PackageManager.h

Go to the documentation of this file.

//========================================================================
// Copyright (c) 2003-2011 Philipp Geyer <http://nistur.com>
//
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would
//    be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such, and must not
//    be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source
//    distribution.
//
//========================================================================

#ifndef __PACKAGE_MANAGER_H
#define __PACKAGE_MANAGER_H

namespace Neo
{
typedef void * PackageEnt;
typedef void * Package;

/*--------------------------------------------------------------------------------
 * PackageManager
 * @brief Interface for adding package managers. Can be used for any 
 * file I/O managers such as package file, or network streams
 *-------------------------------------------------------------------------------*/
class NEO_ENGINE_EXPORT PackageManager
{
public:
    // destructor
    virtual ~PackageManager(void) {}

    virtual void init() = 0;
    virtual void cleanup() = 0;

    // accessors for loading
    // will add a package to the package list and
    // allow searching for files within it
    virtual Package loadPackage(const char *packageName) = 0;
    virtual PackageEnt findEntity(const char *name) = 0;
    virtual void offlinePackage(Package package) = 0;
    virtual void unloadPackage(Package package) = 0;

    // accessors for publishing.
    // this will not add to the package list
    // handling these packages will be your own task
    virtual Package openPackage(const char *packageName) = 0;
    virtual void closePackage(Package package) = 0;
    virtual PackageEnt addFileToPackage(const char *filename, Package package,
                                        const char *entityName) = 0;
    virtual Package mountPackage(Package package) = 0;
};
}
#endif