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