Merged changes in the trunk up to revision 45619.
[blender.git] / source / blender / blenlib / intern / BLI_args.c
1 /*
2  * A general argument parsing module
3  *
4  *
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): none yet.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30
31 /** \file blender/blenlib/intern/BLI_args.c
32  *  \ingroup bli
33  */
34
35
36 #include <ctype.h> /* for tolower */
37 #include <string.h>
38
39 #include "MEM_guardedalloc.h"
40
41 #include "BLI_utildefines.h"
42 #include "BLI_listbase.h"
43 #include "BLI_string.h"
44 #include "BLI_args.h"
45 #include "BLI_ghash.h"
46
47 static char NO_DOCS[] = "NO DOCUMENTATION SPECIFIED";
48
49 struct bArgDoc;
50 typedef struct bArgDoc {
51         struct bArgDoc *next, *prev;
52         const char *short_arg;
53         const char *long_arg;
54         const char *documentation;
55         int  done;
56 } bArgDoc;
57
58 typedef struct bAKey {
59         const char *arg;
60         uintptr_t pass; /* cast easier */
61         int case_str; /* case specific or not */
62 } bAKey;
63
64 typedef struct bArgument {
65         bAKey *key;
66         BA_ArgCallback func;
67         void *data;
68         bArgDoc *doc;
69 } bArgument;
70
71 struct bArgs {
72         ListBase docs;
73         GHash  *items;
74         int     argc;
75         const char  **argv;
76         int       *passes;
77 };
78
79 static unsigned int case_strhash(const void *ptr)
80 {
81         const char *s= ptr;
82         unsigned int i= 0;
83         unsigned char c;
84
85         while ( (c= tolower(*s++)) )
86                 i= i*37 + c;
87
88         return i;
89 }
90
91 static unsigned int     keyhash(const void *ptr)
92 {
93         const bAKey *k = ptr;
94         return case_strhash(k->arg); // ^ BLI_ghashutil_inthash((void*)k->pass);
95 }
96
97 static int keycmp(const void *a, const void *b)
98 {
99         const bAKey *ka = a;
100         const bAKey *kb = b;
101         if (ka->pass == kb->pass || ka->pass == -1 || kb->pass == -1) { /* -1 is wildcard for pass */
102                 if (ka->case_str == 1 || kb->case_str == 1)
103                         return BLI_strcasecmp(ka->arg, kb->arg);
104                 else
105                         return strcmp(ka->arg, kb->arg);
106         }
107         else {
108                 return BLI_ghashutil_intcmp((const void*)ka->pass, (const void*)kb->pass);
109         }
110 }
111
112 static bArgument *lookUp(struct bArgs *ba, const char *arg, int pass, int case_str)
113 {
114         bAKey key;
115
116         key.case_str = case_str;
117         key.pass = pass;
118         key.arg = arg;
119
120         return BLI_ghash_lookup(ba->items, &key);
121 }
122
123 bArgs *BLI_argsInit(int argc, const char **argv)
124 {
125         bArgs *ba = MEM_callocN(sizeof(bArgs), "bArgs");
126         ba->passes = MEM_callocN(sizeof(int) * argc, "bArgs passes");
127         ba->items = BLI_ghash_new(keyhash, keycmp, "bArgs passes gh");
128         ba->docs.first = ba->docs.last = NULL;
129         ba->argc = argc;
130         ba->argv = argv;
131
132         return ba;
133 }
134
135 static void freeItem(void *val)
136 {
137         MEM_freeN(val);
138 }
139
140 void BLI_argsFree(struct bArgs *ba)
141 {
142         BLI_ghash_free(ba->items, freeItem, freeItem);
143         MEM_freeN(ba->passes);
144         BLI_freelistN(&ba->docs);
145         MEM_freeN(ba);
146 }
147
148 void BLI_argsPrint(struct bArgs *ba)
149 {
150         int i;
151         for (i = 0; i < ba->argc; i++) {
152                 printf("argv[%d] = %s\n", i, ba->argv[i]);
153         }
154 }
155
156 const char **BLI_argsArgv(struct bArgs *ba)
157 {
158         return ba->argv;
159 }
160
161 static bArgDoc *internalDocs(struct bArgs *ba, const char *short_arg, const char *long_arg, const char *doc)
162 {
163         bArgDoc *d;
164
165         d = MEM_callocN(sizeof(bArgDoc), "bArgDoc");
166
167         if (doc == NULL)
168                 doc = NO_DOCS;
169
170         d->short_arg = short_arg;
171         d->long_arg = long_arg;
172         d->documentation = doc;
173
174         BLI_addtail(&ba->docs, d);
175
176         return d;
177 }
178
179 static void internalAdd(struct bArgs *ba, const char *arg, int pass, int case_str, BA_ArgCallback cb, void *data, bArgDoc *d)
180 {
181         bArgument *a;
182         bAKey *key;
183
184         a = lookUp(ba, arg, pass, case_str);
185
186         if (a) {
187                 printf("WARNING: conflicting argument\n");
188                 printf("\ttrying to add '%s' on pass %i, %scase sensitive\n", arg, pass, case_str == 1? "not ": "");
189                 printf("\tconflict with '%s' on pass %i, %scase sensitive\n\n", a->key->arg, (int)a->key->pass, a->key->case_str == 1? "not ": "");
190         }
191
192         a = MEM_callocN(sizeof(bArgument), "bArgument");
193         key = MEM_callocN(sizeof(bAKey), "bAKey");
194
195         key->arg = arg;
196         key->pass = pass;
197         key->case_str = case_str;
198
199         a->key = key;
200         a->func = cb;
201         a->data = data;
202         a->doc = d;
203
204         BLI_ghash_insert(ba->items, key, a);
205 }
206
207 void BLI_argsAddCase(struct bArgs *ba, int pass, const char *short_arg, int short_case, const char *long_arg, int long_case, 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 }
219
220 void BLI_argsAdd(struct bArgs *ba, int pass, const char *short_arg, const char *long_arg, 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 = 1;
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 }