xml_io.cc

Go to the documentation of this file.

/* Copyright (C) 2002-2008 Oliver Lemke <olemke@core-dump.info>
 
   This program is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by the
   Free Software Foundation; either version 2, or (at your option) any
   later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
   USA. */
 
 
//   File description
 
#include "arts.h"
#include "xml_io.h"
#include "xml_io_private.h"
#include "xml_io_types.h"
#include "bofstream.h"
#include "bifstream.h"
#include "file.h"
 
#ifdef ENABLE_ZLIB
#include "gzstream.h"
#endif
 
 
//   ArtsXMLTag implementation
 
 
void
ArtsXMLTag::check_name (const String& expected_name)
{
  if (name != expected_name)
    {
      xml_parse_error ("Tag <" + expected_name + "> expected but <"
                       + name + "> found.");
    }
 
}
 
 
 
void
ArtsXMLTag::add_attribute (const String& aname, const String& value)
{
  XMLAttribute attr;
 
  attr.name = aname;
  attr.value = value;
  attribs.push_back (attr);
}
 
 
 
void
ArtsXMLTag::add_attribute (const String& aname, const Index& value)
{
  ostringstream v;
 
  v << value;
  add_attribute (aname, v.str ());
}
 
 
 
void
ArtsXMLTag::check_attribute (const String& aname, const String& value)
{
  String actual_value;
 
  get_attribute_value (aname, actual_value);
 
  if (actual_value == "*not found*")
    {
      xml_parse_error ("Required attribute " + aname
                       + " does not exist");
    }
  else if (actual_value != value)
    {
      xml_parse_error ("Attribute " + aname + " has value \""
                       + actual_value + "\" but \""
                       + value + "\" was expected.");
    }
}
 
 
 
void
ArtsXMLTag::get_attribute_value (const String& aname, String& value)
{
  value = "";
 
  Array<XMLAttribute>::iterator it = attribs.begin ();
  while (it != attribs.end ())
    {
      if (it->name == aname)
        {
          value = it->value;
          it = attribs.end ();
        }
      else
        {
          it++;
        }
    }
}
 
 
 
void
ArtsXMLTag::get_attribute_value (const String& aname, Index& value)
{
  String attribute_value;
  istringstream strstr ("");
 
  get_attribute_value (aname, attribute_value);
  strstr.str (attribute_value);
  strstr >> value;
  if (strstr.fail ())
    {
      xml_parse_error ("Error while parsing value of " + aname
                       + " from <" + name + ">");
    }
}
 
 
 
 
void
ArtsXMLTag::read_from_stream (istream& is)
{
  CREATE_OUT3
  
  String        token;
  stringbuf     tag;
  istringstream sstr ("");
  XMLAttribute  attr;
  char          ch;
 
  attribs.clear ();
 
  while (is.good () && isspace (is.peek ()))
    {
      is.get ();
    }
 
  is >> ch;
 
  if (ch != '<')
    {
      is >> token;
      token = ch + token;
 
      xml_parse_error ("'<' expected but " + token + " found.");
    }
 
  is.get (tag, '>');
 
  // Hit EOF while looking for '>'
  if (is.bad () || is.eof ())
    {
      xml_parse_error ("Unexpected end of file while looking for '>'");
    }
 
  if (is.get () != '>')
    {
      xml_parse_error ("Closing > not found in tag: " + tag.str ());
    }
 
  sstr.str (tag.str () + '>');
  out3 << "Read: " << sstr.str () << '\n';
 
  sstr >> name;
 
  if (name [name.length () - 1] == '>')
    {
      // Because closin > was found, the tag for sure has no
      // attributes, set token to ">" to skip reading of attributes
      name.erase (name.length () - 1, 1);
      token = ">";
    }
  else
    {
      // Tag may have attributes, so read next token
      sstr >> token;
    }
  out3 << "Name: " << name << '\n';
 
  //extract attributes
  while (token != ">")
  {
    String::size_type pos;
 
    pos = token.find ("=", 0);
    if (pos == String::npos)
      {
        xml_parse_error ("Syntax error in tag: " + tag.str ());
      }
 
    attr.name = token.substr (0, pos);
    token.erase (0, pos + 1);
 
    if (token[0] != '\"')
      {
        xml_parse_error ("Missing \" in tag: " + tag.str ());
      }
 
    while ((pos = token.find ("\"", 1)) == (String::size_type)String::npos && token != ">")
      {
        String ntoken;
        sstr >> ntoken;
        if (!ntoken.length()) break;
        token += " " + ntoken;
      }
 
    if (pos == (String::size_type)String::npos)
      {
        xml_parse_error ("Missing \" in tag: " + sstr.str ());
      }
 
    if (pos == 1)
      attr.value = "";
    else
      attr.value = token.substr (1, pos - 1);
 
    attribs.push_back (attr);
 
    out3 << "Attr: " << attr.name << '\n';
    out3 << "Value: " << attr.value << '\n';
 
    if (token[token.length () - 1] == '>')
      {
        token = ">";
      }
    else
      {
        sstr >> token;
      }
  }
 
  out3 << '\n';
 
  // Skip comments
  if (name == "comment")
    {
      is.get (tag, '<');
 
      // Hit EOF while looking for '<'
      if (is.bad () || is.eof ())
        {
          xml_parse_error ("Unexpected end of file while looking for "
                           "comment tag");
        }
 
      read_from_stream (is);
      check_name ("/comment");
      read_from_stream (is);
    }
}
 
 
 
