CBuild wiki

StringBuilder.h

Dynamic string - string builder. Specialization of DynArray.h for char datatype.

License: GPL-3.0-or-later.

cbuild_sb_t

typedef struct cbuild_sb_t {
char* data;
size_t size;
size_t capacity;
} cbuild_sb_t;

String builder string builder.

  • char* data Pointer to data. This pointer “owns” the data.
  • size_t size Length of string builder. Data in range from data to data+size is guaranteed to be valid.
  • size_t capacity Length of allocated data. Data is guaranteed to be allocated (but may be not initialized) from data to data+size.

CBuildSBFmt

#define CBuildSBFmt

Format description for string view for printf-style formatters.

CBuildSBArg

#define CBuildSBArg(sb)

Format argument for string view for printf-style formatters.

cbuild_sb_append

#define cbuild_sb_append(sb, elem)

Append new element to string builder.

  • cbuild_sb_t* sb String builder object.
  • char elem Element to append.

cbuild_sb_append_arr

#define cbuild_sb_append_arr(sb, arr, size)

Append new elements to string builder.

  • cbuild_sb_t* sb String builder object.
  • char* arr Elements to append.
  • size_t arr_size Number of elements to append.

cbuild_sb_append_many

#define cbuild_sb_append_many(sb, ...)

Append new elements to string builder.

  • cbuild_sb_t* sb String builder object.
  • char … Elements to append.

cbuild_sb_append_cstr

#define cbuild_sb_append_cstr(sb, cstr)

Append c-string to string builder.

  • cbuild_sb_t* sb String builder object.
  • char* cstr C-string (NULL-terminated).

cbuild_sb_append_null

#define cbuild_sb_append_null(sb)

Append NULL-terminator to string builder.

cbuild_sb_set

#define cbuild_sb_set(sb, idx, elem)

Set element in string builder using its index.

  • cbuild_sb_t* sb String builder object.
  • size_t idx Element index.
  • char elem New element’s value.

bool False on overflow.

cbuild_sb_get

#define cbuild_sb_get(sb, idx)

Get element from string builder using its index.

char Pointer to an element or NULL if index out of bounds.

cbuild_sb_remove

#define cbuild_sb_remove(sb, idx)

Remove element string builder using its index.

  • cbuild_sb_t* sb String builder object.
  • size_t idx Element index.

bool False on overflow.

cbuild_sb_resize

#define cbuild_sb_resize(sb, new_capacity)

Resize string builder.

  • cbuild_sb_t* sb String builder object.
  • size_t new_size Resize string builder. If new_size equal 0 default growth strategy will be used.

cbuild_sb_clear

#define cbuild_sb_clear(sb)

Free string builder.

This should be used only if you want to free underlying memory, if you just want to clear array and reuse it, setting size to 0 would be much faster.

cbuild_sb_foreach

#define cbuild_sb_foreach(sb, iter)

Foreach implementation for string builder. Same semantics as ‘for’ loop.

  • cbuild_sb_t* sb String builder object.
  • name iter Name if variable that will be used as iterator. Will have type char.

cbuild_sb_cmp

CBUILDDEF int cbuild_sb_cmp(cbuild_sb_t a, cbuild_sb_t b);

strcmp for string builder. Fully compatible but extends API.

  • -2 If size of first string builder is smaller.
  • -1 If first different character in first string builder is smaller.
  • 0 If two string builders are equal.
  • 1 If first different character in first string builder is larger.
  • 2 If size of first string builder is larger.

cbuild_sb_cmp_icase

CBUILDDEF int cbuild_sb_cmp_icase(cbuild_sb_t a, cbuild_sb_t b);

strcmp for string builder. Fully compatible but extends API. Performs case folding for ASCII.

  • -2 If size of first string builder is smaller.
  • -1 If first different character in first string builder is smaller.
  • 0 If two string builders are equal.
  • 1 If first different character in first string builder is larger.
  • 2 If size of first string builder is larger.

cbuild_sb_append_utf8

CBUILDDEF void cbuild_sb_append_utf8(cbuild_sb_t* sb, uint32_t cp);

Append utf8 character to a string builder.

  • cbuild_sb_t* sb String builder object.
  • uint32_t cp UTF8 codepoint.

cbuild_sb_utf8len

CBUILDDEF size_t cbuild_sb_utf8len(cbuild_sb_t sb);

Get length of a string builder in utf8 codepoints.

Invalid codepoints assumed to have length of 1

cbuild_sb_to_sv

CBUILDDEF cbuild_sv_t cbuild_sb_to_sv(cbuild_sb_t sb);

Convert string builder to a string view.

cbuild_sv_from_sb

#define cbuild_sv_from_sb(sb)

Convert string builder to a string view.

cbuild_sv_to_sb

CBUILDDEF cbuild_sb_t cbuild_sv_to_sb(cbuild_sv_t sv);

Convert string view to a string builder (allocated new data).

cbuild_sb_from_sv

#define cbuild_sb_from_sv(sv)

Convert string view to a string builder (allocated new data).

cbuild_sb_append_sv

#define cbuild_sb_append_sv(sb, sv)

Apppend string view to a string builder

cbuild_sb_appendf

CBUILD_ATTR_PRINTF(2,
CBUILDDEF int cbuild_sb_appendf(cbuild_sb_t* sb, const char* fmt, ...));

Append data to a string builder using printf-style format string.

cbuild_sb_vappendf

CBUILDDEF int cbuild_sb_vappendf(cbuild_sb_t* sb, const char* fmt, va_list args);

Append data to a string builder using printf-style format string.