Generated SuperTux libtool library containing more general source, that could prove...
[supertux.git] / lib / utils / lispreader.h
1 /* $Id$ */
2 /*
3  * lispreader.h
4  *
5  * Copyright (C) 1998-2000 Mark Probst
6  * Copyright (C) 2002 Ingo Ruhnke <grumbel@gmx.de>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 #ifndef SUPERTUX_LISPREADER_H
25 #define SUPERTUX_LISPREADER_H
26
27 #include <cstdio>
28 #include <string>
29 #include <vector>
30 #include <exception>
31
32 #include <zlib.h>
33
34 #include "utils/exceptions.h"
35
36 #define LISP_STREAM_FILE       1
37 #define LISP_STREAM_STRING     2
38 #define LISP_STREAM_ANY        3
39
40 #define LISP_TYPE_INTERNAL      -3
41 #define LISP_TYPE_PARSE_ERROR   -2
42 #define LISP_TYPE_EOF           -1
43 #define LISP_TYPE_NIL           0
44 #define LISP_TYPE_SYMBOL        1
45 #define LISP_TYPE_INTEGER       2
46 #define LISP_TYPE_STRING        3
47 #define LISP_TYPE_REAL          4
48 #define LISP_TYPE_CONS          5
49 #define LISP_TYPE_PATTERN_CONS  6
50 #define LISP_TYPE_BOOLEAN       7
51 #define LISP_TYPE_PATTERN_VAR   8
52
53 #define LISP_PATTERN_ANY        1
54 #define LISP_PATTERN_SYMBOL     2
55 #define LISP_PATTERN_STRING     3
56 #define LISP_PATTERN_INTEGER    4
57 #define LISP_PATTERN_REAL       5
58 #define LISP_PATTERN_BOOLEAN    6
59 #define LISP_PATTERN_LIST       7
60 #define LISP_PATTERN_OR         8
61
62 // Exception
63 class LispReaderException : public SuperTuxException
64 {
65   public:
66     LispReaderException(const char* _message = "lispreader error", const char* _file = "", const unsigned int _line = 0)
67       : SuperTuxException(_message, _file, _line) { };
68 };
69
70 typedef struct
71   {
72     int type;
73
74     union
75       {
76         FILE *file;
77         struct
78           {
79             char *buf;
80             int pos;
81           }
82         string;
83         struct
84           {
85             void *data;
86             int (*next_char) (void *data);
87             void (*unget_char) (char c, void *data);
88           }
89         any;
90       } v;
91   }
92 lisp_stream_t;
93
94 typedef struct _lisp_object_t lisp_object_t;
95 struct _lisp_object_t
96   {
97     int type;
98
99     union
100       {
101         struct
102           {
103             struct _lisp_object_t *car;
104             struct _lisp_object_t *cdr;
105           }
106         cons;
107
108         char *string;
109         int integer;
110         float real;
111
112         struct
113           {
114             int type;
115             int index;
116             struct _lisp_object_t *sub;
117           }
118         pattern;
119       } v;
120   };
121
122 lisp_stream_t* lisp_stream_init_file (lisp_stream_t *stream, FILE *file);
123 lisp_stream_t* lisp_stream_init_string (lisp_stream_t *stream, char *buf);
124 lisp_stream_t* lisp_stream_init_any (lisp_stream_t *stream, void *data,
125                                      int (*next_char) (void *data),
126                                      void (*unget_char) (char c, void *data));
127
128 lisp_object_t* lisp_read (lisp_stream_t *in);
129 lisp_object_t* lisp_read_from_file(const std::string& filename);
130 void lisp_free (lisp_object_t *obj);
131
132 lisp_object_t* lisp_read_from_string (const char *buf);
133
134 int lisp_compile_pattern (lisp_object_t **obj, int *num_subs);
135 int lisp_match_pattern (lisp_object_t *pattern, lisp_object_t *obj, lisp_object_t **vars, int num_subs);
136 int lisp_match_string (const char *pattern_string, lisp_object_t *obj, lisp_object_t **vars);
137
138 int lisp_type (lisp_object_t *obj);
139 int lisp_integer (lisp_object_t *obj);
140 float lisp_real (lisp_object_t *obj);
141 char* lisp_symbol (lisp_object_t *obj);
142 char* lisp_string (lisp_object_t *obj);
143 int lisp_boolean (lisp_object_t *obj);
144 lisp_object_t* lisp_car (lisp_object_t *obj);
145 lisp_object_t* lisp_cdr (lisp_object_t *obj);
146
147 lisp_object_t* lisp_cxr (lisp_object_t *obj, const char *x);
148
149 lisp_object_t* lisp_make_integer (int value);
150 lisp_object_t* lisp_make_real (float value);
151 lisp_object_t* lisp_make_symbol (const char *value);
152 lisp_object_t* lisp_make_string (const char *value);
153 lisp_object_t* lisp_make_cons (lisp_object_t *car, lisp_object_t *cdr);
154 lisp_object_t* lisp_make_boolean (int value);
155
156 int lisp_list_length (lisp_object_t *obj);
157 lisp_object_t* lisp_list_nth_cdr (lisp_object_t *obj, int index);
158 lisp_object_t* lisp_list_nth (lisp_object_t *obj, int index);
159
160 void lisp_dump (lisp_object_t *obj, FILE *out);
161
162 #define lisp_nil()           ((lisp_object_t*)0)
163
164 #define lisp_nil_p(obj)      (obj == 0)
165 #define lisp_integer_p(obj)  (lisp_type((obj)) == LISP_TYPE_INTEGER)
166 #define lisp_real_p(obj)     (lisp_type((obj)) == LISP_TYPE_REAL)
167 #define lisp_symbol_p(obj)   (lisp_type((obj)) == LISP_TYPE_SYMBOL)
168 #define lisp_string_p(obj)   (lisp_type((obj)) == LISP_TYPE_STRING)
169 #define lisp_cons_p(obj)     (lisp_type((obj)) == LISP_TYPE_CONS)
170 #define lisp_boolean_p(obj)  (lisp_type((obj)) == LISP_TYPE_BOOLEAN)
171
172 /** */
173 class LispReader
174 {
175 private:
176   lisp_object_t* owner;
177   lisp_object_t* lst;
178
179   lisp_object_t* search_for(const char* name);
180   
181 public:
182   /** cur == ((pos 1 2 3) (id 12 3 4)...) */
183   LispReader(lisp_object_t* l);
184   ~LispReader();
185
186   bool read_int_vector(const char* name, std::vector<int>& vec);
187   bool read_int_vector(const char* name, std::vector<unsigned int>& vec);
188   bool read_char_vector(const char* name, std::vector<char>& vec);
189   bool read_string_vector(const char* name, std::vector<std::string>& vec);
190   bool read_string(const char* name, std::string& str, bool translatable = false);
191   bool read_int(const char* name, int& i);
192   bool read_float(const char* name, float& f);
193   bool read_bool(const char* name, bool& b);
194   bool read_lisp(const char* name, lisp_object_t*& b);
195   lisp_object_t* read_lisp(const char* name);
196
197   static LispReader* load(const std::string& filename,
198       const std::string& toplevellist);
199
200   lisp_object_t* get_lisp();
201 };
202
203 #endif /*SUPERTUX_LISPREADER_H*/
204