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