/* Copyright (C) 2015-2020, Dirk Krause SPDX-License-Identifier: BSD-3-Clause */ /* WARNING: This file was generated by the dkct program (see http://dktools.sourceforge.net/ for details). Changes you make here will be lost if dkct is run again! You should modify the original source and run dkct on it. Original source: dk4strd.ctr */ #ifndef DK4STRD_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4STRD_H_INCLUDED 1 #line 10 "dk4strd.ctr" /** @file String functions for dkChar characters. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #ifndef DK4TYPES_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4types.h" #else #include #endif #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.h" #else #include #endif #endif #ifdef __cplusplus extern "C" { #endif /** Copy string, check destination buffer size. CRT on Windows: Optional. @param dst Destination buffer address. @param sz Destination buffer size. @param src Source string. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if dst or src is NULL or sz is 0, - DK4_E_BUFFER_TOO_SMALL
if the dst buffer is too small. */ int dk4str_cpy_s(dkChar *dst, size_t sz, const dkChar *src, dk4_er_t *erp); /** Concatenate strings, check destination buffer size. CRT on Windows: Optional. @param dst Destination buffer address. @param sz Destination buffer size. @param src Source string. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if dst or src is NULL or sz is 0, - DK4_E_MATH_OVERFLOW
if a mathematical overflow occured in size calculation, - DK4_E_BUFFER_TOO_SMALL
if the concatenated string doest not fit into the buffer. */ int dk4str_cat_s(dkChar *dst, size_t sz, const dkChar *src, dk4_er_t *erp); /** Copy characters within a string from right to left. This copy operation is intended for moving characters within one string from right to left, making the string shorter as is. This function does not check buffer size or report any error. For normal string copy operations, use the dk4str_cpy_s() function instead. CRT on Windows: Not used. @param dst Destination buffer address. @param src Source string. */ void dk4str_cpy_to_left(dkChar *dst, const dkChar *src); /** Find string length. CRT on Windows: Optional, disabling CRT reduces functionality to strings with length fitting to int. @param src Source string. @return String length. */ size_t dk4str_len(const dkChar *src); /** Compare two strings. CRT on Windows: Optional. @param s1 Left string, may be NULL. @param s2 Right string, may be NULL. @return 1 if s1>s2, 0 if s1==s2, -1 if s1s2, 0 if s1==s2, -1 if s1s2, 0 if s1==s2, -1 if s1s2, 0 if s1==s2, -1 if s1 for invalid function arguments, - DK4_E_BUFFER_TOO_SMALL
with dt.mem.nelem set to the number of tokens in string if the dpp array is too short. */ size_t dk4str_tokenize( dkChar **dpp, size_t szdpp, dkChar *src, const dkChar *delim, dk4_er_t *erp ); /** Normalize a string (remove leading and trailing delimiters, replace delimiter sequences by just one delimiter). CRT on Windows: Optional, disabling CRT degrades performance. @param src Buffer containing the string to normalize. @param delim String containing delimiter characters, may be NULL to use the default delimiter set. */ void dk4str_normalize(dkChar *src, const dkChar *delim); /** Find index of a string in an array of strings. CRT on Windows: Optional. @param arr Array of strings. @param str String to find in array. @param cs Flag: Case-sensitive search (0=no, other=yes). @return Non-negative index value on success, -1 on error. */ int dk4str_array_index(const dkChar * const *arr, const dkChar *str, int cs); /** Find index of a string in an array of strings. CRT on Windows: Optional, disabling CRT degrades performance for case-insensitive comparisons. @param arr Array of strings allowing abbreviation. @param spec Special character indicating start of optional text. @param str String to find in array. @param cs Flag: Case-sensitive search (0=no, other=yes). @return Non-negative index value on success, -1 on error. */ int dk4str_abbr_index( const dkChar * const *arr, dkChar spec, const dkChar *str, int cs ); /** Check whether a text matches a pattern, the text may be abbreviated. CRT on windows: Optional, disabling CRT degrades performance for case-insensitive comparisons. @param str Text to check. @param pattern Pattern for comparison. @param spec Special character marking the abbreviation in the pattern. @param cs Flag: Case sensitive (1) or not (0). @return 1 for a match, 0 otherwise. */ int dk4str_is_abbr(const dkChar *str, const dkChar *pattern, dkChar spec, int cs); /** Check whether a string represents a boolean value. @param str String to check. @return 1 if str represents a boolean value, 0 otherwise. */ int dk4str_is_bool(const dkChar *str); /** Check whether a string represents the boolean value TRUE. CRT on Windows: Optional, disabling CRT degrades performance. @param str String to check. @return 1 if str represents the boolean value TRUE, 0 otherwise. */ int dk4str_is_on(const dkChar *str); #if (defined(_WIN32) && DK4_USE_WINDOWS_LOCAL_ALLOC) \ || (DK4_HAVE_MALLOC && DK4_HAVE_FREE) /** Duplicate string in dynamically allocated memory. CRT on Windows: Optional, disabling CRT reduces functionality to strings with length fitting to int and overall size in @param src String to duplicate. @param erp Error report, may be NULL. @return Pointer to string in new memory on succes, NULL on error. Use dk4mem_free() to release the memory after usage. Error codes: - DK4_E_INVALID_ARGUMENTS
if src is a NULL pointer, - DK4_E_MATH_OVERFLOW
on mathematical overflow in size calculation, - DK4_E_MEMORY_ALLOCATION_FAILED
with mem.elsize and mem.nelem set if no memory is available. */ dkChar * dk4str_dup(const dkChar *src, dk4_er_t *erp); #endif /* if (defined(_WIN32) ... */ /** Remove trailing white spaces. CRT on Windows: Optional, disabling CRT degrades performance. @param str String to remove white spaces from. @param whsp White spaces set. */ void dk4str_rtwh(dkChar *str, const dkChar *whsp); /** Remove trailing newline from line. CRT on Windows: Optional, disabling CRT degrades performance. @param lptr Line pointer. */ void dk4str_delnl(dkChar *lptr); /** Skip the first text words in a line, return pointer to start of next word. CRT on Windows: Optional, disabling CRT degrades performance. @param line Line to process. @param skip Number of words to skip. @return Pointer to next word on success, NULL on error. */ const dkChar * dk4str_skip(const dkChar *line, size_t skip); /** Sanitize string (overwrite using 0 bytes). CRT on Windows: Optional. @param str Address of string to sanitize. @return 1 on success, 0 on error. */ int dk4str_sanitize(dkChar *str); /** Sanitize string buffer (overwrite using 0 bytes). CRT on Windows: Optional. @param str Address of string buffer. @param sz Size of string buffer (number of dkChar). @return 1 on success, 0 on error. */ int dk4str_buffer_sanitize(dkChar *str, size_t sz); /** Sanitize dynamically allocated memory and release it. CRT on Windows: Optional. @param str Address of string to sanitize and release. @return 1 on success, 0 on error. */ int dk4str_free_sanitized(dkChar *str); #ifdef __cplusplus } #endif #if DK4_CHAR_SIZE > 1 /** Sanitize string and release it, set pointer to NULL. CRT on Windows: Optional. @param p Pointer to string to release. */ #define dk4str_release_sanitized(p) \ do { if (NULL != p) { (void)dk4strw_free_sanitized(p); } p = NULL; } while (0) #else /** Sanitize string and release it, set pointer to NULL. CRT on Windows: Optional. @param p Pointer to string to release. */ #define dk4str_release_sanitized(p) \ do { if (NULL != p) { (void)dk4str8_free_sanitized(p); } p = NULL; } while (0) #endif #endif