MercuryFiles.h

Go to the documentation of this file.

#ifndef _MERCURY_FILES_H
#define _MERCURY_FILES_H

#include "global.h"
#include "MercuryVector.h"
#include <map>

/****************************************************************/
//File Objects:

enum FilePermission
{
    MFP_READ_ONLY,
    MFP_WRITE_ONLY,
    MFP_READ_AND_WRITE,
    MFP_APPEND,
};

class MercuryFile
{
public:
    MercuryFile();
    virtual ~MercuryFile();
    virtual bool Init( const MString & sPath, FilePermission p );
    virtual void Close() = 0;
    virtual bool Seek( unsigned long position ) = 0;
    virtual unsigned long Tell() = 0;
    virtual unsigned long Length() = 0;
    virtual bool Write( void * data, unsigned long length ) = 0;
    virtual unsigned long Read( void * data, unsigned long length ) = 0;
    virtual bool ReadLine( MString & data );
    virtual bool Check() = 0;
    virtual bool Eof() = 0;
    virtual unsigned long GetModTime() { return 0; }

    MString GetName() { return m_sPath; }
protected:
    MString m_sPath;
    FilePermission m_p;
};

class MercuryFileObjectDirect: public MercuryFile
{
public:
    MercuryFileObjectDirect();
    virtual ~MercuryFileObjectDirect();

    virtual bool Init( const MString & fName, FilePermission p );
    virtual bool Seek( unsigned long position );
    virtual void Close();
    virtual unsigned long Tell();
    virtual unsigned long Length();
    virtual bool Write( void * data, unsigned long length );
    virtual unsigned long Read( void * data, unsigned long length );
    virtual bool Check();
    virtual bool Eof();
    virtual unsigned long GetModTime();
private:
    FILE * m_fF;
    unsigned long length;
};

class MercuryFileObjectPacked: public MercuryFile
{
public:
    virtual ~MercuryFileObjectPacked();
    virtual bool Init( const MString & fName, FilePermission p, const MString & base, unsigned offset, unsigned size );
    virtual bool Seek( unsigned long position );
    virtual void Close();
    virtual unsigned long Tell();
    virtual unsigned long Length();
    virtual bool Write( void * data, unsigned long length );
    virtual unsigned long Read( void * data, unsigned long length );
    virtual bool Check();
    virtual bool Eof();
private:
    MercuryFile * m_base;
    unsigned long m_offset;
    unsigned long m_size;
    unsigned long m_location;
};

class MercuryFileObjectZipped: public MercuryFile
{
public:
    virtual ~MercuryFileObjectZipped();
    virtual bool Init( const MString & fName, FilePermission p, const MString & base, unsigned offset, unsigned size, unsigned packedsize, unsigned decompID );
    virtual bool MemFileInit( const MString & sName, const char * pData, unsigned long iSize );
    virtual bool Seek( unsigned long position );
    virtual void Close();
    virtual unsigned long Tell();
    virtual unsigned long Length();
    virtual bool Write( void * data, unsigned long length );
    virtual unsigned long Read( void * data, unsigned long length );
    virtual bool Check();
    virtual bool Eof();
private:
    unsigned long m_size;
    unsigned long m_location;

    bool m_bIsDummy;

    //Used for the file dump buffer as well as the file itself when done
    char * m_Buffer;
};


class MercuryFileObjectNet: public MercuryFile
{
public:
    MercuryFileObjectNet() : m_pSocket(0), m_Buffer(0) { }
    virtual ~MercuryFileObjectNet();
    virtual bool Init( const MString & fName, FilePermission p );
    virtual bool Seek( unsigned long position );
    virtual void Close();
    virtual unsigned long Tell();
    virtual unsigned long Length();
    virtual bool Write( void * data, unsigned long length ) { return false; }
    virtual unsigned long Read( void * data, unsigned long length );
    virtual bool Check();
    virtual bool Eof();
private:
    unsigned long m_size;
    unsigned long m_location;

