assets.cpp File Reference

Handles asset collection. More...

#include <sys/stat.h>
#include "autoconf.h"
#include "global.h"
#include "compat.h"
#include "assets.h"
#include "AssetsManager.h"
#include "AssetCollector.h"
#include "TreasureLoader.h"
#include "ArchetypeLoader.h"
#include "PngLoader.h"
#include "FacesetLoader.h"
#include "FaceLoader.h"
#include "WrapperLoader.h"
#include "MessageLoader.h"
#include "QuestLoader.h"
#include "ArtifactLoader.h"
#include "Faces.h"
#include <string.h>
#include <set>
#include <unordered_map>
#include <memory>
#include "AssetWriter.h"
#include "TreasureWriter.h"
#include "FaceWriter.h"
#include "AnimationWriter.h"
#include "ArchetypeWriter.h"
#include "MessageWriter.h"
#include "image.h"
#include "FacesetWriter.h"
#include "ArtifactWriter.h"
#include "FormulaeWriter.h"
#include "QuestWriter.h"
#include "microtar.h"
#include "TarLoader.h"

Go to the source code of this file.

Macros
#define	MAX_PACK   100

Functions
static void	add_to_tar (mtar_t *tar, void *data, size_t len, const char *filename)
	Add a file to a .tar file. More...
void	archetypes_for_each (arch_op op)
void	assets_add_collector_hook (const char *name, collectorHook hook)
void	assets_collect (const char *datadir, int what)
	Collect all assets from the specified directory and all its subdirectories. More...
void	assets_end_load ()
	Called after collect is complete, to check various things. More...
void	assets_finish_archetypes_for_play ()
void	assets_free ()
	Free all assets-related memory. More...
void	assets_init ()
	Init assets-related variables. More...
size_t	assets_number_of_treasurelists ()
size_t	assets_number_of_treasures ()
void	assets_pack (const char *what, const char *filename)
	Pack the specified assets in a file. More...
static void	build_filename (const char *name, const char *prefix, char *dest, size_t max)
static void	check_generators (void)
	Check all generators have the other_arch set or something in inventory. More...
static void	check_spells (void)
	This ensures: More...
void	check_summoned (void)
	This checks all summonable items for move_type and other things. More...
static void	check_treasurelist (treasure *t, const treasurelist *tl)
	Checks if a treasure if valid. More...
template<class T >
static void	do_pack (AssetWriter< T > *writer, AssetsCollection< T > *assets, StringBuffer *buf)
void	faces_for_each (face_op op)
Animations *	find_animation (const char *name)
archetype *	find_archetype (const char *name)
const Face *	find_face (const char *name)
face_sets *	find_faceset (int id)
treasurelist *	find_treasurelist (const char *name)
	Search for the given treasurelist by name. More...
const Face *	get_face_by_id (uint16_t id)
	Get a face from its unique identifier. More...
size_t	get_faces_count ()
const GeneralMessage *	get_message_from_identifier (const char *identifier)
	Find the message from its identifier. More...
archetype *	get_next_archetype (archetype *current)
AssetsManager *	getManager ()
void	load_assets (void)
static void	pack_artifacts (StringBuffer *buf)
static void	pack_formulae (StringBuffer *buf)
static void	pack_images (mtar_t *tar)
	Pack all client-side images in the specified tar file. More...
quest_definition *	quest_find_by_code (sstring code)
	Find a quest from its code, logging if no matching quest. More...
void	quest_for_each (quest_op op, void *user)
	Iterate over all quests. More...
quest_definition *	quest_get_by_code (sstring code)
	Find a quest from its code if it exists. More...
size_t	quests_count (bool includeSystem)
Animations *	try_find_animation (const char *name)
archetype *	try_find_archetype (const char *name)
const Face *	try_find_face (const char *name, const Face *error)

Variables
static std::vector< std::pair< std::string, collectorHook > >	collector_hooks
	Collect hooks, as (filename, function) pairs. More...
static AssetsManager *	manager = nullptr
size_t	nroftreasures = 0
	Number of treasure items, for malloc info. More...

Detailed Description

Handles asset collection.

Definition in file assets.cpp.

Macro Definition Documentation

MAX_PACK

#define MAX_PACK   100

