OgreArchive.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef _Archive_H__
#define _Archive_H__

#include "OgrePrerequisites.h"
#include "OgreString.h"
#include "OgreDataStream.h"
#include "OgreSharedPtr.h"
#include "OgreStringVector.h"
#include "OgreException.h"
#include <ctime>
#include "OgreHeaderPrefix.h"

namespace Ogre {

    struct FileInfo {
        const Archive* archive;
        String filename;
        String path;
        String basename;
        size_t compressedSize;
        size_t uncompressedSize;
    };

    typedef vector<FileInfo>::type FileInfoList;
    typedef SharedPtr<FileInfoList> FileInfoListPtr;

    class _OgreExport Archive : public ArchiveAlloc
    {
    protected:
        String mName; 
        String mType;
        bool mReadOnly;
    public:


        Archive( const String& name, const String& archType )
            : mName(name), mType(archType), mReadOnly(true) {}

        virtual ~Archive() {}

        const String& getName(void) const { return mName; }

        virtual bool isCaseSensitive(void) const = 0;

        virtual void load() = 0;

        virtual void unload() = 0;

        virtual bool isReadOnly() const { return mReadOnly; }

        virtual DataStreamPtr open(const String& filename, bool readOnly = true) const = 0;

        virtual DataStreamPtr create(const String& filename) const
        {
                        (void)filename;
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, 
                "This archive does not support creation of files.", 
                "Archive::create");
        }

        virtual void remove(const String& filename) const
        {
                        (void)filename;
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, 
                "This archive does not support removal of files.", 
                "Archive::remove");
        }

        virtual StringVectorPtr list(bool recursive = true, bool dirs = false) = 0;
        
        virtual FileInfoListPtr listFileInfo(bool recursive = true, bool dirs = false) = 0;

        virtual StringVectorPtr find(const String& pattern, bool recursive = true,
            bool dirs = false) = 0;

        virtual bool exists(const String& filename) = 0; 

        virtual time_t getModifiedTime(const String& filename) = 0; 


        virtual FileInfoListPtr findFileInfo(const String& pattern, 
            bool recursive = true, bool dirs = false) const = 0;

        const String& getType(void) const { return mType; }
        
    };
}

#include "OgreHeaderSuffix.h"

#endif