[mirror_ubuntu-bionic-kernel.git] / scripts / kconfig / expr.h

/*
 * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
 * Released under the terms of the GNU GPL v2.0.
 */

#ifndef EXPR_H
#define EXPR_H

#ifdef __cplusplus
extern "C" {
#endif

#include <assert.h>
#include <stdio.h>
#include "list.h"
#ifndef __cplusplus
#include <stdbool.h>
#endif

struct file {
	struct file *next;
	struct file *parent;
	const char *name;
	int lineno;
};

typedef enum tristate {
	no, mod, yes
} tristate;

enum expr_type {
	E_NONE, E_OR, E_AND, E_NOT, E_EQUAL, E_UNEQUAL, E_LIST, E_SYMBOL, E_RANGE
};

union expr_data {
	struct expr *expr;
	struct symbol *sym;
};

struct expr {
	enum expr_type type;
	union expr_data left, right;
};

#define EXPR_OR(dep1, dep2)	(((dep1)>(dep2))?(dep1):(dep2))
#define EXPR_AND(dep1, dep2)	(((dep1)<(dep2))?(dep1):(dep2))
#define EXPR_NOT(dep)		(2-(dep))

#define expr_list_for_each_sym(l, e, s) \
	for (e = (l); e && (s = e->right.sym); e = e->left.expr)

struct expr_value {
	struct expr *expr;
	tristate tri;
};

struct symbol_value {
	void *val;
	tristate tri;
};

enum symbol_type {
	S_UNKNOWN, S_BOOLEAN, S_TRISTATE, S_INT, S_HEX, S_STRING, S_OTHER
};

/* enum values are used as index to symbol.def[] */
enum {
	S_DEF_USER,		/* main user value */
	S_DEF_AUTO,		/* values read from auto.conf */
	S_DEF_DEF3,		/* Reserved for UI usage */
	S_DEF_DEF4,		/* Reserved for UI usage */
	S_DEF_COUNT
};

struct symbol {
	struct symbol *next;
	char *name;
	enum symbol_type type;
	struct symbol_value curr;
	struct symbol_value def[S_DEF_COUNT];
	tristate visible;
	int flags;
	struct property *prop;
	struct expr_value dir_dep;
	struct expr_value rev_dep;
};

#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)

#define SYMBOL_CONST      0x0001  /* symbol is const */
#define SYMBOL_CHECK      0x0008  /* used during dependency checking */
#define SYMBOL_CHOICE     0x0010  /* start of a choice block (null name) */
#define SYMBOL_CHOICEVAL  0x0020  /* used as a value in a choice block */
#define SYMBOL_VALID      0x0080  /* set when symbol.curr is calculated */
#define SYMBOL_OPTIONAL   0x0100  /* choice is optional - values can be 'n' */
#define SYMBOL_WRITE      0x0200  /* write symbol to file (KCONFIG_CONFIG) */
#define SYMBOL_CHANGED    0x0400  /* ? */
#define SYMBOL_AUTO       0x1000  /* value from environment variable */
#define SYMBOL_CHECKED    0x2000  /* used during dependency checking */
#define SYMBOL_WARNED     0x8000  /* warning has been issued */

/* Set when symbol.def[] is used */
#define SYMBOL_DEF        0x10000  /* First bit of SYMBOL_DEF */
#define SYMBOL_DEF_USER   0x10000  /* symbol.def[S_DEF_USER] is valid */
#define SYMBOL_DEF_AUTO   0x20000  /* symbol.def[S_DEF_AUTO] is valid */
#define SYMBOL_DEF3       0x40000  /* symbol.def[S_DEF_3] is valid */
#define SYMBOL_DEF4       0x80000  /* symbol.def[S_DEF_4] is valid */

/* choice values need to be set before calculating this symbol value */
#define SYMBOL_NEED_SET_CHOICE_VALUES  0x100000

/* Set symbol to y if allnoconfig; used for symbols that hide others */
#define SYMBOL_ALLNOCONFIG_Y 0x200000

#define SYMBOL_MAXLENGTH	256
#define SYMBOL_HASHSIZE		9973

/* A property represent the config options that can be associated
 * with a config "symbol".
 * Sample:
 * config FOO
 *         default y
 *         prompt "foo prompt"
 *         select BAR
 * config BAZ
 *         int "BAZ Value"
 *         range 1..255
 */
enum prop_type {
	P_UNKNOWN,
	P_PROMPT,   /* prompt "foo prompt" or "BAZ Value" */
	P_COMMENT,  /* text associated with a comment */
	P_MENU,     /* prompt associated with a menuconfig option */
	P_DEFAULT,  /* default y */
	P_CHOICE,   /* choice value */
	P_SELECT,   /* select BAR */
	P_RANGE,    /* range 7..100 (for a symbol) */
	P_ENV,      /* value from environment variable */
	P_SYMBOL,   /* where a symbol is defined */
};

struct property {
	struct property *next;     /* next property - null if last */
	struct symbol *sym;        /* the symbol for which the property is associated */
	enum prop_type type;       /* type of property */
	const char *text;          /* the prompt value - P_PROMPT, P_MENU, P_COMMENT */
	struct expr_value visible;
	struct expr *expr;         /* the optional conditional part of the property */
	struct menu *menu;         /* the menu the property are associated with
	                            * valid for: P_SELECT, P_RANGE, P_CHOICE,
	                            * P_PROMPT, P_DEFAULT, P_MENU, P_COMMENT */
	struct file *file;         /* what file was this property defined */
	int lineno;                /* what lineno was this property defined */
};

#define for_all_properties(sym, st, tok) \
	for (st = sym->prop; st; st = st->next) \
		if (st->type == (tok))
#define for_all_defaults(sym, st) for_all_properties(sym, st, P_DEFAULT)
#define for_all_choices(sym, st) for_all_properties(sym, st, P_CHOICE)
#define for_all_prompts(sym, st) \
	for (st = sym->prop; st; st = st->next) \
		if (st->text)

struct menu {
	struct menu *next;
	struct menu *parent;
	struct menu *list;
	struct symbol *sym;
	struct property *prompt;
	struct expr *visibility;
	struct expr *dep;
	unsigned int flags;
	char *help;
	struct file *file;
	int lineno;
	void *data;
};

#define MENU_CHANGED		0x0001
#define MENU_ROOT		0x0002

struct jump_key {
	struct list_head entries;
	size_t offset;
	struct menu *target;
	int index;
};

#define JUMP_NB			9

extern struct file *file_list;
extern struct file *current_file;
struct file *lookup_file(const char *name);

extern struct symbol symbol_yes, symbol_no, symbol_mod;
extern struct symbol *modules_sym;
extern struct symbol *sym_defconfig_list;
extern int cdebug;
struct expr *expr_alloc_symbol(struct symbol *sym);
struct expr *expr_alloc_one(enum expr_type type, struct expr *ce);
struct expr *expr_alloc_two(enum expr_type type, struct expr *e1, struct expr *e2);
struct expr *expr_alloc_comp(enum expr_type type, struct symbol *s1, struct symbol *s2);
struct expr *expr_alloc_and(struct expr *e1, struct expr *e2);
struct expr *expr_alloc_or(struct expr *e1, struct expr *e2);
struct expr *expr_copy(const struct expr *org);
void expr_free(struct expr *e);
int expr_eq(struct expr *e1, struct expr *e2);
void expr_eliminate_eq(struct expr **ep1, struct expr **ep2);
tristate expr_calc_value(struct expr *e);
struct expr *expr_eliminate_yn(struct expr *e);
struct expr *expr_trans_bool(struct expr *e);
struct expr *expr_eliminate_dups(struct expr *e);
struct expr *expr_transform(struct expr *e);
int expr_contains_symbol(struct expr *dep, struct symbol *sym);
bool expr_depends_symbol(struct expr *dep, struct symbol *sym);
struct expr *expr_extract_eq_and(struct expr **ep1, struct expr **ep2);
struct expr *expr_extract_eq_or(struct expr **ep1, struct expr **ep2);
void expr_extract_eq(enum expr_type type, struct expr **ep, struct expr **ep1, struct expr **ep2);
struct expr *expr_trans_compare(struct expr *e, enum expr_type type, struct symbol *sym);
struct expr *expr_simplify_unmet_dep(struct expr *e1, struct expr *e2);

void expr_fprint(struct expr *e, FILE *out);
struct gstr; /* forward */
void expr_gstr_print(struct expr *e, struct gstr *gs);

static inline int expr_is_yes(struct expr *e)
{
	return !e || (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
}

static inline int expr_is_no(struct expr *e)
{
	return e && (e->type == E_SYMBOL && e->left.sym == &symbol_no);
}

#ifdef __cplusplus
}
#endif

#endif /* EXPR_H */
Commit	Line	Data
1da177e4 LT	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
37ae2d59	13	#include <assert.h>
1da177e4	14	#include <stdio.h>
bad9955d	15	#include "list.h"
1da177e4 LT	16	#ifndef __cplusplus
	17	#include <stdbool.h>
	18	#endif
	19
	20	struct file {
	21	struct file *next;
	22	struct file *parent;
2e7a0918	23	const char *name;
1da177e4	24	int lineno;
1da177e4 LT	25	};
1da177e4 LT	26
1da177e4 LT	27	typedef enum tristate {
	28	no, mod, yes
	29	} tristate;
	30
	31	enum expr_type {
7a962923	32	E_NONE, E_OR, E_AND, E_NOT, E_EQUAL, E_UNEQUAL, E_LIST, E_SYMBOL, E_RANGE
1da177e4 LT	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
d6ee3576 SR	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))
1da177e4	48
7a962923 RZ	49	#define expr_list_for_each_sym(l, e, s) \
	50	for (e = (l); e && (s = e->right.sym); e = e->left.expr)
	51
