1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*/
#pragma once
/** \file
* \ingroup bli
* \brief A general argument parsing module.
*/
#ifdef __cplusplus
extern "C" {
#endif
struct bArgs;
typedef struct bArgs bArgs;
/**
* Returns the number of extra arguments consumed by the function.
* - 0 is normal value,
* - -1 stops parsing arguments, other negative indicates skip
*/
typedef int (*BA_ArgCallback)(int argc, const char **argv, void *data);
struct bArgs *BLI_args_create(int argc, const char **argv);
void BLI_args_destroy(struct bArgs *ba);
/** The pass to use for #BLI_args_add. */
void BLI_args_pass_set(struct bArgs *ba, int current_pass);
/**
* Pass starts at 1, -1 means valid all the time
* short_arg or long_arg can be null to specify no short or long versions
*/
void BLI_args_add(struct bArgs *ba,
const char *short_arg,
const char *long_arg,
const char *doc,
BA_ArgCallback cb,
void *data);
/**
* Short_case and long_case specify if those arguments are case specific
*/
void BLI_args_add_case(struct bArgs *ba,
const char *short_arg,
int short_case,
const char *long_arg,
int long_case,
const char *doc,
BA_ArgCallback cb,
void *data);
void BLI_args_parse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *data);
void BLI_args_print_arg_doc(struct bArgs *ba, const char *arg);
void BLI_args_print_other_doc(struct bArgs *ba);
bool BLI_args_has_other_doc(const struct bArgs *ba);
void BLI_args_print(struct bArgs *ba);
#ifdef __cplusplus
}
#endif
|