    void * m_pSocket;

    //Used for the file dump buffer as well as the file itself when done
    char * m_Buffer;
};


/****************************************************************/
//File Drivers:

class MercuryFileDriver
{
public:
    virtual ~MercuryFileDriver() {};

    virtual void Init() { }
    virtual MercuryFile * GetFileHandle( const MString & sPath, FilePermission p  ) = 0;
    virtual void ListDirectory( const MString & sPath, MVector< MString > & output, bool bDirsOnly ) = 0;
};

class MercuryFileDriverNet : public MercuryFileDriver
{
public:
    virtual ~MercuryFileDriverNet() {};

    virtual void Init() { }
    virtual MercuryFile * GetFileHandle( const MString & sPath, FilePermission p  );
    virtual void ListDirectory( const MString & sPath, MVector< MString > & output, bool bDirsOnly );
};

class MercuryFileDirverDirect : public MercuryFileDriver
{
public:
    virtual ~MercuryFileDirverDirect() {};

    virtual MercuryFile * GetFileHandle( const MString & sPath, FilePermission p  );
    virtual void ListDirectory( const MString & sPath, MVector< MString > & output, bool bDirsOnly );
};

class MercuryFileDriverPacked : public MercuryFileDriver
{
public: 
    virtual void Init();
    virtual ~MercuryFileDriverPacked() { }
    virtual MercuryFile * GetFileHandle( const MString & sPath, FilePermission p  );
    virtual void ListDirectory( const MString & sPath, MVector< MString > & output, bool bDirsOnly );
private:
    struct PckFileEntry
    {
        bool m_bFolder;
        MString m_sPackageName;
        unsigned long m_iOffset;
        unsigned long m_iSize;
    };
    std::map< MString, std::map< MString, PckFileEntry > > m_mFileFolders;
};

class MercuryFileDriverZipped : public MercuryFileDriver
{
public: 
    virtual void Init();
    virtual ~MercuryFileDriverZipped() {}
    virtual MercuryFile * GetFileHandle( const MString & sPath, FilePermission p  );
    virtual void ListDirectory( const MString & sPath, MVector< MString > & output, bool bDirsOnly );
private:
    struct ZipFileEntry
    {
        bool m_bFolder;
        MString m_sPackageName;
        unsigned long m_iOffset;
        unsigned long m_iSize;

        unsigned long m_iPackedSize;
        unsigned long m_pkID;
        unsigned long m_pkID2;
    };
    std::map< MString, std::map< MString, ZipFileEntry > > m_mFileFolders;
};

class MercuryFileDriverMem : public MercuryFileDriver
{
public:
    virtual ~MercuryFileDriverMem() {};

    virtual void Init();
    virtual MercuryFile * GetFileHandle( const MString & sPath, enum FilePermission p );
    virtual void ListDirectory( const MString & sPath, MVector< MString > & output, bool bDirsOnly );
    int m_iFileSize;
};

/****************************************************************/
//File Manager:

class MercuryFileManager
{
public:
    void Init();
    inline void CheckInit() { if ( m_bInit ) return; Init(); }

    MercuryFile * Open( const MString & sPath, FilePermission p = MFP_READ_ONLY );
    void ListDirectory( const MString & sPath, MVector< MString > & output, bool bDirsOnly=false );
private:
    bool m_bInit;
    MVector< MercuryFileDriver * > * m_Drivers;
};

extern MercuryFileManager FILEMAN;

#endif

/* 
 * Copyright (c) 2005-2006, Charles Lohr
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *  -   Redistributions of source code must retain the above
 *      copyright notice, this list of conditions and the following disclaimer.
 *  -   Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the distribution.
 *  -   Neither the name of the Mercury Engine nor the names of its
 *      contributors may be used to endorse or promote products derived from
 *      this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

---

Hosted by