(mouse-popup-menubar, mouse-buffer-menu-alist): "?\ " -> "?\s".
[bpt/emacs.git] / lisp / newcomment.el
CommitLineData
83b96b22
SM
1;;; newcomment.el --- (un)comment regions of buffers
2
0d30b337 3;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
ae2c9c21 4;; 2005, 2006 Free Software Foundation, Inc.
83b96b22 5
59a1ce8d 6;; Author: code extracted from Emacs-20's simple.el
e8bf8343 7;; Maintainer: Stefan Monnier <monnier@iro.umontreal.ca>
83b96b22 8;; Keywords: comment uncomment
83b96b22 9
59a1ce8d
SM
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
83b96b22 13;; it under the terms of the GNU General Public License as published by
59a1ce8d
SM
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
83b96b22
SM
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
59a1ce8d 21
83b96b22 22;; You should have received a copy of the GNU General Public License
59a1ce8d 23;; along with GNU Emacs; see the file COPYING. If not, write to the
086add15
LK
24;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25;; Boston, MA 02110-1301, USA.
83b96b22
SM
26
27;;; Commentary:
28
771c9b97 29;; A replacement for simple.el's comment-related functions.
83b96b22
SM
30
31;;; Bugs:
32
3674a4a9
SM
33;; - boxed comments in Perl are not properly uncommented because they are
34;; uncommented one-line at a time.
75e95a97 35;; - nested comments in sgml-mode are not properly quoted.
2ab98065
SM
36;; - single-char nestable comment-start can only do the "\\s<+" stuff
37;; if the corresponding closing marker happens to be right.
3e569d22
SM
38;; - uncomment-region with a numeric argument can render multichar
39;; comment markers invalid.
3fc5b4e2
SM
40;; - comment-indent or comment-region when called inside a comment
41;; will happily break the surrounding comment.
42;; - comment-quote-nested will not (un)quote properly all nested comment
43;; markers if there are more than just comment-start and comment-end.
44;; For example, in Pascal where {...*) and (*...} are possible.
83b96b22
SM
45
46;;; Todo:
47
3674a4a9
SM
48;; - rebox.el-style refill.
49;; - quantized steps in comment-alignment.
50;; - try to align tail comments.
51;; - check what c-comment-line-break-function has to say.
52;; - spill auto-fill of comments onto the end of the next line.
7a0a180a 53;; - uncomment-region with a consp (for blocks) or somehow make the
3674a4a9
SM
54;; deletion of continuation markers less dangerous.
55;; - drop block-comment-<foo> unless it's really used.
56;; - uncomment-region on a subpart of a comment.
57;; - support gnu-style "multi-line with space in continue".
771c9b97
SM
58;; - somehow allow comment-dwim to use the region even if transient-mark-mode
59;; is not turned on.
83b96b22 60
bdbe3a89
SM
61;; - when auto-filling a comment, try to move the comment to the left
62;; rather than break it (if possible).
63;; - sometimes default the comment-column to the same
64;; one used on the preceding line(s).
65
83b96b22
SM
66;;; Code:
67
be83ecb2 68;;;###autoload
59a1ce8d 69(defalias 'indent-for-comment 'comment-indent)
be83ecb2 70;;;###autoload
59a1ce8d 71(defalias 'set-comment-column 'comment-set-column)
be83ecb2 72;;;###autoload
59a1ce8d 73(defalias 'kill-comment 'comment-kill)
be83ecb2 74;;;###autoload
59a1ce8d 75(defalias 'indent-new-comment-line 'comment-indent-new-line)
83b96b22 76
3e569d22
SM
77(defgroup comment nil
78 "Indenting and filling of comments."
79 :prefix "comment-"
ac87b3a9 80 :version "21.1"
3e569d22
SM
81 :group 'fill)
82
75975685
RS
83;; Autoload this to avoid warnings, since some major modes define it.
84;;;###autoload
771c9b97
SM
85(defvar comment-use-syntax 'undecided
86 "Non-nil if syntax-tables can be used instead of regexps.
87Can also be `undecided' which means that a somewhat expensive test will
88be used to try to determine whether syntax-tables should be trusted
f5215400
SM
89to understand comments or not in the given buffer.
90Major modes should set this variable.")
2ab98065 91
88fe06af
SM
92(defcustom comment-fill-column nil
93 "Column to use for `comment-indent'. If nil, use `fill-column' instead."
f5307782
JB
94 :type '(choice (const nil) integer)
95 :group 'comment)
88fe06af 96
be83ecb2 97;;;###autoload
83b96b22 98(defcustom comment-column 32
ae2c9c21 99 "Column to indent right-margin comments to.
83b96b22 100Each mode establishes a different default value for this variable; you
a704fec0
SM
101can set the value for a particular mode using that mode's hook.
102Comments might be indented to a value smaller than this in order
88fe06af 103not to go beyond `comment-fill-column'."
f5307782
JB
104 :type 'integer
105 :group 'comment)
83b96b22 106(make-variable-buffer-local 'comment-column)
631c8020 107;;;###autoload(put 'comment-column 'safe-local-variable 'integerp)
83b96b22 108
be83ecb2 109;;;###autoload
f5215400
SM
110(defvar comment-start nil
111 "*String to insert to start a new comment, or nil if no comment syntax.")
be2c62b3 112;;;###autoload(put 'comment-start 'safe-local-variable 'string-or-null-p)
83b96b22 113
be83ecb2 114;;;###autoload
f5215400 115(defvar comment-start-skip nil
83b96b22
SM
116 "*Regexp to match the start of a comment plus everything up to its body.
117If there are any \\(...\\) pairs, the comment delimiter text is held to begin
f5215400 118at the place matched by the close of the first pair.")
be2c62b3 119;;;###autoload(put 'comment-start-skip 'safe-local-variable 'string-or-null-p)
771c9b97 120
be83ecb2 121;;;###autoload
3e569d22
SM
122(defvar comment-end-skip nil
123 "Regexp to match the end of a comment plus everything up to its body.")
be2c62b3 124;;;###autoload(put 'comment-end-skip 'safe-local-variable 'string-or-null-p)
83b96b22 125
be83ecb2 126;;;###autoload
f5215400 127(defvar comment-end ""
83b96b22 128 "*String to insert to end a new comment.
f5215400 129Should be an empty string if comments are terminated by end-of-line.")
be2c62b3 130;;;###autoload(put 'comment-end 'safe-local-variable 'string-or-null-p)
83b96b22 131
be83ecb2 132;;;###autoload
87cf8421 133(defvar comment-indent-function 'comment-indent-default
83b96b22
SM
134 "Function to compute desired indentation for a comment.
135This function is called with no args with point at the beginning of
87cf8421
SM
136the comment's starting delimiter and should return either the desired
137column indentation or nil.
138If nil is returned, indentation is delegated to `indent-according-to-mode'.")
83b96b22 139
a71b3805
EZ
140;;;###autoload
141(defvar comment-insert-comment-function nil
142 "Function to insert a comment when a line doesn't contain one.
143The function has no args.
144
145Applicable at least in modes for languages like fixed-format Fortran where
146comments always start in column zero.")
147
b70dd952 148(defvar comment-region-function 'comment-region-default
a71b3805
EZ
149 "Function to comment a region.
150Its args are the same as those of `comment-region', but BEG and END are
151guaranteed to be correctly ordered. It is called within `save-excursion'.
152
153Applicable at least in modes for languages like fixed-format Fortran where
154comments always start in column zero.")
155
b70dd952 156(defvar uncomment-region-function 'uncomment-region-default
a71b3805
EZ
157 "Function to uncomment a region.
158Its args are the same as those of `uncomment-region', but BEG and END are
159guaranteed to be correctly ordered. It is called within `save-excursion'.
160
161Applicable at least in modes for languages like fixed-format Fortran where
162comments always start in column zero.")
163
164;; ?? never set
3e569d22
SM
165(defvar block-comment-start nil)
166(defvar block-comment-end nil)
83b96b22 167
771c9b97
SM
168(defvar comment-quote-nested t
169 "Non-nil if nested comments should be quoted.
170This should be locally set by each major mode if needed.")
171
172(defvar comment-continue nil
f5215400
SM
173 "Continuation string to insert for multiline comments.
174This string will be added at the beginning of each line except the very
175first one when commenting a region with a commenting style that allows
176comments to span several lines.
177It should generally have the same length as `comment-start' in order to
178preserve indentation.
179If it is nil a value will be automatically derived from `comment-start'
180by replacing its first character with a space.")
181
771c9b97 182(defvar comment-add 0
f5215400
SM
183 "How many more comment chars should be inserted by `comment-region'.
184This determines the default value of the numeric argument of `comment-region'.
185This should generally stay 0, except for a few modes like Lisp where
186it can be convenient to set it to 1 so that regions are commented with
187two semi-colons.")
2ab98065 188
2ab98065 189(defconst comment-styles
771c9b97
SM
190 '((plain . (nil nil nil nil))
191 (indent . (nil nil nil t))
192 (aligned . (nil t nil t))
193 (multi-line . (t nil nil t))
194 (extra-line . (t nil t t))
9b0d1d6e
SM
195 (box . (nil t t t))
196 (box-multi . (t t t t)))
f5215400
SM
197 "Possible comment styles of the form (STYLE . (MULTI ALIGN EXTRA INDENT)).
198STYLE should be a mnemonic symbol.
199MULTI specifies that comments are allowed to span multiple lines.
200ALIGN specifies that the `comment-end' markers should be aligned.
201EXTRA specifies that an extra line should be used before and after the
202 region to comment (to put the `comment-end' and `comment-start').
203INDENT specifies that the `comment-start' markers should not be put at the
204 left margin but at the current indentation of the region to comment.")
205
be83ecb2 206;;;###autoload
f5215400 207(defcustom comment-style 'plain
ae2c9c21 208 "Style to be used for `comment-region'.
f5215400 209See `comment-styles' for a list of available styles."
be83ecb2
SM
210 :type (if (boundp 'comment-styles)
211 `(choice ,@(mapcar (lambda (s) `(const ,(car s))) comment-styles))
f5307782
JB
212 'symbol)
213 :group 'comment)
2ab98065 214
be83ecb2
SM
215;;;###autoload
216(defcustom comment-padding " "
f5215400
SM
217 "Padding string that `comment-region' puts between comment chars and text.
218Can also be an integer which will be automatically turned into a string
219of the corresponding number of spaces.
2ab98065
SM
220
221Extra spacing between the comment characters and the comment text
0603917d 222makes the comment easier to read. Default is 1. nil means 0."
f5307782
JB
223 :type '(choice string integer (const nil))
224 :group 'comment)
2ab98065 225
be83ecb2 226;;;###autoload
3e569d22 227(defcustom comment-multi-line nil
ae2c9c21 228 "Non-nil means `comment-indent-new-line' continues comments.
269a8f1c
LT
229That is, it inserts no new terminator or starter.
230This affects `auto-fill-mode', which is the main reason to
231customize this variable.
232
233It also affects \\[indent-new-comment-line]. However, if you want this
234behavior for explicit filling, you might as well use \\[newline-and-indent]."
f5307782
JB
235 :type 'boolean
236 :group 'comment)
3e569d22 237
6976bf99
SM
238(defcustom comment-empty-lines nil
239 "If nil, `comment-region' does not comment out empty lines.
240If t, it always comments out empty lines.
e29d96b6 241If `eol' it only comments out empty lines if comments are
6976bf99
SM
242terminated by the end of line (i.e. `comment-end' is empty)."
243 :type '(choice (const :tag "Never" nil)
244 (const :tag "Always" t)
f5307782
JB
245 (const :tag "EOl-terminated" 'eol))
246 :group 'comment)
6976bf99 247
2ab98065
SM
248;;;;
249;;;; Helpers
250;;;;
251
f5215400
SM
252(defun comment-string-strip (str beforep afterp)
253 "Strip STR of any leading (if BEFOREP) and/or trailing (if AFTERP) space."
254 (string-match (concat "\\`" (if beforep "\\s-*")
ad679e45 255 "\\(.*?\\)" (if afterp "\\s-*\n?")
2ab98065
SM
256 "\\'") str)
257 (match-string 1 str))
258
259(defun comment-string-reverse (s)
f5215400 260 "Return the mirror image of string S, without any trailing space."
771c9b97 261 (comment-string-strip (concat (nreverse (string-to-list s))) nil t))
2ab98065 262
7164ef13 263;;;###autoload
2ab98065 264(defun comment-normalize-vars (&optional noerror)
0f21c5a0
SM
265 "Check and setup the variables needed by other commenting functions.
266Functions autoloaded from newcomment.el, being entry points, should call
267this function before any other, so the rest of the code can assume that
268the variables are properly set."
0d6a08f6
SM
269 (unless (and (not comment-start) noerror)
270 (unless comment-start
31df2900
SM
271 (let ((cs (read-string "No comment syntax is defined. Use: ")))
272 (if (zerop (length cs))
273 (error "No comment syntax defined")
274 (set (make-local-variable 'comment-start) cs))))
2ab98065 275 ;; comment-use-syntax
771c9b97 276 (when (eq comment-use-syntax 'undecided)
2ab98065
SM
277 (set (make-local-variable 'comment-use-syntax)
278 (let ((st (syntax-table))
279 (cs comment-start)
280 (ce (if (string= "" comment-end) "\n" comment-end)))
771c9b97
SM
281 ;; Try to skip over a comment using forward-comment
282 ;; to see if the syntax tables properly recognize it.
2ab98065
SM
283 (with-temp-buffer
284 (set-syntax-table st)
285 (insert cs " hello " ce)
286 (goto-char (point-min))
287 (and (forward-comment 1) (eobp))))))
2ab98065 288 ;; comment-padding
9145f1c2 289 (unless comment-padding (setq comment-padding 0))
2ab98065
SM
290 (when (integerp comment-padding)
291 (setq comment-padding (make-string comment-padding ? )))
292 ;; comment markers
293 ;;(setq comment-start (comment-string-strip comment-start t nil))
294 ;;(setq comment-end (comment-string-strip comment-end nil t))
295 ;; comment-continue
f5215400 296 (unless (or comment-continue (string= comment-end ""))
2ab98065 297 (set (make-local-variable 'comment-continue)
9b0d1d6e 298 (concat (if (string-match "\\S-\\S-" comment-start) " " "|")
7164ef13
SM
299 (substring comment-start 1)))
300 ;; Hasn't been necessary yet.
301 ;; (unless (string-match comment-start-skip comment-continue)
016c63b6 302 ;; (kill-local-variable 'comment-continue))
7164ef13 303 )
2ab98065 304 ;; comment-skip regexps
f23a0f3a
SM
305 (unless (and comment-start-skip
306 ;; In case comment-start has changed since last time.
307 (string-match comment-start-skip comment-start))
2ab98065 308 (set (make-local-variable 'comment-start-skip)
f0a478be 309 (concat "\\(\\(^\\|[^\\\n]\\)\\(\\\\\\\\\\)*\\)\\(\\s<+\\|"
2ab98065 310 (regexp-quote (comment-string-strip comment-start t t))
75ed43a6
SM
311 ;; Let's not allow any \s- but only [ \t] since \n
312 ;; might be both a comment-end marker and \s-.
313 "+\\)[ \t]*")))
f23a0f3a
SM
314 (unless (and comment-end-skip
315 ;; In case comment-end has changed since last time.
316 (string-match comment-end-skip comment-end))
2ab98065
SM
317 (let ((ce (if (string= "" comment-end) "\n"
318 (comment-string-strip comment-end t t))))
319 (set (make-local-variable 'comment-end-skip)
37dbd369
SM
320 ;; We use [ \t] rather than \s- because we don't want to
321 ;; remove ^L in C mode when uncommenting.
322 (concat "[ \t]*\\(\\s>" (if comment-quote-nested "" "+")
2ab98065 323 "\\|" (regexp-quote (substring ce 0 1))
771c9b97 324 (if (and comment-quote-nested (<= (length ce) 1)) "" "+")
2ab98065
SM
325 (regexp-quote (substring ce 1))
326 "\\)"))))))
f1180544 327
f5215400
SM
328(defun comment-quote-re (str unp)
329 (concat (regexp-quote (substring str 0 1))
330 "\\\\" (if unp "+" "*")
331 (regexp-quote (substring str 1))))
332
333(defun comment-quote-nested (cs ce unp)
334 "Quote or unquote nested comments.
335If UNP is non-nil, unquote nested comment markers."
336 (setq cs (comment-string-strip cs t t))
337 (setq ce (comment-string-strip ce t t))
338 (when (and comment-quote-nested (> (length ce) 0))
339 (let ((re (concat (comment-quote-re ce unp)
340 "\\|" (comment-quote-re cs unp))))
341 (goto-char (point-min))
342 (while (re-search-forward re nil t)
343 (goto-char (match-beginning 0))
344 (forward-char 1)
345 (if unp (delete-char 1) (insert "\\"))
346 (when (= (length ce) 1)
347 ;; If the comment-end is a single char, adding a \ after that
348 ;; "first" char won't deactivate it, so we turn such a CE
349 ;; into !CS. I.e. for pascal, we turn } into !{
350 (if (not unp)
351 (when (string= (match-string 0) ce)
352 (replace-match (concat "!" cs) t t))
353 (when (and (< (point-min) (match-beginning 0))
354 (string= (buffer-substring (1- (match-beginning 0))
355 (1- (match-end 0)))
356 (concat "!" cs)))
357 (backward-char 2)
358 (delete-char (- (match-end 0) (match-beginning 0)))
359 (insert ce))))))))
2ab98065
SM
360
361;;;;
362;;;; Navigation
363;;;;
364
f5f95edf
SM
365(defvar comment-use-global-state nil
366 "Non-nil means that the global syntactic context is used.
367More specifically, it means that `syntax-ppss' is used to find out whether
368point is within a string or not. Major modes whose syntax is faithfully
369described by the syntax-tables can set this to non-nil so comment markers
370in strings will not confuse Emacs.")
371
ad679e45 372(defun comment-search-forward (limit &optional noerror)
771c9b97
SM
373 "Find a comment start between point and LIMIT.
374Moves point to inside the comment and returns the position of the
375comment-starter. If no comment is found, moves point to LIMIT
11a26e05 376and raises an error or returns nil if NOERROR is non-nil."
2ab98065 377 (if (not comment-use-syntax)
9b0d1d6e
SM
378 (if (re-search-forward comment-start-skip limit noerror)
379 (or (match-end 1) (match-beginning 0))
380 (goto-char limit)
381 (unless noerror (error "No comment")))
ad679e45
SM
382 (let* ((pt (point))
383 ;; Assume (at first) that pt is outside of any string.
f5f95edf
SM
384 (s (parse-partial-sexp pt (or limit (point-max)) nil nil
385 (if comment-use-global-state (syntax-ppss pt))
386 t)))
387 (when (and (nth 8 s) (nth 3 s) (not comment-use-global-state))
b70dd952
SM
388 ;; The search ended at eol inside a string. Try to see if it
389 ;; works better when we assume that pt is inside a string.
390 (setq s (parse-partial-sexp
391 pt (or limit (point-max)) nil nil
392 (list nil nil nil (nth 3 s) nil nil nil nil)
393 t)))
ad679e45
SM
394 (if (not (and (nth 8 s) (not (nth 3 s))))
395 (unless noerror (error "No comment"))
396 ;; We found the comment.
9b0d1d6e 397 (let ((pos (point))
ad679e45 398 (start (nth 8 s))
9b0d1d6e 399 (bol (line-beginning-position))
ad679e45
SM
400 (end nil))
401 (while (and (null end) (>= (point) bol))
402 (if (looking-at comment-start-skip)
403 (setq end (min (or limit (point-max)) (match-end 0)))
404 (backward-char)))
9b0d1d6e 405 (goto-char (or end pos))
ad679e45 406 start)))))
2ab98065
SM
407
408(defun comment-search-backward (&optional limit noerror)
409 "Find a comment start between LIMIT and point.
771c9b97
SM
410Moves point to inside the comment and returns the position of the
411comment-starter. If no comment is found, moves point to LIMIT
11a26e05 412and raises an error or returns nil if NOERROR is non-nil."
ad679e45
SM
413 ;; FIXME: If a comment-start appears inside a comment, we may erroneously
414 ;; stop there. This can be rather bad in general, but since
415 ;; comment-search-backward is only used to find the comment-column (in
416 ;; comment-set-column) and to find the comment-start string (via
417 ;; comment-beginning) in indent-new-comment-line, it should be harmless.
2ab98065
SM
418 (if (not (re-search-backward comment-start-skip limit t))
419 (unless noerror (error "No comment"))
420 (beginning-of-line)
421 (let* ((end (match-end 0))
422 (cs (comment-search-forward end t))
423 (pt (point)))
424 (if (not cs)
425 (progn (beginning-of-line)
426 (comment-search-backward limit noerror))
427 (while (progn (goto-char cs)
428 (comment-forward)
429 (and (< (point) end)
430 (setq cs (comment-search-forward end t))))
431 (setq pt (point)))
432 (goto-char pt)
433 cs))))
434
435(defun comment-beginning ()
771c9b97
SM
436 "Find the beginning of the enclosing comment.
437Returns nil if not inside a comment, else moves point and returns
2308f447 438the same as `comment-search-backward'."
75ed43a6
SM
439 ;; HACK ATTACK!
440 ;; We should really test `in-string-p' but that can be expensive.
441 (unless (eq (get-text-property (point) 'face) 'font-lock-string-face)
442 (let ((pt (point))
443 (cs (comment-search-backward nil t)))
444 (when cs
445 (if (save-excursion
446 (goto-char cs)
dde6824c
SM
447 (and
448 ;; For modes where comment-start and comment-end are the same,
449 ;; the search above may have found a `ce' rather than a `cs'.
2308f447 450 (or (if comment-end-skip (not (looking-at comment-end-skip)))
dde6824c
SM
451 ;; Maybe font-lock knows that it's a `cs'?
452 (eq (get-text-property (match-end 0) 'face)
453 'font-lock-comment-face)
454 (unless (eq (get-text-property (point) 'face)
455 'font-lock-comment-face)
456 ;; Let's assume it's a `cs' if we're on the same line.
457 (>= (line-end-position) pt)))
458 ;; Make sure that PT is not past the end of the comment.
459 (if (comment-forward 1) (> (point) pt) (eobp))))
75ed43a6
SM
460 cs
461 (goto-char pt)
462 nil)))))
2ab98065
SM
463
464(defun comment-forward (&optional n)
465 "Skip forward over N comments.
466Just like `forward-comment' but only for positive N
467and can use regexps instead of syntax."
468 (setq n (or n 1))
469 (if (< n 0) (error "No comment-backward")
470 (if comment-use-syntax (forward-comment n)
471 (while (> n 0)
59a1ce8d 472 (setq n
0f38a885
SM
473 (if (or (forward-comment 1)
474 (and (looking-at comment-start-skip)
475 (goto-char (match-end 0))
476 (re-search-forward comment-end-skip nil 'move)))
59a1ce8d 477 (1- n) -1)))
2ab98065
SM
478 (= n 0))))
479
480(defun comment-enter-backward ()
481 "Move from the end of a comment to the end of its content.
771c9b97 482Point is assumed to be just at the end of a comment."
2ab98065
SM
483 (if (bolp)
484 ;; comment-end = ""
485 (progn (backward-char) (skip-syntax-backward " "))
3cc4b076
SM
486 (cond
487 ((save-restriction
1cb40089
SM
488 (narrow-to-region (line-beginning-position) (point))
489 (goto-char (point-min))
3cc4b076
SM
490 (re-search-forward (concat comment-end-skip "\\'") nil t))
491 (goto-char (match-beginning 0)))
492 ;; comment-end-skip not found. Maybe we're at EOB which implicitly
493 ;; closes the comment.
494 ((eobp) (skip-syntax-backward " "))
495 (t
496 ;; else comment-end-skip was not found probably because it was not
497 ;; set right. Since \\s> should catch the single-char case, we'll
498 ;; blindly assume we're at the end of a two-char comment-end.
499 (backward-char 2)
500 (skip-chars-backward (string (char-after)))
501 (skip-syntax-backward " ")))))
2ab98065
SM
502
503;;;;
504;;;; Commands
505;;;;
506
fae99944 507;;;###autoload
87cf8421
SM
508(defun comment-indent-default ()
509 "Default for `comment-indent-function'."
d3fcda22
SM
510 (if (and (looking-at "\\s<\\s<\\(\\s<\\)?")
511 (or (match-end 1) (/= (current-column) (current-indentation))))
512 0
87cf8421 513 (when (or (/= (current-column) (current-indentation))
8c39e595 514 (and (> comment-add 0) (looking-at "\\s<\\(\\S<\\|\\'\\)")))
87cf8421
SM
515 comment-column)))
516
be83ecb2 517;;;###autoload
3e569d22 518(defun comment-indent (&optional continue)
a71b3805 519 "Indent this line's comment to `comment-column', or insert an empty comment.
dde6824c 520If CONTINUE is non-nil, use the `comment-continue' markers if any."
83b96b22 521 (interactive "*")
ad679e45 522 (comment-normalize-vars)
83b96b22
SM
523 (let* ((empty (save-excursion (beginning-of-line)
524 (looking-at "[ \t]*$")))
f5215400 525 (starter (or (and continue comment-continue)
2ab98065 526 (and empty block-comment-start) comment-start))
f5215400 527 (ender (or (and continue comment-continue "")
2ab98065 528 (and empty block-comment-end) comment-end)))
2e1fbba4
SM
529 (unless starter (error "No comment syntax defined"))
530 (beginning-of-line)
531 (let* ((eolpos (line-end-position))
532 (begpos (comment-search-forward eolpos t))
533 cpos indent)
534 ;; An existing comment?
7a06b250
SM
535 (if begpos
536 (progn
537 (if (and (not (looking-at "[\t\n ]"))
538 (looking-at comment-end-skip))
539 ;; The comment is empty and we have skipped all its space
540 ;; and landed right before the comment-ender:
541 ;; Go back to the middle of the space.
542 (forward-char (/ (skip-chars-backward " \t") -2)))
543 (setq cpos (point-marker)))
2e1fbba4 544 ;; If none, insert one.
a71b3805
EZ
545 (if comment-insert-comment-function
546 (funcall comment-insert-comment-function)
2e1fbba4 547 (save-excursion
a71b3805
EZ
548 ;; Some `comment-indent-function's insist on not moving
549 ;; comments that are in column 0, so we first go to the
550 ;; likely target column.
567e961e 551 (indent-to comment-column)
e6bba95e
DL
552 ;; Ensure there's a space before the comment for things
553 ;; like sh where it matters (as well as being neater).
07f10bab 554 (unless (memq (char-before) '(nil ?\n ?\t ?\ ))
e6bba95e 555 (insert ?\ ))
07f10bab 556 (setq begpos (point))
bb304a7a 557 (insert starter)
2e1fbba4 558 (setq cpos (point-marker))
a71b3805 559 (insert ender))))
2e1fbba4
SM
560 (goto-char begpos)
561 ;; Compute desired indent.
053b8d35 562 (setq indent (save-excursion (funcall comment-indent-function)))
8cc313a3
SM
563 ;; If `indent' is nil and there's code before the comment, we can't
564 ;; use `indent-according-to-mode', so we default to comment-column.
565 (unless (or indent (save-excursion (skip-chars-backward " \t") (bolp)))
566 (setq indent comment-column))
2e1fbba4 567 (if (not indent)
bfe6e13f 568 ;; comment-indent-function refuses: delegate to line-indent.
2e1fbba4 569 (indent-according-to-mode)
8cc313a3 570 ;; If the comment is at the left of code, adjust the indentation.
a764440a 571 (unless (save-excursion (skip-chars-backward " \t") (bolp))
8cc313a3 572 ;; Avoid moving comments past the fill-column.
bfe6e13f 573 (let ((max (+ (current-column)
88fe06af 574 (- (or comment-fill-column fill-column)
bfe6e13f
SM
575 (save-excursion (end-of-line) (current-column))))))
576 (if (<= max indent)
577 (setq indent max) ;Don't move past the fill column.
578 ;; We can choose anywhere between indent..max.
579 ;; Let's try to align to a comment on the previous line.
8cc313a3
SM
580 (let ((other nil)
581 (min (max indent
582 (save-excursion (skip-chars-backward " \t")
583 (1+ (current-column))))))
bfe6e13f
SM
584 (save-excursion
585 (when (and (zerop (forward-line -1))
586 (setq other (comment-search-forward
587 (line-end-position) t)))
588 (goto-char other) (setq other (current-column))))
8cc313a3 589 (if (and other (<= other max) (>= other min))
bfe6e13f
SM
590 ;; There is a comment and it's in the range: bingo.
591 (setq indent other)
592 ;; Let's try to align to a comment on the next line, then.
593 (let ((other nil))
594 (save-excursion
595 (when (and (zerop (forward-line 1))
596 (setq other (comment-search-forward
597 (line-end-position) t)))
598 (goto-char other) (setq other (current-column))))
8cc313a3 599 (if (and other (<= other max) (> other min))
bfe6e13f
SM
600 ;; There is a comment and it's in the range: bingo.
601 (setq indent other))))))))
b605a60a
RS
602 ;; Update INDENT to leave at least one space
603 ;; after other nonwhite text on the line.
604 (save-excursion
016c63b6 605 (skip-chars-backward " \t")
b605a60a
RS
606 (unless (bolp)
607 (setq indent (max indent (1+ (current-column))))))
608 ;; If that's different from comment's current position, change it.
7164ef13 609 (unless (= (current-column) indent)
7164ef13 610 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
b605a60a 611 (indent-to indent)))
2e1fbba4
SM
612 (goto-char cpos)
613 (set-marker cpos nil))))
83b96b22 614
be83ecb2 615;;;###autoload
3e569d22 616(defun comment-set-column (arg)
83b96b22 617 "Set the comment column based on point.
2ab98065 618With no ARG, set the comment column to the current column.
83b96b22
SM
619With just minus as arg, kill any comment on this line.
620With any other arg, set comment column to indentation of the previous comment
621 and then align or create a comment on this line at that column."
622 (interactive "P")
e8fe7d39 623 (cond
ad679e45 624 ((eq arg '-) (comment-kill nil))
e8fe7d39 625 (arg
2abd0306 626 (comment-normalize-vars)
e8fe7d39
SM
627 (save-excursion
628 (beginning-of-line)
2ab98065 629 (comment-search-backward)
e8fe7d39 630 (beginning-of-line)
ad679e45 631 (goto-char (comment-search-forward (line-end-position)))
83b96b22 632 (setq comment-column (current-column))
e8fe7d39 633 (message "Comment column set to %d" comment-column))
ad679e45 634 (comment-indent))
e8fe7d39 635 (t (setq comment-column (current-column))
83b96b22
SM
636 (message "Comment column set to %d" comment-column))))
637
be83ecb2 638;;;###autoload
3e569d22 639(defun comment-kill (arg)
7a0a180a
SM
640 "Kill the comment on this line, if any.
641With prefix ARG, kill comments on that many lines starting with this one."
642 (interactive "P")
2abd0306 643 (comment-normalize-vars)
ad679e45
SM
644 (dotimes (_ (prefix-numeric-value arg))
645 (save-excursion
646 (beginning-of-line)
647 (let ((cs (comment-search-forward (line-end-position) t)))
648 (when cs
649 (goto-char cs)
650 (skip-syntax-backward " ")
651 (setq cs (point))
652 (comment-forward)
653 (kill-region cs (if (bolp) (1- (point)) (point)))
654 (indent-according-to-mode))))
655 (if arg (forward-line 1))))
7a0a180a 656
2ab98065
SM
657(defun comment-padright (str &optional n)
658 "Construct a string composed of STR plus `comment-padding'.
f5215400 659It also adds N copies of the last non-whitespace chars of STR.
2ab98065 660If STR already contains padding, the corresponding amount is
f5215400
SM
661ignored from `comment-padding'.
662N defaults to 0.
771c9b97 663If N is `re', a regexp is returned instead, that would match
f5215400 664the string for any N."
2ab98065
SM
665 (setq n (or n 0))
666 (when (and (stringp str) (not (string= "" str)))
f5215400 667 ;; Separate the actual string from any leading/trailing padding
3e569d22 668 (string-match "\\`\\s-*\\(.*?\\)\\s-*\\'" str)
f5215400
SM
669 (let ((s (match-string 1 str)) ;actual string
670 (lpad (substring str 0 (match-beginning 1))) ;left padding
671 (rpad (concat (substring str (match-end 1)) ;original right padding
672 (substring comment-padding ;additional right padding
3e569d22 673 (min (- (match-end 0) (match-end 1))
9b0d1d6e
SM
674 (length comment-padding)))))
675 ;; We can only duplicate C if the comment-end has multiple chars
676 ;; or if comments can be nested, else the comment-end `}' would
677 ;; be turned into `}}}' where only the first ends the comment
678 ;; and the rest becomes bogus junk.
679 (multi (not (and comment-quote-nested
680 ;; comment-end is a single char
681 (string-match "\\`\\s-*\\S-\\s-*\\'" comment-end)))))
f5215400 682 (if (not (symbolp n))
9b0d1d6e 683 (concat lpad s (when multi (make-string n (aref str (1- (match-end 1))))) rpad)
f5215400
SM
684 ;; construct a regexp that would match anything from just S
685 ;; to any possible output of this function for any N.
686 (concat (mapconcat (lambda (c) (concat (regexp-quote (string c)) "?"))
687 lpad "") ;padding is not required
9b0d1d6e
SM
688 (regexp-quote s)
689 (when multi "+") ;the last char of S might be repeated
f5215400
SM
690 (mapconcat (lambda (c) (concat (regexp-quote (string c)) "?"))
691 rpad "")))))) ;padding is not required
2ab98065
SM
692
693(defun comment-padleft (str &optional n)
694 "Construct a string composed of `comment-padding' plus STR.
f5215400 695It also adds N copies of the first non-whitespace chars of STR.
2ab98065 696If STR already contains padding, the corresponding amount is
f5215400
SM
697ignored from `comment-padding'.
698N defaults to 0.
771c9b97 699If N is `re', a regexp is returned instead, that would match
2ab98065
SM
700 the string for any N."
701 (setq n (or n 0))
702 (when (and (stringp str) (not (string= "" str)))
f5215400 703 ;; Only separate the left pad because we assume there is no right pad.
2ab98065
SM
704 (string-match "\\`\\s-*" str)
705 (let ((s (substring str (match-end 0)))
706 (pad (concat (substring comment-padding
707 (min (- (match-end 0) (match-beginning 0))
708 (length comment-padding)))
709 (match-string 0 str)))
f5215400
SM
710 (c (aref str (match-end 0))) ;the first non-space char of STR
711 ;; We can only duplicate C if the comment-end has multiple chars
712 ;; or if comments can be nested, else the comment-end `}' would
713 ;; be turned into `}}}' where only the first ends the comment
714 ;; and the rest becomes bogus junk.
715 (multi (not (and comment-quote-nested
716 ;; comment-end is a single char
717 (string-match "\\`\\s-*\\S-\\s-*\\'" comment-end)))))
718 (if (not (symbolp n))
719 (concat pad (when multi (make-string n c)) s)
720 ;; Construct a regexp that would match anything from just S
721 ;; to any possible output of this function for any N.
722 ;; We match any number of leading spaces because this regexp will
723 ;; be used for uncommenting where we might want to remove
724 ;; uncomment markers with arbitrary leading space (because
725 ;; they were aligned).
726 (concat "\\s-*"
727 (if multi (concat (regexp-quote (string c)) "*"))
728 (regexp-quote s))))))
83b96b22 729
be83ecb2 730;;;###autoload
7a0a180a 731(defun uncomment-region (beg end &optional arg)
eb0b51f8 732 "Uncomment each line in the BEG .. END region.
f5215400
SM
733The numeric prefix ARG can specify a number of chars to remove from the
734comment markers."
83b96b22
SM
735 (interactive "*r\nP")
736 (comment-normalize-vars)
065b7364 737 (when (> beg end) (setq beg (prog1 end (setq end beg))))
b70dd952
SM
738 ;; Bind `comment-use-global-state' to nil. While uncommenting a region
739 ;; (which works a line at a time), a comment can appear to be
cbdad6e2
EZ
740 ;; included in a mult-line string, but it is actually not.
741 (let ((comment-use-global-state nil))
742 (save-excursion
b70dd952
SM
743 (funcall uncomment-region-function beg end arg))))
744
745(defun uncomment-region-default (beg end &optional arg)
746 "Uncomment each line in the BEG .. END region.
747The numeric prefix ARG can specify a number of chars to remove from the
748comment markers."
749 (goto-char beg)
750 (setq end (copy-marker end))
751 (let* ((numarg (prefix-numeric-value arg))
752 (ccs comment-continue)
753 (srei (comment-padright ccs 're))
754 (csre (comment-padright comment-start 're))
755 (sre (and srei (concat "^\\s-*?\\(" srei "\\)")))
756 spt)
757 (while (and (< (point) end)
758 (setq spt (comment-search-forward end t)))
759 (let ((ipt (point))
760 ;; Find the end of the comment.
761 (ept (progn
762 (goto-char spt)
763 (unless (or (comment-forward)
764 ;; Allow non-terminated comments.
765 (eobp))
766 (error "Can't find the comment end"))
767 (point)))
768 (box nil)
769 (box-equal nil)) ;Whether we might be using `=' for boxes.
770 (save-restriction
771 (narrow-to-region spt ept)
016c63b6 772
b70dd952
SM
773 ;; Remove the comment-start.
774 (goto-char ipt)
775 (skip-syntax-backward " ")
776 ;; A box-comment starts with a looong comment-start marker.
777 (when (and (or (and (= (- (point) (point-min)) 1)
778 (setq box-equal t)
779 (looking-at "=\\{7\\}")
780 (not (eq (char-before (point-max)) ?\n))
781 (skip-chars-forward "="))
782 (> (- (point) (point-min) (length comment-start)) 7))
783 (> (count-lines (point-min) (point-max)) 2))
784 (setq box t))
785 ;; Skip the padding. Padding can come from comment-padding and/or
786 ;; from comment-start, so we first check comment-start.
787 (if (or (save-excursion (goto-char (point-min)) (looking-at csre))
788 (looking-at (regexp-quote comment-padding)))
789 (goto-char (match-end 0)))
790 (when (and sre (looking-at (concat "\\s-*\n\\s-*" srei)))
791 (goto-char (match-end 0)))
792 (if (null arg) (delete-region (point-min) (point))
793 (skip-syntax-backward " ")
794 (delete-char (- numarg))
795 (unless (or (bobp)
796 (save-excursion (goto-char (point-min))
797 (looking-at comment-start-skip)))
798 ;; If there's something left but it doesn't look like
799 ;; a comment-start any more, just remove it.
800 (delete-region (point-min) (point))))
016c63b6 801
b70dd952
SM
802 ;; Remove the end-comment (and leading padding and such).
803 (goto-char (point-max)) (comment-enter-backward)
804 ;; Check for special `=' used sometimes in comment-box.
805 (when (and box-equal (not (eq (char-before (point-max)) ?\n)))
806 (let ((pos (point)))
807 ;; skip `=' but only if there are at least 7.
808 (when (> (skip-chars-backward "=") -7) (goto-char pos))))
809 (unless (looking-at "\\(\n\\|\\s-\\)*\\'")
810 (when (and (bolp) (not (bobp))) (backward-char))
811 (if (null arg) (delete-region (point) (point-max))
812 (skip-syntax-forward " ")
813 (delete-char numarg)
814 (unless (or (eobp) (looking-at comment-end-skip))
815 ;; If there's something left but it doesn't look like
816 ;; a comment-end any more, just remove it.
817 (delete-region (point) (point-max)))))
818
819 ;; Unquote any nested end-comment.
820 (comment-quote-nested comment-start comment-end t)
821
822 ;; Eliminate continuation markers as well.
823 (when sre
824 (let* ((cce (comment-string-reverse (or comment-continue
825 comment-start)))
826 (erei (and box (comment-padleft cce 're)))
827 (ere (and erei (concat "\\(" erei "\\)\\s-*$"))))
828 (goto-char (point-min))
829 (while (progn
830 (if (and ere (re-search-forward
831 ere (line-end-position) t))
832 (replace-match "" t t nil (if (match-end 2) 2 1))
833 (setq ere nil))
834 (forward-line 1)
835 (re-search-forward sre (line-end-position) t))
836 (replace-match "" t t nil (if (match-end 2) 2 1)))))
837 ;; Go to the end for the next comment.
838 (goto-char (point-max))))))
839 (set-marker end nil))
83b96b22 840
aac88001 841(defun comment-make-extra-lines (cs ce ccs cce min-indent max-indent &optional block)
ad679e45
SM
842 "Make the leading and trailing extra lines.
843This is used for `extra-line' style (or `box' style if BLOCK is specified)."
9b0d1d6e
SM
844 (let ((eindent 0))
845 (if (not block)
846 ;; Try to match CS and CE's content so they align aesthetically.
847 (progn
848 (setq ce (comment-string-strip ce t t))
849 (when (string-match "\\(.+\\).*\n\\(.*?\\)\\1" (concat ce "\n" cs))
850 (setq eindent
851 (max (- (match-end 2) (match-beginning 2) (match-beginning 0))
852 0))))
853 ;; box comment
854 (let* ((width (- max-indent min-indent))
855 (s (concat cs "a=m" cce))
856 (e (concat ccs "a=m" ce))
857 (c (if (string-match ".*\\S-\\S-" cs)
3674a4a9
SM
858 (aref cs (1- (match-end 0)))
859 (if (and (equal comment-end "") (string-match ".*\\S-" cs))
860 (aref cs (1- (match-end 0))) ?=)))
861 (re "\\s-*a=m\\s-*")
862 (_ (string-match re s))
863 (lcs (length cs))
9b0d1d6e
SM
864 (fill
865 (make-string (+ width (- (match-end 0)
3674a4a9 866 (match-beginning 0) lcs 3)) c)))
aac88001 867 (setq cs (replace-match fill t t s))
3674a4a9
SM
868 (when (and (not (string-match comment-start-skip cs))
869 (string-match "a=m" s))
870 ;; The whitespace around CS cannot be ignored: put it back.
871 (setq re "a=m")
872 (setq fill (make-string (- width lcs) c))
873 (setq cs (replace-match fill t t s)))
874 (string-match re e)
9b0d1d6e
SM
875 (setq ce (replace-match fill t t e))))
876 (cons (concat cs "\n" (make-string min-indent ? ) ccs)
877 (concat cce "\n" (make-string (+ min-indent eindent) ? ) ce))))
aac88001 878
aac88001
SM
879(defmacro comment-with-narrowing (beg end &rest body)
880 "Execute BODY with BEG..END narrowing.
881Space is added (and then removed) at the beginning for the text's
882indentation to be kept as it was before narrowing."
4745e738 883 (declare (debug t) (indent 2))
59a1ce8d 884 (let ((bindent (make-symbol "bindent")))
bfe6e13f 885 `(let ((,bindent (save-excursion (goto-char ,beg) (current-column))))
59a1ce8d 886 (save-restriction
bfe6e13f 887 (narrow-to-region ,beg ,end)
59a1ce8d
SM
888 (goto-char (point-min))
889 (insert (make-string ,bindent ? ))
890 (prog1
891 (progn ,@body)
892 ;; remove the bindent
893 (save-excursion
894 (goto-char (point-min))
895 (when (looking-at " *")
896 (let ((n (min (- (match-end 0) (match-beginning 0)) ,bindent)))
aac88001 897 (delete-char n)
59a1ce8d
SM
898 (setq ,bindent (- ,bindent n))))
899 (end-of-line)
900 (let ((e (point)))
901 (beginning-of-line)
902 (while (and (> ,bindent 0) (re-search-forward " *" e t))
903 (let ((n (min ,bindent (- (match-end 0) (match-beginning 0) 1))))
904 (goto-char (match-beginning 0))
905 (delete-char n)
906 (setq ,bindent (- ,bindent n)))))))))))
aac88001 907
b433a560
SM
908(defun comment-add (arg)
909 (if (and (null arg) (= (string-match "[ \t]*\\'" comment-start) 1))
910 comment-add
911 (1- (prefix-numeric-value arg))))
912
771c9b97 913(defun comment-region-internal (beg end cs ce
aa417798 914 &optional ccs cce block lines indent)
3674a4a9 915 "Comment region BEG .. END.
aa417798
JB
916CS and CE are the comment start string and comment end string,
917respectively. CCS and CCE are the comment continuation strings
918for the start and end of lines, respectively (default to CS and CE).
919BLOCK indicates that end of lines should be marked with either CCE,
920CE or CS \(if CE is empty) and that those markers should be aligned.
921LINES indicates that an extra lines will be used at the beginning
922and end of the region for CE and CS.
923INDENT indicates to put CS and CCS at the current indentation of
924the region rather than at left margin."
59a1ce8d 925 ;;(assert (< beg end))
6976bf99
SM
926 (let ((no-empty (not (or (eq comment-empty-lines t)
927 (and comment-empty-lines (zerop (length ce)))))))
f5215400 928 ;; Sanitize CE and CCE.
83b96b22
SM
929 (if (and (stringp ce) (string= "" ce)) (setq ce nil))
930 (if (and (stringp cce) (string= "" cce)) (setq cce nil))
f5215400
SM
931 ;; If CE is empty, multiline cannot be used.
932 (unless ce (setq ccs nil cce nil))
933 ;; Should we mark empty lines as well ?
83b96b22 934 (if (or ccs block lines) (setq no-empty nil))
f5215400 935 ;; Make sure we have end-markers for BLOCK mode.
2ab98065 936 (when block (unless ce (setq ce (comment-string-reverse cs))))
f5215400
SM
937 ;; If BLOCK is not requested, we don't need CCE.
938 (unless block (setq cce nil))
939 ;; Continuation defaults to the same as CS and CE.
940 (unless ccs (setq ccs cs cce ce))
f1180544 941
83b96b22 942 (save-excursion
aac88001 943 (goto-char end)
f5215400
SM
944 ;; If the end is not at the end of a line and the comment-end
945 ;; is implicit (i.e. a newline), explicitly insert a newline.
aac88001
SM
946 (unless (or ce (eolp)) (insert "\n") (indent-according-to-mode))
947 (comment-with-narrowing beg end
f5215400 948 (let ((min-indent (point-max))
9d5240d2 949 (max-indent 0))
83b96b22 950 (goto-char (point-min))
f5215400
SM
951 ;; Quote any nested comment marker
952 (comment-quote-nested comment-start comment-end nil)
953
954 ;; Loop over all lines to find the needed indentations.
4125ec7e 955 (goto-char (point-min))
f5215400
SM
956 (while
957 (progn
958 (unless (looking-at "[ \t]*$")
959 (setq min-indent (min min-indent (current-indentation))))
960 (end-of-line)
961 (setq max-indent (max max-indent (current-column)))
962 (not (or (eobp) (progn (forward-line) nil)))))
f1180544 963
59a1ce8d 964 (setq max-indent
45f6a663
SM
965 (+ max-indent (max (length cs) (length ccs))
966 ;; Inserting ccs can change max-indent by (1- tab-width)
967 ;; but only if there are TABs in the boxed text, of course.
968 (if (save-excursion (goto-char beg)
969 (search-forward "\t" end t))
970 (1- tab-width) 0)))
771c9b97 971 (unless indent (setq min-indent 0))
83b96b22 972
aac88001 973 ;; make the leading and trailing lines if requested
83b96b22 974 (when lines
771c9b97
SM
975 (let ((csce
976 (comment-make-extra-lines
977 cs ce ccs cce min-indent max-indent block)))
978 (setq cs (car csce))
979 (setq ce (cdr csce))))
f1180544 980
83b96b22
SM
981 (goto-char (point-min))
982 ;; Loop over all lines from BEG to END.
f5215400
SM
983 (while
984 (progn
985 (unless (and no-empty (looking-at "[ \t]*$"))
986 (move-to-column min-indent t)
987 (insert cs) (setq cs ccs) ;switch to CCS after the first line
988 (end-of-line)
989 (if (eobp) (setq cce ce))
990 (when cce
991 (when block (move-to-column max-indent t))
992 (insert cce)))
993 (end-of-line)
994 (not (or (eobp) (progn (forward-line) nil))))))))))
83b96b22 995
be83ecb2 996;;;###autoload
83b96b22
SM
997(defun comment-region (beg end &optional arg)
998 "Comment or uncomment each line in the region.
3674a4a9 999With just \\[universal-argument] prefix arg, uncomment each line in region BEG .. END.
11a26e05 1000Numeric prefix ARG means use ARG comment characters.
83b96b22 1001If ARG is negative, delete that many comment characters instead.
be83ecb2
SM
1002By default, comments start at the left margin, are terminated on each line,
1003even for syntax in which newline does not end the comment and blank lines
1004do not get comments. This can be changed with `comment-style'.
83b96b22
SM
1005
1006The strings used as comment starts are built from
1007`comment-start' without trailing spaces and `comment-padding'."
1008 (interactive "*r\nP")
1009 (comment-normalize-vars)
1010 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
b70dd952
SM
1011 (save-excursion
1012 ;; FIXME: maybe we should call uncomment depending on ARG.
1013 (funcall comment-region-function beg end arg)))
1014
1015(defun comment-region-default (beg end &optional arg)
2ab98065 1016 (let* ((numarg (prefix-numeric-value arg))
2ab98065
SM
1017 (style (cdr (assoc comment-style comment-styles)))
1018 (lines (nth 2 style))
1019 (block (nth 1 style))
1020 (multi (nth 0 style)))
b70dd952
SM
1021 ;; we use `chars' instead of `syntax' because `\n' might be
1022 ;; of end-comment syntax rather than of whitespace syntax.
1023 ;; sanitize BEG and END
1024 (goto-char beg) (skip-chars-forward " \t\n\r") (beginning-of-line)
1025 (setq beg (max beg (point)))
1026 (goto-char end) (skip-chars-backward " \t\n\r") (end-of-line)
1027 (setq end (min end (point)))
1028 (if (>= beg end) (error "Nothing to comment"))
1029
1030 ;; sanitize LINES
1031 (setq lines
1032 (and
1033 lines ;; multi
1034 (progn (goto-char beg) (beginning-of-line)
1035 (skip-syntax-forward " ")
1036 (>= (point) beg))
1037 (progn (goto-char end) (end-of-line) (skip-syntax-backward " ")
1038 (<= (point) end))
1039 (or block (not (string= "" comment-end)))
1040 (or block (progn (goto-char beg) (search-forward "\n" end t)))))
1041
1042 ;; don't add end-markers just because the user asked for `block'
1043 (unless (or lines (string= "" comment-end)) (setq block nil))
1044
1045 (cond
1046 ((consp arg) (uncomment-region beg end))
1047 ((< numarg 0) (uncomment-region beg end (- numarg)))
1048 (t
b433a560 1049 (setq numarg (comment-add arg))
b70dd952
SM
1050 (comment-region-internal
1051 beg end
1052 (let ((s (comment-padright comment-start numarg)))
1053 (if (string-match comment-start-skip s) s
1054 (comment-padright comment-start)))
1055 (let ((s (comment-padleft comment-end numarg)))
1056 (and s (if (string-match comment-end-skip s) s
1057 (comment-padright comment-end))))
1058 (if multi (comment-padright comment-continue numarg))
1059 (if multi
1060 (comment-padleft (comment-string-reverse comment-continue) numarg))
1061 block
1062 lines
1063 (nth 3 style))))))
771c9b97 1064
016c63b6 1065;;;###autoload
771c9b97 1066(defun comment-box (beg end &optional arg)
3674a4a9 1067 "Comment out the BEG .. END region, putting it inside a box.
771c9b97
SM
1068The numeric prefix ARG specifies how many characters to add to begin- and
1069end- comment markers additionally to what `comment-add' already specifies."
1070 (interactive "*r\np")
016c63b6 1071 (comment-normalize-vars)
9b0d1d6e
SM
1072 (let ((comment-style (if (cadr (assoc comment-style comment-styles))
1073 'box-multi 'box)))
771c9b97 1074 (comment-region beg end (+ comment-add arg))))
83b96b22 1075
88fe06af
SM
1076
1077;;;###autoload
1078(defun comment-or-uncomment-region (beg end &optional arg)
1079 "Call `comment-region', unless the region only consists of comments,
1080in which case call `uncomment-region'. If a prefix arg is given, it
1081is passed on to the respective function."
1082 (interactive "*r\nP")
2abd0306 1083 (comment-normalize-vars)
88fe06af
SM
1084 (funcall (if (save-excursion ;; check for already commented region
1085 (goto-char beg)
1086 (comment-forward (point-max))
1087 (<= end (point)))
1088 'uncomment-region 'comment-region)
1089 beg end arg))
1090
be83ecb2 1091;;;###autoload
2ab98065 1092(defun comment-dwim (arg)
ad679e45
SM
1093 "Call the comment command you want (Do What I Mean).
1094If the region is active and `transient-mark-mode' is on, call
39cb51e7 1095 `comment-region' (unless it only consists of comments, in which
ad679e45 1096 case it calls `uncomment-region').
2ab98065 1097Else, if the current line is empty, insert a comment and indent it.
ad679e45 1098Else if a prefix ARG is specified, call `comment-kill'.
ae2c9c21
SM
1099Else, call `comment-indent'.
1100You can configure `comment-style' to change the way regions are commented."
2ab98065
SM
1101 (interactive "*P")
1102 (comment-normalize-vars)
771c9b97 1103 (if (and mark-active transient-mark-mode)
88fe06af 1104 (comment-or-uncomment-region (region-beginning) (region-end) arg)
2ab98065 1105 (if (save-excursion (beginning-of-line) (not (looking-at "\\s-*$")))
ad679e45
SM
1106 ;; FIXME: If there's no comment to kill on this line and ARG is
1107 ;; specified, calling comment-kill is not very clever.
1108 (if arg (comment-kill (and (integerp arg) arg)) (comment-indent))
b433a560
SM
1109 (let ((add (comment-add arg)))
1110 ;; Some modes insist on keeping column 0 comment in column 0
2e1fbba4
SM
1111 ;; so we need to move away from it before inserting the comment.
1112 (indent-according-to-mode)
2ab98065
SM
1113 (insert (comment-padright comment-start add))
1114 (save-excursion
1115 (unless (string= "" comment-end)
1116 (insert (comment-padleft comment-end add)))
1117 (indent-according-to-mode))))))
1118
1fc075d8 1119;;;###autoload
392f1ef5
SM
1120(defcustom comment-auto-fill-only-comments nil
1121 "Non-nil means to only auto-fill inside comments.
1122This has no effect in modes that do not define a comment syntax."
f5307782
JB
1123 :type 'boolean
1124 :group 'comment)
392f1ef5 1125
bfe6e13f 1126(defun comment-valid-prefix-p (prefix compos)
e29d96b6
SM
1127 "Check that the adaptive-fill-prefix is consistent with the context.
1128PREFIX is the prefix (presumably guessed by `adaptive-fill-mode').
1129COMPOS is the position of the beginning of the comment we're in, or nil
1130if we're not inside a comment."
1131 ;; This consistency checking is mostly needed to workaround the limitation
1132 ;; of auto-fill-mode whose paragraph-determination doesn't pay attention
1133 ;; to comment boundaries.
1134 (if (null compos)
1135 ;; We're not inside a comment: the prefix shouldn't match
1136 ;; a comment-starter.
1137 (not (and comment-start comment-start-skip
1138 (string-match comment-start-skip prefix)))
1139 (or
1140 ;; Accept any prefix if the current comment is not EOL-terminated.
1141 (save-excursion (goto-char compos) (comment-forward) (not (bolp)))
1142 ;; Accept any prefix that starts with the same comment-start marker
1143 ;; as the current one.
1144 (when (string-match (concat "\\`[ \t]*\\(?:" comment-start-skip "\\)")
1145 prefix)
1146 (let ((prefix-com (comment-string-strip (match-string 0 prefix) nil t)))
1147 (string-match "\\`[ \t]*" prefix-com)
1148 (let* ((prefix-space (match-string 0 prefix-com))
1149 (prefix-indent (string-width prefix-space))
1150 (prefix-comstart (substring prefix-com (match-end 0))))
1151 (save-excursion
1152 (goto-char compos)
1153 ;; The comstart marker is the same.
1154 (and (looking-at (regexp-quote prefix-comstart))
1155 ;; The indentation as well.
1156 (or (= prefix-indent
1157 (- (current-column) (current-left-margin)))
1158 ;; Check the indentation in two different ways, just
1159 ;; to try and avoid most of the potential funny cases.
1160 (equal prefix-space
1161 (buffer-substring (point)
1162 (progn (move-to-left-margin)
1163 (point)))))))))))))
1164
7164ef13 1165
be83ecb2 1166;;;###autoload
ad679e45 1167(defun comment-indent-new-line (&optional soft)
2ab98065
SM
1168 "Break line at point and indent, continuing comment if within one.
1169This indents the body of the continued comment
1170under the previous comment line.
1171
1172This command is intended for styles where you write a comment per line,
1173starting a new comment (and terminating it if necessary) on each line.
1174If you want to continue one comment across several lines, use \\[newline-and-indent].
1175
1176If a fill column is specified, it overrides the use of the comment column
1177or comment indentation.
1178
1179The inserted newline is marked hard if variable `use-hard-newlines' is true,
1180unless optional argument SOFT is non-nil."
1181 (interactive)
1182 (comment-normalize-vars t)
59a1ce8d
SM
1183 (let (compos comin)
1184 ;; If we are not inside a comment and we only auto-fill comments,
1185 ;; don't do anything (unless no comment syntax is defined).
392f1ef5
SM
1186 (unless (and comment-start
1187 comment-auto-fill-only-comments
0603917d 1188 (not (interactive-p))
392f1ef5 1189 (not (save-excursion
59a1ce8d 1190 (prog1 (setq compos (comment-beginning))
392f1ef5 1191 (setq comin (point))))))
59a1ce8d
SM
1192
1193 ;; Now we know we should auto-fill.
88fe06af
SM
1194 ;; Insert the newline before removing empty space so that markers
1195 ;; get preserved better.
392f1ef5 1196 (if soft (insert-and-inherit ?\n) (newline 1))
88fe06af
SM
1197 (save-excursion (forward-char -1) (delete-horizontal-space))
1198 (delete-horizontal-space)
1199
7164ef13
SM
1200 (if (and fill-prefix (not adaptive-fill-mode))
1201 ;; Blindly trust a non-adaptive fill-prefix.
392f1ef5
SM
1202 (progn
1203 (indent-to-left-margin)
88fe06af 1204 (insert-before-markers-and-inherit fill-prefix))
59a1ce8d
SM
1205
1206 ;; If necessary check whether we're inside a comment.
a764440a 1207 (unless (or compos (null comment-start))
392f1ef5
SM
1208 (save-excursion
1209 (backward-char)
59a1ce8d
SM
1210 (setq compos (comment-beginning))
1211 (setq comin (point))))
1212
7164ef13
SM
1213 (cond
1214 ;; If there's an adaptive prefix, use it unless we're inside
1215 ;; a comment and the prefix is not a comment starter.
1216 ((and fill-prefix
e29d96b6 1217 (comment-valid-prefix-p fill-prefix compos))
7164ef13
SM
1218 (indent-to-left-margin)
1219 (insert-and-inherit fill-prefix))
1220 ;; If we're not inside a comment, just try to indent.
1221 ((not compos) (indent-according-to-mode))
1222 (t
59a1ce8d
SM
1223 (let* ((comment-column
1224 ;; The continuation indentation should be somewhere between
1225 ;; the current line's indentation (plus 2 for good measure)
1226 ;; and the current comment's indentation, with a preference
1227 ;; for comment-column.
1228 (save-excursion
a764440a 1229 ;; FIXME: use prev line's info rather than first line's.
59a1ce8d
SM
1230 (goto-char compos)
1231 (min (current-column) (max comment-column
1232 (+ 2 (current-indentation))))))
1233 (comstart (buffer-substring compos comin))
1234 (normalp
1235 (string-match (regexp-quote (comment-string-strip
1236 comment-start t t))
1237 comstart))
1238 (comment-end
1239 (if normalp comment-end
1240 ;; The comment starter is not the normal comment-start
1241 ;; so we can't just use comment-end.
1242 (save-excursion
1243 (goto-char compos)
1244 (if (not (comment-forward)) comment-end
1245 (comment-string-strip
1246 (buffer-substring
1247 (save-excursion (comment-enter-backward) (point))
1248 (point))
1249 nil t)))))
1250 (comment-start comstart)
a764440a
SM
1251 (continuep (or comment-multi-line
1252 (cadr (assoc comment-style comment-styles))))
59a1ce8d 1253 ;; Force comment-continue to be recreated from comment-start.
dde6824c 1254 ;; FIXME: wrong if comment-continue was set explicitly!
a764440a 1255 ;; FIXME: use prev line's continuation if available.
59a1ce8d 1256 (comment-continue nil))
a764440a
SM
1257 (if (and comment-multi-line (> (length comment-end) 0))
1258 (indent-according-to-mode)
1259 (insert-and-inherit ?\n)
1260 (forward-char -1)
1261 (comment-indent continuep)
1262 (save-excursion
1263 (let ((pt (point)))
1264 (end-of-line)
1265 (let ((comend (buffer-substring pt (point))))
1266 ;; The 1+ is to make sure we delete the \n inserted above.
1267 (delete-region pt (1+ (point)))
1268 (end-of-line 0)
1269 (insert comend))))))))))))
2ab98065 1270
83b96b22
SM
1271(provide 'newcomment)
1272
b70dd952 1273;; arch-tag: 01e3320a-00c8-44ea-a696-8f8e7354c858
83b96b22 1274;;; newcomment.el ends here