file.cc

Go to the documentation of this file.

/* Copyright (C) 2000-2012 Stefan Buehler <sbuehler@ltu.se>

   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

//   External declarations

#include "arts.h"

#include <algorithm>
#include <cfloat>
#include <cmath>
#include <cstdio>
#include <cstdlib>
#include <limits>
#include <stdexcept>

// For getdir
#include <dirent.h>
#include <errno.h>
#include <sys/stat.h>
#include <sys/types.h>

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#include "array.h"
#include "file.h"
#include "parameters.h"

//   Default file names

void filename_ascii(String& filename, const String& varname) {
  if ("" == filename) {
    extern const String out_basename;
    filename = out_basename + "." + varname + ".aa";
  }
}

//   Functions to open and read ASCII files

void open_output_file(ofstream& file, const String& name) {
  String ename = add_basedir(name);

  try {
    // 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.
    file.open(ename.c_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().)
  } catch (const std::exception& e) {
    ostringstream os;
    os << "Cannot open output file: " << ename << '\n'
       << "Maybe you don't have write access "
       << "to the directory or the file?";
    throw runtime_error(os.str());
  }
}

#ifdef HAVE_REMOVE
void cleanup_output_file(ofstream& file, const String& name) {
  if (file.is_open()) {
    streampos fpos = file.tellp();
    file.close();
    if (!fpos) unlink(expand_path(name).c_str());
  }
}
#else
void cleanup_output_file(ofstream&, const String&) {}
#endif

void open_input_file(ifstream& file, const String& name) {
  String ename = expand_path(name);

  // Command line parameters which give us the include search path.
  extern const Parameters parameters;
  ArrayOfString allpaths = parameters.includepath;
  allpaths.insert(
      allpaths.end(), parameters.datapath.begin(), parameters.datapath.end());

  ArrayOfString matching_files;
  find_file(matching_files, ename, allpaths);

  if (matching_files.nelem()) ename = matching_files[0];

  // 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!
  file.exceptions(ios::badbit);

  // c_str explicitly converts to c String.
  file.open(ename.c_str());

  // See if the file is ok.
  // FIXME: This should not be necessary anymore in the future, when
  // g++ stream exceptions work properly.
  if (!file) {
    ostringstream os;
    os << "Cannot open input file: " << ename << '\n'
       << "Maybe the file does not exist?";
    throw runtime_error(os.str());
  }
}

void read_text_from_stream(ArrayOfString& text, istream& is) {
  String linebuffer;

  // Read as long as `is' is good.
  // Contary to what I understood from the book, the explicit check
  // for eof is necessary here, otherwise the last line is read twice
  // if it is not terminated by a newline character!
  while (is && is.good() && !is.eof()) {
    // Read line from file into linebuffer:
    getline(is, linebuffer);

    // Append to end of text:
    text.push_back(linebuffer);
  }

  // Check for error:
  // FIXME: This should not be necessary anymore when stream
  // exceptions work properly.
  if (!is.eof()) {
    ostringstream os;
    os << "Read Error. Last line read:\n" << linebuffer;
    throw runtime_error(os.str());
  }
}

void read_text_from_file(ArrayOfString& text, const String& name) {
  ifstream ifs;

  // Open input stream:
  open_input_file(ifs, name);
  // No need to check for error, because open_input_file throws a
  // runtime_error with an appropriate error message.

  // Read the text from the stream. Here we catch the exception,
  // because then we can issue a nicer error message that includes the
  // filename.
  try {
    read_text_from_stream(text, ifs);
  } catch (const std::runtime_error& x) {
    ostringstream os;
    os << "Error reading file: " << name << '\n' << x.what();
    throw runtime_error(os.str());
  }
}

void replace_all(String& s, const String& what, const String& with) {
  Index j = s.find(what);
  while (j != s.npos) {
    s.replace(j, 1, with);
    j = s.find(what, j + with.size());
  }
}

int check_newline(const String& s) {
  String d = s;
  int result = 0;

  // Remove all whitespaces except \n
  replace_all(d, " ", "");
  replace_all(d, "\t", "");
  replace_all(d, "\r", "");

  const char* cp = d.c_str();
  while ((*cp == '\n') && *cp) cp++;

  if (!(*cp)) result = 1;

  if (!result && d[d.length() - 1] != '\n')
    result = 2;
  else if (!result && d.length() > 2 && d[d.length() - 1] == '\n' &&
           d[d.length() - 2] == '\n')
    result = 3;

  return result;
}

bool file_exists(const String& filename) {
  bool exists = false;

  struct stat st;
  if (lstat(filename.c_str(), &st) >= 0 && !S_ISDIR(st.st_mode)) {
    fstream fin;
    fin.open(filename.c_str(), ios::in);
    if (fin.is_open()) {
      exists = true;
    }
    fin.close();
  }

  return exists;
}

String get_absolute_path(const String& filename) {
  char* fullrealpath;
  fullrealpath = realpath(filename.c_str(), NULL);
  if (fullrealpath) {
    String retpath(fullrealpath);
    free(fullrealpath);
    return retpath;
  } else
    return filename;
}

bool find_file(ArrayOfString& matches,
               const String& filename,
               const ArrayOfString& paths,
               const ArrayOfString& extensions) {
  bool exists = false;
  String efilename = expand_path(filename);

  // filename contains full path
  if (!paths.nelem() || (efilename.nelem() && efilename[0] == '/')) {
    for (ArrayOfString::const_iterator ext = extensions.begin();
         ext != extensions.end();
         ext++) {
      String fullpath = get_absolute_path(efilename + *ext);
      // Full path + extension
      if (file_exists(fullpath)) {
        if (std::find(matches.begin(), matches.end(), fullpath) ==
            matches.end())
          matches.push_back(fullpath);
        exists = true;
      }
    }
  }
  // filename contains no or relative path
  else {
    for (ArrayOfString::const_iterator path = paths.begin();
         path != paths.end();
         path++) {
      for (ArrayOfString::const_iterator ext = extensions.begin();
           ext != extensions.end();
           ext++) {
        String fullpath =
            get_absolute_path(expand_path(*path) + "/" + efilename + *ext);

        if (file_exists(fullpath)) {
          if (std::find(matches.begin(), matches.end(), fullpath) ==
              matches.end())
            matches.push_back(fullpath);
          exists = true;
        }
      }
    }
  }

  return exists;
}

void find_xml_file(String& filename, const Verbosity& verbosity) {
  // Command line parameters which give us the include search path.
  extern const Parameters parameters;
  ArrayOfString allpaths = parameters.includepath;
  allpaths.insert(
      allpaths.end(), parameters.datapath.begin(), parameters.datapath.end());

  ArrayOfString matching_files;
  find_file(matching_files, filename, allpaths, {"", ".xml", ".gz", ".xml.gz"});

  if (matching_files.nelem() > 1) {
    CREATE_OUT1;
    out1
        << "  WARNING: More than one file matching this name exists in the data path.\n"
        << "  Using the first file (1) found:\n";
    for (Index i = 0; i < matching_files.nelem(); i++)
      out1 << "  (" << i + 1 << ") " << matching_files[i] << "\n";
  } else if (!matching_files.nelem()) {
    ostringstream os;
    os << "Cannot find input file: " << filename << endl;
    os << "Search path: " << allpaths << endl;
    throw runtime_error(os.str());
  }

  filename = matching_files[0];
}

bool find_xml_file_existence(String& filename) {
  // Command line parameters which give us the include search path.
  extern const Parameters parameters;
  ArrayOfString allpaths = parameters.includepath;
  allpaths.insert(
    allpaths.end(), parameters.datapath.begin(), parameters.datapath.end());
  
  ArrayOfString matching_files;
  find_file(matching_files, filename, allpaths, {"", ".xml", ".gz", ".xml.gz"});
  
  if (matching_files.nelem()) {
    filename = matching_files[0];
    return true;
  } else {
    return false;
  }
}

String expand_path(const String& path) {
  if ((path.nelem() == 1 && path[0] == '~') ||
      (path.nelem() > 1 && path[0] == '~' && path[1] == '/')) {
    return String(getenv("HOME")) + String(path, 1);
  } else {
    return path;
  }
}

String add_basedir(const String& path) {
  extern const Parameters parameters;
  String expanded_path = expand_path(path);

  if (parameters.outdir.nelem() && path.nelem() && path[0] != '/') {
    expanded_path = parameters.outdir + '/' + expanded_path;
  }

  return expanded_path;
}


void get_dirname(String& dirname, const String& path) {
  dirname = "";
  if (!path.nelem()) return;

  ArrayOfString fileparts;
  path.split(fileparts, "/");
  if (path[0] == '/') dirname = "/";
  if (fileparts.nelem() > 1) {
    for (Index i = 0; i < fileparts.nelem() - 1; i++) {
      dirname += fileparts[i];
      if (i < fileparts.nelem() - 2) dirname += "/";
    }
  }
}


void list_directory(ArrayOfString& files, String dirname) {
  DIR* dp;
  struct dirent* dirp;
  if ((dp = opendir(dirname.c_str())) == NULL) {
    ostringstream os;
    os << "Error(" << errno << ") opening " << dirname << endl;
    throw runtime_error(os.str());
  }

  while ((dirp = readdir(dp)) != NULL) {
    files.push_back(String(dirp->d_name));
  }

  closedir(dp);
}

void make_filename_unique(String& filename, const String& extension) {
  String basename = filename;
  String extensionname;

  // Split filename into base and extension
  if (extension.length()) {
    size_t pos = filename.rfind(extension);
    if (pos == filename.length() - extension.length()) {
      basename = filename.substr(0, filename.length() - extension.length());
      extensionname = extension;
    }
  }

  Index filenumber = 0;
  ostringstream newfilename;
  newfilename << basename << extensionname;

  while (file_exists(newfilename.str()) ||
         file_exists(newfilename.str() + ".gz")) {
    filenumber++;
    newfilename.str("");
    newfilename << basename << "." << filenumber << extensionname;
  }

  filename = newfilename.str();
}

//   IO manipulation classes for parsing nan and inf

double_istream& double_istream::parse_on_fail(double& x, bool neg) {
  const char* exp[] = {"", "inf", "Inf", "nan", "NaN"};
  const char* e = exp[0];
  int l = 0;
  char inf[4] = "\0\0\0";
  char* c = inf;
  if (neg) *c++ = '-';
  in.clear();
  if (!(in >> *c).good()) return *this;
  switch (*c) {
    case 'i':
      e = exp[l = 1];
      break;
    case 'I':
      e = exp[l = 2];
      break;
    case 'n':
      e = exp[l = 3];
      break;
    case 'N':
      e = exp[l = 4];
      break;
  }
  while (*c == *e) {
    if ((e - exp[l]) == 2) break;
    ++e;
    if (!(in >> *++c).good()) break;
  }
  if (in.good() && *c == *e) {
    switch (l) {
      case 1:
      case 2:
        x = std::numeric_limits<double>::infinity();
        break;
      case 3:
      case 4:
        x = std::numeric_limits<double>::quiet_NaN();
        break;
    }
    if (neg) x = -x;
    return *this;
  } else if (!in.good()) {
    if (!in.fail()) return *this;
    in.clear();
    --c;
  }
  do {
    in.putback(*c);
  } while (c-- != inf);
  in.setstate(std::ios_base::failbit);
  return *this;
}

const double_imanip& operator>>(std::istream& in, const double_imanip& dm) {
  dm.in = &in;
  return dm;
}