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