summaryrefslogtreecommitdiff
path: root/support/dktools/dk4pathd.ctr
blob: f3c0c7ba14ddf1358d40d6881eda8b944b6968cd (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
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
SPDX-License-Identifier:	BSD-3-Clause



%%	header

/**	@file
	String operations for path names
	(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

#if DK4_HAVE_WCHAR_H
#ifndef WCHAR_H_INCLUDED
#include <wchar.h>
#define	WCHAR_H_INCLUDED 1
#endif
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**	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
dk4path_is_absolute(const dkChar *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
dk4path_is_relative(const dkChar *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
dk4path_append(
  dkChar *buffer, size_t sz, const dkChar *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.
*/
dkChar *
dk4path_get_suffix(const dkChar *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
dk4path_correct_sep(dkChar *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
dk4path_must_expand(const dkChar *filename);

/**	Check whether filename is in the specified parent directory.
	It may be equal to parent or below the parent directory.
	@param	filename	File or directory name to check.
	@param	parent		Parent directory.
	@param	erp		Error report, may be NULL.
	@return	1 for true, 0 for false.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if filename or parent is NULL,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if filename is too long for an internal buffer.
*/
int
dk4path_is_in_subdir(const dkChar *filename,const dkChar *parent,dk4_er_t *erp);

/**	Create file name with specified suffix.
	@param	pdst	Destination buffer.
	@param	szdst	Size of pdst (number of dkChar).
	@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
dk4path_set_suffix(
  dkChar	*pdst,
  size_t	 szdst,
  dkChar const	*srcname,
  dkChar 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.
*/
dkChar *
dk4path_dup_change_suffix(
  dkChar const	*srcname,
  dkChar 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
dk4path_concatenate_size(
  dkChar const	*dirname,
  dkChar 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 dkChar).
	@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
dk4path_concatenate_buffer(
  dkChar	*buffer,
  size_t	 szbuf,
  dkChar const	*dirn,
  dkChar 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.
*/
dkChar *
dk4path_concatenate_new(
  dkChar const	*dirn,
  dkChar const	*filen,
  dk4_er_t	*erp
);

#ifdef __cplusplus
}
#endif


%%	module


#include "dk4conf.h"

#include "dk4pathd.h"
#if DK4_CHAR_SIZE > 1
#include "dk4pathw.h"
#else
#include "dk4path8.h"
#endif

#if	DK4_HAVE_ASSERT_H
#ifndef	ASSERT_H_INCLUDED
#include <assert.h>
#define	ASSERT_H_INCLUDED 1
#endif
#endif

#include "dk4mem.h"
#include "dk4mpl.h"
#include "dk4strd.h"



$!trace-include



int
dk4path_is_absolute(const dkChar *path)
{
#if	DK4_USE_ASSERT
  assert(NULL != path);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4pathw_is_absolute(path));
#else
  return (dk4path8_is_absolute(path));
#endif
}



int
dk4path_is_relative(const dkChar *path)
{
#if	DK4_USE_ASSERT
  assert(NULL != path);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4pathw_is_relative(path));
#else
  return (dk4path8_is_relative(path));
#endif
}



int
dk4path_append(
  dkChar *buffer, size_t sz, const dkChar *filename, dk4_er_t *erp
)
{
#if	DK4_USE_ASSERT
  assert(NULL != buffer);
  assert(0 < sz);
  assert(NULL != filename);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4pathw_append(buffer, sz, filename, erp));
#else
  return (dk4path8_append(buffer, sz, filename, erp));
#endif
}



dkChar *
dk4path_get_suffix(const dkChar *filename, dk4_er_t *erp)
{
#if	DK4_USE_ASSERT
  assert(NULL != filename);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4pathw_get_suffix(filename, erp));
#else
  return (dk4path8_get_suffix(filename, erp));
#endif
}



void
dk4path_correct_sep(dkChar *filename)
{
#if	DK4_USE_ASSERT
  assert(NULL != filename);
#endif
#if DK4_CHAR_SIZE > 1
  dk4pathw_correct_sep(filename);
#else
  dk4path8_correct_sep(filename);
#endif
}



int
dk4path_must_expand(const dkChar *filename)
{
#if	DK4_USE_ASSERT
  assert(NULL != filename);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4pathw_must_expand(filename));
#else
  return (dk4path8_must_expand(filename));
#endif
}



