[cli] Combine the tagged and required fields of the option info struct.
[vsc-common.git] / include / libvsccli / types.h
1 /*
2  * types.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__TYPES_H__
22 #define __VSC_CLI__TYPES_H__
23
24 #include <libvscmisc/types.h>
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 enum VscCliOptionType {
31         VSC_CLI__OPTION_TYPE__UNDEFINED = 0,
32         VSC_CLI__OPTION_TYPE__BOOLEAN,
33         VSC_CLI__OPTION_TYPE__NUMBER,
34         VSC_CLI__OPTION_TYPE__STRING,
35 };
36
37 enum VscCliOptionFlag {
38         VSC_CLI__OPTION_FLAG__NONE = 0,
39         VSC_CLI__OPTION_FLAG__TAGGED = 1,
40         VSC_CLI__OPTION_FLAG__REQUIRED = 2,
41 };
42
43 struct VscCliOption;
44 struct VscCliCommandInfo;
45
46 typedef void (*VscCliCommandFunction) (struct VscError *error,
47                                        const struct VscCliCommandInfo *command_info,
48                                        const struct VscCliOption *option_list,
49                                        void *user_data);
50
51 typedef void (*VscCliErrorFunction) (struct VscError *error,
52                                      void *user_data);
53
54 typedef void (*VscCliPromptFunction) (struct VscError *error, char *prompt,
55                                       size_t size, void *user_data);
56
57 struct VscCliOptionInfo {
58         const char short_name;
59         const char* long_name;
60         const char* help;
61         enum VscCliOptionType type;
62         int flags;
63 };
64
65 struct VscCliOption {
66         struct VscCliOption *next;
67         const struct VscCliOptionInfo *info;
68         int number;
69         char* string;
70 };
71
72 struct VscCliCommandInfo {
73         const char* name;
74         const char* help;
75         const char* description;
76         VscCliCommandFunction function;
77         const struct VscCliOptionInfo *option_infos;
78 };
79
80 struct VscCliCommand {
81         struct VscCliCommand *next;
82         const struct VscCliCommandInfo *info;
83         struct VscCliOption *option_list;
84 };
85
86 #ifdef __cplusplus
87 }
88 #endif
89
90 #endif /* __VSC_CLI__TYPES_H__ */