xref: /freebsd/usr.bin/indent/indent_globs.h (revision cbd30a72ca196976c1c700400ecd424baa1b9c16)
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  *	@(#)indent_globs.h	8.1 (Berkeley) 6/6/93
36  * $FreeBSD$
37  */
38 
39 #define BACKSLASH '\\'
40 #define bufsize 200		/* size of internal buffers */
41 #define sc_size 5000		/* size of save_com buffer */
42 #define label_offset 2		/* number of levels a label is placed to left
43 				 * of code */
44 
45 #define tabsize 8		/* the size of a tab */
46 #define tabmask 0177770		/* mask used when figuring length of lines
47 				 * with tabs */
48 
49 
50 #define false 0
51 #define true  1
52 
53 
54 FILE       *input;		/* the fid for the input file */
55 FILE       *output;		/* the output file */
56 
57 #define CHECK_SIZE_CODE \
58 	if (e_code >= l_code) { \
59 	    int nsize = l_code-s_code+400; \
60 	    int code_len = e_code-s_code; \
61 	    codebuf = (char *) realloc(codebuf, nsize); \
62 	    if (codebuf == NULL) \
63 		err(1, NULL); \
64 	    e_code = codebuf + code_len + 1; \
65 	    l_code = codebuf + nsize - 5; \
66 	    s_code = codebuf + 1; \
67 	}
68 #define CHECK_SIZE_COM \
69 	if (e_com >= l_com) { \
70 	    int nsize = l_com-s_com+400; \
71 	    int com_len = e_com - s_com; \
72 	    int blank_pos = last_bl - s_com; \
73 	    combuf = (char *) realloc(combuf, nsize); \
74 	    if (combuf == NULL) \
75 		err(1, NULL); \
76 	    e_com = combuf + com_len + 1; \
77 	    last_bl = combuf + blank_pos + 1; \
78 	    l_com = combuf + nsize - 5; \
79 	    s_com = combuf + 1; \
80 	}
81 #define CHECK_SIZE_LAB \
82 	if (e_lab >= l_lab) { \
83 	    int nsize = l_lab-s_lab+400; \
84 	    int label_len = e_lab - s_lab; \
85 	    labbuf = (char *) realloc(labbuf, nsize); \
86 	    if (labbuf == NULL) \
87 		err(1, NULL); \
88 	    e_lab = labbuf + label_len + 1; \
89 	    l_lab = labbuf + nsize - 5; \
90 	    s_lab = labbuf + 1; \
91 	}
92 #define CHECK_SIZE_TOKEN \
93 	if (e_token >= l_token) { \
94 	    int nsize = l_token-s_token+400; \
95 	    int token_len = e_token - s_token; \
96 	    tokenbuf = (char *) realloc(tokenbuf, nsize); \
97 	    if (tokenbuf == NULL) \
98 		err(1, NULL); \
99 	    e_token = tokenbuf + token_len + 1; \
100 	    l_token = tokenbuf + nsize - 5; \
101 	    s_token = tokenbuf + 1; \
102 	}
103 
104 char       *labbuf;		/* buffer for label */
105 char       *s_lab;		/* start ... */
106 char       *e_lab;		/* .. and end of stored label */
107 char       *l_lab;		/* limit of label buffer */
108 
109 char       *codebuf;		/* buffer for code section */
110 char       *s_code;		/* start ... */
111 char       *e_code;		/* .. and end of stored code */
112 char       *l_code;		/* limit of code section */
113 
114 char       *combuf;		/* buffer for comments */
115 char       *s_com;		/* start ... */
116 char       *e_com;		/* ... and end of stored comments */
117 char       *l_com;		/* limit of comment buffer */
118 
119 #define token s_token
120 char       *tokenbuf;		/* the last token scanned */
121 char	   *s_token;
122 char       *e_token;
123 char	   *l_token;
124 
125 char       *in_buffer;		/* input buffer */
126 char	   *in_buffer_limit;	/* the end of the input buffer */
127 char       *buf_ptr;		/* ptr to next character to be taken from
128 				 * in_buffer */
129 char       *buf_end;		/* ptr to first after last char in in_buffer */
130 
131 char        save_com[sc_size];	/* input text is saved here when looking for
132 				 * the brace after an if, while, etc */
133 char       *sc_end;		/* pointer into save_com buffer */
134 
135 char       *bp_save;		/* saved value of buf_ptr when taking input
136 				 * from save_com */
137 char       *be_save;		/* similarly saved value of buf_end */
138 
139 
140 int         found_err;
141 int         pointer_as_binop;
142 int         blanklines_after_declarations;
143 int         blanklines_before_blockcomments;
144 int         blanklines_after_procs;
145 int         blanklines_around_conditional_compilation;
146 int         swallow_optional_blanklines;
147 int         n_real_blanklines;
148 int         prefix_blankline_requested;
149 int         postfix_blankline_requested;
150 int         break_comma;	/* when true and not in parens, break after a
151 				 * comma */
152 int         btype_2;		/* when true, brace should be on same line as
153 				 * if, while, etc */
154 float       case_ind;		/* indentation level to be used for a "case
155 				 * n:" */
156 int         code_lines;		/* count of lines with code */
157 int         had_eof;		/* set to true when input is exhausted */
158 int         line_no;		/* the current line number. */
159 int         max_col;		/* the maximum allowable line length */
160 int         verbose;		/* when true, non-essential error messages are
161 				 * printed */
162 int         cuddle_else;	/* true if else should cuddle up to '}' */
163 int         star_comment_cont;	/* true iff comment continuation lines should
164 				 * have stars at the beginning of each line. */
165 int         comment_delimiter_on_blankline;
166 int         troff;		/* true iff were generating troff input */
167 int         procnames_start_line;	/* if true, the names of procedures
168 					 * being defined get placed in column
169 					 * 1 (ie. a newline is placed between
170 					 * the type of the procedure and its
171 					 * name) */
172 int         proc_calls_space;	/* If true, procedure calls look like:
173 				 * foo(bar) rather than foo (bar) */
174 int         format_block_comments;	/* true if comments beginning with
175 					 * `/ * \n' are to be reformatted */
176 int         format_col1_comments;	/* If comments which start in column 1
177 					 * are to be magically reformatted
178 					 * (just like comments that begin in
179 					 * later columns) */
180 int         inhibit_formatting;	/* true if INDENT OFF is in effect */
181 int         suppress_blanklines;/* set iff following blanklines should be
182 				 * suppressed */
183 int         continuation_indent;/* set to the indentation between the edge of
184 				 * code and continuation lines */
185 int         lineup_to_parens;	/* if true, continued code within parens will
186 				 * be lined up to the open paren */
187 int         Bill_Shannon;	/* true iff a blank should always be inserted
188 				 * after sizeof */
189 int         blanklines_after_declarations_at_proctop;	/* This is vaguely
190 							 * similar to
191 							 * blanklines_after_decla
192 							 * rations except that
193 							 * it only applies to
194 							 * the first set of
195 							 * declarations in a
196 							 * procedure (just after
197 							 * the first '{') and it
198 							 * causes a blank line
199 							 * to be generated even
200 							 * if there are no
201 							 * declarations */
202 int         block_comment_max_col;
203 int         extra_expression_indent;	/* true if continuation lines from the
204 					 * expression part of "if(e)",
205 					 * "while(e)", "for(e;e;e)" should be
206 					 * indented an extra tab stop so that
207 					 * they don't conflict with the code
208 					 * that follows */
209 int	    function_brace_split;	/* split function declaration and
210 					 * brace onto separate lines */
211 int	    use_tabs;			/* set true to use tabs for spacing,
212 					 * false uses all spaces */
213 int	    auto_typedefs;		/* set true to recognize identifiers
214 					 * ending in "_t" like typedefs */
215 int	    space_after_cast;		/* "b = (int) a" vs "b = (int)a" */
216 
217 /* -troff font state information */
218 
219 struct fstate {
220     char        font[4];
221     char        size;
222     int         allcaps:1;
223 } __aligned(sizeof(int));
224 char       *chfont(struct fstate *, struct fstate *, char *);
225 
226 struct fstate
227             keywordf,		/* keyword font */
228             stringf,		/* string font */
229             boxcomf,		/* Box comment font */
230             blkcomf,		/* Block comment font */
231             scomf,		/* Same line comment font */
232             bodyf;		/* major body font */
233 
234 
235 #define	STACKSIZE 256
236 
237 struct parser_state {
238     int         last_token;
239     struct fstate cfont;	/* Current font */
240     int         p_stack[STACKSIZE];	/* this is the parsers stack */
241     int         il[STACKSIZE];	/* this stack stores indentation levels */
242     float       cstk[STACKSIZE];/* used to store case stmt indentation levels */
243     int         box_com;	/* set to true when we are in a "boxed"
244 				 * comment. In that case, the first non-blank
245 				 * char should be lined up with the / in / followed by * */
246     int         comment_delta,
247                 n_comment_delta;
248     int         cast_mask;	/* indicates which close parens potentially
249 				 * close off casts */
250     int         not_cast_mask;	/* indicates which close parens definitely
251 				 * close off something else than casts */
252     int         block_init;	/* true iff inside a block initialization */
253     int         block_init_level;	/* The level of brace nesting in an
254 					 * initialization */
255     int         last_nl;	/* this is true if the last thing scanned was
256 				 * a newline */
257     int         in_or_st;	/* Will be true iff there has been a
258 				 * declarator (e.g. int or char) and no left
259 				 * paren since the last semicolon. When true,
260 				 * a '{' is starting a structure definition or
261 				 * an initialization list */
262     int         bl_line;	/* set to 1 by dump_line if the line is blank */
263     int         col_1;		/* set to true if the last token started in
264 				 * column 1 */
265     int         com_col;	/* this is the column in which the current
266 				 * comment should start */
267     int         com_ind;	/* the column in which comments to the right
268 				 * of code should start */
269     int         com_lines;	/* the number of lines with comments, set by
270 				 * dump_line */
271     int         dec_nest;	/* current nesting level for structure or init */
272     int         decl_com_ind;	/* the column in which comments after
273 				 * declarations should be put */
274     int         decl_on_line;	/* set to true if this line of code has part
275 				 * of a declaration on it */
276     int         i_l_follow;	/* the level to which ind_level should be set
277 				 * after the current line is printed */
278     int         in_decl;	/* set to true when we are in a declaration
279 				 * stmt.  The processing of braces is then
280 				 * slightly different */
281     int         in_stmt;	/* set to 1 while in a stmt */
282     int         ind_level;	/* the current indentation level */
283     int         ind_size;	/* the size of one indentation level */
284     int         ind_stmt;	/* set to 1 if next line should have an extra
285 				 * indentation level because we are in the
286 				 * middle of a stmt */
287     int         last_u_d;	/* set to true after scanning a token which
288 				 * forces a following operator to be unary */
289     int         leave_comma;	/* if true, never break declarations after
290 				 * commas */
291     int         ljust_decl;	/* true if declarations should be left
292 				 * justified */
293     int         out_coms;	/* the number of comments processed, set by
294 				 * pr_comment */
295     int         out_lines;	/* the number of lines written, set by
296 				 * dump_line */
297     int         p_l_follow;	/* used to remember how to indent following
298 				 * statement */
299     int         paren_level;	/* parenthesization level. used to indent
300 				 * within statements */
301     short       paren_indents[20];	/* column positions of each paren */
302     int         pcase;		/* set to 1 if the current line label is a
303 				 * case.  It is printed differently from a
304 				 * regular label */
305     int         search_brace;	/* set to true by parse when it is necessary
306 				 * to buffer up all info up to the start of a
307 				 * stmt after an if, while, etc */
308     int         unindent_displace;	/* comments not to the right of code
309 					 * will be placed this many
310 					 * indentation levels to the left of
311 					 * code */
312     int         use_ff;		/* set to one if the current line should be
313 				 * terminated with a form feed */
314     int         want_blank;	/* set to true when the following token should
315 				 * be prefixed by a blank. (Said prefixing is
316 				 * ignored in some cases.) */
317     int         else_if;	/* True iff else if pairs should be handled
318 				 * specially */
319     int         decl_indent;	/* column to indent declared identifiers to */
320     int         local_decl_indent;	/* like decl_indent but for locals */
321     int         keyword;	/* the type of a keyword or 0 */
322     int         dumped_decl_indent;
323     float       case_indent;	/* The distance to indent case labels from the
324 				 * switch statement */
325     int         in_parameter_declaration;
326     int         indent_parameters;
327     int         tos;		/* pointer to top of stack */
328     char        procname[100];	/* The name of the current procedure */
329     int         just_saw_decl;
330 }           ps;
331 
332 int         ifdef_level;
333 int	    rparen_count;
334 struct parser_state state_stack[5];
335 struct parser_state match_state[5];
336