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$");
49 #include "indent_globs.h"
56 * This routine takes care of scanning and printing comments.
59 * 1) Decide where the comment should be aligned, and if lines should
61 * 2) If lines should not be broken and filled, just copy up to end of
63 * 3) If lines should be filled, then scan thru input_buffer copying
64 * characters to com_buf. Remember where the last blank, tab, or
65 * newline was. When line is filled, print up to last blank and
69 * November 1976 D A Willcox of CAC Initial coding
70 * 12/6/76 D A Willcox of CAC Modification to handle
76 * this routine processes comments. It makes an attempt to keep comments from
77 * going over the max line length. If a line is too long, it moves everything
78 * from the last blank to the next comment line. Blanks and tabs from the
79 * beginning of the input line are removed
85 int now_col; /* column we are in now */
86 int adj_max_col; /* Adjusted max_col for when we decide to
87 * spill comments over the right margin */
88 char *last_bl; /* points to the last blank in the output
90 char *t_ptr; /* used for moving string */
91 int break_delim = comment_delimiter_on_blankline;
92 int l_just_saw_decl = ps.just_saw_decl;
93 adj_max_col = max_col;
95 last_bl = NULL; /* no blanks found so far */
96 ps.box_com = false; /* at first, assume that we are not in
97 * a boxed comment or some other
98 * comment that should not be touched */
99 ++ps.out_coms; /* keep track of number of comments */
101 /* Figure where to align and how to treat the comment */
103 if (ps.col_1 && !format_col1_comments) { /* if comment starts in column
104 * 1 it should not be touched */
110 if (*buf_ptr == '-' || *buf_ptr == '*' ||
111 (*buf_ptr == '\n' && !format_block_comments)) {
112 ps.box_com = true; /* A comment with a '-' or '*' immediately
113 * after the /+* is assumed to be a boxed
114 * comment. A comment with a newline
115 * immediately after the /+* is assumed to
116 * be a block comment and is treated as a
117 * box comment unless format_block_comments
118 * is nonzero (the default). */
121 if ( /* ps.bl_line && */ (s_lab == e_lab) && (s_code == e_code)) {
122 /* klg: check only if this line is blank */
124 * If this (*and previous lines are*) blank, dont put comment way
127 ps.com_col = (ps.ind_level - ps.unindent_displace) * ps.ind_size + 1;
128 adj_max_col = block_comment_max_col;
130 ps.com_col = 1 + !format_col1_comments;
135 if (s_code != e_code)
136 target_col = count_spaces(compute_code_target(), s_code);
140 target_col = count_spaces(compute_label_target(), s_lab);
142 ps.com_col = ps.decl_on_line || ps.ind_level == 0 ? ps.decl_com_ind : ps.com_ind;
143 if (ps.com_col < target_col)
144 ps.com_col = ((target_col + 7) & ~7) + 1;
145 if (ps.com_col + 24 > adj_max_col)
146 adj_max_col = ps.com_col + 24;
151 * Find out how much indentation there was originally, because that
152 * much will have to be ignored by pad_output() in dump_line(). This
153 * is a box comment, so nothing changes -- not even indentation.
155 * The comment we're about to read usually comes from in_buffer,
156 * unless it has been copied into save_com.
158 char *start = buf_ptr >= save_com && buf_ptr < save_com + sc_size ? bp_save : buf_ptr;
159 ps.n_comment_delta = 1 - count_spaces_until(1, in_buffer, start - 2);
162 ps.n_comment_delta = 0;
163 while (*buf_ptr == ' ' || *buf_ptr == '\t')
166 ps.comment_delta = 0;
167 *e_com++ = '/'; /* put '/' followed by '*' into buffer */
169 if (*buf_ptr != ' ' && !ps.box_com)
173 * Don't put a break delimiter if this is a one-liner that won't wrap.
176 for (t_ptr = buf_ptr; *t_ptr != '\0' && *t_ptr != '\n'; t_ptr++) {
177 if (t_ptr >= buf_end)
179 if (t_ptr[0] == '*' && t_ptr[1] == '/') {
180 if (adj_max_col >= count_spaces_until(ps.com_col, buf_ptr, t_ptr + 2))
190 if (blanklines_before_blockcomments)
191 prefix_blankline_requested = 1;
194 if (!ps.box_com && star_comment_cont)
195 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' ';
201 /* Start to copy the comment */
203 while (1) { /* this loop will go until the comment is
206 switch (*buf_ptr) { /* this checks for various spcl cases */
207 case 014: /* check for a form feed */
208 if (!ps.box_com) { /* in a text comment, break the line here */
210 /* fix so dump_line uses a form feed */
213 if (!ps.box_com && star_comment_cont)
214 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' ';
215 while (*++buf_ptr == ' ' || *buf_ptr == '\t')
219 if (++buf_ptr >= buf_end)
226 if (had_eof) { /* check for unexpected eof */
227 printf("Unterminated comment\n");
232 if (ps.box_com || ps.last_nl) { /* if this is a boxed comment,
233 * we dont ignore the newline */
236 if (!ps.box_com && e_com - s_com > 3) {
238 if (star_comment_cont)
239 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' ';
242 if (!ps.box_com && star_comment_cont)
243 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' ';
247 if (*(e_com - 1) == ' ' || *(e_com - 1) == '\t')
250 * if there was a space at the end of the last line, remember
253 else { /* otherwise, insert one */
259 ++line_no; /* keep track of input line number */
262 do { /* flush any blanks and/or tabs at start of
264 if (++buf_ptr >= buf_end)
266 if (*buf_ptr == '*' && --nstar >= 0) {
267 if (++buf_ptr >= buf_end)
272 } while (*buf_ptr == ' ' || *buf_ptr == '\t');
274 else if (++buf_ptr >= buf_end)
276 break; /* end of case for newline */
278 case '*': /* must check for possibility of being at end
280 if (++buf_ptr >= buf_end) /* get to next char after * */
283 if (*buf_ptr == '/') { /* it is the end!!! */
285 if (++buf_ptr >= buf_end)
289 if (e_com > s_com + 3) {
296 if (e_com[-1] != ' ' && e_com[-1] != '\t' && !ps.box_com)
297 *e_com++ = ' '; /* ensure blank before end */
298 *e_com++ = '*', *e_com++ = '/', *e_com = '\0';
299 ps.just_saw_decl = l_just_saw_decl;
302 else /* handle isolated '*' */
305 default: /* we have a random char */
306 now_col = count_spaces_until(ps.com_col, s_com, e_com);
309 if (buf_ptr >= buf_end)
311 if (*e_com == ' ' || *e_com == '\t')
312 last_bl = e_com; /* remember we saw a blank */
315 } while (!memchr("*\n\r\b\t", *buf_ptr, 6) &&
316 (now_col <= adj_max_col || !last_bl));
318 if (now_col > adj_max_col && !ps.box_com && e_com[-1] > ' ') {
320 * the comment is too long, it must be broken up
322 if (last_bl == NULL) {
324 if (!ps.box_com && star_comment_cont)
325 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' ';
331 if (!ps.box_com && star_comment_cont)
332 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' ';
333 for (t_ptr = last_bl + 1; *t_ptr == ' ' || *t_ptr == '\t';
337 while (*t_ptr != '\0') {
338 if (*t_ptr == ' ' || *t_ptr == '\t')