#include <gimbal_string_buffer.h>

Inheritance diagram for GblStringBuffer:

Data Fields
GblArrayList	data

Related Symbols
(Note that these are not member symbols.)
Lifetime Management
Methods for consruction, destruction, moving, etc
GBL_RESULT	GblStringBuffer_construct (GblStringBuffer pSelf, const char pString, size_t length, size_t structSize, GblContext *pCtx)

GBL_RESULT	GblStringBuffer_destruct (GblStringBuffer *pSelf)

GBL_RESULT	GblStringBuffer_acquire (GblStringBuffer pSelf, char pData, size_t capacity)

GBL_RESULT	GblStringBuffer_release (GblStringBuffer pSelf, char ppStrPtr, size_t pCapacity)

Properties
Methods for querying or retrieving associated data
char *	GblStringBuffer_data (GblStringBuffer *pSelf)

size_t	GblStringBuffer_length (const GblStringBuffer *pSelf)

size_t	GblStringBuffer_capacity (const GblStringBuffer *pSelf)

size_t	GblStringBuffer_stackBytes (const GblStringBuffer *pSelf)

char *	GblStringBuffer_stackBuffer (const GblStringBuffer *pSelf)

GblContext *	GblStringBuffer_context (const GblStringBuffer *pSelf)

GblBool	GblStringBuffer_empty (const GblStringBuffer *pSelf)

GblBool	GblStringBuffer_valid (const GblStringBuffer *pSelf)

GblBool	GblStringBuffer_blank (const GblStringBuffer *pSelf)

GblBool	GblStringBuffer_stack (const GblStringBuffer *pSelf)

Conversions
Methods for converting to other string types
const GblStringRef *	GblStringBuffer_createRef (const GblStringBuffer *pSelf)

const char *	GblStringBuffer_cString (const GblStringBuffer *pSelf)

const char *	GblStringBuffer_intern (const GblStringBuffer *pSelf)

GblQuark	GblStringBuffer_quark (const GblStringBuffer *pSelf)

GblQuark	GblStringBuffer_tryQuark (const GblStringBuffer *pSelf)

GblStringView	GblStringBuffer_view (const GblStringBuffer *pSelf, size_t offset, size_t len)

Per-Character Access
Methods for getting and setting individual indices
char	GblStringBuffer_at (const GblStringBuffer *pSelf, size_t index)

GBL_RESULT	GblStringBuffer_setChar (const GblStringBuffer *pSelf, size_t index, char value)

Assignment
Methods for setting the value of a constructed string
const char *	GblStringBuffer_set (GblStringBuffer pSelf, const char pStr, size_t len)

const char *	GblStringBuffer_printf (GblStringBuffer pSelf, const char pFmt,...)

const char *	GblStringBuffer_vPrintf (GblStringBuffer pSelf, const char pFmt, va_list varArgs)

Prepending
Methods for adding to the beginning of the a string
GBL_RESULT	GblStringBuffer_prepend (GblStringBuffer pSelf, const char pStr, size_t len)

GBL_RESULT	GblStringBuffer_prependPadding (GblStringBuffer *pSelf, char value, size_t count)

Appending
Methods for adding to the end of a string
GBL_RESULT	GblStringBuffer_append (GblStringBuffer pSelf, const char pStr, size_t len)

GBL_RESULT	GblStringBuffer_appendPrintf (GblStringBuffer pSelf, const char pFmt,...)

GBL_RESULT	GblStringBuffer_appendVPrintf (GblStringBuffer pSelf, const char pFmt, va_list varArgs)

GBL_RESULT	GblStringBuffer_appendPadding (GblStringBuffer *pSelf, char value, size_t count)

GBL_RESULT	GblStringBuffer_appendNil (GblStringBuffer *pSelf)

GBL_RESULT	GblStringBuffer_appendBool (GblStringBuffer *pSelf, GblBool value)

GBL_RESULT	GblStringBuffer_appendInt (GblStringBuffer *pSelf, int value)

