VRS - The Virtual Rendering System

version 3.3

file.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2000-2007 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  is  free  software; you can redistribute it and/or  modify it
 * under the terms of the GNU Lesser General Public  License  as  published  by
 * the  Free  Software  Foundation;  either  version 2.1 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 Lesser General Public License for more details. You should have received
 * a copy of the GNU Lesser+ General Public License along with this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: file.h 6670 2009-03-03 12:44:01Z Amir_Semmo $

#ifndef VRS_IO_FILE_H
#define VRS_IO_FILE_H

#include <vrs/sharedobj.h>
#include <vector>

namespace VRS {

class DataResource;

class VRS_CORE_API File : public SharedObj {
public:
    enum WriteMode { WM_ReadOnly,  WM_Create,      WM_Overwrite, WM_Append };
    enum SeekMode  { SM_FromStart, SM_FromCurrent, SM_FromEnd              };
        enum FileTime  { Access, Modification                                                              };
    VRS_SERIALIZABLE_CLASS_ENUM(WriteMode);
    VRS_SERIALIZABLE_CLASS_ENUM(SeekMode);

    File(const std::string& filename, WriteMode writeMode = WM_ReadOnly);
    bool isReadOnly() const;

    std::string fullName() const;

    std::string fileName() const;
    std::string pathName() const;
    std::string baseName() const;
    std::string extensionName() const;
    std::string replaceExtensionName(const std::string& extensionName) const;
    UINT64 size() const;

    UINT64 position() const;

    UINT64 seek(INT64 relativePosition, SeekMode seekMode = SM_FromStart);
    UINT64 read(void* writeInto, UINT64 bytes);
    UINT64 write(const void* readFrom, UINT64 bytes);
    UINT64 resize(UINT64 bytes);
    UINT64 truncate();
    SO<DataResource> mapToMemory();
    static bool exists(const std::string& filename);

    static bool isFile(const std::string& filename);

    static bool isDir(const std::string& dirname);

    static bool isRelative(const std::string& name);

    static std::vector<std::string> matchingEntries(
        const std::string& dirName,
        const std::string& pattern = "*",
        bool includeFiles = true,
        bool includeDirs = true,
        bool recurseIntoSubDirs = false
    );
    static UINT64 size(const std::string& filename);
    static bool create(const std::string& filename, UINT64 size = 0, const void* copyFrom = NULL);
    static bool append(const std::string& filename, UINT64 size, const void* copyFrom = NULL);
    static bool rename(const std::string& oldFilename, const std::string& newFilename);

        static bool getFileTime(const std::string& filename, FileTime type, time_t* time);

        static bool setFileTime(const std::string& filename, FileTime type, time_t time);

    static bool copy(const std::string& fromFilename, const std::string& toFilename);

    static bool remove(const std::string& filename);

    static bool createDir(const std::string& dirname);

    static bool removeDir(const std::string& dirname);

    static bool removeOldFiles(const std::string& dirname, const std::string& fileExtension, unsigned int numberOfFilesToRemove = 20);

    static std::string temporaryDir();
    static void temporaryDir(const std::string& tempDir);
    static std::string temporaryFileName(const std::string& fileNamePrefix = "");

    static SO<File> newTemporaryFile(const std::string& fileNamePrefix = "");

    static std::string fileName(const std::string& fullFileName);
    static std::string pathName(const std::string& fullFileName);
    static std::string baseName(const std::string& fullFileName);
    static std::string extensionName(const std::string& fullFileName);
    static std::string replaceExtensionName(const std::string& fullFileName, const std::string& extensionName);
    static SO<DataResource> mapToMemory(const std::string& fileName, bool readOnly = true);
        static std::string currentWorkingDir(const int drive = -1);
        static std::string initialWorkingDir();

        static std::string relativePath(const std::string& absolutePath, const std::string& relativeTo = File::currentWorkingDir(), const bool absolutePathIsDir = false);

        static std::string absolutePath(const std::string& relativePath, const std::string& relativeTo = File::currentWorkingDir());

#ifdef __APPLE__
    static std::string resourcePath(const std::string& fileName = "", const std::string& subdirectory = "");
#endif

    VRS_TYPEINFO(File, SharedObj);

private:
    class Impl;
    SO<Impl> impl_;
    WriteMode writeMode_;

        static std::string initialWorkingDir_;
}; // class File

} // namespace VRS

#endif // VRS_IO_FILE_H

---

Generated on Wed May 23 06:00:12 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact