1 /*- 2 * Copyright (c) 1985 Sun Microsystems, Inc. 3 * Copyright (c) 1980, 1993 4 * The Regents of the University of California. All rights reserved. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 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. 22 * 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 33 * SUCH DAMAGE. 34 */ 35 36 #if 0 37 #ifndef lint 38 static char sccsid[] = "@(#)pr_comment.c 8.1 (Berkeley) 6/6/93"; 39 #endif /* not lint */ 40 #endif 41 42 #include <sys/cdefs.h> 43 __FBSDID("$FreeBSD$"); 44 45 #include <err.h> 46 #include <stdio.h> 47 #include <stdlib.h> 48 #include <string.h> 49 #include "indent_globs.h" 50 #include "indent.h" 51 /* 52 * NAME: 53 * pr_comment 54 * 55 * FUNCTION: 56 * This routine takes care of scanning and printing comments. 57 * 58 * ALGORITHM: 59 * 1) Decide where the comment should be aligned, and if lines should 60 * be broken. 61 * 2) If lines should not be broken and filled, just copy up to end of 62 * comment. 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 66 * continue copying. 67 * 68 * HISTORY: 69 * November 1976 D A Willcox of CAC Initial coding 70 * 12/6/76 D A Willcox of CAC Modification to handle 71 * UNIX-style comments 72 * 73 */ 74 75 /* 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 80 */ 81 82 void 83 pr_comment(void) 84 { 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 89 * buffer */ 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; 94 ps.just_saw_decl = 0; 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 */ 100 101 /* Figure where to align and how to treat the comment */ 102 103 if (ps.col_1 && !format_col1_comments) { /* if comment starts in column 104 * 1 it should not be touched */ 105 ps.box_com = true; 106 break_delim = false; 107 ps.com_col = 1; 108 } 109 else { 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). */ 119 break_delim = false; 120 } 121 if ( /* ps.bl_line && */ (s_lab == e_lab) && (s_code == e_code)) { 122 /* klg: check only if this line is blank */ 123 /* 124 * If this (*and previous lines are*) blank, dont put comment way 125 * out at left 126 */ 127 ps.com_col = (ps.ind_level - ps.unindent_displace) * ps.ind_size + 1; 128 adj_max_col = block_comment_max_col; 129 if (ps.com_col <= 1) 130 ps.com_col = 1 + !format_col1_comments; 131 } 132 else { 133 int target_col; 134 break_delim = false; 135 if (s_code != e_code) 136 target_col = count_spaces(compute_code_target(), s_code); 137 else { 138 target_col = 1; 139 if (s_lab != e_lab) 140 target_col = count_spaces(compute_label_target(), s_lab); 141 } 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; 147 } 148 } 149 if (ps.box_com) { 150 buf_ptr[-2] = 0; 151 ps.n_comment_delta = 1 - count_spaces(1, in_buffer); 152 buf_ptr[-2] = '/'; 153 } 154 else { 155 ps.n_comment_delta = 0; 156 while (*buf_ptr == ' ' || *buf_ptr == '\t') 157 buf_ptr++; 158 } 159 ps.comment_delta = 0; 160 *e_com++ = '/'; /* put '/' followed by '*' into buffer */ 161 *e_com++ = '*'; 162 if (*buf_ptr != ' ' && !ps.box_com) 163 *e_com++ = ' '; 164 165 /* Don't put a break delimiter if this comment is a one-liner */ 166 for (t_ptr = buf_ptr; *t_ptr != '\0' && *t_ptr != '\n'; t_ptr++) { 167 if (t_ptr >= buf_end) 168 fill_buffer(); 169 if (t_ptr[0] == '*' && t_ptr[1] == '/') { 170 break_delim = false; 171 break; 172 } 173 } 174 175 if (break_delim) { 176 char *t = e_com; 177 e_com = s_com + 2; 178 *e_com = 0; 179 if (blanklines_before_blockcomments) 180 prefix_blankline_requested = 1; 181 dump_line(); 182 e_com = s_com = t; 183 if (!ps.box_com && star_comment_cont) 184 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' '; 185 } 186 187 if (troff) 188 adj_max_col = 80; 189 190 /* Start to copy the comment */ 191 192 while (1) { /* this loop will go until the comment is 193 * copied */ 194 CHECK_SIZE_COM; 195 switch (*buf_ptr) { /* this checks for various spcl cases */ 196 case 014: /* check for a form feed */ 197 if (!ps.box_com) { /* in a text comment, break the line here */ 198 ps.use_ff = true; 199 /* fix so dump_line uses a form feed */ 200 dump_line(); 201 last_bl = NULL; 202 if (!ps.box_com && star_comment_cont) 203 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' '; 204 while (*++buf_ptr == ' ' || *buf_ptr == '\t') 205 ; 206 } 207 else { 208 if (++buf_ptr >= buf_end) 209 fill_buffer(); 210 *e_com++ = 014; 211 } 212 break; 213 214 case '\n': 215 if (had_eof) { /* check for unexpected eof */ 216 printf("Unterminated comment\n"); 217 dump_line(); 218 return; 219 } 220 last_bl = NULL; 221 if (ps.box_com || ps.last_nl) { /* if this is a boxed comment, 222 * we dont ignore the newline */ 223 if (s_com == e_com) 224 *e_com++ = ' '; 225 if (!ps.box_com && e_com - s_com > 3) { 226 dump_line(); 227 if (star_comment_cont) 228 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' '; 229 } 230 dump_line(); 231 if (!ps.box_com && star_comment_cont) 232 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' '; 233 } 234 else { 235 ps.last_nl = 1; 236 if (*(e_com - 1) == ' ' || *(e_com - 1) == '\t') 237 last_bl = e_com - 1; 238 /* 239 * if there was a space at the end of the last line, remember 240 * where it was 241 */ 242 else { /* otherwise, insert one */ 243 last_bl = e_com; 244 CHECK_SIZE_COM; 245 *e_com++ = ' '; 246 } 247 } 248 ++line_no; /* keep track of input line number */ 249 if (!ps.box_com) { 250 int nstar = 1; 251 do { /* flush any blanks and/or tabs at start of 252 * next line */ 253 if (++buf_ptr >= buf_end) 254 fill_buffer(); 255 if (*buf_ptr == '*' && --nstar >= 0) { 256 if (++buf_ptr >= buf_end) 257 fill_buffer(); 258 if (*buf_ptr == '/') 259 goto end_of_comment; 260 } 261 } while (*buf_ptr == ' ' || *buf_ptr == '\t'); 262 } 263 else if (++buf_ptr >= buf_end) 264 fill_buffer(); 265 break; /* end of case for newline */ 266 267 case '*': /* must check for possibility of being at end 268 * of comment */ 269 if (++buf_ptr >= buf_end) /* get to next char after * */ 270 fill_buffer(); 271 272 if (*buf_ptr == '/') { /* it is the end!!! */ 273 end_of_comment: 274 if (++buf_ptr >= buf_end) 275 fill_buffer(); 276 CHECK_SIZE_COM; 277 if (break_delim) { 278 if (e_com > s_com + 3) { 279 dump_line(); 280 } 281 else 282 s_com = e_com; 283 *e_com++ = ' '; 284 } 285 if (e_com[-1] != ' ' && !ps.box_com) 286 *e_com++ = ' '; /* ensure blank before end */ 287 *e_com++ = '*', *e_com++ = '/', *e_com = '\0'; 288 ps.just_saw_decl = l_just_saw_decl; 289 return; 290 } 291 else /* handle isolated '*' */ 292 *e_com++ = '*'; 293 break; 294 default: /* we have a random char */ 295 now_col = count_spaces_until(ps.com_col, s_com, e_com); 296 do { 297 *e_com = *buf_ptr++; 298 if (buf_ptr >= buf_end) 299 fill_buffer(); 300 if (*e_com == ' ' || *e_com == '\t') 301 last_bl = e_com; /* remember we saw a blank */ 302 ++e_com; 303 now_col++; 304 } while (!memchr("*\n\r\b\t", *buf_ptr, 6) && 305 (now_col <= adj_max_col || !last_bl)); 306 ps.last_nl = false; 307 if (now_col > adj_max_col && !ps.box_com && e_com[-1] > ' ') { 308 /* 309 * the comment is too long, it must be broken up 310 */ 311 if (last_bl == NULL) { 312 dump_line(); 313 if (!ps.box_com && star_comment_cont) 314 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' '; 315 break; 316 } 317 *e_com = '\0'; 318 e_com = last_bl; 319 dump_line(); 320 if (!ps.box_com && star_comment_cont) 321 *e_com++ = ' ', *e_com++ = '*', *e_com++ = ' '; 322 for (t_ptr = last_bl + 1; *t_ptr == ' ' || *t_ptr == '\t'; 323 t_ptr++) 324 ; 325 last_bl = NULL; 326 while (*t_ptr != '\0') { 327 if (*t_ptr == ' ' || *t_ptr == '\t') 328 last_bl = e_com; 329 *e_com++ = *t_ptr++; 330 } 331 } 332 break; 333 } 334 } 335 } 336