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-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/
#ifndef _Archive_H__
#define _Archive_H__

#include "OgrePrerequisites.h"
#include "OgreString.h"
#include "OgreDataStream.h"
#include "OgreSharedPtr.h"
#include "OgreStringVector.h"

namespace Ogre {

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

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

    class _OgreExport Archive  
    {
    protected:
        String mName; 
        String mType;
    public:


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

        virtual ~Archive() {}

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

        virtual bool isCaseSensitive(void) const = 0;

        virtual void load() = 0;

        virtual void unload() = 0;

        virtual DataStreamPtr open(const String& filename) const = 0;

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

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

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

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

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

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 12:59:41 2006