lexi.c revision 1.69 1 /* $NetBSD: lexi.c,v 1.69 2021/10/05 06:15:24 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 #if 0
41 static char sccsid[] = "@(#)lexi.c 8.1 (Berkeley) 6/6/93";
42 #endif
43
44 #include <sys/cdefs.h>
45 #if defined(__NetBSD__)
46 __RCSID("$NetBSD: lexi.c,v 1.69 2021/10/05 06:15:24 rillig Exp $");
47 #elif defined(__FreeBSD__)
48 __FBSDID("$FreeBSD: head/usr.bin/indent/lexi.c 337862 2018-08-15 18:19:45Z pstef $");
49 #endif
50
51 #include <assert.h>
52 #include <stdio.h>
53 #include <ctype.h>
54 #include <stdlib.h>
55 #include <string.h>
56 #include <sys/param.h>
57
58 #include "indent.h"
59
60 /* must be sorted alphabetically, is used in binary search */
61 static const struct keyword {
62 const char *name;
63 enum keyword_kind kind;
64 } keywords[] = {
65 {"_Bool", kw_type},
66 {"_Complex", kw_type},
67 {"_Imaginary", kw_type},
68 {"auto", kw_storage_class},
69 {"bool", kw_type},
70 {"break", kw_jump},
71 {"case", kw_case_or_default},
72 {"char", kw_type},
73 {"complex", kw_type},
74 {"const", kw_type},
75 {"continue", kw_jump},
76 {"default", kw_case_or_default},
77 {"do", kw_do_or_else},
78 {"double", kw_type},
79 {"else", kw_do_or_else},
80 {"enum", kw_struct_or_union_or_enum},
81 {"extern", kw_storage_class},
82 {"float", kw_type},
83 {"for", kw_for_or_if_or_while},
84 {"global", kw_type},
85 {"goto", kw_jump},
86 {"if", kw_for_or_if_or_while},
87 {"imaginary", kw_type},
88 {"inline", kw_inline_or_restrict},
89 {"int", kw_type},
90 {"long", kw_type},
91 {"offsetof", kw_offsetof},
92 {"register", kw_storage_class},
93 {"restrict", kw_inline_or_restrict},
94 {"return", kw_jump},
95 {"short", kw_type},
96 {"signed", kw_type},
97 {"sizeof", kw_sizeof},
98 {"static", kw_storage_class},
99 {"struct", kw_struct_or_union_or_enum},
100 {"switch", kw_switch},
101 {"typedef", kw_typedef},
102 {"union", kw_struct_or_union_or_enum},
103 {"unsigned", kw_type},
104 {"void", kw_type},
105 {"volatile", kw_type},
106 {"while", kw_for_or_if_or_while}
107 };
108
109 struct {
110 const char **items;
111 unsigned int len;
112 unsigned int cap;
113 } typenames;
114
115 /*
116 * The transition table below was rewritten by hand from lx's output, given
117 * the following definitions. lx is Katherine Flavel's lexer generator.
118 *
119 * O = /[0-7]/; D = /[0-9]/; NZ = /[1-9]/;
120 * H = /[a-f0-9]/i; B = /[0-1]/; HP = /0x/i;
121 * BP = /0b/i; E = /e[+\-]?/i D+; P = /p[+\-]?/i D+;
122 * FS = /[fl]/i; IS = /u/i /(l|L|ll|LL)/? | /(l|L|ll|LL)/ /u/i?;
123 *
124 * D+ E FS? -> $float;
125 * D* "." D+ E? FS? -> $float;
126 * D+ "." E? FS? -> $float; HP H+ IS? -> $int;
127 * HP H+ P FS? -> $float; NZ D* IS? -> $int;
128 * HP H* "." H+ P FS? -> $float; "0" O* IS? -> $int;
129 * HP H+ "." P FS -> $float; BP B+ IS? -> $int;
130 */
131 static const char num_lex_state[][26] = {
132 /* examples:
133 00
134 s 0xx
135 t 00xaa
136 a 11 101100xxa..
137 r 11ee0001101lbuuxx.a.pp
138 t.01.e+008bLuxll0Ll.aa.p+0
139 states: ABCDEFGHIJKLMNOPQRSTUVWXYZ */
140 [0] = "uuiifuufiuuiiuiiiiiuiuuuuu",
141 [1] = "CEIDEHHHIJQ U Q VUVVZZZ",
142 [2] = "DEIDEHHHIJQ U Q VUVVZZZ",
143 [3] = "DEIDEHHHIJ U VUVVZZZ",
144 [4] = "DEJDEHHHJJ U VUVVZZZ",
145 [5] = " U VUVV ",
146 [6] = " K U VUVV ",
147 [7] = " FFF FF U VUVV ",
148 [8] = " f f U VUVV f",
149 [9] = " LLf fL PR Li L f",
150 [10] = " OOf fO S P O i O f",
151 [11] = " FFX ",
152 [12] = " MM M i iiM M ",
153 [13] = " N ",
154 [14] = " G Y ",
155 [15] = "B EE EE T W ",
156 /* ABCDEFGHIJKLMNOPQRSTUVWXYZ */
157 };
158
159 static const uint8_t num_lex_row[] = {
160 ['0'] = 1,
161 ['1'] = 2,
162 ['2'] = 3, ['3'] = 3, ['4'] = 3, ['5'] = 3, ['6'] = 3, ['7'] = 3,
163 ['8'] = 4, ['9'] = 4,
164 ['A'] = 5, ['a'] = 5, ['C'] = 5, ['c'] = 5, ['D'] = 5, ['d'] = 5,
165 ['B'] = 6, ['b'] = 6,
166 ['E'] = 7, ['e'] = 7,
167 ['F'] = 8, ['f'] = 8,
168 ['L'] = 9,
169 ['l'] = 10,
170 ['P'] = 11, ['p'] = 11,
171 ['U'] = 12, ['u'] = 12,
172 ['X'] = 13, ['x'] = 13,
173 ['+'] = 14, ['-'] = 14,
174 ['.'] = 15,
175 };
176
177 static char
178 inbuf_peek(void)
179 {
180 return *buf_ptr;
181 }
182
183 void
184 inbuf_skip(void)
185 {
186 buf_ptr++;
187 if (buf_ptr >= buf_end)
188 fill_buffer();
189 }
190
191 char
192 inbuf_next(void)
193 {
194 char ch = inbuf_peek();
195 inbuf_skip();
196 return ch;
197 }
198
199 static void
200 check_size_token(size_t desired_size)
201 {
202 if (token.e + desired_size >= token.l)
203 buf_expand(&token, desired_size);
204 }
205
206 static int
207 cmp_keyword_by_name(const void *key, const void *elem)
208 {
209 return strcmp(key, ((const struct keyword *)elem)->name);
210 }
211
212 static int
213 cmp_type_by_name(const void *key, const void *elem)
214 {
215 return strcmp(key, *((const char *const *)elem));
216 }
217
218 #ifdef debug
219 const char *
220 token_type_name(token_type ttype)
221 {
222 static const char *const name[] = {
223 "end_of_file", "newline", "lparen", "rparen", "unary_op",
224 "binary_op", "postfix_op", "question", "case_label", "colon",
225 "semicolon", "lbrace", "rbrace", "ident", "comma",
226 "comment", "switch_expr", "preprocessing", "form_feed", "decl",
227 "keyword_for_if_while", "keyword_do_else",
228 "if_expr", "while_expr", "for_exprs",
229 "stmt", "stmt_list", "keyword_else", "keyword_do", "do_stmt",
230 "if_expr_stmt", "if_expr_stmt_else", "period", "string_prefix",
231 "storage_class", "funcname", "type_def", "keyword_struct_union_enum"
232 };
233
234 assert(0 <= ttype && ttype < nitems(name));
235
236 return name[ttype];
237 }
238
239 static void
240 print_buf(const char *name, const char *s, const char *e)
241 {
242 if (s < e) {
243 debug_printf(" %s ", name);
244 debug_vis_range("\"", s, e, "\"");
245 }
246 }
247
248 static token_type
249 lexi_end(token_type ttype)
250 {
251 debug_printf("in line %d, lexi returns '%s'",
252 line_no, token_type_name(ttype));
253 print_buf("token", token.s, token.e);
254 print_buf("label", lab.s, lab.e);
255 print_buf("code", code.s, code.e);
256 print_buf("comment", com.s, com.e);
257 debug_printf("\n");
258
259 return ttype;
260 }
261 #else
262 # define lexi_end(tk) (tk)
263 #endif
264
265 static void
266 lex_number(void)
267 {
268 for (uint8_t s = 'A'; s != 'f' && s != 'i' && s != 'u'; ) {
269 uint8_t ch = (uint8_t)*buf_ptr;
270 if (ch >= nitems(num_lex_row) || num_lex_row[ch] == 0)
271 break;
272 uint8_t row = num_lex_row[ch];
273 if (num_lex_state[row][s - 'A'] == ' ') {
274 /*
275 * num_lex_state[0][s - 'A'] now indicates the type:
276 * f = floating, ch = integer, u = unknown
277 */
278 break;
279 }
280 s = num_lex_state[row][s - 'A'];
281 check_size_token(1);
282 *token.e++ = inbuf_next();
283 }
284 }
285
286 static void
287 lex_word(void)
288 {
289 while (isalnum((unsigned char)*buf_ptr) ||
290 *buf_ptr == '\\' ||
291 *buf_ptr == '_' || *buf_ptr == '$') {
292 /* fill_buffer() terminates buffer with newline */
293 if (*buf_ptr == '\\') {
294 if (buf_ptr[1] == '\n') {
295 buf_ptr += 2;
296 if (buf_ptr >= buf_end)
297 fill_buffer();
298 } else
299 break;
300 }
301 check_size_token(1);
302 *token.e++ = inbuf_next();
303 }
304 }
305
306 static void
307 lex_char_or_string(void)
308 {
309 for (char delim = *token.s;;) {
310 if (*buf_ptr == '\n') {
311 diag(1, "Unterminated literal");
312 return;
313 }
314 check_size_token(2);
315 *token.e++ = inbuf_next();
316 if (token.e[-1] == delim)
317 return;
318 if (token.e[-1] == '\\') {
319 if (*buf_ptr == '\n')
320 ++line_no;
321 *token.e++ = inbuf_next();
322 }
323 }
324 }
325
326 /*
327 * This hack attempts to guess whether the current token is in fact a
328 * declaration keyword -- one that has been defined by typedef.
329 */
330 static bool
331 probably_typedef(const struct parser_state *state)
332 {
333 return state->p_l_follow == 0 && !state->block_init && !state->in_stmt &&
334 ((*buf_ptr == '*' && buf_ptr[1] != '=') ||
335 isalpha((unsigned char)*buf_ptr)) &&
336 (state->last_token == semicolon || state->last_token == lbrace ||
337 state->last_token == rbrace);
338 }
339
340 static bool
341 is_typename(void)
342 {
343 if (opt.auto_typedefs) {
344 const char *u;
345 if ((u = strrchr(token.s, '_')) != NULL && strcmp(u, "_t") == 0)
346 return true;
347 }
348
349 if (typenames.len == 0)
350 return false;
351 return bsearch(token.s, typenames.items, (size_t)typenames.len,
352 sizeof(typenames.items[0]), cmp_type_by_name) != NULL;
353 }
354
355 /* Reads the next token, placing it in the global variable "token". */
356 token_type
357 lexi(struct parser_state *state)
358 {
359 bool unary_delim; /* whether the current token forces a
360 * following operator to be unary */
361 token_type ttype;
362
363 token.e = token.s; /* point to start of place to save token */
364 unary_delim = false;
365 state->col_1 = state->last_nl; /* tell world that this token started
366 * in column 1 iff the last thing
367 * scanned was a newline */
368 state->last_nl = false;
369
370 while (is_hspace(*buf_ptr)) {
371 state->col_1 = false;
372 inbuf_skip();
373 }
374
375 /* Scan an alphanumeric token */
376 if (isalnum((unsigned char)*buf_ptr) ||
377 *buf_ptr == '_' || *buf_ptr == '$' ||
378 (buf_ptr[0] == '.' && isdigit((unsigned char)buf_ptr[1]))) {
379 struct keyword *kw;
380
381 if (isdigit((unsigned char)*buf_ptr) ||
382 (buf_ptr[0] == '.' && isdigit((unsigned char)buf_ptr[1]))) {
383 lex_number();
384 } else {
385 lex_word();
386 }
387 *token.e = '\0';
388
389 if (token.s[0] == 'L' && token.s[1] == '\0' &&
390 (*buf_ptr == '"' || *buf_ptr == '\''))
391 return lexi_end(string_prefix);
392
393 while (is_hspace(inbuf_peek()))
394 inbuf_skip();
395 state->keyword = kw_0;
396
397 if (state->last_token == keyword_struct_union_enum &&
398 state->p_l_follow == 0) {
399 state->last_u_d = true;
400 return lexi_end(decl);
401 }
402 /*
403 * Operator after identifier is binary unless last token was 'struct'
404 */
405 state->last_u_d = (state->last_token == keyword_struct_union_enum);
406
407 kw = bsearch(token.s, keywords, nitems(keywords),
408 sizeof(keywords[0]), cmp_keyword_by_name);
409 if (kw == NULL) {
410 if (is_typename()) {
411 state->keyword = kw_type;
412 state->last_u_d = true;
413 goto found_typename;
414 }
415 } else { /* we have a keyword */
416 state->keyword = kw->kind;
417 state->last_u_d = true;
418 switch (kw->kind) {
419 case kw_switch:
420 return lexi_end(switch_expr);
421 case kw_case_or_default:
422 return lexi_end(case_label);
423 case kw_struct_or_union_or_enum:
424 case kw_type:
425 found_typename:
426 if (state->p_l_follow != 0) {
427 /* inside parens: cast, param list, offsetof or sizeof */
428 state->cast_mask |= (1 << state->p_l_follow) & ~state->not_cast_mask;
429 }
430 if (state->last_token == period || state->last_token == unary_op) {
431 state->keyword = kw_0;
432 break;
433 }
434 if (kw != NULL && kw->kind == kw_struct_or_union_or_enum)
435 return lexi_end(keyword_struct_union_enum);
436 if (state->p_l_follow != 0)
437 break;
438 return lexi_end(decl);
439
440 case kw_for_or_if_or_while:
441 return lexi_end(keyword_for_if_while);
442
443 case kw_do_or_else:
444 return lexi_end(keyword_do_else);
445
446 case kw_storage_class:
447 return lexi_end(storage_class);
448
449 case kw_typedef:
450 return lexi_end(type_def);
451
452 default: /* all others are treated like any other
453 * identifier */
454 return lexi_end(ident);
455 } /* end of switch */
456 } /* end of if (found_it) */
457 if (*buf_ptr == '(' && state->tos <= 1 && state->ind_level == 0 &&
458 !state->in_parameter_declaration && !state->block_init) {
459 char *tp = buf_ptr;
460 while (tp < buf_end)
461 if (*tp++ == ')' && (*tp == ';' || *tp == ','))
462 goto not_proc;
463 strncpy(state->procname, token.s, sizeof state->procname - 1);
464 if (state->in_decl)
465 state->in_parameter_declaration = true;
466 return lexi_end(funcname);
467 not_proc:;
468 } else if (probably_typedef(state)) {
469 state->keyword = kw_type;
470 state->last_u_d = true;
471 return lexi_end(decl);
472 }
473 if (state->last_token == decl) /* if this is a declared variable,
474 * then following sign is unary */
475 state->last_u_d = true; /* will make "int a -1" work */
476 return lexi_end(ident); /* the ident is not in the list */
477 } /* end of procesing for alpanum character */
478
479 /* Scan a non-alphanumeric token */
480
481 check_size_token(3); /* things like "<<=" */
482 *token.e++ = inbuf_next(); /* if it is only a one-character token, it is
483 * moved here */
484 *token.e = '\0';
485
486 switch (*token.s) {
487 case '\n':
488 unary_delim = state->last_u_d;
489 state->last_nl = true; /* remember that we just had a newline */
490 /* if data has been exhausted, the newline is a dummy. */
491 ttype = had_eof ? end_of_file : newline;
492 break;
493
494 case '\'':
495 case '"':
496 lex_char_or_string();
497 ttype = ident;
498 break;
499
500 case '(':
501 case '[':
502 unary_delim = true;
503 ttype = lparen;
504 break;
505
506 case ')':
507 case ']':
508 ttype = rparen;
509 break;
510
511 case '#':
512 unary_delim = state->last_u_d;
513 ttype = preprocessing;
514 break;
515
516 case '?':
517 unary_delim = true;
518 ttype = question;
519 break;
520
521 case ':':
522 ttype = colon;
523 unary_delim = true;
524 break;
525
526 case ';':
527 unary_delim = true;
528 ttype = semicolon;
529 break;
530
531 case '{':
532 unary_delim = true;
533 ttype = lbrace;
534 break;
535
536 case '}':
537 unary_delim = true;
538 ttype = rbrace;
539 break;
540
541 case '\f':
542 unary_delim = state->last_u_d;
543 state->last_nl = true; /* remember this so we can set 'state->col_1'
544 * right */
545 ttype = form_feed;
546 break;
547
548 case ',':
549 unary_delim = true;
550 ttype = comma;
551 break;
552
553 case '.':
554 unary_delim = false;
555 ttype = period;
556 break;
557
558 case '-':
559 case '+': /* check for -, +, --, ++ */
560 ttype = state->last_u_d ? unary_op : binary_op;
561 unary_delim = true;
562
563 if (*buf_ptr == token.s[0]) {
564 /* check for doubled character */
565 *token.e++ = *buf_ptr++;
566 /* buffer overflow will be checked at end of loop */
567 if (state->last_token == ident || state->last_token == rparen) {
568 ttype = state->last_u_d ? unary_op : postfix_op;
569 /* check for following ++ or -- */
570 unary_delim = false;
571 }
572 } else if (*buf_ptr == '=')
573 /* check for operator += */
574 *token.e++ = *buf_ptr++;
575 else if (*buf_ptr == '>') {
576 /* check for operator -> */
577 *token.e++ = *buf_ptr++;
578 unary_delim = false;
579 ttype = unary_op;
580 state->want_blank = false;
581 }
582 break; /* buffer overflow will be checked at end of
583 * switch */
584
585 case '=':
586 if (state->in_or_st)
587 state->block_init = true;
588 if (*buf_ptr == '=') { /* == */
589 *token.e++ = '='; /* Flip =+ to += */
590 buf_ptr++;
591 *token.e = '\0';
592 }
593 ttype = binary_op;
594 unary_delim = true;
595 break;
596 /* can drop thru!!! */
597
598 case '>':
599 case '<':
600 case '!': /* ops like <, <<, <=, !=, etc */
601 if (*buf_ptr == '>' || *buf_ptr == '<' || *buf_ptr == '=')
602 *token.e++ = inbuf_next();
603 if (*buf_ptr == '=')
604 *token.e++ = *buf_ptr++;
605 ttype = state->last_u_d ? unary_op : binary_op;
606 unary_delim = true;
607 break;
608
609 case '*':
610 unary_delim = true;
611 if (!state->last_u_d) {
612 if (*buf_ptr == '=')
613 *token.e++ = *buf_ptr++;
614 ttype = binary_op;
615 break;
616 }
617 while (*buf_ptr == '*' || isspace((unsigned char)*buf_ptr)) {
618 if (*buf_ptr == '*') {
619 check_size_token(1);
620 *token.e++ = *buf_ptr;
621 }
622 inbuf_skip();
623 }
624 if (ps.in_decl) {
625 char *tp = buf_ptr;
626
627 while (isalpha((unsigned char)*tp) ||
628 isspace((unsigned char)*tp)) {
629 if (++tp >= buf_end)
630 fill_buffer();
631 }
632 if (*tp == '(')
633 ps.procname[0] = ' ';
634 }
635 ttype = unary_op;
636 break;
637
638 default:
639 if (token.s[0] == '/' && (*buf_ptr == '*' || *buf_ptr == '/')) {
640 /* it is start of comment */
641 *token.e++ = inbuf_next();
642
643 ttype = comment;
644 unary_delim = state->last_u_d;
645 break;
646 }
647 while (token.e[-1] == *buf_ptr || *buf_ptr == '=') {
648 /*
649 * handle ||, &&, etc, and also things as in int *****i
650 */
651 check_size_token(1);
652 *token.e++ = inbuf_next();
653 }
654 ttype = state->last_u_d ? unary_op : binary_op;
655 unary_delim = true;
656 }
657
658 if (buf_ptr >= buf_end) /* check for input buffer empty */
659 fill_buffer();
660 state->last_u_d = unary_delim;
661 check_size_token(1);
662 *token.e = '\0';
663 return lexi_end(ttype);
664 }
665
666 static int
667 insert_pos(const char *key, const char **arr, unsigned int len) {
668 int lo = 0;
669 int hi = (int)len - 1;
670
671 while (lo <= hi) {
672 int mid = (int)((unsigned)(lo + hi) >> 1);
673 int cmp = strcmp(arr[mid], key);
674 if (cmp < 0)
675 lo = mid + 1;
676 else if (cmp > 0)
677 hi = mid - 1;
678 else
679 return mid;
680 }
681 return -(lo + 1);
682 }
683
684 void
685 add_typename(const char *name)
686 {
687 if (typenames.len >= typenames.cap) {
688 typenames.cap = 16 + 2 * typenames.cap;
689 typenames.items = xrealloc(typenames.items,
690 sizeof(typenames.items[0]) * typenames.cap);
691 }
692
693 int pos = insert_pos(name, typenames.items, typenames.len);
694 if (pos >= 0)
695 return; /* already in the list */
696 pos = -(pos + 1);
697 memmove(typenames.items + pos + 1, typenames.items + pos,
698 sizeof(typenames.items[0]) * (typenames.len++ - pos));
699 typenames.items[pos] = xstrdup(name);
700 }
701