xref: /freebsd/usr.bin/indent/io.c (revision ea825d02749f382c3f7e17f28247f20a48733eab)
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[] = "@(#)io.c	8.1 (Berkeley) 6/6/93";
39 #endif /* not lint */
40 #endif
41 
42 #include <sys/cdefs.h>
43 __FBSDID("$FreeBSD$");
44 
45 #include <ctype.h>
46 #include <err.h>
47 #include <stdio.h>
48 #include <stdlib.h>
49 #include <string.h>
50 #include "indent_globs.h"
51 #include "indent.h"
52 
53 int         comment_open;
54 static int  paren_target;
55 static int pad_output(int current, int target);
56 
57 void
58 dump_line(void)
59 {				/* dump_line is the routine that actually
60 				 * effects the printing of the new source. It
61 				 * prints the label section, followed by the
62 				 * code section with the appropriate nesting
63 				 * level, followed by any comments */
64     int cur_col,
65                 target_col = 1;
66     static int  not_first_line;
67 
68     if (ps.procname[0]) {
69 	if (troff) {
70 	    if (comment_open) {
71 		comment_open = 0;
72 		fprintf(output, ".*/\n");
73 	    }
74 	    fprintf(output, ".Pr \"%s\"\n", ps.procname);
75 	}
76 	ps.ind_level = 0;
77 	ps.procname[0] = 0;
78     }
79     if (s_code == e_code && s_lab == e_lab && s_com == e_com) {
80 	if (suppress_blanklines > 0)
81 	    suppress_blanklines--;
82 	else {
83 	    ps.bl_line = true;
84 	    n_real_blanklines++;
85 	}
86     }
87     else if (!inhibit_formatting) {
88 	suppress_blanklines = 0;
89 	ps.bl_line = false;
90 	if (prefix_blankline_requested && not_first_line) {
91 	    if (swallow_optional_blanklines) {
92 		if (n_real_blanklines == 1)
93 		    n_real_blanklines = 0;
94 	    }
95 	    else {
96 		if (n_real_blanklines == 0)
97 		    n_real_blanklines = 1;
98 	    }
99 	}
100 	while (--n_real_blanklines >= 0)
101 	    putc('\n', output);
102 	n_real_blanklines = 0;
103 	if (ps.ind_level == 0)
104 	    ps.ind_stmt = 0;	/* this is a class A kludge. dont do
105 				 * additional statement indentation if we are
106 				 * at bracket level 0 */
107 
108 	if (e_lab != s_lab || e_code != s_code)
109 	    ++code_lines;	/* keep count of lines with code */
110 
111 
112 	if (e_lab != s_lab) {	/* print lab, if any */
113 	    if (comment_open) {
114 		comment_open = 0;
115 		fprintf(output, ".*/\n");
116 	    }
117 	    while (e_lab > s_lab && (e_lab[-1] == ' ' || e_lab[-1] == '\t'))
118 		e_lab--;
119 	    *e_lab = '\0';
120 	    cur_col = pad_output(1, compute_label_target());
121 	    if (s_lab[0] == '#' && (strncmp(s_lab, "#else", 5) == 0
122 				    || strncmp(s_lab, "#endif", 6) == 0)) {
123 		char *s = s_lab;
124 		if (e_lab[-1] == '\n') e_lab--;
125 		do putc(*s++, output);
126 		while (s < e_lab && 'a' <= *s && *s<='z');
127 		while ((*s == ' ' || *s == '\t') && s < e_lab)
128 		    s++;
129 		if (s < e_lab)
130 		    fprintf(output, s[0]=='/' && s[1]=='*' ? "\t%.*s" : "\t/* %.*s */",
131 			    (int)(e_lab - s), s);
132 	    }
133 	    else fprintf(output, "%.*s", (int)(e_lab - s_lab), s_lab);
134 	    cur_col = count_spaces(cur_col, s_lab);
135 	}
136 	else
137 	    cur_col = 1;	/* there is no label section */
138 
139 	ps.pcase = false;
140 
141 	if (s_code != e_code) {	/* print code section, if any */
142 	    char *p;
143 
144 	    if (comment_open) {
145 		comment_open = 0;
146 		fprintf(output, ".*/\n");
147 	    }
148 	    target_col = compute_code_target();
149 	    {
150 		int i;
151 
152 		for (i = 0; i < ps.p_l_follow; i++)
153 		    if (ps.paren_indents[i] >= 0)
154 			ps.paren_indents[i] = -(ps.paren_indents[i] + target_col);
155 	    }
156 	    cur_col = pad_output(cur_col, target_col);
157 	    for (p = s_code; p < e_code; p++)
158 		if (*p == (char) 0200)
159 		    fprintf(output, "%d", target_col * 7);
160 		else
161 		    putc(*p, output);
162 	    cur_col = count_spaces(cur_col, s_code);
163 	}
164 	if (s_com != e_com) {
165 	    if (troff) {
166 		int         all_here = 0;
167 		char *p;
168 
169 		if (e_com[-1] == '/' && e_com[-2] == '*')
170 		    e_com -= 2, all_here++;
171 		while (e_com > s_com && e_com[-1] == ' ')
172 		    e_com--;
173 		*e_com = 0;
174 		p = s_com;
175 		while (*p == ' ')
176 		    p++;
177 		if (p[0] == '/' && p[1] == '*')
178 		    p += 2, all_here++;
179 		else if (p[0] == '*')
180 		    p += p[1] == '/' ? 2 : 1;
181 		while (*p == ' ')
182 		    p++;
183 		if (*p == 0)
184 		    goto inhibit_newline;
185 		if (comment_open < 2 && ps.box_com) {
186 		    comment_open = 0;
187 		    fprintf(output, ".*/\n");
188 		}
189 		if (comment_open == 0) {
190 		    if ('a' <= *p && *p <= 'z')
191 			*p = *p + 'A' - 'a';
192 		    if (e_com - p < 50 && all_here == 2) {
193 			char *follow = p;
194 			fprintf(output, "\n.nr C! \\w\1");
195 			while (follow < e_com) {
196 			    switch (*follow) {
197 			    case '\n':
198 				putc(' ', output);
199 			    case 1:
200 				break;
201 			    case '\\':
202 				putc('\\', output);
203 				/* add a backslash to escape the '\' */
204 			    default:
205 				putc(*follow, output);
206 			    }
207 			    follow++;
208 			}
209 			putc(1, output);
210 		    }
211 		    fprintf(output, "\n./* %dp %d %dp\n",
212 			    ps.com_col * 7,
213 			    (s_code != e_code || s_lab != e_lab) - ps.box_com,
214 			    target_col * 7);
215 		}
216 		comment_open = 1 + ps.box_com;
217 		while (*p) {
218 		    if (*p == BACKSLASH)
219 			putc(BACKSLASH, output);
220 		    putc(*p++, output);
221 		}
222 	    }
223 	    else {		/* print comment, if any */
224 		int target = ps.com_col;
225 		char *com_st = s_com;
226 
227 		target += ps.comment_delta;
228 		while (*com_st == '\t')	/* consider original indentation in
229 					 * case this is a box comment */
230 		    com_st++, target += tabsize;
231 		while (target <= 0)
232 		    if (*com_st == ' ')
233 			target++, com_st++;
234 		    else if (*com_st == '\t')
235 			target = tabsize * (1 + (target - 1) / tabsize) + 1, com_st++;
236 		    else
237 			target = 1;
238 		if (cur_col > target) {	/* if comment can't fit on this line,
239 					 * put it on next line */
240 		    putc('\n', output);
241 		    cur_col = 1;
242 		    ++ps.out_lines;
243 		}
244 		while (e_com > com_st && isspace(e_com[-1]))
245 		    e_com--;
246 		(void)pad_output(cur_col, target);
247 		fwrite(com_st, e_com - com_st, 1, output);
248 		ps.comment_delta = ps.n_comment_delta;
249 		++ps.com_lines;	/* count lines with comments */
250 	    }
251 	}
252 	if (ps.use_ff)
253 	    putc('\014', output);
254 	else
255 	    putc('\n', output);
256 inhibit_newline:
257 	++ps.out_lines;
258 	if (ps.just_saw_decl == 1 && blanklines_after_declarations) {
259 	    prefix_blankline_requested = 1;
260 	    ps.just_saw_decl = 0;
261 	}
262 	else
263 	    prefix_blankline_requested = postfix_blankline_requested;
264 	postfix_blankline_requested = 0;
265     }
266     ps.decl_on_line = ps.in_decl;	/* if we are in the middle of a
267 					 * declaration, remember that fact for
268 					 * proper comment indentation */
269     ps.ind_stmt = ps.in_stmt & ~ps.in_decl;	/* next line should be
270 						 * indented if we have not
271 						 * completed this stmt and if
272 						 * we are not in the middle of
273 						 * a declaration */
274     ps.use_ff = false;
275     ps.dumped_decl_indent = 0;
276     *(e_lab = s_lab) = '\0';	/* reset buffers */
277     *(e_code = s_code) = '\0';
278     *(e_com = s_com = combuf + 1) = '\0';
279     ps.ind_level = ps.i_l_follow;
280     ps.paren_level = ps.p_l_follow;
281     if (ps.paren_level > 0)
282 	paren_target = -ps.paren_indents[ps.paren_level - 1];
283     not_first_line = 1;
284 }
285 
286 int
287 compute_code_target(void)
288 {
289     int target_col = ps.ind_size * ps.ind_level + 1;
290 
291     if (ps.paren_level)
292 	if (!lineup_to_parens)
293 	    target_col += continuation_indent
294 		* (2 * continuation_indent == ps.ind_size ? 1 : ps.paren_level);
295 	else {
296 	    int w;
297 	    int t = paren_target;
298 
299 	    if ((w = count_spaces(t, s_code) - max_col) > 0
300 		    && count_spaces(target_col, s_code) <= max_col) {
301 		t -= w + 1;
302 		if (t > target_col)
303 		    target_col = t;
304 	    }
305 	    else
306 		target_col = t;
307 	}
308     else if (ps.ind_stmt)
309 	target_col += continuation_indent;
310     return target_col;
311 }
312 
313 int
314 compute_label_target(void)
315 {
316     return
317 	ps.pcase ? (int) (case_ind * ps.ind_size) + 1
318 	: *s_lab == '#' ? 1
319 	: ps.ind_size * (ps.ind_level - label_offset) + 1;
320 }
321 
322 
323 /*
324  * Copyright (C) 1976 by the Board of Trustees of the University of Illinois
325  *
326  * All rights reserved
327  *
328  *
329  * NAME: fill_buffer
330  *
331  * FUNCTION: Reads one block of input into input_buffer
332  *
333  * HISTORY: initial coding 	November 1976	D A Willcox of CAC 1/7/77 A
334  * Willcox of CAC	Added check for switch back to partly full input
335  * buffer from temporary buffer
336  *
337  */
338 void
339 fill_buffer(void)
340 {				/* this routine reads stuff from the input */
341     char *p;
342     int i;
343     FILE *f = input;
344 
345     if (bp_save != NULL) {	/* there is a partly filled input buffer left */
346 	buf_ptr = bp_save;	/* do not read anything, just switch buffers */
347 	buf_end = be_save;
348 	bp_save = be_save = NULL;
349 	if (buf_ptr < buf_end)
350 	    return;		/* only return if there is really something in
351 				 * this buffer */
352     }
353     for (p = in_buffer;;) {
354 	if (p >= in_buffer_limit) {
355 	    int size = (in_buffer_limit - in_buffer) * 2 + 10;
356 	    int offset = p - in_buffer;
357 	    in_buffer = realloc(in_buffer, size);
358 	    if (in_buffer == NULL)
359 		errx(1, "input line too long");
360 	    p = in_buffer + offset;
361 	    in_buffer_limit = in_buffer + size - 2;
362 	}
363 	if ((i = getc(f)) == EOF) {
364 		*p++ = ' ';
365 		*p++ = '\n';
366 		had_eof = true;
367 		break;
368 	}
369 	*p++ = i;
370 	if (i == '\n')
371 		break;
372     }
373     buf_ptr = in_buffer;
374     buf_end = p;
375     if (p - in_buffer > 2 && p[-2] == '/' && p[-3] == '*') {
376 	if (in_buffer[3] == 'I' && strncmp(in_buffer, "/**INDENT**", 11) == 0)
377 	    fill_buffer();	/* flush indent error message */
378 	else {
379 	    int         com = 0;
380 
381 	    p = in_buffer;
382 	    while (*p == ' ' || *p == '\t')
383 		p++;
384 	    if (*p == '/' && p[1] == '*') {
385 		p += 2;
386 		while (*p == ' ' || *p == '\t')
387 		    p++;
388 		if (p[0] == 'I' && p[1] == 'N' && p[2] == 'D' && p[3] == 'E'
389 			&& p[4] == 'N' && p[5] == 'T') {
390 		    p += 6;
391 		    while (*p == ' ' || *p == '\t')
392 			p++;
393 		    if (*p == '*')
394 			com = 1;
395 		    else if (*p == 'O') {
396 			if (*++p == 'N')
397 			    p++, com = 1;
398 			else if (*p == 'F' && *++p == 'F')
399 			    p++, com = 2;
400 		    }
401 		    while (*p == ' ' || *p == '\t')
402 			p++;
403 		    if (p[0] == '*' && p[1] == '/' && p[2] == '\n' && com) {
404 			if (s_com != e_com || s_lab != e_lab || s_code != e_code)
405 			    dump_line();
406 			if (!(inhibit_formatting = com - 1)) {
407 			    n_real_blanklines = 0;
408 			    postfix_blankline_requested = 0;
409 			    prefix_blankline_requested = 0;
410 			    suppress_blanklines = 1;
411 			}
412 		    }
413 		}
414 	    }
415 	}
416     }
417     if (inhibit_formatting) {
418 	p = in_buffer;
419 	do
420 	    putc(*p, output);
421 	while (*p++ != '\n');
422     }
423 }
424 
425 /*
426  * Copyright (C) 1976 by the Board of Trustees of the University of Illinois
427  *
428  * All rights reserved
429  *
430  *
431  * NAME: pad_output
432  *
433  * FUNCTION: Writes tabs and spaces to move the current column up to the desired
434  * position.
435  *
436  * ALGORITHM: Put tabs and/or blanks into pobuf, then write pobuf.
437  *
438  * PARAMETERS: current		integer		The current column target
439  * nteger		The desired column
440  *
441  * RETURNS: Integer value of the new column.  (If current >= target, no action is
442  * taken, and current is returned.
443  *
444  * GLOBALS: None
445  *
446  * CALLS: write (sys)
447  *
448  * CALLED BY: dump_line
449  *
450  * HISTORY: initial coding 	November 1976	D A Willcox of CAC
451  *
452  */
453 static int
454 pad_output(int current, int target)
455 			        /* writes tabs and blanks (if necessary) to
456 				 * get the current output position up to the
457 				 * target column */
458     /* current: the current column value */
459     /* target: position we want it at */
460 {
461 
462     if (troff)
463 	fprintf(output, "\\h'|%dp'", (target - 1) * 7);
464     else {
465 	int curr;		/* internal column pointer */
466 
467 	if (current >= target)
468 	    return (current);	/* line is already long enough */
469 	curr = current;
470         if (use_tabs) {
471 	    int tcur;
472 
473 	    while ((tcur = tabsize * (1 + (curr - 1) / tabsize) + 1) <= target) {
474                 putc('\t', output);
475                 curr = tcur;
476             }
477         }
478         while (curr++ < target)
479 	    putc(' ', output);	/* pad with final blanks */
480     }
481     return (target);
482 }
483 
484 /*
485  * Copyright (C) 1976 by the Board of Trustees of the University of Illinois
486  *
487  * All rights reserved
488  *
489  *
490  * NAME: count_spaces
491  *
492  * FUNCTION: Find out where printing of a given string will leave the current
493  * character position on output.
494  *
495  * ALGORITHM: Run thru input string and add appropriate values to current
496  * position.
497  *
498  * RETURNS: Integer value of position after printing "buffer" starting in column
499  * "current".
500  *
501  * HISTORY: initial coding 	November 1976	D A Willcox of CAC
502  *
503  */
504 int
505 count_spaces_until(int cur, char *buffer, char *end)
506 /*
507  * this routine figures out where the character position will be after
508  * printing the text in buffer starting at column "current"
509  */
510 {
511     char *buf;		/* used to look thru buffer */
512 
513     for (buf = buffer; *buf != '\0' && buf != end; ++buf) {
514 	switch (*buf) {
515 
516 	case '\n':
517 	case 014:		/* form feed */
518 	    cur = 1;
519 	    break;
520 
521 	case '\t':
522 	    cur = tabsize * (1 + (cur - 1) / tabsize) + 1;
523 	    break;
524 
525 	case 010:		/* backspace */
526 	    --cur;
527 	    break;
528 
529 	default:
530 	    ++cur;
531 	    break;
532 	}			/* end of switch */
533     }				/* end of for loop */
534     return (cur);
535 }
536 
537 int
538 count_spaces(int cur, char *buffer)
539 {
540     return (count_spaces_until(cur, buffer, NULL));
541 }
542 
543 void
544 diag4(int level, const char *msg, int a, int b)
545 {
546     if (level)
547 	found_err = 1;
548     if (output == stdout) {
549 	fprintf(stdout, "/**INDENT** %s@%d: ", level == 0 ? "Warning" : "Error", line_no);
550 	fprintf(stdout, msg, a, b);
551 	fprintf(stdout, " */\n");
552     }
553     else {
554 	fprintf(stderr, "%s@%d: ", level == 0 ? "Warning" : "Error", line_no);
555 	fprintf(stderr, msg, a, b);
556 	fprintf(stderr, "\n");
557     }
558 }
559 
560 void
561 diag3(int level, const char *msg, int a)
562 {
563     if (level)
564 	found_err = 1;
565     if (output == stdout) {
566 	fprintf(stdout, "/**INDENT** %s@%d: ", level == 0 ? "Warning" : "Error", line_no);
567 	fprintf(stdout, msg, a);
568 	fprintf(stdout, " */\n");
569     }
570     else {
571 	fprintf(stderr, "%s@%d: ", level == 0 ? "Warning" : "Error", line_no);
572 	fprintf(stderr, msg, a);
573 	fprintf(stderr, "\n");
574     }
575 }
576 
577 void
578 diag2(int level, const char *msg)
579 {
580     if (level)
581 	found_err = 1;
582     if (output == stdout) {
583 	fprintf(stdout, "/**INDENT** %s@%d: ", level == 0 ? "Warning" : "Error", line_no);
584 	fprintf(stdout, "%s", msg);
585 	fprintf(stdout, " */\n");
586     }
587     else {
588 	fprintf(stderr, "%s@%d: ", level == 0 ? "Warning" : "Error", line_no);
589 	fprintf(stderr, "%s", msg);
590 	fprintf(stderr, "\n");
591     }
592 }
593 
594 void
595 writefdef(struct fstate *f, int nm)
596 {
597     fprintf(output, ".ds f%c %s\n.nr s%c %d\n",
598 	    nm, f->font, nm, f->size);
599 }
600 
601 char *
602 chfont(struct fstate *of, struct fstate *nf, char *s)
603 {
604     if (of->font[0] != nf->font[0]
605 	    || of->font[1] != nf->font[1]) {
606 	*s++ = '\\';
607 	*s++ = 'f';
608 	if (nf->font[1]) {
609 	    *s++ = '(';
610 	    *s++ = nf->font[0];
611 	    *s++ = nf->font[1];
612 	}
613 	else
614 	    *s++ = nf->font[0];
615     }
616     if (nf->size != of->size) {
617 	*s++ = '\\';
618 	*s++ = 's';
619 	if (nf->size < of->size) {
620 	    *s++ = '-';
621 	    *s++ = '0' + of->size - nf->size;
622 	}
623 	else {
624 	    *s++ = '+';
625 	    *s++ = '0' + nf->size - of->size;
626 	}
627     }
628     return s;
629 }
630 
631 void
632 parsefont(struct fstate *f, const char *s0)
633 {
634     const char *s = s0;
635     int         sizedelta = 0;
636 
637     memset(f, '\0', sizeof(*f));
638     while (*s) {
639 	if (isdigit(*s))
640 	    f->size = f->size * 10 + *s - '0';
641 	else if (isupper(*s))
642 	    if (f->font[0])
643 		f->font[1] = *s;
644 	    else
645 		f->font[0] = *s;
646 	else if (*s == 'c')
647 	    f->allcaps = 1;
648 	else if (*s == '+')
649 	    sizedelta++;
650 	else if (*s == '-')
651 	    sizedelta--;
652 	else {
653 	    errx(1, "bad font specification: %s", s0);
654 	}
655 	s++;
656     }
657     if (f->font[0] == 0)
658 	f->font[0] = 'R';
659     if (bodyf.size == 0)
660 	bodyf.size = 11;
661     if (f->size == 0)
662 	f->size = bodyf.size + sizedelta;
663     else if (sizedelta > 0)
664 	f->size += bodyf.size;
665     else
666 	f->size = bodyf.size - f->size;
667 }
668