IFileArchive.h

// 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 irrlicht.h
 
#ifndef __I_FILE_ARCHIVE_H_INCLUDED__
#define __I_FILE_ARCHIVE_H_INCLUDED__
 
#include "IReadFile.h"
#include "IFileList.h"
 
namespace irr
{
 
namespace io
{

enum EFileSystemType
{
    FILESYSTEM_NATIVE = 0,  // Native OS FileSystem
    FILESYSTEM_VIRTUAL  // Virtual FileSystem
};

enum E_FILE_ARCHIVE_TYPE
{
    EFAT_ZIP     = MAKE_IRR_ID('Z','I','P', 0),

    EFAT_GZIP    = MAKE_IRR_ID('g','z','i','p'),

    EFAT_FOLDER  = MAKE_IRR_ID('f','l','d','r'),

    EFAT_PAK     = MAKE_IRR_ID('P','A','K', 0),

    EFAT_NPK     = MAKE_IRR_ID('N','P','K', 0),

    EFAT_TAR     = MAKE_IRR_ID('T','A','R', 0),

    EFAT_WAD     = MAKE_IRR_ID('W','A','D', 0),

    EFAT_UNKNOWN = MAKE_IRR_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 irr
 
#endif