altos/lisp: Clean up OS integration bits, add defun
[fw/altos] / src / lisp / ao_lisp.h
index d41086621b24092ae562c8b861a7241cfe12e366..de55b3076888fed40047df96735033510ed4c6fa 100644 (file)
 #ifndef _AO_LISP_H_
 #define _AO_LISP_H_
 
-#if !defined(AO_LISP_TEST) && !defined(AO_LISP_MAKE_CONST)
-#include <ao.h>
-#define AO_LISP_ALTOS  1
-#endif
-
 #include <stdint.h>
 #include <string.h>
-#include <stdio.h>
+//#include <stdio.h>
+#include <ao_lisp_os.h>
 
 #ifdef AO_LISP_MAKE_CONST
 #define AO_LISP_POOL_CONST     16384
 extern uint8_t ao_lisp_const[AO_LISP_POOL_CONST];
-#define _ao_lisp_atom_quote ao_lisp_atom_poly(ao_lisp_atom_intern("quote"))
+#define ao_lisp_pool ao_lisp_const
+#define AO_LISP_POOL AO_LISP_POOL_CONST
+
+#define _atom(n) ao_lisp_atom_poly(ao_lisp_atom_intern(n))
+
+#define _ao_lisp_atom_quote    _atom("quote")
+#define _ao_lisp_atom_set      _atom("set")
+#define _ao_lisp_atom_setq     _atom("setq")
+#define _ao_lisp_atom_t        _atom("t")
+#define _ao_lisp_atom_car      _atom("car")
+#define _ao_lisp_atom_cdr      _atom("cdr")
+#define _ao_lisp_atom_cons     _atom("cons")
+#define _ao_lisp_atom_last     _atom("last")
+#define _ao_lisp_atom_cond     _atom("cond")
+#define _ao_lisp_atom_lambda   _atom("lambda")
+#define _ao_lisp_atom_led      _atom("led")
+#define _ao_lisp_atom_delay    _atom("delay")
 #else
 #include "ao_lisp_const.h"
+#ifndef AO_LISP_POOL
+#define AO_LISP_POOL   16384
+#endif
+extern uint8_t         ao_lisp_pool[AO_LISP_POOL];
 #endif
 
 /* Primitive types */
@@ -46,62 +62,59 @@ extern uint8_t ao_lisp_const[AO_LISP_POOL_CONST];
 /* These have a type value at the start of the struct */
 #define AO_LISP_ATOM           4
 #define AO_LISP_BUILTIN                5
-#define AO_LISP_NUM_TYPE       6
+#define AO_LISP_FRAME          6
+#define AO_LISP_LAMBDA         7
+#define AO_LISP_NUM_TYPE       8
 
 #define AO_LISP_NIL    0
 
-#define AO_LISP_POOL   1024
-
-extern uint8_t         ao_lisp_pool[AO_LISP_POOL];
 extern uint16_t                ao_lisp_top;
 
 #define AO_LISP_OOM            0x01
 #define AO_LISP_DIVIDE_BY_ZERO 0x02
 #define AO_LISP_INVALID                0x04
+#define AO_LISP_UNDEFINED      0x08
 
 extern uint8_t         ao_lisp_exception;
 
 typedef uint16_t       ao_poly;
+typedef int16_t                ao_signed_poly;
 
 static inline int
 ao_lisp_is_const(ao_poly poly) {
        return poly & AO_LISP_CONST;
 }
 