Referenced by assets_pack().

Function Documentation

add_to_tar()

static void add_to_tar ( mtar_t *  tar, void *  data, size_t  len, const char *  filename  )

static

Add a file to a .tar file.

Parameters

tar	where to add the file.
data	file content.
len	length of data.
filename	name in the .tar file.

Definition at line 386 of file assets.cpp.

References fatal(), llevError, LOG(), mtar_header_t::mode, MTAR_ESUCCESS, MTAR_TREG, mtar_write_data(), mtar_write_header(), mtar_header_t::mtime, mtar_header_t::name, SEE_LAST_ERROR, mtar_header_t::size, and mtar_header_t::type.

Referenced by assets_pack(), and pack_images().

archetypes_for_each()

void archetypes_for_each

(

arch_op

op

)

Definition at line 305 of file assets.cpp.

References AssetsManager::archetypes(), and AssetsCollection< T, Key >::each().

Referenced by cast_create_food(), init_gods(), init_mon_info(), init_skills(), and spellpath_msg().

assets_add_collector_hook()

void assets_add_collector_hook	(	const char *	name,
		collectorHook	hook
	)

Definition at line 556 of file assets.cpp.

References collector_hooks.

Referenced by add_server_collect_hooks(), cfcitybell_init(), and citylife_init().

assets_collect()

void assets_collect	(	const char *	datadir,
		int	what
	)

Collect all assets from the specified directory and all its subdirectories.

Parameters

datadir	directory to search from.
what	combination of

See also

Assets flags flags indicating what to collect.

Definition at line 113 of file assets.cpp.

References AssetCollector::addLoader(), AssetsManager::animations(), AssetsManager::archetypes(), artifact_post_load(), ASSETS_ARCHETYPES, ASSETS_ARTIFACTS, ASSETS_ATTACK_MESSAGES, ASSETS_FACES, ASSETS_FACESETS, ASSETS_FORMULAE, ASSETS_MESSAGES, ASSETS_PNG, ASSETS_QUESTS, ASSETS_REGIONS, Settings::assets_tracker, ASSETS_TREASURES, AssetCollector::collect(), collector_hooks, AssetsManager::faces(), AssetsManager::facesets(), init_attackmess(), init_formulae(), init_regions(), llevInfo, LOG(), AssetsManager::messages(), AssetsManager::quests(), settings, and AssetsManager::treasures().

Referenced by command_purge_quest_definitions(), and load_assets().

assets_end_load()

void assets_end_load

(

)

Called after collect is complete, to check various things.

Definition at line 231 of file assets.cpp.

References check_formulae(), check_generators(), check_recipes(), check_spells(), check_summoned(), AssetsCollection< T, Key >::each(), and AssetsManager::treasures().

Referenced by load_assets().

assets_finish_archetypes_for_play()

void assets_finish_archetypes_for_play

(

)

Definition at line 513 of file assets.cpp.

References AssetsManager::archetypes(), archetype::clone, AssetsCollection< T, Key >::each(), and object::speed.

Referenced by command_recollect(), and init_beforeplay().

assets_free()

void assets_free

(

)

Free all assets-related memory.

Definition at line 72 of file assets.cpp.

References manager.

Referenced by free_globals().

assets_init()

void assets_init

(

)

Init assets-related variables.

Definition at line 65 of file assets.cpp.

Referenced by init_library().

assets_number_of_treasurelists()

size_t assets_number_of_treasurelists

(

)

Definition at line 262 of file assets.cpp.

References AssetsCollection< T, Key >::count(), and AssetsManager::treasures().

Referenced by malloc_info().

assets_number_of_treasures()

size_t assets_number_of_treasures

(

)

Definition at line 259 of file assets.cpp.

References nroftreasures.

Referenced by malloc_info().

assets_pack()

void assets_pack	(	const char *	type,
		const char *	filename
	)

Pack the specified assets in a file.

Parameters

type	assets type, see actual implementation.
filename	destination file.

Definition at line 422 of file assets.cpp.