void
ArtsXMLTag::write_to_stream (ostream& os)
{
 
  os << "<" << name;
 
  Array<XMLAttribute>::iterator it = attribs.begin ();
 
  while (it != attribs.end ())
    {
      os << ' ' << it->name
         << "=\"" << it->value << '\"';
      it++;
    }
 
  os << ">";
}
 
 
 
//   Default file name
 
 
void
filename_xml (String&  filename,
              const String&  varname )
{
  if ("" == filename)
    {
      extern const String out_basename;
      filename = out_basename + "." + varname + ".xml";
    }
}
 
 
 
 
void
filename_xml_with_index (
                    String&  filename,
              const Index&   file_index,
              const String&  varname )
{
  if ("" == filename)
    {
      extern const String out_basename;
      ostringstream os;
      os << out_basename << "." << varname << "." << file_index << ".xml";
      filename = os.str();
    }
  else
    {
      ostringstream os;
      os << filename << "." << file_index << ".xml";
      filename = os.str();
    }
}
 
 
 
//   Functions to open and read XML files
 
 
void
xml_open_output_file (ofstream& file, const String& name)
{
  // Tell the stream that it should throw exceptions.
  // Badbit means that the entire stream is corrupted, failbit means
  // that the last operation has failed, but the stream is still
  // valid. We don't want either to happen!
  // FIXME: This does not yet work in  egcs-2.91.66, try again later.
  file.exceptions(ios::badbit |
                  ios::failbit);
 
  // c_str explicitly converts to c String.
  try {
    file.open (name.c_str());
  } catch (ios::failure) {
    ostringstream os;
    os << "Cannot open output file: " << name << '\n'
      << "Maybe you don't have write access "
      << "to the directory or the file?";
    throw runtime_error(os.str());
  }
 
 
  // See if the file is ok.
  // FIXME: This should not be necessary anymore in the future, when
  // g++ stream exceptions work properly. (In that case we would not
  // get here if there really was a problem, because of the exception
  // thrown by open().)
  if (!file)
    {
      ostringstream os;
      os << "Cannot open output file: " << name << '\n'
         << "Maybe you don't have write access "
         << "to the directory or the file?";
      throw runtime_error(os.str());
    }
}
 
#ifdef ENABLE_ZLIB
 
 
void
xml_open_output_file (ogzstream& file, const String& name)
{
  // Tell the stream that it should throw exceptions.
  // Badbit means that the entire stream is corrupted, failbit means
  // that the last operation has failed, but the stream is still
  // valid. We don't want either to happen!
  // FIXME: This does not yet work in  egcs-2.91.66, try again later.
  file.exceptions(ios::badbit |
                  ios::failbit);
 
  // c_str explicitly converts to c String.
  String nname = name;
  
  if (nname.substr (nname.length()-3, 3) != ".gz")
    {
      nname += ".gz";
    }
 
  try {
    file.open (nname.c_str());
  } catch (ios::failure) {
    ostringstream os;
    os << "Cannot open output file: " << nname << '\n'
      << "Maybe you don't have write access "
      << "to the directory or the file?";
    throw runtime_error(os.str());
  }
 
 
  // See if the file is ok.
  // FIXME: This should not be necessary anymore in the future, when
  // g++ stream exceptions work properly. (In that case we would not
  // get here if there really was a problem, because of the exception
  // thrown by open().)
  if (!file)
    {
      ostringstream os;
      os << "Cannot open output file: " << nname << '\n'
         << "Maybe you don't have write access "
         << "to the directory or the file?";
      throw runtime_error(os.str());
    }
}
 
