ucx/cx/string.h

/*
 * 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"

#include <string.h>

/** Convenience macro for creating a null string */
#define CX_NULLSTR cx_mutstr(NULL)

/** 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;

/**
 * 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_NODISCARD CX_CSTR_ARG(1)
CX_INLINE cxmutstr cx_mutstr(char *cstring) {
    cxmutstr str;
    str.ptr = cstring;
    str.length = cstring == NULL ? 0 : strlen(cstring);
    return str;
}

/**
 * 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_NODISCARD CX_ACCESS_RW(1, 2)
CX_INLINE cxmutstr cx_mutstrn(char *cstring, size_t length) {
    cxmutstr str;
    str.ptr = cstring;
    str.length = length;
    return str;
}

/**
 * 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_NODISCARD CX_CSTR_ARG(1)
CX_INLINE cxstring cx_str(const char *cstring) {
    cxstring str;
    str.ptr = cstring;
    str.length = cstring == NULL ? 0 : strlen(cstring);
    return str;
}


/**
 * 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_NODISCARD CX_ACCESS_R(1, 2)
CX_INLINE cxstring cx_strn(const char *cstring, size_t length) {
    cxstring str;
    str.ptr = cstring;
    str.length = length;
    return str;
}

#ifdef __cplusplus
CX_NODISCARD
CX_CPPDECL cxmutstr cx_strcast_m(cxmutstr str) {
    return str;
}
CX_NODISCARD
CX_CPPDECL cxstring cx_strcast_m(cxstring str) {
    return str;
}
CX_NODISCARD
CX_CPPDECL cxmutstr cx_strcast_m(char *str) {
    return cx_mutstr(str);
}
CX_NODISCARD
CX_CPPDECL cxmutstr cx_strcast_m(unsigned char *str) {
    return cx_mutstr(reinterpret_cast<char*>(str));
}
CX_NODISCARD
CX_CPPDECL cxstring cx_strcast_m(const char *str) {
    return cx_str(str);
}
CX_NODISCARD
CX_CPPDECL cxstring cx_strcast_m(const unsigned char *str) {
    return cx_str(reinterpret_cast<const char*>(str));
}
CX_NODISCARD
CX_CPPDECL cxstring cx_strcast_(cxmutstr str) {
    return cx_strn(str.ptr, str.length);
}
CX_NODISCARD
CX_CPPDECL cxstring cx_strcast_(cxstring str) {
    return str;
}
#define cx_strcast(s) cx_strcast_(cx_strcast_m(s))
#else
/**
 * Internal function, do not use.
 * @param str
 * @return
 * @see cx_strcast_m()
 * @see cx_strcast()
 */
CX_NODISCARD
CX_INLINE cxmutstr cx_strcast_cxms(cxmutstr str) {
    return str;
}
/**
 * Internal function, do not use.
 * @param str
 * @return
 * @see cx_strcast_m()
 * @see cx_strcast()
 */
CX_NODISCARD
CX_INLINE cxstring cx_strcast_cxs(cxstring str) {
    return str;
}

/**
 * Internal function, do not use.
 * @param str
 * @return
 * @see cx_strcast_m()
 * @see cx_strcast()
 */
CX_NODISCARD
CX_INLINE cxmutstr cx_strcast_uc(unsigned char *str) {
    return cx_mutstr((char*)str);
}

/**
 * Internal function, do not use.
 * @param str
 * @return
 * @see cx_strcast_m()
 * @see cx_strcast()
 */
CX_NODISCARD
CX_INLINE cxmutstr cx_strcast_c(char *str) {
    return cx_mutstr(str);
}

/**
 * Internal function, do not use.
 * @param str
 * @return
 * @see cx_strcast_m()
 * @see cx_strcast()
 */
CX_NODISCARD
CX_INLINE cxstring cx_strcast_ucc(const unsigned char *str) {
    return cx_str((const char*)str);
}

/**
 * Internal function, do not use.
 * @param str
 * @return
 * @see cx_strcast_m()
 * @see cx_strcast()
 */
CX_NODISCARD
CX_INLINE cxstring cx_strcast_cc(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) or (@c cxmutstr) the string wrapped as UCX string
 */
#define cx_strcast_m(str) _Generic((str), \
        cxstring: cx_strcast_cxs, \
        cxmutstr: cx_strcast_cxms, \
        const unsigned char*: cx_strcast_ucc, \
        unsigned char *: cx_strcast_uc, \
        const char*: cx_strcast_cc, \
        char *: cx_strcast_c) (str)

/**
 * Internal function, do not use.
 * @param str
 * @return
 */
