cpp
[m6w6/ext-psi] / src / cpp_tokiter.c
1 /*******************************************************************************
2 Copyright (c) 2017, Michael Wallner <mike@php.net>.
3 All rights reserved.
4
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions are met:
7
8 * Redistributions of source code must retain the above copyright notice,
9 this list of conditions and the following disclaimer.
10 * Redistributions in binary form must reproduce the above copyright
11 notice, this list of conditions and the following disclaimer in the
12 documentation and/or other materials provided with the distribution.
13
14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
18 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
22 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 *******************************************************************************/
25
26 #include "php_psi_stdinc.h"
27
28 #include "cpp.h"
29 #include "parser.h"
30
31 #if PSI_CPP_DEBUG > 1
32 void psi_cpp_tokiter_dump(int fd, struct psi_cpp *cpp)
33 {
34 size_t i = cpp->index;
35 struct psi_token *T;
36
37 if (i > 20) {
38 i -= 20;
39 } else {
40 i = 0;
41 }
42 while (psi_plist_get(cpp->tokens, i, &T)) {
43 dprintf(fd, "PSI: CPP tokens %5zu %c ", i, cpp->index == i ? '*' : ' ');
44 psi_token_dump(fd, T);
45 if (i >= cpp->index + 10) {
46 dprintf(fd, "PSI: CPP tokens .....\n");
47 break;
48 }
49 ++i;
50 }
51 }
52 #endif
53
54 void psi_cpp_tokiter_reset(struct psi_cpp *cpp)
55 {
56 #if PSI_CPP_DEBUG
57 fprintf(stderr, "PSI: CPP reset (%zu tokens)\n", psi_plist_count(cpp->tokens));
58 # if PSI_CPP_DEBUG > 1
59 psi_cpp_tokiter_dump(2, cpp);
60 # endif
61 #endif
62 cpp->index = 0;
63 cpp->expanded = 0;
64 }
65
66 bool psi_cpp_tokiter_seek(struct psi_cpp *cpp, size_t index)
67 {
68 if (index < psi_plist_count(cpp->tokens)) {
69 cpp->index = index;
70 return true;
71 }
72 return false;
73 }
74
75 struct psi_token *psi_cpp_tokiter_current(struct psi_cpp *cpp)
76 {
77 struct psi_token *current = NULL;
78 bool found = psi_plist_get(cpp->tokens, cpp->index, &current);
79
80 assert(found);
81
82 return current;
83 }
84
85 size_t psi_cpp_tokiter_index(struct psi_cpp *cpp)
86 {
87 return cpp->index;
88 }
89
90 void psi_cpp_tokiter_next(struct psi_cpp *cpp)
91 {
92 #if 0 && PSI_CPP_DEBUG
93 fprintf(stderr, "PSI: CPP next -> index=%zu -> index=%zu\n", cpp->index, cpp->index+1);
94 #endif
95 ++cpp->index;
96 }
97
98 void psi_cpp_tokiter_prev(struct psi_cpp *cpp)
99 {
100 #if 0 && PSI_CPP_DEBUG
101 fprintf(stderr, "PSI: CPP prev -> index=%zu -> index=%zu\n", cpp->index, cpp->index-1);
102 #endif
103 if (cpp->index) {
104 --cpp->index;
105 }
106 }
107
108 bool psi_cpp_tokiter_valid(struct psi_cpp *cpp)
109 {
110 #if 0 && PSI_CPP_DEBUG
111 fprintf(stderr, "PSI: CPP valid -> index=%zu -> %d\n", cpp->index, cpp->index < psi_plist_count(cpp->tokens));
112 #endif
113 return cpp->index < psi_plist_count(cpp->tokens);
114 }
115
116 bool psi_cpp_tokiter_del_cur(struct psi_cpp *cpp, bool free_token)
117 {
118 struct psi_token *cur = NULL;
119 bool deleted = psi_plist_del(cpp->tokens, cpp->index, &cur);
120 size_t count;
121
122 #if PSI_CPP_DEBUG
123 fprintf(stderr, "PSI: CPP del_cur -> index=%zu, del=%d, free=%d, count=%zu ",
124 cpp->index, (int) deleted, (int) free_token, psi_plist_count(cpp->tokens));
125 if (cur) {
126 psi_token_dump(2, cur);
127 } else {
128 fprintf(stderr, "NULL\n");
129 }
130 #endif
131 if (cur && free_token) {
132 free(cur);
133 }
134 count = psi_plist_count(cpp->tokens);
135 if (deleted && cpp->index >= count) {
136 if (count > 0) {
137 cpp->index = count - 1;
138 } else {
139 cpp->index = 0;
140 }
141 }
142 return deleted;
143 }
144
145 bool psi_cpp_tokiter_del_range(struct psi_cpp *cpp, size_t offset, size_t num_eles, bool free_tokens)
146 {
147 struct psi_token **ptr;
148 bool deleted;
149
150 if (free_tokens) {
151 ptr = calloc(num_eles, sizeof(*ptr));
152 } else {
153 ptr = NULL;
154 }
155
156 #if PSI_CPP_DEBUG
157 fprintf(stderr, "PSI: CPP del_range -> index=%zu, offset=%zu, num_eles=%zu, count=%zu\n",
158 cpp->index, offset, num_eles, psi_plist_count(cpp->tokens));
159 #endif
160
161 deleted = psi_plist_del_r(cpp->tokens, offset, num_eles, (void *) ptr);
162
163 if (deleted) {
164 size_t count = psi_plist_count(cpp->tokens);
165
166 if (cpp->index >= count) {
167 if (count > 0) {
168 cpp->index = count - 1;
169 } else {
170 cpp->index = 0;
171 }
172 }
173
174 if (free_tokens) {
175 while (num_eles--) {
176 if (ptr[num_eles]) {
177 free(ptr[num_eles]);
178 }
179 }
180 free(ptr);
181 }
182 }
183 return deleted;
184 }
185
186 bool psi_cpp_tokiter_ins_cur(struct psi_cpp *cpp, struct psi_token *tok)
187 {
188 struct psi_plist *tokens = psi_plist_ins(cpp->tokens, cpp->index, &tok);
189
190 #if PSI_CPP_DEBUG
191 fprintf(stderr, "PSI: CPP ins_cur -> index=%zu ", cpp->index);
192 psi_token_dump(2, tok);
193 #endif
194
195 if (!tokens) {
196 return false;
197 }
198 cpp->tokens = tokens;
199 return true;
200 }
201
202 bool psi_cpp_tokiter_ins_range(struct psi_cpp *cpp, size_t offset,
203 size_t num_eles, void **eles)
204 {
205 struct psi_plist *tokens;
206
207 if (!num_eles) {
208 return true;
209 }
210
211 tokens = psi_plist_ins_r(cpp->tokens, offset, num_eles, eles);
212
213 #if PSI_CPP_DEBUG
214 fprintf(stderr, "PSI: CPP ins_range -> index=%zu, offset=%zu, num_eles=%zu, count=%zu\n",
215 cpp->index, offset, num_eles, psi_plist_count(tokens));
216 #endif
217
218 if (!tokens) {
219 return false;
220 }
221 cpp->tokens = tokens;
222 return true;
223 }
224
225 bool psi_cpp_tokiter_defined(struct psi_cpp *cpp)
226 {
227 if (psi_cpp_tokiter_valid(cpp)) {
228 struct psi_token *current = psi_cpp_tokiter_current(cpp);
229
230 return psi_cpp_defined(cpp, current);
231 }
232
233 return false;
234 }
235
236 void psi_cpp_tokiter_expand_tokens(struct psi_cpp *cpp, struct psi_plist *tokens)
237 {
238 if (tokens && psi_plist_count(tokens)) {
239 size_t i = 0, n = 0;
240 bool stringify = false, paste = false;
241 struct psi_token *tok, **exp_tokens = calloc(psi_plist_count(tokens), sizeof(*exp_tokens));
242
243 while (psi_plist_get(tokens, i++, &tok)) {
244 struct psi_token *new_tok;
245
246 if (tok->type == PSI_T_EOL) {
247 continue;
248 }
249 if (tok->type == PSI_T_HASH) {
250 stringify = true;
251 continue;
252 }
253 if (tok->type == PSI_T_CPP_PASTE) {
254 paste = true;
255 continue;
256 }
257
258 if (paste && n > 0 && exp_tokens[n - 1] &&
259 (new_tok = psi_token_cat(NULL, 2, exp_tokens[n - 1], tok))) {
260 free(exp_tokens[n - 1]);
261 exp_tokens[n - 1] = new_tok;
262 } else {
263 struct psi_token *cpy = psi_token_copy(tok);
264
265 if (stringify) {
266 cpy->type = PSI_T_QUOTED_STRING;
267 }
268 exp_tokens[n++] = cpy;
269 }
270
271 #if PSI_CPP_DEBUG
272 fprintf(stderr, "PSI: CPP expand > ");
273 psi_token_dump(2, tok);
274 #endif
275
276 paste = false;
277 stringify = false;
278 }
279 psi_cpp_tokiter_ins_range(cpp, psi_cpp_tokiter_index(cpp), n, (void *) exp_tokens);
280 free(exp_tokens);
281 }
282 }
283
284 static void psi_cpp_tokiter_free_call_tokens(struct psi_plist **arg_tokens_list, size_t arg_count, bool free_tokens)
285 {
286 size_t i;
287
288 for (i = 0; i < arg_count; ++i) {
289 if (arg_tokens_list[i]) {
290 if (free_tokens) {
291 struct psi_token *tok;
292
293 while (psi_plist_pop(arg_tokens_list[i], &tok)) {
294 free(tok);
295 }
296 }
297 psi_plist_free(arg_tokens_list[i]);
298 }
299 }
300 free(arg_tokens_list);
301 }
302
303 static struct psi_plist **psi_cpp_tokiter_read_call_tokens(
304 struct psi_cpp *cpp, size_t arg_count)
305 {
306 size_t arg_index = 0, lparens = 1, rparens = 0;
307 struct psi_plist **arg_tokens = calloc(arg_count, sizeof(*arg_tokens));
308 struct psi_plist *free_tokens = psi_plist_init((psi_plist_dtor) psi_token_free);
309 struct psi_token *tok;
310
311 arg_tokens[0] = psi_plist_init(NULL);
312
313 /* free macro name token on success */
314 tok = psi_cpp_tokiter_current(cpp);
315 free_tokens = psi_plist_add(free_tokens, &tok);
316
317 /* next token must be a LPAREN for a macro call */
318 psi_cpp_tokiter_next(cpp);
319 tok = psi_cpp_tokiter_current(cpp);
320 if (!psi_cpp_tokiter_valid(cpp) || tok->type != PSI_T_LPAREN) {
321 goto fail;
322 }
323
324 /* free LPAREN on success */
325 free_tokens = psi_plist_add(free_tokens, &tok);
326
327 while (lparens > rparens) {
328 psi_cpp_tokiter_next(cpp);
329 if (!psi_cpp_tokiter_valid(cpp)) {
330 goto fail;
331 }
332 tok = psi_cpp_tokiter_current(cpp);
333
334 switch (tok->type) {
335 case PSI_T_LPAREN:
336 ++lparens;
337 arg_tokens[arg_index] = psi_plist_add(arg_tokens[arg_index], &tok);
338 break;
339 case PSI_T_RPAREN:
340 if (++rparens == lparens) {
341 /* closing RPAREN */
342 if (arg_index + 1 < arg_count) {
343 goto fail;
344 }
345 free_tokens = psi_plist_add(free_tokens, &tok);
346 } else {
347 arg_tokens[arg_index] = psi_plist_add(arg_tokens[arg_index], &tok);
348 }
349 break;
350 case PSI_T_COMMA:
351 if (1 == (lparens - rparens)) {
352 /* too many commas? */
353 if (++arg_index >= arg_count) {
354 goto fail;
355 }
356 free_tokens = psi_plist_add(free_tokens, &tok);
357 /* next arg */
358 arg_tokens[arg_index] = psi_plist_init(NULL);
359 } else {
360 arg_tokens[arg_index] = psi_plist_add(arg_tokens[arg_index], &tok);
361 }
362 break;
363 default:
364 arg_tokens[arg_index] = psi_plist_add(arg_tokens[arg_index], &tok);
365 }
366 }
367
368 psi_plist_free(free_tokens);
369 return arg_tokens;
370
371 fail:
372 psi_cpp_tokiter_free_call_tokens(arg_tokens, arg_count, false);
373 return NULL;
374 }
375
376 static void psi_cpp_tokiter_expand_call_tokens(struct psi_cpp *cpp,
377 struct psi_cpp_macro_decl *macro, struct psi_plist **arg_tokens_list)
378 {
379 size_t i;
380 struct psi_token *tok;
381 struct psi_plist *tokens = psi_plist_init(NULL);
382
383 for (i = 0; psi_plist_get(macro->tokens, i, &tok); ++i) {
384 struct psi_plist *arg_tokens = NULL;
385
386 if (tok->type == PSI_T_NAME) {
387 size_t s;
388 struct psi_token *arg_name;
389
390 for (s = 0; psi_plist_get(macro->sig, s, &arg_name); ++s) {
391 if (arg_name->size == tok->size) {
392 if (!memcmp(arg_name->text, tok->text, tok->size)) {
393 arg_tokens = arg_tokens_list[s];
394 break;
395 }
396 }
397 }
398 }
399
400 if (arg_tokens) {
401 tokens = psi_plist_add_r(tokens, psi_plist_count(arg_tokens), psi_plist_eles(arg_tokens));
402 } else {
403 tokens = psi_plist_add(tokens, &tok);
404 }
405 }
406
407 psi_cpp_tokiter_expand_tokens(cpp, tokens);
408 psi_plist_free(tokens);
409 }
410
411 static bool psi_cpp_tokiter_expand_call(struct psi_cpp *cpp,
412 struct psi_cpp_macro_decl *macro)
413 {
414 /* function-like macro
415 * #define FOO(a,b) a>b // macro->sig == {a, b}, macro->tokens = {a, >, b}
416 * # if FOO(1,2) // expands to if 1 > 2
417 */
418 size_t start = psi_cpp_tokiter_index(cpp);
419 struct psi_plist **arg_tokens_list;
420
421 /* read in tokens, until we have balanced parens */
422 arg_tokens_list = psi_cpp_tokiter_read_call_tokens(cpp, psi_plist_count(macro->sig));
423 if (!arg_tokens_list) {
424 psi_cpp_tokiter_seek(cpp, start);
425 return false;
426 }
427
428 /* ditch arg tokens */
429 psi_cpp_tokiter_del_range(cpp, start, psi_cpp_tokiter_index(cpp) - start + 1, false);
430 psi_cpp_tokiter_seek(cpp, start);
431
432 /* insert and expand macro tokens */
433 psi_cpp_tokiter_expand_call_tokens(cpp, macro, arg_tokens_list);
434 psi_cpp_tokiter_free_call_tokens(arg_tokens_list, psi_plist_count(macro->sig), true);
435
436 /* back to where we took off */
437 psi_cpp_tokiter_seek(cpp, start);
438 ++cpp->expanded;
439 return true;
440 }
441
442 bool psi_cpp_tokiter_expand(struct psi_cpp *cpp)
443 {
444 if (psi_cpp_tokiter_valid(cpp)) {
445 struct psi_token *current = psi_cpp_tokiter_current(cpp);
446
447 if (current) {
448 struct psi_cpp_macro_decl *macro = zend_hash_str_find_ptr(
449 &cpp->defs, current->text, current->size);
450
451 /* don't expand itself */
452 if (macro && macro->token != current) {
453 #if PSI_CPP_DEBUG
454 fprintf(stderr, "PSI: CPP expand < ");
455 psi_token_dump(2, current);
456 #endif
457 if (macro->sig) {
458 return psi_cpp_tokiter_expand_call(cpp, macro);
459 } else {
460 size_t index = psi_cpp_tokiter_index(cpp);
461
462 /* delete current token from stream */
463 psi_cpp_tokiter_del_cur(cpp, true);
464
465 if (index != psi_cpp_tokiter_index(cpp)) {
466 /* might have been last token */
467 psi_cpp_tokiter_next(cpp);
468 }
469 /* replace with tokens from macro */
470 psi_cpp_tokiter_expand_tokens(cpp, macro->tokens);
471
472 ++cpp->expanded;
473 return true;
474 }
475 }
476 }
477 }
478 return false;
479 }