+#define AO_LISP_POOL_BASE      (ao_lisp_pool - 4)
+#define AO_LISP_CONST_BASE     (ao_lisp_const - 4)
+
+#define AO_LISP_IS_CONST(a)    (ao_lisp_const <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_const + AO_LISP_POOL_CONST)
+#define AO_LISP_IS_POOL(a)     (ao_lisp_pool <= ((uint8_t *) (a)) && ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL)
+
 static inline void *
 ao_lisp_ref(ao_poly poly) {
+       if (poly == 0xBEEF)
+               ao_lisp_abort();
        if (poly == AO_LISP_NIL)
                return NULL;
        if (poly & AO_LISP_CONST)
-               return (void *) ((ao_lisp_const - 4) + (poly & AO_LISP_REF_MASK));
-       else
-               return (void *) ((ao_lisp_pool - 4) + (poly & AO_LISP_REF_MASK));
+               return (void *) (AO_LISP_CONST_BASE + (poly & AO_LISP_REF_MASK));
+       return (void *) (AO_LISP_POOL_BASE + (poly & AO_LISP_REF_MASK));
 }
 
 static inline ao_poly
 ao_lisp_poly(const void *addr, ao_poly type) {
        const uint8_t   *a = addr;
-       if (addr == NULL)
+       if (a == NULL)
                return AO_LISP_NIL;
-       if (ao_lisp_pool <= a && a < ao_lisp_pool + AO_LISP_POOL)
-               return (a - (ao_lisp_pool - 4)) | type;
-       else if (ao_lisp_const <= a && a <= ao_lisp_const + AO_LISP_POOL_CONST)
-               return AO_LISP_CONST | (a - (ao_lisp_const - 4)) | type;
-       else {
-               ao_lisp_exception |= AO_LISP_INVALID;
-               return AO_LISP_NIL;
-       }
+       if (AO_LISP_IS_CONST(a))
+               return AO_LISP_CONST | (a - AO_LISP_CONST_BASE) | type;
+       return (a - AO_LISP_POOL_BASE) | type;
 }
 
-#define AO_LISP_POLY(addr, type) (((ao_lisp_pool <= ((uint8_t *) (a)) && \
-                                   ((uint8_t *) (a)) < ao_lisp_pool + AO_LISP_POOL) ? \
-                                  ((uint8_t *) (a) - (ao_lisp_pool - 4)) : \
-                                  (((uint8_t *) (a) - (ao_lisp_const - 4)) | AO_LISP_POOL_CONST)) | \
-                                 (type))
-
 struct ao_lisp_type {
-       void    (*mark)(void *addr);
        int     (*size)(void *addr);
+       void    (*mark)(void *addr);
        void    (*move)(void *addr);
 };
 
@@ -113,15 +126,70 @@ struct ao_lisp_cons {
 struct ao_lisp_atom {
        uint8_t         type;
        uint8_t         pad[1];
-       ao_poly         val;
        ao_poly         next;
        char            name[];
 };
 
-#define AO_LISP_LAMBDA 0
-#define AO_LISP_NLAMBDA        1
-#define AO_LISP_MACRO  2
-#define AO_LISP_LEXPR  3
+struct ao_lisp_val {
+       ao_poly         atom;
+       ao_poly         val;
+};
+
+struct ao_lisp_frame {
+       uint8_t                 type;
+       uint8_t                 num;
+       ao_poly                 next;
+       struct ao_lisp_val      vals[];
+};
+
+static inline struct ao_lisp_frame *
+ao_lisp_poly_frame(ao_poly poly) {
+       return ao_lisp_ref(poly);
+}
+
+static inline ao_poly
+ao_lisp_frame_poly(struct ao_lisp_frame *frame) {
+       return ao_lisp_poly(frame, AO_LISP_OTHER);
+}
+
+enum eval_state {
+       eval_sexpr,             /* Evaluate an sexpr */
+       eval_val,
+       eval_formal,
+       eval_exec,
+       eval_cond,
+       eval_cond_test
+};
+
+struct ao_lisp_stack {
+       uint8_t                 state;          /* enum eval_state */
+       ao_poly                 prev;           /* previous stack frame */
+       ao_poly                 sexprs;         /* expressions to evaluate */
+       ao_poly                 values;         /* values computed */
+       ao_poly                 values_tail;    /* end of the values list for easy appending */
+       ao_poly                 frame;          /* current lookup frame */
+       ao_poly                 list;           /* most recent function call */
+};
+
+static inline struct ao_lisp_stack *
+ao_lisp_poly_stack(ao_poly p)
+{
+       return ao_lisp_ref(p);
+}
+
+static inline ao_poly
+ao_lisp_stack_poly(struct ao_lisp_stack *stack)
+{
+       return ao_lisp_poly(stack, AO_LISP_OTHER);
+}
+
+extern struct ao_lisp_stack    *ao_lisp_stack;
+extern ao_poly                 ao_lisp_v;
+
+#define AO_LISP_FUNC_LAMBDA    0
+#define AO_LISP_FUNC_NLAMBDA   1
+#define AO_LISP_FUNC_MACRO     2
+#define AO_LISP_FUNC_LEXPR     3
 
 struct ao_lisp_builtin {
        uint8_t         type;
@@ -130,24 +198,38 @@ struct ao_lisp_builtin {
 };
 
 enum ao_lisp_builtin_id {
+       builtin_lambda,
+       builtin_lexpr,
+       builtin_nlambda,
+       builtin_macro,
        builtin_car,
        builtin_cdr,
        builtin_cons,
+       builtin_last,
        builtin_quote,
        builtin_set,
        builtin_setq,
+       builtin_cond,
        builtin_print,
+       builtin_patom,
        builtin_plus,
        builtin_minus,
        builtin_times,
        builtin_divide,
        builtin_mod,
-       builtin_last
+       builtin_equal,
+       builtin_less,
+       builtin_greater,
+       builtin_less_equal,
+       builtin_greater_equal,
+       builtin_delay,
+       builtin_led,
+       _builtin_last
 };
 
 typedef ao_poly (*ao_lisp_func_t)(struct ao_lisp_cons *cons);
 
-extern ao_lisp_func_t  ao_lisp_builtins[];
+extern const ao_lisp_func_t    ao_lisp_builtins[];
 
 static inline ao_lisp_func_t
 ao_lisp_func(struct ao_lisp_builtin *b)
@@ -155,11 +237,35 @@ ao_lisp_func(struct ao_lisp_builtin *b)
        return ao_lisp_builtins[b->func];
 }
 
+struct ao_lisp_lambda {
+       uint8_t         type;
+       uint8_t         args;
+       ao_poly         code;
+       ao_poly         frame;
+};
+
+static inline struct ao_lisp_lambda *
+ao_lisp_poly_lambda(ao_poly poly)
+{
+       return ao_lisp_ref(poly);
+}
+
+static inline ao_poly
+ao_lisp_lambda_poly(struct ao_lisp_lambda *lambda)
+{
+       return ao_lisp_poly(lambda, AO_LISP_OTHER);
+}
+
 static inline void *
 ao_lisp_poly_other(ao_poly poly) {
        return ao_lisp_ref(poly);
 }
 
+static inline uint8_t
+ao_lisp_other_type(void *other) {
+       return *((uint8_t *) other);
+}
+
 static inline ao_poly
 ao_lisp_other_poly(const void *other)
 {
@@ -174,10 +280,14 @@ ao_lisp_mem_round(int size)
 
 #define AO_LISP_OTHER_POLY(other) ((ao_poly)(other) + AO_LISP_OTHER)
 
+static inline int ao_lisp_poly_base_type(ao_poly poly) {
+       return poly & AO_LISP_TYPE_MASK;
+}
+
 static inline int ao_lisp_poly_type(ao_poly poly) {
-       int     type = poly & 3;
+       int     type = poly & AO_LISP_TYPE_MASK;
        if (type == AO_LISP_OTHER)
-               return *((uint8_t *) ao_lisp_poly_other(poly));
+               return ao_lisp_other_type(ao_lisp_poly_other(poly));
        return type;
 }
 
@@ -196,13 +306,13 @@ ao_lisp_cons_poly(struct ao_lisp_cons *cons)
 static inline int
 ao_lisp_poly_int(ao_poly poly)
 {
-       return (int) poly >> AO_LISP_TYPE_SHIFT;
+       return (int) ((ao_signed_poly) poly >> AO_LISP_TYPE_SHIFT);
 }
 
 static inline ao_poly
 ao_lisp_int_poly(int i)
 {
-       return ((ao_poly) i << 2) + AO_LISP_INT;
+       return ((ao_poly) i << 2) | AO_LISP_INT;
 }
 
 static inline char *
@@ -242,7 +352,8 @@ ao_lisp_builtin_poly(struct ao_lisp_builtin *b)
 }
 
 /* memory functions */
-void
+/* returns 1 if the object was already marked */
+int
 ao_lisp_mark(const struct ao_lisp_type *type, void *addr);
 
 /* returns 1 if the object was already marked */
@@ -250,18 +361,28 @@ int
 ao_lisp_mark_memory(void *addr, int size);
 
 void *
-ao_lisp_move(const struct ao_lisp_type *type, void *addr);
+ao_lisp_move_map(void *addr);
 
-/* returns NULL if the object was already moved */
-void *
-ao_lisp_move_memory(void *addr, int size);
+/* returns 1 if the object was already moved */
+int
+ao_lisp_move(const struct ao_lisp_type *type, void **ref);
+
+/* returns 1 if the object was already moved */
+int
+ao_lisp_move_memory(void **ref, int size);
 
 void *
 ao_lisp_alloc(int size);
 
+void
+ao_lisp_collect(void);
+
 int
 ao_lisp_root_add(const struct ao_lisp_type *type, void *addr);
 
+int
+ao_lisp_root_poly_add(ao_poly *p);
+
 void
 ao_lisp_root_clear(void *addr);
 
@@ -274,6 +395,9 @@ ao_lisp_cons_cons(ao_poly car, struct ao_lisp_cons *cdr);
 void
 ao_lisp_cons_print(ao_poly);
 
+void
+ao_lisp_cons_patom(ao_poly);
+
 /* string */
 extern const struct ao_lisp_type ao_lisp_string_type;
 
@@ -289,13 +413,15 @@ ao_lisp_string_cat(char *a, char *b);
 void
 ao_lisp_string_print(ao_poly s);
 
+void
+ao_lisp_string_patom(ao_poly s);
+
 /* atom */
 extern const struct ao_lisp_type ao_lisp_atom_type;
 
-extern struct ao_lisp_atom *ao_lisp_atoms;
-
-void
-ao_lisp_atom_init(void);
+extern struct ao_lisp_atom     *ao_lisp_atoms;
+extern struct ao_lisp_frame    *ao_lisp_frame_global;
+extern struct ao_lisp_frame    *ao_lisp_frame_current;
 
 void
 ao_lisp_atom_print(ao_poly a);
@@ -303,28 +429,59 @@ ao_lisp_atom_print(ao_poly a);
 struct ao_lisp_atom *
 ao_lisp_atom_intern(char *name);
 
+ao_poly
+ao_lisp_atom_get(ao_poly atom);
+
+ao_poly
+ao_lisp_atom_set(ao_poly atom, ao_poly val);
+
 /* int */
 void
 ao_lisp_int_print(ao_poly i);
 
 /* prim */
-ao_poly
+void
 ao_lisp_poly_print(ao_poly p);
 
 void
-ao_lisp_poly_mark(ao_poly p);
+ao_lisp_poly_patom(ao_poly p);
 
-ao_poly
-ao_lisp_poly_move(ao_poly p);
+int
+ao_lisp_poly_mark(ao_poly p, uint8_t note_cons);
+
+/* returns 1 if the object has already been moved */
+int
+ao_lisp_poly_move(ao_poly *p, uint8_t note_cons);
 
 /* eval */
+
 ao_poly
 ao_lisp_eval(ao_poly p);
 
+ao_poly
+ao_lisp_set_cond(struct ao_lisp_cons *cons);
+
 /* builtin */
 void
 ao_lisp_builtin_print(ao_poly b);
 
+extern const struct ao_lisp_type ao_lisp_builtin_type;
+
+/* Check argument count */
+ao_poly
+ao_lisp_check_argc(ao_poly name, struct ao_lisp_cons *cons, int min, int max);
+
+/* Check argument type */
+ao_poly
+ao_lisp_check_argt(ao_poly name, struct ao_lisp_cons *cons, int argc, int type, int nil_ok);
+
+/* Fetch an arg (nil if off the end) */
+ao_poly
+ao_lisp_arg(struct ao_lisp_cons *cons, int argc);
+
+char *
+ao_lisp_args_name(uint8_t args);
+
 /* read */
 ao_poly
 ao_lisp_read(void);
@@ -333,4 +490,92 @@ ao_lisp_read(void);
 ao_poly
 ao_lisp_read_eval_print(void);
 
+/* frame */
+extern const struct ao_lisp_type ao_lisp_frame_type;
+
+ao_poly *
+ao_lisp_frame_ref(struct ao_lisp_frame *frame, ao_poly atom);
+
+struct ao_lisp_frame *
+ao_lisp_frame_new(int num);
+
+struct ao_lisp_frame *
+ao_lisp_frame_add(struct ao_lisp_frame *frame, ao_poly atom, ao_poly val);
+
+void
+ao_lisp_frame_print(ao_poly p);
+
+/* lambda */
+extern const struct ao_lisp_type ao_lisp_lambda_type;
+
+struct ao_lisp_lambda *
+ao_lisp_lambda_new(ao_poly cons);
+
+void
+ao_lisp_lambda_print(ao_poly lambda);
+
+ao_poly
+ao_lisp_lambda(struct ao_lisp_cons *cons);
+
+ao_poly
+ao_lisp_lexpr(struct ao_lisp_cons *cons);
+
+ao_poly
+ao_lisp_nlambda(struct ao_lisp_cons *cons);
+
+ao_poly
+ao_lisp_macro(struct ao_lisp_cons *cons);
+
+ao_poly
+ao_lisp_lambda_eval(struct ao_lisp_lambda *lambda,
+                   struct ao_lisp_cons *cons);
+
+/* error */
+
+void
+ao_lisp_stack_print(void);
+
+ao_poly
+ao_lisp_error(int error, char *format, ...);
+
+/* debugging macros */
+
+#if DBG_EVAL
+#define DBG_CODE       1
+int ao_lisp_stack_depth;
+#define DBG_DO(a)      a
+#define DBG_INDENT()   do { int _s; for(_s = 0; _s < ao_lisp_stack_depth; _s++) printf("  "); } while(0)
+#define DBG_IN()       (++ao_lisp_stack_depth)
+#define DBG_OUT()      (--ao_lisp_stack_depth)
+#define DBG_RESET()    (ao_lisp_stack_depth = 0)
+#define DBG(...)       printf(__VA_ARGS__)
+#define DBGI(...)      do { DBG("%4d: ", __LINE__); DBG_INDENT(); DBG(__VA_ARGS__); } while (0)
+#define DBG_CONS(a)    ao_lisp_cons_print(ao_lisp_cons_poly(a))
+#define DBG_POLY(a)    ao_lisp_poly_print(a)
+#define OFFSET(a)      ((a) ? (int) ((uint8_t *) a - ao_lisp_pool) : -1)
+#define DBG_STACK()    ao_lisp_stack_print()
+static inline void
+ao_lisp_frames_dump(void)
+{
+       struct ao_lisp_stack *s;
+       DBGI(".. current frame: "); DBG_POLY(ao_lisp_frame_poly(ao_lisp_frame_current)); DBG("\n");
+       for (s = ao_lisp_stack; s; s = ao_lisp_poly_stack(s->prev)) {
+               DBGI(".. stack frame: "); DBG_POLY(s->frame); DBG("\n");
+       }
+}
+#define DBG_FRAMES()   ao_lisp_frames_dump()
+#else
+#define DBG_DO(a)
+#define DBG_INDENT()
+#define DBG_IN()
+#define DBG_OUT()
+#define DBG(...)
+#define DBGI(...)
+#define DBG_CONS(a)
+#define DBG_POLY(a)
+#define DBG_RESET()
+#define DBG_STACK()
+#define DBG_FRAMES()
+#endif
+
 #endif /* _AO_LISP_H_ */