cvs/stack/stack.h

/*
    stack - an interactive interpreter for a stack-based language
    Copyright (C) 2002  Mats Alritzson and Teddy Hogeborn

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    Authors: Mats Alritzson <masse@fukt.bth.se>
             Teddy Hogeborn <teddy@fukt.bth.se>
*/

#define HASHTBLSIZE 2048

#define CAR(X) ((X)->content.c->car)
#define CDR(X) ((X)->content.c->cdr)

/* printf, sscanf, fgets, fprintf, fopen, perror */
#include <stdio.h>
/* exit, EXIT_SUCCESS, malloc, free */
#include <stdlib.h>
/* NULL */
#include <stddef.h>
/* dlopen, dlsym, dlerror */
#include <dlfcn.h>
/* strcmp, strcpy, strlen, strcat, strdup */
#include <string.h>
/* getopt, STDIN_FILENO, STDOUT_FILENO, usleep */
#include <unistd.h>
/* EX_NOINPUT, EX_USAGE */
#include <sysexits.h>
/* assert */
#include <assert.h>

#ifdef __linux__
/* mtrace, muntrace */
#include <mcheck.h>
/* ioctl */
#include <sys/ioctl.h>
/* KDMKTONE */
#include <linux/kd.h>
#endif /* __linux__ */


/* First, define some types. */

struct cons_struct;
struct symbol_struct;
struct environment_struct;

/* A type for pointers to external functions */
typedef void (*funcp)(struct environment_struct*); 
/* funcp is a pointer to a void function (environment *) */

/* A value of some type */
typedef struct {
  enum {
    empty,                      /* The empty list */
    integer,
    tfloat,
    string,
    func,                       /* Function pointer */
    symb,                       /* Symbol */
    tcons,                      /* A pair of two values */
    port                        /* An I/O port */
  } type:4;                     /* Type of stack element */

  union {
    struct {
      unsigned int mark:1;      /* Used internally in the GC */
      unsigned int protect:1;   /* Protect from GC */
    } flag;
    unsigned int no_gc:2;       /* Both flags as one integer */
  } gc;                         /* Garbage collector stuff */

  union {
    void *ptr;                  /* Pointer to the content */
    struct cons_struct *c;      /* ...or a pointer to a cons cell */
    struct symbol_struct *sym;  /* ...or a pointer to a symbol */
    FILE *p;                    /* ...or an I/O stream */
    int i;                      /* ...or an integer */
    float f;                    /* ...or a floating point number */
    funcp func;                 /* ...or a function pointer */
    char *string;               /* ...or a string */
  } content;                    /* Stores a pointer or an integer */

} value;

/* An item (value) on a stack */
typedef struct stackitem_struct
{
  value *item;                 /* The value on the stack */
                               /* (This is never NULL) */
  struct stackitem_struct *next; /* Next item */
} stackitem;

typedef struct cons_struct {    /* A pair of two values */
  value *car;
  value *cdr;
} pair;

/* A symbol with a name and possible value */
/* (These do not need reference counters, they are kept unique by
   hashing.) */
typedef struct symbol_struct {
  char *id;                     /* Symbol name */
  value *val;                   /* The value (if any) bound to it */
  struct symbol_struct *next;   /* In case of hashing conflicts, a */
} symbol;                       /* symbol is a kind of stack item. */

/* A type for a hash table for symbols */
typedef symbol *hashtbl[HASHTBLSIZE]; /* Hash table declaration */

/* An environment; gives access to the stack and a hash table of
   defined symbols */
typedef struct {
  value *head;                  /* Head of the stack */
  hashtbl symbols;              /* Hash table of all variable bindings */
  int err;                      /* Error flag */
  char *in_string;              /* Input pending to be read */
  char *free_string;            /* Free this string when all input is
                                   read from in_string */
  FILE *inputstream;            /* stdin or a file, most likely */
  int interactive;              /* print prompts, stack, etc */

  /* Garbage Collector stuff*/
  stackitem *gc_ref;            /* Stack of all allocated values */
  int gc_limit;                 /* Run GC when this much is allocated */
  int gc_count;                 /* Amount currently allocated */
} environment;