CX_INLINE cxstring cx_strcast_1(cxmutstr str) {
    return (cxstring){str.ptr, str.length};
}

/**
 * Internal function, do not use.
 * @param str
 * @return
 */
CX_INLINE cxstring cx_strcast_2(cxstring str) {
    return str;
}

/** internal conversion macro */
#define cx_strcast_(str) _Generic((str), \
        cxmutstr: cx_strcast_1, \
        cxstring: cx_strcast_2)(str)

/**
 * Converts any string to a cxstring.
 *
 * @param str (any supported string type) the string to cast
 * @return he string converted to a (@c cxstring)
 */
#define cx_strcast(str) cx_strcast_(cx_strcast_m(str))
#endif

/**
 * Casts away constness and converts a cxstring to a cxmutstr.
 * For internal use only!
 * @param str
 * @return
 */
CX_INLINE cxmutstr cx_mutstrcast(cxstring str) {
    cxmutstr s;
    s.ptr = (char*)str.ptr;
    s.length = str.length;
    return s;
}

/**
 * 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_EXTERN
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_EXTERN CX_NONNULL_ARG(1)
void cx_strfree_a(const CxAllocator *alloc, cxmutstr *str);

/**
 * Copies a string.
 *
 * Internal function - do not use.
 *
 * @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
 * @see cx_strcpy_a()
 */
CX_EXTERN CX_NONNULL_ARG(1)
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 alloc (@c CxAllocator*) the allocator
 * @param dest (@c cxmutstr*) 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
 */
#define cx_strcpy_a(alloc, dest, src) cx_strcpy_a_(alloc, dest, cx_strcast(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 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_EXTERN CX_NODISCARD
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.
 *
 * @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.
 * If allocation fails, the @c ptr in the returned string will be @c NULL.
 *
 * @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_EXTERN CX_NONNULL
cxmutstr cx_strcat_a(const CxAllocator *alloc,
        cxmutstr str, size_t count, ...);

/**
 * 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.
 *
 * @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.
 * If allocation fails, the @c ptr in the returned string will be @c NULL.
 *
 * @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 UCX strings
 * @return the concatenated string
 */
#define cx_strcat(str, count, ...) \
        cx_strcat_a(cxDefaultAllocator, str, count, __VA_ARGS__)

/**
 * Returns a substring.
 *
 * Internal function - do not use.
 *
 * @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_strsubsl()
 */
CX_EXTERN CX_NODISCARD
cxstring cx_strsubsl_(cxstring string, size_t start, size_t length);

/**
 * Returns a substring.
 *
 * Internal function - do not use.
 *
 * @param string input string
 * @param start  start location of the substring
 * @return a substring of @p string starting at @p start
 * @see cx_strsubs()
 */
CX_EXTERN CX_NODISCARD
cxstring cx_strsubs_(cxstring string, size_t start);

/**
 * Internal conversion function - do not use.
 * @param string
 * @param start
 * @return
 */
CX_INLINE
cxmutstr cx_strsubs_m_(cxmutstr string, size_t start) {
    return cx_mutstrcast(cx_strsubs_(cx_strcast(string), start));
}

/**
 * Internal conversion function - do not use.
 * @param string
 * @param start
 * @param length
 * @return
 */
CX_INLINE
cxmutstr cx_strsubsl_m_(cxmutstr string, size_t start, size_t length) {
    return cx_mutstrcast(cx_strsubsl_(cx_strcast(string), start, length));
}

#ifdef __cplusplus
CX_CPPDECL cxstring cx_strsubs_cpp_(cxstring string, size_t start) {
    return cx_strsubs_(string, start);
}
CX_CPPDECL cxstring cx_strsubsl_cpp_(cxstring string, size_t start, size_t length) {
    return cx_strsubsl_(string, start, length);
}
CX_CPPDECL cxmutstr cx_strsubs_cpp_(cxmutstr string, size_t start) {
    return cx_strsubs_m_(string, start);
}
CX_CPPDECL cxmutstr cx_strsubsl_cpp_(cxmutstr string, size_t start, size_t length) {
    return cx_strsubsl_m_(string, start, length);
}
#define cx_strsubs(string, start) cx_strsubs_cpp_(cx_strcast_m(string), start)
#define cx_strsubsl(string, start, length) cx_strsubsl_cpp_(cx_strcast_m(string), start, length)
#else
/**
 * Returns a substring starting at the specified location.
 *
 * @attention the new string references the same memory area as the
 * input string and is @em not zero-terminated.
 * Use cx_strdup() to get a copy.
 *
 * @param string input string
 * @param start (@c size_t) start location of the substring
 * @return (@c cxstring or @c cxmutstr) a substring of @p string starting at @p start
 *
 * @see cx_strsubsl()
 */
