Remove spelling corrector
[xonotic/gmqcc.git] / parser.h
1 /*
2  * Copyright (C) 2012, 2013, 2014, 2015
3  *     Wolfgang Bumiller
4  *     Dale Weiler
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
7  * this software and associated documentation files (the "Software"), to deal in
8  * the Software without restriction, including without limitation the rights to
9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10  * of the Software, and to permit persons to whom the Software is furnished to do
11  * so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef GMQCC_PARSER_HDR
25 #define GMQCC_PARSER_HDR
26 #include "gmqcc.h"
27 #include "lexer.h"
28 #include "ast.h"
29
30 typedef struct intrin_s intrin_t;
31 typedef struct parser_s parser_t;
32
33 typedef struct {
34     struct parser_s *parser;
35     ast_value      **imm_float;              /* vector<ast_value*> */
36     ast_value      **imm_vector;             /* vector<ast_value*> */
37     ast_value      **imm_string;             /* vector<ast_value*> */
38     hash_table_t    *imm_string_untranslate; /* map<string, ast_value*> */
39     hash_table_t    *imm_string_dotranslate; /* map<string, ast_value*> */
40 } fold_t;
41
42 typedef struct {
43     ast_expression *(*intrin)(intrin_t *);
44     const char       *name;
45     const char       *alias;
46     size_t            args;
47 } intrin_func_t;
48
49 struct intrin_s {
50     intrin_func_t  *intrinsics;              /* vector<intrin_func_t>   */
51     ast_expression **generated;              /* vector<ast_expression*> */
52     parser_t       *parser;
53     fold_t         *fold;
54 };
55
56 #define parser_ctx(p) ((p)->lex->tok.ctx)
57
58 struct parser_s {
59     lex_file *lex;
60     int      tok;
61
62     bool     ast_cleaned;
63
64     ast_expression **globals;
65     ast_expression **fields;
66     ast_function **functions;
67     size_t         translated;
68
69     /* must be deleted first, they reference immediates and values */
70     ast_value    **accessors;
71
72     ast_value *nil;
73     ast_value *reserved_version;
74
75     size_t crc_globals;
76     size_t crc_fields;
77
78     ast_function *function;
79     ht            aliases;
80
81     /* All the labels the function defined...
82      * Should they be in ast_function instead?
83      */
84     ast_label  **labels;
85     ast_goto   **gotos;
86     const char **breaks;
87     const char **continues;
88
89     /* A list of hashtables for each scope */
90     ht *variables;
91     ht htfields;
92     ht htglobals;
93     ht *typedefs;
94
95     /* not to be used directly, we use the hash table */
96     ast_expression **_locals;
97     size_t          *_blocklocals;
98     ast_value      **_typedefs;
99     size_t          *_blocktypedefs;
100     lex_ctx_t         *_block_ctx;
101
102     /* we store the '=' operator info */
103     const oper_info *assign_op;
104
105     /* magic values */
106     ast_value *const_vec[3];
107
108     /* pragma flags */
109     bool noref;
110
111     /* collected information */
112     size_t     max_param_count;
113
114     fold_t   *fold;
115     intrin_t *intrin;
116 };
117
118
119 /* parser.c */
120 char           *parser_strdup     (const char *str);
121 ast_expression *parser_find_global(parser_t *parser, const char *name);
122
123 /* fold.c */
124 fold_t         *fold_init           (parser_t *);
125 void            fold_cleanup        (fold_t *);
126 ast_expression *fold_constgen_float (fold_t *, qcfloat_t, bool);
127 ast_expression *fold_constgen_vector(fold_t *, vec3_t);
128 ast_expression *fold_constgen_string(fold_t *, const char *, bool);
129 bool            fold_generate       (fold_t *, ir_builder *);
130 ast_expression *fold_op             (fold_t *, const oper_info *, ast_expression **);
131 ast_expression *fold_intrin         (fold_t *, const char      *, ast_expression **);
132
133 ast_expression *fold_binary         (lex_ctx_t ctx, int, ast_expression *, ast_expression *);
134 int             fold_cond_ifthen    (ir_value *, ast_function *, ast_ifthen  *);
135 int             fold_cond_ternary   (ir_value *, ast_function *, ast_ternary *);
136
137 /* intrin.c */
138 intrin_t       *intrin_init            (parser_t *parser);
139 void            intrin_cleanup         (intrin_t *intrin);
140 ast_expression *intrin_fold            (intrin_t *intrin, ast_value *, ast_expression **);
141 ast_expression *intrin_func            (intrin_t *intrin, const char *name);
142 ast_expression *intrin_debug_typestring(intrin_t *intrin);
143
144 #endif