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

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
license		=	bsd



%%	header

/**	@file
	String operations for path names
	(dkChar characters).
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#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.
	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);

#ifdef __cplusplus
}
#endif


%%	module


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

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



$!trace-include



int
dk4path_is_absolute(const dkChar *path)
{
#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_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_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_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_CHAR_SIZE > 1
  dk4pathw_correct_sep(filename);
#else
  dk4path8_correct_sep(filename);
#endif
}



int
dk4path_must_expand(const dkChar *filename)
{
#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 ((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
	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
	  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;
}