]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.bin/indent/io.c
indent(1): add some comments to quiet down Coverity.
[FreeBSD/FreeBSD.git] / usr.bin / indent / io.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[] = "@(#)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')
229                     com_st++, target += 8;      /* ? */
230                 while (target <= 0)
231                     if (*com_st == ' ')
232                         target++, com_st++;
233                     else if (*com_st == '\t')
234                         target = ((target - 1) & ~7) + 9, com_st++;
235                     else
236                         target = 1;
237                 if (cur_col > target) { /* if comment can't fit on this line,
238                                          * put it on next line */
239                     putc('\n', output);
240                     cur_col = 1;
241                     ++ps.out_lines;
242                 }
243                 while (e_com > com_st && isspace(e_com[-1]))
244                     e_com--;
245                 cur_col = pad_output(cur_col, target);
246                 fwrite(com_st, e_com - com_st, 1, output);
247                 ps.comment_delta = ps.n_comment_delta;
248                 ++ps.com_lines; /* count lines with comments */
249             }
250         }
251         if (ps.use_ff)
252             putc('\014', output);
253         else
254             putc('\n', output);
255 inhibit_newline:
256         ++ps.out_lines;
257         if (ps.just_saw_decl == 1 && blanklines_after_declarations) {
258             prefix_blankline_requested = 1;
259             ps.just_saw_decl = 0;
260         }
261         else
262             prefix_blankline_requested = postfix_blankline_requested;
263         postfix_blankline_requested = 0;
264     }
265     ps.decl_on_line = ps.in_decl;       /* if we are in the middle of a
266                                          * declaration, remember that fact for
267                                          * proper comment indentation */
268     ps.ind_stmt = ps.in_stmt & ~ps.in_decl;     /* next line should be
269                                                  * indented if we have not
270                                                  * completed this stmt and if
271                                                  * we are not in the middle of
272                                                  * a declaration */
273     ps.use_ff = false;
274     ps.dumped_decl_indent = 0;
275     *(e_lab = s_lab) = '\0';    /* reset buffers */
276     *(e_code = s_code) = '\0';
277     *(e_com = s_com = combuf + 1) = '\0';
278     ps.ind_level = ps.i_l_follow;
279     ps.paren_level = ps.p_l_follow;
280     paren_target = -ps.paren_indents[ps.paren_level - 1];
281     not_first_line = 1;
282 }
283
284 int
285 compute_code_target(void)
286 {
287     int target_col = ps.ind_size * ps.ind_level + 1;
288
289     if (ps.paren_level)
290         if (!lineup_to_parens)
291             target_col += continuation_indent
292                 * (2 * continuation_indent == ps.ind_size ? 1 : ps.paren_level);
293         else {
294             int w;
295             int t = paren_target;
296
297             if ((w = count_spaces(t, s_code) - max_col) > 0
298                     && count_spaces(target_col, s_code) <= max_col) {
299                 t -= w + 1;
300                 if (t > target_col)
301                     target_col = t;
302             }
303             else
304                 target_col = t;
305         }
306     else if (ps.ind_stmt)
307         target_col += continuation_indent;
308     return target_col;
309 }
310
311 int
312 compute_label_target(void)
313 {
314     return
315         ps.pcase ? (int) (case_ind * ps.ind_size) + 1
316         : *s_lab == '#' ? 1
317         : ps.ind_size * (ps.ind_level - label_offset) + 1;
318 }
319
320
321 /*
322  * Copyright (C) 1976 by the Board of Trustees of the University of Illinois
323  *
324  * All rights reserved
325  *
326  *
327  * NAME: fill_buffer
328  *
329  * FUNCTION: Reads one block of input into input_buffer
330  *
331  * HISTORY: initial coding      November 1976   D A Willcox of CAC 1/7/77 A
332  * Willcox of CAC       Added check for switch back to partly full input
333  * buffer from temporary buffer
334  *
335  */
336 void
337 fill_buffer(void)
338 {                               /* this routine reads stuff from the input */
339     char *p;
340     int i;
341     FILE *f = input;
342
343     if (bp_save != NULL) {      /* there is a partly filled input buffer left */
344         buf_ptr = bp_save;      /* do not read anything, just switch buffers */
345         buf_end = be_save;
346         bp_save = be_save = NULL;
347         if (buf_ptr < buf_end)
348             return;             /* only return if there is really something in
349                                  * this buffer */
350     }
351     for (p = in_buffer;;) {
352         if (p >= in_buffer_limit) {
353             int size = (in_buffer_limit - in_buffer) * 2 + 10;
354             int offset = p - in_buffer;
355             in_buffer = realloc(in_buffer, size);
356             if (in_buffer == NULL)
357                 errx(1, "input line too long");
358             p = in_buffer + offset;
359             in_buffer_limit = in_buffer + size - 2;
360         }
361         if ((i = getc(f)) == EOF) {
362                 *p++ = ' ';
363                 *p++ = '\n';
364                 had_eof = true;
365                 break;
366         }
367         *p++ = i;
368         if (i == '\n')
369                 break;
370     }
371     buf_ptr = in_buffer;
372     buf_end = p;
373     if (p[-2] == '/' && p[-3] == '*') {
374         if (in_buffer[3] == 'I' && strncmp(in_buffer, "/**INDENT**", 11) == 0)
375             fill_buffer();      /* flush indent error message */
376         else {
377             int         com = 0;
378
379             p = in_buffer;
380             while (*p == ' ' || *p == '\t')
381                 p++;
382             if (*p == '/' && p[1] == '*') {
383                 p += 2;
384                 while (*p == ' ' || *p == '\t')
385                     p++;
386                 if (p[0] == 'I' && p[1] == 'N' && p[2] == 'D' && p[3] == 'E'
387                         && p[4] == 'N' && p[5] == 'T') {
388                     p += 6;
389                     while (*p == ' ' || *p == '\t')
390                         p++;
391                     if (*p == '*')
392                         com = 1;
393                     else if (*p == 'O') {
394                         if (*++p == 'N')
395                             p++, com = 1;
396                         else if (*p == 'F' && *++p == 'F')
397                             p++, com = 2;
398                     }
399                     while (*p == ' ' || *p == '\t')
400                         p++;
401                     if (p[0] == '*' && p[1] == '/' && p[2] == '\n' && com) {
402                         if (s_com != e_com || s_lab != e_lab || s_code != e_code)
403                             dump_line();
404                         if (!(inhibit_formatting = com - 1)) {
405                             n_real_blanklines = 0;
406                             postfix_blankline_requested = 0;
407                             prefix_blankline_requested = 0;
408                             suppress_blanklines = 1;
409                         }
410                     }
411                 }
412             }
413         }
414     }
415     if (inhibit_formatting) {
416         p = in_buffer;
417         do
418             putc(*p, output);
419         while (*p++ != '\n');
420     }
421 }
422
423 /*
424  * Copyright (C) 1976 by the Board of Trustees of the University of Illinois
425  *
426  * All rights reserved
427  *
428  *
429  * NAME: pad_output
430  *
431  * FUNCTION: Writes tabs and spaces to move the current column up to the desired
432  * position.
433  *
434  * ALGORITHM: Put tabs and/or blanks into pobuf, then write pobuf.
435  *
436  * PARAMETERS: current          integer         The current column target
437  * nteger               The desired column
438  *
439  * RETURNS: Integer value of the new column.  (If current >= target, no action is
440  * taken, and current is returned.
441  *
442  * GLOBALS: None
443  *
444  * CALLS: write (sys)
445  *
446  * CALLED BY: dump_line
447  *
448  * HISTORY: initial coding      November 1976   D A Willcox of CAC
449  *
450  */
451 static int
452 pad_output(int current, int target)
453                                 /* writes tabs and blanks (if necessary) to
454                                  * get the current output position up to the
455                                  * target column */
456     /* current: the current column value */
457     /* target: position we want it at */
458 {
459     int curr;           /* internal column pointer */
460     int tcur;
461
462     if (troff)
463         fprintf(output, "\\h'|%dp'", (target - 1) * 7);
464     else {
465         if (current >= target)
466             return (current);   /* line is already long enough */
467         curr = current;
468         if (use_tabs) {
469             while ((tcur = ((curr - 1) & tabmask) + tabsize + 1) <= target) {
470                 putc('\t', output);
471                 curr = tcur;
472             }
473         }
474         while (curr++ < target)
475             putc(' ', output);  /* pad with final blanks */
476     }
477     return (target);
478 }
479
480 /*
481  * Copyright (C) 1976 by the Board of Trustees of the University of Illinois
482  *
483  * All rights reserved
484  *
485  *
486  * NAME: count_spaces
487  *
488  * FUNCTION: Find out where printing of a given string will leave the current
489  * character position on output.
490  *
491  * ALGORITHM: Run thru input string and add appropriate values to current
492  * position.
493  *
494  * RETURNS: Integer value of position after printing "buffer" starting in column
495  * "current".
496  *
497  * HISTORY: initial coding      November 1976   D A Willcox of CAC
498  *
499  */
500 int
501 count_spaces_until(int cur, char *buffer, char *end)
502 /*
503  * this routine figures out where the character position will be after
504  * printing the text in buffer starting at column "current"
505  */
506 {
507     char *buf;          /* used to look thru buffer */
508
509     for (buf = buffer; *buf != '\0' && buf != end; ++buf) {
510         switch (*buf) {
511
512         case '\n':
513         case 014:               /* form feed */
514             cur = 1;
515             break;
516
517         case '\t':
518             cur = ((cur - 1) & tabmask) + tabsize + 1;
519             break;
520
521         case 010:               /* backspace */
522             --cur;
523             break;
524
525         default:
526             ++cur;
527             break;
528         }                       /* end of switch */
529     }                           /* end of for loop */
530     return (cur);
531 }
532
533 int
534 count_spaces(int cur, char *buffer)
535 {
536     return (count_spaces_until(cur, buffer, NULL));
537 }
538
539 void
540 diag4(int level, const char *msg, int a, int b)
541 {
542     if (level)
543         found_err = 1;
544     if (output == stdout) {
545         fprintf(stdout, "/**INDENT** %s@%d: ", level == 0 ? "Warning" : "Error", line_no);
546         fprintf(stdout, msg, a, b);
547         fprintf(stdout, " */\n");
548     }
549     else {
550         fprintf(stderr, "%s@%d: ", level == 0 ? "Warning" : "Error", line_no);
551         fprintf(stderr, msg, a, b);
552         fprintf(stderr, "\n");
553     }
554 }
555
556 void
557 diag3(int level, const char *msg, int a)
558 {
559     if (level)
560         found_err = 1;
561     if (output == stdout) {
562         fprintf(stdout, "/**INDENT** %s@%d: ", level == 0 ? "Warning" : "Error", line_no);
563         fprintf(stdout, msg, a);
564         fprintf(stdout, " */\n");
565     }
566     else {
567         fprintf(stderr, "%s@%d: ", level == 0 ? "Warning" : "Error", line_no);
568         fprintf(stderr, msg, a);
569         fprintf(stderr, "\n");
570     }
571 }
572
573 void
574 diag2(int level, const char *msg)
575 {
576     if (level)
577         found_err = 1;
578     if (output == stdout) {
579         fprintf(stdout, "/**INDENT** %s@%d: ", level == 0 ? "Warning" : "Error", line_no);
580         fprintf(stdout, "%s", msg);
581         fprintf(stdout, " */\n");
582     }
583     else {
584         fprintf(stderr, "%s@%d: ", level == 0 ? "Warning" : "Error", line_no);
585         fprintf(stderr, "%s", msg);
586         fprintf(stderr, "\n");
587     }
588 }
589
590 void
591 writefdef(struct fstate *f, int nm)
592 {
593     fprintf(output, ".ds f%c %s\n.nr s%c %d\n",
594             nm, f->font, nm, f->size);
595 }
596
597 char *
598 chfont(struct fstate *of, struct fstate *nf, char *s)
599 {
600     if (of->font[0] != nf->font[0]
601             || of->font[1] != nf->font[1]) {
602         *s++ = '\\';
603         *s++ = 'f';
604         if (nf->font[1]) {
605             *s++ = '(';
606             *s++ = nf->font[0];
607             *s++ = nf->font[1];
608         }
609         else
610             *s++ = nf->font[0];
611     }
612     if (nf->size != of->size) {
613         *s++ = '\\';
614         *s++ = 's';
615         if (nf->size < of->size) {
616             *s++ = '-';
617             *s++ = '0' + of->size - nf->size;
618         }
619         else {
620             *s++ = '+';
621             *s++ = '0' + nf->size - of->size;
622         }
623     }
624     return s;
625 }
626
627 void
628 parsefont(struct fstate *f, const char *s0)
629 {
630     const char *s = s0;
631     int         sizedelta = 0;
632
633     memset(f, 0, sizeof(struct fstate));
634     while (*s) {
635         if (isdigit(*s))
636             f->size = f->size * 10 + *s - '0';
637         else if (isupper(*s))
638             if (f->font[0])
639                 f->font[1] = *s;
640             else
641                 f->font[0] = *s;
642         else if (*s == 'c')
643             f->allcaps = 1;
644         else if (*s == '+')
645             sizedelta++;
646         else if (*s == '-')
647             sizedelta--;
648         else {
649             errx(1, "bad font specification: %s", s0);
650         }
651         s++;
652     }
653     if (f->font[0] == 0)
654         f->font[0] = 'R';
655     if (bodyf.size == 0)
656         bodyf.size = 11;
657     if (f->size == 0)
658         f->size = bodyf.size + sizedelta;
659     else if (sizedelta > 0)
660         f->size += bodyf.size;
661     else
662         f->size = bodyf.size - f->size;
663 }