lumiera_/src/proc/assetmanager.hpp
Christian Thaeter 3654473b75 WIP: Merge common into lib
* breaks lumigui linking
 * test non functional yet
 * tools cant not be linked because of cross dependency problems
2008-12-17 17:53:32 +01:00

132 lines
3.5 KiB
C++

/*
ASSETMANAGER.hpp - Facade for the Asset subsystem
Copyright (C) Lumiera.org
2008, Hermann Vosseler <Ichthyostega@web.de>
This program 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.
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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/** @file assetmanager.hpp
** Proc-Layer Interface: Asset Lookup and Organization.
** Declares the AssetManager interface used to access individual
** Asset instances.
**
** These classes are placed into namespace asset and proc_interface.
**
** @see asset.hpp
** @see mobject.hpp
*/
#ifndef PROC_INTERFACE_ASSETMANAGER_H
#define PROC_INTERFACE_ASSETMANAGER_H
#include "pre_a.hpp"
#include "proc/asset.hpp"
#include "include/error.hpp"
#include "lib/singleton.hpp"
#include <cstddef>
#include <string>
#include <list>
#include <boost/utility.hpp>
using std::string;
using std::list;
namespace asset
{
class DB;
/**
* Facade for the Asset subsystem
*/
class AssetManager : private boost::noncopyable
{
asset::DB & registry;
public:
static lumiera::Singleton<AssetManager> instance;
/** provide the unique ID for given Asset::Ident tuple */
static ID<Asset> getID (const Asset::Ident&);
/** retrieve the registerd smart-ptr for any asset */
template<class KIND>
static P<KIND> wrap (const KIND& asset);
/** find and return corresponging object */
template<class KIND>
P<KIND> getAsset (const ID<KIND>& id) throw(lumiera::error::Invalid);
/** @return true if the given id is registered in the internal asset DB */
bool known (IDA id) ;
/** @return true if the given id is registered with the given Category */
bool known (IDA id, const Category& cat) ;
/**remove the given asset from the internal DB.
* <i>together with all its dependants</i> */
void remove (IDA id) ;
/** extract a sorted list of all registered Assets */
list<PcAsset> listContent() const;
protected:
/** registers an asset object in the internal DB, providing its unique key.
* @internal used by the Asset base class ctor to create Asset::id.
*/
template<class KIND>
static ID<KIND> reg (KIND* obj, const Asset::Ident& idi)
throw(lumiera::error::Invalid);
/** deleter function used by the Asset smart pointers to delete Asset objects */
static void destroy (Asset* aa) { delete aa; }
friend Asset::Asset (const Asset::Ident& idi);
AssetManager ();
friend class lumiera::singleton::StaticCreate<AssetManager>;
};
LUMIERA_ERROR_DECLARE (UNKNOWN_ASSET_ID); ///< use of a non-registered Asset ID.
LUMIERA_ERROR_DECLARE (WRONG_ASSET_KIND); ///< Asset ID of wrong Asset kind, unable to cast.
} // namespace asset
namespace proc_interface
{
using asset::AssetManager;
}
#endif