]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.bin/indent/args.c
indent(1): add option -P for loading user-provided files as profiles
[FreeBSD/FreeBSD.git] / usr.bin / indent / args.c
1 /*-
2  * Copyright (c) 1985 Sun Microsystems, Inc.
3  * Copyright (c) 1980, 1993
4  *      The Regents of the University of California.  All rights reserved.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *      This product includes software developed by the University of
18  *      California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35
36 #if 0
37 #ifndef lint
38 static char sccsid[] = "@(#)args.c      8.1 (Berkeley) 6/6/93";
39 #endif /* not lint */
40 #endif
41
42 #include <sys/cdefs.h>
43 __FBSDID("$FreeBSD$");
44
45 /*
46  * Argument scanning and profile reading code.  Default parameters are set
47  * here as well.
48  */
49
50 #include <ctype.h>
51 #include <err.h>
52 #include <limits.h>
53 #include <stdio.h>
54 #include <stdlib.h>
55 #include <string.h>
56 #include "indent_globs.h"
57 #include "indent.h"
58
59 /* profile types */
60 #define PRO_SPECIAL     1       /* special case */
61 #define PRO_BOOL        2       /* boolean */
62 #define PRO_INT         3       /* integer */
63 #define PRO_FONT        4       /* troff font */
64
65 /* profile specials for booleans */
66 #define ON              1       /* turn it on */
67 #define OFF             0       /* turn it off */
68
69 /* profile specials for specials */
70 #define IGN             1       /* ignore it */
71 #define CLI             2       /* case label indent (float) */
72 #define STDIN           3       /* use stdin */
73 #define KEY             4       /* type (keyword) */
74
75 static void scan_profile(FILE *);
76
77 #define KEY_FILE                5       /* only used for args */
78
79 const char *option_source = "?";
80
81 void add_typedefs_from_file(const char *str);
82
83 /*
84  * N.B.: because of the way the table here is scanned, options whose names are
85  * substrings of other options must occur later; that is, with -lp vs -l, -lp
86  * must be first.  Also, while (most) booleans occur more than once, the last
87  * default value is the one actually assigned.
88  */
89 struct pro {
90     const char *p_name;         /* name, e.g. -bl, -cli */
91     int         p_type;         /* type (int, bool, special) */
92     int         p_default;      /* the default value (if int) */
93     int         p_special;      /* depends on type */
94     int        *p_obj;          /* the associated variable */
95 }           pro[] = {
96
97     {"T", PRO_SPECIAL, 0, KEY, 0},
98     {"U", PRO_SPECIAL, 0, KEY_FILE, 0},
99     {"bacc", PRO_BOOL, false, ON, &blanklines_around_conditional_compilation},
100     {"badp", PRO_BOOL, false, ON, &blanklines_after_declarations_at_proctop},
101     {"bad", PRO_BOOL, false, ON, &blanklines_after_declarations},
102     {"bap", PRO_BOOL, false, ON, &blanklines_after_procs},
103     {"bbb", PRO_BOOL, false, ON, &blanklines_before_blockcomments},
104     {"bc", PRO_BOOL, true, OFF, &ps.leave_comma},
105     {"bl", PRO_BOOL, true, OFF, &btype_2},
106     {"br", PRO_BOOL, true, ON, &btype_2},
107     {"bs", PRO_BOOL, false, ON, &Bill_Shannon},
108     {"cdb", PRO_BOOL, true, ON, &comment_delimiter_on_blankline},
109     {"cd", PRO_INT, 0, 0, &ps.decl_com_ind},
110     {"ce", PRO_BOOL, true, ON, &cuddle_else},
111     {"ci", PRO_INT, 0, 0, &continuation_indent},
112     {"cli", PRO_SPECIAL, 0, CLI, 0},
113     {"c", PRO_INT, 33, 0, &ps.com_ind},
114     {"di", PRO_INT, 16, 0, &ps.decl_indent},
115     {"dj", PRO_BOOL, false, ON, &ps.ljust_decl},
116     {"d", PRO_INT, 0, 0, &ps.unindent_displace},
117     {"eei", PRO_BOOL, false, ON, &extra_expression_indent},
118     {"ei", PRO_BOOL, true, ON, &ps.else_if},
119     {"fbc", PRO_FONT, 0, 0, (int *) &blkcomf},
120     {"fbs", PRO_BOOL, true, ON, &function_brace_split},
121     {"fbx", PRO_FONT, 0, 0, (int *) &boxcomf},
122     {"fb", PRO_FONT, 0, 0, (int *) &bodyf},
123     {"fc1", PRO_BOOL, true, ON, &format_col1_comments},
124     {"fcb", PRO_BOOL, true, ON, &format_block_comments},
125     {"fc", PRO_FONT, 0, 0, (int *) &scomf},
126     {"fk", PRO_FONT, 0, 0, (int *) &keywordf},
127     {"fs", PRO_FONT, 0, 0, (int *) &stringf},
128     {"ip", PRO_BOOL, true, ON, &ps.indent_parameters},
129     {"i", PRO_INT, 8, 0, &ps.ind_size},
130     {"lc", PRO_INT, 0, 0, &block_comment_max_col},
131     {"ldi", PRO_INT, -1, 0, &ps.local_decl_indent},
132     {"lp", PRO_BOOL, true, ON, &lineup_to_parens},
133     {"l", PRO_INT, 78, 0, &max_col},
134     {"nbacc", PRO_BOOL, false, OFF, &blanklines_around_conditional_compilation},
135     {"nbadp", PRO_BOOL, false, OFF, &blanklines_after_declarations_at_proctop},
136     {"nbad", PRO_BOOL, false, OFF, &blanklines_after_declarations},
137     {"nbap", PRO_BOOL, false, OFF, &blanklines_after_procs},
138     {"nbbb", PRO_BOOL, false, OFF, &blanklines_before_blockcomments},
139     {"nbc", PRO_BOOL, true, ON, &ps.leave_comma},
140     {"nbs", PRO_BOOL, false, OFF, &Bill_Shannon},
141     {"ncdb", PRO_BOOL, true, OFF, &comment_delimiter_on_blankline},
142     {"nce", PRO_BOOL, true, OFF, &cuddle_else},
143     {"ndj", PRO_BOOL, false, OFF, &ps.ljust_decl},
144     {"neei", PRO_BOOL, false, OFF, &extra_expression_indent},
145     {"nei", PRO_BOOL, true, OFF, &ps.else_if},
146     {"nfbs", PRO_BOOL, true, OFF, &function_brace_split},
147     {"nfc1", PRO_BOOL, true, OFF, &format_col1_comments},
148     {"nfcb", PRO_BOOL, true, OFF, &format_block_comments},
149     {"nip", PRO_BOOL, true, OFF, &ps.indent_parameters},
150     {"nlp", PRO_BOOL, true, OFF, &lineup_to_parens},
151     {"npcs", PRO_BOOL, false, OFF, &proc_calls_space},
152     {"npro", PRO_SPECIAL, 0, IGN, 0},
153     {"npsl", PRO_BOOL, true, OFF, &procnames_start_line},
154     {"nps", PRO_BOOL, false, OFF, &pointer_as_binop},
155     {"nsac", PRO_BOOL, false, OFF, &space_after_cast},
156     {"nsc", PRO_BOOL, true, OFF, &star_comment_cont},
157     {"nsob", PRO_BOOL, false, OFF, &swallow_optional_blanklines},
158     {"nut", PRO_BOOL, true, OFF, &use_tabs},
159     {"nv", PRO_BOOL, false, OFF, &verbose},
160     {"pcs", PRO_BOOL, false, ON, &proc_calls_space},
161     {"psl", PRO_BOOL, true, ON, &procnames_start_line},
162     {"ps", PRO_BOOL, false, ON, &pointer_as_binop},
163     {"sac", PRO_BOOL, false, ON, &space_after_cast},
164     {"sc", PRO_BOOL, true, ON, &star_comment_cont},
165     {"sob", PRO_BOOL, false, ON, &swallow_optional_blanklines},
166     {"st", PRO_SPECIAL, 0, STDIN, 0},
167     {"ta", PRO_BOOL, false, ON, &auto_typedefs},
168     {"troff", PRO_BOOL, false, ON, &troff},
169     {"ut", PRO_BOOL, true, ON, &use_tabs},
170     {"v", PRO_BOOL, false, ON, &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(i)) {
219                 if (p > buf && !comment)
220                     break;
221             } else {
222                 *p++ = i;
223             }
224         }
225         if (p != buf) {
226             *p++ = 0;
227             if (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 && p->p_type != PRO_FONT)
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         default:
310             errx(1, "set_option: internal error: p_special %d", p->p_special);
311         }
312         break;
313
314     case PRO_BOOL:
315         if (p->p_special == OFF)
316             *p->p_obj = false;
317         else
318             *p->p_obj = true;
319         break;
320
321     case PRO_INT:
322         if (!isdigit(*param_start)) {
323     need_param:
324             errx(1, "%s: ``%s'' requires a parameter", option_source, arg - 1);
325         }
326         *p->p_obj = atoi(param_start);
327         break;
328
329     case PRO_FONT:
330         parsefont((struct fstate *) p->p_obj, 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 }