/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file string.h
* @brief Strings that know their length.
* @author Mike Becker
* @author Olaf Wintermann
* @copyright 2-Clause BSD License
*/
#ifndef UCX_STRING_H
#define UCX_STRING_H
#include "common.h"
#include "allocator.h"
/** Expands a UCX string as printf arguments. */
#define CX_SFMT(s) (int) (s).length, (s).ptr
/** Format specifier for a UCX string */
#define CX_PRIstr ".*s"
/**
* The maximum length of the "needle" in cx_strstr() that can use SBO.
*/
CX_EXPORT extern const unsigned cx_strstr_sbo_size;
/**
* The UCX string structure.
*/
struct cx_mutstr_s {
/**
* A pointer to the string.
* @note The string is not necessarily @c NULL terminated.
*/
char *ptr;
/** The length of the string */
size_t length;
};
/**
* A mutable string.
*/
typedef struct cx_mutstr_s cxmutstr;
/**
* The UCX string structure for immutable (constant) strings.
*/
struct cx_string_s {
/**
* A pointer to the immutable string.
* @note The string is not necessarily @c NULL terminated.
*/
const char *ptr;
/** The length of the string */
size_t length;
};
/**
* An immutable string.
*/
typedef struct cx_string_s cxstring;
/**
* Context for string tokenizing.
*/
struct cx_strtok_ctx_s {
/**
* The string to tokenize.
*/
cxstring str;
/**
* The primary delimiter.
*/
cxstring delim;
/**
* Optional array of more delimiters.
*/
const cxstring *delim_more;
/**
* Length of the array containing more delimiters.
*/
size_t delim_more_count;
/**
* Position of the currently active token in the source string.
*/
size_t pos;
/**
* Position of the next delimiter in the source string.
*
* If the tokenizer has not yet returned a token, the content of this field
* is undefined. If the tokenizer reaches the end of the string, this field
* contains the length of the source string.
*/
size_t delim_pos;
/**
* The position of the next token in the source string.
*/
size_t next_pos;
/**
* The number of already found tokens.
*/
size_t found;
/**
* The maximum number of tokens that shall be returned.
*/
size_t limit;
};
/**
* A string tokenizing context.
*/
typedef struct cx_strtok_ctx_s CxStrtokCtx;
#ifdef __cplusplus
extern "C" {
/**
* A literal initializer for an UCX string structure.
*
* @param literal the string literal
*/
#define CX_STR(literal) cxstring{literal, sizeof(literal) - 1}
#else // __cplusplus
/**
* A literal initializer for an UCX string structure.
*
* The argument MUST be a string (const char*) @em literal.
*
* @param literal the string literal
*/
#define CX_STR(literal) ((cxstring){literal, sizeof(literal) - 1})
#endif
/**
* Wraps a mutable string that must be zero-terminated.
*
* The length is implicitly inferred by using a call to @c strlen().
*
* When @c NULL is passed, the length will be set to zero.
*
* @note the wrapped string will share the specified pointer to the string.
* If you do want a copy, use cx_strdup() on the return value of this function.
*
* If you need to wrap a constant string, use cx_str().
*
* @param cstring the string to wrap (must be zero-terminated)
* @return the wrapped string
*
* @see cx_mutstrn()
*/
cx_attr_nodiscard cx_attr_cstr_arg(1)
CX_EXPORT cxmutstr cx_mutstr(char *cstring);
/**
* Wraps a string that does not need to be zero-terminated.
*
* The argument may be @c NULL if the length is zero.
*
* @note the wrapped string will share the specified pointer to the string.
* If you do want a copy, use cx_strdup() on the return value of this function.
*
* If you need to wrap a constant string, use cx_strn().
*
* @param cstring the string to wrap (or @c NULL, only if the length is zero)
* @param length the length of the string
* @return the wrapped string
*
* @see cx_mutstr()
*/
cx_attr_nodiscard cx_attr_access_rw(1, 2)
CX_EXPORT cxmutstr cx_mutstrn(char *cstring, size_t length);
/**
* Wraps a string that must be zero-terminated.
*
* The length is implicitly inferred by using a call to @c strlen().
*
* When @c NULL is passed, the length will be set to zero.
*
* @note the wrapped string will share the specified pointer to the string.
* If you do want a copy, use cx_strdup() on the return value of this function.
*
* If you need to wrap a non-constant string, use cx_mutstr().
*
* @param cstring the string to wrap (must be zero-terminated)
* @return the wrapped string
*
* @see cx_strn()
*/
cx_attr_nodiscard cx_attr_cstr_arg(1)
CX_EXPORT cxstring cx_str(const char *cstring);
/**
* Wraps a string that does not need to be zero-terminated.
*
* The argument may be @c NULL if the length is zero.
*
* @note the wrapped string will share the specified pointer to the string.
* If you do want a copy, use cx_strdup() on the return value of this function.
*
* If you need to wrap a non-constant string, use cx_mutstrn().
*
* @param cstring the string to wrap (or @c NULL, only if the length is zero)
* @param length the length of the string
* @return the wrapped string
*
* @see cx_str()
*/
cx_attr_nodiscard cx_attr_access_r(1, 2)
CX_EXPORT cxstring cx_strn(const char *cstring, size_t length);
#ifdef __cplusplus
} // extern "C"
cx_attr_nodiscard
CX_CPPDECL cxstring cx_strcast(cxmutstr str) {
return cx_strn(str.ptr, str.length);
}
cx_attr_nodiscard
CX_CPPDECL cxstring cx_strcast(cxstring str) {
return str;
}
cx_attr_nodiscard
CX_CPPDECL cxstring cx_strcast(const char *str) {
return cx_str(str);
}
cx_attr_nodiscard
CX_CPPDECL cxstring cx_strcast(const unsigned char *str) {
return cx_str(reinterpret_cast<const char*>(str));
}
extern "C" {
#else
/**
* Internal function, do not use.
* @param str
* @return
* @see cx_strcast()
*/
cx_attr_nodiscard
CX_INLINE cxstring cx_strcast_m(cxmutstr str) {
return (cxstring) {str.ptr, str.length};
}
/**
* Internal function, do not use.
* @param str
* @return
* @see cx_strcast()
*/
cx_attr_nodiscard
CX_INLINE cxstring cx_strcast_c(cxstring str) {
return str;
}
/**
* Internal function, do not use.
* @param str
* @return
* @see cx_strcast()
*/
cx_attr_nodiscard
CX_INLINE cxstring cx_strcast_u(const unsigned char *str) {
return cx_str((const char*)str);
}
/**
* Internal function, do not use.
* @param str
* @return
* @see cx_strcast()
*/
cx_attr_nodiscard
CX_INLINE cxstring cx_strcast_z(const char *str) {
return cx_str(str);
}
/**
* Wraps any string into an UCX string.
*
* @param str (any supported string type) the string to cast
* @return (@c cxstring) the string wrapped as UCX string
*/
#define cx_strcast(str) _Generic((str), \
cxmutstr: cx_strcast_m, \
cxstring: cx_strcast_c, \
const unsigned char*: cx_strcast_u, \
unsigned char *: cx_strcast_u, \
const char*: cx_strcast_z, \
char *: cx_strcast_z) (str)
#endif
/**
* Passes the pointer in this string to the cxDefaultAllocator's @c free() function.
*
* The pointer in the struct is set to @c NULL, and the length is set to zero,
* which means that this function protects you against double-free.
*
* @note There is no implementation for cxstring, because it is unlikely that
* you ever have a <code>const char*</code> you are really supposed to free.
* If you encounter such a situation, you should double-check your code.
*
* @param str the string to free
*/
CX_EXPORT void cx_strfree(cxmutstr *str);
/**
* Passes the pointer in this string to the allocator's free function.
*
* The pointer in the struct is set to @c NULL, and the length is set to zero,
* which means that this function protects you against double-free.
*
* @note There is no implementation for cxstring, because it is unlikely that
* you ever have a <code>const char*</code> you are really supposed to free.
* If you encounter such a situation, you should double-check your code.
*
* @param alloc the allocator
* @param str the string to free
*/
cx_attr_nonnull_arg(1)
CX_EXPORT void cx_strfree_a(const CxAllocator *alloc, cxmutstr *str);
/**
* Copies a string.
*
* The memory in the @p dest structure is either allocated or re-allocated to fit the entire
* source string, including a zero-terminator.
*
* The string in @p dest is guaranteed to be zero-terminated, regardless of whether @p src is.
*
* @param alloc the allocator
* @param dest a pointer to the structure where to copy the contents to
* @param src the source string
*
* @retval zero success
* @retval non-zero if re-allocation failed
*/
cx_attr_nonnull_arg(1)
CX_EXPORT int cx_strcpy_a(const CxAllocator *alloc, cxmutstr *dest, cxstring src);
/**
* Copies a string.
*
* The memory in the @p dest structure is either allocated or re-allocated to fit the entire
* source string, including a zero-terminator.
*
* The string in @p dest is guaranteed to be zero-terminated, regardless of whether @p src is.
*
* @param dest (@c cxmutstr*) a pointer to the structure where to copy the contents to
* @param src (@c cxstring) the source string
*
* @retval zero success
* @retval non-zero if re-allocation failed
*/
#define cx_strcpy(dest, src) cx_strcpy_a(cxDefaultAllocator, dest, src)
/**
* Returns the accumulated length of all specified strings.
*
* If this sum overflows, errno is set to EOVERFLOW.
*
* @attention if the count argument is larger than the number of the
* specified strings, the behavior is undefined.
*
* @param count the total number of specified strings
* @param ... all strings
* @return the accumulated length of all strings
*/
cx_attr_nodiscard
CX_EXPORT size_t cx_strlen(size_t count, ...);
/**
* Concatenates strings.
*
* The resulting string will be allocated by the specified allocator.
* So developers @em must pass the return value to cx_strfree_a() eventually.
*
* If @p str already contains a string, the memory will be reallocated and
* the other strings are appended. Otherwise, new memory is allocated.
*
* If memory allocation fails, the pointer in the returned string will
* be @c NULL. Depending on the allocator, @c errno might be set.
*
* @note It is guaranteed that there is only one allocation for the
* resulting string.
* It is also guaranteed that the returned string is zero-terminated.
*
* @param alloc the allocator to use
* @param str the string the other strings shall be concatenated to
* @param count the number of the other following strings to concatenate
* @param ... all other UCX strings
* @return the concatenated string
*/
cx_attr_nodiscard cx_attr_nonnull
CX_EXPORT cxmutstr cx_strcat_ma(const CxAllocator *alloc,
cxmutstr str, size_t count, ...);
/**
* Concatenates strings and returns a new string.
*
* The resulting string will be allocated by the specified allocator.
* So developers @em must pass the return value to cx_strfree_a() eventually.
*
* If memory allocation fails, the pointer in the returned string will
* be @c NULL. Depending on the allocator, @c errno might be set.
*
* @note It is guaranteed that there is only one allocation for the
* resulting string.
* It is also guaranteed that the returned string is zero-terminated.
*
* @param alloc (@c CxAllocator*) the allocator to use
* @param count (@c size_t) the number of the other following strings to concatenate
* @param ... all other UCX strings
* @return (@c cxmutstr) the concatenated string
*/
#define cx_strcat_a(alloc, count, ...) \
cx_strcat_ma(alloc, cx_mutstrn(NULL, 0), count, __VA_ARGS__)
/**
* Concatenates strings and returns a new string.
*
* The resulting string will be allocated by the cxDefaultAllocator.
* So developers @em must pass the return value to cx_strfree() eventually.
*
* If memory allocation fails, the pointer in the returned string will
* be @c NULL and @c errno might be set.
*
* @note It is guaranteed that there is only one allocation for the
* resulting string.
* It is also guaranteed that the returned string is zero-terminated.
*
* @param count (@c size_t) the number of the other following strings to concatenate
* @param ... all other UCX strings
* @return (@c cxmutstr) the concatenated string
*/
#define cx_strcat(count, ...) \
cx_strcat_ma(cxDefaultAllocator, cx_mutstrn(NULL, 0), count, __VA_ARGS__)
/**
* Concatenates strings.
*
* The resulting string will be allocated by the cxDefaultAllocator.
* So developers @em must pass the return value to cx_strfree() eventually.
*
* If @p str already contains a string, the memory will be reallocated and
* the other strings are appended. Otherwise, new memory is allocated.
*
* If memory allocation fails, the pointer in the returned string will
* be @c NULL and @c errno might be set.
*
* @note It is guaranteed that there is only one allocation for the
* resulting string.
* It is also guaranteed that the returned string is zero-terminated.
*
* @param str (@c cxmutstr) the string the other strings shall be concatenated to
* @param count (@c size_t) the number of the other following strings to concatenate
* @param ... all other strings
* @return (@c cxmutstr) the concatenated string
*/
#define cx_strcat_m(str, count, ...) \
cx_strcat_ma(cxDefaultAllocator, str, count, __VA_ARGS__)
/**
* Returns a substring starting at the specified location.
*
* @attention the new string references the same memory area as the
* input string and is usually @em not zero-terminated.
* Use cx_strdup() to get a copy.
*
* @param string input string
* @param start start location of the substring
* @return a substring of @p string starting at @p start
*
* @see cx_strsubsl()
* @see cx_strsubs_m()
* @see cx_strsubsl_m()
*/
cx_attr_nodiscard
CX_EXPORT cxstring cx_strsubs(cxstring string, size_t start);
/**
* Returns a substring starting at the specified location.
*
* The returned string will be limited to @p length bytes or the number
* of bytes available in @p string, whichever is smaller.
*
* @attention the new string references the same memory area as the
* input string and is usually @em not zero-terminated.
* Use cx_strdup() to get a copy.
*
* @param string input string
* @param start start location of the substring
* @param length the maximum length of the returned string
* @return a substring of @p string starting at @p start
*
* @see cx_strsubs()
* @see cx_strsubs_m()
* @see cx_strsubsl_m()
*/
cx_attr_nodiscard
CX_EXPORT cxstring cx_strsubsl(cxstring string, size_t start, size_t length);
/**
* Returns a substring starting at the specified location.
*
* @attention the new string references the same memory area as the
* input string and is usually @em not zero-terminated.
* Use cx_strdup() to get a copy.
*
* @param string input string
* @param start start location of the substring
* @return a substring of @p string starting at @p start
*
* @see cx_strsubsl_m()
* @see cx_strsubs()
* @see cx_strsubsl()
*/
cx_attr_nodiscard
CX_EXPORT cxmutstr cx_strsubs_m(cxmutstr string, size_t start);
/**
* Returns a substring starting at the specified location.
*
* The returned string will be limited to @p length bytes or the number
* of bytes available in @p string, whichever is smaller.
*
* @attention the new string references the same memory area as the
* input string and is usually @em not zero-terminated.
* Use cx_strdup() to get a copy.
*
* @param string input string
* @param start start location of the substring
* @param length the maximum length of the returned string
* @return a substring of @p string starting at @p start
*
* @see cx_strsubs_m()
* @see cx_strsubs()
* @see cx_strsubsl()
*/
cx_attr_nodiscard
CX_EXPORT cxmutstr cx_strsubsl_m(cxmutstr string, size_t start, size_t length);
/**
* Returns a substring starting at the location of the first occurrence of the
* specified character.
*
* If the string does not contain the character, an empty string is returned.
*
* @param string the string where to locate the character
* @param chr the character to locate
* @return a substring starting at the first location of @p chr
*
* @see cx_strchr_m()
*/
cx_attr_nodiscard
CX_EXPORT cxstring cx_strchr(cxstring string, int chr);
/**
* Returns a substring starting at the location of the first occurrence of the
* specified character.
*
* If the string does not contain the character, an empty string is returned.
*
* @param string the string where to locate the character
* @param chr the character to locate
* @return a substring starting at the first location of @p chr
*
* @see cx_strchr()
*/
cx_attr_nodiscard
CX_EXPORT cxmutstr cx_strchr_m(cxmutstr string, int chr);
/**
* Returns a substring starting at the location of the last occurrence of the
* specified character.
*
* If the string does not contain the character, an empty string is returned.
*
* @param string the string where to locate the character
* @param chr the character to locate
* @return a substring starting at the last location of @p chr
*
* @see cx_strrchr_m()
*/
cx_attr_nodiscard
CX_EXPORT cxstring cx_strrchr(cxstring string, int chr);
/**
* Returns a substring starting at the location of the last occurrence of the
* specified character.
*
* If the string does not contain the character, an empty string is returned.
*
* @param string the string where to locate the character
* @param chr the character to locate
* @return a substring starting at the last location of @p chr
*
* @see cx_strrchr()
*/
cx_attr_nodiscard
CX_EXPORT cxmutstr cx_strrchr_m(cxmutstr string, int chr);
/**
* Returns a substring starting at the location of the first occurrence of the
* specified string.
*
* If @p haystack does not contain @p needle, an empty string is returned.
*
* If @p needle is an empty string, the complete @p haystack is
* returned.
*
* @param haystack the string to be scanned
* @param needle string containing the sequence of characters to match
* @return a substring starting at the first occurrence of
* @p needle, or an empty string, if the sequence is not
* contained
* @see cx_strstr_m()
*/
cx_attr_nodiscard
CX_EXPORT cxstring cx_strstr(cxstring haystack, cxstring needle);
/**
* Returns a substring starting at the location of the first occurrence of the
* specified string.
*
* If @p haystack does not contain @p needle, an empty string is returned.
*
* If @p needle is an empty string, the complete @p haystack is
* returned.
*
* @param haystack the string to be scanned
* @param needle string containing the sequence of characters to match
* @return a substring starting at the first occurrence of
* @p needle, or an empty string, if the sequence is not
* contained
* @see cx_strstr()
*/
cx_attr_nodiscard
CX_EXPORT cxmutstr cx_strstr_m(cxmutstr haystack, cxstring needle);
/**
* Splits a given string using a delimiter string.
*
* @note The resulting array contains strings that point to the source
* @p string. Use cx_strdup() to get copies.
*
* @param string the string to split
* @param delim the delimiter
* @param limit the maximum number of split items
* @param output a preallocated array of at least @p limit length
* @return the actual number of split items
*/
cx_attr_nodiscard cx_attr_nonnull cx_attr_access_w(4, 3)
CX_EXPORT size_t cx_strsplit(cxstring string, cxstring delim,
size_t limit, cxstring *output);
/**
* Splits a given string using a delimiter string.
*
* The array pointed to by @p output will be allocated by @p allocator.
*
* @note The resulting array contains strings that point to the source
* @p string. Use cx_strdup() to get copies.
*
* @attention If allocation fails, the @c NULL pointer will be written to
* @p output and the number returned will be zero.
*
* @param allocator the allocator to use for allocating the resulting array
* @param string the string to split
* @param delim the delimiter
* @param limit the maximum number of split items
* @param output a pointer where the address of the allocated array shall be
* written to
* @return the actual number of split items
*/
cx_attr_nodiscard cx_attr_nonnull cx_attr_access_w(5)
CX_EXPORT size_t cx_strsplit_a(const CxAllocator *allocator,
cxstring string, cxstring delim,
size_t limit, cxstring **output);
/**
* Splits a given string using a delimiter string.
*
* @note The resulting array contains strings that point to the source
* @p string. Use cx_strdup() to get copies.
*
* @param string the string to split
* @param delim the delimiter
* @param limit the maximum number of split items
* @param output a preallocated array of at least @p limit length
* @return the actual number of split items
*/
cx_attr_nodiscard cx_attr_nonnull cx_attr_access_w(4, 3)
CX_EXPORT size_t cx_strsplit_m(cxmutstr string, cxstring delim,
size_t limit, cxmutstr *output);
/**
* Splits a given string using a delimiter string.
*
* The array pointed to by @p output will be allocated by @p allocator.
*
* @note The resulting array contains strings that point to the source
* @p string. Use cx_strdup() to get copies.
*
* @attention If allocation fails, the @c NULL pointer will be written to
* @p output and the number returned will be zero.
*
* @param allocator the allocator to use for allocating the resulting array
* @param string the string to split
* @param delim the delimiter
* @param limit the maximum number of split items
* @param output a pointer where the address of the allocated array shall be
* written to
* @return the actual number of split items
*/
cx_attr_nodiscard cx_attr_nonnull cx_attr_access_w(5)
CX_EXPORT size_t cx_strsplit_ma(const CxAllocator *allocator,
cxmutstr string, cxstring delim, size_t limit,
cxmutstr **output);
/**
* Compares two strings.
*
* @param s1 the first string
* @param s2 the second string
* @return negative if @p s1 is smaller than @p s2, positive if @p s1 is larger
* than @p s2, zero if both strings equal
*/
cx_attr_nodiscard
CX_EXPORT int cx_strcmp_(cxstring s1, cxstring s2);
/**
* Compares two strings.
*
* @param s1 the first string
* @param s2 the second string
* @return negative if @p s1 is smaller than @p s2, positive if @p s1 is larger
* than @p s2, zero if both strings equal
*/
#define cx_strcmp(s1, s2) cx_strcmp_(cx_strcast(s1), cx_strcast(s2))
/**
* Compares two strings ignoring case.
*
* @param s1 the first string
* @param s2 the second string
* @return negative if @p s1 is smaller than @p s2, positive if @p s1 is larger
* than @p s2, zero if both strings equal ignoring case
*/
cx_attr_nodiscard
CX_EXPORT int cx_strcasecmp_(cxstring s1, cxstring s2);
/**
* Compares two strings ignoring case.
*
* @param s1 the first string
* @param s2 the second string
* @return negative if @p s1 is smaller than @p s2, positive if @p s1 is larger
* than @p s2, zero if both strings equal ignoring case
*/
#define cx_strcasecmp(s1, s2) cx_strcasecmp_(cx_strcast(s1), cx_strcast(s2))
/**
* Compares two strings.
*
* This function has a compatible signature for the use as a cx_compare_func.
*
* @attention This function can @em only compare UCX strings. It is unsafe to
* pass normal C-strings to this function.
*
* @param s1 the first string
* @param s2 the second string
* @return negative if @p s1 is smaller than @p s2, positive if @p s1 is larger
* than @p s2, zero if both strings equal
*/
cx_attr_nodiscard cx_attr_nonnull
CX_EXPORT int cx_strcmp_p(const void *s1, const void *s2);
/**
* Compares two strings ignoring case.
*
* This function has a compatible signature for the use as a cx_compare_func.
*
* @param s1 the first string
* @param s2 the second string
* @return negative if @p s1 is smaller than @p s2, positive if @p s1 is larger
* than @p s2, zero if both strings equal ignoring case
*/
cx_attr_nodiscard cx_attr_nonnull
CX_EXPORT int cx_strcasecmp_p(const void *s1, const void *s2);
/**
* Creates a duplicate of the specified string.
*
* The new string will contain a copy allocated by @p allocator.
*
* @note The returned string is guaranteed to be zero-terminated.
*
* @param allocator the allocator to use
* @param string the string to duplicate
* @return a duplicate of the string
* @see cx_strdup()
*/
cx_attr_nodiscard cx_attr_nonnull
CX_EXPORT cxmutstr cx_strdup_a_(const CxAllocator *allocator, cxstring string);
/**
* Creates a duplicate of the specified string.
*
* The new string will contain a copy allocated by @p allocator.
*
* @note The returned string is guaranteed to be zero-terminated.
*
* @param allocator (@c CxAllocator*) the allocator to use
* @param string the string to duplicate
* @return (@c cxmutstr) a duplicate of the string
* @see cx_strdup()
* @see cx_strfree_a()
*/
#define cx_strdup_a(allocator, string) cx_strdup_a_((allocator), cx_strcast(string))
/**
* Creates a duplicate of the specified string.
*
* The new string will contain a copy allocated by the cxDefaultAllocator.
* So developers @em must pass the return value to cx_strfree().
*
* @note The returned string is guaranteed to be zero-terminated.
*
* @param string the string to duplicate
* @return (@c cxmutstr) a duplicate of the string
* @see cx_strdup_a()
* @see cx_strfree()
*/
#define cx_strdup(string) cx_strdup_a(cxDefaultAllocator, string)
/**
* Omits leading and trailing spaces.
*
* @note the returned string references the same memory, thus you
* must @em not free the returned memory.
*
* @param string the string that shall be trimmed
* @return the trimmed string
*/
cx_attr_nodiscard
CX_EXPORT cxstring cx_strtrim(cxstring string);
/**
* Omits leading and trailing spaces.
*
* @note the returned string references the same memory, thus you
* must @em not free the returned memory.
*
* @param string the string that shall be trimmed
* @return the trimmed string
*/
cx_attr_nodiscard
CX_EXPORT cxmutstr cx_strtrim_m(cxmutstr string);
/**
* Checks if a string has a specific prefix.
*
* @param string the string to check
* @param prefix the prefix the string should have
* @return @c true, if and only if the string has the specified prefix,
* @c false otherwise
*/
cx_attr_nodiscard
CX_EXPORT bool cx_strprefix_(cxstring string, cxstring prefix);
/**
* Checks if a string has a specific prefix.
*
* @param string the string to check
* @param prefix the prefix the string should have
* @return @c true, if and only if the string has the specified prefix,
* @c false otherwise
*/
#define cx_strprefix(string, prefix) cx_strprefix_(cx_strcast(string), cx_strcast(prefix))
/**
* Checks if a string has a specific suffix.
*
* @param string the string to check
* @param suffix the suffix the string should have
* @return @c true, if and only if the string has the specified suffix,
* @c false otherwise
*/
cx_attr_nodiscard
CX_EXPORT bool cx_strsuffix_(cxstring string, cxstring suffix);
/**
* Checks if a string has a specific suffix.
*
* @param string the string to check
* @param suffix the suffix the string should have
* @return @c true, if and only if the string has the specified suffix,
* @c false otherwise
*/
#define cx_strsuffix(string, suffix) cx_strsuffix_(cx_strcast(string), cx_strcast(suffix))
/**
* Checks if a string has a specific prefix, ignoring the case.
*
* @param string the string to check
* @param prefix the prefix the string should have
* @return @c true, if and only if the string has the specified prefix,
* @c false otherwise
*/
cx_attr_nodiscard
CX_EXPORT bool cx_strcaseprefix_(cxstring string, cxstring prefix);
/**
* Checks if a string has a specific prefix, ignoring the case.
*
* @param string the string to check
* @param prefix the prefix the string should have
* @return @c true, if and only if the string has the specified prefix,
* @c false otherwise
*/
#define cx_strcaseprefix(string, prefix) cx_strcaseprefix_(cx_strcast(string), cx_strcast(prefix))
/**
* Checks, if a string has a specific suffix, ignoring the case.
*
* @param string the string to check
* @param suffix the suffix the string should have
* @return @c true, if and only if the string has the specified suffix,
* @c false otherwise
*/
cx_attr_nodiscard
CX_EXPORT bool cx_strcasesuffix_(cxstring string, cxstring suffix);
/**
* Checks, if a string has a specific suffix, ignoring the case.
*
* @param string the string to check
* @param suffix the suffix the string should have
* @return @c true, if and only if the string has the specified suffix,
* @c false otherwise
*/
#define cx_strcasesuffix(string, suffix) cx_strcasesuffix_(cx_strcast(string), cx_strcast(suffix))
/**
* Replaces a string with another string.
*
* The function replaces at most @p replmax occurrences.
*
* The returned string will be allocated by @p allocator and is guaranteed
* to be zero-terminated.
*
* If allocation fails, or the input string is empty,
* the returned string will be empty.
*
* @param allocator the allocator to use
* @param str the string where replacements should be applied
* @param search the string to search for
* @param replacement the replacement string
* @param replmax maximum number of replacements
* @return the resulting string after applying the replacements
*/
cx_attr_nodiscard cx_attr_nonnull
CX_EXPORT cxmutstr cx_strreplacen_a(const CxAllocator *allocator,
cxstring str, cxstring search, cxstring replacement, size_t replmax);
/**
* Replaces a string with another string.
*
* The function replaces at most @p replmax occurrences.
*
* The returned string will be allocated by the cxDefaultAllocator and is guaranteed
* to be zero-terminated.
*
* If allocation fails, or the input string is empty,
* the returned string will be empty.
*
* @param str (@c cxstring) the string where replacements should be applied
* @param search (@c cxstring) the string to search for
* @param replacement (@c cxstring) the replacement string
* @param replmax (@c size_t) maximum number of replacements
* @return (@c cxmutstr) the resulting string after applying the replacements
*/
#define cx_strreplacen(str, search, replacement, replmax) \
cx_strreplacen_a(cxDefaultAllocator, str, search, replacement, replmax)
/**
* Replaces a string with another string.
*
* The returned string will be allocated by @p allocator and is guaranteed
* to be zero-terminated.
*
* If allocation fails, or the input string is empty,
* the returned string will be empty.
*
* @param allocator (@c CxAllocator*) the allocator to use
* @param str (@c cxstring) the string where replacements should be applied
* @param search (@c cxstring) the string to search for
* @param replacement (@c cxstring) the replacement string
* @return (@c cxmutstr) the resulting string after applying the replacements
*/
#define cx_strreplace_a(allocator, str, search, replacement) \
cx_strreplacen_a(allocator, str, search, replacement, SIZE_MAX)
/**
* Replaces a string with another string.
*
* The returned string will be allocated by the cxDefaultAllocator and is guaranteed
* to be zero-terminated.
*
* If allocation fails, or the input string is empty,
* the returned string will be empty.
*
* @param str (@c cxstring) the string where replacements should be applied
* @param search (@c cxstring) the string to search for
* @param replacement (@c cxstring) the replacement string
* @return (@c cxmutstr) the resulting string after applying the replacements
*/
#define cx_strreplace(str, search, replacement) \
cx_strreplacen_a(cxDefaultAllocator, str, search, replacement, SIZE_MAX)
/**
* Creates a string tokenization context.
*
* @param str the string to tokenize
* @param delim the delimiter (must not be empty)
* @param limit the maximum number of tokens that shall be returned
* @return a new string tokenization context
*/
cx_attr_nodiscard
CX_EXPORT CxStrtokCtx cx_strtok_(cxstring str, cxstring delim, size_t limit);
/**
* Creates a string tokenization context.
*
* @param str the string to tokenize
* @param delim the delimiter string (must not be empty)
* @param limit (@c size_t) the maximum number of tokens that shall be returned
* @return (@c CxStrtokCtx) a new string tokenization context
*/
#define cx_strtok(str, delim, limit) \
cx_strtok_(cx_strcast(str), cx_strcast(delim), (limit))
/**
* Returns the next token.
*
* The token will point to the source string.
*
* @param ctx the tokenization context
* @param token a pointer to memory where the next token shall be stored
* @return true if successful, false if the limit or the end of the string
* has been reached
*/
cx_attr_nonnull cx_attr_nodiscard cx_attr_access_w(2)
CX_EXPORT bool cx_strtok_next(CxStrtokCtx *ctx, cxstring *token);
/**
* Returns the next token of a mutable string.
*
* The token will point to the source string.
*
* @attention
* If the context was not initialized over a mutable string, modifying
* the data of the returned token is undefined behavior.
*
* @param ctx the tokenization context
* @param token a pointer to memory where the next token shall be stored
* @return true if successful, false if the limit or the end of the string
* has been reached
*/
cx_attr_nonnull cx_attr_nodiscard cx_attr_access_w(2)
CX_EXPORT bool cx_strtok_next_m(CxStrtokCtx *ctx, cxmutstr *token);
/**
* Defines an array of more delimiters for the specified tokenization context.
*
* @param ctx the tokenization context
* @param delim array of more delimiters
* @param count number of elements in the array
*/
cx_attr_nonnull cx_attr_access_r(2, 3)
CX_EXPORT void cx_strtok_delim(CxStrtokCtx *ctx, const cxstring *delim, size_t count);
/* ------------------------------------------------------------------------- *
* string to number conversion functions *
* ------------------------------------------------------------------------- */
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtos_lc_(cxstring str, short *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtoi_lc_(cxstring str, int *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtol_lc_(cxstring str, long *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtoll_lc_(cxstring str, long long *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtoi8_lc_(cxstring str, int8_t *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtoi16_lc_(cxstring str, int16_t *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtoi32_lc_(cxstring str, int32_t *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtoi64_lc_(cxstring str, int64_t *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtous_lc_(cxstring str, unsigned short *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtou_lc_(cxstring str, unsigned int *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtoul_lc_(cxstring str, unsigned long *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtoull_lc_(cxstring str, unsigned long long *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtou8_lc_(cxstring str, uint8_t *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtou16_lc_(cxstring str, uint16_t *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtou32_lc_(cxstring str, uint32_t *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtou64_lc_(cxstring str, uint64_t *output, int base, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtoz_lc_(cxstring str, size_t *output, int base, const char *groupsep);
/**
* Converts a string to a single precision floating-point number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character.
* It sets errno to ERANGE when the necessary representation would exceed the limits defined in libc's float.h.
*
* @param str the string to convert
* @param output a pointer to the float variable where the result shall be stored
* @param decsep the decimal separator
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtof_lc_(cxstring str, float *output, char decsep, const char *groupsep);
/**
* Converts a string to a double precision floating-point number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character.
* It sets errno to ERANGE when the necessary representation would exceed the limits defined in libc's float.h.
*
* @param str the string to convert
* @param output a pointer to the float variable where the result shall be stored
* @param decsep the decimal separator
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
cx_attr_access_w(2) cx_attr_nonnull_arg(2)
CX_EXPORT int cx_strtod_lc_(cxstring str, double *output, char decsep, const char *groupsep);
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtos_lc(str, output, base, groupsep) cx_strtos_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi_lc(str, output, base, groupsep) cx_strtoi_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtol_lc(str, output, base, groupsep) cx_strtol_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoll_lc(str, output, base, groupsep) cx_strtoll_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi8_lc(str, output, base, groupsep) cx_strtoi8_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi16_lc(str, output, base, groupsep) cx_strtoi16_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi32_lc(str, output, base, groupsep) cx_strtoi32_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi64_lc(str, output, base, groupsep) cx_strtoi64_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtous_lc(str, output, base, groupsep) cx_strtous_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou_lc(str, output, base, groupsep) cx_strtou_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoul_lc(str, output, base, groupsep) cx_strtoul_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoull_lc(str, output, base, groupsep) cx_strtoull_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou8_lc(str, output, base, groupsep) cx_strtou8_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou16_lc(str, output, base, groupsep) cx_strtou16_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou32_lc(str, output, base, groupsep) cx_strtou32_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou64_lc(str, output, base, groupsep) cx_strtou64_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @param groupsep (@c const @c char*) each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoz_lc(str, output, base, groupsep) cx_strtoz_lc_(cx_strcast(str), output, base, groupsep)
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtos(str, output, base) cx_strtos_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi(str, output, base) cx_strtoi_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtol(str, output, base) cx_strtol_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoll(str, output, base) cx_strtoll_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi8(str, output, base) cx_strtoi8_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi16(str, output, base) cx_strtoi16_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi32(str, output, base) cx_strtoi32_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoi64(str, output, base) cx_strtoi64_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoz(str, output, base) cx_strtoz_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtous(str, output, base) cx_strtous_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou(str, output, base) cx_strtou_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoul(str, output, base) cx_strtoul_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtoull(str, output, base) cx_strtoull_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou8(str, output, base) cx_strtou8_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou16(str, output, base) cx_strtou16_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou32(str, output, base) cx_strtou32_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character or an unsupported base.
* It sets errno to ERANGE when the target datatype is too small.
*
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose the set of group separators, use the @c _lc variant of this function (e.g. cx_strtoz_lc()).
*
* @param str the string to convert
* @param output a pointer to the integer variable where the result shall be stored
* @param base 2, 8, 10, or 16
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtou64(str, output, base) cx_strtou64_lc_(cx_strcast(str), output, base, ",")
/**
* Converts a string to a single precision floating-point number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character.
* It sets errno to ERANGE when the necessary representation would exceed the limits defined in libc's float.h.
*
* @param str the string to convert
* @param output a pointer to the float variable where the result shall be stored
* @param decsep the decimal separator
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtof_lc(str, output, decsep, groupsep) cx_strtof_lc_(cx_strcast(str), output, decsep, groupsep)
/**
* Converts a string to a double precision floating-point number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character.
*
* @param str the string to convert
* @param output a pointer to the double variable where the result shall be stored
* @param decsep the decimal separator
* @param groupsep each character in this string is treated as a group separator and ignored during conversion
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtod_lc(str, output, decsep, groupsep) cx_strtod_lc_(cx_strcast(str), output, decsep, groupsep)
/**
* Converts a string to a single precision floating-point number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character.
* It sets errno to ERANGE when the necessary representation would exceed the limits defined in libc's float.h.
*
* The decimal separator is assumed to be a dot character.
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose a different format, use cx_strtof_lc().
*
* @param str the string to convert
* @param output a pointer to the float variable where the result shall be stored
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtof(str, output) cx_strtof_lc_(cx_strcast(str), output, '.', ",")
/**
* Converts a string to a double precision floating-point number.
*
* The function returns non-zero when conversion is not possible.
* In that case the function sets errno to EINVAL when the reason is an invalid character.
*
* The decimal separator is assumed to be a dot character.
* The comma character is treated as a group separator and ignored during parsing.
* If you want to choose a different format, use cx_strtof_lc().
*
* @param str the string to convert
* @param output a pointer to the double variable where the result shall be stored
* @retval zero success
* @retval non-zero conversion was not possible
*/
#define cx_strtod(str, output) cx_strtod_lc_(cx_strcast(str), output, '.', ",")
#ifdef __cplusplus
} // extern "C"
#endif
#endif //UCX_STRING_H