logger.conf.sample: add missing comment mark
[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         /*! if this package should be autoselected */
47         unsigned char autoselect:1;
48         /*! for linking */
49         AST_LIST_ENTRY(reference) list;
50 };
51
52 enum failure_types {
53         NO_FAILURE = 0,
54         SOFT_FAILURE = 1,
55         HARD_FAILURE = 2,
56 };
57
58 AST_LIST_HEAD_NOLOCK(reference_list, reference);
59
60 struct member {
61         /*! What will be sent to the makeopts file */
62         const char *name;
63         /*! Display name if known */
64         const char *displayname;
65         /*! Default setting */
66         const char *defaultenabled;
67         /*! Delete these file(s) if this member changes */
68         const char *remove_on_change;
69         /*! Touch these file(s) if this member changes */
70         const char *touch_on_change;
71         const char *support_level;
72         const char *replacement;
73         /*! member_data is just an opaque, member-specific string */
74         const char *member_data;
75         /*! This module is currently selected */
76         unsigned int enabled:1;
77         /*! This module was enabled when the config was loaded */
78         unsigned int was_enabled:1;
79         /*! This module has failed dependencies */
80         unsigned int depsfailed:2;
81         /*! Previous failed dependencies when calculating */
82         unsigned int depsfailedold:2;
83         /*! This module has failed conflicts */
84         unsigned int conflictsfailed:2;
85         /*! This module's 'enabled' flag was changed by a default only */
86         unsigned int was_defaulted:1;
87         /*! This module is a dependency, and if it is selected then
88           we have included it in the MENUSELECT_BUILD_DEPS line
89           in the output file */
90         unsigned int build_deps_output:1;
91         /*! This module should never be enabled automatically, but only
92          * when explicitly set. */
93         unsigned int explicitly_enabled_only:1;
94         /*! This isn't actually a module!  It's a separator, and it should
95          * be passed over for many of the usual purposes associated with members. */
96         unsigned int is_separator:1;
97         /*! dependencies of this module */
98         struct reference_list deps;
99         /*! conflicts of this module */
100         struct reference_list conflicts;
101         /*! optional packages used by this module */
102         struct reference_list uses;
103         /*! for making a list of modules */
104         AST_LIST_ENTRY(member) list;
105 };
106
107 enum support_level_values {
108         SUPPORT_CORE = 0,
109         SUPPORT_EXTENDED = 1,
110         SUPPORT_DEPRECATED = 2,
111         SUPPORT_UNSPECIFIED = 3,
112         SUPPORT_EXTERNAL = 4,
113         SUPPORT_OPTION = 5,
114         SUPPORT_COUNT = 6, /* Keep this item at the end of the list. Tracks total number of support levels. */
115 };
116
117 AST_LIST_HEAD_NOLOCK(support_level_bucket, member);
118
119 struct category {
120         /*! Workspace for building support levels */
121         struct support_level_bucket buckets[SUPPORT_COUNT];
122         /*! the Makefile variable */
123         const char *name;
124         /*! the name displayed in the menu */
125         const char *displayname;
126         /*! Delete these file(s) if anything in this category changes */
127         const char *remove_on_change;
128         /*! Touch these file(s) if anything in this category changes */
129         const char *touch_on_change;
130         /*! Output what is selected, as opposed to not selected */
131         unsigned int positive_output:1;
132         /*! All choices in this category are mutually exclusive */
133         unsigned int exclusive:1;
134         /*! the list of possible values to be set in this variable */
135         AST_LIST_HEAD_NOLOCK(, member) members;
136         /*! for linking */
137         AST_LIST_ENTRY(category) list;
138 };
139
140 extern AST_LIST_HEAD_NOLOCK(categories, category) categories;
141
142 extern const char *menu_name;
143
144 /*! This is implemented by the frontend */
145 int run_menu(void);
146
147 int count_categories(void);
148
149 int count_members(struct category *cat);
150
151 /*! \brief Toggle a member of a category at the specified index to enabled/disabled */
152 void toggle_enabled_index(struct category *cat, int index);
153
154 void toggle_enabled(struct member *mem);
155
156 /*! \brief Set a member of a category at the specified index to enabled */
157 void set_enabled(struct category *cat, int index);
158 /*! \brief Set a member of a category at the specified index to not enabled */
159 void clear_enabled(struct category *cat, int index);
160
161 /*! \brief Enable/Disable all members of a category as long as dependencies have been met and no conflicts are found */
162 void set_all(struct category *cat, int val);
163
164 /*! \brief returns non-zero if the string is not defined, or has zero length */
165 static inline int strlen_zero(const char *s)
166 {
167         return (!s || (*s == '\0'));
168 }
169
170 #if !defined(ast_strdupa) && defined(__GNUC__)
171 #define ast_strdupa(s)                                                    \
172         (__extension__                                                    \
173         ({                                                                \
174                 const char *__old = (s);                                  \
175                 size_t __len = strlen(__old) + 1;                         \
176                 char *__new = __builtin_alloca(__len);                    \
177                 memcpy (__new, __old, __len);                             \
178                 __new;                                                    \
179         }))
180 #endif
181
182 #endif /* MENUSELECT_H */