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 #define expr_list_for_each_sym(l, e, s) \ 47 for (e = (l); e && (s = e->right.sym); e = e->left.expr) 48 49 struct expr_value { 50 struct expr *expr; 51 tristate tri; 52 }; 53 54 struct symbol_value { 55 void *val; 56 tristate tri; 57 }; 58 59 enum 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[] */ 64 enum { 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 */ 78 struct 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 /* SYMBOL_* flags */ 112 int flags; 113 114 /* List of properties. See prop_type. */ 115 struct property *prop; 116 117 /* Dependencies from enclosing menus, choices, and ifs */ 118 struct expr_value dir_dep; 119 120 /* Reverse dependencies through being selected by other symbols */ 121 struct expr_value rev_dep; 122 123 /* 124 * "Weak" reverse dependencies through being implied by other symbols 125 */ 126 struct expr_value implied; 127 }; 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 154 /* A property represent the config options that can be associated 155 * with a config "symbol". 156 * Sample: 157 * config FOO 158 * default y 159 * prompt "foo prompt" 160 * select BAR 161 * config BAZ 162 * int "BAZ Value" 163 * range 1..255 164 * 165 * Please, also check parser.y:print_symbol() when modifying the 166 * list of property types! 167 */ 168 enum prop_type { 169 P_UNKNOWN, 170 P_PROMPT, /* prompt "foo prompt" or "BAZ Value" */ 171 P_COMMENT, /* text associated with a comment */ 172 P_MENU, /* prompt associated with a menu or menuconfig symbol */ 173 P_DEFAULT, /* default y */ 174 P_CHOICE, /* choice value */ 175 P_SELECT, /* select BAR */ 176 P_IMPLY, /* imply BAR */ 177 P_RANGE, /* range 7..100 (for a symbol) */ 178 P_SYMBOL, /* where a symbol is defined */ 179 }; 180 181 struct property { 182 struct property *next; /* next property - null if last */ 183 enum prop_type type; /* type of property */ 184 const char *text; /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */ 185 struct expr_value visible; 186 struct expr *expr; /* the optional conditional part of the property */ 187 struct menu *menu; /* the menu the property are associated with 188 * valid for: P_SELECT, P_RANGE, P_CHOICE, 189 * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */ 190 const char *filename; /* what file was this property defined */ 191 int lineno; /* what lineno was this property defined */ 192 }; 193 194 #define for_all_properties(sym, st, tok) \ 195 for (st = sym->prop; st; st = st->next) \ 196 if (st->type == (tok)) 197 #define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT) 198 #define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE) 199 #define for_all_prompts(sym, st) \ 200 for (st = sym->prop; st; st = st->next) \ 201 if (st->text) 202 203 /* 204 * Represents a node in the menu tree, as seen in e.g. menuconfig (though used 205 * for all front ends). Each symbol, menu, etc. defined in the Kconfig files 206 * gets a node. A symbol defined in multiple locations gets one node at each 207 * location. 208 */ 209 struct menu { 210 /* The next menu node at the same level */ 211 struct menu *next; 212 213 /* The parent menu node, corresponding to e.g. a menu or choice */ 214 struct menu *parent; 215 216 /* The first child menu node, for e.g. menus and choices */ 217 struct menu *list; 218 219 /* 220 * The symbol associated with the menu node. Choices are implemented as 221 * a special kind of symbol. NULL for menus, comments, and ifs. 222 */ 223 struct symbol *sym; 224 225 /* 226 * The prompt associated with the node. This holds the prompt for a 227 * symbol as well as the text for a menu or comment, along with the 228 * type (P_PROMPT, P_MENU, etc.) 229 */ 230 struct property *prompt; 231 232 /* 233 * 'visible if' dependencies. If more than one is given, they will be 234 * ANDed together. 235 */ 236 struct expr *visibility; 237 238 /* 239 * Ordinary dependencies from e.g. 'depends on' and 'if', ANDed 240 * together 241 */ 242 struct expr *dep; 243 244 /* MENU_* flags */ 245 unsigned int flags; 246 247 /* Any help text associated with the node */ 248 char *help; 249 250 /* The location where the menu node appears in the Kconfig files */ 251 const char *filename; 252 int lineno; 253 254 /* For use by front ends that need to store auxiliary data */ 255 void *data; 256 }; 257 258 /* 259 * Set on a menu node when the corresponding symbol changes state in some way. 260 * Can be checked by front ends. 261 */ 262 #define MENU_CHANGED 0x0001 263 264 #define MENU_ROOT 0x0002 265 266 struct jump_key { 267 struct list_head entries; 268 size_t offset; 269 struct menu *target; 270 }; 271 272 extern struct symbol symbol_yes, symbol_no, symbol_mod; 273 extern struct symbol *modules_sym; 274 extern int cdebug; 275 struct expr *expr_alloc_symbol(struct symbol *sym); 276 struct expr *expr_alloc_one(enum expr_type type, struct expr *ce); 277 struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2); 278 struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2); 279 struct expr *expr_alloc_and(struct expr *e1, struct expr *e2); 280 struct expr *expr_alloc_or(struct expr *e1, struct expr *e2); 281 struct expr *expr_copy(const struct expr *org); 282 void expr_free(struct expr *e); 283 void expr_eliminate_eq(struct expr **ep1, struct expr **ep2); 284 int expr_eq(struct expr *e1, struct expr *e2); 285 tristate expr_calc_value(struct expr *e); 286 struct expr *expr_trans_bool(struct expr *e); 287 struct expr *expr_eliminate_dups(struct expr *e); 288 struct expr *expr_transform(struct expr *e); 289 int expr_contains_symbol(struct expr *dep, struct symbol *sym); 290 bool expr_depends_symbol(struct expr *dep, struct symbol *sym); 291 struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym); 292 293 void expr_fprint(struct expr *e, FILE *out); 294 struct gstr; /* forward */ 295 void expr_gstr_print(struct expr *e, struct gstr *gs); 296 void expr_gstr_print_revdep(struct expr *e, struct gstr *gs, 297 tristate pr_type, const char *title); 298 299 static inline int expr_is_yes(struct expr *e) 300 { 301 return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes); 302 } 303 304 static inline int expr_is_no(struct expr *e) 305 { 306 return e && (e->type == E_SYMBOL && e->left.sym == &symbol_no); 307 } 308 309 #ifdef __cplusplus 310 } 311 #endif 312 313 #endif /* EXPR_H */ 314