int
dk4path_is_in_subdir(const dkChar *filename,const dkChar *parent,dk4_er_t *erp)
{
  dkChar	 buf[DK4_MAX_PATH];
  size_t	 szf;
  size_t	 szp;
  int		 back = 0;
  $? "+ dk4path_is_in_subdir f=\"%!ds\" p=\"%!ds\"", filename, parent
#if	DK4_USE_ASSERT
  assert(NULL != filename);
  assert(NULL != parent);
#endif
  if ((NULL != filename) && (NULL != parent)) {
    if (0 != dk4str_cpy_s(buf, DK4_SIZEOF(buf,dkChar), filename, erp)) {
      szf = dk4str_len(buf);
      szp = dk4str_len(parent);
      if (szf > szp) {			$? ". filename larger than parent"
#if DK4_ON_WINDOWS || DK4_HAVE_BACKSLASH_AS_SEP
	if (buf[szp] == dkT('\\'))
#else
        if (buf[szp] == dkT('/'))
#endif
	{				$? ". separator at right place"
	  buf[szp] = dkT('\0');
	  if (0 == dk4str_pathcmp(buf, parent)) {
	    back = 1;			$? ". match"
	  }
#if DK4_ON_WINDOWS || DK4_HAVE_BACKSLASH_AS_SEP
	  buf[szp] = dkT('\\');
#else
          buf[szp] = dkT('/');
#endif
	}
      } else {
        if (szf == szp) {		$? ". equal lengths"
	  if (0 == dk4str_pathcmp(buf, parent)) {
	    back = 1;			$? ". match"
	  }
	}
      }
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  } $? "- dk4path_is_in_subdir %d", back
  return back;
}



int
dk4path_set_suffix(
  dkChar	*pdst,
  size_t	 szdst,
  dkChar const	*srcname,
  dkChar const	*newsu,
  dk4_er_t	*erp
)
{
#if	DK4_USE_ASSERT
  assert(NULL != pdst);
  assert(0 < szdst);
  assert(NULL != srcname);
  assert(NULL != newsu);
#endif
#if	DK4_CHAR_SIZE > 1
  return (dk4pathw_set_suffix(pdst, szdst, srcname, newsu, erp));
#else
  return (dk4path8_set_suffix(pdst, szdst, srcname, newsu, erp));
#endif
}



dkChar *
dk4path_dup_change_suffix(
  dkChar const	*srcname,
  dkChar const	*newsu,
  dk4_er_t	*erp
)
{
#if	DK4_USE_ASSERT
  assert(NULL != srcname);
  assert(NULL != newsu);
#endif
#if	DK4_CHAR_SIZE > 1
  return (dk4pathw_dup_change_suffix(srcname, newsu, erp));
#else
  return (dk4path8_dup_change_suffix(srcname, newsu, erp));
#endif
}



size_t
dk4path_concatenate_size(
  dkChar const	*dirname,
  dkChar const	*filename,
  dk4_er_t	*erp
)
{
#if	DK4_USE_ASSERT
  assert(NULL != dirname);
  assert(NULL != filename);
#endif
#if	DK4_CHAR_SIZE > 1
  return (dk4pathw_concatenate_size(dirname, filename, erp));
#else
  return (dk4path8_concatenate_size(dirname, filename, erp));
#endif
}



int
dk4path_concatenate_buffer(
  dkChar	*buffer,
  size_t	 szbuf,
  dkChar const	*dirn,
  dkChar const	*filen,
  dk4_er_t	*erp
)
{
#if	DK4_USE_ASSERT
  assert(NULL != buffer);
  assert(0 < szbuf);
  assert(NULL != dirn);
  assert(NULL != filen);
#endif
#if	DK4_CHAR_SIZE > 1
  return (dk4pathw_concatenate_buffer(buffer, szbuf, dirn, filen, erp));
#else
  return (dk4path8_concatenate_buffer(buffer, szbuf, dirn, filen, erp));
#endif
}



dkChar *
dk4path_concatenate_new(
  dkChar const	*dirn,
  dkChar const	*filen,
  dk4_er_t	*erp
)
{
#if	DK4_USE_ASSERT
  assert(NULL != dirn);
  assert(NULL != filen);
#endif
#if	DK4_CHAR_SIZE > 1
  return (dk4pathw_concatenate_new(dirn, filen, erp));
#else
  return (dk4path8_concatenate_new(dirn, filen, erp));
#endif
}