1da177e4 LT	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
eaa2a874	66	/* enum values are used as index to symbol.def[] */
0c1822e6 RZ	67	enum {
0c1822e6 RZ	68	S_DEF_USER, /* main user value */
eaa2a874 SR	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
0c1822e6 RZ	73	};
0c1822e6 RZ	74
1da177e4 LT	75	struct symbol {
	76	struct symbol *next;
	77	char *name;
1da177e4	78	enum symbol_type type;
0c1822e6	79	struct symbol_value curr;
eaa2a874	80	struct symbol_value def[S_DEF_COUNT];
1da177e4 LT	81	tristate visible;
	82	int flags;
	83	struct property *prop;
246cf9c2	84	struct expr_value dir_dep;
1da177e4 LT	85	struct expr_value rev_dep;
	86	};
	87
e66f25d7	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)
1da177e4	89
5b2cf365 SR	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' */
31bfb108	96	#define SYMBOL_WRITE 0x0200 /* write symbol to file (KCONFIG_CONFIG) */
5b2cf365 SR	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 */
1da177e4	108
fbe98bb9 AH	109	/* choice values need to be set before calculating this symbol value */
	110	#define SYMBOL_NEED_SET_CHOICE_VALUES 0x100000
	111
5d2acfc7 JT	112	/* Set symbol to y if allnoconfig; used for symbols that hide others */
	113	#define SYMBOL_ALLNOCONFIG_Y 0x200000
	114
