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

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



%%	header

/**	@file
	Directory traversal using dkChar file names.

	CRT on Windows: Optional.
*/


#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_CHAR_SIZE > 1
#ifndef DK4DIRWC_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4dirwc.h"
#else
#include <dktools-4/dk4dirwc.h>
#endif
#endif
#else
#ifndef DK4DIR08_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4dir08.h"
#else
#include <dktools-4/dk4dir08.h>
#endif
#endif
#endif

#if DK4_CHAR_SIZE > 1
/**	Directory listing.
*/
typedef	dk4_dir_wc_t	dk4_dir_t;
#else
/**	Directory listing.
*/
typedef	dk4_dir_c8_t	dk4_dir_t;
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**	Open directory, create directory structure.
	@param	path	Directory path name.
	@param	om	Opening mode.
	@param	erp	Error report, may be NULL.
	@return	Pointer to new directory structure on success, NULL on error.
	On success use dk4dir_close() to destroy the directory
	structure.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if path is NULL,
	- DK4_E_NOT_SUPPORTED<br>
	  if no function to traverse directories was found during build process,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  if a memory allocation failed,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occured in a size calculation,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if one of the involved directory or file names is too long for an
	  internal buffer,
	- DK4_E_OPENDIR_FAILED<br>
	  with errno value in iDetails1 if the attempt to open the directory
	  failed,
	- DK4_E_FINDFIRSTFILE_FAILED<br>
	  with GetLastError() value in lDetails1 if the FindFirstFile()
	  function failed on Windows,
	- DK4_E_SYSTEM<br>
	  if the stat() or lstat() function failed for one of the directory
	  items.
*/
dk4_dir_t *
dk4dir_open(const dkChar *path, int om, dk4_er_t *erp);

/**	Destroy directory structure.
	@param	dptr	Structure to destroy.
*/
void
dk4dir_close(dk4_dir_t *dptr);

/**	Reset directory traversal.
	@param	dptr	Directory structure.
*/
void
dk4dir_reset(dk4_dir_t *dptr);

/**	Retrieve directory path.
	@param	dptr	Directory structure.
	@return	Directory path on success,
		NULL on error or if no directory was specified for a
		file name expansion.
*/
const dkChar *
dk4dir_get_path(dk4_dir_t const *dptr);

/**	Retrieve next directory name.
	@param	dptr	Directory structure.
	@return	Pointer to short name on success, NULL if there are no
	more directories.
*/
const dkChar *
dk4dir_next_dir(dk4_dir_t *dptr);

/**	Retrieve next file (non-directory) name.
	@param	dptr	Directory structure.
	@return	Pointer to short name on success, NULL if there are no more
	files.
*/
const dkChar *
dk4dir_next_file(dk4_dir_t *dptr);

/**	Skip files (remove information about files, release memory).
	@param	dptr	Directory structure.
*/
void
dk4dir_skip_files(dk4_dir_t *dptr);

/**	Get maximum entry name length.
	@param	dptr	Directory.
	@return	Maximum name length.
*/
size_t
dk4dir_get_max_entry_length(dk4_dir_t const *dptr);

/**	Create full path name for short file name in existing buffer.
	@param	buffer	Result buffer.
	@param	szbuf	Size of result buffer (number of dkChar).
	@param	pdir	Directory fn was obtained from.
	@param	fn	Short file or directory name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if buffer, pdir or fn is NULL or szbuf is 0,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the buffer is too small.
*/
int
dk4dir_full_name_buffer(
  dkChar		*buffer,
  size_t		 szbuf,
  dk4_dir_t	const	*pdir,
  dkChar	const	*fn,
  dk4_er_t		*erp
);

/**	Create full path name for short file name in newly allocated buffer.
	@param	pdir	Directory fn was obtained from.
	@param	fn	Short file or directory name.
	@param	erp	Error report, may be NULL.
	@return	Valid pointer to newly allocated buffer on success,
	NULL on error.
	On success use dk4mem_free() to release the memory when done with
	the name.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if pdir or fn 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 *
dk4dir_full_name_new(
  dk4_dir_t	const	*pdir,
  dkChar	const	*fn,
  dk4_er_t		*erp
);

#ifdef __cplusplus
}
#endif

/**	Open modes for directories.
*/
enum {

  /* Value definitions */
				/**	Sort file names.
				*/
  DK4_DIR_OPEN_SORTED		=	1,

