lexi.c revision 1.199 1 /* $NetBSD: lexi.c,v 1.199 2023/05/18 05:33:27 rillig Exp $ */
2
3 /*-
4 * SPDX-License-Identifier: BSD-4-Clause
5 *
6 * Copyright (c) 1985 Sun Microsystems, Inc.
7 * Copyright (c) 1980, 1993
8 * The Regents of the University of California. All rights reserved.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * SUCH DAMAGE.
38 */
39
40 #include <sys/cdefs.h>
41 __RCSID("$NetBSD: lexi.c,v 1.199 2023/05/18 05:33:27 rillig Exp $");
42
43 #include <stdlib.h>
44 #include <string.h>
45
46 #include "indent.h"
47
48 /* In lexi_alnum, this constant marks a type, independent of parentheses. */
49 #define lsym_type lsym_type_outside_parentheses
50 #define lsym_type_modifier lsym_storage_class
51
52 /* must be sorted alphabetically, is used in binary search */
53 static const struct keyword {
54 const char name[12];
55 lexer_symbol lsym;
56 } keywords[] = {
57 {"_Bool", lsym_type},
58 {"_Complex", lsym_type},
59 {"_Imaginary", lsym_type},
60 {"auto", lsym_storage_class},
61 {"bool", lsym_type},
62 {"break", lsym_word},
63 {"case", lsym_case_label},
64 {"char", lsym_type},
65 {"complex", lsym_type},
66 {"const", lsym_type_modifier},
67 {"continue", lsym_word},
68 {"default", lsym_case_label},
69 {"do", lsym_do},
70 {"double", lsym_type},
71 {"else", lsym_else},
72 {"enum", lsym_tag},
73 {"extern", lsym_storage_class},
74 {"float", lsym_type},
75 {"for", lsym_for},
76 {"goto", lsym_word},
77 {"if", lsym_if},
78 {"imaginary", lsym_type},
79 {"inline", lsym_word},
80 {"int", lsym_type},
81 {"long", lsym_type},
82 {"offsetof", lsym_offsetof},
83 {"register", lsym_storage_class},
84 {"restrict", lsym_word},
85 {"return", lsym_return},
86 {"short", lsym_type},
87 {"signed", lsym_type},
88 {"sizeof", lsym_sizeof},
89 {"static", lsym_storage_class},
90 {"struct", lsym_tag},
91 {"switch", lsym_switch},
92 {"typedef", lsym_typedef},
93 {"union", lsym_tag},
94 {"unsigned", lsym_type},
95 {"void", lsym_type},
96 {"volatile", lsym_type_modifier},
97 {"while", lsym_while}
98 };
99
100 static struct {
101 const char **items;
102 unsigned int len;
103 unsigned int cap;
104 } typenames;
105
106 /*-
107 * The transition table below was rewritten by hand from lx's output, given
108 * the following definitions. lx is Katherine Flavel's lexer generator.
109 *
110 * O = /[0-7]/; D = /[0-9]/; NZ = /[1-9]/;
111 * H = /[a-f0-9]/i; B = /[0-1]/; HP = /0x/i;
112 * BP = /0b/i; E = /e[+\-]?/i D+; P = /p[+\-]?/i D+;
113 * FS = /[fl]/i; IS = /u/i /(l|L|ll|LL)/? | /(l|L|ll|LL)/ /u/i?;
114 *
115 * D+ E FS? -> $float;
116 * D* "." D+ E? FS? -> $float;
117 * D+ "." E? FS? -> $float; HP H+ IS? -> $int;
118 * HP H+ P FS? -> $float; NZ D* IS? -> $int;
119 * HP H* "." H+ P FS? -> $float; "0" O* IS? -> $int;
120 * HP H+ "." P FS -> $float; BP B+ IS? -> $int;
121 */
122 /* INDENT OFF */
123 static const unsigned char lex_number_state[][26] = {
124 /* examples:
125 00
126 s 0xx
127 t 00xaa
128 a 11 101100xxa..
129 r 11ee0001101lbuuxx.a.pp
130 t.01.e+008bLuxll0Ll.aa.p+0
131 states: ABCDEFGHIJKLMNOPQRSTUVWXYZ */
132 [0] = "uuiifuufiuuiiuiiiiiuiuuuuu", /* (other) */
133 [1] = "CEIDEHHHIJQ U Q VUVVZZZ", /* 0 */
134 [2] = "DEIDEHHHIJQ U Q VUVVZZZ", /* 1 */
135 [3] = "DEIDEHHHIJ U VUVVZZZ", /* 2 3 4 5 6 7 */
136 [4] = "DEJDEHHHJJ U VUVVZZZ", /* 8 9 */
137 [5] = " U VUVV ", /* A a C c D d */
138 [6] = " K U VUVV ", /* B b */
139 [7] = " FFF FF U VUVV ", /* E e */
140 [8] = " f f U VUVV f", /* F f */
141 [9] = " LLf fL PR Li L f", /* L */
142 [10] = " OOf fO S P O i O f", /* l */
143 [11] = " FFX ", /* P p */
144 [12] = " MM M i iiM M ", /* U u */
145 [13] = " N ", /* X x */
146 [14] = " G Y ", /* + - */
147 [15] = "B EE EE T W ", /* . */
148 /* ABCDEFGHIJKLMNOPQRSTUVWXYZ */
149 };
150 /* INDENT ON */
151
152 static const unsigned char lex_number_row[] = {
153 ['0'] = 1,
154 ['1'] = 2,
155 ['2'] = 3, ['3'] = 3, ['4'] = 3, ['5'] = 3, ['6'] = 3, ['7'] = 3,
156 ['8'] = 4, ['9'] = 4,
157 ['A'] = 5, ['a'] = 5, ['C'] = 5, ['c'] = 5, ['D'] = 5, ['d'] = 5,
158 ['B'] = 6, ['b'] = 6,
159 ['E'] = 7, ['e'] = 7,
160 ['F'] = 8, ['f'] = 8,
161 ['L'] = 9,
162 ['l'] = 10,
163 ['P'] = 11, ['p'] = 11,
164 ['U'] = 12, ['u'] = 12,
165 ['X'] = 13, ['x'] = 13,
166 ['+'] = 14, ['-'] = 14,
167 ['.'] = 15,
168 };
169
170 static void
171 token_add_char(char ch)
172 {
173 buf_add_char(&token, ch);
174 }
175
176 static void
177 lex_number(void)
178 {
179 for (unsigned char s = 'A'; s != 'f' && s != 'i' && s != 'u';) {
180 unsigned char ch = (unsigned char)inp.st[0];
181 if (ch == '\\' && inp.st[1] == '\n') {
182 inp.st++;
183 inp_skip();
184 line_no++;
185 continue;
186 }
187 if (ch >= array_length(lex_number_row)
188 || lex_number_row[ch] == 0)
189 break;
190
191 unsigned char row = lex_number_row[ch];
192 if (lex_number_state[row][s - 'A'] == ' ') {
193 /*-
194 * lex_number_state[0][s - 'A'] now indicates the type:
195 * f = floating, i = integer, u = unknown
196 */
197 return;
198 }
199
200 s = lex_number_state[row][s - 'A'];
201 token_add_char(inp_next());
202 }
203 }
204
205 static bool
206 is_identifier_start(char ch)
207 {
208 return ch_isalpha(ch) || ch == '_' || ch == '$';
209 }
210
211 static bool
212 is_identifier_part(char ch)
213 {
214 return ch_isalnum(ch) || ch == '_' || ch == '$';
215 }
216
217 static void
218 lex_word(void)
219 {
220 for (;;) {
221 if (is_identifier_part(inp.st[0]))
222 token_add_char(*inp.st++);
223 else if (inp.st[0] == '\\' && inp.st[1] == '\n') {
224 inp.st++;
225 inp_skip();
226 line_no++;
227 } else
228 return;
229 }
230 }
231
232 static void
233 lex_char_or_string(void)
234 {
235 for (char delim = token.mem[token.len - 1];;) {
236 if (inp.st[0] == '\n') {
237 diag(1, "Unterminated literal");
238 return;
239 }
240
241 token_add_char(*inp.st++);
242 if (token.mem[token.len - 1] == delim)
243 return;
244
245 if (token.mem[token.len - 1] == '\\') {
246 if (inp.st[0] == '\n')
247 ++line_no;
248 token_add_char(inp_next());
249 }
250 }
251 }
252
253 /* Guess whether the current token is a declared type. */
254 static bool
255 probably_typename(void)
256 {
257 if (ps.prev_token == lsym_storage_class)
258 return true;
259 if (ps.block_init)
260 return false;
261 if (ps.in_stmt_or_decl) /* XXX: this condition looks incorrect */
262 return false;
263 if (inp.st[0] == '*' && inp.st[1] != '=')
264 goto maybe;
265 /* XXX: is_identifier_start */
266 if (ch_isalpha(inp.st[0]))
267 goto maybe;
268 return false;
269 maybe:
270 return ps.prev_token == lsym_semicolon ||
271 ps.prev_token == lsym_lbrace ||
272 ps.prev_token == lsym_rbrace;
273 }
274
275 static int
276 bsearch_typenames(const char *key)
277 {
278 const char **arr = typenames.items;
279 int lo = 0;
280 int hi = (int)typenames.len - 1;
281
282 while (lo <= hi) {
283 int mid = (int)((unsigned)(lo + hi) >> 1);
284 int cmp = strcmp(arr[mid], key);
285 if (cmp < 0)
286 lo = mid + 1;
287 else if (cmp > 0)
288 hi = mid - 1;
289 else
290 return mid;
291 }
292 return -(lo + 1);
293 }
294
295 static bool
296 is_typename(void)
297 {
298 if (opt.auto_typedefs &&
299 token.len >= 2 && memcmp(token.mem + token.len - 2, "_t", 2) == 0)
300 return true;
301
302 return bsearch_typenames(token.st) >= 0;
303 }
304
305 static int
306 cmp_keyword_by_name(const void *key, const void *elem)
307 {
308 return strcmp(key, ((const struct keyword *)elem)->name);
309 }
310
311 /*
312 * Looking at something like 'function_name(...)' in a line, guess whether
313 * this starts a function definition or a declaration.
314 */
315 static bool
316 probably_looking_at_definition(void)
317 {
318 int paren_level = 0;
319 for (const char *p = inp.st; *p != '\n'; p++) {
320 if (*p == '(')
321 paren_level++;
322 if (*p == ')' && --paren_level == 0) {
323 p++;
324
325 while (*p != '\n'
326 && (ch_isspace(*p) || is_identifier_part(*p)))
327 p++; /* '__dead' or '__unused' */
328
329 if (*p == '\n') /* func(...) */
330 break;
331 if (*p == ';') /* func(...); */
332 return false;
333 if (*p == ',') /* double abs(), pi; */
334 return false;
335 if (*p == '(') /* func(...) __attribute__((...)) */
336 paren_level++; /* func(...) __printflike(...)
337 */
338 else
339 break; /* func(...) { ... */
340 }
341 }
342
343 /* To further reduce the cases where indent wrongly treats an
344 * incomplete function declaration as a function definition, thus
345 * adding a newline before the function name, it may be worth looking
346 * for parameter names, as these are often omitted in function
347 * declarations and only included in function definitions. Or just
348 * increase the lookahead to more than just the current line of input,
349 * until the next '{'. */
350 return true;
351 }
352
353 /* Read an alphanumeric token into 'token', or return lsym_eof. */
354 static lexer_symbol
355 lexi_alnum(void)
356 {
357 if (ch_isdigit(inp.st[0]) ||
358 (inp.st[0] == '.' && ch_isdigit(inp.st[1]))) {
359 lex_number();
360 } else if (is_identifier_start(inp.st[0])) {
361 lex_word();
362
363 if (token.len == 1 && token.st[0] == 'L' &&
364 (inp.st[0] == '"' || inp.st[0] == '\'')) {
365 token_add_char(*inp.st++);
366 lex_char_or_string();
367 ps.next_unary = false;
368 return lsym_word;
369 }
370 } else
371 return lsym_eof; /* just as a placeholder */
372
373 while (ch_isblank(inp.st[0]))
374 inp.st++;
375
376 ps.next_unary = ps.prev_token == lsym_tag
377 || ps.prev_token == lsym_typedef;
378
379 if (ps.prev_token == lsym_tag && ps.nparen == 0)
380 return lsym_type_outside_parentheses;
381
382 token_add_char('\0');
383 token.len--;
384 const struct keyword *kw = bsearch(token.st, keywords,
385 array_length(keywords), sizeof(keywords[0]), cmp_keyword_by_name);
386 bool is_type = false;
387 if (kw == NULL) {
388 if (is_typename()) {
389 is_type = true;
390 ps.next_unary = true;
391 if (ps.in_enum == in_enum_enum)
392 ps.in_enum = in_enum_type;
393 goto found_typename;
394 }
395
396 } else { /* we have a keyword */
397 is_type = kw->lsym == lsym_type;
398 ps.next_unary = true;
399 if (kw->lsym != lsym_tag && kw->lsym != lsym_type)
400 return kw->lsym;
401
402 found_typename:
403 if (ps.nparen > 0) {
404 /* inside parentheses: cast, param list, offsetof or
405 * sizeof */
406 if (ps.paren[ps.nparen - 1].cast == cast_unknown)
407 ps.paren[ps.nparen - 1].cast = cast_maybe;
408 }
409 if (ps.prev_token != lsym_period
410 && ps.prev_token != lsym_unary_op) {
411 if (kw != NULL && kw->lsym == lsym_tag) {
412 if (token.st[0] == 'e' /* enum */)
413 ps.in_enum = in_enum_enum;
414 return lsym_tag;
415 }
416 if (ps.nparen == 0)
417 return lsym_type_outside_parentheses;
418 }
419 }
420
421 if (inp.st[0] == '(' && ps.tos <= 1 && ps.ind_level == 0 &&
422 !ps.in_func_def_params && !ps.block_init) {
423
424 if (ps.nparen == 0 && probably_looking_at_definition()) {
425 ps.is_function_definition = true;
426 if (ps.in_decl)
427 ps.in_func_def_params = true;
428 return lsym_funcname;
429 }
430
431 } else if (ps.nparen == 0 && probably_typename()) {
432 ps.next_unary = true;
433 return lsym_type_outside_parentheses;
434 }
435
436 return is_type ? lsym_type_in_parentheses : lsym_word;
437 }
438
439 static bool
440 is_asterisk_unary(void)
441 {
442 if (ps.next_unary || ps.in_func_def_params)
443 return true;
444 if (ps.prev_token == lsym_word ||
445 ps.prev_token == lsym_rparen_or_rbracket)
446 return false;
447 return ps.in_decl && ps.nparen > 0;
448 }
449
450 static void
451 lex_asterisk_unary(void)
452 {
453 while (inp.st[0] == '*' || ch_isspace(inp.st[0])) {
454 if (inp.st[0] == '*')
455 token_add_char('*');
456 inp_skip();
457 }
458
459 if (ps.in_decl) {
460 for (const char *tp = inp.st; *tp != '\n';) {
461 if (ch_isspace(*tp))
462 tp++;
463 else if (is_identifier_start(*tp)) {
464 tp++;
465 while (is_identifier_part(*tp))
466 tp++;
467 } else {
468 if (*tp == '(')
469 ps.is_function_definition = true;
470 break;
471 }
472 }
473 }
474 }
475
476 static void
477 skip_blank(const char **pp)
478 {
479 while (ch_isblank(**pp))
480 (*pp)++;
481 }
482
483 static bool
484 skip_string(const char **pp, const char *s)
485 {
486 size_t len = strlen(s);
487 if (strncmp(*pp, s, len) == 0) {
488 *pp += len;
489 return true;
490 }
491 return false;
492 }
493
494 static void
495 lex_indent_comment(void)
496 {
497 const char *p = inp.mem;
498
499 skip_blank(&p);
500 if (!skip_string(&p, "/*"))
501 return;
502 skip_blank(&p);
503 if (!skip_string(&p, "INDENT"))
504 return;
505
506 enum indent_enabled enabled;
507 skip_blank(&p);
508 if (*p == '*' || skip_string(&p, "ON"))
509 enabled = indent_last_off_line;
510 else if (skip_string(&p, "OFF"))
511 enabled = indent_off;
512 else
513 return;
514
515 skip_blank(&p);
516 if (!skip_string(&p, "*/\n"))
517 return;
518
519 if (lab.len > 0 || code.len > 0 || com.len > 0)
520 output_line();
521
522 indent_enabled = enabled;
523 }
524
525 /* Reads the next token, placing it in the global variable "token". */
526 lexer_symbol
527 lexi(void)
528 {
529 token.len = 0;
530 ps.curr_col_1 = ps.next_col_1;
531 ps.next_col_1 = false;
532
533 for (;;) {
534 if (ch_isblank(inp.st[0])) {
535 ps.curr_col_1 = false;
536 inp.st++;
537 } else if (inp.st[0] == '\\' && inp.st[1] == '\n') {
538 inp.st++;
539 inp_skip();
540 line_no++;
541 } else
542 break;
543 }
544
545 lexer_symbol alnum_lsym = lexi_alnum();
546 if (alnum_lsym != lsym_eof) {
547 debug_parser_state(alnum_lsym);
548 return alnum_lsym;
549 }
550
551 /* Scan a non-alphanumeric token */
552
553 token_add_char(inp_next());
554
555 lexer_symbol lsym;
556 bool next_unary;
557
558 switch (token.mem[token.len - 1]) {
559
560 /* INDENT OFF */
561 case '(':
562 case '[': lsym = lsym_lparen_or_lbracket; next_unary = true; break;
563 case ')':
564 case ']': lsym = lsym_rparen_or_rbracket; next_unary = false; break;
565 case '?': lsym = lsym_question; next_unary = true; break;
566 case ':': lsym = lsym_colon; next_unary = true; break;
567 case ';': lsym = lsym_semicolon; next_unary = true; break;
568 case '{': lsym = lsym_lbrace; next_unary = true; break;
569 case '}': lsym = lsym_rbrace; next_unary = true; break;
570 case ',': lsym = lsym_comma; next_unary = true; break;
571 case '.': lsym = lsym_period; next_unary = false; break;
572 /* INDENT ON */
573
574 case '\n':
575 /* if data has been exhausted, the '\n' is a dummy. */
576 lsym = had_eof ? lsym_eof : lsym_newline;
577 next_unary = ps.next_unary;
578 ps.next_col_1 = true;
579 break;
580
581 case '#':
582 lsym = lsym_preprocessing;
583 next_unary = ps.next_unary;
584 break;
585
586 case '\'':
587 case '"':
588 lex_char_or_string();
589 lsym = lsym_word;
590 next_unary = false;
591 break;
592
593 case '-':
594 case '+':
595 lsym = ps.next_unary ? lsym_unary_op : lsym_binary_op;
596 next_unary = true;
597
598 /* '++' or '--' */
599 if (inp.st[0] == token.mem[token.len - 1]) {
600 token_add_char(*inp.st++);
601 if (ps.prev_token == lsym_word ||
602 ps.prev_token == lsym_rparen_or_rbracket) {
603 lsym = ps.next_unary
604 ? lsym_unary_op : lsym_postfix_op;
605 next_unary = false;
606 }
607
608 } else if (inp.st[0] == '=') { /* '+=' or '-=' */
609 token_add_char(*inp.st++);
610
611 } else if (inp.st[0] == '>') { /* '->' */
612 token_add_char(*inp.st++);
613 lsym = lsym_unary_op;
614 next_unary = false;
615 ps.want_blank = false;
616 }
617 break;
618
619 case '=':
620 if (ps.init_or_struct)
621 ps.block_init = true;
622 if (inp.st[0] == '=')
623 token_add_char(*inp.st++);
624 lsym = lsym_binary_op;
625 next_unary = true;
626 break;
627
628 case '>':
629 case '<':
630 case '!': /* ops like <, <<, <=, !=, etc */
631 if (inp.st[0] == '>' || inp.st[0] == '<' || inp.st[0] == '=')
632 token_add_char(*inp.st++);
633 if (inp.st[0] == '=')
634 token_add_char(*inp.st++);
635 lsym = ps.next_unary ? lsym_unary_op : lsym_binary_op;
636 next_unary = true;
637 break;
638
639 case '*':
640 if (is_asterisk_unary()) {
641 lex_asterisk_unary();
642 lsym = lsym_unary_op;
643 next_unary = true;
644 } else {
645 if (inp.st[0] == '=')
646 token_add_char(*inp.st++);
647 lsym = lsym_binary_op;
648 next_unary = true;
649 }
650 break;
651
652 default:
653 if (token.mem[token.len - 1] == '/'
654 && (inp.st[0] == '*' || inp.st[0] == '/')) {
655 enum indent_enabled prev = indent_enabled;
656 lex_indent_comment();
657 if (prev == indent_on && indent_enabled == indent_off)
658 clear_indent_off_text();
659 token_add_char(*inp.st++);
660 lsym = lsym_comment;
661 next_unary = ps.next_unary;
662 break;
663 }
664
665 /* things like '||', '&&', '<<=', 'int *****i' */
666 while (inp.st[0] == token.mem[token.len - 1]
667 || inp.st[0] == '=')
668 token_add_char(*inp.st++);
669
670 lsym = ps.next_unary ? lsym_unary_op : lsym_binary_op;
671 next_unary = true;
672 }
673
674 if (ps.in_enum == in_enum_enum || ps.in_enum == in_enum_type)
675 ps.in_enum = lsym == lsym_lbrace ? in_enum_brace : in_enum_no;
676 if (lsym == lsym_rbrace)
677 ps.in_enum = in_enum_no;
678
679 ps.next_unary = next_unary;
680
681 debug_parser_state(lsym);
682 return lsym;
683 }
684
685 void
686 register_typename(const char *name)
687 {
688 if (typenames.len >= typenames.cap) {
689 typenames.cap = 16 + 2 * typenames.cap;
690 typenames.items = nonnull(realloc(typenames.items,
691 sizeof(typenames.items[0]) * typenames.cap));
692 }
693
694 int pos = bsearch_typenames(name);
695 if (pos >= 0)
696 return; /* already in the list */
697
698 pos = -(pos + 1);
699 memmove(typenames.items + pos + 1, typenames.items + pos,
700 sizeof(typenames.items[0]) * (typenames.len++ - (unsigned)pos));
701 typenames.items[pos] = nonnull(strdup(name));
702 }
703