#endif /* ENABLE_ZLIB */
 
 
void
xml_open_input_file (ifstream& ifs, const String& name, const Verbosity& verbosity)
{
  CREATE_OUT3
  
  // Tell the stream that it should throw exceptions.
  // Badbit means that the entire stream is corrupted.
  // On the other hand, end of file will not lead to an exception, you
  // have to check this manually!
  ifs.exceptions (ios::badbit);
 
  // c_str explicitly converts to c String.
  try
    {
      ifs.open (name.c_str ());
    }
  catch (ios::failure)
    {
      ostringstream os;
      os << "Cannot open input file: " << name << '\n'
        << "Maybe the file does not exist?";
      throw runtime_error (os.str ());
    }
 
  // See if the file is ok.
  // FIXME: This should not be necessary anymore in the future, when
  // g++ stream exceptions work properly.
  if (!ifs)
    {
      ostringstream os;
      os << "Cannot open input file: " << name << '\n'
         << "Maybe the file does not exist?";
      throw runtime_error (os.str ());
    }
 
  out3 << "- Reading input file " << name << "\n";
}
 
 
#ifdef ENABLE_ZLIB
 
 
void
xml_open_input_file (igzstream& ifs, const String& name, const Verbosity& verbosity)
{
  CREATE_OUT3
  
  // Tell the stream that it should throw exceptions.
  // Badbit means that the entire stream is corrupted.
  // On the other hand, end of file will not lead to an exception, you
  // have to check this manually!
  ifs.exceptions (ios::badbit);
 
  // c_str explicitly converts to c String.
  try
    {
      ifs.open (name.c_str ());
    }
  catch (ios::failure)
    {
      ostringstream os;
      os << "Cannot open input file: " << name << '\n'
        << "Maybe the file does not exist?";
      throw runtime_error (os.str ());
    }
 
  // See if the file is ok.
  // FIXME: This should not be necessary anymore in the future, when
  // g++ stream exceptions work properly.
  if (!ifs)
    {
      ostringstream os;
      os << "Cannot open input file: " << name << '\n'
         << "Maybe the file does not exist?";
      throw runtime_error (os.str ());
    }
 
  out3 << "- Reading input file " << name << "\n";
}
 
#endif /* ENABLE_ZLIB */
 
 
//   General XML functions (file header, start root tag, end root tag)
 
 
void
xml_parse_error (const String& str_error)
{
  ostringstream os;
  os << "XML parse error: " << str_error << '\n'
     << "Check syntax of XML file\n";
  throw runtime_error (os.str ());
}
 
 
 
void
xml_data_parse_error (ArtsXMLTag& tag, String str_error)
{
  ostringstream os;
  os << "XML data parse error: Error reading ";
  tag.write_to_stream (os);
  os << str_error << "\n"
    << "Check syntax of XML file. A possible cause is that the file "
    << "contains NaN or Inf values.\n";
  throw runtime_error (os.str ());
}
 
 
 
void
xml_read_header_from_stream (istream& is, FileType& ftype, NumericType& ntype,
                             EndianType& etype, const Verbosity& verbosity)
{
  char str[6];
  stringbuf strbuf;
  ArtsXMLTag tag(verbosity);
  String strtype;
 
  while (!is.fail () && isspace (is.peek())) is.get();
 
  is.get (str, 6, ' ');
 
  if (string(str) != "<?xml")
    {
      xml_parse_error ("Input file is not a valid xml file "
                       "(<?xml not found)");
    }
 
  is.get (strbuf, '>');
  is.get ();
 
  if (is.fail ())
    {
      xml_parse_error ("Input file is not a valid xml file");
    }
 
  tag.read_from_stream (is);
  tag.check_name ("arts");
 
  // Check file format
  tag.get_attribute_value ("format", strtype);
  if (strtype == "binary")
    {
      ftype = FILE_TYPE_BINARY;
    }
  else
    {
      ftype = FILE_TYPE_ASCII;
    }
 
  // Check endian type
  tag.get_attribute_value ("endian_type", strtype);
  if (strtype == "little")
    {
      etype = ENDIAN_TYPE_LITTLE;
    }
  if (strtype == "big")
    {
      etype = ENDIAN_TYPE_BIG;
    }
  if (strtype == "")
    {
/*      out1 << "  Warning: Endian type not specified in XML file, "
        <<    "assuming little endian (PC)\n";*/
      etype = ENDIAN_TYPE_LITTLE;
    }
  else
    {
      ostringstream os;
      os << "  Error: Unknown endian type \"" << strtype
        <<  "\" specified in XML file.\n";
        throw runtime_error(os.str());
    }
 
  // Check numeric type
  tag.get_attribute_value ("numeric_type", strtype);
  if (strtype == "float")
    {
      ntype = NUMERIC_TYPE_FLOAT;
    }
  else if (strtype == "double")
    {
      ntype = NUMERIC_TYPE_DOUBLE;
    }
  else if (strtype == "")
    {
/*      out1 << "  Warning: Numeric type not specified in XML file, "
        <<    "assuming double\n";*/
      ntype = NUMERIC_TYPE_DOUBLE;
    }
  else
    {
      ostringstream os;
      os << "  Error: Unknown numeric type \"" << strtype
        <<  "\" specified in XML file.\n";
        throw runtime_error(os.str());
    }
 
}
 
 
 