References add_to_tar(), AssetsManager::animations(), AssetsManager::archetypes(), buf, do_pack(), AssetsManager::faces(), AssetsManager::facesets(), fatal(), llevError, LOG(), MAX_PACK, AssetsManager::messages(), mtar_close(), MTAR_ESUCCESS, mtar_finalize(), mtar_open(), pack_artifacts(), pack_formulae(), pack_images(), AssetsManager::quests(), SEE_LAST_ERROR, split(), split_string(), strdup_local, stringbuffer_delete(), stringbuffer_finish(), stringbuffer_length(), stringbuffer_new(), and AssetsManager::treasures().

Referenced by server_pack_assets().

build_filename()

static void build_filename ( const char *  name, const char *  prefix, char *  dest, size_t  max  )

static

Definition at line 364 of file assets.cpp.

Referenced by pack_images().

check_generators()

static void check_generators ( void  )

static

Check all generators have the other_arch set or something in inventory.

Definition at line 158 of file assets.cpp.

References AssetsManager::archetypes(), AssetsCollection< T, Key >::each(), fatal(), FLAG_CONTENT_ON_GEN, FLAG_GENERATOR, QUERY_FLAG, and SEE_LAST_ERROR.

Referenced by assets_end_load().

check_spells()

static void check_spells ( void  )

static

This ensures:

• all spells have a valid skill defined
• spell_mapping contains valid spells fatal() is called if any error was found.

Definition at line 202 of file assets.cpp.

References AssetsManager::archetypes(), AssetsCollection< T, Key >::each(), fatal(), llevError, LOG(), SEE_LAST_ERROR, SPELL, spell_mapping, and try_find_archetype().

Referenced by assets_end_load().

check_summoned()

void check_summoned

(

void

)

This checks all summonable items for move_type and other things.

Will call fatal() if an error is found.

Definition at line 185 of file assets.cpp.

References AssetsManager::archetypes(), AssetsCollection< T, Key >::each(), SP_SUMMON_GOLEM, and SPELL.

Referenced by assets_end_load().

check_treasurelist()

static void check_treasurelist ( treasure *  t, const treasurelist *  tl  )

static

Checks if a treasure if valid.

Will also check its yes and no options.

Will LOG() to error.

Parameters

t	treasure to check.
tl	needed only so that the treasure name can be printed out.

Definition at line 93 of file assets.cpp.

References treasure::chance, find_treasurelist(), treasure::item, llevError, LOG(), treasure::name, treasurelist::name, treasure::next, treasure::next_no, and treasure::next_yes.

do_pack()

template<class T >

static void do_pack ( AssetWriter< T > *  writer, AssetsCollection< T > *  assets, StringBuffer *  buf  )

static

Definition at line 337 of file assets.cpp.

References AssetsCollection< T, Key >::each(), and AssetWriter< T >::write().

Referenced by assets_pack().

faces_for_each()

void faces_for_each

(

face_op

op

)

Definition at line 301 of file assets.cpp.

References AssetsCollection< T, Key >::each(), and AssetsManager::faces().

find_animation()

Animations* find_animation

(

const char *

name

)

Definition at line 278 of file assets.cpp.

References AssetsManager::animations(), and AssetsCollection< T, Key >::get().

Referenced by mimic_type_apply(), and transport_type_apply().

find_archetype()

archetype* find_archetype

(

const char *

name

)

Definition at line 270 of file assets.cpp.

References AssetsManager::archetypes(), and AssetsCollection< T, Key >::get().

Referenced by animate_bomb(), apply_builder_window(), apply_map_builder(), can_pay(), cast_raise_dead_spell(), change_luck(), drain_specific_stat(), find_enclosed_spot(), find_next_coin(), fix_flesh_item(), init_archetype_pointers(), kill_player_not_permadeath(), kill_player_permadeath(), make_formula_book(), msgfile_msg(), object_replace_insert_in_map(), op_on_battleground(), pay_from_container(), place_exits(), place_fountain_with_specials(), poison_living(), process_map(), put_in_icecube(), remove_depletion(), restore_player(), save_object_in_sb(), sell_item(), and slow_living_by().

find_face()

const Face* find_face

(

const char *

name

)

Definition at line 286 of file assets.cpp.

References AssetsManager::faces(), and AssetsCollection< T, Key >::get().

Referenced by MessageLoader::load(), and FaceLoader::loadAnimationBlock().

find_faceset()

face_sets* find_faceset

(

int

id

)

