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