#define cx_strsubs(string, start) _Generic(cx_strcast_m(string), \
        cxstring: cx_strsubs_, \
        cxmutstr: cx_strsubs_m_)(cx_strcast_m(string), 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()
 */
#define cx_strsubsl(string, start, length) _Generic(cx_strcast_m(string), \
        cxstring: cx_strsubsl_, \
        cxmutstr: cx_strsubsl_m_)(cx_strcast_m(string), start, length)
#endif

/**
 * Returns the character at the specified index offset.
 *
 * Internal function - do not use.
 *
 * @param str the string
 * @param index the index offset
 * @return the character at the index
 * @see cx_strat()
 */
CX_INLINE
char cx_strat_(cxstring str, off_t index) {
    size_t i;
    if (index >= 0) {
        i = index;
    } else {
        i = (size_t) (str.length + index);
    }
    if (i >= str.length) {
        return '\0';
    }
    return str.ptr[i];
}

/**
 * Returns the character at the specified index offset.
 *
 * When the @p index is negative, the character is counted from the end of the
 * string where -1 denotes the last character in the string.
 *
 * When the @p index is out of bounds, the function returns zero.
 *
 * @param str the string
 * @param index the index offset
 * @return the character at the index
 * @see cx_strat()
 */
#define cx_strat(str, index) cx_strat_(cx_strcast(str), index)

/**
 * Searches for a character in a string.
 * Internal function - do not use.
 * @param string
 * @param chr
 * @return
 * @see cx_strchr()
 */
CX_EXTERN CX_NODISCARD
cxstring cx_strchr_(cxstring string, int chr);

/**
 * Searches for a character in a string.
 * Internal function - do not use.
 * @param string
 * @param chr
 * @return
 * @see cx_strrchr()
 */
CX_EXTERN CX_NODISCARD
cxstring cx_strrchr_(cxstring string, int chr);

#ifdef __cplusplus
CX_CPPDECL cxstring cx_strchr_cpp_(cxstring string, int chr) {
    return cx_strchr_(string, chr);
}
CX_CPPDECL cxmutstr cx_strchr_cpp_(cxmutstr string, int chr) {
    return cx_mutstrcast(cx_strchr_(cx_strcast(string), chr));
}
#define cx_strchr(s, chr) cx_strchr_cpp_(cx_strcast_m(s), chr)
CX_CPPDECL cxstring cx_strrchr_cpp_(cxstring string, int chr) {
    return cx_strrchr_(string, chr);
}
CX_CPPDECL cxmutstr cx_strrchr_cpp_(cxmutstr string, int chr) {
    return cx_mutstrcast(cx_strrchr_(cx_strcast(string), chr));
}
#define cx_strrchr(s, chr) cx_strrchr_cpp_(cx_strcast_m(s), chr)
#else
/**
 * Internal conversion function - do not use.
 * @param string
 * @param chr
 * @return
 */
CX_INLINE cxmutstr cx_strchr_m_(cxmutstr string, int chr) {
    return cx_mutstrcast(cx_strchr_(cx_strcast(string), chr));
}
/**
 * Internal conversion function - do not use.
 * @param string
 * @param chr
 * @return
 */
