Cleanup: warning & whitespace
[blender.git] / source / blender / blenlib / intern / BLI_args.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenlib/intern/BLI_args.c
29  *  \ingroup bli
30  *  \brief A general argument parsing module
31  */
32
33 #include <ctype.h> /* for tolower */
34 #include <string.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_utildefines.h"
39 #include "BLI_listbase.h"
40 #include "BLI_string.h"
41 #include "BLI_args.h"
42 #include "BLI_ghash.h"
43
44 static char NO_DOCS[] = "NO DOCUMENTATION SPECIFIED";
45
46 struct bArgDoc;
47 typedef struct bArgDoc {
48         struct bArgDoc *next, *prev;
49         const char *short_arg;
50         const char *long_arg;
51         const char *documentation;
52         bool done;
53 } bArgDoc;
54
55 typedef struct bAKey {
56         const char *arg;
57         uintptr_t pass; /* cast easier */
58         int case_str; /* case specific or not */
59 } bAKey;
60
61 typedef struct bArgument {
62         bAKey *key;
63         BA_ArgCallback func;
64         void *data;
65         bArgDoc *doc;
66 } bArgument;
67
68 struct bArgs {
69         ListBase docs;
70         GHash  *items;
71         int argc;
72         const char  **argv;
73         int *passes;
74 };
75
76 static unsigned int case_strhash(const void *ptr)
77 {
78         const char *s = ptr;
79         unsigned int i = 0;
80         unsigned char c;
81
82         while ( (c = tolower(*s++)) )
83                 i = i * 37 + c;
84
85         return i;
86 }
87
88 static unsigned int keyhash(const void *ptr)
89 {
90         const bAKey *k = ptr;
91         return case_strhash(k->arg);  /* ^ BLI_ghashutil_inthash((void *)k->pass); */
92 }
93
94 static bool keycmp(const void *a, const void *b)
95 {
96         const bAKey *ka = a;
97         const bAKey *kb = b;
98         if (ka->pass == kb->pass || ka->pass == -1 || kb->pass == -1) { /* -1 is wildcard for pass */
99                 if (ka->case_str == 1 || kb->case_str == 1) {
100                         return (BLI_strcasecmp(ka->arg, kb->arg) != 0);
101                 }
102                 else {
103                         return (!STREQ(ka->arg, kb->arg));
104                 }
105         }
106         else {
107                 return BLI_ghashutil_intcmp((const void *)ka->pass, (const void *)kb->pass);
108         }
109 }
110
111 static bArgument *lookUp(struct bArgs *ba, const char *arg, int pass, int case_str)
112 {
113         bAKey key;
114
115         key.case_str = case_str;
116         key.pass = pass;
117         key.arg = arg;
118
119         return BLI_ghash_lookup(ba->items, &key);
120 }
121
122 bArgs *BLI_argsInit(int argc, const char **argv)
123 {
124         bArgs *ba = MEM_callocN(sizeof(bArgs), "bArgs");
125         ba->passes = MEM_callocN(sizeof(int) * argc, "bArgs passes");
126         ba->items = BLI_ghash_new(keyhash, keycmp, "bArgs passes gh");
127         BLI_listbase_clear(&ba->docs);
128         ba->argc = argc;
129         ba->argv = argv;
130
131         return ba;
132 }
133
134 void BLI_argsFree(struct bArgs *ba)
135 {
136         BLI_ghash_free(ba->items, MEM_freeN, MEM_freeN);
137         MEM_freeN(ba->passes);
138         BLI_freelistN(&ba->docs);
139         MEM_freeN(ba);
140 }
141
142 void BLI_argsPrint(struct bArgs *ba)
143 {
144         int i;
145         for (i = 0; i < ba->argc; i++) {
146                 printf("argv[%d] = %s\n", i, ba->argv[i]);
147         }
148 }
149
150 const char **BLI_argsArgv(struct bArgs *ba)
151 {
152         return ba->argv;
153 }
154
155 static bArgDoc *internalDocs(struct bArgs *ba, const char *short_arg, const char *long_arg, const char *doc)
156 {
157         bArgDoc *d;
158
159         d = MEM_callocN(sizeof(bArgDoc), "bArgDoc");
160
161         if (doc == NULL)
162                 doc = NO_DOCS;
163
164         d->short_arg = short_arg;
165         d->long_arg = long_arg;
166         d->documentation = doc;
167
168         BLI_addtail(&ba->docs, d);
169
170         return d;
171 }
172
173 static void internalAdd(struct bArgs *ba, const char *arg, int pass,
174                         int case_str, BA_ArgCallback cb, void *data, bArgDoc *d)
175 {
176         bArgument *a;
177         bAKey *key;
178
179         a = lookUp(ba, arg, pass, case_str);
180
181         if (a) {
182                 printf("WARNING: conflicting argument\n");
183                 printf("\ttrying to add '%s' on pass %i, %scase sensitive\n",
184                        arg, pass, case_str == 1 ? "not " : "");
185                 printf("\tconflict with '%s' on pass %i, %scase sensitive\n\n",
186                        a->key->arg, (int)a->key->pass, a->key->case_str == 1 ? "not " : "");
187         }
188
189         a = MEM_callocN(sizeof(bArgument), "bArgument");
190         key = MEM_callocN(sizeof(bAKey), "bAKey");
191
192         key->arg = arg;
193         key->pass = pass;
194         key->case_str = case_str;
195
196         a->key = key;
197         a->func = cb;
198         a->data = data;
199         a->doc = d;
200
201         BLI_ghash_insert(ba->items, key, a);
202 }
203
204 void BLI_argsAddCase(struct bArgs *ba, int pass,
205                      const char *short_arg, int short_case,
206                      const char *long_arg, int long_case,
207                      const char *doc, BA_ArgCallback cb, void *data)
208 {
209         bArgDoc *d = internalDocs(ba, short_arg, long_arg, doc);
210
211         if (short_arg)
212                 internalAdd(ba, short_arg, pass, short_case, cb, data, d);
213
214         if (long_arg)
215                 internalAdd(ba, long_arg, pass, long_case, cb, data, d);
216 }
217
218 void BLI_argsAdd(struct bArgs *ba, int pass,
219                  const char *short_arg, const char *long_arg,
220                  const char *doc, BA_ArgCallback cb, void *data)
221 {
222         BLI_argsAddCase(ba, pass, short_arg, 0, long_arg, 0, doc, cb, data);
223 }
224
225 static void internalDocPrint(bArgDoc *d)
226 {
227         if (d->short_arg && d->long_arg)
228                 printf("%s or %s", d->short_arg, d->long_arg);
229         else if (d->short_arg)
230                 printf("%s", d->short_arg);
231         else if (d->long_arg)
232                 printf("%s", d->long_arg);
233
234         printf(" %s\n\n", d->documentation);
235 }
236
237 void BLI_argsPrintArgDoc(struct bArgs *ba, const char *arg)
238 {
239         bArgument *a = lookUp(ba, arg, -1, -1);
240
241         if (a) {
242                 bArgDoc *d = a->doc;
243
244                 internalDocPrint(d);
245
246                 d->done = true;
247         }
248 }
249
250 void BLI_argsPrintOtherDoc(struct bArgs *ba)
251 {
252         bArgDoc *d;
253
254         for (d = ba->docs.first; d; d = d->next) {
255                 if (d->done == 0) {
256                         internalDocPrint(d);
257                 }
258         }
259 }
260
261 void BLI_argsParse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *default_data)
262 {
263         int i = 0;
264
265         for (i = 1; i < ba->argc; i++) {  /* skip argv[0] */
266                 if (ba->passes[i] == 0) {
267                         /* -1 signal what side of the comparison it is */
268                         bArgument *a = lookUp(ba, ba->argv[i], pass, -1);
269                         BA_ArgCallback func = NULL;
270                         void *data = NULL;
271
272                         if (a) {
273                                 func = a->func;
274                                 data = a->data;
275                         }
276                         else {
277                                 func = default_cb;
278                                 data = default_data;
279                         }
280
281                         if (func) {
282                                 int retval = func(ba->argc - i, ba->argv + i, data);
283
284                                 if (retval >= 0) {
285                                         int j;
286
287                                         /* use extra arguments */
288                                         for (j = 0; j <= retval; j++) {
289                                                 ba->passes[i + j] = pass;
290                                         }
291                                         i += retval;
292                                 }
293                                 else if (retval == -1) {
294                                         if (a) {
295                                                 if (a->key->pass != -1)
296                                                         ba->passes[i] = pass;
297                                         }
298                                         break;
299                                 }
300                         }
301                 }
302         }
303 }