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