summaryrefslogtreecommitdiff
path: root/support/dktools/dk4dirwc.h
blob: e60d16a499fb8498af5a90e6095eed4db6656fa9 (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
/*
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: dk4dirwc.ctr
*/

#ifndef DK4DIRWC_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4DIRWC_H_INCLUDED 1


#line 10 "dk4dirwc.ctr"

/**	@file
	Directory traversal using wchar_t 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

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


/**	Directory structure.
*/
typedef struct {
  wchar_t	*path;		/**< Directory path. */
  dk4_sto_t	*s_dir;		/**< Storage for directories. */
  dk4_sto_it_t	*i_dir;		/**< Iterator for directories. */
  dk4_sto_t	*s_file;	/**< Storage for non-directories. */
  dk4_sto_it_t	*i_file;	/**< Iterator for non-directories. */
  size_t	 maxlen;	/**< Maximum entry name length. */
} dk4_dir_wc_t;

#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_wc_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_wc_t *
dk4dir_wc_open(const wchar_t *path, int om, dk4_er_t *erp);

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

/**	Reset directory traversal.
	@param	dptr	Directory structure.
*/
void
dk4dir_wc_reset(dk4_dir_wc_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 wchar_t *
dk4dir_wc_get_path(dk4_dir_wc_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 wchar_t *
dk4dir_wc_next_dir(dk4_dir_wc_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 wchar_t *
dk4dir_wc_next_file(dk4_dir_wc_t *dptr);

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

/**	Compare two file or directory names.
	@param	l	Left name.
	@param	r	Right name.
	@param	cr	Comparison criteria (ignored).
	@return	1 if l>r, 0 if l=r, -1 if l<r.
*/
int
dk4dir_wc_compare(const void *l, const void *r, int cr);

/**	Get maximum entry name length.
	@param	dptr	Directory.
	@return	Maximum name length.
*/
size_t
dk4dir_wc_get_max_entry_length(dk4_dir_wc_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 wchar_t).
	@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_wc_full_name_buffer(
  wchar_t		*buffer,
  size_t		 szbuf,
  dk4_dir_wc_t	const	*pdir,
  wchar_t	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.
*/
wchar_t *
dk4dir_wc_full_name_new(
  dk4_dir_wc_t	const	*pdir,
  wchar_t	const	*fn,
  dk4_er_t		*erp
);

#ifdef __cplusplus
}
#endif


#endif