stringbuffer.h File Reference

Implements a general string buffer: it builds a string by concatenating. More...

#include "global.h"

Include dependency graph for stringbuffer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct StringBuffer	StringBuffer
	The string buffer state. More...

Functions
void	stringbuffer_append_printf (StringBuffer *sb, const char *format,...)
	Append a formatted string to a string buffer instance. More...
void	stringbuffer_append_string (StringBuffer *sb, const char *str)
	Append a string to a string buffer instance. More...
void	stringbuffer_append_stringbuffer (StringBuffer *sb, const StringBuffer *sb2)
	Append the contents of a string buffer instance to another string buffer instance. More...
void	stringbuffer_delete (StringBuffer *sb)
	Totally delete a string buffer. More...
char *	stringbuffer_finish (StringBuffer *sb)
	Deallocate the string buffer instance and return the string. More...
sstring	stringbuffer_finish_shared (StringBuffer *sb)
	Deallocate the string buffer instance and return the string as a shared string. More...
size_t	stringbuffer_length (StringBuffer *sb)
	Return the current length of the buffer. More...
StringBuffer *	stringbuffer_new (void)
	Create a new string buffer. More...

Detailed Description

Implements a general string buffer: it builds a string by concatenating.

It allocates enough memory to hold the whole string; there is no upper limit for the total string length.

Usage is: StringBuffer *sb = stringbuffer_new(); stringbuffer_append_string(sb, "abc"); stringbuffer_append_string(sb, "def"); ... more calls to stringbuffer_append_xxx() char *str = stringbuffer_finish(sb) ... use str free(str);

No function ever fails. In case not enough memory is availabl, fatal() is called.

Definition in file stringbuffer.h.

Typedef Documentation

typedef struct StringBuffer StringBuffer

The string buffer state.

Definition at line 31 of file stringbuffer.h.

Function Documentation

void stringbuffer_append_printf	(	StringBuffer *	sb,
		const char *	format,
			...
	)

Append a formatted string to a string buffer instance.

Parameters

sb	The string buffer to modify.
format	The format string to append.

Definition at line 104 of file stringbuffer.c.

References StringBuffer::buf, StringBuffer::pos, StringBuffer::size, stringbuffer_ensure(), and vsnprintf.

Referenced by artifact_describe(), artifact_msg(), cost_approx_str(), cost_string_from_value(), describe_attacktype(), describe_god(), describe_item(), describe_monster(), describe_resistance(), describe_spellpath_attenuation(), knowledge_alchemy_can_use_item(), knowledge_alchemy_detail(), knowledge_alchemy_summary(), knowledge_god_add(), knowledge_god_summary(), knowledge_message_detail(), knowledge_message_summary(), knowledge_monster_detail(), knowledge_monster_summary(), make_formula_book(), mon_desc(), mon_info_msg(), monster_format_say(), object_dump(), perceive_self(), power_crystal_describe(), power_crystal_type_apply(), real_money_value(), ring_desc(), save_object(), spellpath_msg(), START_TEST(), and write_map_parameters_to_string().

Here is the call graph for this function:

Here is the caller graph for this function:

void stringbuffer_append_string	(	StringBuffer *	sb,
		const char *	str
	)

Append a string to a string buffer instance.

Parameters

sb	The string buffer to modify.
str	The string to append.

Definition at line 95 of file stringbuffer.c.

References StringBuffer::buf, StringBuffer::pos, and stringbuffer_ensure().

Referenced by add_capacity(), artifact_describe(), artifact_msg(), cost_approx_str(), cost_string_from_value(), describe_attacktype(), describe_god(), describe_item(), describe_monster(), describe_resistance(), describe_spellpath_attenuation(), get_ob_diff(), get_string_move_type(), knowledge_alchemy_can_use_item(), knowledge_item_can_be_used_alchemy(), load_quests_from_file(), QuestManager::loadQuestFile(), make_formula_book(), mon_info_msg(), msgfile_msg(), object_dump(), object_set_msg(), perceive_self(), power_crystal_type_apply(), ring_desc(), spellpath_msg(), START_TEST(), and tailor_readable_ob().

Here is the call graph for this function:

Here is the caller graph for this function:

void stringbuffer_append_stringbuffer	(	StringBuffer *	sb,
		const StringBuffer *	sb2
	)

Append the contents of a string buffer instance to another string buffer instance.

Parameters

sb	The string buffer to modify.
sb2	The string buffer to append; it must be different from sb.

Definition at line 131 of file stringbuffer.c.

References StringBuffer::buf, StringBuffer::pos, and stringbuffer_ensure().

