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 #include "list_types.h" 21 22 typedef enum tristate { 23 no, mod, yes 24 } tristate; 25 26 enum 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_SYMBOL, E_RANGE 30 }; 31 32 union expr_data { 33 struct expr *expr; 34 struct symbol *sym; 35 }; 36 37 struct 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 struct expr_value { 47 struct expr *expr; 48 tristate tri; 49 }; 50 51 struct symbol_value { 52 void *val; 53 tristate tri; 54 }; 55 56 enum symbol_type { 57 S_UNKNOWN, S_BOOLEAN, S_TRISTATE, S_INT, S_HEX, S_STRING 58 }; 59 60 /* enum values are used as index to symbol.def[] */ 61 enum { 62 S_DEF_USER, /* main user value */ 63 S_DEF_AUTO, /* values read from auto.conf */ 64 S_DEF_DEF3, /* Reserved for UI usage */ 65 S_DEF_DEF4, /* Reserved for UI usage */ 66 S_DEF_COUNT 67 }; 68 69 /* 70 * Represents a configuration symbol. 71 * 72 * Choices are represented as a special kind of symbol with null name. 73 * 74 * @choice_link: linked to menu::choice_members 75 */ 76 struct symbol { 77 /* link node for the hash table */ 78 struct hlist_node node; 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 /* config entries associated with this symbol */ 110 struct list_head menus; 111 112 struct list_head choice_link; 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_VALID 0x0080 /* set when symbol.curr is calculated */ 135 #define SYMBOL_WRITE 0x0200 /* write symbol to file (KCONFIG_CONFIG) */ 136 #define SYMBOL_WRITTEN 0x0800 /* track info to avoid double-write to .config */ 137 #define SYMBOL_CHECKED 0x2000 /* used during dependency checking */ 138 #define SYMBOL_WARNED 0x8000 /* warning has been issued */ 139 140 /* Set when symbol.def[] is used */ 141 #define SYMBOL_DEF 0x10000 /* First bit of SYMBOL_DEF */ 142 #define SYMBOL_DEF_USER 0x10000 /* symbol.def[S_DEF_USER] is valid */ 143 #define SYMBOL_DEF_AUTO 0x20000 /* symbol.def[S_DEF_AUTO] is valid */ 144 #define SYMBOL_DEF3 0x40000 /* symbol.def[S_DEF_3] is valid */ 145 #define SYMBOL_DEF4 0x80000 /* symbol.def[S_DEF_4] is valid */ 146 147 #define SYMBOL_MAXLENGTH 256 148 149 /* A property represent the config options that can be associated 150 * with a config "symbol". 151 * Sample: 152 * config FOO 153 * default y 154 * prompt "foo prompt" 155 * select BAR 156 * config BAZ 157 * int "BAZ Value" 158 * range 1..255 159 * 160 * Please, also check parser.y:print_symbol() when modifying the 161 * list of property types! 162 */ 163 enum prop_type { 164 P_UNKNOWN, 165 P_PROMPT, /* prompt "foo prompt" or "BAZ Value" */ 166 P_COMMENT, /* text associated with a comment */ 167 P_MENU, /* prompt associated with a menu or menuconfig symbol */ 168 P_DEFAULT, /* default y */ 169 P_SELECT, /* select BAR */ 170 P_IMPLY, /* imply BAR */ 171 P_RANGE, /* range 7..100 (for a symbol) */ 172 P_SYMBOL, /* where a symbol is defined */ 173 }; 174 175 struct property { 176 struct property *next; /* next property - null if last */ 177 enum prop_type type; /* type of property */ 178 const char *text; /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */ 179 struct expr_value visible; 180 struct expr *expr; /* the optional conditional part of the property */ 181 struct menu *menu; /* the menu the property are associated with 182 * valid for: P_SELECT, P_RANGE, 183 * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */ 184 const char *filename; /* what file was this property defined */ 185 int lineno; /* what lineno was this property defined */ 186 }; 187 188 #define for_all_properties(sym, st, tok) \ 189 for (st = sym->prop; st; st = st->next) \ 190 if (st->type == (tok)) 191 #define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT) 192 #define for_all_prompts(sym, st) \ 193 for (st = sym->prop; st; st = st->next) \ 194 if (st->text) 195 196 /* 197 * Represents a node in the menu tree, as seen in e.g. menuconfig (though used 198 * for all front ends). Each symbol, menu, etc. defined in the Kconfig files 199 * gets a node. A symbol defined in multiple locations gets one node at each 200 * location. 201 * 202 * @choice_members: list of choice members with priority. 203 */ 204 struct menu { 205 /* The next menu node at the same level */ 206 struct menu *next; 207 208 /* The parent menu node, corresponding to e.g. a menu or choice */ 209 struct menu *parent; 210 211 /* The first child menu node, for e.g. menus and choices */ 212 struct menu *list; 213 214 /* 215 * The symbol associated with the menu node. Choices are implemented as 216 * a special kind of symbol. NULL for menus, comments, and ifs. 217 */ 218 struct symbol *sym; 219 220 struct list_head link; /* link to symbol::menus */ 221 222 struct list_head choice_members; 223 224 /* 225 * The prompt associated with the node. This holds the prompt for a 226 * symbol as well as the text for a menu or comment, along with the 227 * type (P_PROMPT, P_MENU, etc.) 228 */ 229 struct property *prompt; 230 231 /* 232 * 'visible if' dependencies. If more than one is given, they will be 233 * ANDed together. 234 */ 235 struct expr *visibility; 236 237 /* 238 * Ordinary dependencies from e.g. 'depends on' and 'if', ANDed 239 * together 240 */ 241 struct expr *dep; 242 243 /* MENU_* flags */ 244 unsigned int flags; 245 246 /* Any help text associated with the node */ 247 char *help; 248 249 /* The location where the menu node appears in the Kconfig files */ 250 const char *filename; 251 int lineno; 252 253 /* For use by front ends that need to store auxiliary data */ 254 void *data; 255 }; 256 257 /* 258 * Set on a menu node when the corresponding symbol changes state in some way. 259 * Can be checked by front ends. 260 */ 261 #define MENU_CHANGED 0x0001 262 263 #define MENU_ROOT 0x0002 264 265 struct jump_key { 266 struct list_head entries; 267 size_t offset; 268 struct menu *target; 269 }; 270 271 extern struct symbol symbol_yes, symbol_no, symbol_mod; 272 extern struct symbol *modules_sym; 273 extern int cdebug; 274 struct expr *expr_alloc_symbol(struct symbol *sym); 275 struct expr *expr_alloc_one(enum expr_type type, struct expr *ce); 276 struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2); 277 struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2); 278 struct expr *expr_alloc_and(struct expr *e1, struct expr *e2); 279 struct expr *expr_alloc_or(struct expr *e1, struct expr *e2); 280 struct expr *expr_copy(const struct expr *org); 281 void expr_free(struct expr *e); 282 void expr_eliminate_eq(struct expr **ep1, struct expr **ep2); 283 int expr_eq(struct expr *e1, struct expr *e2); 284 tristate expr_calc_value(struct expr *e); 285 struct expr *expr_eliminate_dups(struct expr *e); 286 struct expr *expr_transform(struct expr *e); 287 int expr_contains_symbol(struct expr *dep, struct symbol *sym); 288 bool expr_depends_symbol(struct expr *dep, struct symbol *sym); 289 struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym); 290 291 void expr_fprint(struct expr *e, FILE *out); 292 struct gstr; /* forward */ 293 void expr_gstr_print(const struct expr *e, struct gstr *gs); 294 void expr_gstr_print_revdep(struct expr *e, struct gstr *gs, 295 tristate pr_type, const char *title); 296 297 static inline int expr_is_yes(const struct expr *e) 298 { 299 return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes); 300 } 301 302 #ifdef __cplusplus 303 } 304 #endif 305 306 #endif /* EXPR_H */ 307