Base library

Basic features required by all other modules. More...

Collaboration diagram for Base library:

Modules
	Simple bitset
	Simple bitset.
	Verbose logging
	Verbose logging.
	Assertions and panic handling
CT_BEGIN_API CT_NODISCARD CT_PUREFN CT_BASE_API bool	is_path_special (const char *path)
	check if a path is special special paths are paths such as "." and ".." that are not valid for most operations More...
CT_NODISCARD CT_CONSTFN CT_BASE_API ctu_hash_t	ctu_ptrhash (const void *ptr)
	hash a pointer value More...
CT_NODISCARD CT_PUREFN CT_BASE_API ctu_hash_t	str_hash (const char *str)
	hash a string More...
CT_NODISCARD CT_PUREFN CT_BASE_API ctu_hash_t	text_hash (text_view_t text)
	hash a string with a provided length More...
CT_NODISCARD CT_CONSTFN CT_BASE_API bool	ctu_isalpha (int c)
	check if a character is a letter More...
CT_NODISCARD CT_CONSTFN CT_BASE_API bool	ctu_isdigit (int c)
	check if a character is a digit More...
CT_NODISCARD CT_CONSTFN CT_BASE_API bool	ctu_isalnum (int c)
	check if a character is alphanumeric More...
CT_NODISCARD CT_PUREFN CT_BASE_API bool	str_equal (const char *lhs, const char *rhs)
	compare strings equality More...
CT_BASE_API char *	ctu_strcpy (STA_WRITES(size) char *dst, const char *src, size_t size)
	copy a string equivalent to strcpy but with safety checks More...
CT_NODISCARD CT_PUREFN CT_BASE_API size_t	ctu_strlen (const char *str)
	get the length of a string not including the null terminator equivalent to strlen but with safety checks More...
CT_NODISCARD CT_PUREFN CT_BASE_API bool	ctu_string_empty (const char *str)
	check if a string is empty equivalent to strlen(str) == 0 More...
CT_NODISCARD CT_PUREFN CT_BASE_API int	ctu_strncmp (const char *lhs, const char *rhs, size_t length)
	compare two strings equivalent to strncmp but with safety checks More...
CT_NODISCARD CT_PUREFN CT_BASE_API int	ctu_strcmp (const char *lhs, const char *rhs)
	compare two strings equivalent to strcmp but with safety checks More...
CT_NOALIAS CT_BASE_API void *	ctu_memcpy (STA_WRITES(size) void *CT_RESTRICT dst, STA_READS(size) const void *CT_RESTRICT src, size_t size)
	copy memory from one location to another equivalent to memcpy but with safety checks More...
CT_BASE_API void *	ctu_memmove (STA_WRITES(size) void *dst, STA_READS(size) const void *src, size_t size)
	move memory from one location to another equivalent to memmove but with safety checks More...
CT_NOALIAS CT_BASE_API void	ctu_memset (STA_WRITES(size) void *dst, int value, size_t size)
	set memory to a value equivalent to memset but with safety checks More...
CT_NODISCARD CT_PUREFN CT_BASE_API char *	ctu_strstr (const char *haystack, const char *needle)
	find a substring in a string equivalent to strstr but with safety checks More...
CT_CONSTFN CT_BASE_API text_t	text_make (STA_READS(length) char *text, size_t length)
	create a new owning text array text must be a valid string at least length bytes long More...
CT_PUREFN CT_BASE_API text_t	text_from (char *text)
	create a new owning text array this is a shortcut for More...
CT_CONSTFN CT_BASE_API text_view_t	text_view_make (STA_READS(length) const char *text, size_t length)
	create a new non-owning text array text must be at least length bytes long More...
CT_PUREFN CT_BASE_API text_view_t	text_view_from (const char *text)
	create a new non-owning text array this is a shortcut for More...
CT_PUREFN CT_BASE_API bool	text_equal (text_view_t lhs, text_view_t rhs)
	check if two text objects are equal More...

Detailed Description

Basic features required by all other modules.

Function Documentation

ctu_isalnum()

CT_NODISCARD CT_CONSTFN CT_BASE_API bool ctu_isalnum

(

int

c

)

check if a character is alphanumeric

Parameters

c	the character

Return values

true	if the character is alphanumeric
false	otherwise

Definition at line 70 of file util.c.

ctu_isalpha()

CT_NODISCARD CT_CONSTFN CT_BASE_API bool ctu_isalpha

(

int

c

)

check if a character is a letter

Parameters

c	the character

Return values

true	if the character is a letter
false	otherwise

Definition at line 58 of file util.c.

ctu_isdigit()

CT_NODISCARD CT_CONSTFN CT_BASE_API bool ctu_isdigit

(

int

c

)

check if a character is a digit

Parameters

c	the character

Return values

true	if the character is a digit
false	otherwise

Definition at line 64 of file util.c.

ctu_memcpy()

CT_NOALIAS CT_BASE_API void* ctu_memcpy	(	STA_WRITES(size) void *CT_RESTRICT	dst,
		STA_READS(size) const void *CT_RESTRICT	src,
		size_t	size
	)

copy memory from one location to another equivalent to memcpy but with safety checks

Precondition

dst and src must not be null and must be at least size bytes long

Parameters

dst	the destination
src	the source
size	the number of bytes to copy

Returns

the destination

ctu_memmove()

CT_BASE_API void* ctu_memmove	(	STA_WRITES(size) void *	dst,
		STA_READS(size) const void *	src,
		size_t	size
	)

move memory from one location to another equivalent to memmove but with safety checks

Precondition

dst and src must not be null and must be at least size bytes long