CX_INLINE  cxmutstr cx_strrchr_m_(cxmutstr string, int chr) {
    return cx_mutstrcast(cx_strrchr_(cx_strcast(string), 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 (@c int) the character to locate
 * @return (@c cxstring or @c cxmutstr) a substring starting at the first
 * location of @p chr
 */
#define cx_strchr(string, chr) _Generic(cx_strcast_m(string), \
        cxstring: cx_strchr_, \
        cxmutstr: cx_strchr_m_)(cx_strcast_m(string), 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 (@c int) the character to locate
 * @return (@c cxstring or @c cxmutstr) a substring starting at the last
 * location of @p chr
 */
#define cx_strrchr(string, chr) _Generic(cx_strcast_m(string), \
        cxstring: cx_strrchr_, \
        cxmutstr: cx_strrchr_m_)(cx_strcast_m(string), chr)
#endif

/**
 * Searches for a specific substring.
 *
 * Internal function - do not use.
 *
 * @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_EXTERN CX_NODISCARD
cxstring cx_strstr_(cxstring haystack, cxstring needle);

#ifdef __cplusplus
CX_CPPDECL cxstring cx_strstr_cpp_(cxstring haystack, cxstring needle) {
    return cx_strstr_(haystack, needle);
}
CX_CPPDECL cxmutstr cx_strstr_cpp_(cxmutstr haystack, cxstring needle) {
    return cx_mutstrcast(cx_strstr_(cx_strcast(haystack), needle));
}
#define cx_strstr(h,n) cx_strstr_cpp_(cx_strcast_m(h), cx_strcast(n))
#else
/**
 * Internal conversion - do not use.
 * @param haystack
 * @param needle
 * @return
 */
CX_INLINE  cxmutstr cx_strstr_m_(cxmutstr haystack, cxstring needle) {
    return cx_mutstrcast(cx_strstr_(cx_strcast(haystack), 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 (@c cxstring or @c cxmutstr) a substring starting at the first
 * occurrence of @p needle, or an empty string, if the sequence is not contained
 */
#define cx_strstr(haystack, needle) _Generic(cx_strcast_m(haystack), \
        cxstring: cx_strstr_,\
        cxmutstr: cx_strstr_m_)(cx_strcast_m(haystack), cx_strcast(needle))
#endif

/**
 * Splits a given string using a delimiter string.
 *
 * Internal function - do not use.
 *
 * @param string the string to split
 * @param delim  the delimiter
 * @param limit the maximum number of split items
 * @param output the output array
 * @return the actual number of split items
 * @see cx_strsplit()
 */
CX_EXTERN CX_NODISCARD CX_NONNULL CX_ACCESS_W(4, 3)
size_t cx_strsplit_(cxstring string, cxstring delim,
        size_t limit, cxstring *output);

/**
 * Splits a given string using a delimiter string.
 *
 * Internal function - do not use.
 *
 * @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 the output array
 * @return the actual number of split items
 * @see cx_strsplit_a()
 */
CX_EXTERN CX_NODISCARD CX_NONNULL CX_ACCESS_W(5)
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.
 *
 * Internal function - do not use.
 *
 * @param string the string to split
 * @param delim  the delimiter
 * @param limit the maximum number of split items
 * @param output the output array
 * @return the actual number of split items
 * @see cx_strsplit_m()
 */
CX_EXTERN CX_NODISCARD CX_NONNULL CX_ACCESS_W(4, 3)
size_t cx_strsplit_m_(cxmutstr string, cxstring delim,
        size_t limit, cxmutstr *output);

/**
 * Splits a given string using a delimiter string.
 *
 * Internal function - do not use.
 *
 * @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 the output array
 * @return the actual number of split items
 * @see cx_strsplit_ma()
 */
CX_EXTERN CX_NODISCARD CX_NONNULL CX_ACCESS_W(5)
size_t cx_strsplit_ma_(const CxAllocator *allocator,
        cxmutstr string, cxstring delim, size_t limit,
        cxmutstr **output);

#ifdef __cplusplus
CX_CPPDECL size_t cx_strsplit_cpp_(cxstring string, cxstring delim,
        size_t limit, cxstring *output) {
    return cx_strsplit_(string, delim, limit, output);
}
CX_CPPDECL size_t cx_strsplit_cpp_(cxmutstr string, cxstring delim,
        size_t limit, cxmutstr *output) {
    return cx_strsplit_m_(string, delim, limit, output);
}
CX_CPPDECL size_t cx_strsplit_a_cpp_(const CxAllocator *allocator,
        cxstring string, cxstring delim, size_t limit, cxstring **output) {
    return cx_strsplit_a_(allocator, string, delim, limit, output);
}
CX_CPPDECL size_t cx_strsplit_a_cpp_(const CxAllocator *allocator,
        cxmutstr string, cxstring delim, size_t limit, cxmutstr **output) {
    return cx_strsplit_ma_(allocator, string, delim, limit, output);
}
#define cx_strsplit(string, delim, limit, output) \
        cx_strsplit_cpp_(cx_strcast_m(string), cx_strcast(delim), limit, output)
#define cx_strsplit_a(allocator, string, delim, limit, output) \
        cx_strsplit_a_cpp_(allocator, cx_strcast_m(string), cx_strcast(delim), limit, output)
#else
/**
 * 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 (@c size_t) the maximum number of split items
 * @param output (@c cxstring* or @c cxmutstr*) a preallocated array of at
 * least @p limit length
 * @return the actual number of split items
 */
#define cx_strsplit(string, delim, limit, output) \
        _Generic(cx_strcast_m(string), \
        cxstring: cx_strsplit_, \
        cxmutstr: cx_strsplit_m_)\
        (cx_strcast_m(string), cx_strcast(delim), limit, 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 (@c CxAllocator*) the allocator to use for allocating the resulting array
 * @param string the string to split
 * @param delim  the delimiter
 * @param limit (@c size_t) the maximum number of split items
 * @param output (@c cxstring** or @c cxmutstr**) a pointer where the address
 * of the allocated array shall be written to
 * @return the actual number of split items
 */
#define cx_strsplit_a(allocator, string, delim, limit, output) \
        _Generic(cx_strcast_m(string), \
        cxstring: cx_strsplit_a_, \
        cxmutstr: cx_strsplit_ma_)\
        (allocator, cx_strcast_m(string), cx_strcast(delim), limit, output)
#endif

/**
 * 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_EXTERN CX_NODISCARD
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_EXTERN CX_NODISCARD
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_EXTERN CX_NODISCARD CX_NONNULL
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_EXTERN CX_NODISCARD CX_NONNULL
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_EXTERN CX_NODISCARD CX_NONNULL
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)

/**
 * Trims a string.
 * Internal function - do not use.
 * @param string
 * @return
 */
CX_EXTERN CX_NODISCARD
cxstring cx_strtrim_(cxstring string);

#ifdef __cplusplus
CX_CPPDECL cxstring cx_strtrim_cpp_(cxstring string) {
    return cx_strtrim_(string);
}
CX_CPPDECL cxmutstr cx_strtrim_cpp_(cxmutstr string) {
    return cx_mutstrcast(cx_strtrim_(cx_strcast(string)));
}
#define cx_strtrim(string) cx_strtrim_cpp_(cx_strcast_m(string))
#else
/**
 * Internal conversion function.
 * @param string
 * @return
 */
CX_INLINE cxmutstr cx_strtrim_m_(cxmutstr string) {
    return cx_mutstrcast(cx_strtrim_(cx_strcast(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 (@c cxstring or @c cxmutstr) the trimmed string
 */
#define cx_strtrim(string) _Generic(cx_strcast_m(string), \
        cxstring: cx_strtrim_, \
        cxmutstr: cx_strtrim_m_)(cx_strcast_m(string))
#endif

/**
 * 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_EXTERN CX_NODISCARD
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_EXTERN CX_NODISCARD
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_EXTERN CX_NODISCARD
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_EXTERN CX_NODISCARD
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.
 *
 * Internal function - do not use.
 *
 * @param allocator
 * @param str
 * @param search
 * @param replacement
 * @param replmax
 * @return
 * @see cx_strreplace_a()
 * @see cx_strreplace()
 * @see cx_strreplacen_a()
 * @see cx_strreplacen()
 */
CX_EXTERN CX_NODISCARD CX_NONNULL
cxmutstr cx_strreplace_(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 @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 the string where replacements should be applied
 * @param search the string to search for
 * @param replacement 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_a(allocator, str, search, replacement, replmax) \
        cx_strreplace_(allocator, cx_strcast(str), cx_strcast(search), cx_strcast(replacement), 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 the string where replacements should be applied
 * @param search the string to search for
 * @param replacement 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 the string where replacements should be applied
 * @param search the string to search for
 * @param replacement 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 the string where replacements should be applied
 * @param search the string to search for
 * @param replacement 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_EXTERN CX_NODISCARD
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_EXTERN CX_NONNULL CX_NODISCARD CX_ACCESS_W(2)
bool cx_strtok_next_(CxStrtokCtx *ctx, cxstring *token);

#ifdef __cplusplus
CX_CPPDECL cx_strtok_next(CxStrtokCtx *ctx, cxstring *token) {
    return cx_strtok_next_(ctx, token);
}
CX_CPPDECL cx_strtok_next(CxStrtokCtx *ctx, cxmutstr *token) {
    // Note: this is actually UB - fixed with start_lifetime_as() in C++23
    //       but it works on all supported platforms
    return cx_strtok_next_(ctx, reinterpret_cast<cxstring*>(token));
}
#else // ! __cplusplus
/**
 * Returns the next token.
 *
 * The token will point to the source string.
 *
 * @param ctx (@c CxStrtokCtx*) the tokenization context
 * @param token a pointer to either a @c cxstring or @c cxmutstr
 * where the next token shall be stored
 * @return true if successful, false if the limit or the end of the string
 * has been reached
 */
#define cx_strtok_next(ctx, token) _Generic((token), \
        cxstring*: cx_strtok_next_, \
        cxmutstr*: cx_strtok_next_)(ctx, (cxstring*)token)
#endif

/**
 * 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_EXTERN CX_NONNULL CX_ACCESS_R(2, 3)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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_EXTERN CX_ACCESS_W(2) CX_NONNULL_ARG(2)
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, '.', ",")

#endif //UCX_STRING_H