void init_env(environment*);
void printerr(const char*);
extern void toss(environment*);
symbol **hash(hashtbl, const char*);
value* new_val(environment*);
void gc_mark(value*);
void gc_maybe(environment*);
extern void gc_init(environment*);
void protect(value*);
void unprotect(value*);
void push_val(environment*, value*);
void push_int(environment*, int);
void push_float(environment*, float);
void push_cstring(environment*, const char*);
char *mangle_str(const char*);
extern void mangle(environment*);
void push_sym(environment*, const char*);
extern void nl(environment*);
extern void nlport(environment*);
extern void type(environment*);
void print_val(environment *, value*, int, stackitem*, FILE*);
extern void print_(environment*);
extern void print(environment*);
extern void princ_(environment*);
extern void princ(environment*);
extern void printport_(environment*);
extern void printport(environment*);
extern void princport_(environment*);
extern void princport(environment*);
void print_st(environment*, value*, long);
extern void printstack(environment*);
extern void swap(environment*);
extern void rot(environment*);
extern void rcl(environment*);
extern void eval(environment*);
extern void rev(environment*);
extern void pack(environment*);
extern void expand(environment*);
extern void eq(environment*);
extern void not(environment*);
extern void neq(environment*);
extern void def(environment*);
extern void quit(environment*);
extern void clear(environment*);
extern void words(environment*);
void forget_sym(symbol**);
extern void forget(environment*);
extern void errn(environment*);
extern void sx_2b(environment*);
extern void sx_2d(environment*);
extern void sx_3e(environment*);
extern void sx_3c(environment*);
extern void sx_3c3d(environment*);
extern void sx_3e3d(environment*);
value *copy_val(environment*, value*);
extern void sx_647570(environment*);
extern void sx_6966(environment*);
extern void ifelse(environment*);
extern void sx_656c7365(environment*);
extern void then(environment*);
extern void sx_7768696c65(environment*);
extern void sx_666f72(environment*);
extern void foreach(environment*);
extern void to(environment*);
extern void readline(environment*);
extern void readlineport(environment*);
void readlinestream(environment*, FILE*);
extern void sx_72656164(environment*);
extern void readport(environment*);
void readstream(environment*, FILE*);
extern void beep(environment*);
extern void sx_77616974(environment*);
extern void copying(environment*);
extern void warranty(environment*);
extern void sx_2a(environment*);
extern void sx_2f(environment*);
extern void mod(environment*);
extern void sx_646976(environment*);
extern void setcar(environment*);
extern void setcdr(environment*);
extern void car(environment*);
extern void cdr(environment*);
extern void cons(environment*);
extern void assq(environment*);
void assocgen(environment*, funcp);
extern void sx_646f(environment *);
extern void sx_6f70656e(environment*);
extern void sx_636c6f7365(environment*);
1	teddy	1.4	/*
2			stack - an interactive interpreter for a stack-based language
3			Copyright (C) 2002 Mats Alritzson and Teddy Hogeborn
4
5			This program is free software; you can redistribute it and/or modify
6			it under the terms of the GNU General Public License as published by
7			the Free Software Foundation; either version 2 of the License, or
8			(at your option) any later version.
9
10			This program is distributed in the hope that it will be useful,
11			but WITHOUT ANY WARRANTY; without even the implied warranty of
12			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			GNU General Public License for more details.
14
15			You should have received a copy of the GNU General Public License
16			along with this program; if not, write to the Free Software
17			Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19			Authors: Mats Alritzson <masse@fukt.bth.se>
20			Teddy Hogeborn <teddy@fukt.bth.se>
21			*/
22	teddy	1.1
23			#define HASHTBLSIZE 2048
24
25	masse	1.22	#define CAR(X) ((X)->content.c->car)
26			#define CDR(X) ((X)->content.c->cdr)
27
28			/* printf, sscanf, fgets, fprintf, fopen, perror */
29			#include <stdio.h>
30			/* exit, EXIT_SUCCESS, malloc, free */
31			#include <stdlib.h>
32			/* NULL */
33			#include <stddef.h>
34			/* dlopen, dlsym, dlerror */
35			#include <dlfcn.h>
36			/* strcmp, strcpy, strlen, strcat, strdup */
37			#include <string.h>
38			/* getopt, STDIN_FILENO, STDOUT_FILENO, usleep */
39			#include <unistd.h>
40			/* EX_NOINPUT, EX_USAGE */
41			#include <sysexits.h>
42			/* assert */
43			#include <assert.h>
44
45			#ifdef __linux__
46			/* mtrace, muntrace */
47			#include <mcheck.h>
48			/* ioctl */
49			#include <sys/ioctl.h>
50			/* KDMKTONE */
51			#include <linux/kd.h>
52			#endif /* __linux__ */
53
54
55
56	teddy	1.1	/* First, define some types. */
57
58	masse	1.10	struct cons_struct;
59	masse	1.13	struct symbol_struct;
60	masse	1.23	struct environment_struct;
61
62			/* A type for pointers to external functions */
63			typedef void (funcp)(struct environment_struct);
64			/* funcp is a pointer to a void function (environment ) /
65	masse	1.10
66	teddy	1.1	/* A value of some type */
67			typedef struct {
68			enum {
69	teddy	1.15	empty, /* The empty list */
70	teddy	1.1	integer,
71	masse	1.5	tfloat,
72	teddy	1.1	string,
73			func, /* Function pointer */
74	teddy	1.11	symb, /* Symbol */
75	teddy	1.21	tcons, /* A pair of two values */
76			port /* An I/O port */
77	masse	1.5	} type:4; /* Type of stack element */
78	masse	1.2
79	teddy	1.9	union {
80			struct {
81	teddy	1.11	unsigned int mark:1; /* Used internally in the GC */
82			unsigned int protect:1; /* Protect from GC */
83	teddy	1.9	} flag;
84	teddy	1.11	unsigned int no_gc:2; /* Both flags as one integer */
85			} gc; /* Garbage collector stuff */
86	teddy	1.1
87			union {
88			void ptr; / Pointer to the content */
89	teddy	1.11	struct cons_struct c; / ...or a pointer to a cons cell */
90	masse	1.13	struct symbol_struct sym; / ...or a pointer to a symbol */
91	teddy	1.21	FILE p; / ...or an I/O stream */
92	masse	1.5	int i; /* ...or an integer */
93	teddy	1.11	float f; /* ...or a floating point number */
94	masse	1.24	funcp func; /* ...or a function pointer */
95	masse	1.23	char string; / ...or a string */
96	teddy	1.1	} content; /* Stores a pointer or an integer */
97
98			} value;
99
100	masse	1.10	/* An item (value) on a stack */
101			typedef struct stackitem_struct
102			{
103			value item; / The value on the stack */
104			/* (This is never NULL) */
105			struct stackitem_struct next; / Next item */
106			} stackitem;
107
108	teddy	1.11	typedef struct cons_struct { /* A pair of two values */
109	masse	1.10	value *car;
110			value *cdr;
111	teddy	1.16	} pair;
112	masse	1.10
113	teddy	1.1	/* A symbol with a name and possible value */
114			/* (These do not need reference counters, they are kept unique by
115			hashing.) */
116			typedef struct symbol_struct {
117			char id; / Symbol name */
118			value val; / The value (if any) bound to it */
119			struct symbol_struct next; / In case of hashing conflicts, a */
120			} symbol; /* symbol is a kind of stack item. */
121
122			/* A type for a hash table for symbols */
123			typedef symbol hashtbl[HASHTBLSIZE]; / Hash table declaration */
124
125			/* An environment; gives access to the stack and a hash table of
126			defined symbols */
127			typedef struct {
128	masse	1.12	value head; / Head of the stack */
129	teddy	1.1	hashtbl symbols; /* Hash table of all variable bindings */
130			int err; /* Error flag */
131			char in_string; / Input pending to be read */
132			char free_string; / Free this string when all input is
133	teddy	1.4	read from in_string */
134	teddy	1.1	FILE inputstream; / stdin or a file, most likely */
135			int interactive; /* print prompts, stack, etc */
136	teddy	1.15
137			/* Garbage Collector stuff*/
138			stackitem gc_ref; / Stack of all allocated values */
139			int gc_limit; /* Run GC when this much is allocated */
140			int gc_count; /* Amount currently allocated */
141	teddy	1.1	} environment;
142
143
144	masse	1.2	void init_env(environment*);
145			void printerr(const char*);
146			extern void toss(environment*);
147			symbol *hash(hashtbl, const char);
148			value* new_val(environment*);
149			void gc_mark(value*);
150	teddy	1.17	void gc_maybe(environment*);
151	masse	1.2	extern void gc_init(environment*);
152	teddy	1.17	void protect(value*);
153			void unprotect(value*);
154	masse	1.2	void push_val(environment, value);
155			void push_int(environment*, int);
156	masse	1.5	void push_float(environment*, float);
157	masse	1.2	void push_cstring(environment, const char);
158			char mangle_str(const char);
159			extern void mangle(environment*);
160			void push_sym(environment, const char);
161	teddy	1.21	extern void nl(environment*);
162			extern void nlport(environment*);
163	masse	1.2	extern void type(environment*);
164	teddy	1.21	void print_val(environment , value, int, stackitem, FILE);
165	masse	1.2	extern void print_(environment*);
166			extern void print(environment*);
167			extern void princ_(environment*);
168			extern void princ(environment*);
169	teddy	1.21	extern void printport_(environment*);
170			extern void printport(environment*);
171			extern void princport_(environment*);
172			extern void princport(environment*);
173			void print_st(environment, value, long);
174	masse	1.2	extern void printstack(environment*);
175			extern void swap(environment*);
176			extern void rot(environment*);
177			extern void rcl(environment*);
178			extern void eval(environment*);
179			extern void rev(environment*);
180			extern void pack(environment*);
181			extern void expand(environment*);
182			extern void eq(environment*);
183			extern void not(environment*);
184			extern void neq(environment*);
185			extern void def(environment*);
186			extern void quit(environment*);
187			extern void clear(environment*);
188			extern void words(environment*);
189			void forget_sym(symbol**);
190			extern void forget(environment*);
191			extern void errn(environment*);
192			extern void sx_2b(environment*);
193			extern void sx_2d(environment*);
194			extern void sx_3e(environment*);
195	teddy	1.17	extern void sx_3c(environment*);
196			extern void sx_3c3d(environment*);
197			extern void sx_3e3d(environment*);
198	masse	1.2	value copy_val(environment, value*);
199			extern void sx_647570(environment*);
200			extern void sx_6966(environment*);
201			extern void ifelse(environment*);
202	teddy	1.17	extern void sx_656c7365(environment*);
203			extern void then(environment*);
204	masse	1.2	extern void sx_7768696c65(environment*);
205			extern void sx_666f72(environment*);
206	teddy	1.17	extern void foreach(environment*);
207	masse	1.2	extern void to(environment*);
208			extern void readline(environment*);
209	teddy	1.21	extern void readlineport(environment*);
210			void readlinestream(environment, FILE);
211	masse	1.2	extern void sx_72656164(environment*);
212	teddy	1.21	extern void readport(environment*);
213			void readstream(environment, FILE);
214	teddy	1.17	extern void beep(environment*);
215			extern void sx_77616974(environment*);
216	masse	1.5	extern void copying(environment*);
217			extern void warranty(environment*);
218			extern void sx_2a(environment*);
219			extern void sx_2f(environment*);
220			extern void mod(environment*);
221	masse	1.6	extern void sx_646976(environment*);
222	teddy	1.17	extern void setcar(environment*);
223			extern void setcdr(environment*);
224			extern void car(environment*);
225			extern void cdr(environment*);
226			extern void cons(environment*);
227	teddy	1.18	extern void assq(environment*);
228	teddy	1.19	void assocgen(environment*, funcp);
229	masse	1.20	extern void sx_646f(environment *);
230	teddy	1.21	extern void sx_6f70656e(environment*);
231			extern void sx_636c6f7365(environment*);