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.1.1.1.14.3 2001/12/06 19:28:47 schweikh Exp $
37 * $DragonFly: src/usr.bin/indent/pr_comment.c,v 1.3 2005/04/10 20:55:38 drhodus Exp $
43 #include "indent_globs.h"
50 * This routine takes care of scanning and printing comments.
53 * 1) Decide where the comment should be aligned, and if lines should
55 * 2) If lines should not be broken and filled, just copy up to end of
57 * 3) If lines should be filled, then scan thru input_buffer copying
58 * characters to com_buf. Remember where the last blank, tab, or
59 * newline was. When line is filled, print up to last blank and
63 * November 1976 D A Willcox of CAC Initial coding
64 * 12/6/76 D A Willcox of CAC Modification to handle
70 * this routine processes comments. It makes an attempt to keep comments from
71 * going over the max line length. If a line is too long, it moves everything
72 * from the last blank to the next comment line. Blanks and tabs from the
73 * beginning of the input line are removed
79 int now_col; /* column we are in now */
80 int adj_max_col; /* Adjusted max_col for when we decide to
81 * spill comments over the right margin */
82 char *last_bl; /* points to the last blank in the output
84 char *t_ptr; /* used for moving string */
85 int unix_comment; /* tri-state variable used to decide if it is
86 * a unix-style comment. 0 means only blanks
87 * since /+*, 1 means regular style comment, 2
88 * means unix style comment */
89 int break_delim = comment_delimiter_on_blankline;
90 int l_just_saw_decl = ps.just_saw_decl;
92 * int ps.last_nl = 0; true iff the last significant thing
93 * weve seen is a newline
95 int one_liner = 1; /* true iff this comment is a one-liner */
96 adj_max_col = max_col;
98 last_bl = 0; /* no blanks found so far */
99 ps.box_com = false; /* at first, assume that we are not in
100 * a boxed comment or some other
101 * comment that should not be touched */
102 ++ps.out_coms; /* keep track of number of comments */
103 unix_comment = 1; /* set flag to let us figure out if there is a
104 * unix-style comment ** DISABLED: use 0 to
105 * reenable this hack! */
107 /* Figure where to align and how to treat the comment */
109 if (ps.col_1 && !format_col1_comments) { /* if comment starts in column
110 * 1 it should not be touched */
115 if (*buf_ptr == '-' || *buf_ptr == '*' ||
116 (*buf_ptr == '\n' && !format_block_comments)) {
117 ps.box_com = true; /* A comment with a '-' or '*' immediately
118 * after the /+* is assumed to be a boxed
119 * comment. A comment with a newline
120 * immediately after the /+* is assumed to
121 * be a block comment and is treated as a
122 * box comment unless format_block_comments
123 * is nonzero (the default). */
126 if ( /* ps.bl_line && */ (s_lab == e_lab) && (s_code == e_code)) {
127 /* klg: check only if this line is blank */
129 * If this (*and previous lines are*) blank, dont put comment way
132 ps.com_col = (ps.ind_level - ps.unindent_displace) * ps.ind_size + 1;
133 adj_max_col = block_comment_max_col;
135 ps.com_col = 1 + !format_col1_comments;
140 if (s_code != e_code)
141 target_col = count_spaces(compute_code_target(), s_code);
145 target_col = count_spaces(compute_label_target(), s_lab);
147 ps.com_col = ps.decl_on_line || ps.ind_level == 0 ? ps.decl_com_ind : ps.com_ind;
148 if (ps.com_col < target_col)
149 ps.com_col = ((target_col + 7) & ~7) + 1;
150 if (ps.com_col + 24 > adj_max_col)
151 adj_max_col = ps.com_col + 24;
156 ps.n_comment_delta = 1 - count_spaces(1, in_buffer);
160 ps.n_comment_delta = 0;
161 while (*buf_ptr == ' ' || *buf_ptr == '\t')
164 ps.comment_delta = 0;
165 *e_com++ = '/'; /* put '/' followed by '*' into buffer */
167 if (*buf_ptr != ' ' && !ps.box_com)
176 now_col = count_spaces(ps.com_col, s_com); /* figure what column we
178 * printed the comment
181 /* Start to copy the comment */
183 while (1) { /* this loop will go until the comment is
185 if (*buf_ptr > 040 && *buf_ptr != '*')
188 switch (*buf_ptr) { /* this checks for various spcl cases */
189 case 014: /* check for a form feed */
190 if (!ps.box_com) { /* in a text comment, break the line here */
192 /* fix so dump_line uses a form feed */
198 while (*++buf_ptr == ' ' || *buf_ptr == '\t');
201 if (++buf_ptr >= buf_end)
208 if (had_eof) { /* check for unexpected eof */
209 printf("Unterminated comment\n");
215 if (ps.box_com || ps.last_nl) { /* if this is a boxed comment,
216 * we dont ignore the newline */
217 if (s_com == e_com) {
222 if (!ps.box_com && e_com - s_com > 3) {
223 if (break_delim == 1 && s_com[0] == '/'
224 && s_com[1] == '*' && s_com[2] == ' ') {
229 if (blanklines_before_blockcomments)
230 prefix_blankline_requested = 1;
233 s_com[0] = s_com[1] = s_com[2] = ' ';
241 now_col = ps.com_col;
245 if (unix_comment != 1) { /* we not are in unix_style
247 if (unix_comment == 0 && s_code == e_code) {
249 * if it is a UNIX-style comment, ignore the
250 * requirement that previous line be blank for
253 ps.com_col = (ps.ind_level - ps.unindent_displace) * ps.ind_size + 1;
257 unix_comment = 2; /* permanently remember that we are in
258 * this type of comment */
261 now_col = ps.com_col;
264 * fix so that the star at the start of the line will line
267 do /* flush leading white space */
268 if (++buf_ptr >= buf_end)
270 while (*buf_ptr == ' ' || *buf_ptr == '\t');
273 if (*(e_com - 1) == ' ' || *(e_com - 1) == '\t')
276 * if there was a space at the end of the last line, remember
279 else { /* otherwise, insert one */
286 ++line_no; /* keep track of input line number */
289 do { /* flush any blanks and/or tabs at start of
291 if (++buf_ptr >= buf_end)
293 if (*buf_ptr == '*' && --nstar >= 0) {
294 if (++buf_ptr >= buf_end)
299 } while (*buf_ptr == ' ' || *buf_ptr == '\t');
301 else if (++buf_ptr >= buf_end)
303 break; /* end of case for newline */
305 case '*': /* must check for possibility of being at end
307 if (++buf_ptr >= buf_end) /* get to next char after * */
310 if (unix_comment == 0) /* set flag to show we are not in
311 * unix-style comment */
314 if (*buf_ptr == '/') { /* it is the end!!! */
316 if (++buf_ptr >= buf_end)
319 if (*(e_com - 1) != ' ' && !ps.box_com) { /* insure blank before
324 if (break_delim == 1 && !one_liner && s_com[0] == '/'
325 && s_com[1] == '*' && s_com[2] == ' ') {
330 if (blanklines_before_blockcomments)
331 prefix_blankline_requested = 1;
334 s_com[0] = s_com[1] = s_com[2] = ' ';
336 if (break_delim == 2 && e_com > s_com + 3
337 /* now_col > adj_max_col - 2 && !ps.box_com */ ) {
340 now_col = ps.com_col;
346 ps.just_saw_decl = l_just_saw_decl;
349 else { /* handle isolated '*' */
354 default: /* we have a random char */
355 if (unix_comment == 0 && *buf_ptr != ' ' && *buf_ptr != '\t')
356 unix_comment = 1; /* we are not in unix-style comment */
359 if (buf_ptr >= buf_end)
362 if (*e_com == '\t') /* keep track of column */
363 now_col = ((now_col - 1) & tabmask) + tabsize + 1;
364 else if (*e_com == '\b') /* this is a backspace */
369 if (*e_com == ' ' || *e_com == '\t')
371 /* remember we saw a blank */
374 if (now_col > adj_max_col && !ps.box_com && unix_comment == 1 && e_com[-1] > ' ') {
376 * the comment is too long, it must be broken up
378 if (break_delim == 1 && s_com[0] == '/'
379 && s_com[1] == '*' && s_com[2] == ' ') {
384 if (blanklines_before_blockcomments)
385 prefix_blankline_requested = 1;
388 s_com[0] = s_com[1] = s_com[2] = ' ';
390 if (last_bl == 0) { /* we have seen no blanks */
391 last_bl = e_com; /* fake it */
394 *e_com = '\0'; /* print what we have */
396 while (last_bl > s_com && last_bl[-1] < 040)
401 *e_com++ = ' '; /* add blanks for continuation */
407 if (t_ptr >= e_com) {
408 while (*t_ptr == ' ' || *t_ptr == '\t')
410 while (*t_ptr != '\0') { /* move unprinted part of
411 * comment down in buffer */
412 if (*t_ptr == ' ' || *t_ptr == '\t')
418 now_col = count_spaces(ps.com_col, s_com); /* recompute current