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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/**
* argparser – command line argument parser library
*
* Copyright © 2013, 2014 Mattias Andrée (maandree@member.fsf.org)
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include "argparser.h"
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <errno.h>
#define xfree(s) (free(s), s = NULL)
/**
* Initialise an argument parser
*
* @param parser The memory address of the parser to initialise
* @return Zero on success, -1 on error, `errno` will be set accordingly
*/
int args_initialise(args_parser_t* parser)
{
parser->state->arguments = NULL;
parser->state->files = NULL;
parser->state->message = NULL;
parser->state->options = NULL;
parser->state->all_options = NULL;
parser->state->freequeue = NULL;
parser->state->arguments_count = 0;
parser->state->unrecognised_count = 0;
parser->state->files_count = 0;
parser->state->options_count = 0;
parser->state->all_options_count = 0;
parser->state->freeptr = 0;
parser->settings->linuxvt = getenv("TERM") ? !strcmp(getenv("TERM"), "linux") : 0;
parser->settings->alternative = 0;
parser->settings->stop_at_first_file = 0;
parser->settings->use_colours = AUTO;
parser->settings->program = NULL;
parser->settings->description = NULL;
parser->settings->usage = NULL;
parser->settings->longdescription = NULL;
parser->settings->error_out = stderr;
parser->settings->warning_out = stderr;
parser->settings->help_out = stderr;
parser->settings->abbreviations = args_standard_abbreviations;
if ((parser->state->arguments = malloc(1 * sizeof(char*))) == NULL) goto fail;
if ((parser->state->files = malloc(1 * sizeof(char*))) == NULL) goto fail;
if ((parser->state->options = malloc(1 * sizeof(args_option_t))) == NULL) goto fail;
if ((parser->state->all_options = malloc(1 * sizeof(char*))) == NULL) goto fail;
if ((parser->state->freequeue = malloc(1 * sizeof(void*))) == NULL) goto fail;
return 0;
fail:
xfree(parser->state->arguments);
xfree(parser->state->files);
xfree(parser->state->options);
xfree(parser->state->all_options);
xfree(parser->state->freequeue);
return -1;
}
/**
* Disposes of all resources, run this when you are done
*
* @param parser The parser
*/
void args_dispose(parser_t* parser)
{
size_t i;
parser->state->arguments_count = 0;
parser->state->unrecognised_count = 0;
parser->state->files_count = 0;
parser->state->all_options_count = 0;
xfree(parser->settings->program);
xfree(parser->state->arguments);
xfree(parser->state->message);
xfree(parser->state->files);
for (i = 0; i < parser->state->options_count; i++)
free(parser->state->options[i].alternatives);
parser->state->options_count = 0;
xfree(parser->state->options);
xfree(parser->state->all_options);
xfree(parser->state->all_options_standard);
for (i = 0; i < parser->state->freeptr; i++)
free(parser->state->freequeue[i]);
parser->state->freeptr = 0;
xfree(parser->state->freequeue);
}
/**
* Checks the correctness of the number of used non-option arguments
*
* @param parser The parser
* @param min The minimum number of files
* @return Whether the usage was correct
*/
int args_test_files_min(args_parser_t* restrictparser, size_t min)
{
return min <= parser->state->files_count;
}
/**
* Checks the correctness of the number of used non-option arguments
*
* @param parser The parser
* @param max The maximum number of files
* @return Whether the usage was correct
*/
int args_test_files_max(args_parser_t* parser, size_t max)
{
return parser->state->files_count <= max;
}
/**
* Checks the correctness of the number of used non-option arguments
*
* @param parser The parser
* @param min The minimum number of files
* @param max The maximum number of files
* @return Whether the usage was correct
*/
int args_test_files(args_parser_t* parser, size_t min, size_t max)
{
return (min <= parser->state->files_count) && (parser->state->files_count <= max);
}
/**
* Dummy trigger
*
* @param user_data User-data
* @param used The used option alternative
* @param standard The standard option alternative
*/
void args_noop_trigger(void* user_data, const char* used, const char* standard)
{
(void) user_data;
(void) used;
(void) standard;
}
/**
* Dummy trigger
*
* @param user_data User-data
* @param used The used option alternative
* @param standard The standard option alternative
* @param value The used value
*/
void args_noop_trigger_v(void* user_data, const char* used, const char* standard, char* value)
{
(void) user_data;
(void) used;
(void) standard;
(void) value;
}
/**
* Stickless evaluator to always evaluates to false
*
* @param user_data User-data
* @param argument The next argument
* @return Whether the argument can be used without being sticky
*/
int args_no_stickless(void* user_data, const char* value)
{
(void) user_data;
(void) value;
return 0;
}
/**
* Default stickless evaluator
*
* @param user_data User-data
* @param argument The next argument
* @return Whether the argument can be used without being sticky
*/
int args_default_stickless(void* user_data, const char* argument)
{
(void) user_data;
return (argument[0] != '-') && (argument[0] != '+');
}
/**
* Evalutator for end argument of variadic options that always evalutes to false
*
* @param user_data User-data
* @param value The next argument
* @return Whether the argument can be used without being sticky
*/
int args_no_variadic_end(void* user_data, char* value)
{
(void) user_data;
(void) value;
return 0;
}
/**
* The standard abbrevation expander
*
* @param argument The option that not recognised
* @param options All recognised options
* @param standards The corresponding standard option for options in `options`
* @param count The number of elements in `options` and `standards`
* @return The only possible expansion, otherwise `NULL`
*/
const char* args_standard_abbreviations(const char* argument, const char** options, const char** standards, size_t count)
{
const char* found = NULL;
size_t i;
for (i = 0; i < count; i++)
if (strstr(options[i], argument) == options[i])
{
if (found == NULL)
found = standards[i];
else if (found != standards[i])
return NULL;
}
return found;
}
|