void
xml_read_footer_from_stream (istream& is, const Verbosity& verbosity)
{
  ArtsXMLTag tag(verbosity);
 
  tag.read_from_stream (is);
  tag.check_name ("/arts");
}
 
 
 
void
xml_write_header_to_stream (ostream& os, FileType ftype, const Verbosity& verbosity)
{
  ArtsXMLTag tag(verbosity);
 
  os << "<?xml version=\"1.0\"?>"
     << '\n';
 
  tag.set_name ("arts");
  switch (ftype)
    {
  case FILE_TYPE_ASCII:
  case FILE_TYPE_ZIPPED_ASCII:
    tag.add_attribute ("format", "ascii");
    break;
  case FILE_TYPE_BINARY:
    tag.add_attribute ("format", "binary");
    break;
    }
 
  tag.add_attribute ("version", "1");
 
  tag.write_to_stream (os);
 
  os << '\n';
 
}
 
 
 
void
xml_write_footer_to_stream (ostream& os, const Verbosity& verbosity)
{
  ArtsXMLTag tag(verbosity);
 
  tag.set_name ("/arts");
  tag.write_to_stream (os);
 
  os << endl;
}
 
void
xml_set_stream_precision (ostream& os)
{
  // Determine the precision, depending on whether Numeric is double
  // or float:
  int precision;
#ifdef USE_FLOAT
  precision = FLT_DIG;
#else
#ifdef USE_DOUBLE
  precision = DBL_DIG;
#else
#error Numeric must be double or float
#endif
#endif
 
  os << setprecision (precision);
}
 
 
//   Generic IO routines for XML files
 
 
template<typename T> void
xml_read_from_file (const String& filename,
                    T&            type,
                    const Verbosity& verbosity)
{
  CREATE_OUT2
  
  String efilename = expand_path(filename);
  
  istream* ifs;
 
  out2 << "  Reading " << efilename << '\n';
 
  String xml_file = efilename;
  bool found_file;
 
  found_file = find_file (xml_file, ".xml");
  if (!found_file) found_file = find_file (xml_file, ".xml.gz");
  if (!found_file) found_file = find_file (xml_file, ".gz");
 
  // Open input stream:
  if (xml_file.substr (xml_file.length () - 3, 3) == ".gz")
#ifdef ENABLE_ZLIB
    {
      ifs = new igzstream();
      xml_open_input_file (*(igzstream *)ifs, xml_file, verbosity);
    }
#else
    {
      throw runtime_error (
        "This arts version was compiled without zlib support.\n"
        "Thus zipped xml files cannot be read.");
    }
#endif /* ENABLE_ZLIB */
  else
    {
      ifs = new ifstream();
      xml_open_input_file (*(ifstream *)ifs, xml_file, verbosity);
    }
 
  // No need to check for error, because xml_open_input_file throws a
  // runtime_error with an appropriate error message.
 
  // Read the matrix from the stream. Here we catch the exception,
  // because then we can issue a nicer error message that includes the
  // filename.
  try
    {
      FileType ftype;
      NumericType ntype;
      EndianType etype;
 
      xml_read_header_from_stream (*ifs, ftype, ntype, etype, verbosity);
      if (ftype == FILE_TYPE_ASCII)
        {
          xml_read_from_stream (*ifs, type, NULL, verbosity);
        }
      else
        {
          String bfilename = efilename + ".bin";
          bifstream bifs (bfilename.c_str ());
          xml_read_from_stream (*ifs, type, &bifs, verbosity);
        }
      xml_read_footer_from_stream (*ifs, verbosity);
    }
  catch (runtime_error e)
    {
      delete ifs;
      ostringstream os;
      os << "Error reading file: " << efilename << '\n'
         << e.what ();
      throw runtime_error (os.str ());
    }
 
  delete ifs;
}
 
 
void
xml_read_arts_catalogue_from_file (const String&      filename,
                                   ArrayOfLineRecord& type,
                                   const Numeric&     fmin,
                                   const Numeric&     fmax,
                                   const Verbosity&   verbosity)
{
  CREATE_OUT2
  
  String efilename = expand_path(filename);
  
  istream* ifs;
 
  out2 << "  Reading " << efilename << '\n';
 
  String xml_file = efilename;
  bool found_file;
 
  found_file = find_file (xml_file, ".xml");
  if (!found_file) found_file = find_file (xml_file, ".xml.gz");
  if (!found_file) /* found_file = */ find_file (xml_file, ".gz");
 
  // Open input stream:
  if (xml_file.substr (xml_file.length () - 3, 3) == ".gz")
#ifdef ENABLE_ZLIB
    {
      ifs = new igzstream();
      xml_open_input_file (*(igzstream *)ifs, xml_file, verbosity);
    }
#else
    {
      throw runtime_error (
        "This arts version was compiled without zlib support.\n"
        "Thus zipped xml files cannot be read.");
    }
#endif /* ENABLE_ZLIB */
  else
    {
      ifs = new ifstream();
      xml_open_input_file (*(ifstream *)ifs, xml_file, verbosity);
    }
 
  // No need to check for error, because xml_open_input_file throws a
  // runtime_error with an appropriate error message.
 
  // Read the matrix from the stream. Here we catch the exception,
  // because then we can issue a nicer error message that includes the
  // filename.
  try
    {
      FileType ftype;
      NumericType ntype;
      EndianType etype;
 
      xml_read_header_from_stream (*ifs, ftype, ntype, etype, verbosity);
      if (ftype == FILE_TYPE_ASCII)
        {
          xml_read_from_stream (*ifs, type, fmin, fmax, NULL, verbosity);
        }
      else
        {
          String bfilename = efilename + ".bin";
          bifstream bifs (bfilename.c_str ());
          xml_read_from_stream (*ifs, type, fmin, fmax, &bifs, verbosity);
        }
      xml_read_footer_from_stream (*ifs, verbosity);
    }
  catch (runtime_error e)
    {
      delete ifs;
      ostringstream os;
      os << "Error reading file: " << efilename << '\n'
         << e.what ();
      throw runtime_error (os.str ());
    }
 
  delete ifs;
}
 
 
 
