ifilesystem.h

Go to the documentation of this file.

/*
 Copyright (C) 2001-2006, William Joseph.
 All Rights Reserved.

 This file is part of GtkRadiant.

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

 GtkRadiant 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 General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with GtkRadiant; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#if !defined(INCLUDED_IFILESYSTEM_H)
#define INCLUDED_IFILESYSTEM_H

#include <cstddef>
#include "generic/constant.h"
#include "generic/callbackfwd.h"
#include <string>

typedef Callback1<const char*> ArchiveNameCallback;
typedef Callback1<const char*> FileNameCallback;

class ArchiveFile;
class ArchiveTextFile;
class Archive;

class ModuleObserver;

typedef struct _GSList GSList;

class VirtualFileSystem
{
    public:
        INTEGER_CONSTANT(Version, 1);
        STRING_CONSTANT(Name, "VFS");

        virtual ~VirtualFileSystem ()
        {
        }

        virtual void initDirectory (const std::string& path) = 0;
        virtual void initialise () = 0;
        virtual void shutdown () = 0;

        virtual ArchiveFile* openFile (const std::string& filename) = 0;
        virtual ArchiveTextFile* openTextFile (const std::string& filename) = 0;

        virtual std::size_t loadFile (const std::string& filename, void **buffer) = 0;
        virtual void freeFile (void *p) = 0;

        virtual void forEachDirectory (const char* basedir, const FileNameCallback& callback, std::size_t depth = 1) = 0;
        virtual void forEachFile (const char* basedir, const char* extension, const FileNameCallback& callback,
                std::size_t depth = 1) = 0;

        virtual std::string findFile (const std::string& name) = 0;
        virtual std::string findRoot (const std::string& name) = 0;
        virtual std::string getRelative (const std::string& name) = 0;

        virtual void attach (ModuleObserver& observer) = 0;
        virtual void detach (ModuleObserver& observer) = 0;

        virtual Archive* getArchive (const char* archiveName) = 0;
        virtual void forEachArchive (const ArchiveNameCallback& callback) = 0;
};

#include "modulesystem.h"

template<typename Type>
class GlobalModule;
typedef GlobalModule<VirtualFileSystem> GlobalFileSystemModule;

template<typename Type>
class GlobalModuleRef;
typedef GlobalModuleRef<VirtualFileSystem> GlobalFileSystemModuleRef;

inline VirtualFileSystem& GlobalFileSystem ()
{
    return GlobalFileSystemModule::getTable();
}

inline int vfsLoadFile (const std::string& filename, void** buffer, int index = 0)
{
    return static_cast<int> (GlobalFileSystem().loadFile(filename, buffer));
}

inline void vfsFreeFile (void* p)
{
    GlobalFileSystem().freeFile(p);
}

#endif