style cleanup
[blender.git] / source / blender / blenlib / BLI_args.h
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 #ifndef __BLI_ARGS_H__
29 #define __BLI_ARGS_H__
30
31 /** \file BLI_args.h
32  *  \ingroup bli
33  *  \brief A general argument parsing module.
34  */
35
36 struct bArgs;
37 typedef struct bArgs bArgs;
38
39 /* returns the number of extra arguments consumed by the function. 0 is normal value, -1 stops parsing arguments, other negative indicates skip */
40 typedef int (*BA_ArgCallback)(int argc, const char **argv, void *data);
41
42 struct bArgs *BLI_argsInit(int argc, const char **argv);
43 void BLI_argsFree(struct bArgs *ba);
44
45 /* pass starts at 1, -1 means valid all the time
46  * short_arg or long_arg can be null to specify no short or long versions
47  * */
48 void BLI_argsAdd(struct bArgs *ba, int pass, const char *short_arg, const char *long_arg, const char *doc, BA_ArgCallback cb, void *data);
49 /* short_case and long_case specify if those arguments are case specific */
50 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);
51
52 void BLI_argsParse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *data);
53
54 void BLI_argsPrintArgDoc(struct bArgs *ba, const char *arg);
55 void BLI_argsPrintOtherDoc(struct bArgs *ba);
56
57 void BLI_argsPrint(struct bArgs *ba);
58 const char **BLI_argsArgv(struct bArgs *ba);
59
60 #endif