Definition at line 332 of file assets.cpp.

References AssetsManager::facesets(), and Facesets::findById().

Referenced by esrv_send_face(), get_face_fallback(), is_valid_faceset(), main(), process_map(), and send_image_sums().

find_treasurelist()

treasurelist* find_treasurelist

(

const char *

name

)

Search for the given treasurelist by name.

Parameters

name	treasure list to search.

Returns

match, or NULL if treasurelist doesn't exist or is 'none'.

Definition at line 253 of file assets.cpp.

References AssetsCollection< T, Key >::get(), and AssetsManager::treasures().

Referenced by apply_race_and_class(), check_treasurelist(), create_all_treasures(), create_one_treasure(), do_harvest(), dragon_ability_gain(), dump_monster_treasure_rec(), find_treasure_by_name(), god_intervention(), key_change_class(), place_chest(), and resurrect_player().

get_face_by_id()

const Face* get_face_by_id

(

uint16_t

id

)

Get a face from its unique identifier.

Parameters

id	face identifier.

Returns

matching face, NULL if no face with this identifier.

Todo:

move back to image.c when migrated

Definition at line 319 of file assets.cpp.

References AssetsManager::faces(), and Faces::findById().

Referenced by ask_smooth_cmd(), cfapi_system_find_face(), send_face_cmd(), and send_image_sums().

get_faces_count()

size_t get_faces_count

(

void

)

Definition at line 297 of file assets.cpp.

References AssetsCollection< T, Key >::count(), and AssetsManager::faces().

Referenced by init_connection(), main(), new_connection(), reset_faces_sent(), send_image_info(), and send_image_sums().

get_message_from_identifier()

const GeneralMessage* get_message_from_identifier

(

const char *

identifier

)

Find the message from its identifier.

Parameters

identifier

message's identifier.

Returns

corresponding message, NULL if no such message.

Definition at line 328 of file assets.cpp.

References AssetsCollection< T, Key >::find(), and AssetsManager::messages().

Referenced by knowledge_message_detail(), knowledge_message_face(), knowledge_message_summary(), and knowledge_message_validate().

get_next_archetype()

archetype* get_next_archetype

(

archetype *

current

)

Definition at line 266 of file assets.cpp.

References AssetsManager::archetypes(), and AssetsCollection< T, Key >::next().

Referenced by artifact_get_face(), and cfapi_archetype_get_property().

getManager()

AssetsManager* getManager

(

)

Definition at line 309 of file assets.cpp.

References manager.

Referenced by build_class_list_reply(), build_race_list_reply(), cfapi_system_get_archetype_vector(), create_archetype_by_object_name(), dump_abilities(), dump_all_archetypes(), dump_animations(), dump_faces(), dump_monster_treasure(), dump_spells(), find_archetype_by_object_name(), find_archetype_by_object_type_name(), finish_races(), get_archetype_by_skill_name(), get_archetype_by_type_subtype(), get_player_archetype(), get_spell_by_name(), init_library(), malloc_info(), msgfile_msg(), polymorph_item(), polymorph_living(), print_monsters(), recipe_find_ingredient_cost(), send_image_info(), and send_map_info().

load_assets()

void load_assets

(

void

)

Definition at line 551 of file assets.cpp.

References ASSETS_ALL, assets_collect(), assets_end_load(), Settings::datadir, and settings.

Referenced by command_recollect(), and init_library().

pack_artifacts()

static void pack_artifacts ( StringBuffer *  buf )

static

Definition at line 344 of file assets.cpp.

References first_artifactlist, artifactlist::items, artifactlist::next, and ArtifactWriter::write().

Referenced by assets_pack().

pack_formulae()

static void pack_formulae ( StringBuffer *  buf )

static

Definition at line 355 of file assets.cpp.

References get_formulalist(), recipelist::next, and FormulaeWriter::write().

Referenced by assets_pack().

pack_images()

static void pack_images ( mtar_t *  tar )

static

Pack all client-side images in the specified tar file.

Parameters

tar	where to pack images.

Definition at line 409 of file assets.cpp.

References add_to_tar(), build_filename(), AssetsCollection< T, Key >::each(), AssetsManager::faces(), and AssetsManager::facesets().

Referenced by assets_pack().

