summaryrefslogtreecommitdiff
path: root/support/dktools/dk4aopt.h
blob: ada76714e57f0aafc747d499b155c3f19675e975 (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
/*
	WARNING: This file was generated by dkct.
	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: dk4aopt.ctr
*/

/*
Copyright (C) 2014, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

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

/**	@file	dk4aopt.h	Command line options with dk4_app_t support.

The dk4app_opt_is_set_short() and dk4app_opt_is_set_long() only return
success, if the specified option was allowed in the option specification
and found on the command line.

The dk4app_opt_get_string_short(), dk4app_opt_get_string_long(),
dk4app_opt_get_double_short(), dk4app_opt_get_double_long(),
dk4app_opt_get_int_short(), dk4app_opt_get_int_long(),
dk4app_opt_get_unsigned_short(), dk4app_opt_get_unsigned_long(),
dk4app_opt_get_size_short(), dk4app_opt_get_size_long(),
dk4app_opt_get_bool_short(), and dk4app_opt_get_bool_long()
functions only return success, if the specified option was allowed/configured
in the option specifications with the correct data type and the option
was found on the command line.
*/

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

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

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifndef DK4APP_H_INCLUDED
#include "dk4app.h"
#endif

#ifndef DK4OPT_H_INCLUDED
#include "dk4opt.h"
#endif



#ifdef __cplusplus
extern "C" {
#endif

/**	Check whether a short option is set.
	@param	app	Application structure.
	@param	c	Short option character.
	@param	erp	Error report, may be NULL.
	@return	1 if option is set, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_is_set_short(dk4_app_t *app, dkChar c, dk4_er_t *erp);

/**	Check whether a long option is set.
	@param	app	Application structure.
	@param	n	Long option name.
	@param	erp	Error report, may be NULL.
	@return 1 if option is set, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp, app, or n is NULL or the application is not configured
	  for preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_is_set_long(dk4_app_t *app, const dkChar *n, dk4_er_t *erp);

/**	Get string argument for short option.
	@param	dptr	Address of result buffer.
	@param	szdptr	Size of result buffer (number of dkChar).
	@param	app	Application structure.
	@param	c	Short option character.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible data type,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the destination buffer is too small to hold the text,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the destination buffer is too small to hold a conversion result,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_string_short(
  dkChar	*dptr,
  size_t	 szdptr,
  dk4_app_t	*app,
  dkChar	 c,
  dk4_er_t	*erp
);

/**	Get string argument for long option.
	@param	dptr	Address of result buffer.
	@param	szdptr	Size of result buffer (number of dkChar).
	@param	app	Application structure.
	@param	n	Long option name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible data type,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the destination buffer is too small to hold the text,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the destination buffer is too small to hold a conversion result,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_string_long(
  dkChar	*dptr,
  size_t	 szdptr,
  dk4_app_t	*app,
  const dkChar	*n,
  dk4_er_t	*erp
);

/**	Get pointer to string argument for short option.
	@param	app	Application structure.
	@param	c	Short option character.
	@param	erp	Error report, may be NULL.
	@return	Pointer to string argument on success, NULL on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if app is NULL or there is no option storage in app,
	- DK4_E_SYNTAX<br>
	  if c is not in the list of accepted options or does not
	  accept a string argument,
	- DK4_E_NOT_FOUND<br>
	  if the option was not specified on the command line.
*/
const dkChar *
dk4app_opt_get_string_ptr_short(dk4_app_t *app, dkChar c, dk4_er_t *erp);

/**	Get pointer to string argument for long option.
	@param	app	Application structure.
	@param	n	Long option character.
	@param	erp	Error report, may be NULL.
	@return	Pointer to string argument on success, NULL on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if app is NULL or there is no option storage in app,
	- DK4_E_SYNTAX<br>
	  if n is not in the list of accepted options or does not
	  accept a string argument,
	- DK4_E_NOT_FOUND<br>
	  if the option was not specified on the command line.
*/
const dkChar *
dk4app_opt_get_string_ptr_long(dk4_app_t *app, const dkChar *n, dk4_er_t *erp);

/**	Get double argument for short option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	c	Short option character.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured
	  for preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible data type,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_double_short(
  double	*rp,
  dk4_app_t	*app,
  dkChar	 c,
  dk4_er_t	*erp
);

/**	Get double argument for long option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	n	Long option name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp, app, or n is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_double_long(
  double	*rp,
  dk4_app_t	*app,
  const dkChar	*n,
  dk4_er_t	*erp
);

/**	Get integer argument for short option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	c	Short option character.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible type or the option argument string does not
	  represent an integer number,
	- DK4_E_MATH_OVERFLOW<br>
	  if the option was configured for another numeric type and conversion
	  results in an overflow,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_int_short(dk4_im_t *rp, dk4_app_t *app, dkChar c, dk4_er_t *erp);

/**	Get integer argument for long option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	n	Long option name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible type or the option argument string does not
	  represent an integer number,
	- DK4_E_MATH_OVERFLOW<br>
	  if the option was configured for another numeric type and conversion
	  results in an overflow,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_int_long(
  dk4_im_t	*rp,
  dk4_app_t	*app,
  const dkChar	*n,
  dk4_er_t	*erp
);

/**	Get unsigned integer argument for short option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	c	Short option character.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible data type or the option argument string does not
	  represent an integer number,
	- DK4_E_MATH_OVERFLOW<br>
	  if the option was configured for an incompatible numeric type and a
	  negative value is stored,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_unsigned_short(
  dk4_um_t	*rp,
  dk4_app_t	*app,
  dkChar	 c,
  dk4_er_t	*erp
);

/**	Get unsigned integer argument for long option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	n	Long option name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible data type or the option argument string does not
	  represent an integer number,
	- DK4_E_MATH_OVERFLOW<br>
	  if the option was configured for an incompatible numeric type and a
	  negative value is stored,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_unsigned_long(
  dk4_um_t	*rp,
  dk4_app_t	*app,
  const dkChar	*n,
  dk4_er_t	*erp
);

/**	Get size_t argument for short option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	c	Short option character.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible type or the option argument string can not be
	  converted to size_t,
	- DK4_E_MATH_OVERFLOW<br>
	  if the option was configured for another numeric type and conversion
	  results in an overflow.
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_size_short(size_t *rp, dk4_app_t *app, dkChar c, dk4_er_t *erp);

/**	Get size_t argument for long option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	n	Long option name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp or app is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible type or the option argument string can not be
	  converted to size_t,
	- DK4_E_MATH_OVERFLOW<br>
	  if the option was configured for another numeric type and conversion
	  results in an overflow.
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_size_long(
  size_t	*rp,
  dk4_app_t	*app,
  const dkChar	*n,
  dk4_er_t	*erp
);

/**	Get boolean argument for short option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	c	Short option character.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp, app, or n is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible data type,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_bool_short(int *rp, dk4_app_t *app, dkChar c, dk4_er_t *erp);

/**	Get boolean argument for long option.
	@param	rp	Address of result variable.
	@param	app	Application structure.
	@param	n	Long option name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if rp, app, or n is NULL or the application is not configured for
	  preferences retrieval,
	- DK4_E_SYNTAX<br>
	  if an invalid option was specified or the option was configured for
	  an incompatible data type,
	- DK4_E_NOT_FOUND<br>
	  if the option was not used on the command line.
*/
int
dk4app_opt_get_bool_long(
  int		*rp,
  dk4_app_t	*app,
  const dkChar	*n,
  dk4_er_t	*erp
);

#ifdef __cplusplus
}
#endif




#endif