Parameters

dst	the destination
src	the source
size	the number of bytes to move

Returns

the destination

ctu_memset()

CT_NOALIAS CT_BASE_API void ctu_memset	(	STA_WRITES(size) void *	dst,
		int	value,
		size_t	size
	)

set memory to a value equivalent to memset but with safety checks

Precondition

dst must not be null and must be at least size bytes long

Parameters

dst	the destination
value	the value to set
size	the number of bytes to set

ctu_ptrhash()

CT_NODISCARD CT_CONSTFN CT_BASE_API ctu_hash_t ctu_ptrhash

(

const void *

ptr

)

hash a pointer value

Parameters

ptr	the pointer to hash

Returns

the hash of the pointer

Definition at line 16 of file util.c.

ctu_strcmp()

CT_NODISCARD CT_PUREFN CT_BASE_API int ctu_strcmp	(	const char *	lhs,
		const char *	rhs
	)

compare two strings equivalent to strcmp but with safety checks

Precondition

lhs and rhs must not be null

Parameters

lhs	the left hand side
rhs	the right hand side

Returns

the comparison result

Definition at line 112 of file util.c.

ctu_strcpy()

CT_BASE_API char* ctu_strcpy	(	STA_WRITES(size) char *	dst,
		const char *	src,
		size_t	size
	)

copy a string equivalent to strcpy but with safety checks

Precondition

dst and src must not be null and dst must be at least size bytes long

Parameters

dst	the destination
src	the source
size	the size of dst

Returns

the destination

ctu_string_empty()

CT_NODISCARD CT_PUREFN CT_BASE_API bool ctu_string_empty

(

const char *

str

)

check if a string is empty equivalent to strlen(str) == 0

Precondition

str must not be null

Parameters

str	the string

Return values

true	if the string is empty
false	otherwise

Definition at line 95 of file util.c.

ctu_strlen()

CT_NODISCARD CT_PUREFN CT_BASE_API size_t ctu_strlen

(

const char *

str

)

get the length of a string not including the null terminator equivalent to strlen but with safety checks

Precondition

str must not be null

Parameters

str	the string

Returns

the length of the string

Definition at line 87 of file util.c.

ctu_strncmp()

CT_NODISCARD CT_PUREFN CT_BASE_API int ctu_strncmp	(	const char *	lhs,
		const char *	rhs,
		size_t	length
	)

compare two strings equivalent to strncmp but with safety checks

Precondition

lhs and rhs must not be null

Parameters

lhs	the left hand side
rhs	the right hand side
length	the length to compare

Returns

the comparison result

Definition at line 103 of file util.c.

ctu_strstr()

CT_NODISCARD CT_PUREFN CT_BASE_API char* ctu_strstr	(	const char *	haystack,
		const char *	needle
	)

find a substring in a string equivalent to strstr but with safety checks

Precondition

haystack and needle must not be null

Parameters

haystack	the string to search in
needle	the string to search for

Returns

the position of needle in haystack or null if not found

Definition at line 156 of file util.c.

is_path_special()

CT_BEGIN_API CT_NODISCARD CT_PUREFN CT_BASE_API bool is_path_special

(

const char *

path

)

check if a path is special special paths are paths such as "." and ".." that are not valid for most operations

Parameters

path	the path to check

Return values

true	if the path is special

Definition at line 10 of file util.c.

str_equal()

CT_NODISCARD CT_PUREFN CT_BASE_API bool str_equal	(	const char *	lhs,
		const char *	rhs
	)

compare strings equality

check if 2 strings are equal

Parameters

lhs	the left hand side of the comparison
rhs	the right hand side of the comparison

Returns

if the strings are equal

Definition at line 76 of file util.c.

str_hash()

CT_NODISCARD CT_PUREFN CT_BASE_API ctu_hash_t str_hash

(

const char *

str

)

hash a string

Parameters

str	the string to hash

Returns

the hash

Definition at line 29 of file util.c.

text_equal()

CT_PUREFN CT_BASE_API bool text_equal	(	text_view_t	lhs,
		text_view_t	rhs
	)

check if two text objects are equal

Parameters

lhs	the left hand side
rhs	the right hand side

Return values

true	if lhs and rhs are equal
false	otherwise

Definition at line 196 of file util.c.

text_from()

CT_PUREFN CT_BASE_API text_t text_from

(

char *

text

)

create a new owning text array this is a shortcut for

text_make(text, ctu_strlen(text))

Parameters

text

the text

Returns

the text object

Definition at line 175 of file util.c.

text_hash()

CT_NODISCARD CT_PUREFN CT_BASE_API ctu_hash_t text_hash

(

text_view_t

text

)

hash a string with a provided length

Parameters

text	the string to hash

Returns

the hash

Definition at line 44 of file util.c.

text_make()

CT_CONSTFN CT_BASE_API text_t text_make	(	STA_READS(length) char *	text,
		size_t	length
	)

create a new owning text array text must be a valid string at least length bytes long

Parameters

text	the text
length	the length of text

Returns

the text object

text_view_from()

CT_PUREFN CT_BASE_API text_view_t text_view_from

(

const char *

text

)

create a new non-owning text array this is a shortcut for

text_view_make(text, ctu_strlen(text))

Parameters

text

the text

Returns

the text object

Definition at line 191 of file util.c.

text_view_make()

CT_CONSTFN CT_BASE_API text_view_t text_view_make	(	STA_READS(length) const char *	text,
		size_t	length
	)

create a new non-owning text array text must be at least length bytes long

Parameters

text	the text
length	the length of text

Returns

the text object