summaryrefslogtreecommitdiff
path: root/support/dktools/dk4strx.h
blob: c8c9c0b99db1700bd44ef694d321c728c6f16fcd (plain)
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
/*
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: dk4strx.cpt
*/

#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
#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 DK4CONST_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4const.h"
#else
#include <dktools-4/dk4const.h>
#endif
#endif

#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#endif

#ifndef DK4WXCS_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4wxcs.h"
#else
#include <dktools-4/dk4wxcs.h>
#endif
#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



#if DK4_ON_WINDOWS || DK4_HAVE_BACKSLASH
/**	File name separator.
*/
#define	DK4_WX_CHAR_SEP	wxT('\\')
#else
/**	File name separator.
*/
#define DK4_WX_CHAR_SEP wxT('/')
#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);

/**	Find file name suffix.
	@param	filename	File name to find suffix from.
	@param	erp		Error report, may be NULL.
	@return	Valid pointer on success, NULL on error.
*/
wxChar const *
dk4strx_get_path_suffix(wxChar const *filename, dk4_er_t *erp);

/**	Check whether a file name is an absolute path.
	CRT on Windows: Not used.
	@param	path	Path name to check.
	@return	1 for absolute path, 0 for other path.
*/
int
dk4strx_path_is_absolute(const wxChar *path);

/**	Check whether a file name is a relative path.
	CRT on Windows: Not used.
	@param	path	Path name to check.
	@return	1 for absolute path, 0 for other path.
*/
int
dk4strx_path_is_relative(const wxChar *path);

/**	Append path filename to path name already stored in buffer.
	Resolve . and .. for current directory and parent directory.
	CRT on Windows: Optional, disabling CRT degrades performance.
	@param	buffer		Buffer already containing a path.
	@param	sz		Buffer size.
	@param	filename	Relative file name to append to buffer.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if buffer or filename is NULL or sz is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  if filename is too long,
	- DK4_E_MEMORY<br>
	  if allocation of a filename copy fails,
	- DK4_E_SYNTAX<br>
	  if too many .. in filename,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if buffer size is too small.
*/
int
dk4strx_path_append(
  wxChar *buffer, size_t sz, const wxChar *filename, dk4_er_t *erp
);


/**	Find pointer to suffix.
	CRT on Windows: Not used.
	@param	filename	File name to find suffix for.
	@param	erp		Error report, may be NULL.
	@return	Pointer to suffix dot if found, NULL otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if filename is NULL,
	- DK4_E_NOT_FOUND<br>
	  if the file name does not contain a suffix.
*/
wxChar *
dk4strx_path_get_suffix(const wxChar *filename, dk4_er_t *erp);


/**	Correct file name separators from slash to backslash on Windows,
	vice versa on other systems.
	CRT on Windows: Not used.
	@param	filename	File name to correct.
*/
void
dk4strx_path_correct_sep(wxChar *filename);

/**	Check whether file name needs expansion on Windows.
	CRT on Windows: Not used.
	@param	filename	File name to check.
	@return	1 if expansion is necessary, 0 otherwise.
*/
int
dk4strx_path_must_expand(const wxChar *filename);

/**	Create file name with specified suffix.
	@param	pdst	Destination buffer.
	@param	szdst	Size of pdst (number of wxChar).
	@param	srcname	Source file name.
	@param	newsu	New file suffix.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if pdst or srcname or newsu is NULL or szdst is 0,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the dst buffer is too small.
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occured in size calculation,
*/
int
dk4strx_path_set_suffix(
  wxChar	*pdst,
  size_t	 szdst,
  wxChar const	*srcname,
  wxChar const	*newsu,
  dk4_er_t	*erp
);

/**	Create a dynamic copy of a file name with changed suffix.
	@param	srcname	Old file name.
	@param	newsu	New suffix.
	@param	erp	Error report, may be NULL.
	@return	Valid pointer to changed file name on success, NULL on error.
	On success call dk4mem_free() on the pointer when no longer needed
	to release the memory.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if srcname or newsu is NULL,
	- DK4_E_BUG<br>
	  if a bug occured,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occured in size calculation,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem set if there is not enough memory
	  available.
*/
wxChar *
dk4strx_path_dup_change_suffix(
  wxChar const	*srcname,
  wxChar const	*newsu,
  dk4_er_t	*erp
);

/**	Calculate buffer size required to concatenate a directory
	name and a file name.
	@param	dirname		Directory name.
	@param	filename	File name.
	@param	erp		Error report, may be NULL.
	@return	Buffer size for concatenated names including the finalizer
	byte on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dirname or filename is NULL,
	- DK4_E_MATH_OVERFLOW<br>
	  if the calculation results in a numeric overflow.
*/
size_t
dk4strx_path_concatenate_size(
  wxChar const	*dirname,
  wxChar const	*filename,
  dk4_er_t	*erp
);

/**	Concatenate a directory name and a file name into an existing buffer.
	This function simply concatenates directory name and file name,
	. and .. for current and parent directory are not resolved.
	@param	buffer	Result buffer for combined file name.
	@param	szbuf	Buffer size (number of wxChar).
	@param	dirn	Directory name.
	@param	filen	File name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if buffer, dirn or filen is NULL or szbuf is 0,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the buffer is too small.
*/
int
dk4strx_path_concatenate_buffer(
  wxChar	*buffer,
  size_t	 szbuf,
  wxChar const	*dirn,
  wxChar const	*filen,
  dk4_er_t	*erp
);

/**	Concatenate a directory name and a file name into newly
	allocated memory.
	This function simply concatenates directory name and file name,
	. and .. for current and parent directory are not resolved.
	@param	dirn	Directory name.
	@param	filen	File name.
	@param	erp	Error report, may be NULL.
	@return	Valid pointer to newly allocated memory containing the
	concatenation on success, NULL on error.
	On success use dk4mem_free() to release the memory when done
	with it.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dirn or filen is NULL,
	- DK4_E_MATH_OVERFLOW<br>
	  if the size calculation results in a numeric overflow.
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  if the memory allocation failed,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the buffer is too small.
*/
wxChar *
dk4strx_path_concatenate_new(
  wxChar const	*dirn,
  wxChar const	*filen,
  dk4_er_t	*erp
);


/**	Check whether a file name is in specified directory.
	There is no check for the presence of the file, just
	a name check.
	@param	filename	File name to check.
	@param	parent		Directory the file should be in.
	@param	erp			Error report, may be NULL.
	@return	Non-zero value if file is in directory, 0 otherwise.
*/
int
dk4strx_path_is_in_subdir(
	const wxChar	*filename,
	const wxChar	*parent,
	dk4_er_t		*erp
);

#ifdef __cplusplus
}
#endif


/* vim: set ai sw=4 ts=4 : */


#endif