Blender V5.3
BLI_args.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
9
10#include <cctype> /* for tolower */
11#include <cstdio>
12
13#include "MEM_guardedalloc.h"
14
15#include "BLI_args.hh"
16#include "BLI_ghash.hh"
17#include "BLI_listbase.hh"
18#include "BLI_string.hh"
19#include "BLI_utildefines.hh"
20
21namespace blender {
22
32#define USE_DUPLICATE_ARG_WORKAROUND
33
34static char NO_DOCS[] = "NO DOCUMENTATION SPECIFIED";
35
36struct bArgDoc;
37struct bArgDoc {
39 const char *short_arg;
40 const char *long_arg;
41 const char *documentation;
42 bool done;
43};
44
45struct bAKey {
46 const char *arg;
47 uintptr_t pass; /* cast easier */
48 int case_str; /* case specific or not */
49};
50
57
58struct bArgs {
59 ListBaseT<bArgDoc> docs;
61 int argc;
62 const char **argv;
63 int *passes;
67
70#ifdef USE_DUPLICATE_ARG_WORKAROUND
73#endif
74};
75
76static uint case_strhash(const void *ptr)
77{
78 const char *s = static_cast<const char *>(ptr);
79 uint i = 0;
80 uchar c;
81
82 while ((c = tolower(*s++))) {
83 i = i * 37 + c;
84 }
85
86 return i;
87}
88
89static uint keyhash(const void *ptr)
90{
91 const bAKey *k = static_cast<const bAKey *>(ptr);
92 return case_strhash(k->arg); /* ^ BLI_ghashutil_inthash((void *)k->pass); */
93}
94
95static bool keycmp(const void *a, const void *b)
96{
97 const bAKey *ka = static_cast<const bAKey *>(a);
98 const bAKey *kb = static_cast<const bAKey *>(b);
99 if (ka->pass == kb->pass || ka->pass == -1 || kb->pass == -1) { /* -1 is wildcard for pass */
100 if (ka->case_str == 1 || kb->case_str == 1) {
101 return (BLI_strcasecmp(ka->arg, kb->arg) != 0);
102 }
103 return !STREQ(ka->arg, kb->arg);
104 }
105 return BLI_ghashutil_intcmp(reinterpret_cast<const void *>(ka->pass),
106 reinterpret_cast<const void *>(kb->pass));
107}
108
109static bArgument *lookUp(bArgs *ba, const char *arg, int pass, int case_str)
110{
111 bAKey key;
112
113 key.case_str = case_str;
114 key.pass = pass;
115 key.arg = arg;
116
117 return static_cast<bArgument *>(BLI_ghash_lookup(ba->items, &key));
118}
119
122static void args_print_wrapper(void * /*user_data*/, const char *format, va_list args)
123{
124 vprintf(format, args);
125}
126
127bArgs *BLI_args_create(int argc, const char **argv)
128{
129 bArgs *ba = MEM_new_zeroed<bArgs>("bArgs");
130 ba->passes = MEM_new_array_zeroed<int>(argc, "bArgs passes");
131 ba->items = BLI_ghash_new(keyhash, keycmp, "bArgs passes gh");
132 ba->docs.clear_no_delete();
133 ba->argc = argc;
134 ba->argv = argv;
135
136 /* Must be initialized by #BLI_args_pass_set. */
137 ba->current_pass = 0;
138#ifdef USE_DUPLICATE_ARG_WORKAROUND
139 ba->pass_max = 0;
140#endif
141
143
144 return ba;
145}
146
148{
150 MEM_delete(ba->passes);
151 ba->docs.free_no_destruct();
152 MEM_delete(ba);
153}
154
155void BLI_args_printf(bArgs *ba, const char *format, ...)
156{
157 va_list args;
158 va_start(args, format);
159 ba->print_fn(ba->print_user_data, format, args);
160 va_end(args);
161}
162
163void BLI_args_print_fn_set(bArgs *ba, bArgPrintFn print_fn, void *user_data)
164{
165 ba->print_fn = print_fn;
166 ba->print_user_data = user_data;
167}
168
169void BLI_args_pass_set(bArgs *ba, int current_pass)
170{
171 BLI_assert((current_pass != 0) && (current_pass >= -1));
172 ba->current_pass = current_pass;
173
174#ifdef USE_DUPLICATE_ARG_WORKAROUND
175 ba->pass_max = std::max(ba->pass_max, current_pass);
176#endif
177}
178
179void BLI_args_print(const bArgs *ba)
180{
181 int i;
182 for (i = 0; i < ba->argc; i++) {
183 printf("argv[%d] = %s\n", i, ba->argv[i]);
184 }
185}
186
188 const char *short_arg,
189 const char *long_arg,
190 const char *doc)
191{
192 bArgDoc *d;
193
194 d = MEM_new_zeroed<bArgDoc>("bArgDoc");
195
196 if (doc == nullptr) {
197 doc = NO_DOCS;
198 }
199
200 d->short_arg = short_arg;
201 d->long_arg = long_arg;
202 d->documentation = doc;
203
204 BLI_addtail(&ba->docs, d);
205
206 return d;
207}
208
209static void internalAdd(
210 bArgs *ba, const char *arg, int case_str, BA_ArgCallback cb, void *data, bArgDoc *d)
211{
212 const int pass = ba->current_pass;
213 bArgument *a;
214 bAKey *key;
215
216 a = lookUp(ba, arg, pass, case_str);
217
218 if (a) {
219 printf("WARNING: conflicting argument\n");
220 printf("\ttrying to add '%s' on pass %i, %scase sensitive\n",
221 arg,
222 pass,
223 case_str == 1 ? "not " : "");
224 printf("\tconflict with '%s' on pass %i, %scase sensitive\n\n",
225 a->key->arg,
226 int(a->key->pass),
227 a->key->case_str == 1 ? "not " : "");
228 }
229
230 a = MEM_new_zeroed<bArgument>("bArgument");
231 key = MEM_new_zeroed<bAKey>("bAKey");
232
233 key->arg = arg;
234 key->pass = pass;
235 key->case_str = case_str;
236
237 a->key = key;
238 a->func = cb;
239 a->data = data;
240 a->doc = d;
241
242 BLI_ghash_insert(ba->items, key, a);
243}
244
246 const char *short_arg,
247 int short_case,
248 const char *long_arg,
249 int long_case,
250 const char *doc,
252 void *data)
253{
254 bArgDoc *d = internalDocs(ba, short_arg, long_arg, doc);
255
256 if (short_arg) {
257 internalAdd(ba, short_arg, short_case, cb, data, d);
258 }
259
260 if (long_arg) {
261 internalAdd(ba, long_arg, long_case, cb, data, d);
262 }
263}
264
266 const char *short_arg,
267 const char *long_arg,
268 const char *doc,
270 void *data)
271{
272 BLI_args_add_case(ba, short_arg, 0, long_arg, 0, doc, cb, data);
273}
274
275static void internalDocPrint(bArgs *ba, bArgDoc *d)
276{
277 if (d->short_arg && d->long_arg) {
278 BLI_args_printf(ba, "%s or %s", d->short_arg, d->long_arg);
279 }
280 else if (d->short_arg) {
281 BLI_args_printf(ba, "%s", d->short_arg);
282 }
283 else if (d->long_arg) {
284 BLI_args_printf(ba, "%s", d->long_arg);
285 }
286
287 BLI_args_printf(ba, " %s\n\n", d->documentation);
288}
289
290void BLI_args_print_arg_doc(bArgs *ba, const char *arg)
291{
292#ifdef USE_DUPLICATE_ARG_WORKAROUND
293 bArgument *a = nullptr;
294 /* Find the first argument which has not been printed. */
295 for (int pass = 0; pass <= ba->pass_max; pass++) {
296 a = lookUp(ba, arg, pass, -1);
297 if (a != nullptr) {
298 const bArgDoc *d = a->doc;
299 if (d->done == true) {
300 a = nullptr;
301 }
302 }
303 if (a) {
304 break;
305 }
306 }
307#else
308 bArgument *a = lookUp(ba, arg, -1, -1);
309#endif
310
311 if (a) {
312 bArgDoc *d = a->doc;
313
314 internalDocPrint(ba, d);
315
316 d->done = true;
317 }
318}
319
321{
322 for (bArgDoc &d : ba->docs) {
323 if (d.done == 0) {
324 internalDocPrint(ba, &d);
325 }
326 }
327}
328
330{
331 for (const bArgDoc &d : ba->docs) {
332 if (d.done == 0) {
333 return true;
334 }
335 }
336 return false;
337}
338
339void BLI_args_parse(bArgs *ba, int pass, BA_ArgCallback default_cb, void *default_data)
340{
341 BLI_assert((pass != 0) && (pass >= -1));
342 int i = 0;
343
344 for (i = 1; i < ba->argc; i++) { /* skip argv[0] */
345 if (ba->passes[i] == 0) {
346 /* -1 signal what side of the comparison it is */
347 bArgument *a = lookUp(ba, ba->argv[i], pass, -1);
348 BA_ArgCallback func = nullptr;
349 void *data = nullptr;
350
351 if (a) {
352 func = a->func;
353 data = a->data;
354 }
355 else {
356 func = default_cb;
357 data = default_data;
358 }
359
360 if (func) {
361 int retval = func(ba->argc - i, ba->argv + i, data);
362
363 if (retval >= 0) {
364 int j;
365
366 /* use extra arguments */
367 for (j = 0; j <= retval; j++) {
368 ba->passes[i + j] = pass;
369 }
370 i += retval;
371 }
372 else if (retval == -1) {
373 if (a) {
374 if (a->key->pass != -1) {
375 ba->passes[i] = pass;
376 }
377 }
378 break;
379 }
380 }
381 }
382 }
383}
384
385} // namespace blender
#define ATTR_PRINTF_FORMAT(format_param, dots_param)
A general argument parsing module.
Read Blender memory allocation and freeing.
#define STREQ(a, b)
BMesh Iterators.
void BLI_args_destroy(struct bArgs *ba)
Definition BLI_args.cc:147
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
int char char int BLI_strcasecmp(const char *s1, const char *s2) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1
static uint case_strhash(const void *ptr)
Definition BLI_args.cc:76
unsigned int uint
Definition BKE_text.h:55
void * BLI_ghash_lookup(const GHash *gh, const void *key) ATTR_WARN_UNUSED_RESULT
Definition BLI_ghash.cc:735
void MEM_delete_void(void *vmemh)
void BLI_ghash_insert(GHash *gh, void *key, void *val)
Definition BLI_ghash.cc:711
void BLI_args_add_case(struct bArgs *ba, const char *short_arg, int short_case, const char *long_arg, int long_case, const char *doc, BA_ArgCallback cb, void *data)
Definition BLI_args.cc:245
void BLI_args_print_other_doc(struct bArgs *ba)
Definition BLI_args.cc:320
static char NO_DOCS[]
Definition BLI_args.cc:34
static bArgDoc * internalDocs(bArgs *ba, const char *short_arg, const char *long_arg, const char *doc)
Definition BLI_args.cc:187
void * MEM_new_zeroed(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
unsigned char uchar
Definition BKE_text.h:58
static bool keycmp(const void *a, const void *b)
Definition BLI_args.cc:95
void BLI_ghash_free(GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp)
Definition BLI_ghash.cc:866
static void internalAdd(bArgs *ba, const char *arg, int case_str, BA_ArgCallback cb, void *data, bArgDoc *d)
Definition BLI_args.cc:209
BMesh const char void * data
bool BLI_ghashutil_intcmp(const void *a, const void *b)
void BLI_args_print_fn_set(struct bArgs *ba, ATTR_PRINTF_FORMAT(2, 0) bArgPrintFn print_fn, void *user_data)
void BLI_args_pass_set(struct bArgs *ba, int current_pass)
Definition BLI_args.cc:169
static void args_print_wrapper(void *, const char *format, va_list args)
Definition BLI_args.cc:122
void(*)(void *user_data, const char *format, va_list args) bArgPrintFn
Definition BLI_args.hh:31
bool BLI_args_has_other_doc(const struct bArgs *ba)
void BLI_args_printf(struct bArgs *ba, const char *format,...)
Definition BLI_args.cc:155
_W64 unsigned int uintptr_t
Definition BKE_text.h:120
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
void BLI_args_print_arg_doc(struct bArgs *ba, const char *arg)
Definition BLI_args.cc:290
static void internalDocPrint(bArgs *ba, bArgDoc *d)
Definition BLI_args.cc:275
void BLI_args_add(struct bArgs *ba, const char *short_arg, const char *long_arg, const char *doc, BA_ArgCallback cb, void *data)
Definition BLI_args.cc:265
GHash * BLI_ghash_new(GHashHashFP hashfp, GHashCmpFP cmpfp, const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
Definition BLI_ghash.cc:690
static uint keyhash(const void *ptr)
Definition BLI_args.cc:89
static bArgument * lookUp(bArgs *ba, const char *arg, int pass, int case_str)
Definition BLI_args.cc:109
struct bArgs * BLI_args_create(int argc, const char **argv)
Definition BLI_args.cc:127
void BLI_args_print(const struct bArgs *ba)
void * MEM_new_array_zeroed(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
int(*)(int argc, const char **argv, void *data) BA_ArgCallback
Definition BLI_args.hh:26
void BLI_args_parse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *default_data)
Definition BLI_args.cc:339
uintptr_t pass
Definition BLI_args.cc:47
const char * arg
Definition BLI_args.cc:46
const char * documentation
Definition BLI_args.cc:41
const char * short_arg
Definition BLI_args.cc:39
const char * long_arg
Definition BLI_args.cc:40
bArgDoc * next
Definition BLI_args.cc:38
bArgDoc * prev
Definition BLI_args.cc:38
GHash * items
Definition BLI_args.cc:60
ListBaseT< bArgDoc > docs
Definition BLI_args.cc:59
const char ** argv
Definition BLI_args.cc:62
void * print_user_data
Definition BLI_args.cc:66
bArgPrintFn print_fn
Definition BLI_args.cc:65
BA_ArgCallback func
Definition BLI_args.cc:53