quest_find_by_code()

quest_definition* quest_find_by_code

(

sstring

code

)

Find a quest from its code, logging if no matching quest.

Parameters

code	quest to search.

Returns

quest, or NULL if no such quest.

Definition at line 523 of file assets.cpp.

References llevError, LOG(), and quest_get_by_code().

Referenced by get_quest_by_number(), quest_display(), quest_get_player_state(), quest_info(), quest_set_state(), and quest_start().

quest_for_each()

void quest_for_each	(	quest_op	op,
		void *	user
	)

Iterate over all quests.

Parameters

op	function to call for each quest.
user	extra parameter to give the function.

Definition at line 543 of file assets.cpp.

References AssetsCollection< T, Key >::each(), and AssetsManager::quests().

Referenced by dump_quests(), main(), output_quests(), and update_quests().

quest_get_by_code()

quest_definition* quest_get_by_code

(

sstring

code

)

Find a quest from its code if it exists.

Returns

quest, or NULL if no such quest.

Definition at line 534 of file assets.cpp.

References AssetsCollection< T, Key >::find(), and AssetsManager::quests().

Referenced by command_quest(), quest_find_by_code(), quest_read_player_data(), and quest_send_initial_states().

quests_count()

size_t quests_count

(

bool

includeSystem

)

Definition at line 547 of file assets.cpp.

References AssetsCollection< T, Key >::count(), AssetsManager::quests(), and Quests::visibleCount().

try_find_animation()

Animations* try_find_animation

(

const char *

name

)

Definition at line 282 of file assets.cpp.

References AssetsManager::animations(), and AssetsCollection< T, Key >::find().

Referenced by add_abilities(), apply_anim_suffix(), apply_changes_to_player(), cfapi_object_set_property(), cfapi_system_find_animation(), move_aura(), object_give_identified_properties(), and write_rune().

try_find_archetype()

archetype* try_find_archetype

(

const char *

name

)

Definition at line 274 of file assets.cpp.

References AssetsManager::archetypes(), and AssetsCollection< T, Key >::find().

Referenced by alchemy_object(), annotate_ob(), artifact_describe(), artifact_get_face(), cast_consecrate(), cast_create_missile(), cast_heal(), cfapi_map_find_by_archetype_name(), cfapi_object_create(), cfapi_object_find_archetype_inside(), check_formulae(), check_probe(), check_recipe(), check_spells(), command_create(), create_archetype(), create_player_cmd(), do_harvest(), dump_alchemy(), dump_alchemy_costs(), fix_walls(), get_npc(), knowledge_alchemy_can_use_item(), knowledge_alchemy_detail(), knowledge_alchemy_summary(), knowledge_god_face(), knowledge_monster_detail(), knowledge_monster_face(), knowledge_monster_summary(), knowledge_monster_validate(), magic_wall(), perceive_self(), pick_joined_wall(), place_exits(), put_a_monster(), recipe_get_face(), retrofit_joined_wall(), send_arch_info(), send_class_info(), send_race_info(), and town_portal_destroy_existing().

try_find_face()

const Face* try_find_face	(	const char *	name,
		const Face *	error
	)

Definition at line 290 of file assets.cpp.

References AssetsManager::faces(), and AssetsCollection< T, Key >::find().

Referenced by add_abilities(), cfapi_object_set_property(), cfapi_system_find_face(), fix_flesh_item(), knowledge_process_incremental(), knowledge_send_info(), object_give_identified_properties(), send_account_players(), set_object_face_main(), set_object_face_other(), transport_type_apply(), and write_rune().

Variable Documentation

collector_hooks

std::vector<std::pair<std::string, collectorHook> > collector_hooks

static

Collect hooks, as (filename, function) pairs.

Definition at line 60 of file assets.cpp.

Referenced by assets_add_collector_hook(), and assets_collect().

manager

AssetsManager* manager = nullptr

static

Definition at line 59 of file assets.cpp.

Referenced by assets_free(), and getManager().

nroftreasures

size_t nroftreasures = 0

Number of treasure items, for malloc info.

Definition at line 80 of file assets.cpp.

Referenced by assets_number_of_treasures(), TreasureLoader::loadTreasure(), and TreasureLoader::TreasureLoader().