GBL_RESULT	GblStringBuffer_appendUint (GblStringBuffer *pSelf, unsigned value)

GBL_RESULT	GblStringBuffer_appendFloat (GblStringBuffer *pSelf, float value)

GBL_RESULT	GblStringBuffer_appendDouble (GblStringBuffer *pSelf, double value)

GBL_RESULT	GblStringBuffer_appendPointer (GblStringBuffer pSelf, const void pPtr)

Modifying
Methods for general string modifications
GBL_RESULT	GblStringBuffer_insert (GblStringBuffer pSelf, size_t index, const char pString, size_t length)

GBL_RESULT	GblStringBuffer_overwrite (GblStringBuffer pSelf, size_t index, const char pString, size_t length)

size_t	GblStringBuffer_replace (GblStringBuffer pSelf, const char pSubstr, const char *pReplacement, size_t limit, size_t substrLen, size_t replLen)

Removing
Methods for erasing portions of a string
GBL_RESULT	GblStringBuffer_erase (GblStringBuffer *pSelf, size_t offset, size_t len)

GBL_RESULT	GblStringBuffer_clear (GblStringBuffer *pSelf)

size_t	GblStringBuffer_remove (GblStringBuffer pSelf, const char pStr, size_t len)

GBL_RESULT	GblStringBuffer_chop (GblStringBuffer *pSelf)

GBL_RESULT	GblStringBuffer_chomp (GblStringBuffer *pSelf)

GBL_RESULT	GblStringBuffer_trimStart (GblStringBuffer *pSelf, char value)

GBL_RESULT	GblStringBuffer_trimEnd (GblStringBuffer *pSelf, char value)

Miscellaneous
Methods for other utilities and string operations
GBL_RESULT	GblStringBuffer_lower (GblStringBuffer *pSelf)

GBL_RESULT	GblStringBuffer_upper (GblStringBuffer *pSelf)

GBL_RESULT	GblStringBuffer_reverse (GblStringBuffer *pSelf)

Sizing
Methods for managing size and capacity
GBL_RESULT	GblStringBuffer_reserve (GblStringBuffer *pSelf, size_t capacity)

GBL_RESULT	GblStringBuffer_resize (GblStringBuffer *pSelf, size_t size)

GBL_RESULT	GblStringBuffer_grow (GblStringBuffer *pSelf, size_t delta)

GBL_RESULT	GblStringBuffer_shrink (GblStringBuffer *pSelf, size_t delta)

GBL_RESULT	GblStringBuffer_shrinkToFit (GblStringBuffer *pSelf)

Detailed Description

Mutable string type optimized for building and writing.

GblStringBuffer is a type of string which is optimized for efficient piece-wise construction, appending, and writing. It's equivalent to a "String Builder" type in other languages, such as C# and Java.

It is typically used temporarily to construct a string, afterwards it is usually converted to another type for storage, such as a GblStringRef or the internal buffer is taken away from it to be stored elsewhere.

Internally it is implemented similarly to a C++-vector, with both a size and a capacity, growing when needed, but not immediatley shrinking.

Note: The API around GblStringBuffer is based around modifying strings. For read-only operations on them, such as searching or match counting, use GblStringBuffer_view() and the GblStringView API.; GblStringBuffer supports being created with additional trailing storage, allowing it to be over-allocated with malloc() or GBL_ALLOCA(). This means it will not create a separate heap allocation until necessary, and will instead useits trailing allocation region as its internal buffer. This can be very efficient when building temporary strings.

See also: GblStringRef, GblStringView, GblQuark

Definition at line 65 of file gimbal_string_buffer.h.

Friends And Related Symbol Documentation

◆ GblStringBuffer_construct()

GBL_RESULT GblStringBuffer_construct	(	GblStringBuffer *	pSelf,
		const char *	pString,
		size_t	length,
		size_t	structSize,
		GblContext *	pCtx
	)

◆ GblStringBuffer_destruct()

GBL_RESULT GblStringBuffer_destruct ( GblStringBuffer * pSelf )

◆ GblStringBuffer_acquire()

