Macros | |
#define | eina_str_join_static(dst, sep, a, b) |
Join two static strings and store the result in a static buffer. | |
Functions | |
size_t | eina_strlcpy (char *dst, const char *src, size_t siz) |
Copy a c-string to another. | |
size_t | eina_strlcat (char *dst, const char *src, size_t siz) |
Append a c-string. | |
Eina_Bool | eina_str_has_prefix (const char *str, const char *prefix) |
Check if the given string has the given prefix. | |
Eina_Bool | eina_str_has_suffix (const char *str, const char *suffix) |
Check if the given string has the given suffix. | |
Eina_Bool | eina_str_has_extension (const char *str, const char *ext) |
Check if the given string has the given extension. | |
char ** | eina_str_split (const char *string, const char *delimiter, int max_tokens) |
Split a string using a delimiter. | |
char ** | eina_str_split_full (const char *string, const char *delimiter, int max_tokens, unsigned int *elements) |
Split a string using a delimiter and returns number of elements. | |
size_t | eina_str_join_len (char *dst, size_t size, char sep, const char *a, size_t a_len, const char *b, size_t b_len) |
Join two strings of known length. | |
char * | eina_str_convert (const char *enc_from, const char *enc_to, const char *text) |
Use Iconv to convert a text string from one encoding to another. | |
char * | eina_str_escape (const char *str) |
Escape slashes, spaces and apostrophes in strings. | |
void | eina_str_tolower (char **str) |
Lowercase all the characters in range [A-Z] in the given string. | |
void | eina_str_toupper (char **str) |
Uppercase all the characters in range [a-z] in the given string. | |
static size_t | eina_str_join (char *dst, size_t size, char sep, const char *a, const char *b) |
static size_t | eina_strlen_bounded (const char *str, size_t maxlen) |
Detailed Description
Provide useful functions for C string manipulation.
This group of functions allow you to more easily manipulate strings, they provide functionality not available through string.h.
- Warning
- Since these functions modify the strings they can't be used with shared strings(eina_stringshare).
See an example here.
Macro Definition Documentation
◆ eina_str_join_static
#define eina_str_join_static | ( | dst, | |
sep, | |||
a, | |||
b ) |
Join two static strings and store the result in a static buffer.
- Parameters
-
dst The buffer to store the result. sep The separator character to use. a First string to use, before sep
.b Second string to use, after sep
.
- Returns
- The number of characters printed.
This function is similar to eina_str_join_len(), but will assume string sizes are know using sizeof(X).
- See also
- eina_str_join()
- eina_str_join_static()
Function Documentation
◆ eina_strlcpy()
size_t eina_strlcpy | ( | char * | dst, |
const char * | src, | ||
size_t | siz ) |
Copy a c-string to another.
- Parameters
-
dst The destination string. src The source string. siz The size of the destination string.
- Returns
- The length of the source string.
This function copies up to siz
- 1 characters from the NULL-terminated string src
to dst
, NULL-terminating the result (unless siz
is equal to 0). The returned value is the length of src
. If the returned value is greater than siz
, truncation occurred.
- Note
- The main difference between eina_strlcpy and strncpy is that this ensures
dst
is NULL-terminated even if noNULL
byte is found in the firstsiz
bytes of src.
- Examples
- eina_str_01.c.
◆ eina_strlcat()
size_t eina_strlcat | ( | char * | dst, |
const char * | src, | ||
size_t | siz ) |
Append a c-string.
- Parameters
-
dst The destination string. src The source string. siz The size of the destination string.
- Returns
- The length of the source string plus MIN(siz, strlen(initial dst))
This function appends src
to dst
of size siz
(unlike strncat, siz
is the full size of dst
, not space left). At most siz
- 1 characters will be copied. Always NULL-terminates (unless siz
<= strlen(dst)). This function returns strlen(src) + MIN(siz, strlen(initial dst)). If the returned value is greater or equal than siz
, truncation occurred.
- Examples
- eina_str_01.c.
◆ eina_str_has_prefix()
Eina_Bool eina_str_has_prefix | ( | const char * | str, |
const char * | prefix ) |
Check if the given string has the given prefix.
- Parameters
-
str The string to work with. prefix The prefix to check for.
- Returns
- EINA_TRUE if the string has the given prefix, EINA_FALSE otherwise.
This function returns EINA_TRUE if str
has the prefix prefix
, EINA_FALSE otherwise. If the length of prefix
is greater than str
, EINA_FALSE is returned.
- Examples
- eina_str_01.c.
References EINA_FALSE.
◆ eina_str_has_suffix()
Eina_Bool eina_str_has_suffix | ( | const char * | str, |
const char * | suffix ) |
Check if the given string has the given suffix.
- Parameters
-
str The string to work with. suffix The suffix to check for.
- Returns
- EINA_TRUE if the string has the given suffix, EINA_FALSE otherwise.
This function returns EINA_TRUE if str
has the suffix suffix
, EINA_FALSE otherwise. If the length of suffix
is greater than str
, EINA_FALSE is returned.
- Examples
- eina_str_01.c.
◆ eina_str_has_extension()
Eina_Bool eina_str_has_extension | ( | const char * | str, |
const char * | ext ) |
Check if the given string has the given extension.
- Parameters
-
str The string to work with. ext The extension to check for.
- Returns
- EINA_TRUE if the string has the given extension, EINA_FALSE otherwise.
This function does the same as eina_str_has_suffix(), except it's case insensitive.
- Examples
- eina_str_01.c.
◆ eina_str_split()
char ** eina_str_split | ( | const char * | string, |
const char * | delimiter, | ||
int | max_tokens ) |
Split a string using a delimiter.
- Parameters
-
string The string to split. delimiter The string which specifies the places at which to split the string. max_tokens The maximum number of strings to split string into, or a number less than 1 to split as many times as possible. This parameter IGNORES the added NULL
terminator.
- Returns
- A newly-allocated NULL-terminated array of strings or
NULL
if it fails to allocate the array.
This function splits string
into a maximum of max_tokens
pieces, using the given delimiter delimiter
. delimiter
is not included in any of the resulting strings, unless max_tokens
is reached. If max_tokens
is less than 1
, the string is splitted as many times as possible. If max_tokens
is reached, the last string in the returned string array contains the remainder of string. The returned value is a newly allocated NULL-terminated array of strings or NULL
if it fails to allocate the array. To free it, free the first element of the array and the array itself.
- Note
- If you need the number of elements in the returned array see eina_str_split_full().
- Examples
- eina_str_01.c.
◆ eina_str_split_full()
char ** eina_str_split_full | ( | const char * | string, |
const char * | delimiter, | ||
int | max_tokens, | ||
unsigned int * | elements ) |
Split a string using a delimiter and returns number of elements.
- Parameters
-
string The string to split. delimiter The string which specifies the places at which to split the string. max_tokens The maximum number of strings to split string into, or a number less than 1 to split as many times as possible. This parameter IGNORES the added NULL
terminator.elements Where to return the number of elements in returned array. This array is guaranteed to be no greater than max_tokens
, and it will NOT count theNULL
terminator element.
- Returns
- A newly-allocated NULL-terminated array of strings or
NULL
if it fails to allocate the array.
This function splits string
into a maximum of max_tokens
pieces, using the given delimiter delimiter
. delimiter
is not included in any of the resulting strings, unless max_tokens
is reached. If max_tokens
is less than 1
, the string is splitted as many times as possible. If max_tokens
is reached, the last string in the returned string array contains the remainder of string. The returned value is a newly allocated NULL-terminated array of strings or NULL
if it fails to allocate the array. To free it, free the first element of the array and the array itself.
- Note
- The actual size of the returned array, when
elements
returns greater than zero, will always beelements
+ 1. This is due to theNULL
terminator element that is added to the array for safety. If it returns6
, the number of split strings returned will be 6, but the size of the array (including theNULL
element) will actually be 7.
- See also
- eina_str_split()
◆ eina_str_join_len()
size_t eina_str_join_len | ( | char * | dst, |
size_t | size, | ||
char | sep, | ||
const char * | a, | ||
size_t | a_len, | ||
const char * | b, | ||
size_t | b_len ) |
Join two strings of known length.
- Parameters
-
dst The buffer to store the result. size Size (in byte) of the buffer. sep The separator character to use. a First string to use, before sep
.a_len length of a
.b Second string to use, after sep
.b_len length of b
.
- Returns
- The number of characters printed.
This function joins the strings a
and b
(in that order) and separate them with sep
. The result is stored in the buffer dst
and at most size
- 1 characters will be written and the string is NULL-terminated. a_len
is the length of a
(not including '\0') and b_len
is the length of b
(not including '\0'). This function returns the number of characters printed (not including the trailing '\0' used to end output to strings). Just like snprintf(), it will not write more than size
bytes, thus a returned value of size
or more means that the output was truncated.
- See also
- eina_str_join()
- eina_str_join_static()
- Examples
- eina_str_01.c.
◆ eina_str_convert()
char * eina_str_convert | ( | const char * | enc_from, |
const char * | enc_to, | ||
const char * | text ) |
Use Iconv to convert a text string from one encoding to another.
- Parameters
-
enc_from Encoding to convert from. enc_to Encoding to convert to. text The text to convert.
- Returns
- The converted text.
This function converts text
, encoded in enc_from
. On success, the converted text is returned and is encoded in enc_to
. On failure, NULL
is returned. Iconv is used to convert text
. If Iconv is not available, NULL
is returned. When not used anymore, the returned value must be freed.
◆ eina_str_escape()
char * eina_str_escape | ( | const char * | str | ) |
Escape slashes, spaces and apostrophes in strings.
- Parameters
-
str The string to escape.
- Returns
- The escaped string.
Escaping is done by adding a slash "\" before any occurrence of slashes "", spaces " " or apostrophes "'". This function returns a newly allocated escaped string on success, NULL
on failure. When not used anymore, the returned value must be freed.
- Examples
- eina_str_01.c.
◆ eina_str_tolower()
void eina_str_tolower | ( | char ** | str | ) |
Lowercase all the characters in range [A-Z] in the given string.
- Parameters
-
str The string to lowercase.
This function modifies the original string, changing all characters in [A-Z] to lowercase. If str
is NULL
or is an empty string, this function does nothing.
- Examples
- eina_str_01.c.
◆ eina_str_toupper()
void eina_str_toupper | ( | char ** | str | ) |
Uppercase all the characters in range [a-z] in the given string.
- Parameters
-
str The string to uppercase.
This function modifies the original string, changing all characters in [a-z] to uppercase. If str
is NULL
or is an empty string, this function does nothing.
- Examples
- eina_str_01.c.