xref: /linux/scripts/kconfig/expr.h (revision b6ebbac51bedf9e98e837688bc838f400196da5e)
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
10 extern "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 
20 struct file {
21 	struct file *next;
22 	struct file *parent;
23 	const char *name;
24 	int lineno;
25 };
26 
27 typedef enum tristate {
28 	no, mod, yes
29 } tristate;
30 
31 enum 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 
37 union expr_data {
38 	struct expr *expr;
39 	struct symbol *sym;
40 };
41 
42 struct 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 
54 struct expr_value {
55 	struct expr *expr;
56 	tristate tri;
57 };
58 
59 struct symbol_value {
60 	void *val;
61 	tristate tri;
62 };
63 
64 enum 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[] */
69 enum {
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 
77 struct 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  */
131 enum 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 
144 struct 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 
167 struct 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 
185 struct 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 
194 extern struct file *file_list;
195 extern struct file *current_file;
196 struct file *lookup_file(const char *name);
197 
198 extern struct symbol symbol_yes, symbol_no, symbol_mod;
199 extern struct symbol *modules_sym;
200 extern struct symbol *sym_defconfig_list;
201 extern int cdebug;
202 struct expr *expr_alloc_symbol(struct symbol *sym);
203 struct expr *expr_alloc_one(enum expr_type type, struct expr *ce);
204 struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2);
205 struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2);
206 struct expr *expr_alloc_and(struct expr *e1, struct expr *e2);
207 struct expr *expr_alloc_or(struct expr *e1, struct expr *e2);
208 struct expr *expr_copy(const struct expr *org);
209 void expr_free(struct expr *e);
210 void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
211 tristate expr_calc_value(struct expr *e);
212 struct expr *expr_trans_bool(struct expr *e);
213 struct expr *expr_eliminate_dups(struct expr *e);
214 struct expr *expr_transform(struct expr *e);
215 int expr_contains_symbol(struct expr *dep, struct symbol *sym);
216 bool expr_depends_symbol(struct expr *dep, struct symbol *sym);
217 struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym);
218 struct expr *expr_simplify_unmet_dep(struct expr *e1, struct expr *e2);
219 
220 void expr_fprint(struct expr *e, FILE *out);
221 struct gstr; /* forward */
222 void expr_gstr_print(struct expr *e, struct gstr *gs);
223 
224 static inline int expr_is_yes(struct expr *e)
225 {
226 	return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
227 }
228 
229 static 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 */
239