| blob | c1b80e3358599a4e03f730aae618a86b08deb476 |
1 ;;; Boxed comments for C mode.
2 ;;; Copyright (C) 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
3 ;;; Francois Pinard <pinard@iro.umontreal.ca>, April 1991.
4 ;;;
5 ;;; I often refill paragraphs inside C comments, while stretching or
6 ;;; shrinking the surrounding box as needed. This is a real pain to
7 ;;; do by hand. Here is the code I made to ease my life on this,
8 ;;; usable from within GNU Emacs. It would not be fair giving all
9 ;;; sources for a product without also giving the means for nicely
10 ;;; modifying them.
11 ;;;
12 ;;; The function rebox-c-comment adjust comment boxes without
13 ;;; refilling comment paragraphs, while reindent-c-comment adjust
14 ;;; comment boxes after refilling. Numeric prefixes are used to add,
15 ;;; remove, or change the style of the box surrounding the comment.
16 ;;; Since refilling paragraphs in C mode does make sense only for
17 ;;; comments, this code redefines the M-q command in C mode. I use
18 ;;; this hack by putting, in my .emacs file:
19 ;;;
20 ;;; (setq c-mode-hook
21 ;;; '(lambda ()
22 ;;; (define-key c-mode-map "\M-q" 'reindent-c-comment)))
23 ;;; (autoload 'rebox-c-comment "c-boxes" nil t)
24 ;;; (autoload 'reindent-c-comment "c-boxes" nil t)
25 ;;;
26 ;;; The cursor should be within a comment before any of these
27 ;;; commands, or else it should be between two comments, in which case
28 ;;; the command applies to the next comment. When the command is
29 ;;; given without prefix, the current comment box type is recognized
30 ;;; and preserved. Given 0 as a prefix, the comment box disappears
31 ;;; and the comment stays between a single opening `/*' and a single
32 ;;; closing `*/'. Given 1 or 2 as a prefix, a single or doubled lined
33 ;;; comment box is forced. Given 3 as a prefix, a Taarna style box is
34 ;;; forced, but you do not even want to hear about those. When a
35 ;;; negative prefix is given, the absolute value is used, but the
36 ;;; default style is changed. Any other value (like C-u alone) forces
37 ;;; the default box style.
38 ;;;
39 ;;; I observed rounded corners first in some code from Warren Tucker
40 ;;; <wht@n4hgf.mt-park.ga.us>.
45 ;;; Set or reset the Taarna team's own way for a C style.
72 ;;; Return the minimum value of the left margin of all lines, or -1 if
73 ;;; all lines are empty.
86 margin))
88 ;;; Return the maximum value of the right margin of all lines. Any
89 ;;; sentence ending a line has a space guaranteed before the margin.
103 margin))
105 ;;; Add, delete or adjust a C comment box. If FLAG is nil, the
106 ;;; current boxing style is recognized and preserved. When 0, the box
107 ;;; is removed; when 1, a single lined box is forced; when 2, a double
108 ;;; lined box is forced; when 3, a Taarna style box is forced. If
109 ;;; negative, the absolute value is used, but the default style is
110 ;;; changed. For any other value (like C-u), the default style is
111 ;;; forced. If REFILL is not nil, refill the comment paragraphs prior
112 ;;; to reboxing.
119 box-style left-margin right-margin)
121 ;; First, find the limits of the block of comments following or
122 ;; enclosing the cursor, or return an error if the cursor is not
123 ;; within such a block of comments, narrow the buffer, and
124 ;; untabify it.
126 ;; - insure the point is into the following comment, if any
134 ;; - identify a minimal comment block
161 ;; - try to extend the comment block backwards
170 ;; - try to extend the comment block forward
178 ;; - narrow to the whole block of comments
182 ;; Second, remove all the comment marks, and move all the text
183 ;; rigidly to the left to insure the left margin stays at the
184 ;; same place. At the same time, recognize and save the box
185 ;; style in BOX-STYLE.
188 actual-margin)
190 ;; - remove all comment marks
201 ;; - remove the first and last dashed lines
222 ;; - remove all spurious whitespace
236 ;; - move the text left is adequate
243 ;; Third, select the new box style from the old box style and
244 ;; the argument, choose the margins for this style and refill
245 ;; each paragraph.
247 ;; - modify box-style only if flag is defined
261 ;; - compute the left margin
265 ;; - temporarily set the fill prefix and column, then refill
275 ;; - compute the right margin after refill
279 ;; Fourth, put the narrowed buffer back into a comment box,
280 ;; according to the value of box-style. Values may be:
281 ;; plain: insert between a single pair of comment delimiters
282 ;; single: complete box, overline and underline with dashes
283 ;; double: complete box, overline and underline with equal signs
284 ;; taarna: comment delimiters on each line, underline with dashes
286 ;; - move the right margin to account for left inserts
290 2
293 ;; - construct the box comment, from top to bottom
298 ;; - construct a plain style comment
315 ;; - construct a single line style comment
335 ;; - construct a double line style comment
355 ;; - construct a Taarna style comment
371 ;; Fifth, retabify, restore the point position, then cleanup the
372 ;; undo list of any boundary since we started.
374 ;; - retabify before left margin only (adapted from tabify.el)
383 ;; - restore the point position
387 ;; - remove all intermediate boundaries from the undo list
396 ;;; Rebox a C comment without refilling it.
402 ;;; Rebox a C comment after refilling.