GBL_RESULT GblStringBuffer_acquire	(	GblStringBuffer *	pSelf,
		char *	pData,
		size_t	capacity
	)

◆ GblStringBuffer_release()

GBL_RESULT GblStringBuffer_release	(	GblStringBuffer *	pSelf,
		char **	ppStrPtr,
		size_t *	pCapacity
	)

◆ GblStringBuffer_data()

char * GblStringBuffer_data ( GblStringBuffer * pSelf )

◆ GblStringBuffer_length()

size_t GblStringBuffer_length ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_capacity()

size_t GblStringBuffer_capacity ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_stackBytes()

size_t GblStringBuffer_stackBytes ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_stackBuffer()

char * GblStringBuffer_stackBuffer ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_context()

GblContext * GblStringBuffer_context ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_empty()

GblBool GblStringBuffer_empty ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_valid()

GblBool GblStringBuffer_valid ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_blank()

GblBool GblStringBuffer_blank ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_stack()

GblBool GblStringBuffer_stack ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_createRef()

const GblStringRef * GblStringBuffer_createRef ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_cString()

const char * GblStringBuffer_cString ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_intern()

const char * GblStringBuffer_intern ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_quark()

GblQuark GblStringBuffer_quark ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_tryQuark()

GblQuark GblStringBuffer_tryQuark ( const GblStringBuffer * pSelf )

◆ GblStringBuffer_view()

GblStringView GblStringBuffer_view	(	const GblStringBuffer *	pSelf,
		size_t	offset,
		size_t	len
	)

◆ GblStringBuffer_at()

char GblStringBuffer_at	(	const GblStringBuffer *	pSelf,
		size_t	index
	)

◆ GblStringBuffer_setChar()

GBL_RESULT GblStringBuffer_setChar	(	const GblStringBuffer *	pSelf,
		size_t	index,
		char	value
	)

◆ GblStringBuffer_set()

const char * GblStringBuffer_set	(	GblStringBuffer *	pSelf,
		const char *	pStr,
		size_t	len
	)

◆ GblStringBuffer_printf()

const char * GblStringBuffer_printf	(	GblStringBuffer *	pSelf,
		const char *	pFmt,
			...
	)

◆ GblStringBuffer_vPrintf()

const char * GblStringBuffer_vPrintf	(	GblStringBuffer *	pSelf,
		const char *	pFmt,
		va_list	varArgs
	)

◆ GblStringBuffer_prepend()

GBL_RESULT GblStringBuffer_prepend	(	GblStringBuffer *	pSelf,
		const char *	pStr,
		size_t	len
	)

◆ GblStringBuffer_prependPadding()

GBL_RESULT GblStringBuffer_prependPadding	(	GblStringBuffer *	pSelf,
		char	value,
		size_t	count
	)

◆ GblStringBuffer_append()

GBL_RESULT GblStringBuffer_append	(	GblStringBuffer *	pSelf,
		const char *	pStr,
		size_t	len
	)

◆ GblStringBuffer_appendPrintf()

GBL_RESULT GblStringBuffer_appendPrintf	(	GblStringBuffer *	pSelf,
		const char *	pFmt,
			...
	)

◆ GblStringBuffer_appendVPrintf()

GBL_RESULT GblStringBuffer_appendVPrintf	(	GblStringBuffer *	pSelf,
		const char *	pFmt,
		va_list	varArgs
	)

◆ GblStringBuffer_appendPadding()

GBL_RESULT GblStringBuffer_appendPadding	(	GblStringBuffer *	pSelf,
		char	value,
		size_t	count
	)

◆ GblStringBuffer_appendNil()

GBL_RESULT GblStringBuffer_appendNil ( GblStringBuffer * pSelf )

◆ GblStringBuffer_appendBool()

GBL_RESULT GblStringBuffer_appendBool	(	GblStringBuffer *	pSelf,
		GblBool	value
	)

◆ GblStringBuffer_appendInt()

GBL_RESULT GblStringBuffer_appendInt	(	GblStringBuffer *	pSelf,
		int	value
	)

