scripts/kconfig/expr.h

   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 {
  32         E_NONE, E_OR, E_AND, E_NOT, E_EQUAL, E_UNEQUAL, E_LIST, E_SYMBOL, E_RANGE
  33 };
  34
  35 union expr_data {
  36         struct expr *expr;
  37         struct symbol *sym;
  38 };
  39
  40 struct expr {
  41         enum expr_type type;
  42         union expr_data left, right;
  43 };
  44
  45 #define EXPR_OR(dep1, dep2)     (((dep1)>(dep2))?(dep1):(dep2))
  46 #define EXPR_AND(dep1, dep2)    (((dep1)<(dep2))?(dep1):(dep2))
  47 #define EXPR_NOT(dep)           (2-(dep))
  48
  49 #define expr_list_for_each_sym(l, e, s) \
  50         for (e = (l); e && (s = e->right.sym); e = e->left.expr)
  51
  52 struct expr_value {
  53         struct expr *expr;
  54         tristate tri;
  55 };
  56
  57 struct symbol_value {
  58         void *val;
  59         tristate tri;
  60 };
  61
  62 enum symbol_type {
  63         S_UNKNOWN, S_BOOLEAN, S_TRISTATE, S_INT, S_HEX, S_STRING, S_OTHER
  64 };
  65
  66 /* enum values are used as index to symbol.def[] */
  67 enum {
  68         S_DEF_USER,             /* main user value */
  69         S_DEF_AUTO,             /* values read from auto.conf */
  70         S_DEF_DEF3,             /* Reserved for UI usage */
  71         S_DEF_DEF4,             /* Reserved for UI usage */
  72         S_DEF_COUNT
  73 };
  74
  75 struct symbol {
  76         struct symbol *next;
  77         char *name;
  78         enum symbol_type type;
  79         struct symbol_value curr;
  80         struct symbol_value def[S_DEF_COUNT];
  81         tristate visible;
  82         int flags;
  83         struct property *prop;
  84         struct expr_value dir_dep;
  85         struct expr_value rev_dep;
  86 };
  87
  88 #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)
  89
  90 #define SYMBOL_CONST      0x0001  /* symbol is const */
  91 #define SYMBOL_CHECK      0x0008  /* used during dependency checking */
  92 #define SYMBOL_CHOICE     0x0010  /* start of a choice block (null name) */
  93 #define SYMBOL_CHOICEVAL  0x0020  /* used as a value in a choice block */
  94 #define SYMBOL_VALID      0x0080  /* set when symbol.curr is calculated */
  95 #define SYMBOL_OPTIONAL   0x0100  /* choice is optional - values can be 'n' */
  96 #define SYMBOL_WRITE      0x0200  /* write symbol to file (KCONFIG_CONFIG) */
  97 #define SYMBOL_CHANGED    0x0400  /* ? */
  98 #define SYMBOL_AUTO       0x1000  /* value from environment variable */
  99 #define SYMBOL_CHECKED    0x2000  /* used during dependency checking */
 100 #define SYMBOL_WARNED     0x8000  /* warning has been issued */
 101
 102 /* Set when symbol.def[] is used */
 103 #define SYMBOL_DEF        0x10000  /* First bit of SYMBOL_DEF */
 104 #define SYMBOL_DEF_USER   0x10000  /* symbol.def[S_DEF_USER] is valid */
 105 #define SYMBOL_DEF_AUTO   0x20000  /* symbol.def[S_DEF_AUTO] is valid */
 106 #define SYMBOL_DEF3       0x40000  /* symbol.def[S_DEF_3] is valid */
 107 #define SYMBOL_DEF4       0x80000  /* symbol.def[S_DEF_4] is valid */
 108
 109 /* choice values need to be set before calculating this symbol value */
 110 #define SYMBOL_NEED_SET_CHOICE_VALUES  0x100000
 111
 112 #define SYMBOL_MAXLENGTH        256
 113 #define SYMBOL_HASHSIZE         9973
 114
 115 /* A property represent the config options that can be associated
 116  * with a config "symbol".
 117  * Sample:
 118  * config FOO
 119  *         default y
 120  *         prompt "foo prompt"
 121  *         select BAR
 122  * config BAZ
 123  *         int "BAZ Value"
 124  *         range 1..255
 125  */
 126 enum prop_type {
 127         P_UNKNOWN,
 128         P_PROMPT,   /* prompt "foo prompt" or "BAZ Value" */
 129         P_COMMENT,  /* text associated with a comment */
 130         P_MENU,     /* prompt associated with a menuconfig option */
 131         P_DEFAULT,  /* default y */
 132         P_CHOICE,   /* choice value */
 133         P_SELECT,   /* select BAR */
 134         P_RANGE,    /* range 7..100 (for a symbol) */
 135         P_ENV,      /* value from environment variable */
 136         P_SYMBOL,   /* where a symbol is defined */
 137 };
 138
 139 struct property {
 140         struct property *next;     /* next property - null if last */
 141         struct symbol *sym;        /* the symbol for which the property is associated */
 142         enum prop_type type;       /* type of property */
 143         const char *text;          /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */
 144         struct expr_value visible;
 145         struct expr *expr;         /* the optional conditional part of the property */
 146         struct menu *menu;         /* the menu the property are associated with
 147                                     * valid for: P_SELECT, P_RANGE, P_CHOICE,
 148                                     * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */
 149         struct file *file;         /* what file was this property defined */
 150         int lineno;                /* what lineno was this property defined */
 151 };
 152
 153 #define for_all_properties(sym, st, tok) \
 154         for (st = sym->prop; st; st = st->next) \
 155                 if (st->type == (tok))
 156 #define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT)
 157 #define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE)
 158 #define for_all_prompts(sym, st) \
 159         for (st = sym->prop; st; st = st->next) \
 160                 if (st->text)
 161
 162 struct menu {
 163         struct menu *next;
 164         struct menu *parent;
 165         struct menu *list;
 166         struct symbol *sym;
 167         struct property *prompt;
 168         struct expr *visibility;
 169         struct expr *dep;
 170         unsigned int flags;
 171         char *help;
 172         struct file *file;
 173         int lineno;
 174         void *data;
 175 };
 176
 177 #define MENU_CHANGED            0x0001
 178 #define MENU_ROOT               0x0002
 179
 180 struct jump_key {
 181         struct list_head entries;
 182         size_t offset;
 183         struct menu *target;
 184         int index;
 185 };
 186
 187 #define JUMP_NB                 9
 188
 189 extern struct file *file_list;
 190 extern struct file *current_file;
 191 struct file *lookup_file(const char *name);
 192
 193 extern struct symbol symbol_yes, symbol_no, symbol_mod;
 194 extern struct symbol *modules_sym;
 195 extern struct symbol *sym_defconfig_list;
 196 extern int cdebug;
 197 struct expr *expr_alloc_symbol(struct symbol *sym);
 198 struct expr *expr_alloc_one(enum expr_type type, struct expr *ce);
 199 struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2);
 200 struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2);
 201 struct expr *expr_alloc_and(struct expr *e1, struct expr *e2);
 202 struct expr *expr_alloc_or(struct expr *e1, struct expr *e2);
 203 struct expr *expr_copy(const struct expr *org);
 204 void expr_free(struct expr *e);
 205 int expr_eq(struct expr *e1, struct expr *e2);
 206 void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
 207 tristate expr_calc_value(struct expr *e);
 208 struct expr *expr_eliminate_yn(struct expr *e);
 209 struct expr *expr_trans_bool(struct expr *e);
 210 struct expr *expr_eliminate_dups(struct expr *e);
 211 struct expr *expr_transform(struct expr *e);
 212 int expr_contains_symbol(struct expr *dep, struct symbol *sym);
 213 bool expr_depends_symbol(struct expr *dep, struct symbol *sym);
 214 struct expr *expr_extract_eq_and(struct expr **ep1, struct expr **ep2);
 215 struct expr *expr_extract_eq_or(struct expr **ep1, struct expr **ep2);
 216 void expr_extract_eq(enum expr_type type, struct expr **ep, struct expr **ep1, struct expr **ep2);
 217 struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym);
 218 struct expr *expr_simplify_unmet_dep(struct expr *e1, struct expr *e2);
 219
 220 void expr_fprint(struct expr *e, FILE *out);
 221 struct gstr; /* forward */
 222 void expr_gstr_print(struct expr *e, struct gstr *gs);
 223
 224 static inline int expr_is_yes(struct expr *e)
 225 {
 226         return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
 227 }
 228
 229 static inline int expr_is_no(struct expr *e)
 230 {
 231         return e && (e->type == E_SYMBOL && e->left.sym == &symbol_no);
 232 }
 233
 234 #ifdef __cplusplus
 235 }
 236 #endif
 237
 238 #endif /* EXPR_H */