pr_comment.c revision 1.60 1 1.60 rillig /* $NetBSD: pr_comment.c,v 1.60 2021/10/08 17:19:49 rillig Exp $ */
2 1.4 tls
3 1.11 kamil /*-
4 1.11 kamil * SPDX-License-Identifier: BSD-4-Clause
5 1.11 kamil *
6 1.11 kamil * Copyright (c) 1985 Sun Microsystems, Inc.
7 1.5 mrg * Copyright (c) 1980, 1993
8 1.5 mrg * The Regents of the University of California. All rights reserved.
9 1.1 cgd * All rights reserved.
10 1.1 cgd *
11 1.1 cgd * Redistribution and use in source and binary forms, with or without
12 1.1 cgd * modification, are permitted provided that the following conditions
13 1.1 cgd * are met:
14 1.1 cgd * 1. Redistributions of source code must retain the above copyright
15 1.1 cgd * notice, this list of conditions and the following disclaimer.
16 1.1 cgd * 2. Redistributions in binary form must reproduce the above copyright
17 1.1 cgd * notice, this list of conditions and the following disclaimer in the
18 1.1 cgd * documentation and/or other materials provided with the distribution.
19 1.1 cgd * 3. All advertising materials mentioning features or use of this software
20 1.1 cgd * must display the following acknowledgement:
21 1.1 cgd * This product includes software developed by the University of
22 1.1 cgd * California, Berkeley and its contributors.
23 1.1 cgd * 4. Neither the name of the University nor the names of its contributors
24 1.1 cgd * may be used to endorse or promote products derived from this software
25 1.1 cgd * without specific prior written permission.
26 1.1 cgd *
27 1.1 cgd * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 1.1 cgd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 1.1 cgd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 1.1 cgd * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 1.1 cgd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 1.1 cgd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 1.1 cgd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 1.1 cgd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 1.1 cgd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 1.1 cgd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 1.1 cgd * SUCH DAMAGE.
38 1.1 cgd */
39 1.1 cgd
40 1.11 kamil #if 0
41 1.11 kamil static char sccsid[] = "@(#)pr_comment.c 8.1 (Berkeley) 6/6/93";
42 1.11 kamil #endif
43 1.11 kamil
44 1.6 lukem #include <sys/cdefs.h>
45 1.11 kamil #if defined(__NetBSD__)
46 1.60 rillig __RCSID("$NetBSD: pr_comment.c,v 1.60 2021/10/08 17:19:49 rillig Exp $");
47 1.11 kamil #elif defined(__FreeBSD__)
48 1.11 kamil __FBSDID("$FreeBSD: head/usr.bin/indent/pr_comment.c 334927 2018-06-10 16:44:18Z pstef $");
49 1.11 kamil #endif
50 1.1 cgd
51 1.1 cgd #include <stdio.h>
52 1.11 kamil #include <string.h>
53 1.12 rillig
54 1.11 kamil #include "indent.h"
55 1.12 rillig
56 1.14 rillig static void
57 1.35 rillig check_size_comment(size_t desired_size)
58 1.14 rillig {
59 1.46 rillig if (com.e + desired_size >= com.l)
60 1.46 rillig buf_expand(&com, desired_size);
61 1.14 rillig }
62 1.14 rillig
63 1.1 cgd /*
64 1.28 rillig * Scan, reformat and output a single comment, which is either a block comment
65 1.28 rillig * starting with '/' '*' or an end-of-line comment starting with '//'.
66 1.1 cgd *
67 1.28 rillig * Try to keep comments from going over the maximum line length. If a line is
68 1.28 rillig * too long, move everything starting from the last blank to the next comment
69 1.28 rillig * line. Blanks and tabs from the beginning of the input line are removed.
70 1.1 cgd *
71 1.1 cgd * ALGORITHM:
72 1.1 cgd * 1) Decide where the comment should be aligned, and if lines should
73 1.1 cgd * be broken.
74 1.1 cgd * 2) If lines should not be broken and filled, just copy up to end of
75 1.1 cgd * comment.
76 1.28 rillig * 3) If lines should be filled, then scan through the input buffer,
77 1.28 rillig * copying characters to com_buf. Remember where the last blank,
78 1.28 rillig * tab, or newline was. When line is filled, print up to last blank
79 1.28 rillig * and continue copying.
80 1.1 cgd */
81 1.6 lukem void
82 1.28 rillig process_comment(void)
83 1.1 cgd {
84 1.47 rillig int adj_max_line_length; /* Adjusted max_line_length for comments that
85 1.47 rillig * spill over the right margin */
86 1.36 rillig ssize_t last_blank; /* index of the last blank in com.buf */
87 1.47 rillig char *t_ptr; /* used for moving string */
88 1.44 rillig bool break_delim = opt.comment_delimiter_on_blankline;
89 1.47 rillig int l_just_saw_decl = ps.just_saw_decl;
90 1.11 kamil
91 1.26 rillig adj_max_line_length = opt.max_line_length;
92 1.11 kamil ps.just_saw_decl = 0;
93 1.35 rillig last_blank = -1; /* no blanks found so far */
94 1.47 rillig ps.box_com = false; /* at first, assume that we are not in a boxed
95 1.47 rillig * comment or some other comment that should
96 1.47 rillig * not be touched */
97 1.41 rillig ps.stats.comments++;
98 1.11 kamil
99 1.11 kamil /* Figure where to align and how to treat the comment */
100 1.11 kamil
101 1.28 rillig if (ps.col_1 && !opt.format_col1_comments) { /* if the comment starts in
102 1.28 rillig * column 1, it should not be touched */
103 1.11 kamil ps.box_com = true;
104 1.11 kamil break_delim = false;
105 1.60 rillig ps.com_ind = 0;
106 1.56 rillig
107 1.19 rillig } else {
108 1.58 rillig if (*inp.s == '-' || *inp.s == '*' || token.e[-1] == '/' ||
109 1.58 rillig (*inp.s == '\n' && !opt.format_block_comments)) {
110 1.11 kamil ps.box_com = true; /* A comment with a '-' or '*' immediately
111 1.11 kamil * after the /+* is assumed to be a boxed
112 1.11 kamil * comment. A comment with a newline
113 1.47 rillig * immediately after the /+* is assumed to be
114 1.47 rillig * a block comment and is treated as a box
115 1.47 rillig * comment unless format_block_comments is
116 1.47 rillig * nonzero (the default). */
117 1.11 kamil break_delim = false;
118 1.11 kamil }
119 1.56 rillig
120 1.45 rillig if (lab.s == lab.e && code.s == code.e) {
121 1.60 rillig ps.com_ind = (ps.ind_level - opt.unindent_displace) * opt.indent_size;
122 1.26 rillig adj_max_line_length = opt.block_comment_max_line_length;
123 1.60 rillig if (ps.com_ind <= 0)
124 1.60 rillig ps.com_ind = opt.format_col1_comments ? 0 : 1;
125 1.56 rillig
126 1.19 rillig } else {
127 1.33 rillig break_delim = false;
128 1.34 rillig
129 1.59 rillig int target_ind;
130 1.38 rillig if (code.s != code.e)
131 1.59 rillig target_ind = indentation_after(compute_code_indent(), code.s);
132 1.37 rillig else if (lab.s != lab.e)
133 1.59 rillig target_ind = indentation_after(compute_label_indent(), lab.s);
134 1.34 rillig else
135 1.59 rillig target_ind = 0;
136 1.34 rillig
137 1.60 rillig ps.com_ind = ps.decl_on_line || ps.ind_level == 0
138 1.60 rillig ? opt.decl_comment_column - 1 : opt.comment_column - 1;
139 1.60 rillig if (ps.com_ind <= target_ind)
140 1.60 rillig ps.com_ind = opt.tabsize * (1 + target_ind / opt.tabsize);
141 1.60 rillig /* XXX: the '+ 1' smells like an off-by-one error */
142 1.60 rillig if (ps.com_ind + 1 + 24 > adj_max_line_length)
143 1.60 rillig adj_max_line_length = ps.com_ind + 1 + 24;
144 1.11 kamil }
145 1.11 kamil }
146 1.56 rillig
147 1.11 kamil if (ps.box_com) {
148 1.6 lukem /*
149 1.11 kamil * Find out how much indentation there was originally, because that
150 1.53 rillig * much will have to be ignored by dump_line(). This is a box comment,
151 1.53 rillig * so nothing changes -- not even indentation.
152 1.11 kamil *
153 1.58 rillig * The comment we're about to read usually comes from inp.buf,
154 1.11 kamil * unless it has been copied into save_com.
155 1.11 kamil */
156 1.53 rillig const char *start;
157 1.11 kamil
158 1.25 rillig /*
159 1.25 rillig * XXX: ordered comparison between pointers from different objects
160 1.25 rillig * invokes undefined behavior (C99 6.5.8).
161 1.25 rillig */
162 1.58 rillig start = inp.s >= save_com && inp.s < save_com + sc_size ?
163 1.58 rillig sc_buf : inp.buf;
164 1.58 rillig ps.n_comment_delta = -indentation_after_range(0, start, inp.s - 2);
165 1.19 rillig } else {
166 1.11 kamil ps.n_comment_delta = 0;
167 1.58 rillig while (is_hspace(*inp.s))
168 1.58 rillig inp.s++;
169 1.11 kamil }
170 1.56 rillig
171 1.11 kamil ps.comment_delta = 0;
172 1.36 rillig *com.e++ = '/';
173 1.39 rillig *com.e++ = token.e[-1];
174 1.58 rillig if (*inp.s != ' ' && !ps.box_com)
175 1.36 rillig *com.e++ = ' ';
176 1.11 kamil
177 1.55 rillig /* Don't put a break delimiter if this is a one-liner that won't wrap. */
178 1.57 rillig if (break_delim) {
179 1.58 rillig for (t_ptr = inp.s; *t_ptr != '\0' && *t_ptr != '\n'; t_ptr++) {
180 1.58 rillig if (t_ptr >= inp.e)
181 1.11 kamil fill_buffer();
182 1.11 kamil if (t_ptr[0] == '*' && t_ptr[1] == '/') {
183 1.47 rillig /*
184 1.47 rillig * XXX: This computation ignores the leading " * ", as well as
185 1.47 rillig * the trailing ' ' '*' '/'. In simple cases, these cancel
186 1.47 rillig * out since they are equally long.
187 1.47 rillig */
188 1.60 rillig int right_margin = indentation_after_range(ps.com_ind,
189 1.58 rillig inp.s, t_ptr + 2);
190 1.30 rillig if (right_margin < adj_max_line_length)
191 1.11 kamil break_delim = false;
192 1.11 kamil break;
193 1.11 kamil }
194 1.6 lukem }
195 1.57 rillig }
196 1.1 cgd
197 1.11 kamil if (break_delim) {
198 1.47 rillig char *t = com.e;
199 1.36 rillig com.e = com.s + 2;
200 1.49 rillig *com.e = '\0';
201 1.11 kamil if (opt.blanklines_before_blockcomments && ps.last_token != lbrace)
202 1.43 rillig prefix_blankline_requested = true;
203 1.11 kamil dump_line();
204 1.36 rillig com.e = com.s = t;
205 1.11 kamil if (!ps.box_com && opt.star_comment_cont)
206 1.36 rillig *com.e++ = ' ', *com.e++ = '*', *com.e++ = ' ';
207 1.11 kamil }
208 1.11 kamil
209 1.11 kamil /* Start to copy the comment */
210 1.1 cgd
211 1.31 rillig for (;;) { /* this loop will go until the comment is
212 1.6 lukem * copied */
213 1.58 rillig switch (*inp.s) { /* this checks for various special cases */
214 1.51 rillig case '\f':
215 1.35 rillig check_size_comment(3);
216 1.11 kamil if (!ps.box_com) { /* in a text comment, break the line here */
217 1.11 kamil ps.use_ff = true;
218 1.11 kamil dump_line();
219 1.35 rillig last_blank = -1;
220 1.11 kamil if (!ps.box_com && opt.star_comment_cont)
221 1.36 rillig *com.e++ = ' ', *com.e++ = '*', *com.e++ = ' ';
222 1.58 rillig inp.s++;
223 1.58 rillig while (is_hspace(*inp.s))
224 1.58 rillig inp.s++;
225 1.19 rillig } else {
226 1.48 rillig inbuf_skip();
227 1.51 rillig *com.e++ = '\f';
228 1.11 kamil }
229 1.11 kamil break;
230 1.11 kamil
231 1.11 kamil case '\n':
232 1.39 rillig if (token.e[-1] == '/') {
233 1.13 rillig ++line_no;
234 1.13 rillig goto end_of_comment;
235 1.13 rillig }
236 1.56 rillig
237 1.54 rillig if (had_eof) {
238 1.11 kamil printf("Unterminated comment\n");
239 1.11 kamil dump_line();
240 1.11 kamil return;
241 1.11 kamil }
242 1.56 rillig
243 1.35 rillig last_blank = -1;
244 1.35 rillig check_size_comment(4);
245 1.11 kamil if (ps.box_com || ps.last_nl) { /* if this is a boxed comment,
246 1.52 rillig * we handle the newline */
247 1.36 rillig if (com.s == com.e)
248 1.36 rillig *com.e++ = ' ';
249 1.36 rillig if (!ps.box_com && com.e - com.s > 3) {
250 1.11 kamil dump_line();
251 1.11 kamil if (opt.star_comment_cont)
252 1.36 rillig *com.e++ = ' ', *com.e++ = '*', *com.e++ = ' ';
253 1.11 kamil }
254 1.11 kamil dump_line();
255 1.11 kamil if (!ps.box_com && opt.star_comment_cont)
256 1.36 rillig *com.e++ = ' ', *com.e++ = '*', *com.e++ = ' ';
257 1.56 rillig
258 1.19 rillig } else {
259 1.43 rillig ps.last_nl = true;
260 1.50 rillig if (!is_hspace(com.e[-1]))
261 1.36 rillig *com.e++ = ' ';
262 1.36 rillig last_blank = com.e - 1 - com.buf;
263 1.11 kamil }
264 1.54 rillig ++line_no;
265 1.11 kamil if (!ps.box_com) {
266 1.52 rillig int asterisks_to_skip = 1;
267 1.11 kamil do { /* flush any blanks and/or tabs at start of
268 1.11 kamil * next line */
269 1.48 rillig inbuf_skip();
270 1.58 rillig if (*inp.s == '*' && --asterisks_to_skip >= 0) {
271 1.48 rillig inbuf_skip();
272 1.58 rillig if (*inp.s == '/')
273 1.11 kamil goto end_of_comment;
274 1.11 kamil }
275 1.58 rillig } while (is_hspace(*inp.s));
276 1.48 rillig } else
277 1.48 rillig inbuf_skip();
278 1.11 kamil break; /* end of case for newline */
279 1.1 cgd
280 1.52 rillig case '*':
281 1.48 rillig inbuf_skip();
282 1.35 rillig check_size_comment(4);
283 1.58 rillig if (*inp.s == '/') {
284 1.11 kamil end_of_comment:
285 1.48 rillig inbuf_skip();
286 1.56 rillig
287 1.11 kamil if (break_delim) {
288 1.36 rillig if (com.e > com.s + 3)
289 1.11 kamil dump_line();
290 1.11 kamil else
291 1.36 rillig com.s = com.e;
292 1.36 rillig *com.e++ = ' ';
293 1.11 kamil }
294 1.56 rillig
295 1.50 rillig if (!is_hspace(com.e[-1]) && !ps.box_com)
296 1.36 rillig *com.e++ = ' '; /* ensure blank before end */
297 1.39 rillig if (token.e[-1] == '/')
298 1.36 rillig *com.e++ = '\n', *com.e = '\0';
299 1.13 rillig else
300 1.36 rillig *com.e++ = '*', *com.e++ = '/', *com.e = '\0';
301 1.56 rillig
302 1.11 kamil ps.just_saw_decl = l_just_saw_decl;
303 1.11 kamil return;
304 1.56 rillig
305 1.19 rillig } else /* handle isolated '*' */
306 1.36 rillig *com.e++ = '*';
307 1.11 kamil break;
308 1.56 rillig
309 1.11 kamil default: /* we have a random char */
310 1.26 rillig ;
311 1.60 rillig int now_len = indentation_after_range(ps.com_ind, com.s, com.e);
312 1.11 kamil do {
313 1.35 rillig check_size_comment(1);
314 1.49 rillig char ch = inbuf_next();
315 1.50 rillig if (is_hspace(ch))
316 1.49 rillig last_blank = com.e - com.buf;
317 1.49 rillig *com.e++ = ch;
318 1.26 rillig now_len++;
319 1.58 rillig } while (memchr("*\n\r\b\t", *inp.s, 6) == NULL &&
320 1.35 rillig (now_len < adj_max_line_length || last_blank == -1));
321 1.56 rillig
322 1.11 kamil ps.last_nl = false;
323 1.56 rillig
324 1.26 rillig /* XXX: signed character comparison '>' does not work for UTF-8 */
325 1.32 rillig if (now_len > adj_max_line_length &&
326 1.36 rillig !ps.box_com && com.e[-1] > ' ') {
327 1.56 rillig
328 1.55 rillig /* the comment is too long, it must be broken up */
329 1.35 rillig if (last_blank == -1) {
330 1.11 kamil dump_line();
331 1.11 kamil if (!ps.box_com && opt.star_comment_cont)
332 1.36 rillig *com.e++ = ' ', *com.e++ = '*', *com.e++ = ' ';
333 1.11 kamil break;
334 1.11 kamil }
335 1.56 rillig
336 1.36 rillig *com.e = '\0';
337 1.36 rillig com.e = com.buf + last_blank;
338 1.11 kamil dump_line();
339 1.56 rillig
340 1.11 kamil if (!ps.box_com && opt.star_comment_cont)
341 1.36 rillig *com.e++ = ' ', *com.e++ = '*', *com.e++ = ' ';
342 1.56 rillig
343 1.36 rillig for (t_ptr = com.buf + last_blank + 1;
344 1.50 rillig is_hspace(*t_ptr); t_ptr++)
345 1.35 rillig continue;
346 1.35 rillig last_blank = -1;
347 1.56 rillig
348 1.11 kamil /*
349 1.36 rillig * t_ptr will be somewhere between com.e (dump_line() reset)
350 1.47 rillig * and com.l. So it's safe to copy byte by byte from t_ptr to
351 1.47 rillig * com.e without any check_size_comment().
352 1.11 kamil */
353 1.11 kamil while (*t_ptr != '\0') {
354 1.50 rillig if (is_hspace(*t_ptr))
355 1.36 rillig last_blank = com.e - com.buf;
356 1.36 rillig *com.e++ = *t_ptr++;
357 1.1 cgd }
358 1.11 kamil }
359 1.11 kamil break;
360 1.1 cgd }
361 1.11 kamil }
362 1.1 cgd }
363