				/**	Treat symbolic links pointing to
					directories as files.
				*/
  DK4_DIR_SYMLINK_DIR_AS_FILE	=	2,

  /* Default modes for special purposes */

				/**	For deltree we do not follow
					symbolic links, no need for sorting.
				*/
  DK4_DIR_OPEN_DELTREE		=	DK4_DIR_SYMLINK_DIR_AS_FILE
};



%%	module

#include "dk4conf.h"
#include "dk4dir.h"
#if DK4_CHAR_SIZE > 1
#include "dk4dirwc.h"
#else
#include "dk4dir08.h"
#endif

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


dk4_dir_t *
dk4dir_open(const dkChar *path, int om, dk4_er_t *erp)
{
#if	DK4_USE_ASSERT
  assert(NULL != path);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4dir_wc_open(path, om, erp));
#else
  return (dk4dir_c8_open(path, om, erp));
#endif
}



void
dk4dir_close(dk4_dir_t *dptr)
{
#if	DK4_USE_ASSERT
  assert(NULL != dptr);
#endif
#if DK4_CHAR_SIZE > 1
  dk4dir_wc_close(dptr);
#else
  dk4dir_c8_close(dptr);
#endif
}



void
dk4dir_reset(dk4_dir_t *dptr)
{
#if	DK4_USE_ASSERT
  assert(NULL != dptr);
#endif
#if DK4_CHAR_SIZE > 1
  dk4dir_wc_reset(dptr);
#else
  dk4dir_c8_reset(dptr);
#endif
}



const dkChar *
dk4dir_get_path(dk4_dir_t const *dptr)
{
#if	DK4_USE_ASSERT
  assert(NULL != dptr);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4dir_wc_get_path(dptr));
#else
  return (dk4dir_c8_get_path(dptr));
#endif
}



const dkChar *
dk4dir_next_dir(dk4_dir_t *dptr)
{
#if	DK4_USE_ASSERT
  assert(NULL != dptr);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4dir_wc_next_dir(dptr));
#else
  return (dk4dir_c8_next_dir(dptr));
#endif
}



const dkChar *
dk4dir_next_file(dk4_dir_t *dptr)
{
#if	DK4_USE_ASSERT
  assert(NULL != dptr);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4dir_wc_next_file(dptr));
#else
  return (dk4dir_c8_next_file(dptr));
#endif
}




void
dk4dir_skip_files(dk4_dir_t *dptr)
{
#if	DK4_USE_ASSERT
  assert(NULL != dptr);
#endif
#if DK4_CHAR_SIZE > 1
  dk4dir_wc_skip_files(dptr);
#else
  dk4dir_c8_skip_files(dptr);
#endif
}



size_t
dk4dir_get_max_entry_length(dk4_dir_t const *dptr)
{
#if	DK4_USE_ASSERT
  assert(NULL != dptr);
#endif
#if DK4_CHAR_SIZE > 1
  return (dk4dir_wc_get_max_entry_length(dptr));
#else
  return (dk4dir_c8_get_max_entry_length(dptr));
#endif
}



int
dk4dir_full_name_buffer(
  dkChar		*buffer,
  size_t		 szbuf,
  dk4_dir_t	const	*pdir,
  dkChar	const	*fn,
  dk4_er_t		*erp
)
{
#if	DK4_USE_ASSERT
  assert(NULL != pdir);
  assert(NULL != fn);
  assert(NULL != buffer);
  assert(0 < szbuf);
#endif
#if	DK4_CHAR_SIZE > 1
  return (
    dk4dir_wc_full_name_buffer(buffer, szbuf, pdir, fn, erp)
  );
#else
  return (
    dk4dir_c8_full_name_buffer(buffer, szbuf, pdir, fn, erp)
  );
#endif
}



dkChar *
dk4dir_full_name_new(
  dk4_dir_t	const	*pdir,
  dkChar	const	*fn,
  dk4_er_t		*erp
)
{
#if	DK4_USE_ASSERT
  assert(NULL != pdir);
  assert(NULL != fn);
#endif
#if	DK4_CHAR_SIZE > 1
  return (
    dk4dir_wc_full_name_new(pdir, fn, erp)
  );
#else
  return (
    dk4dir_c8_full_name_new(pdir, fn, erp)
  );
#endif
}