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_cond      _atom("cond")
  46 #else
  47 #include "ao_lisp_const.h"
  48 #ifndef AO_LISP_POOL
  49 #define AO_LISP_POOL    16384
  50 #endif
  51 extern uint8_t          ao_lisp_pool[AO_LISP_POOL];
  52 #endif
  53
  54 /* Primitive types */
  55 #define AO_LISP_CONS            0
  56 #define AO_LISP_INT             1
  57 #define AO_LISP_STRING          2
  58 #define AO_LISP_OTHER           3
  59
  60 #define AO_LISP_TYPE_MASK       0x0003
  61 #define AO_LISP_TYPE_SHIFT      2
  62 #define AO_LISP_REF_MASK        0x7ffc
  63 #define AO_LISP_CONST           0x8000
  64
  65 /* These have a type value at the start of the struct */
  66 #define AO_LISP_ATOM            4
  67 #define AO_LISP_BUILTIN         5
  68 #define AO_LISP_FRAME           6
  69 #define AO_LISP_NUM_TYPE        7
  70
  71 #define AO_LISP_NIL     0
  72
  73 extern uint16_t         ao_lisp_top;
  74
  75 #define AO_LISP_OOM             0x01
  76 #define AO_LISP_DIVIDE_BY_ZERO  0x02
  77 #define AO_LISP_INVALID         0x04
  78
  79 extern uint8_t          ao_lisp_exception;
  80
  81 typedef uint16_t        ao_poly;
  82 typedef int16_t         ao_signed_poly;
  83
  84 static inline int
  85 ao_lisp_is_const(ao_poly poly) {
  86         return poly & AO_LISP_CONST;
  87 }
  88
  89 #define AO_LISP_POOL_BASE       (ao_lisp_pool - 4)
  90 #define AO_LISP_CONST_BASE      (ao_lisp_const - 4)
  91
  92 #define AO_LISP_IS_CONST(a)     (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
  93 #define AO_LISP_IS_POOL(a)      (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
  94
  95 static inline void *
  96 ao_lisp_ref(ao_poly poly) {
  97         if (poly == 0xBEEF)
  98                 abort();
  99         if (poly == AO_LISP_NIL)
 100                 return NULL;
 101         if (poly & AO_LISP_CONST)
 102                 return (void *) (AO_LISP_CONST_BASE + (poly & AO_LISP_REF_MASK));
 103         return (void *) (AO_LISP_POOL_BASE + (poly & AO_LISP_REF_MASK));
 104 }
 105
 106 static inline ao_poly
 107 ao_lisp_poly(const void *addr, ao_poly type) {
 108         const uint8_t   *a = addr;
 109         if (a == NULL)
 110                 return AO_LISP_NIL;
 111         if (AO_LISP_IS_CONST(a))
 112                 return AO_LISP_CONST | (a - AO_LISP_CONST_BASE) | type;
 113         return (a - AO_LISP_POOL_BASE) | type;
 114 }
 115
 116 struct ao_lisp_type {
 117         void    (*mark)(void *addr);
 118         int     (*size)(void *addr);
 119         void    (*move)(void *addr);
 120 };
 121
 122 struct ao_lisp_cons {
 123         ao_poly         car;
 124         ao_poly         cdr;
 125 };
 126
 127 struct ao_lisp_atom {
 128         uint8_t         type;
 129         uint8_t         pad[1];
 130         ao_poly         next;
 131         char            name[];
 132 };
 133
 134 struct ao_lisp_val {
 135         ao_poly         atom;
 136         ao_poly         val;
 137 };
 138
 139 struct ao_lisp_frame {
 140         uint8_t                 type;
 141         uint8_t                 num;
 142         ao_poly                 next;
 143         struct ao_lisp_val      vals[];
 144 };
 145
 146 static inline struct ao_lisp_frame *
 147 ao_lisp_poly_frame(ao_poly poly) {
 148         return ao_lisp_ref(poly);
 149 }
 150
 151 static inline ao_poly
 152 ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
 153         return ao_lisp_poly(frame, AO_LISP_OTHER);
 154 }
 155
 156 #define AO_LISP_LAMBDA  0
 157 #define AO_LISP_NLAMBDA 1
 158 #define AO_LISP_MACRO   2
 159 #define AO_LISP_LEXPR   3
 160
 161 struct ao_lisp_builtin {
 162         uint8_t         type;
 163         uint8_t         args;
 164         uint16_t        func;
 165 };
 166
 167 enum ao_lisp_builtin_id {
 168         builtin_car,
 169         builtin_cdr,
 170         builtin_cons,
 171         builtin_quote,
 172         builtin_set,
 173         builtin_setq,
 174         builtin_cond,
 175         builtin_print,
 176         builtin_patom,
 177         builtin_plus,
 178         builtin_minus,
 179         builtin_times,
 180         builtin_divide,
 181         builtin_mod,
 182         builtin_equal,
 183         builtin_less,
 184         builtin_greater,
 185         builtin_less_equal,
 186         builtin_greater_equal,
 187         builtin_last
 188 };
 189
 190 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
 191
 192 extern ao_lisp_func_t   ao_lisp_builtins[];
 193
 194 static inline ao_lisp_func_t
 195 ao_lisp_func(struct ao_lisp_builtin *b)
 196 {
 197         return ao_lisp_builtins[b->func];
 198 }
 199
 200 static inline void *
 201 ao_lisp_poly_other(ao_poly poly) {
 202         return ao_lisp_ref(poly);
 203 }
 204
 205 static inline uint8_t
 206 ao_lisp_other_type(void *other) {
 207         return *((uint8_t *) other);
 208 }
 209
 210 static inline ao_poly
 211 ao_lisp_other_poly(const void *other)
 212 {
 213         return ao_lisp_poly(other, AO_LISP_OTHER);
 214 }
 215
 216 static inline int
 217 ao_lisp_mem_round(int size)
 218 {
 219         return (size + 3) & ~3;
 220 }
 221
 222 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
 223
 224 static inline int ao_lisp_poly_base_type(ao_poly poly) {
 225         return poly & AO_LISP_TYPE_MASK;
 226 }
 227
 228 static inline int ao_lisp_poly_type(ao_poly poly) {
 229         int     type = poly & AO_LISP_TYPE_MASK;
 230         if (type == AO_LISP_OTHER)
 231                 return ao_lisp_other_type(ao_lisp_poly_other(poly));
 232         return type;
 233 }
 234
 235 static inline struct ao_lisp_cons *
 236 ao_lisp_poly_cons(ao_poly poly)
 237 {
 238         return ao_lisp_ref(poly);
 239 }
 240
 241 static inline ao_poly
 242 ao_lisp_cons_poly(struct ao_lisp_cons *cons)
 243 {
 244         return ao_lisp_poly(cons, AO_LISP_CONS);
 245 }
 246
 247 static inline int
 248 ao_lisp_poly_int(ao_poly poly)
 249 {
 250         return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
 251 }
 252
 253 static inline ao_poly
 254 ao_lisp_int_poly(int i)
 255 {
 256         return ((ao_poly) i << 2) | AO_LISP_INT;
 257 }
 258
 259 static inline char *
 260 ao_lisp_poly_string(ao_poly poly)
 261 {
 262         return ao_lisp_ref(poly);
 263 }
 264
 265 static inline ao_poly
 266 ao_lisp_string_poly(char *s)
 267 {
 268         return ao_lisp_poly(s, AO_LISP_STRING);
 269 }
 270
 271 static inline struct ao_lisp_atom *
 272 ao_lisp_poly_atom(ao_poly poly)
 273 {
 274         return ao_lisp_ref(poly);
 275 }
 276
 277 static inline ao_poly
 278 ao_lisp_atom_poly(struct ao_lisp_atom *a)
 279 {
 280         return ao_lisp_poly(a, AO_LISP_OTHER);
 281 }
 282
 283 static inline struct ao_lisp_builtin *
 284 ao_lisp_poly_builtin(ao_poly poly)
 285 {
 286         return ao_lisp_ref(poly);
 287 }
 288
 289 static inline ao_poly
 290 ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
 291 {
 292         return ao_lisp_poly(b, AO_LISP_OTHER);
 293 }
 294
 295 /* memory functions */
 296 /* returns 1 if the object was already marked */
 297 int
 298 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
 299
 300 /* returns 1 if the object was already marked */
 301 int
 302 ao_lisp_mark_memory(void *addr, int size);
 303
 304 void *
 305 ao_lisp_move_map(void *addr);
 306
 307 /* returns 1 if the object was already moved */
 308 int
 309 ao_lisp_move(const struct ao_lisp_type *type, void **ref);
 310
 311 /* returns 1 if the object was already moved */
 312 int
 313 ao_lisp_move_memory(void **ref, int size);
 314
 315 void *
 316 ao_lisp_alloc(int size);
 317
 318 void
 319 ao_lisp_collect(void);
 320
 321 int
 322 ao_lisp_root_add(const struct ao_lisp_type *type, void *addr);
 323
 324 int
 325 ao_lisp_root_poly_add(ao_poly *p);
 326
 327 void
 328 ao_lisp_root_clear(void *addr);
 329
 330 /* cons */
 331 extern const struct ao_lisp_type ao_lisp_cons_type;
 332
 333 struct ao_lisp_cons *
 334 ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
 335
 336 void
 337 ao_lisp_cons_print(ao_poly);
 338
 339 void
 340 ao_lisp_cons_patom(ao_poly);
 341
 342 /* string */
 343 extern const struct ao_lisp_type ao_lisp_string_type;
 344
 345 char *
 346 ao_lisp_string_new(int len);
 347
 348 char *
 349 ao_lisp_string_copy(char *a);
 350
 351 char *
 352 ao_lisp_string_cat(char *a, char *b);
 353
 354 void
 355 ao_lisp_string_print(ao_poly s);
 356
 357 void
 358 ao_lisp_string_patom(ao_poly s);
 359
 360 /* atom */
 361 extern const struct ao_lisp_type ao_lisp_atom_type;
 362
 363 extern struct ao_lisp_atom *ao_lisp_atoms;
 364
 365 extern struct ao_lisp_frame *ao_lisp_frame_current;
 366
 367 void
 368 ao_lisp_atom_print(ao_poly a);
 369
 370 struct ao_lisp_atom *
 371 ao_lisp_atom_intern(char *name);
 372
 373 ao_poly
 374 ao_lisp_atom_get(ao_poly atom);
 375
 376 ao_poly
 377 ao_lisp_atom_set(ao_poly atom, ao_poly val);
 378
 379 /* int */
 380 void
 381 ao_lisp_int_print(ao_poly i);
 382
 383 /* prim */
 384 void
 385 ao_lisp_poly_print(ao_poly p);
 386
 387 void
 388 ao_lisp_poly_patom(ao_poly p);
 389
 390 int
 391 ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
 392
 393 /* returns 1 if the object has already been moved */
 394 int
 395 ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
 396
 397 /* eval */
 398
 399 ao_poly
 400 ao_lisp_eval(ao_poly p);
 401
 402 ao_poly
 403 ao_lisp_set_cond(struct ao_lisp_cons *cons);
 404
 405 /* builtin */
 406 void
 407 ao_lisp_builtin_print(ao_poly b);
 408
 409 extern const struct ao_lisp_type ao_lisp_builtin_type;
 410
 411 /* Check argument count */
 412 ao_poly
 413 ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
 414
 415 /* Check argument type */
 416 ao_poly
 417 ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
 418
 419 /* Fetch an arg (nil if off the end) */
 420 ao_poly
 421 ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
 422
 423 /* read */
 424 ao_poly
 425 ao_lisp_read(void);
 426
 427 /* rep */
 428 ao_poly
 429 ao_lisp_read_eval_print(void);
 430
 431 /* frame */
 432 extern const struct ao_lisp_type ao_lisp_frame_type;
 433
 434 ao_poly *
 435 ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
 436
 437 struct ao_lisp_frame *
 438 ao_lisp_frame_new(int num);
 439
 440 struct ao_lisp_frame *
 441 ao_lisp_frame_add(struct ao_lisp_frame *frame, ao_poly atom, ao_poly val);
 442
 443 /* error */
 444
 445 ao_poly
 446 ao_lisp_error(int error, char *format, ...);
 447
 448 #endif /* _AO_LISP_H_ */