template<typename T> void
xml_write_to_file (const String&  filename,
                   const T&       type,
                   const FileType ftype,
                   const Verbosity& verbosity)
{
  CREATE_OUT2
  
  String efilename = expand_path(filename);
  
  ostream* ofs;
 
  out2 << "  Writing " << efilename << '\n';
  if (ftype == FILE_TYPE_ZIPPED_ASCII)
#ifdef ENABLE_ZLIB
    {
      ofs = new ogzstream();
      xml_open_output_file(*(ogzstream *)ofs, efilename);
    }
#else
    {
      throw runtime_error (
        "This arts version was compiled without zlib support.\n"
        "Thus zipped xml files cannot be written.");
    }
#endif /* ENABLE_ZLIB */
  else
    {
      ofs = new ofstream();
      xml_open_output_file(*(ofstream *)ofs, efilename);
    }
 
 
  try
    {
      xml_write_header_to_stream (*ofs, ftype, verbosity);
      if (ftype == FILE_TYPE_ASCII || ftype == FILE_TYPE_ZIPPED_ASCII)
        {
          xml_write_to_stream (*ofs, type, NULL, "", verbosity);
        }
      else
        {
          String bfilename = efilename + ".bin";
          bofstream bofs (bfilename.c_str ());
          xml_write_to_stream (*ofs, type, &bofs, "", verbosity);
        }
 
      xml_write_footer_to_stream (*ofs, verbosity);
    }
  catch (runtime_error e)
    {
      delete ofs;
      ostringstream os;
      os << "Error writing file: " << efilename << '\n'
         << e.what ();
      throw runtime_error (os.str ());
    }
 
  delete ofs;
}
 
// We can't do the instantiation at the beginning of this file, because the
// implementation of xml_write_to_file and xml_read_from_file have to be known.
 
#include "xml_io_instantiation.h"