altos/lisp: Evaluate macros once, then smash them into place
[fw/altos] / src / lisp / ao_lisp_make_const.c
1 /*
2  * Copyright © 2016 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  */
14
15 #include "ao_lisp.h"
16 #include <stdlib.h>
17 #include <ctype.h>
18 #include <unistd.h>
19 #include <getopt.h>
20
21 static struct ao_lisp_builtin *
22 ao_lisp_make_builtin(enum ao_lisp_builtin_id func, int args) {
23         struct ao_lisp_builtin *b = ao_lisp_alloc(sizeof (struct ao_lisp_builtin));
24
25         b->type = AO_LISP_BUILTIN;
26         b->func = func;
27         b->args = args;
28         return b;
29 }
30
31 struct builtin_func {
32         char    *name;
33         int     args;
34         int     func;
35 };
36
37 struct builtin_func funcs[] = {
38         { .name = "eval",       .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_eval },
39         { .name = "read",       .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_read },
40         { .name = "lambda",     .args = AO_LISP_FUNC_NLAMBDA,   .func = builtin_lambda },
41         { .name = "lexpr",      .args = AO_LISP_FUNC_NLAMBDA,   .func = builtin_lexpr },
42         { .name = "nlambda",    .args = AO_LISP_FUNC_NLAMBDA,   .func = builtin_nlambda },
43         { .name = "macro",      .args = AO_LISP_FUNC_NLAMBDA,   .func = builtin_macro },
44         { .name = "car",        .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_car },
45         { .name = "cdr",        .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_cdr },
46         { .name = "cons",       .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_cons },
47         { .name = "last",       .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_last },
48         { .name = "length",     .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_length },
49         { .name = "quote",      .args = AO_LISP_FUNC_NLAMBDA,   .func = builtin_quote },
50         { .name = "set",        .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_set },
51         { .name = "setq",       .args = AO_LISP_FUNC_MACRO,     .func = builtin_setq },
52         { .name = "cond",       .args = AO_LISP_FUNC_NLAMBDA,   .func = builtin_cond },
53         { .name = "progn",      .args = AO_LISP_FUNC_NLAMBDA,   .func = builtin_progn },
54         { .name = "while",      .args = AO_LISP_FUNC_NLAMBDA,   .func = builtin_while },
55         { .name = "print",      .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_print },
56         { .name = "patom",      .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_patom },
57         { .name = "+",          .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_plus },
58         { .name = "-",          .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_minus },
59         { .name = "*",          .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_times },
60         { .name = "/",          .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_divide },
61         { .name = "%",          .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_mod },
62         { .name = "=",          .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_equal },
63         { .name = "<",          .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_less },
64         { .name = ">",          .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_greater },
65         { .name = "<=",         .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_less_equal },
66         { .name = ">=",         .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_greater_equal },
67         { .name = "pack",       .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_pack },
68         { .name = "unpack",     .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_unpack },
69         { .name = "flush",      .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_flush },
70         { .name = "delay",      .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_delay },
71         { .name = "led",        .args = AO_LISP_FUNC_F_LEXPR,   .func = builtin_led },
72         { .name = "save",       .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_save },
73         { .name = "restore",    .args = AO_LISP_FUNC_F_LAMBDA,  .func = builtin_restore },
74 };
75
76 #define N_FUNC (sizeof funcs / sizeof funcs[0])
77
78 struct ao_lisp_frame    *globals;
79
80 static int
81 is_atom(int offset)
82 {
83         struct ao_lisp_atom *a;
84
85         for (a = ao_lisp_atoms; a; a = ao_lisp_poly_atom(a->next))
86                 if (((uint8_t *) a->name - ao_lisp_const) == offset)
87                         return strlen(a->name);
88         return 0;
89 }
90
91 #define AO_FEC_CRC_INIT 0xffff
92
93 static inline uint16_t
94 ao_fec_crc_byte(uint8_t byte, uint16_t crc)
95 {
96         uint8_t bit;
97
98         for (bit = 0; bit < 8; bit++) {
99                 if (((crc & 0x8000) >> 8) ^ (byte & 0x80))
100                         crc = (crc << 1) ^ 0x8005;
101                 else
102                         crc = (crc << 1);
103                 byte <<= 1;
104         }
105         return crc;
106 }
107
108 uint16_t
109 ao_fec_crc(const uint8_t *bytes, uint8_t len)
110 {
111         uint16_t        crc = AO_FEC_CRC_INIT;
112
113         while (len--)
114                 crc = ao_fec_crc_byte(*bytes++, crc);
115         return crc;
116 }
117
118 int
119 ao_is_macro(ao_poly p)
120 {
121         struct ao_lisp_builtin  *builtin;
122         struct ao_lisp_lambda   *lambda;
123
124 //      printf ("macro scanning "); ao_lisp_poly_print(p); printf("\n");
125         switch (ao_lisp_poly_type(p)) {
126         case AO_LISP_ATOM:
127                 return ao_is_macro(ao_lisp_atom_get(p));
128         case AO_LISP_BUILTIN:
129                 builtin = ao_lisp_poly_builtin(p);
130                 if ((builtin->args & AO_LISP_FUNC_MASK) == AO_LISP_FUNC_MACRO)
131                         return 1;
132                 return 0;
133         case AO_LISP_LAMBDA:
134                 lambda = ao_lisp_poly_lambda(p);
135                 if (lambda->args == AO_LISP_FUNC_MACRO)
136                         return 1;
137                 return 0;
138         default:
139                 return 0;
140         }
141 }
142
143 ao_poly
144 ao_has_macro(ao_poly p)
145 {
146         struct ao_lisp_cons     *cons;
147         struct ao_lisp_lambda   *lambda;
148         ao_poly                 m;
149
150         if (p == AO_LISP_NIL)
151                 return AO_LISP_NIL;
152
153         switch (ao_lisp_poly_type(p)) {
154         case AO_LISP_LAMBDA:
155                 lambda = ao_lisp_poly_lambda(p);
156                 return ao_has_macro(lambda->code);
157         case AO_LISP_CONS:
158                 cons = ao_lisp_poly_cons(p);
159                 if (ao_is_macro(cons->car))
160                         return cons->car;
161
162                 cons = ao_lisp_poly_cons(cons->cdr);
163                 while (cons) {
164                         m = ao_has_macro(cons->car);
165                         if (m)
166                                 return m;
167                         cons = ao_lisp_poly_cons(cons->cdr);
168                 }
169                 return AO_LISP_NIL;
170
171         default:
172                 return AO_LISP_NIL;
173         }
174 }
175
176 int
177 ao_lisp_read_eval_abort(void)
178 {
179         ao_poly in, out = AO_LISP_NIL;
180         for(;;) {
181                 in = ao_lisp_read();
182                 if (in == _ao_lisp_atom_eof)
183                         break;
184                 out = ao_lisp_eval(in);
185                 if (ao_lisp_exception)
186                         return 0;
187                 ao_lisp_poly_print(out);
188                 putchar ('\n');
189         }
190         return 1;
191 }
192
193 static FILE     *in;
194 static FILE     *out;
195
196 int
197 ao_lisp_getc(void)
198 {
199         return getc(in);
200 }
201
202 static const struct option options[] = {
203         { .name = "out", .has_arg = 1, .val = 'o' },
204         { 0, 0, 0, 0 }
205 };
206
207 static void usage(char *program)
208 {
209         fprintf(stderr, "usage: %s [--out=<output>] [input]\n", program);
210         exit(1);
211 }
212
213 int
214 main(int argc, char **argv)
215 {
216         int     f, o;
217         ao_poly val;
218         struct ao_lisp_atom     *a;
219         struct ao_lisp_builtin  *b;
220         int     in_atom;
221         char    *out_name;
222         int     c;
223
224         in = stdin;
225         out = stdout;
226
227         while ((c = getopt_long(argc, argv, "o:", options, NULL)) != -1) {
228                 switch (c) {
229                 case 'o':
230                         out_name = optarg;
231                         break;
232                 default:
233                         usage(argv[0]);
234                         break;
235                 }
236         }
237
238         for (f = 0; f < (int) N_FUNC; f++) {
239                 b = ao_lisp_make_builtin(funcs[f].func, funcs[f].args);
240                 a = ao_lisp_atom_intern(funcs[f].name);
241                 ao_lisp_atom_set(ao_lisp_atom_poly(a),
242                                  ao_lisp_builtin_poly(b));
243         }
244
245         /* boolean constants */
246         ao_lisp_atom_set(ao_lisp_atom_poly(ao_lisp_atom_intern("nil")),
247                          AO_LISP_NIL);
248         a = ao_lisp_atom_intern("t");
249         ao_lisp_atom_set(ao_lisp_atom_poly(a),
250                          ao_lisp_atom_poly(a));
251
252         /* end of file value */
253         a = ao_lisp_atom_intern("eof");
254         ao_lisp_atom_set(ao_lisp_atom_poly(a),
255                          ao_lisp_atom_poly(a));
256
257         if (argv[optind]){
258                 in = fopen(argv[optind], "r");
259                 if (!in) {
260                         perror(argv[optind]);
261                         exit(1);
262                 }
263         }
264         if (!ao_lisp_read_eval_abort()) {
265                 fprintf(stderr, "eval failed\n");
266                 exit(1);
267         }
268
269         /* Reduce to referenced values */
270         ao_lisp_collect();
271
272         for (f = 0; f < ao_lisp_frame_global->num; f++) {
273                 val = ao_has_macro(ao_lisp_frame_global->vals[f].val);
274                 if (val != AO_LISP_NIL) {
275                         printf("error: function %s contains unresolved macro: ",
276                                ao_lisp_poly_atom(ao_lisp_frame_global->vals[f].atom)->name);
277                         ao_lisp_poly_print(val);
278                         printf(stderr, "\n");
279                         exit(1);
280                 }
281         }
282
283         if (out_name) {
284                 out = fopen(out_name, "w");
285                 if (!out) {
286                         perror(out_name);
287                         exit(1);
288                 }
289         }
290
291         fprintf(out, "/* Generated file, do not edit */\n\n");
292
293         fprintf(out, "#define AO_LISP_POOL_CONST %d\n", ao_lisp_top);
294         fprintf(out, "extern const uint8_t ao_lisp_const[AO_LISP_POOL_CONST] __attribute__((aligned(4)));\n");
295         fprintf(out, "#define ao_builtin_atoms 0x%04x\n", ao_lisp_atom_poly(ao_lisp_atoms));
296         fprintf(out, "#define ao_builtin_frame 0x%04x\n", ao_lisp_frame_poly(ao_lisp_frame_global));
297         fprintf(out, "#define ao_lisp_const_checksum ((uint16_t) 0x%04x)\n", ao_fec_crc(ao_lisp_const, ao_lisp_top));
298
299
300         for (a = ao_lisp_atoms; a; a = ao_lisp_poly_atom(a->next)) {
301                 char    *n = a->name, c;
302                 fprintf(out, "#define _ao_lisp_atom_");
303                 while ((c = *n++)) {
304                         if (isalnum(c))
305                                 fprintf(out, "%c", c);
306                         else
307                                 fprintf(out, "%02x", c);
308                 }
309                 fprintf(out, "  0x%04x\n", ao_lisp_atom_poly(a));
310         }
311         fprintf(out, "#ifdef AO_LISP_CONST_BITS\n");
312         fprintf(out, "const uint8_t ao_lisp_const[] = {");
313         for (o = 0; o < ao_lisp_top; o++) {
314                 uint8_t c;
315                 if ((o & 0xf) == 0)
316                         fprintf(out, "\n\t");
317                 else
318                         fprintf(out, " ");
319                 c = ao_lisp_const[o];
320                 if (!in_atom)
321                         in_atom = is_atom(o);
322                 if (in_atom) {
323                         fprintf(out, " '%c',", c);
324                         in_atom--;
325                 } else {
326                         fprintf(out, "0x%02x,", c);
327                 }
328         }
329         fprintf(out, "\n};\n");
330         fprintf(out, "#endif /* AO_LISP_CONST_BITS */\n");
331         exit(0);
332 }