Loading...
1/*
2 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
3 * Released under the terms of the GNU GPL v2.0.
4 */
5
6#ifndef EXPR_H
7#define EXPR_H
8
9#ifdef __cplusplus
10extern "C" {
11#endif
12
13#include <assert.h>
14#include <stdio.h>
15#include "list.h"
16#ifndef __cplusplus
17#include <stdbool.h>
18#endif
19
20struct file {
21 struct file *next;
22 struct file *parent;
23 const char *name;
24 int lineno;
25};
26
27typedef enum tristate {
28 no, mod, yes
29} tristate;
30
31enum expr_type {
32 E_NONE, E_OR, E_AND, E_NOT,
33 E_EQUAL, E_UNEQUAL, E_LTH, E_LEQ, E_GTH, E_GEQ,
34 E_LIST, E_SYMBOL, E_RANGE
35};
36
37union expr_data {
38 struct expr *expr;
39 struct symbol *sym;
40};
41
42struct expr {
43 enum expr_type type;
44 union expr_data left, right;
45};
46
47#define EXPR_OR(dep1, dep2) (((dep1)>(dep2))?(dep1):(dep2))
48#define EXPR_AND(dep1, dep2) (((dep1)<(dep2))?(dep1):(dep2))
49#define EXPR_NOT(dep) (2-(dep))
50
51#define expr_list_for_each_sym(l, e, s) \
52 for (e = (l); e && (s = e->right.sym); e = e->left.expr)
53
54struct expr_value {
55 struct expr *expr;
56 tristate tri;
57};
58
59struct symbol_value {
60 void *val;
61 tristate tri;
62};
63
64enum symbol_type {
65 S_UNKNOWN, S_BOOLEAN, S_TRISTATE, S_INT, S_HEX, S_STRING, S_OTHER
66};
67
68/* enum values are used as index to symbol.def[] */
69enum {
70 S_DEF_USER, /* main user value */
71 S_DEF_AUTO, /* values read from auto.conf */
72 S_DEF_DEF3, /* Reserved for UI usage */
73 S_DEF_DEF4, /* Reserved for UI usage */
74 S_DEF_COUNT
75};
76
77struct symbol {
78 struct symbol *next;
79 char *name;
80 enum symbol_type type;
81 struct symbol_value curr;
82 struct symbol_value def[S_DEF_COUNT];
83 tristate visible;
84 int flags;
85 struct property *prop;
86 struct expr_value dir_dep;
87 struct expr_value rev_dep;
88};
89
90#define for_all_symbols(i, sym) for (i = 0; i < SYMBOL_HASHSIZE; i++) for (sym = symbol_hash[i]; sym; sym = sym->next) if (sym->type != S_OTHER)
91
92#define SYMBOL_CONST 0x0001 /* symbol is const */
93#define SYMBOL_CHECK 0x0008 /* used during dependency checking */
94#define SYMBOL_CHOICE 0x0010 /* start of a choice block (null name) */
95#define SYMBOL_CHOICEVAL 0x0020 /* used as a value in a choice block */
96#define SYMBOL_VALID 0x0080 /* set when symbol.curr is calculated */
97#define SYMBOL_OPTIONAL 0x0100 /* choice is optional - values can be 'n' */
98#define SYMBOL_WRITE 0x0200 /* write symbol to file (KCONFIG_CONFIG) */
99#define SYMBOL_CHANGED 0x0400 /* ? */
100#define SYMBOL_AUTO 0x1000 /* value from environment variable */
101#define SYMBOL_CHECKED 0x2000 /* used during dependency checking */
102#define SYMBOL_WARNED 0x8000 /* warning has been issued */
103
104/* Set when symbol.def[] is used */
105#define SYMBOL_DEF 0x10000 /* First bit of SYMBOL_DEF */
106#define SYMBOL_DEF_USER 0x10000 /* symbol.def[S_DEF_USER] is valid */
107#define SYMBOL_DEF_AUTO 0x20000 /* symbol.def[S_DEF_AUTO] is valid */
108#define SYMBOL_DEF3 0x40000 /* symbol.def[S_DEF_3] is valid */
109#define SYMBOL_DEF4 0x80000 /* symbol.def[S_DEF_4] is valid */
110
111/* choice values need to be set before calculating this symbol value */
112#define SYMBOL_NEED_SET_CHOICE_VALUES 0x100000
113
114/* Set symbol to y if allnoconfig; used for symbols that hide others */
115#define SYMBOL_ALLNOCONFIG_Y 0x200000
116
117#define SYMBOL_MAXLENGTH 256
118#define SYMBOL_HASHSIZE 9973
119
120/* A property represent the config options that can be associated
121 * with a config "symbol".
122 * Sample:
123 * config FOO
124 * default y
125 * prompt "foo prompt"
126 * select BAR
127 * config BAZ
128 * int "BAZ Value"
129 * range 1..255
130 */
131enum prop_type {
132 P_UNKNOWN,
133 P_PROMPT, /* prompt "foo prompt" or "BAZ Value" */
134 P_COMMENT, /* text associated with a comment */
135 P_MENU, /* prompt associated with a menuconfig option */
136 P_DEFAULT, /* default y */
137 P_CHOICE, /* choice value */
138 P_SELECT, /* select BAR */
139 P_RANGE, /* range 7..100 (for a symbol) */
140 P_ENV, /* value from environment variable */
141 P_SYMBOL, /* where a symbol is defined */
142};
143
144struct property {
145 struct property *next; /* next property - null if last */
146 struct symbol *sym; /* the symbol for which the property is associated */
147 enum prop_type type; /* type of property */
148 const char *text; /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */
149 struct expr_value visible;
150 struct expr *expr; /* the optional conditional part of the property */
151 struct menu *menu; /* the menu the property are associated with
152 * valid for: P_SELECT, P_RANGE, P_CHOICE,
153 * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */
154 struct file *file; /* what file was this property defined */
155 int lineno; /* what lineno was this property defined */
156};
157
158#define for_all_properties(sym, st, tok) \
159 for (st = sym->prop; st; st = st->next) \
160 if (st->type == (tok))
161#define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT)
162#define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE)
163#define for_all_prompts(sym, st) \
164 for (st = sym->prop; st; st = st->next) \
165 if (st->text)
166
167struct menu {
168 struct menu *next;
169 struct menu *parent;
170 struct menu *list;
171 struct symbol *sym;
172 struct property *prompt;
173 struct expr *visibility;
174 struct expr *dep;
175 unsigned int flags;
176 char *help;
177 struct file *file;
178 int lineno;
179 void *data;
180};
181
182#define MENU_CHANGED 0x0001
183#define MENU_ROOT 0x0002
184
185struct jump_key {
186 struct list_head entries;
187 size_t offset;
188 struct menu *target;
189 int index;
190};
191
192#define JUMP_NB 9
193
194extern struct file *file_list;
195extern struct file *current_file;
196struct file *lookup_file(const char *name);
197
198extern struct symbol symbol_yes, symbol_no, symbol_mod;
199extern struct symbol *modules_sym;
200extern struct symbol *sym_defconfig_list;
201extern int cdebug;
202struct expr *expr_alloc_symbol(struct symbol *sym);
203struct expr *expr_alloc_one(enum expr_type type, struct expr *ce);
204struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2);
205struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2);
206struct expr *expr_alloc_and(struct expr *e1, struct expr *e2);
207struct expr *expr_alloc_or(struct expr *e1, struct expr *e2);
208struct expr *expr_copy(const struct expr *org);
209void expr_free(struct expr *e);
210void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
211tristate expr_calc_value(struct expr *e);
212struct expr *expr_trans_bool(struct expr *e);
213struct expr *expr_eliminate_dups(struct expr *e);
214struct expr *expr_transform(struct expr *e);
215int expr_contains_symbol(struct expr *dep, struct symbol *sym);
216bool expr_depends_symbol(struct expr *dep, struct symbol *sym);
217struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym);
218struct expr *expr_simplify_unmet_dep(struct expr *e1, struct expr *e2);
219
220void expr_fprint(struct expr *e, FILE *out);
221struct gstr; /* forward */
222void expr_gstr_print(struct expr *e, struct gstr *gs);
223
224static inline int expr_is_yes(struct expr *e)
225{
226 return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
227}
228
229static inline int expr_is_no(struct expr *e)
230{
231 return e && (e->type == E_SYMBOL && e->left.sym == &symbol_no);
232}
233
234#ifdef __cplusplus
235}
236#endif
237
238#endif /* EXPR_H */
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
4 */
5
6#ifndef EXPR_H
7#define EXPR_H
8
9#ifdef __cplusplus
10extern "C" {
11#endif
12
13#include <assert.h>
14#include <stdio.h>
15#include "list_types.h"
16#ifndef __cplusplus
17#include <stdbool.h>
18#endif
19
20#include "list_types.h"
21
22typedef enum tristate {
23 no, mod, yes
24} tristate;
25
26enum expr_type {
27 E_NONE, E_OR, E_AND, E_NOT,
28 E_EQUAL, E_UNEQUAL, E_LTH, E_LEQ, E_GTH, E_GEQ,
29 E_LIST, E_SYMBOL, E_RANGE
30};
31
32union expr_data {
33 struct expr *expr;
34 struct symbol *sym;
35};
36
37struct expr {
38 enum expr_type type;
39 union expr_data left, right;
40};
41
42#define EXPR_OR(dep1, dep2) (((dep1)>(dep2))?(dep1):(dep2))
43#define EXPR_AND(dep1, dep2) (((dep1)<(dep2))?(dep1):(dep2))
44#define EXPR_NOT(dep) (2-(dep))
45
46#define expr_list_for_each_sym(l, e, s) \
47 for (e = (l); e && (s = e->right.sym); e = e->left.expr)
48
49struct expr_value {
50 struct expr *expr;
51 tristate tri;
52};
53
54struct symbol_value {
55 void *val;
56 tristate tri;
57};
58
59enum symbol_type {
60 S_UNKNOWN, S_BOOLEAN, S_TRISTATE, S_INT, S_HEX, S_STRING
61};
62
63/* enum values are used as index to symbol.def[] */
64enum {
65 S_DEF_USER, /* main user value */
66 S_DEF_AUTO, /* values read from auto.conf */
67 S_DEF_DEF3, /* Reserved for UI usage */
68 S_DEF_DEF4, /* Reserved for UI usage */
69 S_DEF_COUNT
70};
71
72/*
73 * Represents a configuration symbol.
74 *
75 * Choices are represented as a special kind of symbol and have the
76 * SYMBOL_CHOICE bit set in 'flags'.
77 */
78struct symbol {
79 /* link node for the hash table */
80 struct hlist_node node;
81
82 /* The name of the symbol, e.g. "FOO" for 'config FOO' */
83 char *name;
84
85 /* S_BOOLEAN, S_TRISTATE, ... */
86 enum symbol_type type;
87
88 /*
89 * The calculated value of the symbol. The SYMBOL_VALID bit is set in
90 * 'flags' when this is up to date. Note that this value might differ
91 * from the user value set in e.g. a .config file, due to visibility.
92 */
93 struct symbol_value curr;
94
95 /*
96 * Values for the symbol provided from outside. def[S_DEF_USER] holds
97 * the .config value.
98 */
99 struct symbol_value def[S_DEF_COUNT];
100
101 /*
102 * An upper bound on the tristate value the user can set for the symbol
103 * if it is a boolean or tristate. Calculated from prompt dependencies,
104 * which also inherit dependencies from enclosing menus, choices, and
105 * ifs. If 'n', the user value will be ignored.
106 *
107 * Symbols lacking prompts always have visibility 'n'.
108 */
109 tristate visible;
110
111 /* config entries associated with this symbol */
112 struct list_head menus;
113
114 /* SYMBOL_* flags */
115 int flags;
116
117 /* List of properties. See prop_type. */
118 struct property *prop;
119
120 /* Dependencies from enclosing menus, choices, and ifs */
121 struct expr_value dir_dep;
122
123 /* Reverse dependencies through being selected by other symbols */
124 struct expr_value rev_dep;
125
126 /*
127 * "Weak" reverse dependencies through being implied by other symbols
128 */
129 struct expr_value implied;
130};
131
132#define SYMBOL_CONST 0x0001 /* symbol is const */
133#define SYMBOL_CHECK 0x0008 /* used during dependency checking */
134#define SYMBOL_CHOICE 0x0010 /* start of a choice block (null name) */
135#define SYMBOL_CHOICEVAL 0x0020 /* used as a value in a choice block */
136#define SYMBOL_VALID 0x0080 /* set when symbol.curr is calculated */
137#define SYMBOL_OPTIONAL 0x0100 /* choice is optional - values can be 'n' */
138#define SYMBOL_WRITE 0x0200 /* write symbol to file (KCONFIG_CONFIG) */
139#define SYMBOL_CHANGED 0x0400 /* ? */
140#define SYMBOL_WRITTEN 0x0800 /* track info to avoid double-write to .config */
141#define SYMBOL_NO_WRITE 0x1000 /* Symbol for internal use only; it will not be written */
142#define SYMBOL_CHECKED 0x2000 /* used during dependency checking */
143#define SYMBOL_WARNED 0x8000 /* warning has been issued */
144
145/* Set when symbol.def[] is used */
146#define SYMBOL_DEF 0x10000 /* First bit of SYMBOL_DEF */
147#define SYMBOL_DEF_USER 0x10000 /* symbol.def[S_DEF_USER] is valid */
148#define SYMBOL_DEF_AUTO 0x20000 /* symbol.def[S_DEF_AUTO] is valid */
149#define SYMBOL_DEF3 0x40000 /* symbol.def[S_DEF_3] is valid */
150#define SYMBOL_DEF4 0x80000 /* symbol.def[S_DEF_4] is valid */
151
152/* choice values need to be set before calculating this symbol value */
153#define SYMBOL_NEED_SET_CHOICE_VALUES 0x100000
154
155#define SYMBOL_MAXLENGTH 256
156
157/* A property represent the config options that can be associated
158 * with a config "symbol".
159 * Sample:
160 * config FOO
161 * default y
162 * prompt "foo prompt"
163 * select BAR
164 * config BAZ
165 * int "BAZ Value"
166 * range 1..255
167 *
168 * Please, also check parser.y:print_symbol() when modifying the
169 * list of property types!
170 */
171enum prop_type {
172 P_UNKNOWN,
173 P_PROMPT, /* prompt "foo prompt" or "BAZ Value" */
174 P_COMMENT, /* text associated with a comment */
175 P_MENU, /* prompt associated with a menu or menuconfig symbol */
176 P_DEFAULT, /* default y */
177 P_CHOICE, /* choice value */
178 P_SELECT, /* select BAR */
179 P_IMPLY, /* imply BAR */
180 P_RANGE, /* range 7..100 (for a symbol) */
181 P_SYMBOL, /* where a symbol is defined */
182};
183
184struct property {
185 struct property *next; /* next property - null if last */
186 enum prop_type type; /* type of property */
187 const char *text; /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */
188 struct expr_value visible;
189 struct expr *expr; /* the optional conditional part of the property */
190 struct menu *menu; /* the menu the property are associated with
191 * valid for: P_SELECT, P_RANGE, P_CHOICE,
192 * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */
193 const char *filename; /* what file was this property defined */
194 int lineno; /* what lineno was this property defined */
195};
196
197#define for_all_properties(sym, st, tok) \
198 for (st = sym->prop; st; st = st->next) \
199 if (st->type == (tok))
200#define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT)
201#define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE)
202#define for_all_prompts(sym, st) \
203 for (st = sym->prop; st; st = st->next) \
204 if (st->text)
205
206/*
207 * Represents a node in the menu tree, as seen in e.g. menuconfig (though used
208 * for all front ends). Each symbol, menu, etc. defined in the Kconfig files
209 * gets a node. A symbol defined in multiple locations gets one node at each
210 * location.
211 */
212struct menu {
213 /* The next menu node at the same level */
214 struct menu *next;
215
216 /* The parent menu node, corresponding to e.g. a menu or choice */
217 struct menu *parent;
218
219 /* The first child menu node, for e.g. menus and choices */
220 struct menu *list;
221
222 /*
223 * The symbol associated with the menu node. Choices are implemented as
224 * a special kind of symbol. NULL for menus, comments, and ifs.
225 */
226 struct symbol *sym;
227
228 struct list_head link; /* link to symbol::menus */
229
230 /*
231 * The prompt associated with the node. This holds the prompt for a
232 * symbol as well as the text for a menu or comment, along with the
233 * type (P_PROMPT, P_MENU, etc.)
234 */
235 struct property *prompt;
236
237 /*
238 * 'visible if' dependencies. If more than one is given, they will be
239 * ANDed together.
240 */
241 struct expr *visibility;
242
243 /*
244 * Ordinary dependencies from e.g. 'depends on' and 'if', ANDed
245 * together
246 */
247 struct expr *dep;
248
249 /* MENU_* flags */
250 unsigned int flags;
251
252 /* Any help text associated with the node */
253 char *help;
254
255 /* The location where the menu node appears in the Kconfig files */
256 const char *filename;
257 int lineno;
258
259 /* For use by front ends that need to store auxiliary data */
260 void *data;
261};
262
263/*
264 * Set on a menu node when the corresponding symbol changes state in some way.
265 * Can be checked by front ends.
266 */
267#define MENU_CHANGED 0x0001
268
269#define MENU_ROOT 0x0002
270
271struct jump_key {
272 struct list_head entries;
273 size_t offset;
274 struct menu *target;
275};
276
277extern struct symbol symbol_yes, symbol_no, symbol_mod;
278extern struct symbol *modules_sym;
279extern int cdebug;
280struct expr *expr_alloc_symbol(struct symbol *sym);
281struct expr *expr_alloc_one(enum expr_type type, struct expr *ce);
282struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2);
283struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2);
284struct expr *expr_alloc_and(struct expr *e1, struct expr *e2);
285struct expr *expr_alloc_or(struct expr *e1, struct expr *e2);
286struct expr *expr_copy(const struct expr *org);
287void expr_free(struct expr *e);
288void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
289int expr_eq(struct expr *e1, struct expr *e2);
290tristate expr_calc_value(struct expr *e);
291struct expr *expr_trans_bool(struct expr *e);
292struct expr *expr_eliminate_dups(struct expr *e);
293struct expr *expr_transform(struct expr *e);
294int expr_contains_symbol(struct expr *dep, struct symbol *sym);
295bool expr_depends_symbol(struct expr *dep, struct symbol *sym);
296struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym);
297
298void expr_fprint(struct expr *e, FILE *out);
299struct gstr; /* forward */
300void expr_gstr_print(struct expr *e, struct gstr *gs);
301void expr_gstr_print_revdep(struct expr *e, struct gstr *gs,
302 tristate pr_type, const char *title);
303
304static inline int expr_is_yes(struct expr *e)
305{
306 return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
307}
308
309static inline int expr_is_no(struct expr *e)
310{
311 return e && (e->type == E_SYMBOL && e->left.sym == &symbol_no);
312}
313
314#ifdef __cplusplus
315}
316#endif
317
318#endif /* EXPR_H */