xref: /linux/scripts/kconfig/lkc.h (revision 68e5c7d4cefb66de3953a874e670ec8f1ce86a24)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2002 Roman Zippel <zippel@linux-m68k.org>
4  */
5 
6 #ifndef LKC_H
7 #define LKC_H
8 
9 #include <assert.h>
10 #include <stdio.h>
11 #include <stdlib.h>
12 
13 #include "expr.h"
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 #include "lkc_proto.h"
20 
21 #define SRCTREE "srctree"
22 
23 #ifndef CONFIG_
24 #define CONFIG_ "CONFIG_"
25 #endif
26 static inline const char *CONFIG_prefix(void)
27 {
28 	return getenv( "CONFIG_" ) ?: CONFIG_;
29 }
30 #undef CONFIG_
31 #define CONFIG_ CONFIG_prefix()
32 
33 extern int yylineno;
34 void zconfdump(FILE *out);
35 void zconf_starthelp(void);
36 FILE *zconf_fopen(const char *name);
37 void zconf_initscan(const char *name);
38 void zconf_nextfile(const char *name);
39 
40 /* confdata.c */
41 extern struct gstr autoconf_cmd;
42 const char *conf_get_configname(void);
43 
44 /* confdata.c and expr.c */
45 static inline void xfwrite(const void *str, size_t len, size_t count, FILE *out)
46 {
47 	assert(len != 0);
48 
49 	if (fwrite(str, len, count, out) != count)
50 		fprintf(stderr, "Error in writing or end of file.\n");
51 }
52 
53 /* util.c */
54 const char *file_lookup(const char *name);
55 
56 /* lexer.l */
57 int yylex(void);
58 
59 struct gstr {
60 	size_t len;
61 	char  *s;
62 	/*
63 	* when max_width is not zero long lines in string s (if any) get
64 	* wrapped not to exceed the max_width value
65 	*/
66 	int max_width;
67 };
68 struct gstr str_new(void);
69 void str_free(struct gstr *gs);
70 void str_append(struct gstr *gs, const char *s);
71 void str_printf(struct gstr *gs, const char *fmt, ...);
72 char *str_get(const struct gstr *gs);
73 
74 /* menu.c */
75 struct menu *menu_next(struct menu *menu, struct menu *root);
76 #define menu_for_each_sub_entry(menu, root) \
77 	for (menu = menu_next(root, root); menu; menu = menu_next(menu, root))
78 #define menu_for_each_entry(menu) \
79 	menu_for_each_sub_entry(menu, &rootmenu)
80 void _menu_init(void);
81 void menu_warn(const struct menu *menu, const char *fmt, ...);
82 struct menu *menu_add_menu(void);
83 void menu_end_menu(void);
84 void menu_add_entry(struct symbol *sym);
85 void menu_add_dep(struct expr *dep);
86 void menu_add_visibility(struct expr *dep);
87 struct property *menu_add_prompt(enum prop_type type, const char *prompt,
88 				 struct expr *dep);
89 void menu_add_expr(enum prop_type type, struct expr *expr, struct expr *dep);
90 void menu_add_symbol(enum prop_type type, struct symbol *sym, struct expr *dep);
91 void menu_finalize(void);
92 void menu_set_type(int type);
93 
94 extern struct menu rootmenu;
95 
96 bool menu_is_empty(struct menu *menu);
97 bool menu_is_visible(struct menu *menu);
98 bool menu_has_prompt(const struct menu *menu);
99 const char *menu_get_prompt(const struct menu *menu);
100 struct menu *menu_get_parent_menu(struct menu *menu);
101 int get_jump_key_char(void);
102 struct gstr get_relations_str(struct symbol **sym_arr, struct list_head *head);
103 void menu_get_ext_help(struct menu *menu, struct gstr *help);
104 
105 /* symbol.c */
106 void sym_clear_all_valid(void);
107 struct symbol *sym_choice_default(struct menu *choice);
108 struct symbol *sym_calc_choice(struct menu *choice);
109 struct property *sym_get_range_prop(struct symbol *sym);
110 const char *sym_get_string_default(struct symbol *sym);
111 struct symbol *sym_check_deps(struct symbol *sym);
112 struct symbol *prop_get_symbol(const struct property *prop);
113 
114 static inline tristate sym_get_tristate_value(const struct symbol *sym)
115 {
116 	return sym->curr.tri;
117 }
118 
119 static inline bool sym_is_choice(const struct symbol *sym)
120 {
121 	/* A choice is a symbol with no name */
122 	return sym->name == NULL;
123 }
124 
125 bool sym_is_choice_value(const struct symbol *sym);
126 
127 static inline bool sym_has_value(const struct symbol *sym)
128 {
129 	return sym->flags & SYMBOL_DEF_USER ? true : false;
130 }
131 
132 #ifdef __cplusplus
133 }
134 #endif
135 
136 #endif /* LKC_H */
137