xml_io.cc

Go to the documentation of this file.

/* Copyright (C) 2002-2012 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 "xml_io.h"
#include "arts.h"
#include "bifstream.h"
#include "bofstream.h"
#include "file.h"
#include "parameters.h"
 
 
//   ArtsXMLTag implementation
 
void ArtsXMLTag::add_attribute(const String& aname, const std::vector<QuantumNumberType>& value) {
  ostringstream v;
  
  if(value.size() == 0)
    v << "";
  else {
    for(size_t i=0; i<value.size()-1; i++)
      v << value[i] << ' ';
    v << value.back();
  }
  
  add_attribute(aname, v.str());
}
 
void ArtsXMLTag::add_attribute(const String& aname, const ArrayOfSpecies& value, const bool self, const bool bath) {
  ostringstream v;
  
  if(self)
    v << LineShape::self_broadening;
  for(Index i=Index(self); i<value.nelem()-Index(bath); i++)
    v << ' ' << Species::toShortName(value[i]);
  if(bath) {
    v << ' ' << LineShape::bath_broadening;
  }
  
  add_attribute(aname, v.str());
}
 
void ArtsXMLTag::get_attribute_value(const String& aname, SpeciesTag& value) {
  String attribute_value;
  
  get_attribute_value(aname, attribute_value);
  value = SpeciesTag(attribute_value);
}
 
void ArtsXMLTag::get_attribute_value(const String& aname, ArrayOfSpecies& value, bool& self, bool& bath) {
  value.resize(0);
  self=false;
  bath=false;
  
  String attribute_value;
  istringstream strstr("");
  
  get_attribute_value(aname, attribute_value);
  if (attribute_value.nelem() == 0) return;
  
  strstr.str(attribute_value);
  String val;
  
  while(not strstr.eof()) {
    strstr >> val;
    if (strstr.fail()) {
      xml_parse_error("Error while parsing value of " + aname + " from <" + name +
      ">");
    }
    
    if(val == LineShape::self_broadening) {
      value.push_back(Species::Species::FINAL);
      self = true;
    }
    else if(val == LineShape::bath_broadening) {
      value.push_back(Species::Species::Bath);
      bath = true;
    }
    else {
      Species::Species x = Species::fromShortName(val);
      ARTS_USER_ERROR_IF(not good_enum(x), "Species: ", val, " cannot be understood")
      value.push_back(x);
    }
  }
}
 
void ArtsXMLTag::get_attribute_value(const String& aname, std::vector<QuantumNumberType>& value) {
  value.resize(0);
  
  String attribute_value;
  istringstream strstr("");
  
  get_attribute_value(aname, attribute_value);
  if (attribute_value.nelem() == 0) return;
  
  strstr.str(attribute_value);
  String val;
  
  while(not strstr.eof()) {
    strstr >> val;
    if (strstr.fail()) {
      xml_parse_error("Error while parsing value of " + aname + " from <" + name +
      ">");
    }
    value.push_back(Quantum::Number::toType(val));
  }
}
 
void xml_find_and_open_input_file(std::shared_ptr<istream>& ifs,
                                  const String& filename,
                                  const Verbosity& verbosity) {
  CREATE_OUT2;
 
  String xml_file = filename;
  find_xml_file(xml_file, verbosity);
  out2 << "  Reading " << xml_file << '\n';
 
  // Open input stream:
  if (xml_file.substr(xml_file.length() - 3, 3) == ".gz")
#ifdef ENABLE_ZLIB
  {
    ifs = std::shared_ptr<istream>(new igzstream());
    xml_open_input_file(
        *(static_cast<igzstream*>(ifs.get())), 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 = shared_ptr<istream>(new ifstream());
    xml_open_input_file(
        *(static_cast<ifstream*>(ifs.get())), xml_file, verbosity);
  }
}
 
//   General XML functions (file header, start root tag, end root tag)
 
 
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());
}
 
//   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,
                             const Index& digits) {
  if ("" == filename) {
    extern const String out_basename;
    ostringstream os;
    os << out_basename << "." << varname << "." << std::setw((int)digits)
       << std::setfill('0') << file_index << ".xml";
    filename = os.str();
  } else {
    ostringstream os;
    os << filename << "." << std::setw((int)digits) << std::setfill('0')
       << file_index << ".xml";
    filename = os.str();
  }
}