Collection of assets identified by a unique name. More...

#include <AssetsCollection.h>

Inheritance diagram for AssetsCollection< T, Key >:

Collaboration diagram for AssetsCollection< T, Key >:

Public Member Functions
void	clear ()
	Clear all assets. More...

size_t	count () const
	Get the number of assets. More...

T *	define (const Key &name, T *asset)
	Define an asset, erasing an existing one. More...

void	each (std::function< void(T *)> op)
	Apply a function to each asset. More...

T *	find (const Key &name)
	Get a named asset if it exists. More...

T *	first (std::function< bool(const T *)> op)
	Find the first asset matching some condition. More...

T *	get (const Key &name)
	Get a named asset. More...

std::vector< Key >	keys () const
	Get the names of all defined assets. More...

T *	next (T *current)
	Allow browsing assets in a list-like manner. More...

const std::set< Key > &	undefined () const
	Return the list of undefined assets, that is assets requested through get() but not defined through define(). More...

virtual	~AssetsCollection ()
	Destroy this instance and all assets it owns. More...

Protected Member Functions
virtual void	added (T *)
	An asset was either referenced (but undefined) or defined. More...

virtual void	replace (T existing, T update)=0
	Replace an asset by an updated version. More...

Protected Attributes
std::unordered_map< Key, T * >	m_assets
	Known assets. More...

std::set< Key >	m_undefined
	List of undefined assets. More...

Detailed Description

template<class T, class Key = std::string>
class AssetsCollection< T, Key >

Collection of assets identified by a unique name.

An asset is whetever is wanted, no assumption are done on the class.

A pointer to an asset returned by this class is deleted only when the AssetsCollection instance is destroyed. The contents of the asset itself may change though.

If an asset is searched for and created on the fly, it is marked as "undefined" until actually defined through a call to define().

Assets are owned by this instance, and deleted when the instance is destroyed or clear() is called. The asset_destroy() and asset_create() functions must be implemented for the type T and key Key.

Actual implementations must provide some pure virtual functions.

Definition at line 55 of file AssetsCollection.h.

Constructor & Destructor Documentation

◆ ~AssetsCollection()

template<class T , class Key = std::string>

virtual AssetsCollection< T, Key >::~AssetsCollection ( )

inlinevirtual

Destroy this instance and all assets it owns.

Definition at line 62 of file AssetsCollection.h.

Member Function Documentation

◆ added()

template<class T , class Key = std::string>

virtual void AssetsCollection< T, Key >::added ( T * )

inlineprotectedvirtual

An asset was either referenced (but undefined) or defined.

Reimplemented in Quests, Messages, Facesets, Faces, and AllAnimations.

Definition at line 203 of file AssetsCollection.h.

Referenced by AssetsCollection< Animations >::define(), and AssetsCollection< Animations >::get().

Here is the caller graph for this function:

◆ clear()

template<class T , class Key = std::string>

void AssetsCollection< T, Key >::clear ( )

inline

Clear all assets.

Definition at line 69 of file AssetsCollection.h.

Referenced by AssetsCollection< Animations >::~AssetsCollection().

Here is the caller graph for this function:

◆ count()

template<class T , class Key = std::string>

size_t AssetsCollection< T, Key >::count ( ) const

inline

Get the number of assets.

Returns: number.

Definition at line 80 of file AssetsCollection.h.

Referenced by assets_number_of_treasurelists(), get_faces_count(), malloc_info(), and quests_count().

Here is the caller graph for this function:

◆ define()

template<class T , class Key = std::string>

T* AssetsCollection< T, Key >::define	(	const Key &	name,
		T *	asset
	)

inline

Define an asset, erasing an existing one.

Parameters

name	unique asset name.
asset	new version of the asset. This pointer may become invalid and must not be used after the call.

Returns: asset with this name, either asset or the previous existing asset.

Definition at line 120 of file AssetsCollection.h.

Referenced by FacesetLoader::load(), ArchetypeLoader::load(), MessageLoader::load(), FaceLoader::load(), QuestLoader::load(), TreasureLoader::load(), and FaceLoader::loadAnimationBlock().

Here is the caller graph for this function:

◆ each()

template<class T , class Key = std::string>

void AssetsCollection< T, Key >::each ( std::function< void(T *)> op )

inline

Apply a function to each asset.

Parameters

op	function to apply.

Definition at line 158 of file AssetsCollection.h.

Referenced by archetypes_for_each(), assets_end_load(), assets_finish_archetypes_for_play(), build_class_list_reply(), build_race_list_reply(), cfapi_system_get_archetype_vector(), check_generators(), check_spells(), check_summoned(), do_pack(), dump_abilities(), dump_all_archetypes(), dump_animations(), dump_faces(), dump_monster_treasure(), dump_spells(), faces_for_each(), get_player_archetype(), get_spell_by_name(), pack_images(), polymorph_item(), polymorph_living(), print_monsters(), quest_for_each(), recipe_find_ingredient_cost(), send_image_info(), and send_map_info().

