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