fileutils.h

Go to the documentation of this file.

// -*- C++ -*-

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1998 Pascal Vincent
// Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio and University of Montreal
//

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org


 

/* *******************************************************      
   * $Id: fileutils.h,v 1.14 2004/04/23 14:14:17 plearner Exp $
   * AUTHORS: Pascal Vincent
   * This file is part of the PLearn library.
   ******************************************************* */

// This file contains useful functions for string manipulation
// that are used in the PLearn Library


#ifndef fileutils_INC
#define fileutils_INC

#include <fstream>
#include <map>
#include <string>
#include <vector>
//#include "general.h"

// norman: set win32 functions
#ifdef WIN32
#include <sys/types.h>
#define stat _stat
#endif

namespace PLearn {
using namespace std;

  string getcwd();

  int chdir(const string& path);

  string abspath(const string& path);
  
  bool pathexists(const string& path);

  bool isdir(const string& path);

  bool isfile(const string& path);

  time_t mtime(const string& path);

  vector<string> lsdir(const string& dirpath);

  vector<string> lsdir_fullpath(const string& dirpath);

  bool force_mkdir(const string& dirname);

void force_mkdir_for_file(const string& filepath);

  bool force_rmdir(const string& dirname);

  long filesize(const string& filename);

  void cp(const string& srcpath, const string& destpath);

  void rm(const string& file);

  void mv(const string& file);

  void mvforce(const string& file);

  void touch(const string& file);

  void readWhileMatches(istream& in, const string& s);

  void skipRestOfLine(istream& in);

  void skipBlanksAndComments(istream& in);

  void getNextNonBlankLine(istream& in, string& line);

  int countNonBlankLinesOfFile(const string& filename);

  int smartReadUntilNext(istream& in, string stoppingsymbols, string& characters_read, bool ignore_brackets=false);
  
  inline char peekAfterSkipBlanks(istream& in) { while(isspace(in.get())); in.unget();return in.peek(); }

  inline char peekAfterSkipBlanksAndComments(istream& in) { skipBlanksAndComments(in); return in.peek(); }

  inline char getAfterSkipBlanks(istream& in) { char c; while(isspace(c = in.get())); return c; }

  inline char getAfterSkipBlanksAndComments(istream& in) { skipBlanksAndComments(in); return in.get(); }

  string newFilename(const string directory="/tmp/", const string prefix="", bool is_directory=false);

  string makeFileNameValid(const string& filename);

  string makeExplicitPath(const string& filename);

  string loadFileAsString(const string& filepath);

  void saveStringInFile(const string& filepath, const string& text);

  string readAndMacroProcess(istream& in, map<string, string>& variables);


string readFileAndMacroProcess(const string& filepath, map<string, string>& variables);

inline string readFileAndMacroProcess(const string& filepath)
{
  map<string, string> variables;
  return readFileAndMacroProcess(filepath, variables);
}

#ifdef WIN32
#undef stat
#endif

} // end of namespace PLearn


#endif

---