Fix syntax for ID keyword.
[blender-staging.git] / source / blender / blenlib / BLI_args.h
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 #ifndef BLI_ARGS_H
33 #define BLI_ARGS_H
34
35 struct bArgs;
36 typedef struct bArgs bArgs;
37
38 /* returns the number of extra arguments consumed by the function. 0 is normal value, -1 stops parsing arguments, other negative indicates skip */
39 typedef int     (*BA_ArgCallback)(int argc, char **argv, void *data);
40
41 struct bArgs *BLI_argsInit(int argc, char **argv);
42 void BLI_argsFree(struct bArgs *ba);
43
44 /* pass starts at 1, -1 means valid all the time */
45 void BLI_argsAdd(struct bArgs *ba, char *arg, int pass, BA_ArgCallback cb, void *data);
46 void BLI_argsAddCase(struct bArgs *ba, char *arg, int pass, BA_ArgCallback cb, void *data); /* not case specific */
47
48 void BLI_argsParse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *data);
49
50 void BLI_argsPrint(struct bArgs *ba);
51 char **BLI_argsArgv(struct bArgs *ba);
52
53 #endif