:orphan: .. index:: pair: group; Regular strings .. _doxid-group__te__tools__te__str: Regular strings =============== .. toctree:: :hidden: Overview ~~~~~~~~ Function to operate the strings. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions static bool :ref:`te_str_is_null_or_empty`(const char* str); static const char* :ref:`te_str_empty_if_null`(const char* str); bool :ref:`te_str_is_equal_nospace`(const char* str1, const char* str2); char* :ref:`te_str_upper`(const char* src); char* :ref:`te_str_lower`(const char* src); char* :ref:`te_str_concat`(const char* first, const char* second); size_t :ref:`te_strlcpy`(char* dst, const char* src, size_t size); size_t :ref:`te_strlcat`(char* dst, const char* src, size_t size); :ref:`te_errno` :ref:`te_strlcpy_safe`(char* dst, const char* src, size_t size); char* :ref:`te_strlcpy_verbose`(const char* id, char* dst, const char* src, size_t size); char* :ref:`te_snprintf_verbose`(const char* id, char* dst, size_t size, const char* fmt, ...); :ref:`te_errno` :ref:`te_vsnprintf`(char* dst, size_t size, const char* fmt, va_list ap); :ref:`te_errno` :ref:`te_snprintf`(char* dst, size_t size, const char* fmt, ...); :ref:`te_errno` char* :ref:`te_str_strip_spaces`(const char* str); static const char* :ref:`te_str_strip_prefix`(const char* str, const char* prefix); size_t :ref:`te_str_common_prefix`(const char* str1, const char* str2); :ref:`te_errno` :ref:`te_strpbrk_balanced`(const char* str, char opening, char closing, char escape, const char* seps, const char** result); :ref:`te_errno` :ref:`te_strpbrk_rev_balanced`(const char* str, char opening, char closing, char escape, const char* seps, const char** result); :ref:`te_errno` :ref:`te_strtoumax`(const char* str, int base, uintmax_t* value); :ref:`te_errno` :ref:`te_strtou_size`(const char* str, int base, void* value, size_t size); :ref:`te_errno` :ref:`te_strtoi_size`(const char* str, int base, void* value, size_t size); :ref:`te_errno` :ref:`te_strtoimax`(const char* str, int base, intmax_t* value); :ref:`te_errno` :ref:`te_str_to_uint64`(const char* str, int base, uint64_t* value); :ref:`te_errno` :ref:`te_strtoul`(const char* str, int base, unsigned long int* value); :ref:`te_errno` :ref:`te_strtoi`(const char* str, int base, int* value); :ref:`te_errno` :ref:`te_strtoui`(const char* str, int base, unsigned int* value); :ref:`te_errno` :ref:`te_strtol_raw`(const char* input, char** endptr, int base, long int* result); :ref:`te_errno` :ref:`te_strtol_raw_silent`(const char* str, char** endptr, int base, long int* result); :ref:`te_errno` :ref:`te_strtol_silent`(const char* input, int base, long int* result); :ref:`te_errno` :ref:`te_strtol`(const char* input, int base, long int* result); :ref:`te_errno` :ref:`te_strtol_bool`(const char* input, bool* bresult); :ref:`te_errno` :ref:`te_strtoi_range_raw`(const char* input, int minval, int maxval, char** endptr, int base, int* result); :ref:`te_errno` :ref:`te_strtod_raw`(const char* str, char** endptr, double* result); :ref:`te_errno` :ref:`te_strtod`(const char* str, double* result); :ref:`te_errno` :ref:`te_str_hex_raw2str`(const uint8_t* data, size_t data_len, :ref:`te_string`* str); :ref:`te_errno` :ref:`te_str_hex_str2raw`(const char* str, uint8_t* data, size_t data_len); :ref:`te_errno` :ref:`te_str_find_index`(const char* str, const char** str_array, unsigned int str_array_len, unsigned int* index); char** :ref:`te_str_make_array`(const char* fst, ...); void :ref:`te_str_free_array`(char** str); :ref:`te_errno` :ref:`te_str_compare_versions`(const char* v1, const char* v2, int* res); // macros #define :ref:`TE_SNPRINTF`(_dst, _size, _fmt...) #define :ref:`TE_SPRINTF`(_buf, _fmt...) #define :ref:`TE_STRLCPY`(_dst, _src, _size) #define :target:`TE_STR_HEX_DELIMITER` .. _details-group__te__tools__te__str: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Function to operate the strings. Global Functions ---------------- .. index:: pair: function; te_str_is_null_or_empty .. _doxid-group__te__tools__te__str_1ga20c0463c40308d4c91d4e6b62f2167e7: .. ref-code-block:: cpp :class: doxyrest-title-code-block static bool te_str_is_null_or_empty(const char* str) Check for empty string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Byte string. .. rubric:: Returns: ``true`` if the string is ``NULL`` or zero-length; ``false`` otherwise. .. index:: pair: function; te_str_empty_if_null .. _doxid-group__te__tools__te__str_1ga665e48c96ea6ae126eec7272cb3ceb51: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* te_str_empty_if_null(const char* str) Return pointer to an empty string if the string is ``NULL`` or pointer to the string itself. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Byte string. .. rubric:: Returns: ``str`` or static empty string if ``str`` is ``NULL`` .. index:: pair: function; te_str_is_equal_nospace .. _doxid-group__te__tools__te__str_1ga3459366e2bdc11955a14585ecd6e60fa: .. ref-code-block:: cpp :class: doxyrest-title-code-block bool te_str_is_equal_nospace(const char* str1, const char* str2) Checks whether two strings are equal modulo space difference. In particular: * leading and trailing spaces are completely ignored * in the middle all non-empty sequences of whitespace characters are considered equal. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str1 - the first string * - str2 - the second string .. rubric:: Returns: ``true`` iff ``str1`` and ``str2`` are equal up to space difference. .. index:: pair: function; te_str_upper .. _doxid-group__te__tools__te__str_1ga5e24caf17b0bece3f92d7b3445fb1557: .. ref-code-block:: cpp :class: doxyrest-title-code-block char* te_str_upper(const char* src) Convert lowercase letters of the ``string`` to uppercase. The function does not work with multibyte/wide strings. Return value should be freed with free(3) when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - src - Source string. .. rubric:: Returns: Uppercase letters string, or ``NULL`` if it fails to allocate memory. .. index:: pair: function; te_str_lower .. _doxid-group__te__tools__te__str_1gacb3a09a7458f7494b97638a95449762c: .. ref-code-block:: cpp :class: doxyrest-title-code-block char* te_str_lower(const char* src) Convert uppercase letters of the ``string`` to lowercase. The function does not work with multibyte/wide strings. Return value should be freed with free(3) when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - src - Source string. .. rubric:: Returns: Lowercase letters string, or ``NULL`` if it fails to allocate memory. .. index:: pair: function; te_str_concat .. _doxid-group__te__tools__te__str_1ga2b78e1bf828397e1bd2cc104f2551474: .. ref-code-block:: cpp :class: doxyrest-title-code-block char* te_str_concat(const char* first, const char* second) Concatenate two strings and put result to the newly allocated string. The function does not work with multibyte/wide strings. Return value should be freed with free(3) when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - first - First string to concatenate. May be ``NULL``, in this case it will be interpreted as empty string, i.e. "". * - second - Second string to concatenate. May be ``NULL``, in this case it will be interpreted as empty string, i.e. "". .. rubric:: Returns: Concatenated string, or ``NULL`` if insufficient memory available to allocate a resulting string. .. index:: pair: function; te_strlcpy .. _doxid-group__te__tools__te__str_1ga3f78ef7d70f6ee46a97650a5f056421b: .. ref-code-block:: cpp :class: doxyrest-title-code-block size_t te_strlcpy(char* dst, const char* src, size_t size) Copy a string to provided buffer with NUL-terminated result guarantee. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - dst - Destination buffer * - src - String to copy * - size - Size of destination buffer .. rubric:: Returns: Total length even if it is larger than buffer size. .. index:: pair: function; te_strlcat .. _doxid-group__te__tools__te__str_1ga8423e953b0b3f2986f1dec7448df99f7: .. ref-code-block:: cpp :class: doxyrest-title-code-block size_t te_strlcat(char* dst, const char* src, size_t size) Concatenate with NUL-terminated result guarantee a string to provided string which is located in buffer of specified size. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - dst - Buffer with a string to concatenate to * - src - String to append * - size - Size of destination buffer .. rubric:: Returns: Total length even if it is larger than buffer size. .. index:: pair: function; te_strlcpy_safe .. _doxid-group__te__tools__te__str_1ga6972a97c98ce366952a11192aea04f6b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strlcpy_safe(char* dst, const char* src, size_t size) Same as :ref:`te_strlcpy() ` except it checks the result itself and returns a status code .. index:: pair: function; te_strlcpy_verbose .. _doxid-group__te__tools__te__str_1ga2cddde5cec0fd55c76c14ddf314cea7e: .. ref-code-block:: cpp :class: doxyrest-title-code-block char* te_strlcpy_verbose(const char* id, char* dst, const char* src, size_t size) Call :ref:`te_strlcpy_safe() ` and print an error message if there is no enough space in the buffer to allocate the whole input string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Prefix for error message, usually **func** * - dst - Destination buffer * - src - String to copy * - size - Size of destination buffer .. rubric:: Returns: A pointer to the destination buffer ``dst``. .. index:: pair: function; te_snprintf_verbose .. _doxid-group__te__tools__te__str_1ga3384d13e54d516e2d720a8d8b2cc306c: .. ref-code-block:: cpp :class: doxyrest-title-code-block char* te_snprintf_verbose(const char* id, char* dst, size_t size, const char* fmt, ...) The function is equivalent to the function :ref:`te_snprintf() `, except that it just prints error messages instead of returning error code .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - id - Prefix for error message, usually **func** * - dst - Pointer to destination buffer * - size - Size of destination buffer * - fmt - Format string * - ... - Format string arguments .. rubric:: Returns: A pointer to the destination string ``dst`` .. index:: pair: function; te_vsnprintf .. _doxid-group__te__tools__te__str_1ga5caeeb9bdbd83cfdf720ddf232a58f34: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_vsnprintf(char* dst, size_t size, const char* fmt, va_list ap) Write at most ``size`` bytes (including the terminating null byte ('\0')) to the buffer pointed to by ``dst`` according to a format string. The function does not call the va_end macro. Because it invokes the va_arg macro, the value of ap is undefined after the call .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - dst - Pointer to destination buffer * - size - Size of destination buffer * - fmt - Format string * - ap - List of arguments * - TE_ESMALLBUF - Size of destination buffer is not big enough to store the whole source string. If ``size`` = ``0``, ``dst`` is not modified * - errno - An output error is encountered .. rubric:: Returns: Status code .. rubric:: See also: :ref:`te_snprintf `, te_strnprintf .. index:: pair: function; te_snprintf .. _doxid-group__te__tools__te__str_1ga7eea016d2602147db1a508b45e365b40: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_snprintf(char* dst, size_t size, const char* fmt, ...) The function is equivalent to the function :ref:`te_vsnprintf() `, except that it is called with a variable number of arguments instead of a va_list .. index:: pair: function; te_str_strip_spaces .. _doxid-group__te__tools__te__str_1gaab42e8408795a2948125636e1d4b00aa: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` char* te_str_strip_spaces(const char* str) Take off heading and trailing spaces (all the symbols " \f\n\r\t\v"). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to strip spaces. .. rubric:: Returns: Pointer to the duplicated (heap) string without surrounding spaces, or ``NULL`` in case of memory allocation failure. .. index:: pair: function; te_str_strip_prefix .. _doxid-group__te__tools__te__str_1gad25d0707fd4248c5ed8d2da1cbc1d4a7: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* te_str_strip_prefix(const char* str, const char* prefix) Skips the ``prefix`` from the string ``str`` if it has one. The function does not allocate any memory, just returning a pointer into the original string or ``NULL`` if ``str`` does not start with ``prefix``, so it can freely be used just to test for a string prefix. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Source string. * - prefix - Expected prefix. .. rubric:: Returns: A pointer into ``str`` after the ``prefix`` or ``NULL``. .. index:: pair: function; te_str_common_prefix .. _doxid-group__te__tools__te__str_1ga7c54a1819a5db8c3d2bb979fdbf20d04: .. ref-code-block:: cpp :class: doxyrest-title-code-block size_t te_str_common_prefix(const char* str1, const char* str2) Return the longest common prefix of ``str1`` and ``str2``. Terminating zeroes are never considered part of the prefix. If any of the strings is ``NULL``, the prefix is considered to be zero. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str1 - First string. * - str2 - Second string. .. rubric:: Returns: Common prefix length. .. index:: pair: function; te_strpbrk_balanced .. _doxid-group__te__tools__te__str_1ga416b0a63c5c2fd9c108c23d0a0962cfa: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strpbrk_balanced(const char* str, char opening, char closing, char escape, const char* seps, const char** result) Search for the leftmost char from ``seps`` outside balanced parentheses. The function scans characters starting from ``str`` searching for any char in ``seps`` that is outside any nested group of parentheses defined by ``opening`` and ``closing``. If ``seps`` is ``NULL``, the leftmost character outside any parentheses is returned. If ``escape`` is not ``NUL``, it is used to escape parentheses and separator characters. .. ref-code-block:: cpp te_strpbrk_balanced("a(b,c),d", '(', ')', '\0', ",", result); result == ",d"; te_strpbrk_balanced("a(b,(c,d)),e", '(', ')', '\0', ",", result); result == ",e"; te_strpbrk_balanced("a(b,\\),c,d)\\,e,f", '(', ')', '\\', ",", result); result == ",f"; te_strpbrk_balanced("(abc)def", '(', ')', '\0', NULL, result); result == "def"; .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Source string. * - opening - Opening parenthesis character. * - closing - Closing parenthesis character. * - escape - Escape character (use ``NUL`` for no escape character). * - seps - List of separators to search for (may be ``NULL``). * - result - The location of a pointer to the leftmost found character or ``NULL`` if none found. If ``result`` itself may be ``NULL``, the found pointer is discarded. * - TE_ENOENT - No suitable character found. * - TE_EILSEQ - ``str`` contains unbalanced parentheses or dangling escape characters. .. rubric:: Returns: Status code. .. index:: pair: function; te_strpbrk_rev_balanced .. _doxid-group__te__tools__te__str_1gae38dc98db6b7845a6b4ea6e9890470bd: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strpbrk_rev_balanced(const char* str, char opening, char closing, char escape, const char* seps, const char** result) Like :ref:`te_strpbrk_balanced() `, but search for the rightmost character. .. ref-code-block:: cpp te_strpbrk_rev_balanced("a,(b,c)d", '(', ')', '\0', ",", result); result == ",(b,c)d"; te_strpbrk_rev_balanced("a,(b,(c,d))e", '(', ')', '\0', ",", result); result == ",(b,(c,d))e"; te_strpbrk_rev_balanced("a,(b,\\(,c,d)\\,e", '(', ')', '\\', ",", result); result == ",(b,\\(,c,d)\\,e"; te_strpbrk_rev_balanced("abc(def)", '(', ')', '\0', NULL, result); result == "c(def)"; There is slight asymmtetry between forward and reverse search functions: if ``seps`` is empty and the whole string is enclosed in parentheses, then forward searching would point to a terminating zero, but reverse searching would return ``NULL``, because we cannot assume there may be any characters before the string. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Source string. * - opening - Opening parenthesis character. * - closing - Closing parenthesis character. * - escape - Escape character (use ``NUL`` for no escape character). * - seps - List of separators to search for (may be ``NULL``). * - result - The location of a pointer to the rightmost found character or ``NULL`` if none found. If ``result`` itself may be ``NULL``, the found pointer is discarded. * - TE_ENOENT - No suitable character found. * - TE_EILSEQ - ``str`` contains unbalanced parentheses or dangling escape characters. .. rubric:: Returns: Status code. .. index:: pair: function; te_strtoumax .. _doxid-group__te__tools__te__str_1ga7688db2d36c93cfb7c14a21cc1c9bb82: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtoumax(const char* str, int base, uintmax_t* value) Wrapper over strtoumax(). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to convert. * - base - Base of a numeral system. * - value - Where to save conversion result (may be ``NULL``). .. rubric:: Returns: Status code. .. index:: pair: function; te_strtou_size .. _doxid-group__te__tools__te__str_1ga6d720756270e7430dcb25e862b4667f5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtou_size(const char* str, int base, void* value, size_t size) Parse unsigned integer of a given size. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to parse. * - base - Base of a numeral system. * - value - Parsed value (may be ``NULL``). * - size - Size of ``value`` in bytes (1, 2, 4 and 8 are supported). .. rubric:: Returns: Status code. .. index:: pair: function; te_strtoi_size .. _doxid-group__te__tools__te__str_1ga7983e0c5d410d68749dea933934aee73: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtoi_size(const char* str, int base, void* value, size_t size) Parse signed integer of a given size. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to parse. * - base - Base of a numeral system. * - value - Parsed value (may be ``NULL``). * - size - Size of ``value`` in bytes (1, 2, 4 and 8 are supported). .. rubric:: Returns: Status code. .. index:: pair: function; te_strtoimax .. _doxid-group__te__tools__te__str_1ga4b11cca78d7b45b31931a08e8e380d65: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtoimax(const char* str, int base, intmax_t* value) Wrapper over strtoimax(). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to convert. * - base - Base of a numeral system. * - value - Where to save conversion result (may be ``NULL``). .. rubric:: Returns: Status code. .. index:: pair: function; te_str_to_uint64 .. _doxid-group__te__tools__te__str_1gaf2b8d1ec0b8e64cb539c29a5d5fe4edd: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_str_to_uint64(const char* str, int base, uint64_t* value) Wrapper over :ref:`te_strtoumax() ` with overflow check. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to convert. * - base - Base of a numeral system. * - value - Where to save conversion result (may be ``NULL``). .. rubric:: Returns: Status code. .. index:: pair: function; te_strtoul .. _doxid-group__te__tools__te__str_1ga29d831892a72406910ff6d431572bd1a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtoul(const char* str, int base, unsigned long int* value) Wrapper over :ref:`te_strtoumax() ` with overflow check. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to convert. * - base - Base of a numeral system. * - value - Where to save conversion result (may be ``NULL``). .. rubric:: Returns: Status code. .. index:: pair: function; te_strtoi .. _doxid-group__te__tools__te__str_1gaf59fa5e42f1b6031a717d8b8f9525b0d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtoi(const char* str, int base, int* value) Wrapper for :ref:`te_strtol() ` with overflow check .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to convert. * - base - Base of the numeral system. * - value - Location for the resulting value (may be ``NULL``). .. rubric:: Returns: Status code. .. index:: pair: function; te_strtoui .. _doxid-group__te__tools__te__str_1ga113fbc94b9ff3a311513515b601ce9f9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtoui(const char* str, int base, unsigned int* value) Wrapper for :ref:`te_strtoumax() ` with overflow check. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to convert. * - base - Base of the numeral system. * - value - Location for the resulting value (may be ``NULL``). .. rubric:: Returns: Status code. .. index:: pair: function; te_strtol_raw .. _doxid-group__te__tools__te__str_1ga74833747aa341b7096dd2ef53b055183: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtol_raw(const char* input, char** endptr, int base, long int* result) Convert string to long int. Following characters are allowed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - input - String to convert. * - endptr - Pointer to the end of parsed int. * - base - Base to be used. * - result - Storage for result (may be ``NULL``). .. rubric:: Returns: 0 or error .. index:: pair: function; te_strtol_raw_silent .. _doxid-group__te__tools__te__str_1ga2417602ef7d3023bd8aca0289130ca7e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtol_raw_silent(const char* str, char** endptr, int base, long int* result) Convert a prefix of string to a long int without logging any errors. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - input - String to convert. * - endptr - Pointer to the end of a parsed prefix. * - base - Conversion base (``0`` to auto-detect). * - result - Storage for result. .. rubric:: Returns: Status code. .. index:: pair: function; te_strtol_silent .. _doxid-group__te__tools__te__str_1gacf081c955ed74a831dcac001548c5d79: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtol_silent(const char* input, int base, long int* result) Convert string to long int without error logs input is not a number. Should be used to avoid creating extra vars for 'end' parameter in the code. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - input - String to convert. * - base - Base to be used. * - result - Storage for result (may be ``NULL``). .. rubric:: Returns: 0 or error .. index:: pair: function; te_strtol .. _doxid-group__te__tools__te__str_1gac490ea3c53498f53f85b1a8e5c743da8: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtol(const char* input, int base, long int* result) Convert string to long int. Should be used to avoid creating extra vars for 'end' parameter in the code. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - input - String to convert. * - base - Base to be used. * - result - Storage for result (may be ``NULL``). .. rubric:: Returns: 0 or error .. index:: pair: function; te_strtol_bool .. _doxid-group__te__tools__te__str_1ga12ed5138b1678e6502df4b448c12c1c1: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtol_bool(const char* input, bool* bresult) Convert string to bool where ``0`` means ``false``, not ``0`` ``true``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - input - String to convert. * - bresult - Storage for result (may be ``NULL``). .. rubric:: Returns: 0 or error .. index:: pair: function; te_strtoi_range_raw .. _doxid-group__te__tools__te__str_1ga82bb6ff22ac62a9e5f4fdd67b6bb589b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtoi_range_raw(const char* input, int minval, int maxval, char** endptr, int base, int* result) Convert a string to an integer which must fit into a given range. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - input - String to convert. * - minval - Minimum allowed value. * - maxval - Maximum allowed value. * - endptr - Pointer to the tail of the string. * - base - Conversion base as per strtol(). * - result - Result value (may be ``NULL``). * - TE_ERANGE - The value is not within ``minval``.. ``maxval`` .. rubric:: Returns: Status code. .. index:: pair: function; te_strtod_raw .. _doxid-group__te__tools__te__str_1ga083d5e29144d73e5b7e1dbe64f4a04dc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtod_raw(const char* str, char** endptr, double* result) Convert string to double. Following characters are allowed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to convert. * - endptr - Pointer to the end of parsed double. * - result - Storage for result (may be ``NULL``). .. rubric:: Returns: Status code. .. index:: pair: function; te_strtod .. _doxid-group__te__tools__te__str_1ga66cd2bf478d80970a4351d410b7748ef: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_strtod(const char* str, double* result) Convert string to double. Should be used to avoid creating extra vars for 'end' parameter in the code. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - String to convert. * - result - Storage for result (may be ``NULL``). .. rubric:: Returns: Status code. .. index:: pair: function; te_str_hex_raw2str .. _doxid-group__te__tools__te__str_1gaf3a22e6ce6128ab964c81b26a9e86713: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_str_hex_raw2str(const uint8_t* data, size_t data_len, :ref:`te_string`* str) Convert raw data to hex-string representation .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - data - Raw data to be converted * - data_len - Length of the ``data`` * - str - Pointer to :ref:`te_string ` .. rubric:: Returns: Status code .. index:: pair: function; te_str_hex_str2raw .. _doxid-group__te__tools__te__str_1ga05a984f699214a59bbc74615359b4664: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_str_hex_str2raw(const char* str, uint8_t* data, size_t data_len) Convert hex-string to raw data .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Null-terminated hex-string * - data - Storage to raw data * - data_len - The length of the ``data`` .. rubric:: Returns: Status code .. index:: pair: function; te_str_find_index .. _doxid-group__te__tools__te__str_1gabad4b66698a97d8c630f35007ece13a5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_str_find_index(const char* str, const char** str_array, unsigned int str_array_len, unsigned int* index) Find index of the string in the array of strings. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - Null-terminated string * - str_array - Array of strings * - str_array_len - The length of the ``str_array`` * - index - The index of the ``srt`` in the ``str_array`` .. rubric:: Returns: Status code .. index:: pair: function; te_str_make_array .. _doxid-group__te__tools__te__str_1gafcf642d396c990c54e6af9baeebd54d9: .. ref-code-block:: cpp :class: doxyrest-title-code-block char** te_str_make_array(const char* fst, ...) Copy requested values to the new string array. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - fst - Pointer to the first string (it may be ``NULL``). * - ... - Other args for copying (it must end with ``NULL``). .. rubric:: Returns: A pointer to the newly allocated string array with ``NULL`` as the last element. .. index:: pair: function; te_str_free_array .. _doxid-group__te__tools__te__str_1ga7364e5b77319c6ed4cdb507ab19c6659: .. ref-code-block:: cpp :class: doxyrest-title-code-block void te_str_free_array(char** str) Free array of strings .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - str - The array of strings with ``NULL`` item at the end .. index:: pair: function; te_str_compare_versions .. _doxid-group__te__tools__te__str_1ga93e0ec9acca69756febeb9eb493dd47a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_str_compare_versions(const char* v1, const char* v2, int* res) Compares two version strings in Major.Minor.Patch format. Major/Minor/Patch parts should consist of digits only. ``res`` may take value that is * >0 if ``v1`` is greater (later) than ``v2``, * <0 if ``v1`` is less (earlier) than ``v2``, * 0 if ``v1`` is the same as ``v2``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - v1 - First version. * - v2 - Second version. * - res - Comparison result. .. rubric:: Returns: Status code. Macros ------ .. index:: pair: define; TE_SNPRINTF .. _doxid-group__te__tools__te__str_1ga38c84c77a99b8432665a5cb18ab201a4: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TE_SNPRINTF(_dst, _size, _fmt...) Fill a destination buffer according to a format string. It is a wrapper for :ref:`te_snprintf_verbose() ` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _dst - Pointer to destination buffer * - _size - Size of destination buffer * - _fmt - Format string with arguments .. rubric:: See also: :ref:`TE_SPRINTF ` .. index:: pair: define; TE_SPRINTF .. _doxid-group__te__tools__te__str_1ga89956b93fbb13bf734498df80c7db44f: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TE_SPRINTF(_buf, _fmt...) Fill a destination buffer according to a format string. It should only be used if the buffer is a real array, not a pointer .. rubric:: See also: :ref:`TE_SNPRINTF ` .. index:: pair: define; TE_STRLCPY .. _doxid-group__te__tools__te__str_1ga147774ac98e7a8c935e0db451a141308: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TE_STRLCPY(_dst, _src, _size) Call :ref:`te_strlcpy_verbose() ` with id "\__func\__". .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - _dst - Destination buffer * - _src - String to copy * - _size - Size of destination buffer