1da177e4	115	#define SYMBOL_MAXLENGTH 256
e66f25d7	116	#define SYMBOL_HASHSIZE 9973
1da177e4	117
cf82607a SR	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	*/
1da177e4	129	enum prop_type {
cf82607a SR	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 */
59e89e3d	139	P_SYMBOL, /* where a symbol is defined */
1da177e4 LT	140	};
	141
	142	struct property {
cf82607a SR	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 */
1da177e4	147	struct expr_value visible;
cf82607a SR	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 */
1da177e4 LT	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
	165	struct menu {
	166	struct menu *next;
	167	struct menu *parent;
	168	struct menu *list;
	169	struct symbol *sym;
	170	struct property *prompt;
86e187ff	171	struct expr *visibility;
1da177e4 LT	172	struct expr *dep;
1da177e4 LT	173	unsigned int flags;
03d29122	174	char *help;
1da177e4 LT	175	struct file *file;
	176	int lineno;
	177	void *data;
	178	};
	179
	180	#define MENU_CHANGED 0x0001
	181	#define MENU_ROOT 0x0002
	182
95ac9b3b	183	struct jump_key {
bad9955d	184	struct list_head entries;
95ac9b3b BP	185	size_t offset;
	186	struct menu *target;
	187	int index;
	188	};
95ac9b3b	189
5e609add BP	190	#define JUMP_NB 9
5e609add BP	191
1da177e4 LT	192	extern struct file *file_list;
	193	extern struct file *current_file;
	194	struct file lookup_file(const char name);
	195
	196	extern struct symbol symbol_yes, symbol_no, symbol_mod;
	197	extern struct symbol *modules_sym;
face4374	198	extern struct symbol *sym_defconfig_list;
1da177e4 LT	199	extern int cdebug;
	200	struct expr expr_alloc_symbol(struct symbol sym);
	201	struct expr expr_alloc_one(enum expr_type type, struct expr ce);
	202	struct expr expr_alloc_two(enum expr_type type, struct expr e1, struct expr *e2);
	203	struct expr expr_alloc_comp(enum expr_type type, struct symbol s1, struct symbol *s2);
	204	struct expr expr_alloc_and(struct expr e1, struct expr *e2);
	205	struct expr expr_alloc_or(struct expr e1, struct expr *e2);
17742dc7	206	struct expr expr_copy(const struct expr org);
1da177e4 LT	207	void expr_free(struct expr *e);
	208	int expr_eq(struct expr e1, struct expr e2);
	209	void expr_eliminate_eq(struct expr ep1, struct expr ep2);
	210	tristate expr_calc_value(struct expr *e);
	211	struct expr expr_eliminate_yn(struct expr e);
	212	struct expr expr_trans_bool(struct expr e);
	213	struct expr expr_eliminate_dups(struct expr e);
	214	struct expr expr_transform(struct expr e);
	215	int expr_contains_symbol(struct expr dep, struct symbol sym);
	216	bool expr_depends_symbol(struct expr dep, struct symbol sym);
	217	struct expr expr_extract_eq_and(struct expr ep1, struct expr *ep2);
	218	struct expr expr_extract_eq_or(struct expr ep1, struct expr *ep2);
	219	void expr_extract_eq(enum expr_type type, struct expr ep, struct expr ep1, struct expr **ep2);
	220	struct expr expr_trans_compare(struct expr e, enum expr_type type, struct symbol *sym);
0597fcd0	221	struct expr expr_simplify_unmet_dep(struct expr e1, struct expr *e2);
1da177e4 LT	222
	223	void expr_fprint(struct expr e, FILE out);
	224	struct gstr; /* forward */
	225	void expr_gstr_print(struct expr e, struct gstr gs);
	226
	227	static inline int expr_is_yes(struct expr *e)
	228	{
	229	return !e \|\| (e->type == E_SYMBOL && e->left.sym == &symbol_yes);
	230	}
	231
	232	static inline int expr_is_no(struct expr *e)
	233	{
	234	return e && (e->type == E_SYMBOL && e->left.sym == &symbol_no);
	235	}
1da177e4 LT	236
	237	#ifdef __cplusplus
	238	}
	239	#endif
	240
	241	#endif /* EXPR_H */