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
38 static char sccsid[] = "@(#)pr_comment.c 8.1 (Berkeley) 6/6/93";
42 #include <sys/cdefs.h>
43 __FBSDID("$FreeBSD$");
48 #include "indent_globs.h"
55 * This routine takes care of scanning and printing comments.
58 * 1) Decide where the comment should be aligned, and if lines should
60 * 2) If lines should not be broken and filled, just copy up to end of
62 * 3) If lines should be filled, then scan thru input_buffer copying
63 * characters to com_buf. Remember where the last blank, tab, or
64 * newline was. When line is filled, print up to last blank and
68 * November 1976 D A Willcox of CAC Initial coding
69 * 12/6/76 D A Willcox of CAC Modification to handle
75 * this routine processes comments. It makes an attempt to keep comments from
76 * going over the max line length. If a line is too long, it moves everything
77 * from the last blank to the next comment line. Blanks and tabs from the
78 * beginning of the input line are removed
84 int now_col; /* column we are in now */
85 int adj_max_col; /* Adjusted max_col for when we decide to
86 * spill comments over the right margin */
87 char *last_bl; /* points to the last blank in the output
89 char *t_ptr; /* used for moving string */
90 int unix_comment; /* tri-state variable used to decide if it is
91 * a unix-style comment. 0 means only blanks
92 * since /+*, 1 means regular style comment, 2
93 * means unix style comment */
94 int break_delim = comment_delimiter_on_blankline;
95 int l_just_saw_decl = ps.just_saw_decl;
97 * int ps.last_nl = 0; true iff the last significant thing
98 * weve seen is a newline
100 int one_liner = 1; /* true iff this comment is a one-liner */
101 adj_max_col = max_col;
102 ps.just_saw_decl = 0;
103 last_bl = 0; /* no blanks found so far */
104 ps.box_com = false; /* at first, assume that we are not in
105 * a boxed comment or some other
106 * comment that should not be touched */
107 ++ps.out_coms; /* keep track of number of comments */
108 unix_comment = 1; /* set flag to let us figure out if there is a
109 * unix-style comment ** DISABLED: use 0 to
110 * reenable this hack! */
112 /* Figure where to align and how to treat the comment */
114 if (ps.col_1 && !format_col1_comments) { /* if comment starts in column
115 * 1 it should not be touched */
120 if (*buf_ptr == '-' || *buf_ptr == '*' ||
121 (*buf_ptr == '\n' && !format_block_comments)) {
122 ps.box_com = true; /* A comment with a '-' or '*' immediately
123 * after the /+* is assumed to be a boxed
124 * comment. A comment with a newline
125 * immediately after the /+* is assumed to
126 * be a block comment and is treated as a
127 * box comment unless format_block_comments
128 * is nonzero (the default). */
131 if ( /* ps.bl_line && */ (s_lab == e_lab) && (s_code == e_code)) {
132 /* klg: check only if this line is blank */
134 * If this (*and previous lines are*) blank, dont put comment way
137 ps.com_col = (ps.ind_level - ps.unindent_displace) * ps.ind_size + 1;
138 adj_max_col = block_comment_max_col;
140 ps.com_col = 1 + !format_col1_comments;
145 if (s_code != e_code)
146 target_col = count_spaces(compute_code_target(), s_code);
150 target_col = count_spaces(compute_label_target(), s_lab);
152 ps.com_col = ps.decl_on_line || ps.ind_level == 0 ? ps.decl_com_ind : ps.com_ind;
153 if (ps.com_col < target_col)
154 ps.com_col = ((target_col + 7) & ~7) + 1;
155 if (ps.com_col + 24 > adj_max_col)
156 adj_max_col = ps.com_col + 24;
161 ps.n_comment_delta = 1 - count_spaces(1, in_buffer);
165 ps.n_comment_delta = 0;
166 while (*buf_ptr == ' ' || *buf_ptr == '\t')
169 ps.comment_delta = 0;
170 *e_com++ = '/'; /* put '/' followed by '*' into buffer */
172 if (*buf_ptr != ' ' && !ps.box_com)
181 now_col = count_spaces(ps.com_col, s_com); /* figure what column we
183 * printed the comment
186 /* Start to copy the comment */
188 while (1) { /* this loop will go until the comment is
190 if (*buf_ptr > 040 && *buf_ptr != '*')
193 switch (*buf_ptr) { /* this checks for various spcl cases */
194 case 014: /* check for a form feed */
195 if (!ps.box_com) { /* in a text comment, break the line here */
197 /* fix so dump_line uses a form feed */
203 while (*++buf_ptr == ' ' || *buf_ptr == '\t');
206 if (++buf_ptr >= buf_end)
213 if (had_eof) { /* check for unexpected eof */
214 printf("Unterminated comment\n");
220 if (ps.box_com || ps.last_nl) { /* if this is a boxed comment,
221 * we dont ignore the newline */
222 if (s_com == e_com) {
227 if (!ps.box_com && e_com - s_com > 3) {
228 if (break_delim == 1 && s_com[0] == '/'
229 && s_com[1] == '*' && s_com[2] == ' ') {
234 if (blanklines_before_blockcomments)
235 prefix_blankline_requested = 1;
238 s_com[0] = s_com[1] = s_com[2] = ' ';
246 now_col = ps.com_col;
250 if (unix_comment != 1) { /* we not are in unix_style
252 if (unix_comment == 0 && s_code == e_code) {
254 * if it is a UNIX-style comment, ignore the
255 * requirement that previous line be blank for
258 ps.com_col = (ps.ind_level - ps.unindent_displace) * ps.ind_size + 1;
262 unix_comment = 2; /* permanently remember that we are in
263 * this type of comment */
266 now_col = ps.com_col;
269 * fix so that the star at the start of the line will line
272 do /* flush leading white space */
273 if (++buf_ptr >= buf_end)
275 while (*buf_ptr == ' ' || *buf_ptr == '\t');
278 if (*(e_com - 1) == ' ' || *(e_com - 1) == '\t')
281 * if there was a space at the end of the last line, remember
284 else { /* otherwise, insert one */
291 ++line_no; /* keep track of input line number */
294 do { /* flush any blanks and/or tabs at start of
296 if (++buf_ptr >= buf_end)
298 if (*buf_ptr == '*' && --nstar >= 0) {
299 if (++buf_ptr >= buf_end)
304 } while (*buf_ptr == ' ' || *buf_ptr == '\t');
306 else if (++buf_ptr >= buf_end)
308 break; /* end of case for newline */
310 case '*': /* must check for possibility of being at end
312 if (++buf_ptr >= buf_end) /* get to next char after * */
315 if (unix_comment == 0) /* set flag to show we are not in
316 * unix-style comment */
319 if (*buf_ptr == '/') { /* it is the end!!! */
321 if (++buf_ptr >= buf_end)
324 if (*(e_com - 1) != ' ' && !ps.box_com) { /* insure blank before
329 if (break_delim == 1 && !one_liner && s_com[0] == '/'
330 && s_com[1] == '*' && s_com[2] == ' ') {
335 if (blanklines_before_blockcomments)
336 prefix_blankline_requested = 1;
339 s_com[0] = s_com[1] = s_com[2] = ' ';
341 if (break_delim == 2 && e_com > s_com + 3
342 /* now_col > adj_max_col - 2 && !ps.box_com */ ) {
345 now_col = ps.com_col;
351 ps.just_saw_decl = l_just_saw_decl;
354 else { /* handle isolated '*' */
359 default: /* we have a random char */
360 if (unix_comment == 0 && *buf_ptr != ' ' && *buf_ptr != '\t')
361 unix_comment = 1; /* we are not in unix-style comment */
364 if (buf_ptr >= buf_end)
367 if (*e_com == '\t') /* keep track of column */
368 now_col = ((now_col - 1) & tabmask) + tabsize + 1;
369 else if (*e_com == '\b') /* this is a backspace */
374 if (*e_com == ' ' || *e_com == '\t')
376 /* remember we saw a blank */
379 if (now_col > adj_max_col && !ps.box_com && unix_comment == 1 && e_com[-1] > ' ') {
381 * the comment is too long, it must be broken up
383 if (break_delim == 1 && s_com[0] == '/'
384 && s_com[1] == '*' && s_com[2] == ' ') {
389 if (blanklines_before_blockcomments)
390 prefix_blankline_requested = 1;
393 s_com[0] = s_com[1] = s_com[2] = ' ';
395 if (last_bl == 0) { /* we have seen no blanks */
396 last_bl = e_com; /* fake it */
399 *e_com = '\0'; /* print what we have */
401 while (last_bl > s_com && last_bl[-1] < 040)
406 *e_com++ = ' '; /* add blanks for continuation */
412 if (t_ptr >= e_com) {
413 while (*t_ptr == ' ' || *t_ptr == '\t')
415 while (*t_ptr != '\0') { /* move unprinted part of
416 * comment down in buffer */
417 if (*t_ptr == ' ' || *t_ptr == '\t')
423 now_col = count_spaces(ps.com_col, s_com); /* recompute current