opt.h
6.14 KB
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
/* opt.h -- general-purpose command line option parser
Copyright (C) 2016 Free Software Foundation, Inc.
GNU Mailutils is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 3, or (at
your option) any later version.
GNU Mailutils is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Mailutils. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _MAILUTILS_OPT_H
#define _MAILUTILS_OPT_H
#include <stdio.h>
#include <mailutils/types.h>
#include <mailutils/list.h>
#include <mailutils/util.h>
#include <mailutils/cctype.h>
extern char *mu_program_name;
extern char *mu_full_program_name;
void mu_set_program_name (char const *arg);
#define MU_OPTION_DEFAULT 0
#define MU_OPTION_ARG_OPTIONAL 0x01
#define MU_OPTION_HIDDEN 0x02
#define MU_OPTION_ALIAS 0x04
#define MU_OPTION_IMMEDIATE 0x08
struct mu_parseopt;
struct mu_option
{
char *opt_long; /* Long option name */
int opt_short; /* Short option character */
char *opt_arg; /* Argument name */
int opt_flags; /* Flags (see above) */
char *opt_doc; /* Human-readable documentation */
mu_c_type_t opt_type; /* Option type */
void *opt_ptr; /* Data pointer */
void (*opt_set) (struct mu_parseopt *, struct mu_option *, char const *);
/* Function to set the option */
};
#define MU_OPTION_GROUP(text) { NULL, 0, NULL, 0, text }
#define MU_OPTION_END { NULL, 0, NULL, 0, NULL }
#define MU_OPTION_IS_END(opt) \
(!(opt)->opt_long && !(opt)->opt_short && !(opt)->opt_doc)
#define MU_OPTION_IS_OPTION(opt) \
((opt)->opt_short || (opt)->opt_long)
#define MU_OPTION_IS_GROUP_HEADER(opt) \
(!MU_OPTION_IS_OPTION(opt) && (opt)->opt_doc)
#define MU_OPTION_IS_VALID_SHORT_OPTION(opt) \
((opt)->opt_short > 0 && (opt)->opt_short < 127 && \
(mu_isalnum ((opt)->opt_short) || ((opt)->opt_short == '?')))
#define MU_OPTION_IS_VALID_LONG_OPTION(opt) \
((opt)->opt_long != NULL)
typedef struct mu_option_cache *mu_option_cache_ptr_t;
struct mu_option_cache
{
struct mu_option *cache_opt;
char *cache_arg;
};
#define MU_PARSEOPT_DEFAULT 0
/* Don't ignore the first element of ARGV. By default it is the program
name */
#define MU_PARSEOPT_ARGV0 0x00000001
/* Ignore command line errors. */
#define MU_PARSEOPT_IGNORE_ERRORS 0x00000002
/* Don't order arguments so that options come first. */
#define MU_PARSEOPT_IN_ORDER 0x00000004
/* Don't provide standard options: -h, --help, --usage, --version */
#define MU_PARSEOPT_NO_STDOPT 0x00000008
/* Don't exit on errors */
#define MU_PARSEOPT_NO_ERREXIT 0x00000010
/* Apply all options immediately */
#define MU_PARSEOPT_IMMEDIATE 0x00000020
/* Don't sort options */
#define MU_PARSEOPT_NO_SORT 0x00001000
#define MU_PARSEOPT_PROG_NAME 0x00002000
#define MU_PARSEOPT_PROG_DOC 0x00004000
#define MU_PARSEOPT_PROG_ARGS 0x00008000
#define MU_PARSEOPT_BUG_ADDRESS 0x00010000
#define MU_PARSEOPT_PACKAGE_NAME 0x00020000
#define MU_PARSEOPT_PACKAGE_URL 0x00040000
#define MU_PARSEOPT_EXTRA_INFO 0x00080000
#define MU_PARSEOPT_EXIT_ERROR 0x00100000
#define MU_PARSEOPT_HELP_HOOK 0x00200000
#define MU_PARSEOPT_DATA 0x00400000
#define MU_PARSEOPT_VERSION_HOOK 0x00800000
/* Reuse mu_parseopt struct initialized previously */
#define MU_PARSEOPT_REUSE 0x80000000
/* Mask for immutable flag bits */
#define MU_PARSEOPT_IMMUTABLE_MASK 0xFFFFF000
struct mu_parseopt
{
/* Input data: */
int po_argc; /* Number of argiments */
char **po_argv; /* Array of arguments */
size_t po_optc; /* Number of elements in optv */
struct mu_option **po_optv; /* Array of ptrs to option structures */
int po_flags;
void *po_data; /* Call-specific data */
int po_exit_error; /* Exit on error with this code */
/* Informational: */
char const *po_prog_name;
char const *po_prog_doc;
char const *po_prog_args;
char const *po_bug_address;
char const *po_package_name;
char const *po_package_url;
char const *po_extra_info;
/* FIXME: should these take mu_stream_t ?*/
void (*po_help_hook) (struct mu_parseopt *po, FILE *stream);
void (*po_version_hook) (struct mu_parseopt *po, FILE *stream);
/* Output data */
int po_ind; /* Index of the next option */
int po_opterr; /* Index of the element in po_argv that
caused last error, or -1 if no errors */
mu_list_t po_optlist;
/* Auxiliary data */
char *po_cur; /* Points to the next character */
int po_chr; /* Single-char option */
/* The following two keep the position of the first non-optional argument
and the number of contiguous non-optional arguments after it.
Obviously, the following holds true:
arg_start + arg_count == opt_ind
If permutation is not allowed (MU_OPTION_PARSE_IN_ORDER flag is set),
arg_count is always 0.
*/
int po_arg_start;
int po_arg_count;
unsigned po_permuted:1; /* Whether the arguments were permuted */
};
int mu_parseopt (struct mu_parseopt *p,
int argc, char **argv, struct mu_option **optv,
int flags);
void mu_parseopt_error (struct mu_parseopt *po, char const *fmt, ...);
int mu_parseopt_apply (struct mu_parseopt *p);
void mu_parseopt_free (struct mu_parseopt *p);
unsigned mu_parseopt_getcolumn (const char *name);
void mu_parseopt_fmt_text (const char *text, size_t col);
void mu_option_describe_options (struct mu_option **optbuf, size_t optcnt);
void mu_program_help (struct mu_parseopt *p);
void mu_program_usage (struct mu_parseopt *p);
void mu_option_set_value (struct mu_parseopt *po, struct mu_option *opt,
char const *arg);
#endif