doxygen: editor entry
[blender.git] / source / blender / blenlib / BLI_args.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BLI_ARGS_H
31 #define BLI_ARGS_H
32
33 /** \file BLI_args.h
34  *  \ingroup bli
35  *  \brief A general argument parsing module.
36  */
37
38 struct bArgs;
39 typedef struct bArgs bArgs;
40
41 /* returns the number of extra arguments consumed by the function. 0 is normal value, -1 stops parsing arguments, other negative indicates skip */
42 typedef int     (*BA_ArgCallback)(int argc, const char **argv, void *data);
43
44 struct bArgs *BLI_argsInit(int argc, const char **argv);
45 void BLI_argsFree(struct bArgs *ba);
46
47 /* pass starts at 1, -1 means valid all the time
48  * short_arg or long_arg can be null to specify no short or long versions
49  * */
50 void BLI_argsAdd(struct bArgs *ba, int pass, const char *short_arg, const char *long_arg, const char *doc, BA_ArgCallback cb, void *data);
51 /* short_case and long_case specify if those arguments are case specific */
52 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);
53
54 void BLI_argsParse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *data);
55
56 void BLI_argsPrintArgDoc(struct bArgs *ba, const char *arg);
57 void BLI_argsPrintOtherDoc(struct bArgs *ba);
58
59 void BLI_argsPrint(struct bArgs *ba);
60 const char **BLI_argsArgv(struct bArgs *ba);
61
62 #endif