universe@390:
universe@390:
Bounded string implementation.
universe@390: More...
universe@390:
#include "ucx.h"
universe@390:
#include "allocator.h"
universe@390:
#include <stddef.h>
universe@390:
universe@390:
Go to the source code of this file.
universe@390:
universe@390: |
universe@390: | struct | sstr_t |
universe@390: | | The UCX string structure. More...
|
universe@390: | |
universe@390: | struct | scstr_t |
universe@390: | | The UCX string structure for immutable (constant) strings. More...
|
universe@390: | |
universe@390:
universe@390: |
universe@390: |
universe@390: #define | ST(s) { s, sizeof(s)-1 } |
universe@390: | | Shortcut for a sstr_t struct or scstr_t struct literal.
|
universe@390: | |
universe@390: | #define | S(s) sstrn(s, sizeof(s)-1) |
universe@390: | | Shortcut for the conversion of a C string to a sstr_t. More...
|
universe@390: | |
universe@390: | #define | SC(s) scstrn(s, sizeof(s)-1) |
universe@390: | | Shortcut for the conversion of a C string to a scstr_t. More...
|
universe@390: | |
universe@390: | #define | SFMT(s) (int) (s).length, (s).ptr |
universe@390: | | Expands a sstr_t or scstr_t to printf arguments. More...
|
universe@390: | |
universe@390: | #define | PRIsstr ".*s" |
universe@390: | | Format specifier for a sstr_t or scstr_t. More...
|
universe@390: | |
universe@390: | #define | SCSTR(str) ucx_ss2c_s(str) |
universe@390: | | Converts a UCX string to an immutable UCX string (scstr_t). More...
|
universe@390: | |
universe@390: | #define | sstrnlen(count, ...) scstrnlen(count, __VA_ARGS__) |
universe@390: | | Returns the accumulated length of all specified strings. More...
|
universe@390: | |
universe@390: | #define | sstrcat(count, s1, ...) scstrcat(count, SCSTR(s1), __VA_ARGS__) |
universe@390: | | Concatenates two or more strings. More...
|
universe@390: | |
universe@390: | #define | sstrcat_a(alloc, count, s1, ...) scstrcat_a(alloc, count, SCSTR(s1), __VA_ARGS__) |
universe@390: | | Concatenates two or more strings using a UcxAllocator. More...
|
universe@390: | |
universe@390: | #define | sstrstr(string, match) scstrsstr(string, SCSTR(match)) |
universe@390: | | Returns a substring starting at the location of the first occurrence of the specified string. More...
|
universe@390: | |
universe@390: | #define | sstrscstr(string, match) scstrscstr(string, SCSTR(match)) |
universe@390: | | Returns an immutable substring starting at the location of the first occurrence of the specified immutable string. More...
|
universe@390: | |
universe@390: | #define | sstrsplit(string, delim, count) scstrsplit(SCSTR(string), SCSTR(delim), count) |
universe@390: | | Splits a string into parts by using a delimiter string. More...
|
universe@390: | |
universe@390: | #define | sstrsplit_a(allocator, string, delim, count) scstrsplit_a(allocator, SCSTR(string), SCSTR(delim), count) |
universe@390: | | Performing sstrsplit() using a UcxAllocator. More...
|
universe@390: | |
universe@390: | #define | sstrcmp(s1, s2) scstrcmp(SCSTR(s1), SCSTR(s2)) |
universe@390: | | Compares two UCX strings with standard memcmp(). More...
|
universe@390: | |
universe@390: | #define | sstrcasecmp(s1, s2) scstrcasecmp(SCSTR(s1), SCSTR(s2)) |
universe@390: | | Compares two UCX strings ignoring the case. More...
|
universe@390: | |
universe@390: | #define | sstrdup(string) scstrdup(SCSTR(string)) |
universe@390: | | Creates a duplicate of the specified string. More...
|
universe@390: | |
universe@390: | #define | sstrdup_a(allocator, string) scstrdup_a(allocator, SCSTR(string)) |
universe@390: | | Creates a duplicate of the specified string using a UcxAllocator. More...
|
universe@390: | |
universe@390: | #define | sstrprefix(string, prefix) scstrprefix(SCSTR(string), SCSTR(prefix)) |
universe@390: | | Checks, if a string has a specific prefix. More...
|
universe@390: | |
universe@390: | #define | sstrsuffix(string, suffix) scstrsuffix(SCSTR(string), SCSTR(suffix)) |
universe@390: | | Checks, if a string has a specific suffix. More...
|
universe@390: | |
universe@390: | #define | sstrcaseprefix(string, prefix) scstrcaseprefix(SCSTR(string), SCSTR(prefix)) |
universe@390: | | Checks, if a string has a specific prefix, ignoring the case. More...
|
universe@390: | |
universe@390: | #define | sstrcasesuffix(string, suffix) scstrcasesuffix(SCSTR(string), SCSTR(suffix)) |
universe@390: | | Checks, if a string has a specific suffix, ignoring the case. More...
|
universe@390: | |
universe@390: | #define | sstrlower(string) scstrlower(SCSTR(string)) |
universe@390: | | Returns a lower case version of a string. More...
|
universe@390: | |
universe@390: | #define | sstrlower_a(allocator, string) scstrlower_a(allocator, SCSTR(string)) |
universe@390: | | Returns a lower case version of a string. More...
|
universe@390: | |
universe@390: | #define | sstrupper(string) scstrupper(SCSTR(string)) |
universe@390: | | Returns a upper case version of a string. More...
|
universe@390: | |
universe@390: | #define | sstrupper_a(allocator, string) scstrupper_a(allocator, string) |
universe@390: | | Returns a upper case version of a string. More...
|
universe@390: | |
universe@390:
universe@390: |
universe@390: | scstr_t | ucx_sc2sc (scstr_t str) |
universe@390: | | One of two type adjustment functions that return an scstr_t. More...
|
universe@390: | |
universe@390: | scstr_t | ucx_ss2sc (sstr_t str) |
universe@390: | | One of two type adjustment functions that return an scstr_t. More...
|
universe@390: | |
universe@390: | scstr_t | ucx_ss2c_s () |
universe@390: | | Converts a UCX string to an immutable UCX string (scstr_t). More...
|
universe@390: | |
universe@390: | sstr_t | sstr (char *cstring) |
universe@390: | | Creates a new sstr_t based on a C string. More...
|
universe@390: | |
universe@390: | sstr_t | sstrn (char *cstring, size_t length) |
universe@390: | | Creates a new sstr_t of the specified length based on a C string. More...
|
universe@390: | |
universe@390: | scstr_t | scstr (const char *cstring) |
universe@390: | | Creates a new scstr_t based on a constant C string. More...
|
universe@390: | |
universe@390: | scstr_t | scstrn (const char *cstring, size_t length) |
universe@390: | | Creates a new scstr_t of the specified length based on a constant C string. More...
|
universe@390: | |
universe@390: | size_t | scstrnlen (size_t count,...) |
universe@390: | | Returns the accumulated length of all specified strings. More...
|
universe@390: | |
universe@390: | sstr_t | scstrcat (size_t count, scstr_t s1,...) |
universe@390: | | Concatenates two or more strings. More...
|
universe@390: | |
universe@390: | sstr_t | scstrcat_a (UcxAllocator *alloc, size_t count, scstr_t s1,...) |
universe@390: | | Concatenates two or more strings using a UcxAllocator. More...
|
universe@390: | |
universe@390: | sstr_t | sstrsubs (sstr_t string, size_t start) |
universe@390: | | Returns a substring starting at the specified location. More...
|
universe@390: | |
universe@390: | sstr_t | sstrsubsl (sstr_t string, size_t start, size_t length) |
universe@390: | | Returns a substring with the given length starting at the specified location. More...
|
universe@390: | |
universe@390: | scstr_t | scstrsubs (scstr_t string, size_t start) |
universe@390: | | Returns a substring of an immutable string starting at the specified location. More...
|
universe@390: | |
universe@390: | scstr_t | scstrsubsl (scstr_t string, size_t start, size_t length) |
universe@390: | | Returns a substring of an immutable string with a maximum length starting at the specified location. More...
|
universe@390: | |
universe@390: | sstr_t | sstrchr (sstr_t string, int chr) |
universe@390: | | Returns a substring starting at the location of the first occurrence of the specified character. More...
|
universe@390: | |
universe@390: | sstr_t | sstrrchr (sstr_t string, int chr) |
universe@390: | | Returns a substring starting at the location of the last occurrence of the specified character. More...
|
universe@390: | |
universe@390: | scstr_t | scstrchr (scstr_t string, int chr) |
universe@390: | | Returns an immutable substring starting at the location of the first occurrence of the specified character. More...
|
universe@390: | |
universe@390: | scstr_t | scstrrchr (scstr_t string, int chr) |
universe@390: | | Returns an immutable substring starting at the location of the last occurrence of the specified character. More...
|
universe@390: | |
universe@390: | sstr_t | scstrsstr (sstr_t string, scstr_t match) |
universe@390: | | Returns a substring starting at the location of the first occurrence of the specified string. More...
|
universe@390: | |
universe@390: | scstr_t | scstrscstr (scstr_t string, scstr_t match) |
universe@390: | | Returns an immutable substring starting at the location of the first occurrence of the specified immutable string. More...
|
universe@390: | |
universe@390: | sstr_t * | scstrsplit (scstr_t string, scstr_t delim, ssize_t *count) |
universe@390: | | Splits a string into parts by using a delimiter string. More...
|
universe@390: | |
universe@390: | sstr_t * | scstrsplit_a (UcxAllocator *allocator, scstr_t string, scstr_t delim, ssize_t *count) |
universe@390: | | Performing scstrsplit() using a UcxAllocator. More...
|
universe@390: | |
universe@390: | int | scstrcmp (scstr_t s1, scstr_t s2) |
universe@390: | | Compares two UCX strings with standard memcmp(). More...
|
universe@390: | |
universe@390: | int | scstrcasecmp (scstr_t s1, scstr_t s2) |
universe@390: | | Compares two UCX strings ignoring the case. More...
|
universe@390: | |
universe@390: | sstr_t | scstrdup (scstr_t string) |
universe@390: | | Creates a duplicate of the specified string. More...
|
universe@390: | |
universe@390: | sstr_t | scstrdup_a (UcxAllocator *allocator, scstr_t string) |
universe@390: | | Creates a duplicate of the specified string using a UcxAllocator. More...
|
universe@390: | |
universe@390: | sstr_t | sstrtrim (sstr_t string) |
universe@390: | | Omits leading and trailing spaces. More...
|
universe@390: | |
universe@390: | scstr_t | scstrtrim (scstr_t string) |
universe@390: | | Omits leading and trailing spaces. More...
|
universe@390: | |
universe@390: | int | scstrprefix (scstr_t string, scstr_t prefix) |
universe@390: | | Checks, if a string has a specific prefix. More...
|
universe@390: | |
universe@390: | int | scstrsuffix (scstr_t string, scstr_t suffix) |
universe@390: | | Checks, if a string has a specific suffix. More...
|
universe@390: | |
universe@390: | int | scstrcaseprefix (scstr_t string, scstr_t prefix) |
universe@390: | | Checks, if a string has a specific prefix, ignoring the case. More...
|
universe@390: | |
universe@390: | int | scstrcasesuffix (scstr_t string, scstr_t suffix) |
universe@390: | | Checks, if a string has a specific suffix, ignoring the case. More...
|
universe@390: | |
universe@390: | sstr_t | scstrlower (scstr_t string) |
universe@390: | | Returns a lower case version of a string. More...
|
universe@390: | |
universe@390: | sstr_t | scstrlower_a (UcxAllocator *allocator, scstr_t string) |
universe@390: | | Returns a lower case version of a string. More...
|
universe@390: | |
universe@390: | sstr_t | scstrupper (scstr_t string) |
universe@390: | | Returns a upper case version of a string. More...
|
universe@390: | |
universe@390: | sstr_t | scstrupper_a (UcxAllocator *allocator, scstr_t string) |
universe@390: | | Returns a upper case version of a string. More...
|
universe@390: | |
universe@390:
universe@390:
universe@390:
Bounded string implementation.
universe@390:
The UCX strings (sstr_t) provide an alternative to C strings. The main difference to C strings is, that sstr_t does not need to be NULL-terminated. Instead the length is stored within the structure.
universe@390:
When using sstr_t, developers must be full aware of what type of string (NULL-terminated) or not) they are using, when accessing the char* ptr directly.
universe@390:
The UCX string module provides some common string functions, known from standard libc, working with sstr_t.
universe@390:
- Author
- Mike Becker
universe@390: -
universe@390: Olaf Wintermann
universe@390:
universe@390:
universe@390:
◆ PRIsstr
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define PRIsstr ".*s" |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Format specifier for a sstr_t or scstr_t.
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define S |
universe@390: ( |
universe@390: |
universe@390: s | ) |
universe@390: sstrn(s, sizeof(s)-1) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Shortcut for the conversion of a C string to a sstr_t.
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ SC
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define SC |
universe@390: ( |
universe@390: |
universe@390: s | ) |
universe@390: scstrn(s, sizeof(s)-1) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Shortcut for the conversion of a C string to a scstr_t.
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ SCSTR
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define SCSTR |
universe@390: ( |
universe@390: |
universe@390: str | ) |
universe@390: ucx_ss2c_s(str) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Converts a UCX string to an immutable UCX string (scstr_t).
universe@390:
- Parameters
-
universe@390:
universe@390: | str | some UCX string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the an immutable version of the provided string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ SFMT
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define SFMT |
universe@390: ( |
universe@390: |
universe@390: s | ) |
universe@390: (int) (s).length, (s).ptr |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Expands a sstr_t or scstr_t to printf arguments.
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrcasecmp
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrcasecmp |
universe@390: ( |
universe@390: |
universe@390: s1, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: s2 |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrcasecmp(SCSTR(s1), SCSTR(s2)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Compares two UCX strings ignoring the case.
universe@390:
At first it compares the sstr_t.length attribute of the two strings. If and only if the lengths match, both strings are compared char by char ignoring the case.
universe@390:
- Parameters
-
universe@390:
universe@390: | s1 | the first string |
universe@390: | s2 | the second string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- -1, if the length of s1 is less than the length of s2 or 1, if the length of s1 is greater than the length of s2 or the result of the platform specific string comparison function ignoring the case.
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrcaseprefix
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrcaseprefix |
universe@390: ( |
universe@390: |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: prefix |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrcaseprefix(SCSTR(string), SCSTR(prefix)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Checks, if a string has a specific prefix, ignoring the case.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to check |
universe@390: | prefix | the prefix the string should have |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- 1, if and only if the string has the specified prefix, 0 otherwise
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrcasesuffix
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrcasesuffix |
universe@390: ( |
universe@390: |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: suffix |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrcasesuffix(SCSTR(string), SCSTR(suffix)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Checks, if a string has a specific suffix, ignoring the case.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to check |
universe@390: | suffix | the suffix the string should have |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- 1, if and only if the string has the specified suffix, 0 otherwise
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrcat
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrcat |
universe@390: ( |
universe@390: |
universe@390: count, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: s1, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: ... |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrcat(count, SCSTR(s1), __VA_ARGS__) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Concatenates two or more strings.
universe@390:
The resulting string will be allocated by standard malloc(). So developers MUST pass the sstr_t.ptr to free().
universe@390:
The sstr_t.ptr of the return value will always be NULL- terminated.
universe@390:
- Parameters
-
universe@390:
universe@390: | count | the total number of strings to concatenate |
universe@390: | s1 | first string |
universe@390: | ... | all remaining strings |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the concatenated string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrcat_a
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrcat_a |
universe@390: ( |
universe@390: |
universe@390: alloc, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: count, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: s1, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: ... |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrcat_a(alloc, count, SCSTR(s1), __VA_ARGS__) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Concatenates two or more strings using a UcxAllocator.
universe@390:
The resulting string must be freed by the allocators free() implementation.
universe@390:
The sstr_t.ptr of the return value will always be NULL- terminated.
universe@390:
- Parameters
-
universe@390:
universe@390: | alloc | the allocator to use |
universe@390: | count | the total number of strings to concatenate |
universe@390: | s1 | first string |
universe@390: | ... | all remaining strings |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the concatenated string
universe@390:
- See also
- sstrcat()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrcmp
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrcmp |
universe@390: ( |
universe@390: |
universe@390: s1, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: s2 |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrcmp(SCSTR(s1), SCSTR(s2)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Compares two UCX strings with standard memcmp().
universe@390:
At first it compares the sstr_t.length attribute of the two strings. The memcmp() function is called, if and only if the lengths match.
universe@390:
- Parameters
-
universe@390:
universe@390: | s1 | the first string |
universe@390: | s2 | the second string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- -1, if the length of s1 is less than the length of s2 or 1, if the length of s1 is greater than the length of s2 or the result of
memcmp() otherwise (i.e. 0 if the strings match)
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrdup
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrdup |
universe@390: ( |
universe@390: |
universe@390: string | ) |
universe@390: scstrdup(SCSTR(string)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Creates a duplicate of the specified string.
universe@390:
The new sstr_t will contain a copy allocated by standard malloc(). So developers MUST pass the sstr_t.ptr to free().
universe@390:
The sstr_t.ptr of the return value will always be NULL- terminated, regardless of the argument.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to duplicate |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a duplicate of the string
universe@390:
- See also
- sstrdup_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrdup_a
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrdup_a |
universe@390: ( |
universe@390: |
universe@390: allocator, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: string |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrdup_a(allocator, SCSTR(string)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Creates a duplicate of the specified string using a UcxAllocator.
universe@390:
The new sstr_t will contain a copy allocated by the allocators UcxAllocator.malloc() function. So it is implementation depended, whether the returned sstr_t.ptr pointer must be passed to the allocators UcxAllocator.free() function manually.
universe@390:
The sstr_t.ptr of the return value will always be NULL- terminated, regardless of the argument.
universe@390:
- Parameters
-
universe@390:
universe@390: | allocator | a valid instance of a UcxAllocator |
universe@390: | string | the string to duplicate |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a duplicate of the string
universe@390:
- See also
- scstrdup()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrlower
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrlower |
universe@390: ( |
universe@390: |
universe@390: string | ) |
universe@390: scstrlower(SCSTR(string)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a lower case version of a string.
universe@390:
This function creates a duplicate of the input string, first (see sstrdup()).
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the input string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the resulting lower case string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrlower_a
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrlower_a |
universe@390: ( |
universe@390: |
universe@390: allocator, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: string |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrlower_a(allocator, SCSTR(string)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a lower case version of a string.
universe@390:
This function creates a duplicate of the input string, first (see sstrdup_a()).
universe@390:
- Parameters
-
universe@390:
universe@390: | allocator | the allocator used for duplicating the string |
universe@390: | string | the input string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the resulting lower case string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrnlen
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrnlen |
universe@390: ( |
universe@390: |
universe@390: count, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: ... |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrnlen(count, __VA_ARGS__) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns the accumulated length of all specified strings.
universe@390:
Attention: if the count argument is larger than the count of the specified strings, the behavior is undefined.
universe@390:
- Parameters
-
universe@390:
universe@390: | count | the total number of specified strings |
universe@390: | ... | all strings |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the cumulated length of all strings
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrprefix
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrprefix |
universe@390: ( |
universe@390: |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: prefix |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrprefix(SCSTR(string), SCSTR(prefix)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Checks, if a string has a specific prefix.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to check |
universe@390: | prefix | the prefix the string should have |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- 1, if and only if the string has the specified prefix, 0 otherwise
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrscstr
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrscstr |
universe@390: ( |
universe@390: |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: match |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrscstr(string, SCSTR(match)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns an immutable substring starting at the location of the first occurrence of the specified immutable string.
universe@390:
If the string does not contain the other string, an empty string is returned.
universe@390:
If match is an empty string, the complete string is returned.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to be scanned |
universe@390: | match | string containing the sequence of characters to match |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring starting at the first occurrence of
match, or an empty string, if the sequence is not present in string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrsplit
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrsplit |
universe@390: ( |
universe@390: |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: delim, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: count |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrsplit(SCSTR(string), SCSTR(delim), count) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Splits a string into parts by using a delimiter string.
universe@390:
This function will return NULL, if one of the following happens:
universe@390: -
universe@390: the string length is zero
universe@390: -
universe@390: the delimeter length is zero
universe@390: -
universe@390: the string equals the delimeter
universe@390: -
universe@390: memory allocation fails
universe@390:
universe@390:
The integer referenced by count is used as input and determines the maximum size of the resulting array, i.e. the maximum count of splits to perform + 1.
universe@390:
The integer referenced by count is also used as output and is set to
universe@390: -
universe@390: -2, on memory allocation errors
universe@390: -
universe@390: -1, if either the string or the delimiter is an empty string
universe@390: -
universe@390: 0, if the string equals the delimiter
universe@390: -
universe@390: 1, if the string does not contain the delimiter
universe@390: -
universe@390: the count of array items, otherwise
universe@390:
universe@390:
If the string starts with the delimiter, the first item of the resulting array will be an empty string.
universe@390:
If the string ends with the delimiter and the maximum list size is not exceeded, the last array item will be an empty string. In case the list size would be exceeded, the last array item will be the remaining string after the last split, including the terminating delimiter.
universe@390:
Attention: The array pointer AND all sstr_t.ptr of the array items must be manually passed to free(). Use sstrsplit_a() with an allocator to managed memory, to avoid this.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to split |
universe@390: | delim | the delimiter string |
universe@390: | count | IN: the maximum size of the resulting array (0 = no limit), OUT: the actual size of the array |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a sstr_t array containing the split strings or
NULL on error
universe@390:
- See also
- sstrsplit_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrsplit_a
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrsplit_a |
universe@390: ( |
universe@390: |
universe@390: allocator, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: delim, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: count |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrsplit_a(allocator, SCSTR(string), SCSTR(delim), count) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Performing sstrsplit() using a UcxAllocator.
universe@390:
Read the description of sstrsplit() for details.
universe@390:
The memory for the sstr_t.ptr pointers of the array items and the memory for the sstr_t array itself are allocated by using the UcxAllocator.malloc() function.
universe@390:
- Parameters
-
universe@390:
universe@390: | allocator | the UcxAllocator used for allocating memory |
universe@390: | string | the string to split |
universe@390: | delim | the delimiter string |
universe@390: | count | IN: the maximum size of the resulting array (0 = no limit), OUT: the actual size of the array |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a sstr_t array containing the split strings or
NULL on error
universe@390:
- See also
- sstrsplit()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrstr
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrstr |
universe@390: ( |
universe@390: |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: match |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrsstr(string, SCSTR(match)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a substring starting at the location of the first occurrence of the specified string.
universe@390:
If the string does not contain the other string, an empty string is returned.
universe@390:
If match is an empty string, the complete string is returned.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to be scanned |
universe@390: | match | string containing the sequence of characters to match |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring starting at the first occurrence of
match, or an empty string, if the sequence is not present in string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrsuffix
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrsuffix |
universe@390: ( |
universe@390: |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: suffix |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrsuffix(SCSTR(string), SCSTR(suffix)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Checks, if a string has a specific suffix.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to check |
universe@390: | suffix | the suffix the string should have |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- 1, if and only if the string has the specified suffix, 0 otherwise
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrupper
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrupper |
universe@390: ( |
universe@390: |
universe@390: string | ) |
universe@390: scstrupper(SCSTR(string)) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a upper case version of a string.
universe@390:
This function creates a duplicate of the input string, first (see sstrdup()).
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the input string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the resulting upper case string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrupper_a
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | #define sstrupper_a |
universe@390: ( |
universe@390: |
universe@390: allocator, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: string |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | scstrupper_a(allocator, string) |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a upper case version of a string.
universe@390:
This function creates a duplicate of the input string, first (see sstrdup_a()).
universe@390:
- Parameters
-
universe@390:
universe@390: | allocator | the allocator used for duplicating the string |
universe@390: | string | the input string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the resulting upper case string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t scstr |
universe@390: ( |
universe@390: const char * |
universe@390: cstring | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Creates a new scstr_t based on a constant C string.
universe@390:
The length is implicitly inferred by using a call to strlen().
universe@390:
Note: the scstr_t will share the specified pointer to the C string. If you do want a copy, use scstrdup() on the return value of this function.
universe@390:
- Parameters
-
universe@390:
universe@390: | cstring | the C string to wrap |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a new scstr_t containing the C string
universe@390:
- See also
- scstrn()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrcasecmp()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | int scstrcasecmp |
universe@390: ( |
universe@390: scstr_t |
universe@390: s1, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: s2 |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Compares two UCX strings ignoring the case.
universe@390:
At first it compares the scstr_t.length attribute of the two strings. If and only if the lengths match, both strings are compared char by char ignoring the case.
universe@390:
- Parameters
-
universe@390:
universe@390: | s1 | the first string |
universe@390: | s2 | the second string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- -1, if the length of s1 is less than the length of s2 or 1, if the length of s1 is greater than the length of s2 or the result of the platform specific string comparison function ignoring the case.
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrcaseprefix()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | int scstrcaseprefix |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: prefix |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Checks, if a string has a specific prefix, ignoring the case.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to check |
universe@390: | prefix | the prefix the string should have |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- 1, if and only if the string has the specified prefix, 0 otherwise
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrcasesuffix()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | int scstrcasesuffix |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: suffix |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Checks, if a string has a specific suffix, ignoring the case.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to check |
universe@390: | suffix | the suffix the string should have |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- 1, if and only if the string has the specified suffix, 0 otherwise
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrcat()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t scstrcat |
universe@390: ( |
universe@390: size_t |
universe@390: count, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: s1, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: ... |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Concatenates two or more strings.
universe@390:
The resulting string will be allocated by standard malloc(). So developers MUST pass the sstr_t.ptr to free().
universe@390:
The sstr_t.ptr of the return value will always be NULL- terminated.
universe@390:
- Parameters
-
universe@390:
universe@390: | count | the total number of strings to concatenate |
universe@390: | s1 | first string |
universe@390: | ... | all remaining strings |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the concatenated string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrcat_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t scstrcat_a |
universe@390: ( |
universe@390: UcxAllocator * |
universe@390: alloc, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: size_t |
universe@390: count, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: s1, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: ... |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Concatenates two or more strings using a UcxAllocator.
universe@390:
The resulting string must be freed by the allocators free() implementation.
universe@390:
The sstr_t.ptr of the return value will always be NULL- terminated.
universe@390:
- Parameters
-
universe@390:
universe@390: | alloc | the allocator to use |
universe@390: | count | the total number of strings to concatenate |
universe@390: | s1 | first string |
universe@390: | ... | all remaining strings |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the concatenated string
universe@390:
- See also
- scstrcat()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrchr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t scstrchr |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: int |
universe@390: chr |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns an immutable substring starting at the location of the first occurrence of the specified character.
universe@390:
If the string does not contain the character, an empty string is returned.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string where to locate the character |
universe@390: | chr | the character to locate |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring starting at the first location of
chr
universe@390:
- See also
- scstrsubs()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrcmp()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | int scstrcmp |
universe@390: ( |
universe@390: scstr_t |
universe@390: s1, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: s2 |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Compares two UCX strings with standard memcmp().
universe@390:
At first it compares the scstr_t.length attribute of the two strings. The memcmp() function is called, if and only if the lengths match.
universe@390:
- Parameters
-
universe@390:
universe@390: | s1 | the first string |
universe@390: | s2 | the second string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- -1, if the length of s1 is less than the length of s2 or 1, if the length of s1 is greater than the length of s2 or the result of
memcmp() otherwise (i.e. 0 if the strings match)
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrdup()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t scstrdup |
universe@390: ( |
universe@390: scstr_t |
universe@390: string | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Creates a duplicate of the specified string.
universe@390:
The new sstr_t will contain a copy allocated by standard malloc(). So developers MUST pass the sstr_t.ptr to free().
universe@390:
The sstr_t.ptr of the return value will always be NULL- terminated and mutable, regardless of the argument.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to duplicate |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a duplicate of the string
universe@390:
- See also
- scstrdup_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrdup_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t scstrdup_a |
universe@390: ( |
universe@390: UcxAllocator * |
universe@390: allocator, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: string |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Creates a duplicate of the specified string using a UcxAllocator.
universe@390:
The new sstr_t will contain a copy allocated by the allocators UcxAllocator.malloc() function. So it is implementation depended, whether the returned sstr_t.ptr pointer must be passed to the allocators UcxAllocator.free() function manually.
universe@390:
The sstr_t.ptr of the return value will always be NULL- terminated and mutable, regardless of the argument.
universe@390:
- Parameters
-
universe@390:
universe@390: | allocator | a valid instance of a UcxAllocator |
universe@390: | string | the string to duplicate |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a duplicate of the string
universe@390:
- See also
- scstrdup()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrlower()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t scstrlower |
universe@390: ( |
universe@390: scstr_t |
universe@390: string | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a lower case version of a string.
universe@390:
This function creates a duplicate of the input string, first (see scstrdup()).
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the input string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the resulting lower case string
universe@390:
- See also
- scstrdup()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrlower_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t scstrlower_a |
universe@390: ( |
universe@390: UcxAllocator * |
universe@390: allocator, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: string |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a lower case version of a string.
universe@390:
This function creates a duplicate of the input string, first (see scstrdup_a()).
universe@390:
- Parameters
-
universe@390:
universe@390: | allocator | the allocator used for duplicating the string |
universe@390: | string | the input string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the resulting lower case string
universe@390:
- See also
- scstrdup_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrn()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t scstrn |
universe@390: ( |
universe@390: const char * |
universe@390: cstring, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: size_t |
universe@390: length |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Creates a new scstr_t of the specified length based on a constant C string.
universe@390:
Note: the scstr_t will share the specified pointer to the C string. If you do want a copy, use scstrdup() on the return value of this function. *
universe@390:
- Parameters
-
universe@390:
universe@390: | cstring | the C string to wrap |
universe@390: | length | the length of the string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a new scstr_t containing the C string
universe@390:
- See also
- scstr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrnlen()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | size_t scstrnlen |
universe@390: ( |
universe@390: size_t |
universe@390: count, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: |
universe@390: ... |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns the accumulated length of all specified strings.
universe@390:
Attention: if the count argument is larger than the count of the specified strings, the behavior is undefined.
universe@390:
- Parameters
-
universe@390:
universe@390: | count | the total number of specified strings |
universe@390: | ... | all strings |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the accumulated length of all strings
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrprefix()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | int scstrprefix |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: prefix |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Checks, if a string has a specific prefix.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to check |
universe@390: | prefix | the prefix the string should have |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- 1, if and only if the string has the specified prefix, 0 otherwise
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrrchr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t scstrrchr |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: int |
universe@390: chr |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns an immutable substring starting at the location of the last occurrence of the specified character.
universe@390:
If the string does not contain the character, an empty string is returned.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string where to locate the character |
universe@390: | chr | the character to locate |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring starting at the last location of
chr
universe@390:
- See also
- scstrsubs()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrscstr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t scstrscstr |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: match |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns an immutable substring starting at the location of the first occurrence of the specified immutable string.
universe@390:
If the string does not contain the other string, an empty string is returned.
universe@390:
If match is an empty string, the complete string is returned.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to be scanned |
universe@390: | match | string containing the sequence of characters to match |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring starting at the first occurrence of
match, or an empty string, if the sequence is not present in string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrsplit()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t* scstrsplit |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: delim, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: ssize_t * |
universe@390: count |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Splits a string into parts by using a delimiter string.
universe@390:
This function will return NULL, if one of the following happens:
universe@390: -
universe@390: the string length is zero
universe@390: -
universe@390: the delimeter length is zero
universe@390: -
universe@390: the string equals the delimeter
universe@390: -
universe@390: memory allocation fails
universe@390:
universe@390:
The integer referenced by count is used as input and determines the maximum size of the resulting array, i.e. the maximum count of splits to perform + 1.
universe@390:
The integer referenced by count is also used as output and is set to
universe@390: -
universe@390: -2, on memory allocation errors
universe@390: -
universe@390: -1, if either the string or the delimiter is an empty string
universe@390: -
universe@390: 0, if the string equals the delimiter
universe@390: -
universe@390: 1, if the string does not contain the delimiter
universe@390: -
universe@390: the count of array items, otherwise
universe@390:
universe@390:
If the string starts with the delimiter, the first item of the resulting array will be an empty string.
universe@390:
If the string ends with the delimiter and the maximum list size is not exceeded, the last array item will be an empty string. In case the list size would be exceeded, the last array item will be the remaining string after the last split, including the terminating delimiter.
universe@390:
Attention: The array pointer AND all sstr_t.ptr of the array items must be manually passed to free(). Use scstrsplit_a() with an allocator to managed memory, to avoid this.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to split |
universe@390: | delim | the delimiter string |
universe@390: | count | IN: the maximum size of the resulting array (0 = no limit), OUT: the actual size of the array |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a sstr_t array containing the split strings or
NULL on error
universe@390:
- See also
- scstrsplit_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrsplit_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t* scstrsplit_a |
universe@390: ( |
universe@390: UcxAllocator * |
universe@390: allocator, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: delim, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: ssize_t * |
universe@390: count |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Performing scstrsplit() using a UcxAllocator.
universe@390:
Read the description of scstrsplit() for details.
universe@390:
The memory for the sstr_t.ptr pointers of the array items and the memory for the sstr_t array itself are allocated by using the UcxAllocator.malloc() function.
universe@390:
- Parameters
-
universe@390:
universe@390: | allocator | the UcxAllocator used for allocating memory |
universe@390: | string | the string to split |
universe@390: | delim | the delimiter string |
universe@390: | count | IN: the maximum size of the resulting array (0 = no limit), OUT: the actual size of the array |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a sstr_t array containing the split strings or
NULL on error
universe@390:
- See also
- scstrsplit()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrsstr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t scstrsstr |
universe@390: ( |
universe@390: sstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: match |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a substring starting at the location of the first occurrence of the specified string.
universe@390:
If the string does not contain the other string, an empty string is returned.
universe@390:
If match is an empty string, the complete string is returned.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to be scanned |
universe@390: | match | string containing the sequence of characters to match |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring starting at the first occurrence of
match, or an empty string, if the sequence is not present in string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrsubs()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t scstrsubs |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: size_t |
universe@390: start |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a substring of an immutable string starting at the specified location.
universe@390:
Attention: the new string references the same memory area as the input string and is NOT required to be NULL-terminated. Use scstrdup() to get a copy.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | input string |
universe@390: | start | start location of the substring |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring of
string starting at start
universe@390:
- See also
- scstrsubsl()
universe@390: -
universe@390: scstrchr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrsubsl()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t scstrsubsl |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: size_t |
universe@390: start, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: size_t |
universe@390: length |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a substring of an immutable string with a maximum length starting at the specified location.
universe@390:
Attention: the new string references the same memory area as the input string and is NOT required to be NULL-terminated. Use scstrdup() to get a copy.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | input string |
universe@390: | start | start location of the substring |
universe@390: | length | the maximum length of the substring |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring of
string starting at start with a maximum length of length
universe@390:
- See also
- scstrsubs()
universe@390: -
universe@390: scstrchr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrsuffix()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | int scstrsuffix |
universe@390: ( |
universe@390: scstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: suffix |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Checks, if a string has a specific suffix.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string to check |
universe@390: | suffix | the suffix the string should have |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- 1, if and only if the string has the specified suffix, 0 otherwise
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrtrim()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t scstrtrim |
universe@390: ( |
universe@390: scstr_t |
universe@390: string | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Omits leading and trailing spaces.
universe@390:
This function returns a new scstr_t containing a trimmed version of the specified string.
universe@390:
Note: the new scstr_t references the same memory, thus you MUST NOT pass the scstr_t.ptr of the return value to free(). It is also highly recommended to avoid assignments like mystr = scstrtrim(mystr); as you lose the reference to the source string. Assignments of this type are only permitted, if the scstr_t.ptr of the source string does not need to be freed or if another reference to the source string exists.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string that shall be trimmed |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a new scstr_t containing the trimmed string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrupper()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t scstrupper |
universe@390: ( |
universe@390: scstr_t |
universe@390: string | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a upper case version of a string.
universe@390:
This function creates a duplicate of the input string, first (see scstrdup()).
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the input string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the resulting upper case string
universe@390:
- See also
- scstrdup()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ scstrupper_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t scstrupper_a |
universe@390: ( |
universe@390: UcxAllocator * |
universe@390: allocator, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: scstr_t |
universe@390: string |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a upper case version of a string.
universe@390:
This function creates a duplicate of the input string, first (see scstrdup_a()).
universe@390:
- Parameters
-
universe@390:
universe@390: | allocator | the allocator used for duplicating the string |
universe@390: | string | the input string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the resulting upper case string
universe@390:
- See also
- scstrdup_a()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t sstr |
universe@390: ( |
universe@390: char * |
universe@390: cstring | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Creates a new sstr_t based on a C string.
universe@390:
The length is implicitly inferred by using a call to strlen().
universe@390:
Note: the sstr_t will share the specified pointer to the C string. If you do want a copy, use sstrdup() on the return value of this function.
universe@390:
If you need to wrap a constant string, use scstr().
universe@390:
- Parameters
-
universe@390:
universe@390: | cstring | the C string to wrap |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a new sstr_t containing the C string
universe@390:
- See also
- sstrn()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrchr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t sstrchr |
universe@390: ( |
universe@390: sstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: int |
universe@390: chr |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a substring starting at the location of the first occurrence of the specified character.
universe@390:
If the string does not contain the character, an empty string is returned.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string where to locate the character |
universe@390: | chr | the character to locate |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring starting at the first location of
chr
universe@390:
- See also
- sstrsubs()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrn()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t sstrn |
universe@390: ( |
universe@390: char * |
universe@390: cstring, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: size_t |
universe@390: length |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Creates a new sstr_t of the specified length based on a C string.
universe@390:
Note: the sstr_t will share the specified pointer to the C string. If you do want a copy, use sstrdup() on the return value of this function.
universe@390:
If you need to wrap a constant string, use scstrn().
universe@390:
- Parameters
-
universe@390:
universe@390: | cstring | the C string to wrap |
universe@390: | length | the length of the string |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a new sstr_t containing the C string
universe@390:
- See also
- sstr()
universe@390: -
universe@390: S()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrrchr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t sstrrchr |
universe@390: ( |
universe@390: sstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: int |
universe@390: chr |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a substring starting at the location of the last occurrence of the specified character.
universe@390:
If the string does not contain the character, an empty string is returned.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string where to locate the character |
universe@390: | chr | the character to locate |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring starting at the last location of
chr
universe@390:
- See also
- sstrsubs()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrsubs()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t sstrsubs |
universe@390: ( |
universe@390: sstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: size_t |
universe@390: start |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a substring starting at the specified location.
universe@390:
Attention: the new string references the same memory area as the input string and is NOT required to be NULL-terminated. Use sstrdup() to get a copy.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | input string |
universe@390: | start | start location of the substring |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring of
string starting at start
universe@390:
- See also
- sstrsubsl()
universe@390: -
universe@390: sstrchr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrsubsl()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t sstrsubsl |
universe@390: ( |
universe@390: sstr_t |
universe@390: string, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: size_t |
universe@390: start, |
universe@390:
universe@390:
universe@390: |
universe@390: |
universe@390: size_t |
universe@390: length |
universe@390:
universe@390:
universe@390: |
universe@390: ) |
universe@390: | |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Returns a substring with the given length starting at the specified location.
universe@390:
Attention: the new string references the same memory area as the input string and is NOT required to be NULL-terminated. Use sstrdup() to get a copy.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | input string |
universe@390: | start | start location of the substring |
universe@390: | length | the maximum length of the substring |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a substring of
string starting at start with a maximum length of length
universe@390:
- See also
- sstrsubs()
universe@390: -
universe@390: sstrchr()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ sstrtrim()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | sstr_t sstrtrim |
universe@390: ( |
universe@390: sstr_t |
universe@390: string | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Omits leading and trailing spaces.
universe@390:
This function returns a new sstr_t containing a trimmed version of the specified string.
universe@390:
Note: the new sstr_t references the same memory, thus you MUST NOT pass the sstr_t.ptr of the return value to free(). It is also highly recommended to avoid assignments like mystr = sstrtrim(mystr); as you lose the reference to the source string. Assignments of this type are only permitted, if the sstr_t.ptr of the source string does not need to be freed or if another reference to the source string exists.
universe@390:
- Parameters
-
universe@390:
universe@390: | string | the string that shall be trimmed |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- a new sstr_t containing the trimmed string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ ucx_sc2sc()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t ucx_sc2sc |
universe@390: ( |
universe@390: scstr_t |
universe@390: str | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
One of two type adjustment functions that return an scstr_t.
universe@390:
Used internally to convert a UCX string to an immutable UCX string. This variant is used, when the string is already immutable and no operation needs to be performed.
universe@390:
Do not use this function manually.
universe@390:
- Parameters
-
universe@390:
universe@390: | str | some scstr_t |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- the argument itself
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ ucx_ss2c_s()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t ucx_ss2c_s |
universe@390: ( |
universe@390: | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
Converts a UCX string to an immutable UCX string (scstr_t).
universe@390:
This internal function (ab)uses the C standard an expects one single argument which is then implicitly converted to scstr_t without a warning.
universe@390:
Do not use this function manually.
universe@390:
- Returns
- the an immutable version of the provided string
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
◆ ucx_ss2sc()
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: | scstr_t ucx_ss2sc |
universe@390: ( |
universe@390: sstr_t |
universe@390: str | ) |
universe@390: |
universe@390:
universe@390:
universe@390:
universe@390:
universe@390:
One of two type adjustment functions that return an scstr_t.
universe@390:
Used internally to convert a UCX string to an immutable UCX string.
universe@390:
Do not use this function manually.
universe@390:
- Parameters
-
universe@390:
universe@390: | str | some sstr_t |
universe@390:
universe@390:
universe@390:
universe@390:
- Returns
- an immutable (scstr_t) version of the provided string.
universe@390:
universe@390:
universe@390:
universe@390:
universe@390: