1d996f4d0ac92f41158361f54532e2faf30b8238
[vsc-common.git] / include / libvsccli / option.h
1 /*
2  * option.h: Library for interactive commandline interfaces
3  *
4  * Copyright (C) 2009 Matthias Bolte <matthias.bolte@googlemail.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library 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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
19  */
20
21 #ifndef __VSC_CLI__OPTION_H__
22 #define __VSC_CLI__OPTION_H__
23
24 #include "types.h"
25
26 #define VSC_CLI__NULL__OPTION_INFO { -1, NULL, NULL, 0, FALSE, FALSE }
27
28 #define VSC_CLI__VERBOSE_ERRORS__OPTION_INFO__LONG_NAME "verbose-errors"
29 #define VSC_CLI__VERBOSE_ERRORS__OPTION_INFO \
30         { -1, VSC_CLI__VERBOSE_ERRORS__OPTION_INFO__LONG_NAME, \
31           "Enable verbose error reporting", \
32           VSC_CLI__OPTION_TYPE__BOOLEAN, TRUE, FALSE }
33
34 #define VSC_CLI__NO_COLOR__OPTION_INFO__LONG_NAME "no-color"
35 #define VSC_CLI__NO_COLOR__OPTION_INFO \
36         { -1, VSC_CLI__NO_COLOR__OPTION_INFO__LONG_NAME, \
37           "Disable output coloring", \
38           VSC_CLI__OPTION_TYPE__BOOLEAN, TRUE, FALSE }
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 const struct VscCliOption *
45 vsc_cli_option_list_lookup (const struct VscCliOption *option_list,
46                             const char *option_long_name);
47
48 int
49 vsc_cli_option_list_lookup_boolean (const struct VscCliOption *option_list,
50                                     const char *option_long_name);
51
52 int
53 vsc_cli_option_list_lookup_number (const struct VscCliOption *option_list,
54                                    const char *option_long_name, int *found);
55
56 const char *
57 vsc_cli_option_list_lookup_string (const struct VscCliOption *option_list,
58                                    const char *option_long_name);
59
60 void
61 vsc_cli_option_list_free (struct VscCliOption **option_list);
62
63 #ifdef __cplusplus
64 }
65 #endif
66
67 #endif /* __VSC_CLI__OPTION_H__ */