1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org> 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 with null name. 76 */ 77 struct symbol { 78 /* link node for the hash table */ 79 struct hlist_node node; 80 81 /* The name of the symbol, e.g. "FOO" for 'config FOO' */ 82 char *name; 83 84 /* S_BOOLEAN, S_TRISTATE, ... */ 85 enum symbol_type type; 86 87 /* 88 * The calculated value of the symbol. The SYMBOL_VALID bit is set in 89 * 'flags' when this is up to date. Note that this value might differ 90 * from the user value set in e.g. a .config file, due to visibility. 91 */ 92 struct symbol_value curr; 93 94 /* 95 * Values for the symbol provided from outside. def[S_DEF_USER] holds 96 * the .config value. 97 */ 98 struct symbol_value def[S_DEF_COUNT]; 99 100 /* 101 * An upper bound on the tristate value the user can set for the symbol 102 * if it is a boolean or tristate. Calculated from prompt dependencies, 103 * which also inherit dependencies from enclosing menus, choices, and 104 * ifs. If 'n', the user value will be ignored. 105 * 106 * Symbols lacking prompts always have visibility 'n'. 107 */ 108 tristate visible; 109 110 /* config entries associated with this symbol */ 111 struct list_head menus; 112 113 /* SYMBOL_* flags */ 114 int flags; 115 116 /* List of properties. See prop_type. */ 117 struct property *prop; 118 119 /* Dependencies from enclosing menus, choices, and ifs */ 120 struct expr_value dir_dep; 121 122 /* Reverse dependencies through being selected by other symbols */ 123 struct expr_value rev_dep; 124 125 /* 126 * "Weak" reverse dependencies through being implied by other symbols 127 */ 128 struct expr_value implied; 129 }; 130 131 #define SYMBOL_CONST 0x0001 /* symbol is const */ 132 #define SYMBOL_CHECK 0x0008 /* used during dependency checking */ 133 #define SYMBOL_CHOICEVAL 0x0020 /* used as a value in a choice block */ 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_CHANGED 0x0400 /* ? */ 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 /* choice values need to be set before calculating this symbol value */ 149 #define SYMBOL_NEED_SET_CHOICE_VALUES 0x100000 150 151 #define SYMBOL_MAXLENGTH 256 152 153 /* A property represent the config options that can be associated 154 * with a config "symbol". 155 * Sample: 156 * config FOO 157 * default y 158 * prompt "foo prompt" 159 * select BAR 160 * config BAZ 161 * int "BAZ Value" 162 * range 1..255 163 * 164 * Please, also check parser.y:print_symbol() when modifying the 165 * list of property types! 166 */ 167 enum prop_type { 168 P_UNKNOWN, 169 P_PROMPT, /* prompt "foo prompt" or "BAZ Value" */ 170 P_COMMENT, /* text associated with a comment */ 171 P_MENU, /* prompt associated with a menu or menuconfig symbol */ 172 P_DEFAULT, /* default y */ 173 P_CHOICE, /* choice value */ 174 P_SELECT, /* select BAR */ 175 P_IMPLY, /* imply BAR */ 176 P_RANGE, /* range 7..100 (for a symbol) */ 177 P_SYMBOL, /* where a symbol is defined */ 178 }; 179 180 struct property { 181 struct property *next; /* next property - null if last */ 182 enum prop_type type; /* type of property */ 183 const char *text; /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */ 184 struct expr_value visible; 185 struct expr *expr; /* the optional conditional part of the property */ 186 struct menu *menu; /* the menu the property are associated with 187 * valid for: P_SELECT, P_RANGE, P_CHOICE, 188 * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */ 189 const char *filename; /* what file was this property defined */ 190 int lineno; /* what lineno was this property defined */ 191 }; 192 193 #define for_all_properties(sym, st, tok) \ 194 for (st = sym->prop; st; st = st->next) \ 195 if (st->type == (tok)) 196 #define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT) 197 #define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE) 198 #define for_all_prompts(sym, st) \ 199 for (st = sym->prop; st; st = st->next) \ 200 if (st->text) 201 202 /* 203 * Represents a node in the menu tree, as seen in e.g. menuconfig (though used 204 * for all front ends). Each symbol, menu, etc. defined in the Kconfig files 205 * gets a node. A symbol defined in multiple locations gets one node at each 206 * location. 207 */ 208 struct menu { 209 /* The next menu node at the same level */ 210 struct menu *next; 211 212 /* The parent menu node, corresponding to e.g. a menu or choice */ 213 struct menu *parent; 214 215 /* The first child menu node, for e.g. menus and choices */ 216 struct menu *list; 217 218 /* 219 * The symbol associated with the menu node. Choices are implemented as 220 * a special kind of symbol. NULL for menus, comments, and ifs. 221 */ 222 struct symbol *sym; 223 224 struct list_head link; /* link to symbol::menus */ 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