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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
/*
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 <dktools-4/dk4conf.h>
#endif
#endif
#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.h>
#endif
#endif
#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#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<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
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<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
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 s1<s2.
*/
int
dk4str_cmp(const dkChar *s1, const dkChar *s2);
/** Compare two strings.
CRT on Windows: Optional.
@param s1 Left string, may be NULL.
@param s2 Right string, may be NULL.
@param n Maximum number of characters to compare.
@return 1 if s1>s2, 0 if s1==s2, -1 if s1<s2.
*/
int
dk4str_ncmp(const dkChar *s1, const dkChar *s2, size_t n);
/** Compare two strings, case-insensitive comparison.
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 s1<s2.
*/
int
dk4str_casecmp(const dkChar *s1, const dkChar *s2);
/** Compare two file path names.
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 s1<s2.
*/
int
dk4str_pathcmp(const dkChar *s1, const dkChar *s2);
/** Find first occurance of character c in string s.
CRT on Windows: Optional, disabling CRT degrades performance.
@param s String to search for c.
@param c Character to find.
@return Pointer to first occurance if found, NULL otherwise.
*/
dkChar *
dk4str_chr(const dkChar *s, dkChar c);
/** Find last occurance of character c in string s.
CRT on Windows: Optional, disabling CRT degrades performance.
@param s String to search for c.
@param c Character to find.
@return Pointer to last occurance if found, NULL otherwise.
*/
dkChar *
dk4str_rchr(const dkChar *s, dkChar c);
/** Retrieve first token from *stringp.
CRT on Windows: Optional, disabling CRT degrades performance.
@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.
*/
dkChar *
dk4str_sep(dkChar **stringp, const dkChar *delim);
/** Find first token in string.
CRT on Windows: Optional, disabling CRT degrades performance.
@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.
*/
dkChar *
dk4str_start(const dkChar *src, const dkChar *delim);
/** Cut string after first token, find start of second token in string.
CRT on Windows: Optional, disabling CRT degrades performance.
@param src String to search for tokens,
normally the result of dk4str_start() or a
previous dk4str_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.
*/
dkChar *
dk4str_next(dkChar *src, const dkChar *delim);
/** Split a string into tokens.
CRT on Windows: Optional, disabling CRT degrades performance.
@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
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<br>
if src is a NULL pointer,
- DK4_E_MATH_OVERFLOW<br>
on mathematical overflow in size calculation,
- DK4_E_MEMORY_ALLOCATION_FAILED<br>
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
|