discover/grub2: Add support for for-loops
[petitboot] / discover / grub2 / grub2.h
1 #ifndef GRUB2_H
2 #define GRUB2_H
3
4 #include <discover/device-handler.h>
5
6 #include <stdbool.h>
7 #include <list/list.h>
8
9 struct grub2_script;
10
11 struct grub2_word {
12         enum {
13                 GRUB2_WORD_TEXT,
14                 GRUB2_WORD_VAR,
15         } type;
16         union {
17                 char            *text;
18                 const char      *name;
19         };
20         bool                    split;
21         struct grub2_word       *next;
22         struct grub2_word       *last;
23         struct list_item        argv_list;
24 };
25
26 struct grub2_argv {
27         struct list             words;
28
29         /* postprocessing (with process_expansions) populates these to hand to
30          * the grub2_command callbacks */
31         char                    **argv;
32         int                     argc;
33 };
34
35 struct grub2_statements {
36         struct list             list;
37 };
38
39 struct grub2_statement {
40         struct list_item        list;
41         enum {
42                 STMT_TYPE_SIMPLE,
43                 STMT_TYPE_MENUENTRY,
44                 STMT_TYPE_IF,
45                 STMT_TYPE_BLOCK,
46                 STMT_TYPE_CONDITIONAL,
47         } type;
48         int                     (*exec)(struct grub2_script *,
49                                         struct grub2_statement *);
50 };
51
52 struct grub2_statement_simple {
53         struct grub2_statement  st;
54         struct grub2_argv       *argv;
55 };
56
57 struct grub2_statement_menuentry {
58         struct grub2_statement  st;
59         struct grub2_argv       *argv;
60         struct grub2_statements *statements;
61 };
62
63 struct grub2_statement_conditional {
64         struct grub2_statement  st;
65         struct grub2_statement  *condition;
66         struct grub2_statements *statements;
67 };
68
69 struct grub2_statement_if {
70         struct grub2_statement  st;
71         struct grub2_statements *conditionals;
72         struct grub2_statements *else_case;
73 };
74
75 struct grub2_statement_block {
76         struct grub2_statement  st;
77         struct grub2_statements *statements;
78 };
79
80 struct grub2_statement_function {
81         struct grub2_statement  st;
82         struct grub2_word       *name;
83         struct grub2_statements *body;
84 };
85
86 struct grub2_statement_for {
87         struct grub2_statement  st;
88         struct grub2_word       *var;
89         struct grub2_argv       *list;
90         struct grub2_statements *body;
91 };
92
93 struct grub2_script {
94         struct grub2_statements         *statements;
95         struct list                     environment;
96         struct list                     symtab;
97         struct discover_context         *ctx;
98         struct discover_boot_option     *opt;
99         const char                      *filename;
100         unsigned int                    n_options;
101 };
102
103 struct grub2_parser {
104         void                    *scanner;
105         struct grub2_script     *script;
106 };
107
108 /* type for builtin functions */
109 typedef int (*grub2_function)(struct grub2_script *script, void *data,
110                                 int argc, char *argv[]);
111
112 struct grub2_statements *create_statements(struct grub2_parser *parser);
113
114 struct grub2_statement *create_statement_simple(struct grub2_parser *parser,
115                 struct grub2_argv *argv);
116
117 struct grub2_statement *create_statement_menuentry(struct grub2_parser *parser,
118                 struct grub2_argv *argv, struct grub2_statements *stmts);
119
120 struct grub2_statement *create_statement_conditional(
121                 struct grub2_parser *parser, struct grub2_statement *condition,
122                 struct grub2_statements *statements);
123
124 struct grub2_statement *create_statement_if(struct grub2_parser *parser,
125                 struct grub2_statement *conditional,
126                 struct grub2_statements *elifs,
127                 struct grub2_statements *else_case);
128
129 struct grub2_statement *create_statement_block(struct grub2_parser *parser,
130                 struct grub2_statements *stmts);
131
132 struct grub2_statement *create_statement_function(struct grub2_parser *parser,
133                 struct grub2_word *name, struct grub2_statements *body);
134
135 struct grub2_statement *create_statement_for(struct grub2_parser *parser,
136                 struct grub2_word *var, struct grub2_argv *list,
137                 struct grub2_statements *body);
138
139 struct grub2_word *create_word_text(struct grub2_parser *parser,
140                 const char *text);
141
142 struct grub2_word *create_word_var(struct grub2_parser *parser,
143                 const char *name, bool split);
144
145 struct grub2_argv *create_argv(struct grub2_parser *parser);
146
147 void statement_append(struct grub2_statements *stmts,
148                 struct grub2_statement *stmt);
149
150 void argv_append(struct grub2_argv *argv, struct grub2_word *word);
151
152 void word_append(struct grub2_word *w1, struct grub2_word *w2);
153
154 /* script interface */
155 void script_execute(struct grub2_script *script);
156
157 int statement_simple_execute(struct grub2_script *script,
158                 struct grub2_statement *statement);
159 int statement_block_execute(struct grub2_script *script,
160                 struct grub2_statement *statement);
161 int statement_if_execute(struct grub2_script *script,
162                 struct grub2_statement *statement);
163 int statement_menuentry_execute(struct grub2_script *script,
164                 struct grub2_statement *statement);
165 int statement_function_execute(struct grub2_script *script,
166                 struct grub2_statement *statement);
167 int statement_for_execute(struct grub2_script *script,
168                 struct grub2_statement *statement);
169
170 struct grub2_script *create_script(struct grub2_parser *parser,
171                 struct discover_context *ctx);
172
173 const char *script_env_get(struct grub2_script *script, const char *name);
174
175 void script_env_set(struct grub2_script *script,
176                 const char *name, const char *value);
177
178 void script_register_function(struct grub2_script *script,
179                 const char *name, grub2_function fn, void *data);
180
181 void register_builtins(struct grub2_script *script);
182
183 /* resources */
184 struct resource *create_grub2_resource(struct discover_boot_option *opt,
185                 struct discover_device *orig_device,
186                 const char *root, const char *path);
187
188 bool resolve_grub2_resource(struct device_handler *handler,
189                 struct resource *res);
190
191 /* external parser api */
192 struct grub2_parser *grub2_parser_create(struct discover_context *ctx);
193 void grub2_parser_parse(struct grub2_parser *parser, const char *filename,
194                 char *buf, int len);
195 #endif /* GRUB2_H */
196