xref: /freebsd/usr.bin/indent/args.c (revision e52d92164754cbfff84767d4c6eb3cc93e8c21ae)
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 /* profile types */
62 #define	PRO_SPECIAL	1	/* special case */
63 #define	PRO_BOOL	2	/* boolean */
64 #define	PRO_INT		3	/* integer */
65 
66 /* profile specials for booleans */
67 #define	ON		1	/* turn it on */
68 #define	OFF		0	/* turn it off */
69 
70 /* profile specials for specials */
71 #define	IGN		1	/* ignore it */
72 #define	CLI		2	/* case label indent (float) */
73 #define	STDIN		3	/* use stdin */
74 #define	KEY		4	/* type (keyword) */
75 
76 static void scan_profile(FILE *);
77 
78 #define	KEY_FILE		5	/* only used for args */
79 
80 const char *option_source = "?";
81 
82 void add_typedefs_from_file(const char *str);
83 
84 /*
85  * N.B.: because of the way the table here is scanned, options whose names are
86  * substrings of other options must occur later; that is, with -lp vs -l, -lp
87  * must be first.  Also, while (most) booleans occur more than once, the last
88  * default value is the one actually assigned.
89  */
90 struct pro {
91     const char *p_name;		/* name, e.g. -bl, -cli */
92     int         p_type;		/* type (int, bool, special) */
93     int         p_default;	/* the default value (if int) */
94     int         p_special;	/* depends on type */
95     int        *p_obj;		/* the associated variable */
96 }           pro[] = {
97 
98     {"T", PRO_SPECIAL, 0, KEY, 0},
99     {"U", PRO_SPECIAL, 0, KEY_FILE, 0},
100     {"P", PRO_SPECIAL, 0, IGN, 0},
101     {"bacc", PRO_BOOL, false, ON, &blanklines_around_conditional_compilation},
102     {"badp", PRO_BOOL, false, ON, &blanklines_after_declarations_at_proctop},
103     {"bad", PRO_BOOL, false, ON, &blanklines_after_declarations},
104     {"bap", PRO_BOOL, false, ON, &blanklines_after_procs},
105     {"bbb", PRO_BOOL, false, ON, &blanklines_before_blockcomments},
106     {"bc", PRO_BOOL, true, OFF, &ps.leave_comma},
107     {"bl", PRO_BOOL, true, OFF, &btype_2},
108     {"br", PRO_BOOL, true, ON, &btype_2},
109     {"bs", PRO_BOOL, false, ON, &Bill_Shannon},
110     {"cdb", PRO_BOOL, true, ON, &comment_delimiter_on_blankline},
111     {"cd", PRO_INT, 0, 0, &ps.decl_com_ind},
112     {"ce", PRO_BOOL, true, ON, &cuddle_else},
113     {"ci", PRO_INT, 0, 0, &continuation_indent},
114     {"cli", PRO_SPECIAL, 0, CLI, 0},
115     {"c", PRO_INT, 33, 0, &ps.com_ind},
116     {"di", PRO_INT, 16, 0, &ps.decl_indent},
117     {"dj", PRO_BOOL, false, ON, &ps.ljust_decl},
118     {"d", PRO_INT, 0, 0, &ps.unindent_displace},
119     {"eei", PRO_BOOL, false, ON, &extra_expression_indent},
120     {"ei", PRO_BOOL, true, ON, &ps.else_if},
121     {"fbs", PRO_BOOL, true, ON, &function_brace_split},
122     {"fc1", PRO_BOOL, true, ON, &format_col1_comments},
123     {"fcb", PRO_BOOL, true, ON, &format_block_comments},
124     {"ip", PRO_BOOL, true, ON, &ps.indent_parameters},
125     {"i", PRO_INT, 8, 0, &ps.ind_size},
126     {"lc", PRO_INT, 0, 0, &block_comment_max_col},
127     {"ldi", PRO_INT, -1, 0, &ps.local_decl_indent},
128     {"lpl", PRO_BOOL, false, ON, &lineup_to_parens_always},
129     {"lp", PRO_BOOL, true, ON, &lineup_to_parens},
130     {"l", PRO_INT, 78, 0, &max_col},
131     {"nbacc", PRO_BOOL, false, OFF, &blanklines_around_conditional_compilation},
132     {"nbadp", PRO_BOOL, false, OFF, &blanklines_after_declarations_at_proctop},
133     {"nbad", PRO_BOOL, false, OFF, &blanklines_after_declarations},
134     {"nbap", PRO_BOOL, false, OFF, &blanklines_after_procs},
135     {"nbbb", PRO_BOOL, false, OFF, &blanklines_before_blockcomments},
136     {"nbc", PRO_BOOL, true, ON, &ps.leave_comma},
137     {"nbs", PRO_BOOL, false, OFF, &Bill_Shannon},
138     {"ncdb", PRO_BOOL, true, OFF, &comment_delimiter_on_blankline},
139     {"nce", PRO_BOOL, true, OFF, &cuddle_else},
140     {"ndj", PRO_BOOL, false, OFF, &ps.ljust_decl},
141     {"neei", PRO_BOOL, false, OFF, &extra_expression_indent},
142     {"nei", PRO_BOOL, true, OFF, &ps.else_if},
143     {"nfbs", PRO_BOOL, true, OFF, &function_brace_split},
144     {"nfc1", PRO_BOOL, true, OFF, &format_col1_comments},
145     {"nfcb", PRO_BOOL, true, OFF, &format_block_comments},
146     {"nip", PRO_BOOL, true, OFF, &ps.indent_parameters},
147     {"nlpl", PRO_BOOL, false, OFF, &lineup_to_parens_always},
148     {"nlp", PRO_BOOL, true, OFF, &lineup_to_parens},
149     {"npcs", PRO_BOOL, false, OFF, &proc_calls_space},
150     {"npro", PRO_SPECIAL, 0, IGN, 0},
151     {"npsl", PRO_BOOL, true, OFF, &procnames_start_line},
152     {"nsac", PRO_BOOL, false, OFF, &space_after_cast},
153     {"nsc", PRO_BOOL, true, OFF, &star_comment_cont},
154     {"nsob", PRO_BOOL, false, OFF, &swallow_optional_blanklines},
155     {"nut", PRO_BOOL, true, OFF, &use_tabs},
156     {"nv", PRO_BOOL, false, OFF, &verbose},
157     {"pcs", PRO_BOOL, false, ON, &proc_calls_space},
158     {"psl", PRO_BOOL, true, ON, &procnames_start_line},
159     {"sac", PRO_BOOL, false, ON, &space_after_cast},
160     {"sc", PRO_BOOL, true, ON, &star_comment_cont},
161     {"sob", PRO_BOOL, false, ON, &swallow_optional_blanklines},
162     {"st", PRO_SPECIAL, 0, STDIN, 0},
163     {"ta", PRO_BOOL, false, ON, &auto_typedefs},
164     {"ts", PRO_INT, 8, 0, &tabsize},
165     {"ut", PRO_BOOL, true, ON, &use_tabs},
166     {"v", PRO_BOOL, false, ON, &verbose},
167     /* whew! */
168     {0, 0, 0, 0, 0}
169 };
170 
171 /*
172  * set_profile reads $HOME/.indent.pro and ./.indent.pro and handles arguments
173  * given in these files.
174  */
175 void
176 set_profile(const char *profile_name)
177 {
178     FILE *f;
179     char fname[PATH_MAX];
180     static char prof[] = ".indent.pro";
181 
182     if (profile_name == NULL)
183 	snprintf(fname, sizeof(fname), "%s/%s", getenv("HOME"), prof);
184     else
185 	snprintf(fname, sizeof(fname), "%s", profile_name + 2);
186     if ((f = fopen(option_source = fname, "r")) != NULL) {
187 	scan_profile(f);
188 	(void) fclose(f);
189     }
190     if ((f = fopen(option_source = prof, "r")) != NULL) {
191 	scan_profile(f);
192 	(void) fclose(f);
193     }
194     option_source = "Command line";
195 }
196 
197 static void
198 scan_profile(FILE *f)
199 {
200     int		comment, i;
201     char	*p;
202     char        buf[BUFSIZ];
203 
204     while (1) {
205 	p = buf;
206 	comment = 0;
207 	while ((i = getc(f)) != EOF) {
208 	    if (i == '*' && !comment && p > buf && p[-1] == '/') {
209 		comment = p - buf;
210 		*p++ = i;
211 	    } else if (i == '/' && comment && p > buf && p[-1] == '*') {
212 		p = buf + comment - 1;
213 		comment = 0;
214 	    } else if (isspace((unsigned char)i)) {
215 		if (p > buf && !comment)
216 		    break;
217 	    } else {
218 		*p++ = i;
219 	    }
220 	}
221 	if (p != buf) {
222 	    *p++ = 0;
223 	    if (verbose)
224 		printf("profile: %s\n", buf);
225 	    set_option(buf);
226 	}
227 	else if (i == EOF)
228 	    return;
229     }
230 }
231 
232 static const char *
233 eqin(const char *s1, const char *s2)
234 {
235     while (*s1) {
236 	if (*s1++ != *s2++)
237 	    return (NULL);
238     }
239     return (s2);
240 }
241 
242 /*
243  * Set the defaults.
244  */
245 void
246 set_defaults(void)
247 {
248     struct pro *p;
249 
250     /*
251      * Because ps.case_indent is a float, we can't initialize it from the
252      * table:
253      */
254     ps.case_indent = 0.0;	/* -cli0.0 */
255     for (p = pro; p->p_name; p++)
256 	if (p->p_type != PRO_SPECIAL)
257 	    *p->p_obj = p->p_default;
258 }
259 
260 void
261 set_option(char *arg)
262 {
263     struct	pro *p;
264     const char	*param_start;
265 
266     arg++;			/* ignore leading "-" */
267     for (p = pro; p->p_name; p++)
268 	if (*p->p_name == *arg && (param_start = eqin(p->p_name, arg)) != NULL)
269 	    goto found;
270     errx(1, "%s: unknown parameter \"%s\"", option_source, arg - 1);
271 found:
272     switch (p->p_type) {
273 
274     case PRO_SPECIAL:
275 	switch (p->p_special) {
276 
277 	case IGN:
278 	    break;
279 
280 	case CLI:
281 	    if (*param_start == 0)
282 		goto need_param;
283 	    ps.case_indent = atof(param_start);
284 	    break;
285 
286 	case STDIN:
287 	    if (input == NULL)
288 		input = stdin;
289 	    if (output == NULL)
290 		output = stdout;
291 	    break;
292 
293 	case KEY:
294 	    if (*param_start == 0)
295 		goto need_param;
296 	    add_typename(param_start);
297 	    break;
298 
299 	case KEY_FILE:
300 	    if (*param_start == 0)
301 		goto need_param;
302 	    add_typedefs_from_file(param_start);
303 	    break;
304 
305 	default:
306 	    errx(1, "set_option: internal error: p_special %d", p->p_special);
307 	}
308 	break;
309 
310     case PRO_BOOL:
311 	if (p->p_special == OFF)
312 	    *p->p_obj = false;
313 	else
314 	    *p->p_obj = true;
315 	break;
316 
317     case PRO_INT:
318 	if (!isdigit((unsigned char)*param_start)) {
319     need_param:
320 	    errx(1, "%s: ``%s'' requires a parameter", option_source, p->p_name);
321 	}
322 	*p->p_obj = atoi(param_start);
323 	break;
324 
325     default:
326 	errx(1, "set_option: internal error: p_type %d", p->p_type);
327     }
328 }
329 
330 void
331 add_typedefs_from_file(const char *str)
332 {
333     FILE *file;
334     char line[BUFSIZ];
335 
336     if ((file = fopen(str, "r")) == NULL) {
337 	fprintf(stderr, "indent: cannot open file %s\n", str);
338 	exit(1);
339     }
340     while ((fgets(line, BUFSIZ, file)) != NULL) {
341 	/* Remove trailing whitespace */
342 	line[strcspn(line, " \t\n\r")] = '\0';
343 	add_typename(line);
344     }
345     fclose(file);
346 }
347