xref: /openbsd/usr.bin/indent/indent_globs.h (revision d9a51c35)
1 /*	$OpenBSD: indent_globs.h,v 1.16 2022/12/26 19:16:01 jmc Exp $ */
2 /*
3  * Copyright (c) 1985 Sun Microsystems, Inc.
4  * Copyright (c) 1980, 1993
5  *	The Regents of the University of California.
6  * Copyright (c) 1976 Board of Trustees of the University of Illinois.
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. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	from: @(#)indent_globs.h	8.1 (Berkeley) 6/6/93
34  */
35 
36 #define BACKSLASH '\\'
37 #define bufsize 200		/* size of internal buffers */
38 #define sc_size 5000		/* size of save_com buffer */
39 #define label_offset 2		/* number of levels a label is placed to left
40 				 * of code */
41 
42 #define tabsize 8		/* the size of a tab */
43 #define tabmask 0177770		/* mask used when figuring length of lines
44 				 * with tabs */
45 
46 
47 #define false 0
48 #define true  1
49 
50 
51 extern FILE *input;		/* the fid for the input file */
52 extern FILE *output;		/* the output file */
53 
54 #define CHECK_SIZE_CODE \
55 	if (e_code >= l_code) { \
56 	    int nsize = l_code-s_code+400; \
57 	\
58 	    codebuf = realloc(codebuf, nsize); \
59 	    if (codebuf == NULL) \
60 		    err(1, NULL); \
61 	    e_code = codebuf + (e_code-s_code) + 1; \
62 	    l_code = codebuf + nsize - 5; \
63 	    s_code = codebuf + 1; \
64 	}
65 #define CHECK_SIZE_COM \
66 	if (e_com >= l_com) { \
67 	    int nsize = l_com-s_com+400; \
68 	\
69 	    combuf = realloc(combuf, nsize); \
70 	    if (combuf == NULL) \
71 		    err(1, NULL); \
72 	    e_com = combuf + (e_com-s_com) + 1; \
73 	    l_com = combuf + nsize - 5; \
74 	    s_com = combuf + 1; \
75 	}
76 #define CHECK_SIZE_LAB \
77 	if (e_lab >= l_lab) { \
78 	    int nsize = l_lab-s_lab+400; \
79 	\
80 	    labbuf = realloc(labbuf, nsize); \
81 	    if (labbuf == NULL) \
82 		    err(1, NULL); \
83 	    e_lab = labbuf + (e_lab-s_lab) + 1; \
84 	    l_lab = labbuf + nsize - 5; \
85 	    s_lab = labbuf + 1; \
86 	}
87 #define CHECK_SIZE_TOKEN \
88 	if (e_token >= l_token) { \
89 	    int nsize = l_token-s_token+400; \
90 	\
91 	    tokenbuf = realloc(tokenbuf, nsize); \
92 	    if (tokenbuf == NULL) \
93 		    err(1, NULL); \
94 	    e_token = tokenbuf + (e_token-s_token) + 1; \
95 	    l_token = tokenbuf + nsize - 5; \
96 	    s_token = tokenbuf + 1; \
97 	}
98 
99 extern char *labbuf;		/* buffer for label */
100 extern char *s_lab;		/* start ... */
101 extern char *e_lab;		/* .. and end of stored label */
102 extern char *l_lab;		/* limit of label buffer */
103 
104 extern char *codebuf;		/* buffer for code section */
105 extern char *s_code;		/* start ... */
106 extern char *e_code;		/* .. and end of stored code */
107 extern char *l_code;		/* limit of code section */
108 
109 extern char *combuf;		/* buffer for comments */
110 extern char *s_com;		/* start ... */
111 extern char *e_com;		/* ... and end of stored comments */
112 extern char *l_com;		/* limit of comment buffer */
113 
114 #define token s_token
115 extern char *tokenbuf;		/* the last token scanned */
116 extern char *s_token;
117 extern char *e_token;
118 extern char *l_token;
119 
120 extern char *in_buffer;		/* input buffer */
121 extern char *in_buffer_limit;	/* the end of the input buffer */
122 extern char *buf_ptr;		/* ptr to next character to be taken from
123 				 * in_buffer */
124 extern char *buf_end;		/* ptr to first after last char in in_buffer */
125 
126 extern char  save_com[sc_size];	/* input text is saved here when looking for
127 				 * the brace after an if, while, etc */
128 extern char  *sc_end;		/* pointer into save_com buffer */
129 
130 extern char  *bp_save;		/* saved value of buf_ptr when taking input
131 				 * from save_com */
132 extern char  *be_save;		/* similarly saved value of buf_end */
133 
134 
135 extern int  pointer_as_binop;
136 extern int  blanklines_after_declarations;
137 extern int  blanklines_before_blockcomments;
138 extern int  blanklines_after_procs;
139 extern int  blanklines_around_conditional_compilation;
140 extern int  swallow_optional_blanklines;
141 extern int  n_real_blanklines;
142 extern int  prefix_blankline_requested;
143 extern int  postfix_blankline_requested;
144 extern int  break_comma;	/* when true and not in parens, break after a
145 				 * comma */
146 extern int  btype_2;		/* when true, brace should be on same line as
147 				 * if, while, etc */
148 extern float case_ind;		/* indentation level to be used for a "case
149 				 * n:" */
150 extern int code_lines;		/* count of lines with code */
151 extern int had_eof;		/* set to true when input is exhausted */
152 extern int line_no;		/* the current line number. */
153 extern int max_col;		/* the maximum allowable line length */
154 extern int verbose;		/* when true, non-essential error messages are
155 				 * printed */
156 extern int cuddle_else;	/* true if else should cuddle up to '}' */
157 extern int star_comment_cont;	/* true iff comment continuation lines should
158 				 * have stars at the beginning of each line. */
159 extern int  comment_delimiter_on_blankline;
160 extern int  troff;		/* true iff were generating troff input */
161 extern int  procnames_start_line;	/* if true, the names of procedures
162 					 * being defined get placed in column
163 					 * 1 (ie. a newline is placed between
164 					 * the type of the procedure and its
165 					 * name) */
166 extern int proc_calls_space;	/* If true, procedure calls look like:
167 				 * foo(bar) rather than foo (bar) */
168 extern int  format_col1_comments;	/* If comments which start in column 1
169 					 * are to be magically reformatted
170 					 * (just like comments that begin in
171 					 * later columns) */
172 extern int inhibit_formatting;	/* true if INDENT OFF is in effect */
173 extern int suppress_blanklines;/* set iff following blanklines should be
174 				 * suppressed */
175 extern int continuation_indent;/* set to the indentation between the edge of
176 				 * code and continuation lines */
177 extern int lineup_to_parens;	/* if true, continued code within parens will
178 				 * be lined up to the open paren */
179 extern int Bill_Shannon;	/* true iff a blank should always be inserted
180 				 * after sizeof */
181 extern int blanklines_after_declarations_at_proctop;	/* This is vaguely
182 							 * similar to
183 							 * blanklines_after_decla
184 							 * rations except that
185 							 * it only applies to
186 							 * the first set of
187 							 * declarations in a
188 							 * procedure (just after
189 							 * the first '{') and it
190 							 * causes a blank line
191 							 * to be generated even
192 							 * if there are no
193 							 * declarations */
194 extern int  block_comment_max_col;
195 extern int  extra_expression_indent;	/* True if continuation lines from the
196 					 * expression part of "if(e)",
197 					 * "while(e)", "for(e;e;e)" should be
198 					 * indented an extra tab stop so that
199 					 * they don't conflict with the code
200 					 * that follows */
201 extern int  use_tabs;			/* set true to use tabs for spacing,
202 					 * false uses all spaces */
203 
204 /* -troff font state information */
205 
206 struct fstate {
207     char        font[4];
208     char        size;
209     int         allcaps:1;
210 };
211 
212 extern struct fstate
213             keywordf,		/* keyword font */
214             stringf,		/* string font */
215             boxcomf,		/* Box comment font */
216             blkcomf,		/* Block comment font */
217             scomf,		/* Same line comment font */
218             bodyf;		/* major body font */
219 
220 
221 #define STACKSIZE 150
222 
223 extern struct parser_state {
224     int         last_token;
225     struct fstate cfont;	/* Current font */
226     int         p_stack[STACKSIZE];	/* this is the parsers stack */
227     int         il[STACKSIZE];	/* this stack stores indentation levels */
228     float       cstk[STACKSIZE];/* used to store case stmt indentation levels */
229     int         box_com;	/* set to true when we are in a "boxed"
230 				 * comment. In that case, the first non-blank
231 				 * char should be lined up with the / in rem */
232     int         comment_delta,
233                 n_comment_delta;
234     int         cast_mask;	/* indicates which close parens close off
235 				 * casts */
236     int         sizeof_mask;	/* indicates which close parens close off
237 				 * sizeof''s */
238     int         block_init;	/* true iff inside a block initialization */
239     int         block_init_level;	/* The level of brace nesting in an
240 					 * initialization */
241     int         last_nl;	/* this is true if the last thing scanned was
242 				 * a newline */
243     int         in_or_st;	/* Will be true iff there has been a
244 				 * declarator (e.g. int or char) and no left
245 				 * paren since the last semicolon. When true,
246 				 * a '{' is starting a structure definition or
247 				 * an initialization list */
248     int         bl_line;	/* set to 1 by dump_line if the line is blank */
249     int         col_1;		/* set to true if the last token started in
250 				 * column 1 */
251     int         com_col;	/* this is the column in which the current
252 				 * comment should start */
253     int         com_ind;	/* the column in which comments to the right
254 				 * of code should start */
255     int         com_lines;	/* the number of lines with comments, set by
256 				 * dump_line */
257     int         dec_nest;	/* current nesting level for structure or init */
258     int         decl_com_ind;	/* the column in which comments after
259 				 * declarations should be put */
260     int         decl_on_line;	/* set to true if this line of code has part
261 				 * of a declaration on it */
262     int         i_l_follow;	/* the level to which ind_level should be set
263 				 * after the current line is printed */
264     int         in_decl;	/* set to true when we are in a declaration
265 				 * stmt.  The processing of braces is then
266 				 * slightly different */
267     int         in_stmt;	/* set to 1 while in a stmt */
268     int         ind_level;	/* the current indentation level */
269     int         ind_size;	/* the size of one indentation level */
270     int         ind_stmt;	/* set to 1 if next line should have an extra
271 				 * indentation level because we are in the
272 				 * middle of a stmt */
273     int         last_u_d;	/* set to true after scanning a token which
274 				 * forces a following operator to be unary */
275     int         leave_comma;	/* if true, never break declarations after
276 				 * commas */
277     int         ljust_decl;	/* true if declarations should be left
278 				 * justified */
279     int         out_coms;	/* the number of comments processed, set by
280 				 * pr_comment */
281     int         out_lines;	/* the number of lines written, set by
282 				 * dump_line */
283     int         p_l_follow;	/* used to remember how to indent following
284 				 * statement */
285     int         paren_level;	/* parenthesization level. used to indent
286 				 * within stmts */
287     short       paren_indents[20];	/* column positions of each paren */
288     int         pcase;		/* set to 1 if the current line label is a
289 				 * case.  It is printed differently from a
290 				 * regular label */
291     int         search_brace;	/* set to true by parse when it is necessary
292 				 * to buffer up all info up to the start of a
293 				 * stmt after an if, while, etc */
294     int         unindent_displace;	/* comments not to the right of code
295 					 * will be placed this many
296 					 * indentation levels to the left of
297 					 * code */
298     int         use_ff;		/* set to one if the current line should be
299 				 * terminated with a form feed */
300     int         want_blank;	/* set to true when the following token should
301 				 * be prefixed by a blank. (Said prefixing is
302 				 * ignored in some cases.) */
303     int         else_if;	/* True iff else if pairs should be handled
304 				 * specially */
305     int         decl_indent;	/* column to indent declared identifiers to */
306     int         its_a_keyword;
307     int         sizeof_keyword;
308     int         dumped_decl_indent;
309     float       case_indent;	/* The distance to indent case labels from the
310 				 * switch statement */
311     int         in_parameter_declaration;
312     int         indent_parameters;
313     int         tos;		/* pointer to top of stack */
314     char        procname[100];	/* The name of the current procedure */
315     int         just_saw_decl;
316 }           ps;
317 
318 extern int ifdef_level;
319 extern int rparen_count;
320 extern struct parser_state state_stack[5];
321 extern struct parser_state match_state[5];
322 
323 int compute_code_target(void);
324 int compute_label_target(void);
325 int count_spaces(int, char *);
326 void diag(int, const char *, ...) __attribute__((__format__ (printf, 2, 3)));
327 void dump_line(void);
328 int eqin(char *, char *);
329 void fill_buffer(void);
330 int pad_output(int, int);
331 void scan_profile(FILE *);
332 void set_defaults(void);
333 void set_option(char *);
334 void addkey(char *, int);
335 void set_profile(void);
336 char   *chfont(struct fstate *, struct fstate *, char *);
337 void parsefont(struct fstate *, char *);
338 void writefdef(struct fstate *, int);
339 int lexi(void);
340 void reduce(void);
341 void parse(int);
342 void pr_comment(void);
343 void bakcopy(void);
344