Print warning for arguments not considered an option.
[gnupg.git] / common / argparse.h
1 /* argparse.h - Argument parser for option handling.
2  *      Copyright (C) 1998,1999,2000,2001,2006 Free Software Foundation, Inc.
3  *
4  * This file is part of JNLIB, which is a subsystem of GnuPG.
5  *
6  * JNLIB is free software; you can redistribute it and/or modify it
7  * under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * JNLIB is distributed in the hope that it will be useful, but
22  * WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * General Public License for more details.
25  *
26  * You should have received a copies of the GNU General Public License
27  * and the GNU Lesser General Public License along with this program;
28  * if not, see <http://www.gnu.org/licenses/>.
29  */
30
31 #ifndef LIBJNLIB_ARGPARSE_H
32 #define LIBJNLIB_ARGPARSE_H
33
34 #include <stdio.h>
35 #include "types.h"
36
37 typedef struct
38 {
39   int  *argc;         /* Pointer to ARGC (value subject to change). */
40   char ***argv;       /* Pointer to ARGV (value subject to change). */
41   unsigned int flags; /* Global flags.  May be set prior to calling the
42                          parser.  The parser may change the value.  */
43   int err;            /* Print error description for last option.
44                          Either 0,  ARGPARSE_PRINT_WARNING or
45                          ARGPARSE_PRINT_ERROR.  */
46
47   int r_opt;          /* Returns option code. */
48   int r_type;         /* Returns type of option value.  */
49   union {
50     int   ret_int;
51     long  ret_long;
52     unsigned long ret_ulong;
53     char *ret_str;
54   } r;                /* Return values */
55
56   struct {
57     int idx;
58     int inarg;
59     int stopped;
60     const char *last;
61     void *aliases;
62     const void *cur_alias;
63   } internal;       /* Private - do not change. */
64 } ARGPARSE_ARGS;
65
66 typedef struct
67 {
68   int          short_opt;
69   const char  *long_opt;
70   unsigned int flags;
71   const char  *description; /* Optional option description. */
72 } ARGPARSE_OPTS;
73
74
75 /* Global flags (ARGPARSE_ARGS).  */
76 #define ARGPARSE_FLAG_KEEP       1   /* Do not remove options form argv.     */
77 #define ARGPARSE_FLAG_ALL        2   /* Do not stop at last option but return
78                                         remaining args with R_OPT set to -1. */
79 #define ARGPARSE_FLAG_MIXED      4   /* Assume options and args are mixed.   */
80 #define ARGPARSE_FLAG_NOSTOP     8   /* Do not stop processing at "--".      */
81 #define ARGPARSE_FLAG_ARG0      16   /* Do not skip the first arg.           */
82 #define ARGPARSE_FLAG_ONEDASH   32   /* Allow long options with one dash.    */
83 #define ARGPARSE_FLAG_NOVERSION 64   /* No output for "--version".           */
84
85 #define ARGPARSE_FLAG_STOP_SEEN 256  /* Set to true if a "--" has been seen. */
86
87 /* Flags for each option (ARGPARSE_OPTS).  The type code may be
88    ORed with the OPT flags.  */
89 #define ARGPARSE_TYPE_NONE        0  /* Does not take an argument.        */
90 #define ARGPARSE_TYPE_INT         1  /* Takes an int argument.            */
91 #define ARGPARSE_TYPE_STRING      2  /* Takes a string argument.          */
92 #define ARGPARSE_TYPE_LONG        3  /* Takes a long argument.            */
93 #define ARGPARSE_TYPE_ULONG       4  /* Takes an unsigned long argument.  */
94 #define ARGPARSE_OPT_OPTIONAL (1<<3) /* Argument is optional.             */
95 #define ARGPARSE_OPT_PREFIX   (1<<4) /* Allow 0x etc. prefixed values.    */
96 #define ARGPARSE_OPT_COMMAND  (1<<8) /* The argument is a command.        */
97
98 /* A set of macros to make option definitions easier to read.  */
99 #define ARGPARSE_x(s,l,t,f,d) \
100      { (s), (l), ARGPARSE_TYPE_ ## t | (f), (d) }
101
102 #define ARGPARSE_s(s,l,t,d) \
103      { (s), (l), ARGPARSE_TYPE_ ## t, (d) }
104 #define ARGPARSE_s_n(s,l,d) \
105      { (s), (l), ARGPARSE_TYPE_NONE, (d) }
106 #define ARGPARSE_s_i(s,l,d) \
107      { (s), (l), ARGPARSE_TYPE_INT, (d) }
108 #define ARGPARSE_s_s(s,l,d) \
109      { (s), (l), ARGPARSE_TYPE_STRING, (d) }
110 #define ARGPARSE_s_l(s,l,d) \
111      { (s), (l), ARGPARSE_TYPE_LONG, (d) }
112 #define ARGPARSE_s_u(s,l,d) \
113      { (s), (l), ARGPARSE_TYPE_ULONG, (d) }
114
115 #define ARGPARSE_o(s,l,t,d) \
116      { (s), (l), (ARGPARSE_TYPE_ ## t  | ARGPARSE_OPT_OPTIONAL), (d) }
117 #define ARGPARSE_o_n(s,l,d) \
118      { (s), (l), (ARGPARSE_TYPE_NONE   | ARGPARSE_OPT_OPTIONAL), (d) }
119 #define ARGPARSE_o_i(s,l,d) \
120      { (s), (l), (ARGPARSE_TYPE_INT    | ARGPARSE_OPT_OPTIONAL), (d) }
121 #define ARGPARSE_o_s(s,l,d) \
122      { (s), (l), (ARGPARSE_TYPE_STRING | ARGPARSE_OPT_OPTIONAL), (d) }
123 #define ARGPARSE_o_l(s,l,d) \
124      { (s), (l), (ARGPARSE_TYPE_LONG   | ARGPARSE_OPT_OPTIONAL), (d) }
125 #define ARGPARSE_o_u(s,l,d) \
126      { (s), (l), (ARGPARSE_TYPE_ULONG  | ARGPARSE_OPT_OPTIONAL), (d) }
127
128 #define ARGPARSE_p(s,l,t,d) \
129      { (s), (l), (ARGPARSE_TYPE_ ## t  | ARGPARSE_OPT_PREFIX), (d) }
130 #define ARGPARSE_p_n(s,l,d) \
131      { (s), (l), (ARGPARSE_TYPE_NONE   | ARGPARSE_OPT_PREFIX), (d) }
132 #define ARGPARSE_p_i(s,l,d) \
133      { (s), (l), (ARGPARSE_TYPE_INT    | ARGPARSE_OPT_PREFIX), (d) }
134 #define ARGPARSE_p_s(s,l,d) \
135      { (s), (l), (ARGPARSE_TYPE_STRING | ARGPARSE_OPT_PREFIX), (d) }
136 #define ARGPARSE_p_l(s,l,d) \
137      { (s), (l), (ARGPARSE_TYPE_LONG   | ARGPARSE_OPT_PREFIX), (d) }
138 #define ARGPARSE_p_u(s,l,d) \
139      { (s), (l), (ARGPARSE_TYPE_ULONG  | ARGPARSE_OPT_PREFIX), (d) }
140
141 #define ARGPARSE_op(s,l,t,d) \
142      { (s), (l), (ARGPARSE_TYPE_ ## t \
143                   | ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
144 #define ARGPARSE_op_n(s,l,d) \
145      { (s), (l), (ARGPARSE_TYPE_NONE \
146                   | ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
147 #define ARGPARSE_op_i(s,l,d) \
148      { (s), (l), (ARGPARSE_TYPE_INT \
149                   | ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
150 #define ARGPARSE_op_s(s,l,d) \
151      { (s), (l), (ARGPARSE_TYPE_STRING \
152                   | ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
153 #define ARGPARSE_op_l(s,l,d) \
154      { (s), (l), (ARGPARSE_TYPE_LONG \
155                   | ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
156 #define ARGPARSE_op_u(s,l,d) \
157      { (s), (l), (ARGPARSE_TYPE_ULONG \
158                   | ARGPARSE_OPT_OPTIONAL | ARGPARSE_OPT_PREFIX), (d) }
159
160 #define ARGPARSE_c(s,l,d) \
161      { (s), (l), (ARGPARSE_TYPE_NONE | ARGPARSE_OPT_COMMAND), (d) }
162
163
164 #define ARGPARSE_group(s,d) \
165      { (s), NULL, 0, (d) }
166
167 #define ARGPARSE_end()  { 0, NULL, 0, NULL }
168
169
170 /* Other constants.  */
171 #define ARGPARSE_PRINT_WARNING  1
172 #define ARGPARSE_PRINT_ERROR    2
173
174
175 /* Error values.  */
176 #define ARGPARSE_IS_ARG            (-1)
177 #define ARGPARSE_INVALID_OPTION    (-2)
178 #define ARGPARSE_MISSING_ARG       (-3)
179 #define ARGPARSE_KEYWORD_TOO_LONG  (-4)
180 #define ARGPARSE_READ_ERROR        (-5)
181 #define ARGPARSE_UNEXPECTED_ARG    (-6)
182 #define ARGPARSE_INVALID_COMMAND   (-7)
183 #define ARGPARSE_AMBIGUOUS_OPTION  (-8)
184 #define ARGPARSE_AMBIGUOUS_COMMAND (-9)
185 #define ARGPARSE_INVALID_ALIAS     (-10)
186 #define ARGPARSE_OUT_OF_CORE       (-11)
187
188
189 int arg_parse( ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
190 int optfile_parse( FILE *fp, const char *filename, unsigned *lineno,
191                    ARGPARSE_ARGS *arg, ARGPARSE_OPTS *opts);
192 void usage( int level );
193 const char *strusage( int level );
194 void set_strusage( const char *(*f)( int ) );
195 void argparse_register_outfnc (int (*fnc)(int, const char *));
196
197 #endif /*LIBJNLIB_ARGPARSE_H*/