Cleanups
[xonotic/gmqcc.git] / gmqcc.h
1 /*
2  * Copyright (C) 2012 
3  *      Dale Weiler
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9  * of the Software, and to permit persons to whom the Software is furnished to do
10  * so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23 #ifndef GMQCC_HDR
24 #define GMQCC_HDR
25 #include <stdio.h>
26
27 //===================================================================
28 //============================ lex.c ================================
29 //===================================================================
30 struct lex_file {
31         FILE *file;
32         char  peek  [5];
33         char  lastok[8192];
34         
35         int   last;
36         int   current;
37         int   length;
38         int   size;
39 };
40
41 /*
42  * It's important that this table never exceed 32 keywords, the ascii
43  * table starts at 33 (and we don't want conflicts)
44  */
45 #define TOKEN_DO       0
46 #define TOKEN_ELSE     1
47 #define TOKEN_IF       2
48 #define TOKEN_WHILE    3
49 #define TOKEN_BREAK    4
50 #define TOKEN_CONTINUE 5
51 #define TOKEN_RETURN   6
52 #define TOKEN_GOTO     7
53 #define TOKEN_FOR      8   // extension
54 #define TOKEN_TYPEDEF  9   // extension
55
56 // ensure the token types are out of the
57 // bounds of anyothers that may conflict.
58 #define TOKEN_FLOAT    110
59 #define TOKEN_VECTOR   111
60 #define TOKEN_STRING   112
61 #define TOKEN_ENTITY   113
62 #define TOKEN_VOID     114
63
64 /*
65  * Lexer state constants, these are numbers for where exactly in
66  * the lexing the lexer is at. Or where it decided to stop if a lexer
67  * error occurs.  These numbers must be > where the ascii-table ends
68  * and > the last type token which is TOKEN_VOID
69  */
70 #define LEX_COMMENT    1128 
71 #define LEX_CHRLIT     1129
72 #define LEX_STRLIT     1130
73 #define LEX_IDENT      1131
74
75 int              lex_token(struct lex_file *);
76 void             lex_reset(struct lex_file *);
77 void             lex_close(struct lex_file *);
78 struct lex_file *lex_open (FILE *);
79
80 //===================================================================
81 //========================== error.c ================================
82 //===================================================================
83 #define ERROR_LEX      (SHRT_MAX+0)
84 #define ERROR_PARSE    (SHRT_MAX+1)
85 #define ERROR_INTERNAL (SHRT_MAX+2)
86 #define ERROR_COMPILER (SHRT_MAX+3)
87 #define ERROR_PREPRO   (SHRT_MAX+4)
88 int error(int, const char *, ...);
89
90 //===================================================================
91 //========================== parse.c ================================
92 //===================================================================
93 int parse_tree(struct lex_file *);
94 struct parsenode {
95         struct parsenode *next;
96         int               type; /* some token */
97 };
98
99 //===================================================================
100 //========================== typedef.c ==============================
101 //===================================================================
102 typedef struct typedef_node_t {
103         char      *name;
104 } typedef_node;
105
106 void          typedef_init();
107 void          typedef_clear();
108 typedef_node *typedef_find(const char *);
109 int           typedef_add (const char *, const char *);
110
111
112 //===================================================================
113 //=========================== util.c ================================
114 //===================================================================
115 void *util_memory_a(unsigned int, unsigned int, const char *);
116 void  util_memory_d(void       *, unsigned int, const char *);
117 char *util_strdup  (const char *);
118
119 #ifdef NOTRACK
120 #       define mem_a(x) malloc(x)
121 #       define mem_d(x) free  (x)
122 #else
123 #       define mem_a(x) util_memory_a((x), __LINE__, __FILE__)
124 #       define mem_d(x) util_memory_d((x), __LINE__, __FILE__)
125 #endif
126
127 //===================================================================
128 //=========================== code.c ================================
129 //===================================================================
130 #define TYPE_VOID     0
131 #define TYPE_STRING   1
132 #define TYPE_FLOAT    2
133 #define TYPE_VECTOR   3
134 #define TYPE_ENTITY   4
135 #define TYPE_FIELD    5
136 #define TYPE_FUNCTION 6
137 #define TYPE_POINTER  7
138
139 /* 
140  * Instructions 
141  * These are the external instructions supported by the interperter
142  * this is what things compile to (from the C code).
143  */
144 #define INSTR_DONE      0
145 // math
146 #define INSTR_MUL_F     1
147 #define INSTR_MUL_V     2
148 #define INSTR_MUL_FV    3
149 #define INSTR_MUL_VF    4
150 #define INSTR_DIV_F     5
151 #define INSTR_ADD_F     6
152 #define INSTR_ADD_V     7
153 #define INSTR_SUB_F     8
154 #define INSTR_SUB_V     9
155 // compare
156 #define INSTR_EQ_F      10
157 #define INSTR_EQ_V      11
158 #define INSTR_EQ_S      12
159 #define INSTR_EQ_E      13
160 #define INSTR_EQ_FNC    14
161 #define INSTR_NE_F      15
162 #define INSTR_NE_V      16
163 #define INSTR_NE_S      17
164 #define INSTR_NE_E      18
165 #define INSTR_NE_FNC    19
166 // multi compare
167 #define INSTR_LE        20
168 #define INSTR_GE        21
169 #define INSTR_LT        22
170 #define INSTR_GT        23
171 // load and store
172 #define INSTR_LOAD_F    24
173 #define INSTR_LOAD_V    25
174 #define INSTR_LOAD_S    26
175 #define INSTR_LOAD_ENT  27
176 #define INSTR_LOAD_FLD  28
177 #define INSTR_LOAD_FNC  29
178 #define INSTR_STORE_F   31
179 #define INSTR_STORE_V   32
180 #define INSTR_STORE_S   33
181 #define INSTR_STORE_ENT 34
182 #define INSTR_STORE_FLD 35
183 #define INSTR_STORE_FNC 36
184 // others
185 #define INSTR_ADDRESS   30
186 #define INSTR_RETURN    37
187 #define INSTR_NOT_F     38
188 #define INSTR_NOT_V     39
189 #define INSTR_NOT_S     40
190 #define INSTR_NOT_ENT   41
191 #define INSTR_NOT_FNC   42
192 #define INSTR_IF        43
193 #define INSTR_IFNOT     44
194 #define INSTR_CALL0     45
195 #define INSTR_CALL1     46
196 #define INSTR_CALL2     47
197 #define INSTR_CALL3     48
198 #define INSTR_CALL4     49
199 #define INSTR_CALL5     50
200 #define INSTR_CALL6     51
201 #define INSTR_CALL7     52
202 #define INSTR_CALL8     53
203 #define INSTR_STATE     54
204 #define INSTR_GOTO      55
205 #define INSTR_AND       56
206 #define INSTR_OR        57
207 #define INSTR_BITAND    59
208 #define INSTR_BITOR     60
209 #endif