Commit | Line | Data |
---|---|---|
83b96b22 SM |
1 | ;;; newcomment.el --- (un)comment regions of buffers |
2 | ||
39cb51e7 | 3 | ;; Copyright (C) 1999, 2000 Free Software Foundation Inc. |
83b96b22 | 4 | |
59a1ce8d | 5 | ;; Author: code extracted from Emacs-20's simple.el |
771c9b97 | 6 | ;; Maintainer: Stefan Monnier <monnier@cs.yale.edu> |
83b96b22 SM |
7 | ;; Keywords: comment uncomment |
8 | ;; Version: $Name: $ | |
39cb51e7 | 9 | ;; Revision: $Id: newcomment.el,v 1.26 2000/11/29 05:11:01 monnier Exp $ |
83b96b22 | 10 | |
59a1ce8d SM |
11 | ;; This file is part of GNU Emacs. |
12 | ||
13 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
83b96b22 | 14 | ;; it under the terms of the GNU General Public License as published by |
59a1ce8d SM |
15 | ;; the Free Software Foundation; either version 2, or (at your option) |
16 | ;; any later version. | |
17 | ||
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
83b96b22 SM |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
59a1ce8d | 22 | |
83b96b22 | 23 | ;; You should have received a copy of the GNU General Public License |
59a1ce8d SM |
24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
25 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
26 | ;; Boston, MA 02111-1307, USA. | |
83b96b22 SM |
27 | |
28 | ;;; Commentary: | |
29 | ||
771c9b97 | 30 | ;; A replacement for simple.el's comment-related functions. |
83b96b22 SM |
31 | |
32 | ;;; Bugs: | |
33 | ||
2ab98065 SM |
34 | ;; - single-char nestable comment-start can only do the "\\s<+" stuff |
35 | ;; if the corresponding closing marker happens to be right. | |
771c9b97 | 36 | ;; - comment-box in TeXinfo generate bogus comments @ccccc@ |
3e569d22 SM |
37 | ;; - uncomment-region with a numeric argument can render multichar |
38 | ;; comment markers invalid. | |
3fc5b4e2 SM |
39 | ;; - comment-indent or comment-region when called inside a comment |
40 | ;; will happily break the surrounding comment. | |
41 | ;; - comment-quote-nested will not (un)quote properly all nested comment | |
42 | ;; markers if there are more than just comment-start and comment-end. | |
43 | ;; For example, in Pascal where {...*) and (*...} are possible. | |
83b96b22 SM |
44 | |
45 | ;;; Todo: | |
46 | ||
771c9b97 SM |
47 | ;; - try to align tail comments |
48 | ;; - check what c-comment-line-break-function has to say | |
3e569d22 | 49 | ;; - spill auto-fill of comments onto the end of the next line |
7a0a180a SM |
50 | ;; - uncomment-region with a consp (for blocks) or somehow make the |
51 | ;; deletion of continuation markers less dangerous | |
2ab98065 | 52 | ;; - drop block-comment-<foo> unless it's really used |
f5215400 | 53 | ;; - uncomment-region on a subpart of a comment |
771c9b97 | 54 | ;; - support gnu-style "multi-line with space in continue" |
771c9b97 SM |
55 | ;; - somehow allow comment-dwim to use the region even if transient-mark-mode |
56 | ;; is not turned on. | |
83b96b22 | 57 | |
bdbe3a89 SM |
58 | ;; - when auto-filling a comment, try to move the comment to the left |
59 | ;; rather than break it (if possible). | |
60 | ;; - sometimes default the comment-column to the same | |
61 | ;; one used on the preceding line(s). | |
62 | ||
83b96b22 SM |
63 | ;;; Code: |
64 | ||
be83ecb2 | 65 | ;;;###autoload |
59a1ce8d | 66 | (defalias 'indent-for-comment 'comment-indent) |
be83ecb2 | 67 | ;;;###autoload |
59a1ce8d | 68 | (defalias 'set-comment-column 'comment-set-column) |
be83ecb2 | 69 | ;;;###autoload |
59a1ce8d | 70 | (defalias 'kill-comment 'comment-kill) |
be83ecb2 | 71 | ;;;###autoload |
59a1ce8d | 72 | (defalias 'indent-new-comment-line 'comment-indent-new-line) |
83b96b22 | 73 | |
be83ecb2 | 74 | ;;;###autoload |
3e569d22 SM |
75 | (defgroup comment nil |
76 | "Indenting and filling of comments." | |
77 | :prefix "comment-" | |
ac87b3a9 | 78 | :version "21.1" |
3e569d22 SM |
79 | :group 'fill) |
80 | ||
771c9b97 SM |
81 | (defvar comment-use-syntax 'undecided |
82 | "Non-nil if syntax-tables can be used instead of regexps. | |
83 | Can also be `undecided' which means that a somewhat expensive test will | |
84 | be used to try to determine whether syntax-tables should be trusted | |
f5215400 SM |
85 | to understand comments or not in the given buffer. |
86 | Major modes should set this variable.") | |
2ab98065 | 87 | |
be83ecb2 | 88 | ;;;###autoload |
83b96b22 SM |
89 | (defcustom comment-column 32 |
90 | "*Column to indent right-margin comments to. | |
91 | Setting this variable automatically makes it local to the current buffer. | |
92 | Each mode establishes a different default value for this variable; you | |
93 | can set the value for a particular mode using that mode's hook." | |
94 | :type 'integer | |
3e569d22 | 95 | :group 'comment) |
83b96b22 SM |
96 | (make-variable-buffer-local 'comment-column) |
97 | ||
be83ecb2 | 98 | ;;;###autoload |
f5215400 SM |
99 | (defvar comment-start nil |
100 | "*String to insert to start a new comment, or nil if no comment syntax.") | |
83b96b22 | 101 | |
be83ecb2 | 102 | ;;;###autoload |
f5215400 | 103 | (defvar comment-start-skip nil |
83b96b22 SM |
104 | "*Regexp to match the start of a comment plus everything up to its body. |
105 | If there are any \\(...\\) pairs, the comment delimiter text is held to begin | |
f5215400 | 106 | at the place matched by the close of the first pair.") |
771c9b97 | 107 | |
be83ecb2 | 108 | ;;;###autoload |
3e569d22 SM |
109 | (defvar comment-end-skip nil |
110 | "Regexp to match the end of a comment plus everything up to its body.") | |
83b96b22 | 111 | |
be83ecb2 | 112 | ;;;###autoload |
f5215400 | 113 | (defvar comment-end "" |
83b96b22 | 114 | "*String to insert to end a new comment. |
f5215400 | 115 | Should be an empty string if comments are terminated by end-of-line.") |
83b96b22 | 116 | |
be83ecb2 | 117 | ;;;###autoload |
87cf8421 | 118 | (defvar comment-indent-function 'comment-indent-default |
83b96b22 SM |
119 | "Function to compute desired indentation for a comment. |
120 | This function is called with no args with point at the beginning of | |
87cf8421 SM |
121 | the comment's starting delimiter and should return either the desired |
122 | column indentation or nil. | |
123 | If nil is returned, indentation is delegated to `indent-according-to-mode'.") | |
83b96b22 | 124 | |
3e569d22 SM |
125 | (defvar block-comment-start nil) |
126 | (defvar block-comment-end nil) | |
83b96b22 | 127 | |
771c9b97 SM |
128 | (defvar comment-quote-nested t |
129 | "Non-nil if nested comments should be quoted. | |
130 | This should be locally set by each major mode if needed.") | |
131 | ||
132 | (defvar comment-continue nil | |
f5215400 SM |
133 | "Continuation string to insert for multiline comments. |
134 | This string will be added at the beginning of each line except the very | |
135 | first one when commenting a region with a commenting style that allows | |
136 | comments to span several lines. | |
137 | It should generally have the same length as `comment-start' in order to | |
138 | preserve indentation. | |
139 | If it is nil a value will be automatically derived from `comment-start' | |
140 | by replacing its first character with a space.") | |
141 | ||
771c9b97 | 142 | (defvar comment-add 0 |
f5215400 SM |
143 | "How many more comment chars should be inserted by `comment-region'. |
144 | This determines the default value of the numeric argument of `comment-region'. | |
145 | This should generally stay 0, except for a few modes like Lisp where | |
146 | it can be convenient to set it to 1 so that regions are commented with | |
147 | two semi-colons.") | |
2ab98065 | 148 | |
2ab98065 | 149 | (defconst comment-styles |
771c9b97 SM |
150 | '((plain . (nil nil nil nil)) |
151 | (indent . (nil nil nil t)) | |
152 | (aligned . (nil t nil t)) | |
153 | (multi-line . (t nil nil t)) | |
154 | (extra-line . (t nil t t)) | |
9b0d1d6e SM |
155 | (box . (nil t t t)) |
156 | (box-multi . (t t t t))) | |
f5215400 SM |
157 | "Possible comment styles of the form (STYLE . (MULTI ALIGN EXTRA INDENT)). |
158 | STYLE should be a mnemonic symbol. | |
159 | MULTI specifies that comments are allowed to span multiple lines. | |
160 | ALIGN specifies that the `comment-end' markers should be aligned. | |
161 | EXTRA specifies that an extra line should be used before and after the | |
162 | region to comment (to put the `comment-end' and `comment-start'). | |
163 | INDENT specifies that the `comment-start' markers should not be put at the | |
164 | left margin but at the current indentation of the region to comment.") | |
165 | ||
be83ecb2 | 166 | ;;;###autoload |
f5215400 SM |
167 | (defcustom comment-style 'plain |
168 | "*Style to be used for `comment-region'. | |
169 | See `comment-styles' for a list of available styles." | |
170 | :group 'comment | |
be83ecb2 SM |
171 | :type (if (boundp 'comment-styles) |
172 | `(choice ,@(mapcar (lambda (s) `(const ,(car s))) comment-styles)) | |
173 | 'symbol)) | |
2ab98065 | 174 | |
be83ecb2 SM |
175 | ;;;###autoload |
176 | (defcustom comment-padding " " | |
f5215400 SM |
177 | "Padding string that `comment-region' puts between comment chars and text. |
178 | Can also be an integer which will be automatically turned into a string | |
179 | of the corresponding number of spaces. | |
2ab98065 SM |
180 | |
181 | Extra spacing between the comment characters and the comment text | |
771c9b97 | 182 | makes the comment easier to read. Default is 1. nil means 0.") |
2ab98065 | 183 | |
be83ecb2 | 184 | ;;;###autoload |
3e569d22 | 185 | (defcustom comment-multi-line nil |
ac87b3a9 | 186 | "*Non-nil means \\[comment-indent-new-line] continues comments, with no new terminator or starter. |
3e569d22 SM |
187 | This is obsolete because you might as well use \\[newline-and-indent]." |
188 | :type 'boolean | |
189 | :group 'comment) | |
190 | ||
2ab98065 SM |
191 | ;;;; |
192 | ;;;; Helpers | |
193 | ;;;; | |
194 | ||
f5215400 SM |
195 | (defun comment-string-strip (str beforep afterp) |
196 | "Strip STR of any leading (if BEFOREP) and/or trailing (if AFTERP) space." | |
197 | (string-match (concat "\\`" (if beforep "\\s-*") | |
ad679e45 | 198 | "\\(.*?\\)" (if afterp "\\s-*\n?") |
2ab98065 SM |
199 | "\\'") str) |
200 | (match-string 1 str)) | |
201 | ||
202 | (defun comment-string-reverse (s) | |
f5215400 | 203 | "Return the mirror image of string S, without any trailing space." |
771c9b97 | 204 | (comment-string-strip (concat (nreverse (string-to-list s))) nil t)) |
2ab98065 SM |
205 | |
206 | (defun comment-normalize-vars (&optional noerror) | |
207 | (if (not comment-start) (or noerror (error "No comment syntax is defined")) | |
208 | ;; comment-use-syntax | |
771c9b97 | 209 | (when (eq comment-use-syntax 'undecided) |
2ab98065 SM |
210 | (set (make-local-variable 'comment-use-syntax) |
211 | (let ((st (syntax-table)) | |
212 | (cs comment-start) | |
213 | (ce (if (string= "" comment-end) "\n" comment-end))) | |
771c9b97 SM |
214 | ;; Try to skip over a comment using forward-comment |
215 | ;; to see if the syntax tables properly recognize it. | |
2ab98065 SM |
216 | (with-temp-buffer |
217 | (set-syntax-table st) | |
218 | (insert cs " hello " ce) | |
219 | (goto-char (point-min)) | |
220 | (and (forward-comment 1) (eobp)))))) | |
2ab98065 SM |
221 | ;; comment-padding |
222 | (when (integerp comment-padding) | |
223 | (setq comment-padding (make-string comment-padding ? ))) | |
224 | ;; comment markers | |
225 | ;;(setq comment-start (comment-string-strip comment-start t nil)) | |
226 | ;;(setq comment-end (comment-string-strip comment-end nil t)) | |
227 | ;; comment-continue | |
f5215400 | 228 | (unless (or comment-continue (string= comment-end "")) |
2ab98065 | 229 | (set (make-local-variable 'comment-continue) |
9b0d1d6e SM |
230 | (concat (if (string-match "\\S-\\S-" comment-start) " " "|") |
231 | (substring comment-start 1)))) | |
2ab98065 SM |
232 | ;; comment-skip regexps |
233 | (unless comment-start-skip | |
234 | (set (make-local-variable 'comment-start-skip) | |
235 | (concat "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)\\(\\s<+\\|" | |
236 | (regexp-quote (comment-string-strip comment-start t t)) | |
237 | "+\\)\\s-*"))) | |
238 | (unless comment-end-skip | |
239 | (let ((ce (if (string= "" comment-end) "\n" | |
240 | (comment-string-strip comment-end t t)))) | |
241 | (set (make-local-variable 'comment-end-skip) | |
771c9b97 | 242 | (concat "\\s-*\\(\\s>" (if comment-quote-nested "" "+") |
2ab98065 | 243 | "\\|" (regexp-quote (substring ce 0 1)) |
771c9b97 | 244 | (if (and comment-quote-nested (<= (length ce) 1)) "" "+") |
2ab98065 SM |
245 | (regexp-quote (substring ce 1)) |
246 | "\\)")))))) | |
247 | ||
f5215400 SM |
248 | (defun comment-quote-re (str unp) |
249 | (concat (regexp-quote (substring str 0 1)) | |
250 | "\\\\" (if unp "+" "*") | |
251 | (regexp-quote (substring str 1)))) | |
252 | ||
253 | (defun comment-quote-nested (cs ce unp) | |
254 | "Quote or unquote nested comments. | |
255 | If UNP is non-nil, unquote nested comment markers." | |
256 | (setq cs (comment-string-strip cs t t)) | |
257 | (setq ce (comment-string-strip ce t t)) | |
258 | (when (and comment-quote-nested (> (length ce) 0)) | |
259 | (let ((re (concat (comment-quote-re ce unp) | |
260 | "\\|" (comment-quote-re cs unp)))) | |
261 | (goto-char (point-min)) | |
262 | (while (re-search-forward re nil t) | |
263 | (goto-char (match-beginning 0)) | |
264 | (forward-char 1) | |
265 | (if unp (delete-char 1) (insert "\\")) | |
266 | (when (= (length ce) 1) | |
267 | ;; If the comment-end is a single char, adding a \ after that | |
268 | ;; "first" char won't deactivate it, so we turn such a CE | |
269 | ;; into !CS. I.e. for pascal, we turn } into !{ | |
270 | (if (not unp) | |
271 | (when (string= (match-string 0) ce) | |
272 | (replace-match (concat "!" cs) t t)) | |
273 | (when (and (< (point-min) (match-beginning 0)) | |
274 | (string= (buffer-substring (1- (match-beginning 0)) | |
275 | (1- (match-end 0))) | |
276 | (concat "!" cs))) | |
277 | (backward-char 2) | |
278 | (delete-char (- (match-end 0) (match-beginning 0))) | |
279 | (insert ce)))))))) | |
2ab98065 SM |
280 | |
281 | ;;;; | |
282 | ;;;; Navigation | |
283 | ;;;; | |
284 | ||
ad679e45 | 285 | (defun comment-search-forward (limit &optional noerror) |
771c9b97 SM |
286 | "Find a comment start between point and LIMIT. |
287 | Moves point to inside the comment and returns the position of the | |
288 | comment-starter. If no comment is found, moves point to LIMIT | |
e8fe7d39 | 289 | and raises an error or returns nil of NOERROR is non-nil." |
2ab98065 | 290 | (if (not comment-use-syntax) |
9b0d1d6e SM |
291 | (if (re-search-forward comment-start-skip limit noerror) |
292 | (or (match-end 1) (match-beginning 0)) | |
293 | (goto-char limit) | |
294 | (unless noerror (error "No comment"))) | |
ad679e45 SM |
295 | (let* ((pt (point)) |
296 | ;; Assume (at first) that pt is outside of any string. | |
297 | (s (parse-partial-sexp pt (or limit (point-max)) nil nil nil t))) | |
298 | (when (and (nth 8 s) (nth 3 s)) | |
299 | ;; The search ended inside a string. Try to see if it | |
300 | ;; works better when we assume that pt is inside a string. | |
301 | (setq s (parse-partial-sexp | |
302 | pt (or limit (point-max)) nil nil | |
303 | (list nil nil nil (nth 3 s) nil nil nil nil) | |
304 | t))) | |
305 | (if (not (and (nth 8 s) (not (nth 3 s)))) | |
306 | (unless noerror (error "No comment")) | |
307 | ;; We found the comment. | |
9b0d1d6e | 308 | (let ((pos (point)) |
ad679e45 | 309 | (start (nth 8 s)) |
9b0d1d6e | 310 | (bol (line-beginning-position)) |
ad679e45 SM |
311 | (end nil)) |
312 | (while (and (null end) (>= (point) bol)) | |
313 | (if (looking-at comment-start-skip) | |
314 | (setq end (min (or limit (point-max)) (match-end 0))) | |
315 | (backward-char))) | |
9b0d1d6e | 316 | (goto-char (or end pos)) |
ad679e45 | 317 | start))))) |
2ab98065 SM |
318 | |
319 | (defun comment-search-backward (&optional limit noerror) | |
320 | "Find a comment start between LIMIT and point. | |
771c9b97 SM |
321 | Moves point to inside the comment and returns the position of the |
322 | comment-starter. If no comment is found, moves point to LIMIT | |
2ab98065 | 323 | and raises an error or returns nil of NOERROR is non-nil." |
ad679e45 SM |
324 | ;; FIXME: If a comment-start appears inside a comment, we may erroneously |
325 | ;; stop there. This can be rather bad in general, but since | |
326 | ;; comment-search-backward is only used to find the comment-column (in | |
327 | ;; comment-set-column) and to find the comment-start string (via | |
328 | ;; comment-beginning) in indent-new-comment-line, it should be harmless. | |
2ab98065 SM |
329 | (if (not (re-search-backward comment-start-skip limit t)) |
330 | (unless noerror (error "No comment")) | |
331 | (beginning-of-line) | |
332 | (let* ((end (match-end 0)) | |
333 | (cs (comment-search-forward end t)) | |
334 | (pt (point))) | |
335 | (if (not cs) | |
336 | (progn (beginning-of-line) | |
337 | (comment-search-backward limit noerror)) | |
338 | (while (progn (goto-char cs) | |
339 | (comment-forward) | |
340 | (and (< (point) end) | |
341 | (setq cs (comment-search-forward end t)))) | |
342 | (setq pt (point))) | |
343 | (goto-char pt) | |
344 | cs)))) | |
345 | ||
346 | (defun comment-beginning () | |
771c9b97 SM |
347 | "Find the beginning of the enclosing comment. |
348 | Returns nil if not inside a comment, else moves point and returns | |
2ab98065 SM |
349 | the same as `comment-search-forward'." |
350 | (let ((pt (point)) | |
351 | (cs (comment-search-backward nil t))) | |
ad679e45 | 352 | (when cs |
392f1ef5 SM |
353 | (if (save-excursion |
354 | (goto-char cs) | |
355 | (if (comment-forward 1) (> (point) pt) (eobp))) | |
ad679e45 SM |
356 | cs |
357 | (goto-char pt) | |
358 | nil)))) | |
2ab98065 SM |
359 | |
360 | (defun comment-forward (&optional n) | |
361 | "Skip forward over N comments. | |
362 | Just like `forward-comment' but only for positive N | |
363 | and can use regexps instead of syntax." | |
364 | (setq n (or n 1)) | |
365 | (if (< n 0) (error "No comment-backward") | |
366 | (if comment-use-syntax (forward-comment n) | |
367 | (while (> n 0) | |
368 | (skip-syntax-forward " ") | |
59a1ce8d SM |
369 | (setq n |
370 | (if (and (looking-at comment-start-skip) | |
371 | (re-search-forward comment-end-skip nil 'move)) | |
372 | (1- n) -1))) | |
2ab98065 SM |
373 | (= n 0)))) |
374 | ||
375 | (defun comment-enter-backward () | |
376 | "Move from the end of a comment to the end of its content. | |
771c9b97 | 377 | Point is assumed to be just at the end of a comment." |
2ab98065 SM |
378 | (if (bolp) |
379 | ;; comment-end = "" | |
380 | (progn (backward-char) (skip-syntax-backward " ")) | |
381 | (let ((end (point))) | |
382 | (beginning-of-line) | |
383 | (save-restriction | |
384 | (narrow-to-region (point) end) | |
ad679e45 SM |
385 | (if (re-search-forward (concat comment-end-skip "\\'") nil t) |
386 | (goto-char (match-beginning 0)) | |
387 | ;; comment-end-skip not found probably because it was not set right. | |
388 | ;; Since \\s> should catch the single-char case, we'll blindly | |
389 | ;; assume we're at the end of a two-char comment-end. | |
390 | (goto-char (point-max)) | |
391 | (backward-char 2) | |
392 | (skip-chars-backward (string (char-after))) | |
393 | (skip-syntax-backward " ")))))) | |
2ab98065 SM |
394 | |
395 | ;;;; | |
396 | ;;;; Commands | |
397 | ;;;; | |
398 | ||
fae99944 | 399 | ;;;###autoload |
87cf8421 SM |
400 | (defun comment-indent-default () |
401 | "Default for `comment-indent-function'." | |
d3fcda22 SM |
402 | (if (and (looking-at "\\s<\\s<\\(\\s<\\)?") |
403 | (or (match-end 1) (/= (current-column) (current-indentation)))) | |
404 | 0 | |
87cf8421 SM |
405 | (when (or (/= (current-column) (current-indentation)) |
406 | (and (> comment-add 0) (looking-at "\\s<\\S<"))) | |
407 | comment-column))) | |
408 | ||
be83ecb2 | 409 | ;;;###autoload |
3e569d22 | 410 | (defun comment-indent (&optional continue) |
2ab98065 SM |
411 | "Indent this line's comment to comment column, or insert an empty comment. |
412 | If CONTINUE is non-nil, use the `comment-continuation' markers if any." | |
83b96b22 | 413 | (interactive "*") |
ad679e45 | 414 | (comment-normalize-vars) |
83b96b22 SM |
415 | (let* ((empty (save-excursion (beginning-of-line) |
416 | (looking-at "[ \t]*$"))) | |
f5215400 | 417 | (starter (or (and continue comment-continue) |
2ab98065 | 418 | (and empty block-comment-start) comment-start)) |
f5215400 | 419 | (ender (or (and continue comment-continue "") |
2ab98065 | 420 | (and empty block-comment-end) comment-end))) |
2e1fbba4 SM |
421 | (unless starter (error "No comment syntax defined")) |
422 | (beginning-of-line) | |
423 | (let* ((eolpos (line-end-position)) | |
424 | (begpos (comment-search-forward eolpos t)) | |
425 | cpos indent) | |
426 | ;; An existing comment? | |
427 | (if begpos (setq cpos (point-marker)) | |
428 | ;; If none, insert one. | |
429 | (save-excursion | |
430 | ;; Some comment-indent-function insist on not moving comments that | |
431 | ;; are in column 0, so we insert a space to avoid this special case | |
432 | (insert " ") | |
433 | (setq begpos (point)) | |
bb304a7a | 434 | (insert starter) |
2e1fbba4 SM |
435 | (setq cpos (point-marker)) |
436 | (insert ender))) | |
437 | (goto-char begpos) | |
438 | ;; Compute desired indent. | |
053b8d35 | 439 | (setq indent (save-excursion (funcall comment-indent-function))) |
2e1fbba4 SM |
440 | (if (not indent) |
441 | ;; comment-indent-function refuses delegates to indent. | |
442 | (indent-according-to-mode) | |
443 | ;; Avoid moving comments past the fill-column. | |
444 | (setq indent | |
445 | (min indent | |
446 | (+ (current-column) | |
447 | (- fill-column | |
448 | (save-excursion (end-of-line) (current-column)))))) | |
449 | (if (= (current-column) indent) | |
450 | (goto-char begpos) | |
451 | ;; If that's different from current, change it. | |
452 | (skip-chars-backward " \t") | |
453 | (delete-region (point) begpos) | |
454 | (indent-to (if (bolp) indent | |
455 | (max indent (1+ (current-column))))))) | |
456 | (goto-char cpos) | |
457 | (set-marker cpos nil)))) | |
83b96b22 | 458 | |
be83ecb2 | 459 | ;;;###autoload |
3e569d22 | 460 | (defun comment-set-column (arg) |
83b96b22 | 461 | "Set the comment column based on point. |
2ab98065 | 462 | With no ARG, set the comment column to the current column. |
83b96b22 SM |
463 | With just minus as arg, kill any comment on this line. |
464 | With any other arg, set comment column to indentation of the previous comment | |
465 | and then align or create a comment on this line at that column." | |
466 | (interactive "P") | |
e8fe7d39 | 467 | (cond |
ad679e45 | 468 | ((eq arg '-) (comment-kill nil)) |
e8fe7d39 SM |
469 | (arg |
470 | (save-excursion | |
471 | (beginning-of-line) | |
2ab98065 | 472 | (comment-search-backward) |
e8fe7d39 | 473 | (beginning-of-line) |
ad679e45 | 474 | (goto-char (comment-search-forward (line-end-position))) |
83b96b22 | 475 | (setq comment-column (current-column)) |
e8fe7d39 | 476 | (message "Comment column set to %d" comment-column)) |
ad679e45 | 477 | (comment-indent)) |
e8fe7d39 | 478 | (t (setq comment-column (current-column)) |
83b96b22 SM |
479 | (message "Comment column set to %d" comment-column)))) |
480 | ||
be83ecb2 | 481 | ;;;###autoload |
3e569d22 | 482 | (defun comment-kill (arg) |
7a0a180a SM |
483 | "Kill the comment on this line, if any. |
484 | With prefix ARG, kill comments on that many lines starting with this one." | |
485 | (interactive "P") | |
ad679e45 SM |
486 | (dotimes (_ (prefix-numeric-value arg)) |
487 | (save-excursion | |
488 | (beginning-of-line) | |
489 | (let ((cs (comment-search-forward (line-end-position) t))) | |
490 | (when cs | |
491 | (goto-char cs) | |
492 | (skip-syntax-backward " ") | |
493 | (setq cs (point)) | |
494 | (comment-forward) | |
495 | (kill-region cs (if (bolp) (1- (point)) (point))) | |
496 | (indent-according-to-mode)))) | |
497 | (if arg (forward-line 1)))) | |
7a0a180a | 498 | |
2ab98065 SM |
499 | (defun comment-padright (str &optional n) |
500 | "Construct a string composed of STR plus `comment-padding'. | |
f5215400 | 501 | It also adds N copies of the last non-whitespace chars of STR. |
2ab98065 | 502 | If STR already contains padding, the corresponding amount is |
f5215400 SM |
503 | ignored from `comment-padding'. |
504 | N defaults to 0. | |
771c9b97 | 505 | If N is `re', a regexp is returned instead, that would match |
f5215400 | 506 | the string for any N." |
2ab98065 SM |
507 | (setq n (or n 0)) |
508 | (when (and (stringp str) (not (string= "" str))) | |
f5215400 | 509 | ;; Separate the actual string from any leading/trailing padding |
3e569d22 | 510 | (string-match "\\`\\s-*\\(.*?\\)\\s-*\\'" str) |
f5215400 SM |
511 | (let ((s (match-string 1 str)) ;actual string |
512 | (lpad (substring str 0 (match-beginning 1))) ;left padding | |
513 | (rpad (concat (substring str (match-end 1)) ;original right padding | |
514 | (substring comment-padding ;additional right padding | |
3e569d22 | 515 | (min (- (match-end 0) (match-end 1)) |
9b0d1d6e SM |
516 | (length comment-padding))))) |
517 | ;; We can only duplicate C if the comment-end has multiple chars | |
518 | ;; or if comments can be nested, else the comment-end `}' would | |
519 | ;; be turned into `}}}' where only the first ends the comment | |
520 | ;; and the rest becomes bogus junk. | |
521 | (multi (not (and comment-quote-nested | |
522 | ;; comment-end is a single char | |
523 | (string-match "\\`\\s-*\\S-\\s-*\\'" comment-end))))) | |
f5215400 | 524 | (if (not (symbolp n)) |
9b0d1d6e | 525 | (concat lpad s (when multi (make-string n (aref str (1- (match-end 1))))) rpad) |
f5215400 SM |
526 | ;; construct a regexp that would match anything from just S |
527 | ;; to any possible output of this function for any N. | |
528 | (concat (mapconcat (lambda (c) (concat (regexp-quote (string c)) "?")) | |
529 | lpad "") ;padding is not required | |
9b0d1d6e SM |
530 | (regexp-quote s) |
531 | (when multi "+") ;the last char of S might be repeated | |
f5215400 SM |
532 | (mapconcat (lambda (c) (concat (regexp-quote (string c)) "?")) |
533 | rpad "")))))) ;padding is not required | |
2ab98065 SM |
534 | |
535 | (defun comment-padleft (str &optional n) | |
536 | "Construct a string composed of `comment-padding' plus STR. | |
f5215400 | 537 | It also adds N copies of the first non-whitespace chars of STR. |
2ab98065 | 538 | If STR already contains padding, the corresponding amount is |
f5215400 SM |
539 | ignored from `comment-padding'. |
540 | N defaults to 0. | |
771c9b97 | 541 | If N is `re', a regexp is returned instead, that would match |
2ab98065 SM |
542 | the string for any N." |
543 | (setq n (or n 0)) | |
544 | (when (and (stringp str) (not (string= "" str))) | |
f5215400 | 545 | ;; Only separate the left pad because we assume there is no right pad. |
2ab98065 SM |
546 | (string-match "\\`\\s-*" str) |
547 | (let ((s (substring str (match-end 0))) | |
548 | (pad (concat (substring comment-padding | |
549 | (min (- (match-end 0) (match-beginning 0)) | |
550 | (length comment-padding))) | |
551 | (match-string 0 str))) | |
f5215400 SM |
552 | (c (aref str (match-end 0))) ;the first non-space char of STR |
553 | ;; We can only duplicate C if the comment-end has multiple chars | |
554 | ;; or if comments can be nested, else the comment-end `}' would | |
555 | ;; be turned into `}}}' where only the first ends the comment | |
556 | ;; and the rest becomes bogus junk. | |
557 | (multi (not (and comment-quote-nested | |
558 | ;; comment-end is a single char | |
559 | (string-match "\\`\\s-*\\S-\\s-*\\'" comment-end))))) | |
560 | (if (not (symbolp n)) | |
561 | (concat pad (when multi (make-string n c)) s) | |
562 | ;; Construct a regexp that would match anything from just S | |
563 | ;; to any possible output of this function for any N. | |
564 | ;; We match any number of leading spaces because this regexp will | |
565 | ;; be used for uncommenting where we might want to remove | |
566 | ;; uncomment markers with arbitrary leading space (because | |
567 | ;; they were aligned). | |
568 | (concat "\\s-*" | |
569 | (if multi (concat (regexp-quote (string c)) "*")) | |
570 | (regexp-quote s)))))) | |
83b96b22 | 571 | |
be83ecb2 | 572 | ;;;###autoload |
7a0a180a SM |
573 | (defun uncomment-region (beg end &optional arg) |
574 | "Uncomment each line in the BEG..END region. | |
f5215400 SM |
575 | The numeric prefix ARG can specify a number of chars to remove from the |
576 | comment markers." | |
83b96b22 SM |
577 | (interactive "*r\nP") |
578 | (comment-normalize-vars) | |
579 | (if (> beg end) (let (mid) (setq mid beg beg end end mid))) | |
580 | (save-excursion | |
7a0a180a | 581 | (goto-char beg) |
f5215400 | 582 | (setq end (copy-marker end)) |
7a0a180a | 583 | (let ((numarg (prefix-numeric-value arg)) |
2ab98065 | 584 | spt) |
7a0a180a | 585 | (while (and (< (point) end) |
2ab98065 SM |
586 | (setq spt (comment-search-forward end t))) |
587 | (let* ((ipt (point)) | |
f5215400 | 588 | ;; Find the end of the comment. |
e8fe7d39 | 589 | (ept (progn |
2ab98065 SM |
590 | (goto-char spt) |
591 | (unless (comment-forward) | |
e8fe7d39 | 592 | (error "Can't find the comment end")) |
f5215400 SM |
593 | (point))) |
594 | (box nil) | |
595 | (ccs comment-continue) | |
2ab98065 | 596 | (srei (comment-padright ccs 're)) |
3e569d22 | 597 | (sre (and srei (concat "^\\s-*?\\(" srei "\\)")))) |
e8fe7d39 SM |
598 | (save-restriction |
599 | (narrow-to-region spt ept) | |
f5215400 | 600 | ;; Remove the comment-start. |
2ab98065 SM |
601 | (goto-char ipt) |
602 | (skip-syntax-backward " ") | |
9b0d1d6e SM |
603 | ;; Check for special `=' used sometimes in comment-box. |
604 | (when (and (= (- (point) (point-min)) 1) (looking-at "=\\{7\\}")) | |
605 | (skip-chars-forward "=")) | |
f5215400 | 606 | ;; A box-comment starts with a looong comment-start marker. |
2ab98065 | 607 | (when (> (- (point) (point-min) (length comment-start)) 7) |
f5215400 | 608 | (setq box t)) |
2ab98065 SM |
609 | (when (looking-at (regexp-quote comment-padding)) |
610 | (goto-char (match-end 0))) | |
611 | (when (and sre (looking-at (concat "\\s-*\n\\s-*" srei))) | |
612 | (goto-char (match-end 0))) | |
3e569d22 SM |
613 | (if (null arg) (delete-region (point-min) (point)) |
614 | (skip-syntax-backward " ") | |
615 | (delete-char (- numarg))) | |
2ab98065 | 616 | |
f5215400 | 617 | ;; Remove the end-comment (and leading padding and such). |
2ab98065 | 618 | (goto-char (point-max)) (comment-enter-backward) |
9b0d1d6e | 619 | ;; Check for special `=' used sometimes in comment-box. |
6dcd3806 SM |
620 | (when (= (- (point-max) (point)) 1) |
621 | (let ((pos (point))) | |
622 | ;; skip `=' but only if there are at least 7. | |
623 | (when (> (skip-chars-backward "=") -7) (goto-char pos)))) | |
9b0d1d6e | 624 | (unless (looking-at "\\(\n\\|\\s-\\)*\\'") |
2ab98065 | 625 | (when (and (bolp) (not (bobp))) (backward-char)) |
f5215400 | 626 | (if (null arg) (delete-region (point) (point-max)) |
3e569d22 SM |
627 | (skip-syntax-forward " ") |
628 | (delete-char numarg))) | |
e8fe7d39 | 629 | |
f5215400 SM |
630 | ;; Unquote any nested end-comment. |
631 | (comment-quote-nested comment-start comment-end t) | |
632 | ||
633 | ;; Eliminate continuation markers as well. | |
634 | (when sre | |
635 | (let* ((cce (comment-string-reverse (or comment-continue | |
636 | comment-start))) | |
637 | (erei (and box (comment-padleft cce 're))) | |
638 | (ere (and erei (concat "\\(" erei "\\)\\s-*$")))) | |
7a0a180a | 639 | (goto-char (point-min)) |
f5215400 SM |
640 | (while (progn |
641 | (if (and ere (re-search-forward | |
642 | ere (line-end-position) t)) | |
643 | (replace-match "" t t nil (if (match-end 2) 2 1)) | |
644 | (setq ere nil)) | |
645 | (forward-line 1) | |
646 | (re-search-forward sre (line-end-position) t)) | |
2ab98065 | 647 | (replace-match "" t t nil (if (match-end 2) 2 1))))) |
f5215400 SM |
648 | ;; Go the the end for the next comment. |
649 | (goto-char (point-max))))) | |
650 | (set-marker end nil)))) | |
83b96b22 | 651 | |
aac88001 | 652 | (defun comment-make-extra-lines (cs ce ccs cce min-indent max-indent &optional block) |
ad679e45 SM |
653 | "Make the leading and trailing extra lines. |
654 | This is used for `extra-line' style (or `box' style if BLOCK is specified)." | |
9b0d1d6e SM |
655 | (let ((eindent 0)) |
656 | (if (not block) | |
657 | ;; Try to match CS and CE's content so they align aesthetically. | |
658 | (progn | |
659 | (setq ce (comment-string-strip ce t t)) | |
660 | (when (string-match "\\(.+\\).*\n\\(.*?\\)\\1" (concat ce "\n" cs)) | |
661 | (setq eindent | |
662 | (max (- (match-end 2) (match-beginning 2) (match-beginning 0)) | |
663 | 0)))) | |
664 | ;; box comment | |
665 | (let* ((width (- max-indent min-indent)) | |
666 | (s (concat cs "a=m" cce)) | |
667 | (e (concat ccs "a=m" ce)) | |
668 | (c (if (string-match ".*\\S-\\S-" cs) | |
669 | (aref cs (1- (match-end 0))) ?=)) | |
3fc5b4e2 | 670 | (_ (string-match "\\s-*a=m\\s-*" s)) |
9b0d1d6e SM |
671 | (fill |
672 | (make-string (+ width (- (match-end 0) | |
673 | (match-beginning 0) (length cs) 3)) c))) | |
aac88001 | 674 | (setq cs (replace-match fill t t s)) |
3fc5b4e2 | 675 | (string-match "\\s-*a=m\\s-*" e) |
9b0d1d6e SM |
676 | (setq ce (replace-match fill t t e)))) |
677 | (cons (concat cs "\n" (make-string min-indent ? ) ccs) | |
678 | (concat cce "\n" (make-string (+ min-indent eindent) ? ) ce)))) | |
aac88001 SM |
679 | |
680 | (def-edebug-spec comment-with-narrowing t) | |
681 | (put 'comment-with-narrowing 'lisp-indent-function 2) | |
682 | (defmacro comment-with-narrowing (beg end &rest body) | |
683 | "Execute BODY with BEG..END narrowing. | |
684 | Space is added (and then removed) at the beginning for the text's | |
685 | indentation to be kept as it was before narrowing." | |
59a1ce8d SM |
686 | (let ((bindent (make-symbol "bindent"))) |
687 | `(let ((,bindent (save-excursion (goto-char beg) (current-column)))) | |
688 | (save-restriction | |
689 | (narrow-to-region beg end) | |
690 | (goto-char (point-min)) | |
691 | (insert (make-string ,bindent ? )) | |
692 | (prog1 | |
693 | (progn ,@body) | |
694 | ;; remove the bindent | |
695 | (save-excursion | |
696 | (goto-char (point-min)) | |
697 | (when (looking-at " *") | |
698 | (let ((n (min (- (match-end 0) (match-beginning 0)) ,bindent))) | |
aac88001 | 699 | (delete-char n) |
59a1ce8d SM |
700 | (setq ,bindent (- ,bindent n)))) |
701 | (end-of-line) | |
702 | (let ((e (point))) | |
703 | (beginning-of-line) | |
704 | (while (and (> ,bindent 0) (re-search-forward " *" e t)) | |
705 | (let ((n (min ,bindent (- (match-end 0) (match-beginning 0) 1)))) | |
706 | (goto-char (match-beginning 0)) | |
707 | (delete-char n) | |
708 | (setq ,bindent (- ,bindent n))))))))))) | |
aac88001 | 709 | |
771c9b97 SM |
710 | (defun comment-region-internal (beg end cs ce |
711 | &optional ccs cce block lines indent) | |
f5215400 | 712 | "Comment region BEG..END. |
4125ec7e SM |
713 | CS and CE are the comment start resp end string. |
714 | CCS and CCE are the comment continuation strings for the start resp end | |
f5215400 SM |
715 | of lines (default to CS and CE). |
716 | BLOCK indicates that end of lines should be marked with either CCE, CE or CS | |
717 | \(if CE is empty) and that those markers should be aligned. | |
718 | LINES indicates that an extra lines will be used at the beginning and end | |
719 | of the region for CE and CS. | |
720 | INDENT indicates to put CS and CCS at the current indentation of the region | |
721 | rather than at left margin." | |
59a1ce8d | 722 | ;;(assert (< beg end)) |
83b96b22 | 723 | (let ((no-empty t)) |
f5215400 | 724 | ;; Sanitize CE and CCE. |
83b96b22 SM |
725 | (if (and (stringp ce) (string= "" ce)) (setq ce nil)) |
726 | (if (and (stringp cce) (string= "" cce)) (setq cce nil)) | |
f5215400 SM |
727 | ;; If CE is empty, multiline cannot be used. |
728 | (unless ce (setq ccs nil cce nil)) | |
729 | ;; Should we mark empty lines as well ? | |
83b96b22 | 730 | (if (or ccs block lines) (setq no-empty nil)) |
f5215400 | 731 | ;; Make sure we have end-markers for BLOCK mode. |
2ab98065 | 732 | (when block (unless ce (setq ce (comment-string-reverse cs)))) |
f5215400 SM |
733 | ;; If BLOCK is not requested, we don't need CCE. |
734 | (unless block (setq cce nil)) | |
735 | ;; Continuation defaults to the same as CS and CE. | |
736 | (unless ccs (setq ccs cs cce ce)) | |
7a0a180a | 737 | |
83b96b22 | 738 | (save-excursion |
aac88001 | 739 | (goto-char end) |
f5215400 SM |
740 | ;; If the end is not at the end of a line and the comment-end |
741 | ;; is implicit (i.e. a newline), explicitly insert a newline. | |
aac88001 SM |
742 | (unless (or ce (eolp)) (insert "\n") (indent-according-to-mode)) |
743 | (comment-with-narrowing beg end | |
f5215400 | 744 | (let ((min-indent (point-max)) |
83b96b22 SM |
745 | (max-indent 0)) |
746 | (goto-char (point-min)) | |
f5215400 SM |
747 | ;; Quote any nested comment marker |
748 | (comment-quote-nested comment-start comment-end nil) | |
749 | ||
750 | ;; Loop over all lines to find the needed indentations. | |
4125ec7e | 751 | (goto-char (point-min)) |
f5215400 SM |
752 | (while |
753 | (progn | |
754 | (unless (looking-at "[ \t]*$") | |
755 | (setq min-indent (min min-indent (current-indentation)))) | |
756 | (end-of-line) | |
757 | (setq max-indent (max max-indent (current-column))) | |
758 | (not (or (eobp) (progn (forward-line) nil))))) | |
759 | ||
760 | ;; Inserting ccs can change max-indent by (1- tab-width). | |
59a1ce8d SM |
761 | (setq max-indent |
762 | (+ max-indent (max (length cs) (length ccs)) tab-width -1)) | |
771c9b97 | 763 | (unless indent (setq min-indent 0)) |
83b96b22 | 764 | |
aac88001 | 765 | ;; make the leading and trailing lines if requested |
83b96b22 | 766 | (when lines |
771c9b97 SM |
767 | (let ((csce |
768 | (comment-make-extra-lines | |
769 | cs ce ccs cce min-indent max-indent block))) | |
770 | (setq cs (car csce)) | |
771 | (setq ce (cdr csce)))) | |
83b96b22 SM |
772 | |
773 | (goto-char (point-min)) | |
774 | ;; Loop over all lines from BEG to END. | |
f5215400 SM |
775 | (while |
776 | (progn | |
777 | (unless (and no-empty (looking-at "[ \t]*$")) | |
778 | (move-to-column min-indent t) | |
779 | (insert cs) (setq cs ccs) ;switch to CCS after the first line | |
780 | (end-of-line) | |
781 | (if (eobp) (setq cce ce)) | |
782 | (when cce | |
783 | (when block (move-to-column max-indent t)) | |
784 | (insert cce))) | |
785 | (end-of-line) | |
786 | (not (or (eobp) (progn (forward-line) nil)))))))))) | |
83b96b22 | 787 | |
be83ecb2 | 788 | ;;;###autoload |
83b96b22 SM |
789 | (defun comment-region (beg end &optional arg) |
790 | "Comment or uncomment each line in the region. | |
39cb51e7 | 791 | With just \\[universal-argument] prefix arg, uncomment each line in region BEG..END. |
83b96b22 SM |
792 | Numeric prefix arg ARG means use ARG comment characters. |
793 | If ARG is negative, delete that many comment characters instead. | |
be83ecb2 SM |
794 | By default, comments start at the left margin, are terminated on each line, |
795 | even for syntax in which newline does not end the comment and blank lines | |
796 | do not get comments. This can be changed with `comment-style'. | |
83b96b22 SM |
797 | |
798 | The strings used as comment starts are built from | |
799 | `comment-start' without trailing spaces and `comment-padding'." | |
800 | (interactive "*r\nP") | |
801 | (comment-normalize-vars) | |
802 | (if (> beg end) (let (mid) (setq mid beg beg end end mid))) | |
2ab98065 | 803 | (let* ((numarg (prefix-numeric-value arg)) |
771c9b97 | 804 | (add comment-add) |
2ab98065 SM |
805 | (style (cdr (assoc comment-style comment-styles))) |
806 | (lines (nth 2 style)) | |
807 | (block (nth 1 style)) | |
808 | (multi (nth 0 style))) | |
83b96b22 SM |
809 | (save-excursion |
810 | ;; we use `chars' instead of `syntax' because `\n' might be | |
811 | ;; of end-comment syntax rather than of whitespace syntax. | |
812 | ;; sanitize BEG and END | |
813 | (goto-char beg) (skip-chars-forward " \t\n\r") (beginning-of-line) | |
814 | (setq beg (max beg (point))) | |
815 | (goto-char end) (skip-chars-backward " \t\n\r") (end-of-line) | |
816 | (setq end (min end (point))) | |
817 | (if (>= beg end) (error "Nothing to comment")) | |
818 | ||
83b96b22 SM |
819 | ;; sanitize LINES |
820 | (setq lines | |
821 | (and | |
9b0d1d6e | 822 | lines ;; multi |
83b96b22 SM |
823 | (progn (goto-char beg) (beginning-of-line) |
824 | (skip-syntax-forward " ") | |
825 | (>= (point) beg)) | |
826 | (progn (goto-char end) (end-of-line) (skip-syntax-backward " ") | |
827 | (<= (point) end)) | |
771c9b97 | 828 | (or (not (string= "" comment-end)) block) |
2ab98065 | 829 | (progn (goto-char beg) (search-forward "\n" end t))))) |
83b96b22 | 830 | |
2ab98065 SM |
831 | ;; don't add end-markers just because the user asked for `block' |
832 | (unless (or lines (string= "" comment-end)) (setq block nil)) | |
833 | ||
83b96b22 SM |
834 | (cond |
835 | ((consp arg) (uncomment-region beg end)) | |
836 | ((< numarg 0) (uncomment-region beg end (- numarg))) | |
837 | (t | |
59a1ce8d SM |
838 | (setq numarg (if (and (null arg) (= (length comment-start) 1)) |
839 | add (1- numarg))) | |
83b96b22 SM |
840 | (comment-region-internal |
841 | beg end | |
3e569d22 SM |
842 | (let ((s (comment-padright comment-start numarg))) |
843 | (if (string-match comment-start-skip s) s | |
844 | (comment-padright comment-start))) | |
845 | (let ((s (comment-padleft comment-end numarg))) | |
846 | (and s (if (string-match comment-end-skip s) s | |
847 | (comment-padright comment-end)))) | |
f5215400 SM |
848 | (if multi (comment-padright comment-continue numarg)) |
849 | (if multi (comment-padleft (comment-string-reverse comment-continue) numarg)) | |
83b96b22 | 850 | block |
771c9b97 SM |
851 | lines |
852 | (nth 3 style)))))) | |
853 | ||
854 | (defun comment-box (beg end &optional arg) | |
855 | "Comment out the BEG..END region, putting it inside a box. | |
856 | The numeric prefix ARG specifies how many characters to add to begin- and | |
857 | end- comment markers additionally to what `comment-add' already specifies." | |
858 | (interactive "*r\np") | |
9b0d1d6e SM |
859 | (let ((comment-style (if (cadr (assoc comment-style comment-styles)) |
860 | 'box-multi 'box))) | |
771c9b97 | 861 | (comment-region beg end (+ comment-add arg)))) |
83b96b22 | 862 | |
be83ecb2 | 863 | ;;;###autoload |
2ab98065 | 864 | (defun comment-dwim (arg) |
ad679e45 SM |
865 | "Call the comment command you want (Do What I Mean). |
866 | If the region is active and `transient-mark-mode' is on, call | |
39cb51e7 | 867 | `comment-region' (unless it only consists of comments, in which |
ad679e45 | 868 | case it calls `uncomment-region'). |
2ab98065 | 869 | Else, if the current line is empty, insert a comment and indent it. |
ad679e45 SM |
870 | Else if a prefix ARG is specified, call `comment-kill'. |
871 | Else, call `comment-indent'." | |
2ab98065 SM |
872 | (interactive "*P") |
873 | (comment-normalize-vars) | |
771c9b97 | 874 | (if (and mark-active transient-mark-mode) |
2ab98065 SM |
875 | (let ((beg (min (point) (mark))) |
876 | (end (max (point) (mark)))) | |
877 | (if (save-excursion ;; check for already commented region | |
878 | (goto-char beg) | |
879 | (comment-forward (point-max)) | |
880 | (<= end (point))) | |
881 | (uncomment-region beg end arg) | |
882 | (comment-region beg end arg))) | |
883 | (if (save-excursion (beginning-of-line) (not (looking-at "\\s-*$"))) | |
ad679e45 SM |
884 | ;; FIXME: If there's no comment to kill on this line and ARG is |
885 | ;; specified, calling comment-kill is not very clever. | |
886 | (if arg (comment-kill (and (integerp arg) arg)) (comment-indent)) | |
2ab98065 | 887 | (let ((add (if arg (prefix-numeric-value arg) |
771c9b97 | 888 | (if (= (length comment-start) 1) comment-add 0)))) |
2e1fbba4 SM |
889 | ;; Some modes insist on keeping column 0 comment in column 0 |
890 | ;; so we need to move away from it before inserting the comment. | |
891 | (indent-according-to-mode) | |
2ab98065 SM |
892 | (insert (comment-padright comment-start add)) |
893 | (save-excursion | |
894 | (unless (string= "" comment-end) | |
895 | (insert (comment-padleft comment-end add))) | |
896 | (indent-according-to-mode)))))) | |
897 | ||
392f1ef5 SM |
898 | (defcustom comment-auto-fill-only-comments nil |
899 | "Non-nil means to only auto-fill inside comments. | |
900 | This has no effect in modes that do not define a comment syntax." | |
901 | :type 'boolean | |
902 | :group 'comment) | |
903 | ||
be83ecb2 | 904 | ;;;###autoload |
ad679e45 | 905 | (defun comment-indent-new-line (&optional soft) |
2ab98065 SM |
906 | "Break line at point and indent, continuing comment if within one. |
907 | This indents the body of the continued comment | |
908 | under the previous comment line. | |
909 | ||
910 | This command is intended for styles where you write a comment per line, | |
911 | starting a new comment (and terminating it if necessary) on each line. | |
912 | If you want to continue one comment across several lines, use \\[newline-and-indent]. | |
913 | ||
914 | If a fill column is specified, it overrides the use of the comment column | |
915 | or comment indentation. | |
916 | ||
917 | The inserted newline is marked hard if variable `use-hard-newlines' is true, | |
918 | unless optional argument SOFT is non-nil." | |
919 | (interactive) | |
920 | (comment-normalize-vars t) | |
59a1ce8d SM |
921 | (let (compos comin) |
922 | ;; If we are not inside a comment and we only auto-fill comments, | |
923 | ;; don't do anything (unless no comment syntax is defined). | |
392f1ef5 SM |
924 | (unless (and comment-start |
925 | comment-auto-fill-only-comments | |
926 | (not (save-excursion | |
59a1ce8d | 927 | (prog1 (setq compos (comment-beginning)) |
392f1ef5 | 928 | (setq comin (point)))))) |
59a1ce8d SM |
929 | |
930 | ;; Now we know we should auto-fill. | |
392f1ef5 | 931 | (delete-region (progn (skip-chars-backward " \t") (point)) |
59a1ce8d | 932 | (progn (skip-chars-forward " \t") (point))) |
392f1ef5 SM |
933 | (if soft (insert-and-inherit ?\n) (newline 1)) |
934 | (if fill-prefix | |
935 | (progn | |
936 | (indent-to-left-margin) | |
937 | (insert-and-inherit fill-prefix)) | |
59a1ce8d SM |
938 | |
939 | ;; If necessary check whether we're inside a comment. | |
940 | (unless (or comment-multi-line compos (null comment-start)) | |
392f1ef5 SM |
941 | (save-excursion |
942 | (backward-char) | |
59a1ce8d SM |
943 | (setq compos (comment-beginning)) |
944 | (setq comin (point)))) | |
945 | ||
946 | ;; If we're not inside a comment, just try to indent. | |
947 | (if (not compos) (indent-according-to-mode) | |
948 | (let* ((comment-column | |
949 | ;; The continuation indentation should be somewhere between | |
950 | ;; the current line's indentation (plus 2 for good measure) | |
951 | ;; and the current comment's indentation, with a preference | |
952 | ;; for comment-column. | |
953 | (save-excursion | |
954 | (goto-char compos) | |
955 | (min (current-column) (max comment-column | |
956 | (+ 2 (current-indentation)))))) | |
957 | (comstart (buffer-substring compos comin)) | |
958 | (normalp | |
959 | (string-match (regexp-quote (comment-string-strip | |
960 | comment-start t t)) | |
961 | comstart)) | |
962 | (comment-end | |
963 | (if normalp comment-end | |
964 | ;; The comment starter is not the normal comment-start | |
965 | ;; so we can't just use comment-end. | |
966 | (save-excursion | |
967 | (goto-char compos) | |
968 | (if (not (comment-forward)) comment-end | |
969 | (comment-string-strip | |
970 | (buffer-substring | |
971 | (save-excursion (comment-enter-backward) (point)) | |
972 | (point)) | |
973 | nil t))))) | |
974 | (comment-start comstart) | |
975 | ;; Force comment-continue to be recreated from comment-start. | |
976 | (comment-continue nil)) | |
977 | (insert-and-inherit ?\n) | |
978 | (forward-char -1) | |
979 | (comment-indent (cadr (assoc comment-style comment-styles))) | |
980 | (save-excursion | |
981 | (let ((pt (point))) | |
982 | (end-of-line) | |
983 | (let ((comend (buffer-substring pt (point)))) | |
984 | ;; The 1+ is to make sure we delete the \n inserted above. | |
985 | (delete-region pt (1+ (point))) | |
986 | (beginning-of-line) | |
987 | (backward-char) | |
988 | (insert comend) | |
989 | (forward-char)))))))))) | |
2ab98065 | 990 | |
83b96b22 SM |
991 | (provide 'newcomment) |
992 | ||
83b96b22 | 993 | ;;; newcomment.el ends here |