getarg.h revision 78527 
1/*
2 * Copyright (c) 1997 - 2001 Kungliga Tekniska H�gskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * 3. Neither the name of the Institute nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 */
33
34/* $Id: getarg.h,v 1.11 2001/04/25 12:06:37 assar Exp $ */
35
36#ifndef __GETARG_H__
37#define __GETARG_H__
38
39#include <stddef.h>
40
41struct getargs{
42    const char *long_name;
43    char short_name;
44    enum { arg_integer,
45	   arg_string,
46	   arg_flag,
47	   arg_negative_flag,
48	   arg_strings,
49	   arg_double,
50	   arg_collect,
51	   arg_counter
52    } type;
53    void *value;
54    const char *help;
55    const char *arg_help;
56};
57
58enum {
59    ARG_ERR_NO_MATCH  = 1,
60    ARG_ERR_BAD_ARG,
61    ARG_ERR_NO_ARG
62};
63
64typedef struct getarg_strings {
65    int num_strings;
66    char **strings;
67} getarg_strings;
68
69typedef int (*getarg_collect_func)(int short_opt,
70				   int argc,
71				   char **argv,
72				   int *optind,
73				   int *optarg,
74				   void *data);
75
76typedef struct getarg_collect_info {
77    getarg_collect_func func;
78    void *data;
79} getarg_collect_info;
80
81int getarg(struct getargs *args, size_t num_args,
82	   int argc, char **argv, int *optind);
83
84void arg_printusage (struct getargs *args,
85		     size_t num_args,
86		     const char *progname,
87		     const char *extra_string);
88
89void free_getarg_strings (getarg_strings *);
90
91#endif /* __GETARG_H__ */
92