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_LIST, 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_CHOICEVAL 0x0020 /* used as a value in a choice block */ 135 #define SYMBOL_VALID 0x0080 /* set when symbol.curr is calculated */ 136 #define SYMBOL_WRITE 0x0200 /* write symbol to file (KCONFIG_CONFIG) */ 137 #define SYMBOL_WRITTEN 0x0800 /* track info to avoid double-write to .config */ 138 #define SYMBOL_CHECKED 0x2000 /* used during dependency checking */ 139 #define SYMBOL_WARNED 0x8000 /* warning has been issued */ 140 141 /* Set when symbol.def[] is used */ 142 #define SYMBOL_DEF 0x10000 /* First bit of SYMBOL_DEF */ 143 #define SYMBOL_DEF_USER 0x10000 /* symbol.def[S_DEF_USER] is valid */ 144 #define SYMBOL_DEF_AUTO 0x20000 /* symbol.def[S_DEF_AUTO] is valid */ 145 #define SYMBOL_DEF3 0x40000 /* symbol.def[S_DEF_3] is valid */ 146 #define SYMBOL_DEF4 0x80000 /* symbol.def[S_DEF_4] is valid */ 147 148 #define SYMBOL_MAXLENGTH 256 149 150 /* A property represent the config options that can be associated 151 * with a config "symbol". 152 * Sample: 153 * config FOO 154 * default y 155 * prompt "foo prompt" 156 * select BAR 157 * config BAZ 158 * int "BAZ Value" 159 * range 1..255 160 * 161 * Please, also check parser.y:print_symbol() when modifying the 162 * list of property types! 163 */ 164 enum prop_type { 165 P_UNKNOWN, 166 P_PROMPT, /* prompt "foo prompt" or "BAZ Value" */ 167 P_COMMENT, /* text associated with a comment */ 168 P_MENU, /* prompt associated with a menu or menuconfig symbol */ 169 P_DEFAULT, /* default y */ 170 P_CHOICE, /* choice value */ 171 P_SELECT, /* select BAR */ 172 P_IMPLY, /* imply BAR */ 173 P_RANGE, /* range 7..100 (for a symbol) */ 174 P_SYMBOL, /* where a symbol is defined */ 175 }; 176 177 struct property { 178 struct property *next; /* next property - null if last */ 179 enum prop_type type; /* type of property */ 180 const char *text; /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */ 181 struct expr_value visible; 182 struct expr *expr; /* the optional conditional part of the property */ 183 struct menu *menu; /* the menu the property are associated with 184 * valid for: P_SELECT, P_RANGE, P_CHOICE, 185 * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */ 186 const char *filename; /* what file was this property defined */ 187 int lineno; /* what lineno was this property defined */ 188 }; 189 190 #define for_all_properties(sym, st, tok) \ 191 for (st = sym->prop; st; st = st->next) \ 192 if (st->type == (tok)) 193 #define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT) 194 #define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE) 195 #define for_all_prompts(sym, st) \ 196 for (st = sym->prop; st; st = st->next) \ 197 if (st->text) 198 199 /* 200 * Represents a node in the menu tree, as seen in e.g. menuconfig (though used 201 * for all front ends). Each symbol, menu, etc. defined in the Kconfig files 202 * gets a node. A symbol defined in multiple locations gets one node at each 203 * location. 204 * 205 * @choice_members: list of choice members with priority. 206 */ 207 struct menu { 208 /* The next menu node at the same level */ 209 struct menu *next; 210 211 /* The parent menu node, corresponding to e.g. a menu or choice */ 212 struct menu *parent; 213 214 /* The first child menu node, for e.g. menus and choices */ 215 struct menu *list; 216 217 /* 218 * The symbol associated with the menu node. Choices are implemented as 219 * a special kind of symbol. NULL for menus, comments, and ifs. 220 */ 221 struct symbol *sym; 222 223 struct list_head link; /* link to symbol::menus */ 224 225 struct list_head choice_members; 226 227 /* 228 * The prompt associated with the node. This holds the prompt for a 229 * symbol as well as the text for a menu or comment, along with the 230 * type (P_PROMPT, P_MENU, etc.) 231 */ 232 struct property *prompt; 233 234 /* 235 * 'visible if' dependencies. If more than one is given, they will be 236 * ANDed together. 237 */ 238 struct expr *visibility; 239 240 /* 241 * Ordinary dependencies from e.g. 'depends on' and 'if', ANDed 242 * together 243 */ 244 struct expr *dep; 245 246 /* MENU_* flags */ 247 unsigned int flags; 248 249 /* Any help text associated with the node */ 250 char *help; 251 252 /* The location where the menu node appears in the Kconfig files */ 253 const char *filename; 254 int lineno; 255 256 /* For use by front ends that need to store auxiliary data */ 257 void *data; 258 }; 259 260 /* 261 * Set on a menu node when the corresponding symbol changes state in some way. 262 * Can be checked by front ends. 263 */ 264 #define MENU_CHANGED 0x0001 265 266 #define MENU_ROOT 0x0002 267 268 struct jump_key { 269 struct list_head entries; 270 size_t offset; 271 struct menu *target; 272 }; 273 274 extern struct symbol symbol_yes, symbol_no, symbol_mod; 275 extern struct symbol *modules_sym; 276 extern int cdebug; 277 struct expr *expr_alloc_symbol(struct symbol *sym); 278 struct expr *expr_alloc_one(enum expr_type type, struct expr *ce); 279 struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2); 280 struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2); 281 struct expr *expr_alloc_and(struct expr *e1, struct expr *e2); 282 struct expr *expr_alloc_or(struct expr *e1, struct expr *e2); 283 struct expr *expr_copy(const struct expr *org); 284 void expr_free(struct expr *e); 285 void expr_eliminate_eq(struct expr **ep1, struct expr **ep2); 286 int expr_eq(struct expr *e1, struct expr *e2); 287 tristate expr_calc_value(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 #ifdef __cplusplus 306 } 307 #endif 308 309 #endif /* EXPR_H */ 310