File.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_File_hxx
#define __ccxx_File_hxx

#include <commonc++/Common.h++>
#include <commonc++/FileName.h++>
#include <commonc++/Permissions.h++>
#include <commonc++/Stream.h++>
#include <commonc++/String.h++>

namespace ccxx {

enum FileType { TypeFile, TypeDir, TypeSymLink, TypePipe, TypeDevice,
                TypeOther, TypeUnknown };

enum FileOpenMode { FileOpenElseCreate, FileOpen, FileCreate, FileTruncate,
                    FileTruncateElseCreate };

struct COMMONCPP_API FileAttributes
{
  FileAttributes()
    : type(TypeUnknown),
      created(INT64_CONST(0)),
      modified(INT64_CONST(0)),
      accessed(INT64_CONST(0)),
      size(UINT64_CONST(0))
  { }

  FileType type;
  time_ms_t created;
  time_ms_t modified;
  time_ms_t accessed;
  uint64_t size;
  Permissions permissions;

  inline bool isDirectory() const throw()
  { return(type == TypeDir); }

  inline bool isFile() const throw()
  { return(type == TypeFile); }
};

enum LockType { LockRead, LockWrite };

class COMMONCPP_API File : public Stream
{
  public:

  File(const String &path);

  virtual ~File() throw();

  void open(IOMode mode = IOReadWrite,
            FileOpenMode openMode = FileOpenElseCreate,
            const Permissions &perm = Permissions::USER_READ_WRITE)
    throw(IOException);

  bool exists() const throw();

  bool isDirectory() const throw();

  bool isFile() const throw();

  bool isPipe() const throw();

  bool isSymLink() const throw();

  bool touch() throw();

  bool remove() throw();

  bool setPermissions(const Permissions &perm) throw();

  bool getPermissions(Permissions &perm) throw();

  bool lockRange(uint64_t start, uint64_t length, LockType type,
                 bool wait = true) throw();

  bool unlockRange(uint64_t start, uint64_t length) throw();

  void truncate(uint64_t size = 0) throw(IOException);

  inline String getPath() const
  { return(_name); }

  int64_t getSize() throw(IOException);

  static bool makeDirectory(
    const String &path, bool createAll = false,
    const Permissions &perm = Permissions::defaultDirPerms) throw();

  static bool remove(const String &path) throw();

  static bool removeDirectory(const String &path) throw();

  static bool removeDirectoryTree(const String &path);

  static bool exists(const String &path) throw();

  static bool isDirectory(const String &path) throw();

  static bool isFile(const String &path) throw();

  static bool isPipe(const String &path) throw();

  static bool isSymLink(const String &path) throw();

  static bool readSymLink(String &path) throw();

  static bool resolveSymLink(String &path) throw();

  static bool createLink(const String &oldPath, const String &newPath,
                         bool hardLink = false) throw();

  static bool setPermissions(const String &path, const Permissions &perm)
    throw();

  static bool getPermissions(const String &path, Permissions &perm)
    throw();

  static bool getAttributes(const String &path, FileAttributes &attrs)
    throw();

  static int64_t getSize(const String &path) throw();

  static bool rename(const String &oldName, const String &newName) throw();

  static bool copy(const String &oldFile, const String &newFile) throw();

  static bool move(const String &oldFile, const String &newFile) throw();

  static bool touch(const String &path) throw();

  static void getFileSystemRoots(StringVec &roots, bool localOnly = true)
    throw();

  static void setCreationMask(const Permissions &perm) throw();

  static uint64_t getDiskFreeSpace(const String &path) throw();

  static size_t getDiskBlockSize(const String &path) throw();

  static int64_t roundSizeToBlockSize(const int64_t &fileSize,
                                      size_t blockSize);

  static String removeTrailingSeparators(const String &path) throw();

  static const char separator;

  static const char validSeparators[];

  static bool isValidSeparator(char c) throw();

  static const char separatorString[];

  static const char *eol;

  protected:

  String _name;

  private:

  CCXX_COPY_DECLS(File);
};

}; // namespace ccxx

#endif // __ccxx_File_hxx

/* end of header file */