LXR linux/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
  10extern "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
  20struct file {
  21        struct file *next;
  22        struct file *parent;
  23        const char *name;
  24        int lineno;
  25};
  26
  27typedef enum tristate {
  28        no, mod, yes
  29} tristate;
  30
  31enum expr_type {
  32        E_NONE, E_OR, E_AND, E_NOT, E_EQUAL, E_UNEQUAL, E_LIST, E_SYMBOL, E_RANGE
  33};
  34
  35union expr_data {
  36        struct expr *expr;
  37        struct symbol *sym;
  38};
  39
  40struct 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
  52struct expr_value {
  53        struct expr *expr;
  54        tristate tri;
  55};
  56
  57struct symbol_value {
  58        void *val;
  59        tristate tri;
  60};
  61
  62enum 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[] */
  67enum {
  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
  75struct 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  /* ? */
  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#define SYMBOL_MAXLENGTH        256
 110#define SYMBOL_HASHSIZE         9973
 111
 112/* A property represent the config options that can be associated
 113 * with a config "symbol".
 114 * Sample:
 115 * config FOO
 116 *         default y
 117 *         prompt "foo prompt"
 118 *         select BAR
 119 * config BAZ
 120 *         int "BAZ Value"
 121 *         range 1..255
 122 */
 123enum prop_type {
 124        P_UNKNOWN,
 125        P_PROMPT,   /* prompt "foo prompt" or "BAZ Value" */
 126        P_COMMENT,  /* text associated with a comment */
 127        P_MENU,     /* prompt associated with a menuconfig option */
 128        P_DEFAULT,  /* default y */
 129        P_CHOICE,   /* choice value */
 130        P_SELECT,   /* select BAR */
 131        P_RANGE,    /* range 7..100 (for a symbol) */
 132        P_ENV,      /* value from environment variable */
 133        P_SYMBOL,   /* where a symbol is defined */
 134};
 135
 136struct property {
 137        struct property *next;     /* next property - null if last */
 138        struct symbol *sym;        /* the symbol for which the property is associated */
 139        enum prop_type type;       /* type of property */
 140        const char *text;          /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */
 141        struct expr_value visible;
 142        struct expr *expr;         /* the optional conditional part of the property */
 143        struct menu *menu;         /* the menu the property are associated with
 144                                    * valid for: P_SELECT, P_RANGE, P_CHOICE,
 145                                    * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */
 146        struct file *file;         /* what file was this property defined */
 147        int lineno;                /* what lineno was this property defined */
 148};
 149
 150#define for_all_properties(sym, st, tok) \
 151        for (st = sym->prop; st; st = st->next) \
 152                if (st->type == (tok))
 153#define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT)
 154#define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE)
 155#define for_all_prompts(sym, st) \
 156        for (st = sym->prop; st; st = st->next) \
 157                if (st->text)
 158
 159struct menu {
 160        struct menu *next;
 161        struct menu *parent;
 162        struct menu *list;
 163        struct symbol *sym;
 164        struct property *prompt;
 165        struct expr *visibility;
 166        struct expr *dep;
 167        unsigned int flags;
 168        char *help;
 169        struct file *file;
 170        int lineno;
 171        void *data;
 172};
 173
 174#define MENU_CHANGED            0x0001
 175#define MENU_ROOT               0x0002
 176
 177struct jump_key {
 178        struct list_head entries;
 179        size_t offset;
 180        struct menu *target;
 181        int index;
 182};
 183
 184#define JUMP_NB                 9
 185
 186extern struct file *file_list;
 187extern struct file *current_file;
 188struct file *lookup_file(const char *name);
 189
 190extern struct symbol symbol_yes, symbol_no, symbol_mod;
 191extern struct symbol *modules_sym;
 192extern struct symbol *sym_defconfig_list;
 193extern int cdebug;
 194struct expr *expr_alloc_symbol(struct symbol *sym);
 195struct expr *expr_alloc_one(enum expr_type type, struct expr *ce);
 196struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2);
 197struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2);
 198struct expr *expr_alloc_and(struct expr *e1, struct expr *e2);
 199struct expr *expr_alloc_or(struct expr *e1, struct expr *e2);
 200struct expr *expr_copy(const struct expr *org);
 201void expr_free(struct expr *e);
 202int expr_eq(struct expr *e1, struct expr *e2);
 203void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
 204tristate expr_calc_value(struct expr *e);
 205struct expr *expr_eliminate_yn(struct expr *e);
 206struct expr *expr_trans_bool(struct expr *e);
 207struct expr *expr_eliminate_dups(struct expr *e);
 208struct expr *expr_transform(struct expr *e);
 209int expr_contains_symbol(struct expr *dep, struct symbol *sym);
 210bool expr_depends_symbol(struct expr *dep, struct symbol *sym);
 211struct expr *expr_extract_eq_and(struct expr **ep1, struct expr **ep2);
 212struct expr *expr_extract_eq_or(struct expr **ep1, struct expr **ep2);
 213void expr_extract_eq(enum expr_type type, struct expr **ep, struct expr **ep1, struct expr **ep2);
 214struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym);
 215struct expr *expr_simplify_unmet_dep(struct expr *e1, struct expr *e2);
 216
 217void expr_fprint(struct expr *e, FILE *out);
 218struct gstr; /* forward */
 219void expr_gstr_print(struct expr *e, struct gstr *gs);
 220
 221static inline int expr_is_yes(struct expr *e)
 222{
 223        return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
 224}
 225
 226static inline int expr_is_no(struct expr *e)
 227{
 228        return e && (e->type == E_SYMBOL && e->left.sym == &symbol_no);
 229}
 230
 231#ifdef __cplusplus
 232}
 233#endif
 234
 235#endif /* EXPR_H */
 236