Referenced by artifact_describe(), artifact_msg(), describe_god(), and mon_info_msg().

Here is the call graph for this function:

Here is the caller graph for this function:

void stringbuffer_delete

(

StringBuffer *

sb

)

Totally delete a string buffer.

Parameters

sb	String to delete, pointer becomes invalid after the call.

Definition at line 71 of file stringbuffer.c.

References StringBuffer::buf.

Referenced by artifact_msg(), cost_approx_str(), god_info_msg(), and mon_info_msg().

Here is the caller graph for this function:

char* stringbuffer_finish

(

StringBuffer *

sb

)

Deallocate the string buffer instance and return the string.

The passed string buffer must not be accessed afterwards.

Parameters

sb	The string buffer to deallocate.

Returns

The result string; to free it, call free() on it.

Definition at line 76 of file stringbuffer.c.

References StringBuffer::buf, and StringBuffer::pos.

Referenced by add_one_item(), animate_object(), artifact_describe(), CREArtifactPanel::artifactChanged(), cfapi_object_describe(), command_diff(), command_dump(), command_dumpbelow(), common_ob_describe(), cost_approx_str(), cost_string_from_value(), describe_god(), dump_abilities(), dump_all_archetypes(), dump_gods(), gate_type_process(), generate_random_map(), knowledge_do_display(), knowledge_item_can_be_used_alchemy(), knowledge_process_incremental(), knowledge_show(), knowledge_show_monster_detail(), load_quests_from_file(), QuestManager::loadQuestFile(), make_formula_book(), monster_npc_say(), object_dump_all(), object_free2(), object_insert_in_map(), object_insert_in_ob(), object_remove(), perceive_self(), place_exits(), place_special_exit(), power_crystal_describe(), power_crystal_type_apply(), process_events(), query_base_name(), query_short_name(), save_object(), CRERandomMapPanel::setItem(), CREArtifactPanel::setItem(), CREArchetypePanel::setItem(), SockList_AddStringBuffer(), START_TEST(), CREMapInformationManager::storeCache(), stringbuffer_finish_shared(), and tailor_readable_ob().

Here is the caller graph for this function:

sstring stringbuffer_finish_shared

(

StringBuffer *

sb

)

Deallocate the string buffer instance and return the string as a shared string.

The passed string buffer must not be accessed afterwards.

Parameters

sb	The string buffer to deallocate.

Returns

The result shared string; to free it, call free_string() on it.

Definition at line 85 of file stringbuffer.c.

References add_string(), and stringbuffer_finish().

Referenced by knowledge_god_add(), make_formula_book(), mon_info_msg(), monster_do_talk_npc(), and object_set_msg().

Here is the call graph for this function:

Here is the caller graph for this function:

size_t stringbuffer_length

(

StringBuffer *

sb

)

Return the current length of the buffer.

Parameters

sb	The string buffer to check.

Returns

current length of sb.

Definition at line 154 of file stringbuffer.c.

References StringBuffer::pos.

Referenced by artifact_describe(), artifact_msg(), describe_god(), god_info_msg(), mon_info_msg(), ring_desc(), and spellpath_msg().

Here is the caller graph for this function:

StringBuffer* stringbuffer_new

(

void

)

Create a new string buffer.

Returns

The newly allocated string buffer.

Definition at line 57 of file stringbuffer.c.

References StringBuffer::buf, fatal(), OUT_OF_MEMORY, StringBuffer::pos, and StringBuffer::size.

Referenced by add_one_item(), animate_object(), artifact_describe(), artifact_msg(), command_diff(), command_dump(), command_dumpbelow(), cost_approx_str(), cost_string_from_value(), describe_attacktype(), describe_god(), describe_item(), describe_monster(), describe_resistance(), describe_spellpath_attenuation(), dump_all_archetypes(), gate_type_process(), god_info_msg(), knowledge_alchemy_can_use_item(), knowledge_do_display(), knowledge_god_add(), knowledge_process_incremental(), knowledge_show(), knowledge_show_monster_detail(), load_quests_from_file(), QuestManager::loadQuestFile(), make_formula_book(), mon_desc(), mon_info_msg(), monster_format_say(), msgfile_msg(), object_dump_all(), object_free2(), object_insert_in_map(), object_insert_in_ob(), object_remove(), object_set_msg(), perceive_self(), power_crystal_describe(), power_crystal_type_apply(), process_events(), ring_desc(), save_object(), CREArtifactPanel::setItem(), CREArchetypePanel::setItem(), spellpath_msg(), START_TEST(), and write_map_parameters_to_string().

Here is the call graph for this function:

Here is the caller graph for this function: