lexi.c revision 1.221 1 /* $NetBSD: lexi.c,v 1.221 2023/06/10 06:38:21 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.221 2023/06/10 06:38:21 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
51 /* must be sorted alphabetically, is used in binary search */
52 static const struct keyword {
53 const char name[12];
54 lexer_symbol lsym;
55 } keywords[] = {
56 {"_Bool", lsym_type},
57 {"_Complex", lsym_type},
58 {"_Imaginary", lsym_type},
59 {"auto", lsym_modifier},
60 {"bool", lsym_type},
61 {"break", lsym_word},
62 {"case", lsym_case},
63 {"char", lsym_type},
64 {"complex", lsym_type},
65 {"const", lsym_modifier},
66 {"continue", lsym_word},
67 {"default", lsym_default},
68 {"do", lsym_do},
69 {"double", lsym_type},
70 {"else", lsym_else},
71 {"enum", lsym_tag},
72 {"extern", lsym_modifier},
73 {"float", lsym_type},
74 {"for", lsym_for},
75 {"goto", lsym_word},
76 {"if", lsym_if},
77 {"imaginary", lsym_type},
78 {"inline", lsym_modifier},
79 {"int", lsym_type},
80 {"long", lsym_type},
81 {"offsetof", lsym_offsetof},
82 {"register", lsym_modifier},
83 {"restrict", lsym_word},
84 {"return", lsym_return},
85 {"short", lsym_type},
86 {"signed", lsym_type},
87 {"sizeof", lsym_sizeof},
88 {"static", lsym_modifier},
89 {"struct", lsym_tag},
90 {"switch", lsym_switch},
91 {"typedef", lsym_typedef},
92 {"union", lsym_tag},
93 {"unsigned", lsym_type},
94 {"void", lsym_type},
95 {"volatile", lsym_modifier},
96 {"while", lsym_while}
97 };
98
99 static struct {
100 const char **items;
101 unsigned int len;
102 unsigned int cap;
103 } typenames;
104
105 /*-
106 * The transition table below was rewritten by hand from lx's output, given
107 * the following definitions. lx is Katherine Flavel's lexer generator.
108 *
109 * O = /[0-7]/; D = /[0-9]/; NZ = /[1-9]/;
110 * H = /[a-f0-9]/i; B = /[0-1]/; HP = /0x/i;
111 * BP = /0b/i; E = /e[+\-]?/i D+; P = /p[+\-]?/i D+;
112 * FS = /[fl]/i; IS = /u/i /(l|L|ll|LL)/? | /(l|L|ll|LL)/ /u/i?;
113 *
114 * D+ E FS? -> $float;
115 * D* "." D+ E? FS? -> $float;
116 * D+ "." E? FS? -> $float; HP H+ IS? -> $int;
117 * HP H+ P FS? -> $float; NZ D* IS? -> $int;
118 * HP H* "." H+ P FS? -> $float; "0" O* IS? -> $int;
119 * HP H+ "." P FS -> $float; BP B+ IS? -> $int;
120 */
121 /* INDENT OFF */
122 static const unsigned char lex_number_state[][26] = {
123 /* examples:
124 00
125 s 0xx
126 t 00xaa
127 a 11 101100xxa..
128 r 11ee0001101lbuuxx.a.pp
129 t.01.e+008bLuxll0Ll.aa.p+0
130 states: ABCDEFGHIJKLMNOPQRSTUVWXYZ */
131 [0] = "uuiifuufiuuiiuiiiiiuiuuuuu", /* (other) */
132 [1] = "CEIDEHHHIJQ U Q VUVVZZZ", /* 0 */
133 [2] = "DEIDEHHHIJQ U Q VUVVZZZ", /* 1 */
134 [3] = "DEIDEHHHIJ U VUVVZZZ", /* 2 3 4 5 6 7 */
135 [4] = "DEJDEHHHJJ U VUVVZZZ", /* 8 9 */
136 [5] = " U VUVV ", /* A a C c D d */
137 [6] = " K U VUVV ", /* B b */
138 [7] = " FFF FF U VUVV ", /* E e */
139 [8] = " f f U VUVV f", /* F f */
140 [9] = " LLf fL PR Li L f", /* L */
141 [10] = " OOf fO S P O i O f", /* l */
142 [11] = " FFX ", /* P p */
143 [12] = " MM M i iiM M ", /* U u */
144 [13] = " N ", /* X x */
145 [14] = " G Y ", /* + - */
146 [15] = "B EE EE T W ", /* . */
147 /* ABCDEFGHIJKLMNOPQRSTUVWXYZ */
148 };
149 /* INDENT ON */
150
151 static const unsigned char lex_number_row[] = {
152 ['0'] = 1,
153 ['1'] = 2,
154 ['2'] = 3, ['3'] = 3, ['4'] = 3, ['5'] = 3, ['6'] = 3, ['7'] = 3,
155 ['8'] = 4, ['9'] = 4,
156 ['A'] = 5, ['a'] = 5, ['C'] = 5, ['c'] = 5, ['D'] = 5, ['d'] = 5,
157 ['B'] = 6, ['b'] = 6,
158 ['E'] = 7, ['e'] = 7,
159 ['F'] = 8, ['f'] = 8,
160 ['L'] = 9,
161 ['l'] = 10,
162 ['P'] = 11, ['p'] = 11,
163 ['U'] = 12, ['u'] = 12,
164 ['X'] = 13, ['x'] = 13,
165 ['+'] = 14, ['-'] = 14,
166 ['.'] = 15,
167 };
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_p[0];
181 if (ch == '\\' && inp_p[1] == '\n') {
182 inp_p++;
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_p[0]))
222 token_add_char(*inp_p++);
223 else if (inp_p[0] == '\\' && inp_p[1] == '\n') {
224 inp_p++;
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.s[token.len - 1];;) {
236 if (inp_p[0] == '\n') {
237 diag(1, "Unterminated literal");
238 return;
239 }
240
241 token_add_char(*inp_p++);
242 if (token.s[token.len - 1] == delim)
243 return;
244
245 if (token.s[token.len - 1] == '\\') {
246 if (inp_p[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_lsym == lsym_modifier)
258 return true;
259 if (ps.in_init)
260 return false;
261 if (ps.in_stmt_or_decl) /* XXX: this condition looks incorrect */
262 return false;
263 if (ps.prev_lsym == lsym_semicolon
264 || ps.prev_lsym == lsym_lbrace
265 || ps.prev_lsym == lsym_rbrace) {
266 if (inp_p[0] == '*' && inp_p[1] != '=')
267 return true;
268 /* XXX: is_identifier_start */
269 if (ch_isalpha(inp_p[0]))
270 return true;
271 }
272 return false;
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.s + token.len - 2, "_t", 2) == 0)
300 return true;
301
302 return bsearch_typenames(token.s) >= 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_p; *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 if (paren_level == 1 && p[0] == '*' && p[1] == ',')
343 return false;
344 }
345
346 /* To further reduce the cases where indent wrongly treats an
347 * incomplete function declaration as a function definition, thus
348 * adding a newline before the function name, it may be worth looking
349 * for parameter names, as these are often omitted in function
350 * declarations and only included in function definitions. Or just
351 * increase the lookahead to more than just the current line of input,
352 * until the next '{'. */
353 return true;
354 }
355
356 /* Read an alphanumeric token into 'token', or return lsym_eof. */
357 static lexer_symbol
358 lexi_alnum(void)
359 {
360 if (ch_isdigit(inp_p[0]) ||
361 (inp_p[0] == '.' && ch_isdigit(inp_p[1]))) {
362 lex_number();
363 } else if (is_identifier_start(inp_p[0])) {
364 lex_word();
365
366 if (token.len == 1 && token.s[0] == 'L' &&
367 (inp_p[0] == '"' || inp_p[0] == '\'')) {
368 token_add_char(*inp_p++);
369 lex_char_or_string();
370 ps.next_unary = false;
371 return lsym_word;
372 }
373 } else
374 return lsym_eof; /* just as a placeholder */
375
376 while (ch_isblank(inp_p[0]))
377 inp_p++;
378
379 ps.next_unary = ps.prev_lsym == lsym_tag
380 || ps.prev_lsym == lsym_typedef;
381
382 if (ps.prev_lsym == lsym_tag && ps.nparen == 0)
383 return lsym_type_outside_parentheses;
384
385 token_add_char('\0');
386 token.len--;
387 const struct keyword *kw = bsearch(token.s, keywords,
388 array_length(keywords), sizeof(keywords[0]), cmp_keyword_by_name);
389 lexer_symbol lsym = lsym_word;
390 if (kw != NULL) {
391 if (kw->lsym == lsym_type)
392 lsym = lsym_type_in_parentheses;
393 ps.next_unary = true;
394 if (kw->lsym == lsym_tag || kw->lsym == lsym_type)
395 goto found_typename;
396 return kw->lsym;
397 }
398
399 if (is_typename()) {
400 lsym = lsym_type_in_parentheses;
401 ps.next_unary = true;
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_lsym != lsym_period
410 && ps.prev_lsym != lsym_unary_op) {
411 if (kw != NULL && kw->lsym == lsym_tag)
412 return lsym_tag;
413 if (ps.nparen == 0)
414 return lsym_type_outside_parentheses;
415 }
416 }
417
418 if (inp_p[0] == '(' && ps.psyms.top <= 1 && ps.ind_level == 0 &&
419 !ps.in_func_def_params && !ps.in_init) {
420
421 if (ps.nparen == 0 && probably_looking_at_definition()) {
422 ps.in_func_def_line = true;
423 if (ps.in_decl)
424 ps.in_func_def_params = true;
425 return lsym_funcname;
426 }
427
428 } else if (ps.nparen == 0 && probably_typename()) {
429 ps.next_unary = true;
430 return lsym_type_outside_parentheses;
431 }
432
433 return lsym;
434 }
435
436 static bool
437 is_asterisk_unary(void)
438 {
439 if (inp_p[strspn(inp_p, "* \t")] == ')')
440 return true;
441 if (ps.next_unary || ps.in_func_def_params)
442 return true;
443 if (ps.prev_lsym == lsym_word ||
444 ps.prev_lsym == lsym_rparen ||
445 ps.prev_lsym == lsym_rbracket)
446 return false;
447 return ps.in_decl && ps.nparen > 0;
448 }
449
450 static bool
451 probably_in_function_definition(void)
452 {
453 for (const char *tp = inp_p; *tp != '\n';) {
454 if (ch_isspace(*tp))
455 tp++;
456 else if (is_identifier_start(*tp)) {
457 tp++;
458 while (is_identifier_part(*tp))
459 tp++;
460 } else
461 return *tp == '(';
462 }
463 return false;
464 }
465
466 static void
467 lex_asterisk_unary(void)
468 {
469 while (inp_p[0] == '*' || ch_isspace(inp_p[0])) {
470 if (inp_p[0] == '*')
471 token_add_char('*');
472 inp_skip();
473 }
474
475 if (ps.in_decl && probably_in_function_definition())
476 ps.in_func_def_line = true;
477 }
478
479 static void
480 skip_blank(const char **pp)
481 {
482 while (ch_isblank(**pp))
483 (*pp)++;
484 }
485
486 static bool
487 skip_string(const char **pp, const char *s)
488 {
489 size_t len = strlen(s);
490 if (strncmp(*pp, s, len) == 0) {
491 *pp += len;
492 return true;
493 }
494 return false;
495 }
496
497 static void
498 lex_indent_comment(void)
499 {
500 const char *p = inp.s;
501
502 skip_blank(&p);
503 if (!skip_string(&p, "/*"))
504 return;
505 skip_blank(&p);
506 if (!skip_string(&p, "INDENT"))
507 return;
508
509 enum indent_enabled enabled;
510 skip_blank(&p);
511 if (*p == '*' || skip_string(&p, "ON"))
512 enabled = indent_last_off_line;
513 else if (skip_string(&p, "OFF"))
514 enabled = indent_off;
515 else
516 return;
517
518 skip_blank(&p);
519 if (!skip_string(&p, "*/\n"))
520 return;
521
522 if (lab.len > 0 || code.len > 0 || com.len > 0)
523 output_line();
524
525 indent_enabled = enabled;
526 }
527
528 /* Reads the next token, placing it in the global variable "token". */
529 lexer_symbol
530 lexi(void)
531 {
532 token.len = 0;
533 ps.curr_col_1 = ps.next_col_1;
534 ps.next_col_1 = false;
535
536 for (;;) {
537 if (ch_isblank(inp_p[0])) {
538 ps.curr_col_1 = false;
539 inp_p++;
540 } else if (inp_p[0] == '\\' && inp_p[1] == '\n') {
541 inp_p++;
542 inp_skip();
543 line_no++;
544 } else
545 break;
546 }
547
548 lexer_symbol alnum_lsym = lexi_alnum();
549 if (alnum_lsym != lsym_eof)
550 return alnum_lsym;
551
552 /* Scan a non-alphanumeric token */
553
554 token_add_char(inp_next());
555
556 lexer_symbol lsym;
557 bool next_unary;
558
559 switch (token.s[token.len - 1]) {
560
561 case '#':
562 lsym = lsym_preprocessing;
563 next_unary = ps.next_unary;
564 break;
565
566 case '\n':
567 /* if data has been exhausted, the '\n' is a dummy. */
568 lsym = had_eof ? lsym_eof : lsym_newline;
569 next_unary = ps.next_unary;
570 ps.next_col_1 = true;
571 break;
572
573 /* INDENT OFF */
574 case '(': lsym = lsym_lparen; next_unary = true; break;
575 case ')': lsym = lsym_rparen; next_unary = false; break;
576 case '[': lsym = lsym_lbracket; next_unary = true; break;
577 case ']': lsym = lsym_rbracket; next_unary = false; break;
578 case '{': lsym = lsym_lbrace; next_unary = true; break;
579 case '}': lsym = lsym_rbrace; next_unary = true; break;
580 case '.': lsym = lsym_period; next_unary = false; break;
581 case '?': lsym = lsym_question; next_unary = true; break;
582 case ',': lsym = lsym_comma; next_unary = true; break;
583 case ';': lsym = lsym_semicolon; next_unary = true; break;
584 /* INDENT ON */
585
586 case '-':
587 case '+':
588 lsym = ps.next_unary ? lsym_unary_op : lsym_binary_op;
589 next_unary = true;
590
591 /* '++' or '--' */
592 if (inp_p[0] == token.s[token.len - 1]) {
593 token_add_char(*inp_p++);
594 if (ps.prev_lsym == lsym_word ||
595 ps.prev_lsym == lsym_rparen ||
596 ps.prev_lsym == lsym_rbracket) {
597 lsym = ps.next_unary
598 ? lsym_unary_op : lsym_postfix_op;
599 next_unary = false;
600 }
601
602 } else if (inp_p[0] == '=') { /* '+=' or '-=' */
603 token_add_char(*inp_p++);
604
605 } else if (inp_p[0] == '>') { /* '->' */
606 token_add_char(*inp_p++);
607 lsym = lsym_unary_op;
608 next_unary = false;
609 ps.want_blank = false;
610 }
611 break;
612
613 case ':':
614 lsym = ps.quest_level > 0
615 ? (ps.quest_level--, lsym_colon_question)
616 : ps.in_var_decl
617 ? lsym_colon_other
618 : lsym_colon_label;
619 next_unary = true;
620 break;
621
622 case '*':
623 if (inp_p[0] == '=') {
624 token_add_char(*inp_p++);
625 lsym = lsym_binary_op;
626 } else if (is_asterisk_unary()) {
627 lex_asterisk_unary();
628 lsym = lsym_unary_op;
629 } else
630 lsym = lsym_binary_op;
631 next_unary = true;
632 break;
633
634 case '=':
635 if (ps.in_var_decl)
636 ps.in_init = true;
637 if (inp_p[0] == '=')
638 token_add_char(*inp_p++);
639 lsym = lsym_binary_op;
640 next_unary = true;
641 break;
642
643 case '>':
644 case '<':
645 case '!': /* ops like <, <<, <=, !=, etc */
646 if (inp_p[0] == '>' || inp_p[0] == '<' || inp_p[0] == '=')
647 token_add_char(*inp_p++);
648 if (inp_p[0] == '=')
649 token_add_char(*inp_p++);
650 lsym = ps.next_unary ? lsym_unary_op : lsym_binary_op;
651 next_unary = true;
652 break;
653
654 case '\'':
655 case '"':
656 lex_char_or_string();
657 lsym = lsym_word;
658 next_unary = false;
659 break;
660
661 default:
662 if (token.s[token.len - 1] == '/'
663 && (inp_p[0] == '*' || inp_p[0] == '/')) {
664 enum indent_enabled prev = indent_enabled;
665 lex_indent_comment();
666 if (prev == indent_on && indent_enabled == indent_off)
667 out.indent_off_text.len = 0;
668 token_add_char(*inp_p++);
669 lsym = lsym_comment;
670 next_unary = ps.next_unary;
671 break;
672 }
673
674 /* things like '||', '&&', '<<=' */
675 lsym = ps.next_unary ? lsym_unary_op : lsym_binary_op;
676 if (inp_p[0] == token.s[token.len - 1])
677 token_add_char(*inp_p++), lsym = lsym_binary_op;
678 if (inp_p[0] == '=')
679 token_add_char(*inp_p++), lsym = lsym_binary_op;
680
681 next_unary = true;
682 }
683
684 ps.next_unary = next_unary;
685
686 return lsym;
687 }
688
689 void
690 register_typename(const char *name)
691 {
692 if (typenames.len >= typenames.cap) {
693 typenames.cap = 16 + 2 * typenames.cap;
694 typenames.items = nonnull(realloc(typenames.items,
695 sizeof(typenames.items[0]) * typenames.cap));
696 }
697
698 int pos = bsearch_typenames(name);
699 if (pos >= 0)
700 return; /* already in the list */
701
702 pos = -(pos + 1);
703 memmove(typenames.items + pos + 1, typenames.items + pos,
704 sizeof(typenames.items[0]) * (typenames.len++ - (unsigned)pos));
705 typenames.items[pos] = nonnull(strdup(name));
706 }
707