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