Here is the caller graph for this function:

◆ find()

template<class T , class Key = std::string>

T* AssetsCollection< T, Key >::find ( const Key & name )

inline

Get a named asset if it exists.

Parameters

name	asset name.

Returns: asset pointer guaranteed to live as long as this instance if the asset exists, nullptr else.

Definition at line 108 of file AssetsCollection.h.

Referenced by finish_races(), get_message_from_identifier(), quest_get_by_code(), try_find_animation(), try_find_archetype(), and try_find_face().

Here is the caller graph for this function:

◆ first()

template<class T , class Key = std::string>

T* AssetsCollection< T, Key >::first ( std::function< bool(const T *)> op )

inline

Find the first asset matching some condition.

Parameters

op	function which must return true if the asset matches, false else.

Returns: nullptr if no asset matches, else the first matching asset.

Definition at line 167 of file AssetsCollection.h.

◆ get()

template<class T , class Key = std::string>

T* AssetsCollection< T, Key >::get ( const Key & name )

inline

Get a named asset.

Parameters

name	asset name.

Returns: asset pointer guaranteed to live as long as this instance, never nullptr.

Definition at line 89 of file AssetsCollection.h.

Referenced by AssetsManager::AssetsManager(), find_animation(), find_archetype(), find_face(), find_treasurelist(), FacesetLoader::load(), PngLoader::load(), FaceLoader::load(), QuestLoader::load(), and TreasureLoader::loadTreasure().

Here is the caller graph for this function:

◆ keys()

template<class T , class Key = std::string>

std::vector<Key> AssetsCollection< T, Key >::keys ( ) const

inline

Get the names of all defined assets.

Returns: list of all names.

Definition at line 183 of file AssetsCollection.h.

◆ next()

template<class T , class Key = std::string>

T* AssetsCollection< T, Key >::next ( T * current )

inline

Allow browsing assets in a list-like manner.

Note: this function is not efficient, and should not be used in C++ code.

Parameters

current asset to get the next of, nullptr to get the first asset.

Returns: next asset, nullptr if no assets is defined or 'current' was the last one.

Definition at line 139 of file AssetsCollection.h.

Referenced by get_next_archetype().

Here is the caller graph for this function:

◆ replace()

template<class T , class Key = std::string>

virtual void AssetsCollection< T, Key >::replace	(	T *	existing,
		T *	update
	)

protectedpure virtual

Replace an asset by an updated version.

Parameters

existing	asset to be updated.
update	new version of the asset, which must be destroyed.

Implemented in Treasures, Quests, Messages, Facesets, Faces, Archetypes, and AllAnimations.

Referenced by AssetsCollection< Animations >::define().

Here is the caller graph for this function:

◆ undefined()

template<class T , class Key = std::string>

const std::set<Key>& AssetsCollection< T, Key >::undefined ( ) const

inline

Return the list of undefined assets, that is assets requested through get() but not defined through define().

Returns: list of undefined names.

Definition at line 177 of file AssetsCollection.h.

Referenced by AssetsManager::dumpUndefined().

Here is the caller graph for this function:

Field Documentation

◆ m_assets

template<class T , class Key = std::string>

std::unordered_map<Key, T*> AssetsCollection< T, Key >::m_assets

protected

Known assets.

Definition at line 190 of file AssetsCollection.h.

Referenced by AssetsCollection< Animations >::clear(), AssetsCollection< Animations >::count(), AssetsCollection< Animations >::define(), AssetsCollection< Animations >::each(), AssetsCollection< Animations >::find(), AssetsCollection< Animations >::first(), AssetsCollection< Animations >::get(), AssetsCollection< Animations >::keys(), and AssetsCollection< Animations >::next().

◆ m_undefined

template<class T , class Key = std::string>

std::set<Key> AssetsCollection< T, Key >::m_undefined

protected

List of undefined assets.

Definition at line 191 of file AssetsCollection.h.

Referenced by AssetsCollection< Animations >::define(), AssetsCollection< Animations >::get(), and AssetsCollection< Animations >::undefined().

The documentation for this class was generated from the following file:

crossfire-crossfire-server/include/AssetsCollection.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class T, class Key = std::string> class AssetsCollection< T, Key >

Constructor & Destructor Documentation

◆ ~AssetsCollection()

Member Function Documentation

◆ added()

◆ clear()

◆ count()

◆ define()

◆ each()

◆ find()

◆ first()

◆ get()

◆ keys()

◆ next()

◆ replace()

◆ undefined()

Field Documentation

◆ m_assets

◆ m_undefined

template<class T, class Key = std::string>
class AssetsCollection< T, Key >