1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
/*
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 <wx/wxprec.h>
#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 <wx/chartype.h>
#define WX_CHARTYPE_H_INCLUDED 1
#endif
#else
#if DK4_HAVE_WX_WXCHAR_H
#ifndef WX_WXCHAR_H_INCLUDED
#include <wx/wxchar.h>
#define WX_WXCHAR_H_INCLUDED 1
#endif
#else
#ifndef WX_WX_H_INCLUDED
#include <wx/wx.h>
#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<br>
if dst or src is NULL or sz is 0,
- DK4_E_BUFFER_TOO_SMALL<br>
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<br>
if dst or src is NULL or sz is 0,
- DK4_E_MATH_OVERFLOW<br>
if a mathematical overflow occured in size calculation,
- DK4_E_BUFFER_TOO_SMALL<br>
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 s1<s2.
*/
int
dk4strx_cmp(const wxChar *s1, const wxChar *s2);
/** Compare two strings, case-insensitive comparison.
@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 s1<s2.
*/
int
dk4strx_casecmp(const wxChar *s1, const wxChar *s2);
/** Compare two file path names.
@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 s1<s2.
*/
int
dk4strx_pathcmp(const wxChar *s1, const wxChar *s2);
/** Find first occurance of character c in string s.
@param s String to search for c.
@param c Character to find.
@return Pointer to first occurance if found, NULL otherwise.
*/
wxChar *
dk4strx_chr(const wxChar *s, wxChar c);
/** Find last occurance of character c in string s.
@param s String to search for c.
@param c Character to find.
@return Pointer to last occurance if found, NULL otherwise.
*/
wxChar *
dk4strx_rchr(const wxChar *s, wxChar c);
/** Retrieve first token from *stringp.
@param stringp Adress of string pointer.
@param delim String containing the delimiter set,
my be NULL to use the default delimiter
set (space, tabulator, carriage return and newline).
@return Pointer to first token on success, NULL if no (further)
token found.
*/
wxChar *
dk4strx_sep(wxChar **stringp, const wxChar *delim);
/** Find first token in string.
@param src String to search for tokens.
@param delim String containing the delimiter characters,
may be NULL to use the default delimiter set.
@return Pointer to first token if found, NULL otherwise.
*/
wxChar *
dk4strx_start(const wxChar *src, const wxChar *delim);
/** Cut string after first token, find start of second token in string.
@param src String to search for tokens,
normally the result of dk4strx_start() or a
previous dk4strx_next() call.
@param delim String containing the delimiter characters,
may be NULL to use the default delimiter set.
@return Pointer to second token if found, NULL otherwise.
*/
wxChar *
dk4strx_next(wxChar *src, const wxChar *delim);
/** Split a string into tokens.
@param dpp Pointer to string pointer array.
@param szdpp Size of destination string pointer array.
@param src Source string to process.
@param delim String containing delimiter characters,
may be NULL to use the default delimiter set.
@param erp Error report, may be NULL.
@return Number of tokens found on success, 0 if no token
found or on error.
Error codes:
- DK4_E_INVALID_ARGUMENTS<br>
for invalid function arguments,
- DK4_E_BUFFER_TOO_SMALL<br>
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<br>
if src is a NULL pointer,
- DK4_E_MATH_OVERFLOW<br>
on mathematical overflow in size calculation,
- DK4_E_MEMORY<br>
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
|