Crossfire Server, Trunk
stringbuffer.h File Reference
#include <ctype.h>
#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
 

Functions

void stringbuffer_append_char (StringBuffer *sb, const char c)
 
void stringbuffer_append_int64 (StringBuffer *sb, int64_t x)
 
void stringbuffer_append_multiline_block (StringBuffer *sb, const char *start, const char *content, const char *end)
 
void stringbuffer_append_printf (StringBuffer *sb, const char *format,...)
 
void stringbuffer_append_string (StringBuffer *sb, const char *str)
 
void stringbuffer_append_stringbuffer (StringBuffer *sb, const StringBuffer *sb2)
 
void stringbuffer_delete (StringBuffer *sb)
 
char * stringbuffer_finish (StringBuffer *sb)
 
sstring stringbuffer_finish_shared (StringBuffer *sb)
 
size_t stringbuffer_length (StringBuffer *sb)
 
StringBufferstringbuffer_new (void)
 
void stringbuffer_trim_whitespace (StringBuffer *sb)
 

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, {} is called.

Definition in file stringbuffer.h.

Typedef Documentation

◆ StringBuffer

typedef struct StringBuffer StringBuffer

The string buffer state.

Definition at line 33 of file stringbuffer.h.

Function Documentation

◆ stringbuffer_append_char()

void stringbuffer_append_char ( StringBuffer sb,
const char  c 
)

Append a character to a string buffer instance.

Parameters
sbThe string buffer to modify.
cThe string to append.

Definition at line 104 of file stringbuffer.c.

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

Referenced by FAST_SAVE_LONG(), and stringbuffer_append_int64().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ stringbuffer_append_int64()

void stringbuffer_append_int64 ( StringBuffer sb,
int64_t  x 
)

Append a signed integer to a string buffer instance. This is intended to be faster than using stringbuffer_append_printf().

Parameters
sbThe string buffer to modify.
xThe signed integer to append.

Definition at line 111 of file stringbuffer.c.

References buf, stringbuffer_append_char(), and diamondslots::x.

Referenced by FAST_SAVE_LONG(), and START_TEST().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ stringbuffer_append_multiline_block()

void stringbuffer_append_multiline_block ( StringBuffer sb,
const char *  start,
const char *  content,
const char *  end 
)

Append the specified content in a multiline block, starting with "start" and ending with "end". "start" and "end" must not end with a newline.

Parameters
sbThe string buffer to modify.
startThe text to write to signify the start of the contents.
contentThe actual content, which may contain multilines. If NULL of empty string, nothing is written.
endThe text to write to signify the end of the contents. If NULL then "end_<start>" will be used.

Definition at line 196 of file stringbuffer.c.

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

Referenced by QuestWriter::write().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ stringbuffer_append_printf()

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

◆ stringbuffer_append_string()

◆ stringbuffer_append_stringbuffer()

void stringbuffer_append_stringbuffer ( StringBuffer sb,
const StringBuffer sb2 
)

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

Parameters
sbThe string buffer to modify.
sb2The string buffer to append; it must be different from sb.

Definition at line 165 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:

◆ stringbuffer_delete()

void stringbuffer_delete ( StringBuffer sb)

Totally delete a string buffer.

Parameters
sbString to delete, pointer becomes invalid after the call.

Definition at line 71 of file stringbuffer.c.

References StringBuffer::buf.

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

+ Here is the caller graph for this function:

◆ stringbuffer_finish()

char* stringbuffer_finish ( StringBuffer sb)

Deallocate the string buffer instance and return the string.

The passed string buffer must not be accessed afterwards.

Parameters
sbThe 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, StringBuffer::pos, and rotate-tower::result.

Referenced by add_one_item(), animate_object(), artifact_describe(), ArtifactPanel::artifactChanged(), assets_pack(), cfapi_object_describe(), check_sb_equals(), command_bowmode(), command_diff(), command_dump(), common_ob_describe(), cost_approx_str(), cost_string_from_value(), describe_god(), do_dump(), dump_abilities(), dump_all_archetypes(), dump_gods(), examine(), gate_type_process(), generate_random_map(), knowledge_add_probe_monster(), knowledge_do_display(), knowledge_item_can_be_used_alchemy(), knowledge_process_incremental(), knowledge_show(), lamp_type_describe(), QuestLoader::load(), make_formula_book(), monster_npc_say(), object_dump_all(), object_free(), 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(), Archetypes::recursive_update(), save_object(), save_objects(), SockList_AddStringBuffer(), spellbook_type_apply(), spellbook_type_describe(), START_TEST(), CREMapInformationManager::storeCache(), stringbuffer_finish_shared(), tailor_readable_ob(), CRERandomMapPanel::updateItem(), ArtifactPanel::updateItem(), ArchetypePanel::updateItem(), ModifiedAssetsManager< archt >::write(), and write_load().

◆ stringbuffer_finish_shared()

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
sbThe 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(), rotate-tower::result, sstring, make_face_from_files::str, and stringbuffer_finish().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ stringbuffer_length()

size_t stringbuffer_length ( StringBuffer sb)

Return the current length of the buffer.

Parameters
sbThe string buffer to check.
Returns
current length of sb.

Definition at line 218 of file stringbuffer.c.

References StringBuffer::pos.

Referenced by artifact_describe(), artifact_msg(), assets_pack(), describe_god(), do_spellpath_msg(), god_info_msg(), mon_info_msg(), ring_desc(), ModifiedAssetsManager< archt >::write(), and write_load().

+ Here is the caller graph for this function:

◆ stringbuffer_new()

StringBuffer* stringbuffer_new ( void  )

◆ stringbuffer_trim_whitespace()

void stringbuffer_trim_whitespace ( StringBuffer sb)

Trim trailing whitespace from a stringbuffer.

Parameters
sbThe stringbuffer.

Definition at line 222 of file stringbuffer.c.

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

Referenced by examine(), and spellbook_type_apply().

+ Here is the caller graph for this function: