CBuild wiki

StringView.h

Implementation of string view in C.

License: GPL-3.0-or-later.

cbuild_sv_t

typedef struct cbuild_sv_t {
char*  data;
size_t size;
} cbuild_sv_t;

String view datatype

  • char* data Pointer into data. This pointer does not “own” its data.
  • size_t size Length of string view. Data in range from data to data+size is guaranteed to be valid.

CBuildSVFmt

#define CBuildSVFmt

Format description for string view for printf-style formatters.

CBuildSVArg

#define CBuildSVArg(sv)

Format argument for string view for printf-style formatters.

cbuild_sv_from_parts

#define cbuild_sv_from_parts(_data, _size)

Create new string view from raw parts

cbuild_sv_from_cstr

#define cbuild_sv_from_cstr(cstr)

Create new string view from C-string.

cbuild_sv_from_lit

#define cbuild_sv_from_lit(lit)

Create new string view from C-string literal (compile-time).

cbuild_sv_trim_left

CBUILDDEF size_t cbuild_sv_trim_left(cbuild_sv_t* sv);

Trim whitespaces from a string view starting from the left.

size_t Number of characters removed.

cbuild_sv_trim_right

CBUILDDEF size_t cbuild_sv_trim_right(cbuild_sv_t* sv);

Trim whitespaces from a string view starting from the right.

size_t Number of characters removed.

cbuild_sv_trim

CBUILDDEF size_t cbuild_sv_trim(cbuild_sv_t* sv);

Trim whitespaces from a string view starting from both sides.

size_t Number of characters removed.

cbuild_sv_chop

CBUILDDEF cbuild_sv_t cbuild_sv_chop(cbuild_sv_t* sv, size_t size);

Chop sizesize_t characters from string view starting from the left.

  • cbuild_sv_t* sv String view from which data will be chopped. Its size will be reduced.
  • size_t size Number of character that will be chopped.

cbuild_sv_t New string view containing chopped characters.

cbuild_sv_chop_right

CBUILDDEF cbuild_sv_t cbuild_sv_chop_right(cbuild_sv_t* sv, size_t size);

Chop sizesize_t characters from string view starting from the right.

  • cbuild_sv_t* sv String view from which data will be chopped. Its size will be reduced.
  • size_t size Number of character that will be chopped.

cbuild_sv_t New string view containing chopped characters.

cbuild_sv_chop_by_delim

CBUILDDEF cbuild_sv_t cbuild_sv_chop_by_delim(cbuild_sv_t* sv, char delim);

Chop characters from string view starting from the left until delimchar is found.

  • cbuild_sv_t* sv String view from which data will be chopped. Its size will be reduced.
  • char delim Delimiter character.

cbuild_sv_t New string view containing chopped characters. delimchar will not be included.

cbuild_sv_chop_right_by_delim

CBUILDDEF cbuild_sv_t cbuild_sv_chop_right_by_delim(cbuild_sv_t* sv, char delim);

Chop characters from string view starting from the right until delimchar is found.

  • cbuild_sv_t* sv String view from which data will be chopped. Its size will be reduced.
  • char delim Delimiter character.

cbuild_sv_t New string view containing chopped characters. delimchar will not be included.

cbuild_sv_chop_by_sv

CBUILDDEF cbuild_sv_t cbuild_sv_chop_by_sv(cbuild_sv_t* sv, cbuild_sv_t delim);

Chop characters from string view starting from the left until delimcbuild_sv_t is found.

  • cbuild_sv_t* sv String view from which data will be chopped. Its size will be reduced.
  • cbuild_sv_t delim Delimiter string view.

cbuild_sv_t New string view containing chopped characters. delimcbuild_sv_t will not be included.

cbuild_sv_chop_right_by_sv

CBUILDDEF cbuild_sv_t cbuild_sv_chop_right_by_sv(cbuild_sv_t* sv, cbuild_sv_t delim);

Chop characters from string view starting from the right until delimcbuild_sv_t is found.

  • cbuild_sv_t* sv String view from which data will be chopped. Its size will be reduced.
  • cbuild_sv_t delim Delimiter string view.

cbuild_sv_t New string view containing chopped characters. delimcbuild_sv_t will not be included.

cbuild_sv_delim_func

typedef bool (*cbuild_sv_delim_func)(const cbuild_sv_t* sv, size_t idx, void* args);

Delimiter function. Used as comparator in cbuild_sv_chop_by_func and cbuild_sv_chop_right_by_func

  • const cbuild_sv_t* sv String view passed to function.
  • size_t idx Current character.
  • void* args Arguments passed by caller.

bool If true is returned this character will be considered a delimiter

cbuild_sv_chop_by_func

CBUILDDEF cbuild_sv_t cbuild_sv_chop_by_func(cbuild_sv_t* sv,
cbuild_sv_delim_func delim, void* args);

chop characters from string view starting from the left until delimcbuild_sv_delim_func returns true.

  • cbuild_sv_t* sv String view from which data will be chopped. its size will be reduced.
  • cbuild_sv_delim_func delim Delimiter function.
  • void* args Arguments to a function.

cbuild_sv_t new string view containing chopped characters. delimeter character will not be in any string view.

cbuild_sv_chop_right_by_func

CBUILDDEF cbuild_sv_t cbuild_sv_chop_right_by_func(cbuild_sv_t* sv,
cbuild_sv_delim_func delim, void* args);

chop characters from string view starting from the right until delimcbuild_sv_delim_func returns true.

  • cbuild_sv_t* sv String view from which data will be chopped. Its size will be reduced.
  • cbuild_sv_delim_func delim Delimiter function.
  • void* args Arguments to a function.

cbuild_sv_t new string view containing chopped characters. Delimiter character will not be in any string view.

cbuild_sv_cmp

CBUILDDEF int cbuild_sv_cmp(cbuild_sv_t a, cbuild_sv_t b);

strcmp for string view. Fully compatible but extends API.

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

cbuild_sv_cmp_icase

CBUILDDEF int cbuild_sv_cmp_icase(cbuild_sv_t a, cbuild_sv_t b);

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

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

cbuild_sv_prefix

CBUILDDEF bool cbuild_sv_prefix(cbuild_sv_t sv, cbuild_sv_t prefix);

Check if string view has specific prefix.

cbuild_sv_suffix

CBUILDDEF bool cbuild_sv_suffix(cbuild_sv_t sv, cbuild_sv_t suffix);

Check if string view has specific suffix.

cbuild_sv_find

CBUILDDEF ssize_t cbuild_sv_find(cbuild_sv_t sv, char c);

Find specific character in string view.

ssize_t Index of character or -1 if not found

cbuild_sv_find_sv

CBUILDDEF ssize_t cbuild_sv_find_sv(cbuild_sv_t sv, cbuild_sv_t needle);

Find specific substring (provided as string view) in another string view.

ssize_t Index of first character of needlecbuild_sv_t or -1 if not found

cbuild_sv_rfind

CBUILDDEF ssize_t cbuild_sv_rfind(cbuild_sv_t sv, char c);

Find specific character in string view. Searches from the end.

ssize_t Index of character or -1 if not found

cbuild_sv_contains

CBUILDDEF bool cbuild_sv_contains(cbuild_sv_t sv, char c);

Check if string view contains some character.

cbuild_sv_contains_sv

CBUILDDEF bool cbuild_sv_contains_sv(cbuild_sv_t sv, cbuild_sv_t needle);

Check substring (provided as string view) is contained in another string view.

cbuild_sv_utf8cp_len

CBUILDDEF int cbuild_sv_utf8cp_len(cbuild_sv_t sv);

Get length of first utf8 codepoint in string view.

Invalid codepoints assumed to have length of 1

int Length of codepoint in bytes.

cbuild_sv_strchr

CBUILDDEF char* cbuild_sv_strchr(cbuild_sv_t sv, char c);

strchr implementation for string view.

  • cbuild_sv_t sv String view to work with
  • char c Character that will be searched.

char* Pointer to character or NULL if not found.

cbuild_sv_utf8chr

CBUILDDEF char* cbuild_sv_utf8chr(cbuild_sv_t sv, uint32_t c);

strchr implementation for string view. Operates on utf8 codepoints instead of ASCII characters.

  • cbuild_sv_t sv String view to work with
  • uint32_t c Codepoint that will be searched.

char* Pointer to character or NULL if not found.

cbuild_sv_chop_utf8

CBUILDDEF uint32_t cbuild_sv_chop_utf8(cbuild_sv_t* sv);

Chop first utf8 codepoint out of string view.

uint32_t Unicode codepoint. UINT32_MAX means error.

cbuild_sv_chop_by_utf8

CBUILDDEF cbuild_sv_t cbuild_sv_chop_by_utf8(cbuild_sv_t* sv, uint32_t delim);

Chop characters from string view starting from the left until delimuint32_t is found. Operates on utf8 codepoints instead of ASCII characters.

  • cbuild_sv_t* sv String view from which data will be chopped. Its size will be reduced.
  • uint32_t delim Delimiter character.

cbuild_sv_t New string view containing chopped characters. delimuint32_t will not be included.

cbuild_sv_utf8delim_func

typedef bool (*cbuild_sv_utf8delim_func)(const cbuild_sv_t* sv, void* args);

Delimiter function. Used as comparator in cbuild_sv_chop_by_func_utf8

  • const cbuild_sv_t* sv String view, prechopped, so first character is possible delimiter and should be checked.
  • void* args Arguments passed by caller.

bool If true is returned this character will be considered a delimiter

cbuild_sv_chop_by_func_utf8

CBUILDDEF cbuild_sv_t cbuild_sv_chop_by_func_utf8(cbuild_sv_t* sv,
cbuild_sv_utf8delim_func delim, void* args);

chop characters from string view starting from the right until delimcbuild_sv_utf8delim_func returns true. Operates on utf8 codepoints instead of ASCII characters.

cbuild_sv_t new string view containing chopped characters. Delimiter character will not be in any string view.

cbuild_sv_utf8len

CBUILDDEF size_t cbuild_sv_utf8len(cbuild_sv_t sv);

Get length of a string view in utf8 codepoints.

Invalid codepoints assumed to have length of 1

cbuild_sv_utf8valid

CBUILDDEF bool cbuild_sv_utf8valid(cbuild_sv_t sv, size_t* idx);

Check if string view is a valid utf8 data.

  • cbuild_sv_t sv String view to work with.
  • size_t* idx If validation failed this will store index of first invalid codepoint. Can be NULL.

bool false if validation failed.

cbuild_sv_to_cstr

CBUILDDEF char* cbuild_sv_to_cstr(cbuild_sv_t sv);

Convert string view to c-string. Allocate memory via malloc.

cbuild_cstr_from_sv

#define cbuild_cstr_from_sv(sv)

Convert string view to c-string. Allocate memory via malloc.

cbuild_sv_to_temp_cstr

CBUILDDEF char* cbuild_sv_to_temp_cstr(cbuild_sv_t sv);

Convert string view to c-string. Allocate memory via cbuild_temp_malloc.

cbuild_temp_cstr_from_sv

#define cbuild_temp_cstr_from_sv(sv)

Convert string view to c-string. Allocate memory via cbuild_temp_malloc.