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

/*
Copyright (C) 2011-2017, 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.
*/

/**	@file dk3opt.h Header file for the dk3opt module.
*/

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


#line 10 "dk3opt.ctr"

#include "dk3conf.h"
#include "dk3types.h"

#ifdef __cplusplus
extern "C" {
#endif

/**	Create new options set.
	@param	options		Array of option descriptions.
	@param	szoptions	Number of entries in options.
	@param	foc		Character introducing a further option.
	@param	focl		String introducing a further option.
	@param	argc		Number of command line arguments to process.
	@param	argv		Command line arguments array pointer.
	@param	app	Application structure for diagnostics, may be NULL.
	@return	Pointer to option set on success, NULL on error.
*/
dk3_option_set_t *
dk3opt_open_app(
  dk3_option_t const	*options,
  size_t		 szoptions,
  dkChar		 foc,
  dkChar const		*focl,
  int			 argc,
  dkChar const * const	*argv,
  dk3_app_t		*app
);

/**	Create new options set.
	@param	options		Array of option descriptions.
	@param	szoptions	Number of entries in options.
	@param	foc		Character to indicate a further option.
	@param	focl		Long option for further options.
	@param	app	Application structure.
	@return	Pointer to option set on success, NULL on error.
*/
dk3_option_set_t *
dk3opt_open_from_app(
  dk3_option_t const	*options,
  size_t		 szoptions,
  dkChar		 foc,
  dkChar const		*focl,
  dk3_app_t		*app
);

/**	Check whether or not an option is set.
	@param	optset		Options set.
	@param	shortopt	Option character.
	@return	1 for option was set, 0 for option was not set.
*/
int
dk3opt_is_set(
  dk3_option_set_t const	*optset,
  dkChar			 shortopt
);

/**	Check whether or not a long option is set.
	@param	optset		Options set.
	@param	longopt		Long option name string.
	@return 1 for option was set, 0 for option was not set.
*/
int
dk3opt_is_set_long(
  dk3_option_set_t const	*optset,
  dkChar const			*longopt
);

/**	Get option argument.
	@param	optset		Options set.
	@param	shortopt	Option character.
	@return	Option argument (if any) or NULL.
*/
dkChar const *
dk3opt_get_short_arg(
  dk3_option_set_t const	*optset,
  dkChar			 shortopt
);

/**	Get long option argument.
	@param	optset		Options set.
	@param	longopt		Option name.
	@return	Option argument (if any) or NULL.
*/
dkChar const *
dk3opt_get_long_arg(
  dk3_option_set_t const	*optset,
  dkChar const			*longopt
);

/**	Get number of command line arguments without options.
	@param	optset		Options set.
	@return	Number of command line arguments.
*/
int
dk3opt_get_num_args(
  dk3_option_set_t const	*optset
);

/**	Get one command line argument.
	@param	optset		Options set.
	@param	num		Index of argument.
	@return	The argument on success, NULL on error.
*/
dkChar const *
dk3opt_get_arg(
  dk3_option_set_t const	*optset,
  int				 num
);

/**	Get number of further options.
	@param	os		Options set.
	@return	Number of further options.
*/
int
dk3opt_get_num_fo(
  dk3_option_set_t const	*os
);

/**	Get one further option.
	@param	os		Options set.
	@param	num		Index of option.
	@return	The further option on success, NULL on error.
*/
dkChar const *
dk3opt_get_fo(
  dk3_option_set_t const	*os,
  int			 num
);

/**	Destroy option set.
	@param	os	Option set to destroy.
*/
void
dk3opt_close(
  dk3_option_set_t *os
);

/**	Get error code.
	@param	os	Option set to check for errors.
	@return	Error code value.
*/
int
dk3opt_get_error_code(dk3_option_set_t const *os);

/**	Reset error code.
	@param	os	Option set to clean up.
*/
void
dk3opt_reset_error_code(dk3_option_set_t *os);

#ifdef __cplusplus
}
#endif




#endif