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