d451d4a3262c638d8a930d73d0d2844ffa4882b6
[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__VERBOSE_ERRORS__OPTION_INFO__LONG_NAME "verbose-errors"
27 #define VSC_CLI__VERBOSE_ERRORS__OPTION_INFO \
28         { -1, VSC_CLI__VERBOSE_ERRORS__OPTION_INFO__LONG_NAME, \
29           "enable verbose error reporting", \
30           VSC_CLI__OPTION_TYPE__BOOL, FALSE }
31
32 #define VSC_CLI__NO_COLOR__OPTION_INFO__LONG_NAME "no-color"
33 #define VSC_CLI__NO_COLOR__OPTION_INFO \
34         { -1, VSC_CLI__NO_COLOR__OPTION_INFO__LONG_NAME, \
35           "disable output coloring", \
36           VSC_CLI__OPTION_TYPE__BOOL, FALSE }
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 int
43 vsc_cli_option_get_bool (const struct VscCliOption *option_list,
44                          const char *option_long_name);
45
46 int
47 vsc_cli_option_get_number (const struct VscCliOption *option_list,
48                            const char *option_long_name, int *found);
49
50 const char *
51 vsc_cli_option_get_string (const struct VscCliOption *option_list,
52                            const char *option_long_name);
53
54 void
55 vsc_cli_option_list_free (struct VscCliOption **option_list);
56
57 #ifdef __cplusplus
58 }
59 #endif
60
61 #endif /* __VSC_CLI__OPTION_H__ */