xref: /freebsd/bin/sh/mksyntax.c (revision aa0a1e58)
1 /*-
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Kenneth Almquist.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #if 0
34 #ifndef lint
35 static char const copyright[] =
36 "@(#) Copyright (c) 1991, 1993\n\
37 	The Regents of the University of California.  All rights reserved.\n";
38 #endif /* not lint */
39 
40 #ifndef lint
41 static char sccsid[] = "@(#)mksyntax.c	8.2 (Berkeley) 5/4/95";
42 #endif /* not lint */
43 #endif
44 #include <sys/cdefs.h>
45 __FBSDID("$FreeBSD$");
46 
47 /*
48  * This program creates syntax.h and syntax.c.
49  */
50 
51 #include <stdio.h>
52 #include <stdlib.h>
53 #include <string.h>
54 #include "parser.h"
55 
56 
57 struct synclass {
58 	const char *name;
59 	const char *comment;
60 };
61 
62 /* Syntax classes */
63 struct synclass synclass[] = {
64 	{ "CWORD",	"character is nothing special" },
65 	{ "CNL",	"newline character" },
66 	{ "CBACK",	"a backslash character" },
67 	{ "CSQUOTE",	"single quote" },
68 	{ "CDQUOTE",	"double quote" },
69 	{ "CENDQUOTE",	"a terminating quote" },
70 	{ "CBQUOTE",	"backwards single quote" },
71 	{ "CVAR",	"a dollar sign" },
72 	{ "CENDVAR",	"a '}' character" },
73 	{ "CLP",	"a left paren in arithmetic" },
74 	{ "CRP",	"a right paren in arithmetic" },
75 	{ "CEOF",	"end of file" },
76 	{ "CCTL",	"like CWORD, except it must be escaped" },
77 	{ "CSPCL",	"these terminate a word" },
78 	{ "CIGN",       "character should be ignored" },
79 	{ NULL,		NULL }
80 };
81 
82 
83 /*
84  * Syntax classes for is_ functions.  Warning:  if you add new classes
85  * you may have to change the definition of the is_in_name macro.
86  */
87 struct synclass is_entry[] = {
88 	{ "ISDIGIT",	"a digit" },
89 	{ "ISUPPER",	"an upper case letter" },
90 	{ "ISLOWER",	"a lower case letter" },
91 	{ "ISUNDER",	"an underscore" },
92 	{ "ISSPECL",	"the name of a special parameter" },
93 	{ NULL, 	NULL }
94 };
95 
96 static char writer[] = "\
97 /*\n\
98  * This file was generated by the mksyntax program.\n\
99  */\n\
100 \n";
101 
102 
103 static FILE *cfile;
104 static FILE *hfile;
105 static const char *syntax[513];
106 static int base;
107 static int size;	/* number of values which a char variable can have */
108 static int nbits;	/* number of bits in a character */
109 static int digit_contig;/* true if digits are contiguous */
110 
111 static void filltable(const char *);
112 static void init(void);
113 static void add(const char *, const char *);
114 static void print(const char *);
115 static void output_type_macros(void);
116 static void digit_convert(void);
117 
118 int
119 main(int argc __unused, char **argv __unused)
120 {
121 	char c;
122 	char d;
123 	int sign;
124 	int i;
125 	char buf[80];
126 	int pos;
127 	static char digit[] = "0123456789";
128 
129 	/* Create output files */
130 	if ((cfile = fopen("syntax.c", "w")) == NULL) {
131 		perror("syntax.c");
132 		exit(2);
133 	}
134 	if ((hfile = fopen("syntax.h", "w")) == NULL) {
135 		perror("syntax.h");
136 		exit(2);
137 	}
138 	fputs(writer, hfile);
139 	fputs(writer, cfile);
140 
141 	/* Determine the characteristics of chars. */
142 	c = -1;
143 	sign = (c > 0) ? 0 : 1;
144 	for (nbits = 1 ; ; nbits++) {
145 		d = (1 << nbits) - 1;
146 		if (d == c)
147 			break;
148 	}
149 #if 0
150 	printf("%s %d bit chars\n", sign? "signed" : "unsigned", nbits);
151 #endif
152 	if (nbits > 9) {
153 		fputs("Characters can't have more than 9 bits\n", stderr);
154 		exit(2);
155 	}
156 	size = (1 << nbits) + 1;
157 	base = 1;
158 	if (sign)
159 		base += 1 << (nbits - 1);
160 	digit_contig = 1;
161 	for (i = 0 ; i < 10 ; i++) {
162 		if (digit[i] != '0' + i)
163 			digit_contig = 0;
164 	}
165 
166 	fputs("#include <sys/cdefs.h>\n", hfile);
167 	fputs("#include <ctype.h>\n", hfile);
168 
169 	/* Generate the #define statements in the header file */
170 	fputs("/* Syntax classes */\n", hfile);
171 	for (i = 0 ; synclass[i].name ; i++) {
172 		sprintf(buf, "#define %s %d", synclass[i].name, i);
173 		fputs(buf, hfile);
174 		for (pos = strlen(buf) ; pos < 32 ; pos = (pos + 8) & ~07)
175 			putc('\t', hfile);
176 		fprintf(hfile, "/* %s */\n", synclass[i].comment);
177 	}
178 	putc('\n', hfile);
179 	fputs("/* Syntax classes for is_ functions */\n", hfile);
180 	for (i = 0 ; is_entry[i].name ; i++) {
181 		sprintf(buf, "#define %s %#o", is_entry[i].name, 1 << i);
182 		fputs(buf, hfile);
183 		for (pos = strlen(buf) ; pos < 32 ; pos = (pos + 8) & ~07)
184 			putc('\t', hfile);
185 		fprintf(hfile, "/* %s */\n", is_entry[i].comment);
186 	}
187 	putc('\n', hfile);
188 	fprintf(hfile, "#define SYNBASE %d\n", base);
189 	fprintf(hfile, "#define PEOF %d\n\n", -base);
190 	putc('\n', hfile);
191 	fputs("#define BASESYNTAX (basesyntax + SYNBASE)\n", hfile);
192 	fputs("#define DQSYNTAX (dqsyntax + SYNBASE)\n", hfile);
193 	fputs("#define SQSYNTAX (sqsyntax + SYNBASE)\n", hfile);
194 	fputs("#define ARISYNTAX (arisyntax + SYNBASE)\n", hfile);
195 	putc('\n', hfile);
196 	output_type_macros();		/* is_digit, etc. */
197 	putc('\n', hfile);
198 
199 	/* Generate the syntax tables. */
200 	fputs("#include \"shell.h\"\n", cfile);
201 	fputs("#include \"syntax.h\"\n\n", cfile);
202 	init();
203 	fputs("/* syntax table used when not in quotes */\n", cfile);
204 	add("\n", "CNL");
205 	add("\\", "CBACK");
206 	add("'", "CSQUOTE");
207 	add("\"", "CDQUOTE");
208 	add("`", "CBQUOTE");
209 	add("$", "CVAR");
210 	add("}", "CENDVAR");
211 	add("<>();&| \t", "CSPCL");
212 	print("basesyntax");
213 	init();
214 	fputs("\n/* syntax table used when in double quotes */\n", cfile);
215 	add("\n", "CNL");
216 	add("\\", "CBACK");
217 	add("\"", "CENDQUOTE");
218 	add("`", "CBQUOTE");
219 	add("$", "CVAR");
220 	add("}", "CENDVAR");
221 	/* ':/' for tilde expansion, '-' for [a\-x] pattern ranges */
222 	add("!*?[=~:/-", "CCTL");
223 	print("dqsyntax");
224 	init();
225 	fputs("\n/* syntax table used when in single quotes */\n", cfile);
226 	add("\n", "CNL");
227 	add("'", "CENDQUOTE");
228 	/* ':/' for tilde expansion, '-' for [a\-x] pattern ranges */
229 	add("!*?[=~:/-", "CCTL");
230 	print("sqsyntax");
231 	init();
232 	fputs("\n/* syntax table used when in arithmetic */\n", cfile);
233 	add("\n", "CNL");
234 	add("\\", "CBACK");
235 	add("`", "CBQUOTE");
236 	add("\"", "CIGN");
237 	add("$", "CVAR");
238 	add("}", "CENDVAR");
239 	add("(", "CLP");
240 	add(")", "CRP");
241 	print("arisyntax");
242 	filltable("0");
243 	fputs("\n/* character classification table */\n", cfile);
244 	add("0123456789", "ISDIGIT");
245 	add("abcdefghijklmnopqrstuvwxyz", "ISLOWER");
246 	add("ABCDEFGHIJKLMNOPQRSTUVWXYZ", "ISUPPER");
247 	add("_", "ISUNDER");
248 	add("#?$!-*@", "ISSPECL");
249 	print("is_type");
250 	if (! digit_contig)
251 		digit_convert();
252 	exit(0);
253 }
254 
255 
256 
257 /*
258  * Clear the syntax table.
259  */
260 
261 static void
262 filltable(const char *dftval)
263 {
264 	int i;
265 
266 	for (i = 0 ; i < size ; i++)
267 		syntax[i] = dftval;
268 }
269 
270 
271 /*
272  * Initialize the syntax table with default values.
273  */
274 
275 static void
276 init(void)
277 {
278 	filltable("CWORD");
279 	syntax[0] = "CEOF";
280 	syntax[base + CTLESC] = "CCTL";
281 	syntax[base + CTLVAR] = "CCTL";
282 	syntax[base + CTLENDVAR] = "CCTL";
283 	syntax[base + CTLBACKQ] = "CCTL";
284 	syntax[base + CTLBACKQ + CTLQUOTE] = "CCTL";
285 	syntax[base + CTLARI] = "CCTL";
286 	syntax[base + CTLENDARI] = "CCTL";
287 	syntax[base + CTLQUOTEMARK] = "CCTL";
288 	syntax[base + CTLQUOTEEND] = "CCTL";
289 }
290 
291 
292 /*
293  * Add entries to the syntax table.
294  */
295 
296 static void
297 add(const char *p, const char *type)
298 {
299 	while (*p)
300 		syntax[*p++ + base] = type;
301 }
302 
303 
304 
305 /*
306  * Output the syntax table.
307  */
308 
309 static void
310 print(const char *name)
311 {
312 	int i;
313 	int col;
314 
315 	fprintf(hfile, "extern const char %s[];\n", name);
316 	fprintf(cfile, "const char %s[%d] = {\n", name, size);
317 	col = 0;
318 	for (i = 0 ; i < size ; i++) {
319 		if (i == 0) {
320 			fputs("      ", cfile);
321 		} else if ((i & 03) == 0) {
322 			fputs(",\n      ", cfile);
323 			col = 0;
324 		} else {
325 			putc(',', cfile);
326 			while (++col < 9 * (i & 03))
327 				putc(' ', cfile);
328 		}
329 		fputs(syntax[i], cfile);
330 		col += strlen(syntax[i]);
331 	}
332 	fputs("\n};\n", cfile);
333 }
334 
335 
336 
337 /*
338  * Output character classification macros (e.g. is_digit).  If digits are
339  * contiguous, we can test for them quickly.
340  */
341 
342 static const char *macro[] = {
343 	"#define is_digit(c)\t((is_type+SYNBASE)[(int)c] & ISDIGIT)",
344 	"#define is_eof(c)\t((c) == PEOF)",
345 	"#define is_alpha(c)\t((is_type+SYNBASE)[(int)c] & (ISUPPER|ISLOWER))",
346 	"#define is_name(c)\t((is_type+SYNBASE)[(int)c] & (ISUPPER|ISLOWER|ISUNDER))",
347 	"#define is_in_name(c)\t((is_type+SYNBASE)[(int)c] & (ISUPPER|ISLOWER|ISUNDER|ISDIGIT))",
348 	"#define is_special(c)\t((is_type+SYNBASE)[(int)c] & (ISSPECL|ISDIGIT))",
349 	NULL
350 };
351 
352 static void
353 output_type_macros(void)
354 {
355 	const char **pp;
356 
357 	if (digit_contig)
358 		macro[0] = "#define is_digit(c)\t((unsigned int)((c) - '0') <= 9)";
359 	for (pp = macro ; *pp ; pp++)
360 		fprintf(hfile, "%s\n", *pp);
361 	if (digit_contig)
362 		fputs("#define digit_val(c)\t((c) - '0')\n", hfile);
363 	else
364 		fputs("#define digit_val(c)\t(digit_value[c])\n", hfile);
365 }
366 
367 
368 
369 /*
370  * Output digit conversion table (if digits are not contiguous).
371  */
372 
373 static void
374 digit_convert(void)
375 {
376 	int maxdigit;
377 	static char digit[] = "0123456789";
378 	char *p;
379 	int i;
380 
381 	maxdigit = 0;
382 	for (p = digit ; *p ; p++)
383 		if (*p > maxdigit)
384 			maxdigit = *p;
385 	fputs("extern const char digit_value[];\n", hfile);
386 	fputs("\n\nconst char digit_value[] = {\n", cfile);
387 	for (i = 0 ; i <= maxdigit ; i++) {
388 		for (p = digit ; *p && *p != i ; p++);
389 		if (*p == '\0')
390 			p = digit;
391 		fprintf(cfile, "      %d,\n", (int)(p - digit));
392 	}
393 	fputs("};\n", cfile);
394 }
395