menuselect: Add menuselect to Asterisk trunk (Patch 1)
[asterisk/asterisk.git] / menuselect / menuselect.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005-2006, Russell Bryant
5  *
6  * Russell Bryant <russell@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  *
22  * \brief public data structures and defaults for menuselect
23  *
24  */
25
26 #ifndef MENUSELECT_H
27 #define MENUSELECT_H
28
29 #include "linkedlists.h"
30
31 #define OUTPUT_MAKEOPTS_DEFAULT "menuselect.makeopts"
32 #define OUTPUT_MAKEDEPS_DEFAULT "menuselect.makedeps"
33 #define MENUSELECT_DEPS         "build_tools/menuselect-deps"
34
35 struct member;
36
37 struct reference {
38         /*! the name of the dependency */
39         const char *name;
40         /*! the display name of the dependency */
41         const char *displayname;
42         /*! if this dependency is a member, not an external object */
43         struct member *member;
44         /*! if this package was found */
45         unsigned char met:1;
46         /*! for linking */
47         AST_LIST_ENTRY(reference) list;
48 };
49
50 enum failure_types {
51         NO_FAILURE = 0,
52         SOFT_FAILURE = 1,
53         HARD_FAILURE = 2,
54 };
55
56 struct member {
57         /*! What will be sent to the makeopts file */
58         const char *name;
59         /*! Display name if known */
60         const char *displayname;
61         /*! Default setting */
62         const char *defaultenabled;
63         /*! Delete these file(s) if this member changes */
64         const char *remove_on_change;
65         /*! Touch these file(s) if this member changes */
66         const char *touch_on_change;
67         const char *support_level;
68         const char *replacement;
69         /*! This module is currently selected */
70         unsigned int enabled:1;
71         /*! This module was enabled when the config was loaded */
72         unsigned int was_enabled:1;
73         /*! This module has failed dependencies */
74         unsigned int depsfailed:2;
75         /*! This module has failed conflicts */
76         unsigned int conflictsfailed:2;
77         /*! This module's 'enabled' flag was changed by a default only */
78         unsigned int was_defaulted:1;
79         /*! This module is a dependency, and if it is selected then
80           we have included it in the MENUSELECT_BUILD_DEPS line
81           in the output file */
82         unsigned int build_deps_output:1;
83         /*! This module should never be enabled automatically, but only
84          * when explicitly set. */
85         unsigned int explicitly_enabled_only:1;
86         /*! This isn't actually a module!  It's a separator, and it should
87          * be passed over for many of the usual purposes associated with members. */
88         unsigned int is_separator:1;
89         /*! dependencies of this module */
90         AST_LIST_HEAD_NOLOCK(, reference) deps;
91         /*! conflicts of this module */
92         AST_LIST_HEAD_NOLOCK(, reference) conflicts;
93         /*! optional packages used by this module */
94         AST_LIST_HEAD_NOLOCK(, reference) uses;
95         /*! for making a list of modules */
96         AST_LIST_ENTRY(member) list;
97 };
98
99 enum support_level_values {
100         SUPPORT_CORE = 0,
101         SUPPORT_EXTENDED = 1,
102         SUPPORT_DEPRECATED = 2,
103         SUPPORT_UNSPECIFIED = 3,
104         SUPPORT_COUNT = 4, /* Keep this item at the end of the list. Tracks total number of support levels. */
105 };
106
107 struct category {
108         struct member *separators[SUPPORT_COUNT];
109         /*! the Makefile variable */
110         const char *name;
111         /*! the name displayed in the menu */
112         const char *displayname;
113         /*! Delete these file(s) if anything in this category changes */
114         const char *remove_on_change;
115         /*! Touch these file(s) if anything in this category changes */
116         const char *touch_on_change;
117         /*! Output what is selected, as opposed to not selected */
118         unsigned int positive_output:1;
119         /*! All choices in this category are mutually exclusive */
120         unsigned int exclusive:1;
121         /*! the list of possible values to be set in this variable */
122         AST_LIST_HEAD_NOLOCK(, member) members;
123         /*! for linking */
124         AST_LIST_ENTRY(category) list;
125 };
126
127 extern AST_LIST_HEAD_NOLOCK(categories, category) categories;
128
129 extern const char *menu_name;
130
131 /*! This is implemented by the frontend */
132 int run_menu(void);
133
134 int count_categories(void);
135
136 int count_members(struct category *cat);
137
138 /*! \brief Toggle a member of a category at the specified index to enabled/disabled */
139 void toggle_enabled_index(struct category *cat, int index);
140
141 void toggle_enabled(struct member *mem);
142
143 /*! \brief Set a member of a category at the specified index to enabled */
144 void set_enabled(struct category *cat, int index);
145 /*! \brief Set a member of a category at the specified index to not enabled */
146 void clear_enabled(struct category *cat, int index);
147
148 /*! \brief Enable/Disable all members of a category as long as dependencies have been met and no conflicts are found */
149 void set_all(struct category *cat, int val);
150
151 /*! \brief returns non-zero if the string is not defined, or has zero length */
152 static inline int strlen_zero(const char *s)
153 {
154         return (!s || (*s == '\0'));
155 }
156
157 #endif /* MENUSELECT_H */