IFileSystem.hpp

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in nirtcpp/nirtcpp.hpp
 
#ifndef NIRT_I_FILE_SYSTEM_HPP_INCLUDED
#define NIRT_I_FILE_SYSTEM_HPP_INCLUDED
 
#include <nirtcpp/core/engine/IReferenceCounted.hpp>
#include <nirtcpp/core/engine/IXMLReader.hpp>
#include <nirtcpp/core/engine/IXMLWriter.hpp>
#include <nirtcpp/core/engine/IFileArchive.hpp>
 
namespace nirt
{
namespace video
{
    class IVideoDriver;
} // end namespace video
namespace io
{
 
class IReadFile;
class IWriteFile;
class IFileList;
class IAttributes;
 
 
 
class IFileSystem : public virtual IReferenceCounted
{
public:
 
 
    virtual IReadFile* createAndOpenFile(const path& filename) =0;
 
 
    virtual IReadFile* createMemoryReadFile(const void* memory, s32 len, const path& fileName, bool deleteMemoryWhenDropped=false) =0;
 
 
    virtual IReadFile* createLimitReadFile(const path& fileName,
            IReadFile* alreadyOpenedFile, long pos, long areaSize) =0;
 
 
    virtual IWriteFile* createMemoryWriteFile(void* memory, s32 len, const path& fileName, bool deleteMemoryWhenDropped=false) =0;
 
 
 
    virtual IWriteFile* createAndWriteFile(const path& filename, bool append=false) =0;
 
 
    virtual bool addFileArchive(const path& filename, bool ignoreCase=true,
            bool ignorePaths=true,
            E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN,
            const core::stringc& password="",
            IFileArchive** retArchive=0) =0;
 
 
    virtual bool addFileArchive(IReadFile* file, bool ignoreCase=true,
            bool ignorePaths=true,
            E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN,
            const core::stringc& password="",
            IFileArchive** retArchive=0) =0;
 
 
    virtual bool addFileArchive(IFileArchive* archive) =0;
 
    virtual u32 getFileArchiveCount() const =0;
 
 
    virtual bool removeFileArchive(u32 index) =0;
 
 
    virtual bool removeFileArchive(const path& filename) =0;
 
 
    virtual bool removeFileArchive(const IFileArchive* archive) =0;
 
 
    virtual bool moveFileArchive(u32 sourceIndex, s32 relative) =0;
 
    virtual IFileArchive* getFileArchive(u32 index) =0;
 
 
    virtual void addArchiveLoader(IArchiveLoader* loader) =0;
 
    virtual u32 getArchiveLoaderCount() const = 0;
 
 
    virtual IArchiveLoader* getArchiveLoader(u32 index) const = 0;
 
 
    NIRT_DEPRECATED virtual bool addZipFileArchive(const c8* filename, bool ignoreCase=true, bool ignorePaths=true)
    {
        return addFileArchive(filename, ignoreCase, ignorePaths, EFAT_ZIP);
    }
 
 
    NIRT_DEPRECATED virtual bool addFolderFileArchive(const c8* filename, bool ignoreCase=true, bool ignorePaths=true)
    {
        return addFileArchive(filename, ignoreCase, ignorePaths, EFAT_FOLDER);
    }
 
 
    NIRT_DEPRECATED virtual bool addPakFileArchive(const c8* filename, bool ignoreCase=true, bool ignorePaths=true)
    {
        return addFileArchive(filename, ignoreCase, ignorePaths, EFAT_PAK);
    }
 
 
    virtual const path& getWorkingDirectory() =0;
 
 
    virtual bool changeWorkingDirectoryTo(const path& newDirectory) =0;
 
 
    virtual path getAbsolutePath(const path& filename) const =0;
 
 
    virtual path getFileDir(const path& filename) const =0;
 
 
    virtual path getFileBasename(const path& filename, bool keepExtension=true) const =0;
 
    virtual path& flattenFilename(path& directory, const path& root="/") const =0;
 
    virtual path getRelativeFilename(const path& filename, const path& directory) const =0;
 
 
    virtual IFileList* createFileList() =0;
 
 
    virtual IFileList* createEmptyFileList(const io::path& path, bool ignoreCase, bool ignorePaths) =0;
 
    virtual EFileSystemType setFileListSystem(EFileSystemType listType) =0;
 
 
    virtual bool existFile(const path& filename) const =0;
 
 
    virtual IXMLReader* createXMLReader(const path& filename) =0;
 
 
    virtual IXMLReader* createXMLReader(IReadFile* file) =0;
 
 
    virtual IXMLReaderUTF8* createXMLReaderUTF8(const path& filename) =0;
 
 
    virtual IXMLReaderUTF8* createXMLReaderUTF8(IReadFile* file) =0;
 
 
    virtual IXMLWriterUTF8* createXMLWriterUTF8(const path& filename) =0;
 
 
    virtual IXMLWriterUTF8* createXMLWriterUTF8(IWriteFile* file) =0;
 
 
    virtual IXMLWriter* createXMLWriter(const path& filename) =0;
 
 
    virtual IXMLWriter* createXMLWriter(IWriteFile* file) =0;
 
 
    virtual IAttributes* createEmptyAttributes(video::IVideoDriver* driver=0) =0;
};
 
 
} // end namespace io
} // end namespace nirt
 
#endif