Line -... |
Line 1... |
- |
|
1 |
/*
|
- |
|
2 |
* Copyright (c) 2002-2006 The TenDRA Project <http://www.tendra.org/>.
|
- |
|
3 |
* All rights reserved.
|
- |
|
4 |
*
|
- |
|
5 |
* Redistribution and use in source and binary forms, with or without
|
- |
|
6 |
* modification, are permitted provided that the following conditions are met:
|
- |
|
7 |
*
|
- |
|
8 |
* 1. Redistributions of source code must retain the above copyright notice,
|
- |
|
9 |
* this list of conditions and the following disclaimer.
|
- |
|
10 |
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
- |
|
11 |
* this list of conditions and the following disclaimer in the documentation
|
- |
|
12 |
* and/or other materials provided with the distribution.
|
- |
|
13 |
* 3. Neither the name of The TenDRA Project nor the names of its contributors
|
- |
|
14 |
* may be used to endorse or promote products derived from this software
|
- |
|
15 |
* without specific, prior written permission.
|
- |
|
16 |
*
|
- |
|
17 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
|
- |
|
18 |
* IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
- |
|
19 |
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
- |
|
20 |
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
|
- |
|
21 |
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
- |
|
22 |
* EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
- |
|
23 |
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
|
- |
|
24 |
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
- |
|
25 |
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
- |
|
26 |
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
- |
|
27 |
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
- |
|
28 |
*
|
- |
|
29 |
* $Id$
|
- |
|
30 |
*/
|
1 |
/*
|
31 |
/*
|
2 |
Crown Copyright (c) 1997
|
32 |
Crown Copyright (c) 1997
|
3 |
|
33 |
|
4 |
This TenDRA(r) Computer Program is subject to Copyright
|
34 |
This TenDRA(r) Computer Program is subject to Copyright
|
5 |
owned by the United Kingdom Secretary of State for Defence
|
35 |
owned by the United Kingdom Secretary of State for Defence
|
6 |
acting through the Defence Evaluation and Research Agency
|
36 |
acting through the Defence Evaluation and Research Agency
|
7 |
(DERA). It is made available to Recipients with a
|
37 |
(DERA). It is made available to Recipients with a
|
8 |
royalty-free licence for its use, reproduction, transfer
|
38 |
royalty-free licence for its use, reproduction, transfer
|
9 |
to other parties and amendment for any purpose not excluding
|
39 |
to other parties and amendment for any purpose not excluding
|
10 |
product development provided that any such use et cetera
|
40 |
product development provided that any such use et cetera
|
11 |
shall be deemed to be acceptance of the following conditions:-
|
41 |
shall be deemed to be acceptance of the following conditions:-
|
12 |
|
42 |
|
13 |
(1) Its Recipients shall ensure that this Notice is
|
43 |
(1) Its Recipients shall ensure that this Notice is
|
14 |
reproduced upon any copies or amended versions of it;
|
44 |
reproduced upon any copies or amended versions of it;
|
15 |
|
45 |
|
16 |
(2) Any amended version of it shall be clearly marked to
|
46 |
(2) Any amended version of it shall be clearly marked to
|
17 |
show both the nature of and the organisation responsible
|
47 |
show both the nature of and the organisation responsible
|
18 |
for the relevant amendment or amendments;
|
48 |
for the relevant amendment or amendments;
|
19 |
|
49 |
|
20 |
(3) Its onward transfer from a recipient to another
|
50 |
(3) Its onward transfer from a recipient to another
|
21 |
party shall be deemed to be that party's acceptance of
|
51 |
party shall be deemed to be that party's acceptance of
|
22 |
these conditions;
|
52 |
these conditions;
|
23 |
|
53 |
|
24 |
(4) DERA gives no warranty or assurance as to its
|
54 |
(4) DERA gives no warranty or assurance as to its
|
25 |
quality or suitability for any purpose and DERA accepts
|
55 |
quality or suitability for any purpose and DERA accepts
|
26 |
no liability whatsoever in relation to any use to which
|
56 |
no liability whatsoever in relation to any use to which
|
27 |
it may be put.
|
57 |
it may be put.
|
28 |
*/
|
58 |
*/
|
Line 180... |
Line 210... |
180 |
* This is the type of argument to be passed to ``write_arg_usage''.
|
210 |
* This is the type of argument to be passed to ``write_arg_usage''.
|
181 |
*
|
211 |
*
|
182 |
***=== FUNCTIONS ============================================================
|
212 |
***=== FUNCTIONS ============================================================
|
183 |
*
|
213 |
*
|
184 |
** Function: void arg_parse_intern_descriptions
|
214 |
** Function: void arg_parse_intern_descriptions
|
185 |
* PROTO_S ((ArgListP arg_list))
|
215 |
* (ArgListP arg_list)
|
186 |
** Exceptions: XX_dalloc_no_memory, XX_error_redefined_string
|
216 |
** Exceptions: XX_dalloc_no_memory, XX_error_redefined_string
|
187 |
*
|
217 |
*
|
188 |
* This function should be called on all option lists that the program uses,
|
218 |
* This function should be called on all option lists that the program uses,
|
189 |
* before they are passed to ``arg_parse_arguments''. It replaces the
|
219 |
* before they are passed to ``arg_parse_arguments''. It replaces the
|
190 |
* descrption name with the named string it represents. It should only be
|
220 |
* descrption name with the named string it represents. It should only be
|
191 |
* called once on each list. The named strings used should be interned before
|
221 |
* called once on each list. The named strings used should be interned before
|
192 |
* this function is called.
|
222 |
* this function is called.
|
193 |
*
|
223 |
*
|
194 |
** Function: int arg_parse_arguments
|
- |
|
195 |
* PROTO_S ((ArgListP arg_list, EStringP usage, int argc,
|
224 |
** Function: int arg_parse_arguments(ArgListP arg_list, EStringP usage,
|
196 |
* char **argv))
|
225 |
* int argc, char **argv)
|
197 |
** Exceptions: XX_dalloc_no_memory, XX_ostream_write_error
|
226 |
** Exceptions: XX_dalloc_no_memory, XX_ostream_write_error
|
198 |
*
|
227 |
*
|
199 |
* This function does the argument parsing. The arg_list argument should
|
228 |
* This function does the argument parsing. The arg_list argument should
|
200 |
* specify the valid options for the program. The usage estring should be a
|
229 |
* specify the valid options for the program. The usage estring should be a
|
201 |
* named string, whose content is a summary of the program's usage. The argc
|
230 |
* named string, whose content is a summary of the program's usage. The argc
|
Line 203... |
Line 232... |
203 |
* program. The parsing starts from the first argument, so the first element
|
232 |
* program. The parsing starts from the first argument, so the first element
|
204 |
* of the program's argument list (the program name) should not be passed to
|
233 |
* of the program's argument list (the program name) should not be passed to
|
205 |
* this function. The function returns the number of elements of the list
|
234 |
* this function. The function returns the number of elements of the list
|
206 |
* that it parsed.
|
235 |
* that it parsed.
|
207 |
*
|
236 |
*
|
208 |
** Function: void write_arg_usage
|
- |
|
209 |
* PROTO_S ((OStreamP ostream, ArgUsageP closure))
|
237 |
** Function: void write_arg_usage(OStreamP ostream, ArgUsageP closure)
|
210 |
** Exceptions: XX_dalloc_no_memory, XX_ostream_write_error
|
238 |
** Exceptions: XX_dalloc_no_memory, XX_ostream_write_error
|
211 |
*
|
239 |
*
|
212 |
* This function can be used to write out a usage message based upon the usage
|
240 |
* This function can be used to write out a usage message based upon the usage
|
213 |
* information supplied.
|
241 |
* information supplied.
|
214 |
*
|
242 |
*
|
Line 274... |
Line 302... |
274 |
typedef struct ArgUsageT {
|
302 |
typedef struct ArgUsageT {
|
275 |
CStringP usage;
|
303 |
CStringP usage;
|
276 |
struct ArgListT *arg_list;
|
304 |
struct ArgListT *arg_list;
|
277 |
} ArgUsageT, *ArgUsageP;
|
305 |
} ArgUsageT, *ArgUsageP;
|
278 |
|
306 |
|
279 |
typedef void (*ArgProcP) PROTO_S ((CStringP, ArgUsageP, GenericP, ...));
|
307 |
typedef void(*ArgProcP)(CStringP, ArgUsageP, GenericP, ...);
|
280 |
|
308 |
|
281 |
typedef struct ArgListT {
|
309 |
typedef struct ArgListT {
|
282 |
CStringP name;
|
310 |
CStringP name;
|
283 |
char short_name;
|
311 |
char short_name;
|
284 |
ArgTypeT type;
|
312 |
ArgTypeT type;
|
Line 291... |
Line 319... |
291 |
} ArgListT, *ArgListP;
|
319 |
} ArgListT, *ArgListP;
|
292 |
|
320 |
|
293 |
/*--------------------------------------------------------------------------*/
|
321 |
/*--------------------------------------------------------------------------*/
|
294 |
|
322 |
|
295 |
extern void arg_parse_intern_descriptions
|
323 |
extern void arg_parse_intern_descriptions
|
296 |
PROTO_S ((ArgListP));
|
324 |
(ArgListP);
|
297 |
extern int arg_parse_arguments
|
325 |
extern int arg_parse_arguments
|
298 |
PROTO_S ((ArgListP, EStringP, int, char **));
|
326 |
(ArgListP, EStringP, int, char **);
|
299 |
|
327 |
|
300 |
extern void write_arg_usage
|
328 |
extern void write_arg_usage
|
301 |
PROTO_S ((OStreamP, ArgUsageP));
|
329 |
(OStreamP, ArgUsageP);
|
302 |
|
330 |
|
303 |
/*--------------------------------------------------------------------------*/
|
331 |
/*--------------------------------------------------------------------------*/
|
304 |
|
332 |
|
305 |
#define ARG_PARSE_END_LIST \
|
333 |
#define ARG_PARSE_END_LIST \
|
306 |
{NIL (CStringP), '\0', (ArgTypeT) 0, NIL (ArgProcP), NIL (GenericP), \
|
334 |
{NIL(CStringP), '\0',(ArgTypeT)0, NIL(ArgProcP), NIL(GenericP), \
|
307 |
UB NIL (CStringP) UE}
|
335 |
UB NIL(CStringP)UE}
|
308 |
|
336 |
|
309 |
#endif /* !defined (H_ARG_PARSE) */
|
337 |
#endif /* !defined (H_ARG_PARSE) */
|
310 |
|
338 |
|
311 |
/*
|
339 |
/*
|
312 |
* Local variables(smf):
|
340 |
* Local variables(smf):
|