◆ GblStringBuffer_appendUint()

GBL_RESULT GblStringBuffer_appendUint	(	GblStringBuffer *	pSelf,
		unsigned	value
	)

◆ GblStringBuffer_appendFloat()

GBL_RESULT GblStringBuffer_appendFloat	(	GblStringBuffer *	pSelf,
		float	value
	)

◆ GblStringBuffer_appendDouble()

GBL_RESULT GblStringBuffer_appendDouble	(	GblStringBuffer *	pSelf,
		double	value
	)

◆ GblStringBuffer_appendPointer()

GBL_RESULT GblStringBuffer_appendPointer	(	GblStringBuffer *	pSelf,
		const void *	pPtr
	)

◆ GblStringBuffer_insert()

GBL_RESULT GblStringBuffer_insert	(	GblStringBuffer *	pSelf,
		size_t	index,
		const char *	pString,
		size_t	length
	)

◆ GblStringBuffer_overwrite()

GBL_RESULT GblStringBuffer_overwrite	(	GblStringBuffer *	pSelf,
		size_t	index,
		const char *	pString,
		size_t	length
	)

◆ GblStringBuffer_replace()

size_t GblStringBuffer_replace	(	GblStringBuffer *	pSelf,
		const char *	pSubstr,
		const char *	pReplacement,
		size_t	limit,
		size_t	substrLen,
		size_t	replLen
	)

◆ GblStringBuffer_erase()

GBL_RESULT GblStringBuffer_erase	(	GblStringBuffer *	pSelf,
		size_t	offset,
		size_t	len
	)

◆ GblStringBuffer_clear()

GBL_RESULT GblStringBuffer_clear ( GblStringBuffer * pSelf )

◆ GblStringBuffer_remove()

size_t GblStringBuffer_remove	(	GblStringBuffer *	pSelf,
		const char *	pStr,
		size_t	len
	)

◆ GblStringBuffer_chop()

GBL_RESULT GblStringBuffer_chop ( GblStringBuffer * pSelf )

◆ GblStringBuffer_chomp()

GBL_RESULT GblStringBuffer_chomp ( GblStringBuffer * pSelf )

◆ GblStringBuffer_trimStart()

GBL_RESULT GblStringBuffer_trimStart	(	GblStringBuffer *	pSelf,
		char	value
	)

◆ GblStringBuffer_trimEnd()

GBL_RESULT GblStringBuffer_trimEnd	(	GblStringBuffer *	pSelf,
		char	value
	)

◆ GblStringBuffer_lower()

GBL_RESULT GblStringBuffer_lower ( GblStringBuffer * pSelf )

◆ GblStringBuffer_upper()

GBL_RESULT GblStringBuffer_upper ( GblStringBuffer * pSelf )

◆ GblStringBuffer_reverse()

GBL_RESULT GblStringBuffer_reverse ( GblStringBuffer * pSelf )

◆ GblStringBuffer_reserve()

GBL_RESULT GblStringBuffer_reserve	(	GblStringBuffer *	pSelf,
		size_t	capacity
	)

◆ GblStringBuffer_resize()

GBL_RESULT GblStringBuffer_resize	(	GblStringBuffer *	pSelf,
		size_t	size
	)

◆ GblStringBuffer_grow()

GBL_RESULT GblStringBuffer_grow	(	GblStringBuffer *	pSelf,
		size_t	delta
	)

◆ GblStringBuffer_shrink()

GBL_RESULT GblStringBuffer_shrink	(	GblStringBuffer *	pSelf,
		size_t	delta
	)

◆ GblStringBuffer_shrinkToFit()

GBL_RESULT GblStringBuffer_shrinkToFit ( GblStringBuffer * pSelf )

Field Documentation

◆ data

GblArrayList GblStringBuffer::data

Internal storage buffer.

Definition at line 66 of file gimbal_string_buffer.h.

The documentation for this struct was generated from the following file:

gimbal_string_buffer.h

Data Fields

Related Symbols