2 * Copyright (c) 1985 Sun Microsystems, Inc.
3 * Copyright (c) 1980, 1993
4 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
35 * @(#)pr_comment.c 8.1 (Berkeley) 6/6/93
36 * $FreeBSD: src/usr.bin/indent/pr_comment.c,v 1.8 2003/06/15 09:28:17 charnier Exp $
42 #include "indent_globs.h"
49 * This routine takes care of scanning and printing comments.
52 * 1) Decide where the comment should be aligned, and if lines should
54 * 2) If lines should not be broken and filled, just copy up to end of
56 * 3) If lines should be filled, then scan thru input_buffer copying
57 * characters to com_buf. Remember where the last blank, tab, or
58 * newline was. When line is filled, print up to last blank and
62 * November 1976 D A Willcox of CAC Initial coding
63 * 12/6/76 D A Willcox of CAC Modification to handle
69 * this routine processes comments. It makes an attempt to keep comments from
70 * going over the max line length. If a line is too long, it moves everything
71 * from the last blank to the next comment line. Blanks and tabs from the
72 * beginning of the input line are removed
78 int now_col; /* column we are in now */
79 int adj_max_col; /* Adjusted max_col for when we decide to
80 * spill comments over the right margin */
81 char *last_bl; /* points to the last blank in the output
83 char *t_ptr; /* used for moving string */
84 int unix_comment; /* tri-state variable used to decide if it is
85 * a unix-style comment. 0 means only blanks
86 * since /+*, 1 means regular style comment, 2
87 * means unix style comment */
88 int break_delim = comment_delimiter_on_blankline;
89 int l_just_saw_decl = ps.just_saw_decl;
91 * int ps.last_nl = 0; true iff the last significant thing
92 * weve seen is a newline
94 int one_liner = 1; /* true iff this comment is a one-liner */
95 adj_max_col = max_col;
97 last_bl = NULL; /* no blanks found so far */
98 ps.box_com = false; /* at first, assume that we are not in
99 * a boxed comment or some other
100 * comment that should not be touched */
101 ++ps.out_coms; /* keep track of number of comments */
102 unix_comment = 1; /* set flag to let us figure out if there is a
103 * unix-style comment ** DISABLED: use 0 to
104 * reenable this hack! */
106 /* Figure where to align and how to treat the comment */
108 if (ps.col_1 && !format_col1_comments) { /* if comment starts in column
109 * 1 it should not be touched */
114 if (*buf_ptr == '-' || *buf_ptr == '*' ||
115 (*buf_ptr == '\n' && !format_block_comments)) {
116 ps.box_com = true; /* A comment with a '-' or '*' immediately
117 * after the /+* is assumed to be a boxed
118 * comment. A comment with a newline
119 * immediately after the /+* is assumed to
120 * be a block comment and is treated as a
121 * box comment unless format_block_comments
122 * is nonzero (the default). */
125 if ( /* ps.bl_line && */ (s_lab == e_lab) && (s_code == e_code)) {
126 /* klg: check only if this line is blank */
128 * If this (*and previous lines are*) blank, dont put comment way
131 ps.com_col = (ps.ind_level - ps.unindent_displace) * ps.ind_size + 1;
132 adj_max_col = block_comment_max_col;
134 ps.com_col = 1 + !format_col1_comments;
139 if (s_code != e_code)
140 target_col = count_spaces(compute_code_target(), s_code);
144 target_col = count_spaces(compute_label_target(), s_lab);
146 ps.com_col = ps.decl_on_line || ps.ind_level == 0 ? ps.decl_com_ind : ps.com_ind;
147 if (ps.com_col < target_col)
148 ps.com_col = ((target_col + 7) & ~7) + 1;
149 if (ps.com_col + 24 > adj_max_col)
150 adj_max_col = ps.com_col + 24;
155 ps.n_comment_delta = 1 - count_spaces(1, in_buffer);
159 ps.n_comment_delta = 0;
160 while (*buf_ptr == ' ' || *buf_ptr == '\t')
163 ps.comment_delta = 0;
164 *e_com++ = '/'; /* put '/' followed by '*' into buffer */
166 if (*buf_ptr != ' ' && !ps.box_com)
175 now_col = count_spaces(ps.com_col, s_com); /* figure what column we
177 * printed the comment
180 /* Start to copy the comment */
182 while (1) { /* this loop will go until the comment is
184 if (*buf_ptr > 040 && *buf_ptr != '*')
187 switch (*buf_ptr) { /* this checks for various spcl cases */
188 case 014: /* check for a form feed */
189 if (!ps.box_com) { /* in a text comment, break the line here */
191 /* fix so dump_line uses a form feed */
197 while (*++buf_ptr == ' ' || *buf_ptr == '\t');
200 if (++buf_ptr >= buf_end)
207 if (had_eof) { /* check for unexpected eof */
208 printf("Unterminated comment\n");
214 if (ps.box_com || ps.last_nl) { /* if this is a boxed comment,
215 * we dont ignore the newline */
216 if (s_com == e_com) {
221 if (!ps.box_com && e_com - s_com > 3) {
222 if (break_delim == 1 && s_com[0] == '/'
223 && s_com[1] == '*' && s_com[2] == ' ') {
228 if (blanklines_before_blockcomments)
229 prefix_blankline_requested = 1;
232 s_com[0] = s_com[1] = s_com[2] = ' ';
240 now_col = ps.com_col;
244 if (unix_comment != 1) { /* we not are in unix_style
246 if (unix_comment == 0 && s_code == e_code) {
248 * if it is a UNIX-style comment, ignore the
249 * requirement that previous line be blank for
252 ps.com_col = (ps.ind_level - ps.unindent_displace) * ps.ind_size + 1;
256 unix_comment = 2; /* permanently remember that we are in
257 * this type of comment */
260 now_col = ps.com_col;
263 * fix so that the star at the start of the line will line
266 do /* flush leading white space */
267 if (++buf_ptr >= buf_end)
269 while (*buf_ptr == ' ' || *buf_ptr == '\t');
272 if (*(e_com - 1) == ' ' || *(e_com - 1) == '\t')
275 * if there was a space at the end of the last line, remember
278 else { /* otherwise, insert one */
285 ++line_no; /* keep track of input line number */
288 do { /* flush any blanks and/or tabs at start of
290 if (++buf_ptr >= buf_end)
292 if (*buf_ptr == '*' && --nstar >= 0) {
293 if (++buf_ptr >= buf_end)
298 } while (*buf_ptr == ' ' || *buf_ptr == '\t');
300 else if (++buf_ptr >= buf_end)
302 break; /* end of case for newline */
304 case '*': /* must check for possibility of being at end
306 if (++buf_ptr >= buf_end) /* get to next char after * */
309 if (unix_comment == 0) /* set flag to show we are not in
310 * unix-style comment */
313 if (*buf_ptr == '/') { /* it is the end!!! */
315 if (++buf_ptr >= buf_end)
318 if (*(e_com - 1) != ' ' && !ps.box_com) { /* insure blank before
323 if (break_delim == 1 && !one_liner && s_com[0] == '/'
324 && s_com[1] == '*' && s_com[2] == ' ') {
329 if (blanklines_before_blockcomments)
330 prefix_blankline_requested = 1;
333 s_com[0] = s_com[1] = s_com[2] = ' ';
335 if (break_delim == 2 && e_com > s_com + 3
336 /* now_col > adj_max_col - 2 && !ps.box_com */ ) {
339 now_col = ps.com_col;
345 ps.just_saw_decl = l_just_saw_decl;
348 else { /* handle isolated '*' */
353 default: /* we have a random char */
354 if (unix_comment == 0 && *buf_ptr != ' ' && *buf_ptr != '\t')
355 unix_comment = 1; /* we are not in unix-style comment */
358 if (buf_ptr >= buf_end)
361 if (*e_com == '\t') /* keep track of column */
362 now_col = ((now_col - 1) & tabmask) + tabsize + 1;
363 else if (*e_com == '\b') /* this is a backspace */
368 if (*e_com == ' ' || *e_com == '\t')
370 /* remember we saw a blank */
373 if (now_col > adj_max_col && !ps.box_com && unix_comment == 1 && e_com[-1] > ' ') {
375 * the comment is too long, it must be broken up
377 if (break_delim == 1 && s_com[0] == '/'
378 && s_com[1] == '*' && s_com[2] == ' ') {
383 if (blanklines_before_blockcomments)
384 prefix_blankline_requested = 1;
387 s_com[0] = s_com[1] = s_com[2] = ' ';
389 if (last_bl == NULL) { /* we have seen no blanks */
390 last_bl = e_com; /* fake it */
393 *e_com = '\0'; /* print what we have */
395 while (last_bl > s_com && last_bl[-1] < 040)
400 *e_com++ = ' '; /* add blanks for continuation */
406 if (t_ptr >= e_com) {
407 while (*t_ptr == ' ' || *t_ptr == '\t')
409 while (*t_ptr != '\0') { /* move unprinted part of
410 * comment down in buffer */
411 if (*t_ptr == ' ' || *t_ptr == '\t')
417 now_col = count_spaces(ps.com_col, s_com); /* recompute current