IFileArchive.hpp

// Copyright (C) 2002-2012 Nikolaus Gebhardt/ Thomas Alten
// 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_ARCHIVE_HPP_INCLUDED
#define NIRT_I_FILE_ARCHIVE_HPP_INCLUDED
 
#include <nirtcpp/core/engine/IReadFile.hpp>
#include <nirtcpp/core/engine/IFileList.hpp>
 
namespace nirt
{
 
namespace io
{
 
enum EFileSystemType
{
    FILESYSTEM_NATIVE = 0,  // Native OS FileSystem
    FILESYSTEM_VIRTUAL  // Virtual FileSystem
};
 
enum E_FILE_ARCHIVE_TYPE
{
    EFAT_ZIP     = MAKE_NIRT_ID('Z','I','P', 0),
 
    EFAT_GZIP    = MAKE_NIRT_ID('g','z','i','p'),
 
    EFAT_FOLDER  = MAKE_NIRT_ID('f','l','d','r'),
 
    EFAT_PAK     = MAKE_NIRT_ID('P','A','K', 0),
 
    EFAT_NPK     = MAKE_NIRT_ID('N','P','K', 0),
 
    EFAT_TAR     = MAKE_NIRT_ID('T','A','R', 0),
 
    EFAT_WAD     = MAKE_NIRT_ID('W','A','D', 0),
 
    EFAT_UNKNOWN = MAKE_NIRT_ID('u','n','k','n')
};
 
class IFileArchive : public virtual IReferenceCounted
{
public:
 
 
    virtual IReadFile* createAndOpenFile(const path& filename) =0;
 
 
    virtual IReadFile* createAndOpenFile(u32 index) =0;
 
 
    virtual const IFileList* getFileList() const =0;
 
    virtual E_FILE_ARCHIVE_TYPE getType() const { return EFAT_UNKNOWN; }
 
    virtual const io::path& getArchiveName() const =0;
 
 
    core::stringc Password;
};
 
 
class IArchiveLoader : public virtual IReferenceCounted
{
public:
 
    virtual bool isALoadableFileFormat(const path& filename) const =0;
 
 
    virtual bool isALoadableFileFormat(io::IReadFile* file) const =0;
 
 
    virtual bool isALoadableFileFormat(E_FILE_ARCHIVE_TYPE fileType) const =0;
 
 
    virtual IFileArchive* createArchive(const path& filename, bool ignoreCase, bool ignorePaths) const =0;
 
 
    virtual IFileArchive* createArchive(io::IReadFile* file, bool ignoreCase, bool ignorePaths) const =0;
};
 
 
} // end namespace io
} // end namespace nirt
 
#endif