/* WARNING: This file was generated by dkct. 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: dk4strx.cpt */ /* Copyright (C) 2015-2017, Dirk Krause Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above opyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the author nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission. 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 OWNER 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. */ #ifndef DK4STRX_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4STRX_H_INCLUDED 1 #line 8 "dk4strx.cpt" /** @file dk4strx.h String functions for wxChar. */ #ifndef DK4CONF_H_INCLUDED #include "dk4conf.h" #endif #ifndef DK4TYPES_H_INCLUDED #include "dk4types.h" #endif #ifndef DK4CONST_H_INCLUDED #include "dk4const.h" #endif #ifndef DK4ERROR_H_INCLUDED #include "dk4error.h" #endif #ifndef DK4WXCS_H_INCLUDED #include "dk4wxcs.h" #endif #ifndef WX_WXPREC_H_INCLUDED #include #define WX_WXPREC_H_INCLUDED 1 #endif #ifdef __BORLANDC__ #pragma hdrstop #endif #ifndef WX_PRECOMP #if DK4_HAVE_WX_CHARTYPE_H #ifndef WX_CHARTYPE_H_INCLUDED #include #define WX_CHARTYPE_H_INCLUDED 1 #endif #else #if DK4_HAVE_WX_WXCHAR_H #ifndef WX_WXCHAR_H_INCLUDED #include #define WX_WXCHAR_H_INCLUDED 1 #endif #else #ifndef WX_WX_H_INCLUDED #include #define WX_WX_H_INCLUDED #endif #endif #endif #endif #ifdef __cplusplus extern "C" { #endif /** Copy string, check destination buffer size. @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 dk4strx_cpy_s(wxChar *dst, size_t sz, const wxChar *src, dk4_er_t *erp); /** Concatenate strings, check destination buffer size. @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 dk4strx_cat_s(wxChar *dst, size_t sz, const wxChar *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 dk4strx_cpy_s() function instead. @param dst Destination buffer address. @param src Source string. */ void dk4strx_cpy_to_left(wxChar *dst, const wxChar *src); /** Find string length. @param src Source string. @return String length. */ size_t dk4strx_len(const wxChar *src); /** Compare two strings. @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 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 dk4strx_tokenize( wxChar **dpp, size_t szdpp, wxChar *src, const wxChar *delim, dk4_er_t *erp ); /** Normalize a string (remove leading and trailing delimiters, replace delimiter sequences by just one delimiter). @param src Buffer containing the string to normalize. @param delim String containing delimiter characters, may be NULL to use the default delimiter set. */ void dk4strx_normalize(wxChar *src, const wxChar *delim); /** Find index of a string in an array of strings. @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 dk4strx_array_index(const wxChar * const *arr, const wxChar *str, int cs); /** Find index of a string in an array of strings. @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 dk4strx_abbr_index( const wxChar * const *arr, wxChar spec, const wxChar *str, int cs ); /** Check whether a text matches a pattern, the text may be abbreviated. @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 dk4strx_is_abbr(const wxChar *str, const wxChar *pattern, wxChar 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 dk4strx_is_bool(const wxChar *str); /** Check whether a string represents the boolean value TRUE. @param str String to check. @return 1 if str represents the boolean value TRUE, 0 otherwise. */ int dk4strx_is_on(const wxChar *str); #if (defined(_WIN32) && DK4_USE_WINDOWS_LOCAL_ALLOC) \ || (DK4_HAVE_MALLOC && DK4_HAVE_FREE) /** Duplicate string in dynamically allocated memory. @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
if no memory is available. */ wxChar * dk4strx_dup(const wxChar *src, dk4_er_t *erp); #endif /* if (defined(_WIN32) ... */ /** Remove trailing white spaces. @param str String to remove white spaces from. @param whsp White spaces set. */ void dk4strx_rtwh(wxChar *str, const wxChar *whsp); /** Remove trailing newline from line. @param lptr Line pointer. */ void dk4strx_delnl(wxChar *lptr); #ifdef __cplusplus } #endif #endif