source: orxonox.OLD/branches/terrain.old/src/lib/util/filesys/file.h @ 10652

/*!
 * @file file.h
 * @brief Definition of File Handler class
 */

#ifndef __FILE_H_
#define __FILE_H_


#include <string>
struct stat;

//! A Class to Handle Files.
class File
{
  public:
  //! How the File should be opened.
  typedef enum {
    ReadOnly    = 0,     //!< ReadOnly mode
    WriteOnly   = 1,     //!< WriteOnly mode
    ReadWrite   = 2,     //!< Read and Write mode together
    Append              = 3      //!< Append at the end.
  } OpenMode;
public:
  File();
  File(const std::string& fileName);
  File(const File& file);
  virtual ~File();

  /// Set-Up
  void setFileName(const std::string& fileName);
  File& operator=(const std::string& fileName);
  File& operator=(const File& file);

  /// Comparison
  bool operator==(const std::string& fileName) const;
  bool operator==(const File& file) const;

  virtual bool open(OpenMode mode);
  virtual bool close();
  FILE* handle() const 
  { return this->_handle; };
  inline OpenMode mode() const
  { return _mode; }
  /** @returns the FileName of this File */
  const std::string& name() const { return this->_name; };

  /// Testing
  bool exists() const;
  bool isLink() const;
  bool isFile() const;
  bool isDirectory() const;
  bool isReadable() const;
  bool isWriteable() const;
  bool isExecutable() const;


  /// Operate on the FileSystem
  bool copy(const File& destination);
  bool rename(const File& destination);
  bool touch();
  bool remove();

  /// Transformations
  static void relToAbs(std::string& relFileName);
  static void absToRel(std::string& absFileName);
  static const std::string& cwd();

  private:
    void init();
    void statFile();
    void homeDirCheck(std::string& fileName);

  private:
    FILE*               _handle;          //!< The FileHandle (if set).
    std::string         _name;            //!< The Name of the File.
    stat*               _status;          //!< The Stat of the File.
        OpenMode                        _mode;
    static std::string  _cwd;             //!< The currend Working directory.

};

#endif /* __FILE_H_ */