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