git.gag.com Git - fw/altos/blob - src/lisp/ao_lisp.h

   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 #ifndef _AO_LISP_H_
  16 #define _AO_LISP_H_
  17
  18 #include <stdlib.h>
  19
  20 #if !defined(AO_LISP_TEST) && !defined(AO_LISP_MAKE_CONST)
  21 #include <ao.h>
  22 #define AO_LISP_ALTOS   1
  23 #define abort() ao_panic(1)
  24 #endif
  25
  26 #include <stdint.h>
  27 #include <string.h>
  28 #include <stdio.h>
  29
  30 #ifdef AO_LISP_MAKE_CONST
  31 #define AO_LISP_POOL_CONST      16384
  32 extern uint8_t ao_lisp_const[AO_LISP_POOL_CONST];
  33 #define ao_lisp_pool ao_lisp_const
  34 #define AO_LISP_POOL AO_LISP_POOL_CONST
  35
  36 #define _atom(n) ao_lisp_atom_poly(ao_lisp_atom_intern(n))
  37
  38 #define _ao_lisp_atom_quote     _atom("quote")
  39 #define _ao_lisp_atom_set       _atom("set")
  40 #define _ao_lisp_atom_setq      _atom("setq")
  41 #define _ao_lisp_atom_t         _atom("t")
  42 #define _ao_lisp_atom_car       _atom("car")
  43 #define _ao_lisp_atom_cdr       _atom("cdr")
  44 #define _ao_lisp_atom_cons      _atom("cons")
  45 #define _ao_lisp_atom_last      _atom("last")
  46 #define _ao_lisp_atom_cond      _atom("cond")
  47 #define _ao_lisp_atom_lambda    _atom("lambda")
  48 #else
  49 #include "ao_lisp_const.h"
  50 #ifndef AO_LISP_POOL
  51 #define AO_LISP_POOL    16384
  52 #endif
  53 extern uint8_t          ao_lisp_pool[AO_LISP_POOL];
  54 #endif
  55
  56 /* Primitive types */
  57 #define AO_LISP_CONS            0
  58 #define AO_LISP_INT             1
  59 #define AO_LISP_STRING          2
  60 #define AO_LISP_OTHER           3
  61
  62 #define AO_LISP_TYPE_MASK       0x0003
  63 #define AO_LISP_TYPE_SHIFT      2
  64 #define AO_LISP_REF_MASK        0x7ffc
  65 #define AO_LISP_CONST           0x8000
  66
  67 /* These have a type value at the start of the struct */
  68 #define AO_LISP_ATOM            4
  69 #define AO_LISP_BUILTIN         5
  70 #define AO_LISP_FRAME           6
  71 #define AO_LISP_LAMBDA          7
  72 #define AO_LISP_NUM_TYPE        8
  73
  74 #define AO_LISP_NIL     0
  75
  76 extern uint16_t         ao_lisp_top;
  77
  78 #define AO_LISP_OOM             0x01
  79 #define AO_LISP_DIVIDE_BY_ZERO  0x02
  80 #define AO_LISP_INVALID         0x04
  81
  82 extern uint8_t          ao_lisp_exception;
  83
  84 typedef uint16_t        ao_poly;
  85 typedef int16_t         ao_signed_poly;
  86
  87 static inline int
  88 ao_lisp_is_const(ao_poly poly) {
  89         return poly & AO_LISP_CONST;
  90 }
  91
  92 #define AO_LISP_POOL_BASE       (ao_lisp_pool - 4)
  93 #define AO_LISP_CONST_BASE      (ao_lisp_const - 4)
  94
  95 #define AO_LISP_IS_CONST(a)     (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
  96 #define AO_LISP_IS_POOL(a)      (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
  97
  98 static inline void *
  99 ao_lisp_ref(ao_poly poly) {
 100         if (poly == 0xBEEF)
 101                 abort();
 102         if (poly == AO_LISP_NIL)
 103                 return NULL;
 104         if (poly & AO_LISP_CONST)
 105                 return (void *) (AO_LISP_CONST_BASE + (poly & AO_LISP_REF_MASK));
 106         return (void *) (AO_LISP_POOL_BASE + (poly & AO_LISP_REF_MASK));
 107 }
 108
 109 static inline ao_poly
 110 ao_lisp_poly(const void *addr, ao_poly type) {
 111         const uint8_t   *a = addr;
 112         if (a == NULL)
 113                 return AO_LISP_NIL;
 114         if (AO_LISP_IS_CONST(a))
 115                 return AO_LISP_CONST | (a - AO_LISP_CONST_BASE) | type;
 116         return (a - AO_LISP_POOL_BASE) | type;
 117 }
 118
 119 struct ao_lisp_type {
 120         int     (*size)(void *addr);
 121         void    (*mark)(void *addr);
 122         void    (*move)(void *addr);
 123 };
 124
 125 struct ao_lisp_cons {
 126         ao_poly         car;
 127         ao_poly         cdr;
 128 };
 129
 130 struct ao_lisp_atom {
 131         uint8_t         type;
 132         uint8_t         pad[1];
 133         ao_poly         next;
 134         char            name[];
 135 };
 136
 137 struct ao_lisp_val {
 138         ao_poly         atom;
 139         ao_poly         val;
 140 };
 141
 142 struct ao_lisp_frame {
 143         uint8_t                 type;
 144         uint8_t                 num;
 145         ao_poly                 next;
 146         struct ao_lisp_val      vals[];
 147 };
 148
 149 static inline struct ao_lisp_frame *
 150 ao_lisp_poly_frame(ao_poly poly) {
 151         return ao_lisp_ref(poly);
 152 }
 153
 154 static inline ao_poly
 155 ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
 156         return ao_lisp_poly(frame, AO_LISP_OTHER);
 157 }
 158
 159 struct ao_lisp_stack {
 160         ao_poly                 prev;
 161         uint8_t                 state;
 162         uint8_t                 macro;
 163         ao_poly                 sexprs;
 164         ao_poly                 values;
 165         ao_poly                 values_tail;
 166         ao_poly                 frame;
 167         ao_poly                 macro_frame;
 168         ao_poly                 list;
 169 };
 170
 171 enum eval_state {
 172         eval_sexpr,
 173         eval_val,
 174         eval_formal,
 175         eval_exec,
 176         eval_lambda_done,
 177         eval_cond,
 178         eval_cond_test
 179 };
 180
 181 static inline struct ao_lisp_stack *
 182 ao_lisp_poly_stack(ao_poly p)
 183 {
 184         return ao_lisp_ref(p);
 185 }
 186
 187 static inline ao_poly
 188 ao_lisp_stack_poly(struct ao_lisp_stack *stack)
 189 {
 190         return ao_lisp_poly(stack, AO_LISP_OTHER);
 191 }
 192
 193 extern struct ao_lisp_stack     *ao_lisp_stack;
 194 extern ao_poly                  ao_lisp_v;
 195
 196 #define AO_LISP_FUNC_LAMBDA     0
 197 #define AO_LISP_FUNC_NLAMBDA    1
 198 #define AO_LISP_FUNC_MACRO      2
 199 #define AO_LISP_FUNC_LEXPR      3
 200
 201 struct ao_lisp_builtin {
 202         uint8_t         type;
 203         uint8_t         args;
 204         uint16_t        func;
 205 };
 206
 207 enum ao_lisp_builtin_id {
 208         builtin_lambda,
 209         builtin_lexpr,
 210         builtin_nlambda,
 211         builtin_macro,
 212         builtin_car,
 213         builtin_cdr,
 214         builtin_cons,
 215         builtin_last,
 216         builtin_quote,
 217         builtin_set,
 218         builtin_setq,
 219         builtin_cond,
 220         builtin_print,
 221         builtin_patom,
 222         builtin_plus,
 223         builtin_minus,
 224         builtin_times,
 225         builtin_divide,
 226         builtin_mod,
 227         builtin_equal,
 228         builtin_less,
 229         builtin_greater,
 230         builtin_less_equal,
 231         builtin_greater_equal,
 232         _builtin_last
 233 };
 234
 235 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
 236
 237 extern ao_lisp_func_t   ao_lisp_builtins[];
 238
 239 static inline ao_lisp_func_t
 240 ao_lisp_func(struct ao_lisp_builtin *b)
 241 {
 242         return ao_lisp_builtins[b->func];
 243 }
 244
 245 struct ao_lisp_lambda {
 246         uint8_t         type;
 247         uint8_t         args;
 248         ao_poly         code;
 249         ao_poly         frame;
 250 };
 251
 252 static inline struct ao_lisp_lambda *
 253 ao_lisp_poly_lambda(ao_poly poly)
 254 {
 255         return ao_lisp_ref(poly);
 256 }
 257
 258 static inline ao_poly
 259 ao_lisp_lambda_poly(struct ao_lisp_lambda *lambda)
 260 {
 261         return ao_lisp_poly(lambda, AO_LISP_OTHER);
 262 }
 263
 264 static inline void *
 265 ao_lisp_poly_other(ao_poly poly) {
 266         return ao_lisp_ref(poly);
 267 }
 268
 269 static inline uint8_t
 270 ao_lisp_other_type(void *other) {
 271         return *((uint8_t *) other);
 272 }
 273
 274 static inline ao_poly
 275 ao_lisp_other_poly(const void *other)
 276 {
 277         return ao_lisp_poly(other, AO_LISP_OTHER);
 278 }
 279
 280 static inline int
 281 ao_lisp_mem_round(int size)
 282 {
 283         return (size + 3) & ~3;
 284 }
 285
 286 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
 287
 288 static inline int ao_lisp_poly_base_type(ao_poly poly) {
 289         return poly & AO_LISP_TYPE_MASK;
 290 }
 291
 292 static inline int ao_lisp_poly_type(ao_poly poly) {
 293         int     type = poly & AO_LISP_TYPE_MASK;
 294         if (type == AO_LISP_OTHER)
 295                 return ao_lisp_other_type(ao_lisp_poly_other(poly));
 296         return type;
 297 }
 298
 299 static inline struct ao_lisp_cons *
 300 ao_lisp_poly_cons(ao_poly poly)
 301 {
 302         return ao_lisp_ref(poly);
 303 }
 304
 305 static inline ao_poly
 306 ao_lisp_cons_poly(struct ao_lisp_cons *cons)
 307 {
 308         return ao_lisp_poly(cons, AO_LISP_CONS);
 309 }
 310
 311 static inline int
 312 ao_lisp_poly_int(ao_poly poly)
 313 {
 314         return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
 315 }
 316
 317 static inline ao_poly
 318 ao_lisp_int_poly(int i)
 319 {
 320         return ((ao_poly) i << 2) | AO_LISP_INT;
 321 }
 322
 323 static inline char *
 324 ao_lisp_poly_string(ao_poly poly)
 325 {
 326         return ao_lisp_ref(poly);
 327 }
 328
 329 static inline ao_poly
 330 ao_lisp_string_poly(char *s)
 331 {
 332         return ao_lisp_poly(s, AO_LISP_STRING);
 333 }
 334
 335 static inline struct ao_lisp_atom *
 336 ao_lisp_poly_atom(ao_poly poly)
 337 {
 338         return ao_lisp_ref(poly);
 339 }
 340
 341 static inline ao_poly
 342 ao_lisp_atom_poly(struct ao_lisp_atom *a)
 343 {
 344         return ao_lisp_poly(a, AO_LISP_OTHER);
 345 }
 346
 347 static inline struct ao_lisp_builtin *
 348 ao_lisp_poly_builtin(ao_poly poly)
 349 {
 350         return ao_lisp_ref(poly);
 351 }
 352
 353 static inline ao_poly
 354 ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
 355 {
 356         return ao_lisp_poly(b, AO_LISP_OTHER);
 357 }
 358
 359 /* memory functions */
 360 /* returns 1 if the object was already marked */
 361 int
 362 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
 363
 364 /* returns 1 if the object was already marked */
 365 int
 366 ao_lisp_mark_memory(void *addr, int size);
 367
 368 void *
 369 ao_lisp_move_map(void *addr);
 370
 371 /* returns 1 if the object was already moved */
 372 int
 373 ao_lisp_move(const struct ao_lisp_type *type, void **ref);
 374
 375 /* returns 1 if the object was already moved */
 376 int
 377 ao_lisp_move_memory(void **ref, int size);
 378
 379 void *
 380 ao_lisp_alloc(int size);
 381
 382 void
 383 ao_lisp_collect(void);
 384
 385 int
 386 ao_lisp_root_add(const struct ao_lisp_type *type, void *addr);
 387
 388 int
 389 ao_lisp_root_poly_add(ao_poly *p);
 390
 391 void
 392 ao_lisp_root_clear(void *addr);
 393
 394 /* cons */
 395 extern const struct ao_lisp_type ao_lisp_cons_type;
 396
 397 struct ao_lisp_cons *
 398 ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
 399
 400 void
 401 ao_lisp_cons_print(ao_poly);
 402
 403 void
 404 ao_lisp_cons_patom(ao_poly);
 405
 406 /* string */
 407 extern const struct ao_lisp_type ao_lisp_string_type;
 408
 409 char *
 410 ao_lisp_string_new(int len);
 411
 412 char *
 413 ao_lisp_string_copy(char *a);
 414
 415 char *
 416 ao_lisp_string_cat(char *a, char *b);
 417
 418 void
 419 ao_lisp_string_print(ao_poly s);
 420
 421 void
 422 ao_lisp_string_patom(ao_poly s);
 423
 424 /* atom */
 425 extern const struct ao_lisp_type ao_lisp_atom_type;
 426
 427 extern struct ao_lisp_atom      *ao_lisp_atoms;
 428 extern struct ao_lisp_frame     *ao_lisp_frame_global;
 429 extern struct ao_lisp_frame     *ao_lisp_frame_current;
 430
 431 void
 432 ao_lisp_atom_print(ao_poly a);
 433
 434 struct ao_lisp_atom *
 435 ao_lisp_atom_intern(char *name);
 436
 437 ao_poly
 438 ao_lisp_atom_get(ao_poly atom);
 439
 440 ao_poly
 441 ao_lisp_atom_set(ao_poly atom, ao_poly val);
 442
 443 /* int */
 444 void
 445 ao_lisp_int_print(ao_poly i);
 446
 447 /* prim */
 448 void
 449 ao_lisp_poly_print(ao_poly p);
 450
 451 void
 452 ao_lisp_poly_patom(ao_poly p);
 453
 454 int
 455 ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
 456
 457 /* returns 1 if the object has already been moved */
 458 int
 459 ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
 460
 461 /* eval */
 462
 463 ao_poly
 464 ao_lisp_eval(ao_poly p);
 465
 466 ao_poly
 467 ao_lisp_set_cond(struct ao_lisp_cons *cons);
 468
 469 /* builtin */
 470 void
 471 ao_lisp_builtin_print(ao_poly b);
 472
 473 extern const struct ao_lisp_type ao_lisp_builtin_type;
 474
 475 /* Check argument count */
 476 ao_poly
 477 ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
 478
 479 /* Check argument type */
 480 ao_poly
 481 ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
 482
 483 /* Fetch an arg (nil if off the end) */
 484 ao_poly
 485 ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
 486
 487 char *
 488 ao_lisp_args_name(uint8_t args);
 489
 490 /* read */
 491 ao_poly
 492 ao_lisp_read(void);
 493
 494 /* rep */
 495 ao_poly
 496 ao_lisp_read_eval_print(void);
 497
 498 /* frame */
 499 extern const struct ao_lisp_type ao_lisp_frame_type;
 500
 501 ao_poly *
 502 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
 503
 504 struct ao_lisp_frame *
 505 ao_lisp_frame_new(int num);
 506
 507 struct ao_lisp_frame *
 508 ao_lisp_frame_add(struct ao_lisp_frame *frame, ao_poly atom, ao_poly val);
 509
 510 void
 511 ao_lisp_frame_print(ao_poly p);
 512
 513 /* lambda */
 514 extern const struct ao_lisp_type ao_lisp_lambda_type;
 515
 516 struct ao_lisp_lambda *
 517 ao_lisp_lambda_new(ao_poly cons);
 518
 519 void
 520 ao_lisp_lambda_print(ao_poly lambda);
 521
 522 ao_poly
 523 ao_lisp_lambda(struct ao_lisp_cons *cons);
 524
 525 ao_poly
 526 ao_lisp_lexpr(struct ao_lisp_cons *cons);
 527
 528 ao_poly
 529 ao_lisp_nlambda(struct ao_lisp_cons *cons);
 530
 531 ao_poly
 532 ao_lisp_macro(struct ao_lisp_cons *cons);
 533
 534 ao_poly
 535 ao_lisp_lambda_eval(struct ao_lisp_lambda *lambda,
 536                     struct ao_lisp_cons *cons);
 537
 538 /* error */
 539
 540 void
 541 ao_lisp_stack_print(void);
 542
 543 ao_poly
 544 ao_lisp_error(int error, char *format, ...);
 545
 546 /* debugging macros */
 547
 548 #if DBG_EVAL
 549 #define DBG_CODE        1
 550 int ao_lisp_stack_depth;
 551 #define DBG_DO(a)       a
 552 #define DBG_INDENT()    do { int _s; for(_s = 0; _s < ao_lisp_stack_depth; _s++) printf("  "); } while(0)
 553 #define DBG_IN()        (++ao_lisp_stack_depth)
 554 #define DBG_OUT()       (--ao_lisp_stack_depth)
 555 #define DBG_RESET()     (ao_lisp_stack_depth = 0)
 556 #define DBG(...)        printf(__VA_ARGS__)
 557 #define DBGI(...)       do { DBG("%4d: ", __LINE__); DBG_INDENT(); DBG(__VA_ARGS__); } while (0)
 558 #define DBG_CONS(a)     ao_lisp_cons_print(ao_lisp_cons_poly(a))
 559 #define DBG_POLY(a)     ao_lisp_poly_print(a)
 560 #define OFFSET(a)       ((a) ? (int) ((uint8_t *) a - ao_lisp_pool) : -1)
 561 #define DBG_STACK()     ao_lisp_stack_print()
 562 #else
 563 #define DBG_DO(a)
 564 #define DBG_INDENT()
 565 #define DBG_IN()
 566 #define DBG_OUT()
 567 #define DBG(...)
 568 #define DBGI(...)
 569 #define DBG_CONS(a)
 570 #define DBG_POLY(a)
 571 #define DBG_RESET()
 572 #define DBG_STACK()
 573 #endif
 574
 575 #endif /* _AO_LISP_H_ */