lexi.c revision 1.206 1 /* $NetBSD: lexi.c,v 1.206 2023/05/23 18:16:28 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.206 2023/05/23 18:16:28 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 lexer_symbol lsym = lsym_word;
387 if (kw != NULL) {
388 if (kw->lsym == lsym_type)
389 lsym = lsym_type_in_parentheses;
390 ps.next_unary = true;
391 if (kw->lsym == lsym_tag || kw->lsym == lsym_type)
392 goto found_typename;
393 return kw->lsym;
394 }
395
396 if (is_typename()) {
397 lsym = lsym_type_in_parentheses;
398 ps.next_unary = true;
399 found_typename:
400 if (ps.nparen > 0) {
401 /* inside parentheses: cast, param list, offsetof or
402 * sizeof */
403 if (ps.paren[ps.nparen - 1].cast == cast_unknown)
404 ps.paren[ps.nparen - 1].cast = cast_maybe;
405 }
406 if (ps.prev_token != lsym_period
407 && ps.prev_token != lsym_unary_op) {
408 if (kw != NULL && kw->lsym == lsym_tag)
409 return lsym_tag;
410 if (ps.nparen == 0)
411 return lsym_type_outside_parentheses;
412 }
413 }
414
415 if (inp.st[0] == '(' && ps.tos <= 1 && ps.ind_level == 0 &&
416 !ps.in_func_def_params && !ps.block_init) {
417
418 if (ps.nparen == 0 && probably_looking_at_definition()) {
419 ps.is_function_definition = true;
420 if (ps.in_decl)
421 ps.in_func_def_params = true;
422 return lsym_funcname;
423 }
424
425 } else if (ps.nparen == 0 && probably_typename()) {
426 ps.next_unary = true;
427 return lsym_type_outside_parentheses;
428 }
429
430 return lsym;
431 }
432
433 static bool
434 is_asterisk_unary(void)
435 {
436 if (ps.decl_ptr == dp_word)
437 return true;
438 if (ps.next_unary || ps.in_func_def_params)
439 return true;
440 if (ps.prev_token == lsym_word ||
441 ps.prev_token == lsym_rparen_or_rbracket)
442 return false;
443 return ps.in_decl && ps.nparen > 0;
444 }
445
446 static bool
447 probably_in_function_definition(void)
448 {
449 for (const char *tp = inp.st; *tp != '\n';) {
450 if (ch_isspace(*tp))
451 tp++;
452 else if (is_identifier_start(*tp)) {
453 tp++;
454 while (is_identifier_part(*tp))
455 tp++;
456 } else
457 return *tp == '(';
458 }
459 return false;
460 }
461
462 static void
463 lex_asterisk_unary(void)
464 {
465 while (inp.st[0] == '*' || ch_isspace(inp.st[0])) {
466 if (inp.st[0] == '*')
467 token_add_char('*');
468 inp_skip();
469 }
470
471 if (ps.in_decl && probably_in_function_definition())
472 ps.is_function_definition = true;
473 }
474
475 static void
476 skip_blank(const char **pp)
477 {
478 while (ch_isblank(**pp))
479 (*pp)++;
480 }
481
482 static bool
483 skip_string(const char **pp, const char *s)
484 {
485 size_t len = strlen(s);
486 if (strncmp(*pp, s, len) == 0) {
487 *pp += len;
488 return true;
489 }
490 return false;
491 }
492
493 static void
494 lex_indent_comment(void)
495 {
496 const char *p = inp.mem;
497
498 skip_blank(&p);
499 if (!skip_string(&p, "/*"))
500 return;
501 skip_blank(&p);
502 if (!skip_string(&p, "INDENT"))
503 return;
504
505 enum indent_enabled enabled;
506 skip_blank(&p);
507 if (*p == '*' || skip_string(&p, "ON"))
508 enabled = indent_last_off_line;
509 else if (skip_string(&p, "OFF"))
510 enabled = indent_off;
511 else
512 return;
513
514 skip_blank(&p);
515 if (!skip_string(&p, "*/\n"))
516 return;
517
518 if (lab.len > 0 || code.len > 0 || com.len > 0)
519 output_line();
520
521 indent_enabled = enabled;
522 }
523
524 /* Reads the next token, placing it in the global variable "token". */
525 lexer_symbol
526 lexi(void)
527 {
528 token.len = 0;
529 ps.curr_col_1 = ps.next_col_1;
530 ps.next_col_1 = false;
531
532 for (;;) {
533 if (ch_isblank(inp.st[0])) {
534 ps.curr_col_1 = false;
535 inp.st++;
536 } else if (inp.st[0] == '\\' && inp.st[1] == '\n') {
537 inp.st++;
538 inp_skip();
539 line_no++;
540 } else
541 break;
542 }
543
544 lexer_symbol alnum_lsym = lexi_alnum();
545 if (alnum_lsym != lsym_eof)
546 return alnum_lsym;
547
548 /* Scan a non-alphanumeric token */
549
550 token_add_char(inp_next());
551
552 lexer_symbol lsym;
553 bool next_unary;
554
555 switch (token.mem[token.len - 1]) {
556
557 /* INDENT OFF */
558 case '(':
559 case '[': lsym = lsym_lparen_or_lbracket; next_unary = true; break;
560 case ')':
561 case ']': lsym = lsym_rparen_or_rbracket; next_unary = false; break;
562 case '?': lsym = lsym_question; next_unary = true; break;
563 case ':': lsym = lsym_colon; next_unary = true; break;
564 case ';': lsym = lsym_semicolon; next_unary = true; break;
565 case '{': lsym = lsym_lbrace; next_unary = true; break;
566 case '}': lsym = lsym_rbrace; next_unary = true; break;
567 case ',': lsym = lsym_comma; next_unary = true; break;
568 case '.': lsym = lsym_period; next_unary = false; break;
569 /* INDENT ON */
570
571 case '\n':
572 /* if data has been exhausted, the '\n' is a dummy. */
573 lsym = had_eof ? lsym_eof : lsym_newline;
574 next_unary = ps.next_unary;
575 ps.next_col_1 = true;
576 break;
577
578 case '#':
579 lsym = lsym_preprocessing;
580 next_unary = ps.next_unary;
581 break;
582
583 case '\'':
584 case '"':
585 lex_char_or_string();
586 lsym = lsym_word;
587 next_unary = false;
588 break;
589
590 case '-':
591 case '+':
592 lsym = ps.next_unary ? lsym_unary_op : lsym_binary_op;
593 next_unary = true;
594
595 /* '++' or '--' */
596 if (inp.st[0] == token.mem[token.len - 1]) {
597 token_add_char(*inp.st++);
598 if (ps.prev_token == lsym_word ||
599 ps.prev_token == lsym_rparen_or_rbracket) {
600 lsym = ps.next_unary
601 ? lsym_unary_op : lsym_postfix_op;
602 next_unary = false;
603 }
604
605 } else if (inp.st[0] == '=') { /* '+=' or '-=' */
606 token_add_char(*inp.st++);
607
608 } else if (inp.st[0] == '>') { /* '->' */
609 token_add_char(*inp.st++);
610 lsym = lsym_unary_op;
611 next_unary = false;
612 ps.want_blank = false;
613 }
614 break;
615
616 case '=':
617 if (ps.init_or_struct)
618 ps.block_init = true;
619 if (inp.st[0] == '=')
620 token_add_char(*inp.st++);
621 lsym = lsym_binary_op;
622 next_unary = true;
623 break;
624
625 case '>':
626 case '<':
627 case '!': /* ops like <, <<, <=, !=, etc */
628 if (inp.st[0] == '>' || inp.st[0] == '<' || inp.st[0] == '=')
629 token_add_char(*inp.st++);
630 if (inp.st[0] == '=')
631 token_add_char(*inp.st++);
632 lsym = ps.next_unary ? lsym_unary_op : lsym_binary_op;
633 next_unary = true;
634 break;
635
636 case '*':
637 if (is_asterisk_unary()) {
638 lex_asterisk_unary();
639 lsym = lsym_unary_op;
640 next_unary = true;
641 } else {
642 if (inp.st[0] == '=')
643 token_add_char(*inp.st++);
644 lsym = lsym_binary_op;
645 next_unary = true;
646 }
647 break;
648
649 default:
650 if (token.mem[token.len - 1] == '/'
651 && (inp.st[0] == '*' || inp.st[0] == '/')) {
652 enum indent_enabled prev = indent_enabled;
653 lex_indent_comment();
654 if (prev == indent_on && indent_enabled == indent_off)
655 out.indent_off_text.len = 0;
656 token_add_char(*inp.st++);
657 lsym = lsym_comment;
658 next_unary = ps.next_unary;
659 break;
660 }
661
662 /* things like '||', '&&', '<<=', 'int *****i' */
663 while (inp.st[0] == token.mem[token.len - 1]
664 || inp.st[0] == '=')
665 token_add_char(*inp.st++);
666
667 lsym = ps.next_unary ? lsym_unary_op : lsym_binary_op;
668 next_unary = true;
669 }
670
671 ps.next_unary = next_unary;
672
673 return lsym;
674 }
675
676 void
677 register_typename(const char *name)
678 {
679 if (typenames.len >= typenames.cap) {
680 typenames.cap = 16 + 2 * typenames.cap;
681 typenames.items = nonnull(realloc(typenames.items,
682 sizeof(typenames.items[0]) * typenames.cap));
683 }
684
685 int pos = bsearch_typenames(name);
686 if (pos >= 0)
687 return; /* already in the list */
688
689 pos = -(pos + 1);
690 memmove(typenames.items + pos + 1, typenames.items + pos,
691 sizeof(typenames.items[0]) * (typenames.len++ - (unsigned)pos));
692 typenames.items[pos] = nonnull(strdup(name));
693 }
694