xref: /freebsd/usr.bin/indent/args.c (revision 389e4940069316fe667ffa263fa7d6390d0a960f)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 1985 Sun Microsystems, Inc.
5  * Copyright (c) 1980, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by the University of
20  *	California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  */
37 
38 #if 0
39 #ifndef lint
40 static char sccsid[] = "@(#)args.c	8.1 (Berkeley) 6/6/93";
41 #endif /* not lint */
42 #endif
43 
44 #include <sys/cdefs.h>
45 __FBSDID("$FreeBSD$");
46 
47 /*
48  * Argument scanning and profile reading code.  Default parameters are set
49  * here as well.
50  */
51 
52 #include <ctype.h>
53 #include <err.h>
54 #include <limits.h>
55 #include <stdio.h>
56 #include <stdlib.h>
57 #include <string.h>
58 #include "indent_globs.h"
59 #include "indent.h"
60 
61 #define INDENT_VERSION	"2.0"
62 
63 /* profile types */
64 #define	PRO_SPECIAL	1	/* special case */
65 #define	PRO_BOOL	2	/* boolean */
66 #define	PRO_INT		3	/* integer */
67 
68 /* profile specials for booleans */
69 #define	ON		1	/* turn it on */
70 #define	OFF		0	/* turn it off */
71 
72 /* profile specials for specials */
73 #define	IGN		1	/* ignore it */
74 #define	CLI		2	/* case label indent (float) */
75 #define	STDIN		3	/* use stdin */
76 #define	KEY		4	/* type (keyword) */
77 
78 static void scan_profile(FILE *);
79 
80 #define	KEY_FILE		5	/* only used for args */
81 #define VERSION			6	/* only used for args */
82 
83 const char *option_source = "?";
84 
85 void add_typedefs_from_file(const char *str);
86 
87 /*
88  * N.B.: because of the way the table here is scanned, options whose names are
89  * substrings of other options must occur later; that is, with -lp vs -l, -lp
90  * must be first.  Also, while (most) booleans occur more than once, the last
91  * default value is the one actually assigned.
92  */
93 struct pro {
94     const char *p_name;		/* name, e.g. -bl, -cli */
95     int         p_type;		/* type (int, bool, special) */
96     int         p_default;	/* the default value (if int) */
97     int         p_special;	/* depends on type */
98     int        *p_obj;		/* the associated variable */
99 }           pro[] = {
100 
101     {"T", PRO_SPECIAL, 0, KEY, 0},
102     {"U", PRO_SPECIAL, 0, KEY_FILE, 0},
103     {"-version", PRO_SPECIAL, 0, VERSION, 0},
104     {"P", PRO_SPECIAL, 0, IGN, 0},
105     {"bacc", PRO_BOOL, false, ON, &opt.blanklines_around_conditional_compilation},
106     {"badp", PRO_BOOL, false, ON, &opt.blanklines_after_declarations_at_proctop},
107     {"bad", PRO_BOOL, false, ON, &opt.blanklines_after_declarations},
108     {"bap", PRO_BOOL, false, ON, &opt.blanklines_after_procs},
109     {"bbb", PRO_BOOL, false, ON, &opt.blanklines_before_blockcomments},
110     {"bc", PRO_BOOL, true, OFF, &opt.leave_comma},
111     {"bl", PRO_BOOL, true, OFF, &opt.btype_2},
112     {"br", PRO_BOOL, true, ON, &opt.btype_2},
113     {"bs", PRO_BOOL, false, ON, &opt.Bill_Shannon},
114     {"cdb", PRO_BOOL, true, ON, &opt.comment_delimiter_on_blankline},
115     {"cd", PRO_INT, 0, 0, &opt.decl_com_ind},
116     {"ce", PRO_BOOL, true, ON, &opt.cuddle_else},
117     {"ci", PRO_INT, 0, 0, &opt.continuation_indent},
118     {"cli", PRO_SPECIAL, 0, CLI, 0},
119     {"cs", PRO_BOOL, false, ON, &opt.space_after_cast},
120     {"c", PRO_INT, 33, 0, &opt.com_ind},
121     {"di", PRO_INT, 16, 0, &opt.decl_indent},
122     {"dj", PRO_BOOL, false, ON, &opt.ljust_decl},
123     {"d", PRO_INT, 0, 0, &opt.unindent_displace},
124     {"eei", PRO_BOOL, false, ON, &opt.extra_expression_indent},
125     {"ei", PRO_BOOL, true, ON, &opt.else_if},
126     {"fbs", PRO_BOOL, true, ON, &opt.function_brace_split},
127     {"fc1", PRO_BOOL, true, ON, &opt.format_col1_comments},
128     {"fcb", PRO_BOOL, true, ON, &opt.format_block_comments},
129     {"ip", PRO_BOOL, true, ON, &opt.indent_parameters},
130     {"i", PRO_INT, 8, 0, &opt.ind_size},
131     {"lc", PRO_INT, 0, 0, &opt.block_comment_max_col},
132     {"ldi", PRO_INT, -1, 0, &opt.local_decl_indent},
133     {"lpl", PRO_BOOL, false, ON, &opt.lineup_to_parens_always},
134     {"lp", PRO_BOOL, true, ON, &opt.lineup_to_parens},
135     {"l", PRO_INT, 78, 0, &opt.max_col},
136     {"nbacc", PRO_BOOL, false, OFF, &opt.blanklines_around_conditional_compilation},
137     {"nbadp", PRO_BOOL, false, OFF, &opt.blanklines_after_declarations_at_proctop},
138     {"nbad", PRO_BOOL, false, OFF, &opt.blanklines_after_declarations},
139     {"nbap", PRO_BOOL, false, OFF, &opt.blanklines_after_procs},
140     {"nbbb", PRO_BOOL, false, OFF, &opt.blanklines_before_blockcomments},
141     {"nbc", PRO_BOOL, true, ON, &opt.leave_comma},
142     {"nbs", PRO_BOOL, false, OFF, &opt.Bill_Shannon},
143     {"ncdb", PRO_BOOL, true, OFF, &opt.comment_delimiter_on_blankline},
144     {"nce", PRO_BOOL, true, OFF, &opt.cuddle_else},
145     {"ncs", PRO_BOOL, false, OFF, &opt.space_after_cast},
146     {"ndj", PRO_BOOL, false, OFF, &opt.ljust_decl},
147     {"neei", PRO_BOOL, false, OFF, &opt.extra_expression_indent},
148     {"nei", PRO_BOOL, true, OFF, &opt.else_if},
149     {"nfbs", PRO_BOOL, true, OFF, &opt.function_brace_split},
150     {"nfc1", PRO_BOOL, true, OFF, &opt.format_col1_comments},
151     {"nfcb", PRO_BOOL, true, OFF, &opt.format_block_comments},
152     {"nip", PRO_BOOL, true, OFF, &opt.indent_parameters},
153     {"nlpl", PRO_BOOL, false, OFF, &opt.lineup_to_parens_always},
154     {"nlp", PRO_BOOL, true, OFF, &opt.lineup_to_parens},
155     {"npcs", PRO_BOOL, false, OFF, &opt.proc_calls_space},
156     {"npro", PRO_SPECIAL, 0, IGN, 0},
157     {"npsl", PRO_BOOL, true, OFF, &opt.procnames_start_line},
158     {"nsc", PRO_BOOL, true, OFF, &opt.star_comment_cont},
159     {"nsob", PRO_BOOL, false, OFF, &opt.swallow_optional_blanklines},
160     {"nut", PRO_BOOL, true, OFF, &opt.use_tabs},
161     {"nv", PRO_BOOL, false, OFF, &opt.verbose},
162     {"pcs", PRO_BOOL, false, ON, &opt.proc_calls_space},
163     {"psl", PRO_BOOL, true, ON, &opt.procnames_start_line},
164     {"sc", PRO_BOOL, true, ON, &opt.star_comment_cont},
165     {"sob", PRO_BOOL, false, ON, &opt.swallow_optional_blanklines},
166     {"st", PRO_SPECIAL, 0, STDIN, 0},
167     {"ta", PRO_BOOL, false, ON, &opt.auto_typedefs},
168     {"ts", PRO_INT, 8, 0, &opt.tabsize},
169     {"ut", PRO_BOOL, true, ON, &opt.use_tabs},
170     {"v", PRO_BOOL, false, ON, &opt.verbose},
171     /* whew! */
172     {0, 0, 0, 0, 0}
173 };
174 
175 /*
176  * set_profile reads $HOME/.indent.pro and ./.indent.pro and handles arguments
177  * given in these files.
178  */
179 void
180 set_profile(const char *profile_name)
181 {
182     FILE *f;
183     char fname[PATH_MAX];
184     static char prof[] = ".indent.pro";
185 
186     if (profile_name == NULL)
187 	snprintf(fname, sizeof(fname), "%s/%s", getenv("HOME"), prof);
188     else
189 	snprintf(fname, sizeof(fname), "%s", profile_name + 2);
190     if ((f = fopen(option_source = fname, "r")) != NULL) {
191 	scan_profile(f);
192 	(void) fclose(f);
193     }
194     if ((f = fopen(option_source = prof, "r")) != NULL) {
195 	scan_profile(f);
196 	(void) fclose(f);
197     }
198     option_source = "Command line";
199 }
200 
201 static void
202 scan_profile(FILE *f)
203 {
204     int		comment, i;
205     char	*p;
206     char        buf[BUFSIZ];
207 
208     while (1) {
209 	p = buf;
210 	comment = 0;
211 	while ((i = getc(f)) != EOF) {
212 	    if (i == '*' && !comment && p > buf && p[-1] == '/') {
213 		comment = p - buf;
214 		*p++ = i;
215 	    } else if (i == '/' && comment && p > buf && p[-1] == '*') {
216 		p = buf + comment - 1;
217 		comment = 0;
218 	    } else if (isspace((unsigned char)i)) {
219 		if (p > buf && !comment)
220 		    break;
221 	    } else {
222 		*p++ = i;
223 	    }
224 	}
225 	if (p != buf) {
226 	    *p++ = 0;
227 	    if (opt.verbose)
228 		printf("profile: %s\n", buf);
229 	    set_option(buf);
230 	}
231 	else if (i == EOF)
232 	    return;
233     }
234 }
235 
236 static const char *
237 eqin(const char *s1, const char *s2)
238 {
239     while (*s1) {
240 	if (*s1++ != *s2++)
241 	    return (NULL);
242     }
243     return (s2);
244 }
245 
246 /*
247  * Set the defaults.
248  */
249 void
250 set_defaults(void)
251 {
252     struct pro *p;
253 
254     /*
255      * Because ps.case_indent is a float, we can't initialize it from the
256      * table:
257      */
258     ps.case_indent = 0.0;	/* -cli0.0 */
259     for (p = pro; p->p_name; p++)
260 	if (p->p_type != PRO_SPECIAL)
261 	    *p->p_obj = p->p_default;
262 }
263 
264 void
265 set_option(char *arg)
266 {
267     struct	pro *p;
268     const char	*param_start;
269 
270     arg++;			/* ignore leading "-" */
271     for (p = pro; p->p_name; p++)
272 	if (*p->p_name == *arg && (param_start = eqin(p->p_name, arg)) != NULL)
273 	    goto found;
274     errx(1, "%s: unknown parameter \"%s\"", option_source, arg - 1);
275 found:
276     switch (p->p_type) {
277 
278     case PRO_SPECIAL:
279 	switch (p->p_special) {
280 
281 	case IGN:
282 	    break;
283 
284 	case CLI:
285 	    if (*param_start == 0)
286 		goto need_param;
287 	    ps.case_indent = atof(param_start);
288 	    break;
289 
290 	case STDIN:
291 	    if (input == NULL)
292 		input = stdin;
293 	    if (output == NULL)
294 		output = stdout;
295 	    break;
296 
297 	case KEY:
298 	    if (*param_start == 0)
299 		goto need_param;
300 	    add_typename(param_start);
301 	    break;
302 
303 	case KEY_FILE:
304 	    if (*param_start == 0)
305 		goto need_param;
306 	    add_typedefs_from_file(param_start);
307 	    break;
308 
309 	case VERSION:
310 	    printf("FreeBSD indent %s\n", INDENT_VERSION);
311 	    exit(0);
312 
313 	default:
314 	    errx(1, "set_option: internal error: p_special %d", p->p_special);
315 	}
316 	break;
317 
318     case PRO_BOOL:
319 	if (p->p_special == OFF)
320 	    *p->p_obj = false;
321 	else
322 	    *p->p_obj = true;
323 	break;
324 
325     case PRO_INT:
326 	if (!isdigit((unsigned char)*param_start)) {
327     need_param:
328 	    errx(1, "%s: ``%s'' requires a parameter", option_source, p->p_name);
329 	}
330 	*p->p_obj = atoi(param_start);
331 	break;
332 
333     default:
334 	errx(1, "set_option: internal error: p_type %d", p->p_type);
335     }
336 }
337 
338 void
339 add_typedefs_from_file(const char *str)
340 {
341     FILE *file;
342     char line[BUFSIZ];
343 
344     if ((file = fopen(str, "r")) == NULL) {
345 	fprintf(stderr, "indent: cannot open file %s\n", str);
346 	exit(1);
347     }
348     while ((fgets(line, BUFSIZ, file)) != NULL) {
349 	/* Remove trailing whitespace */
350 	line[strcspn(line, " \t\n\r")] = '\0';
351 	add_typename(line);
352     }
353     fclose(file);
354 }
355