Spelling fixes.
[emacs.git] / lisp / newcomment.el
blob251c1605345d806ded666a5f934ed3038f498981
1 ;;; newcomment.el --- (un)comment regions of buffers -*- lexical-binding: t -*-
3 ;; Copyright (C) 1999-2013 Free Software Foundation, Inc.
5 ;; Author: code extracted from Emacs-20's simple.el
6 ;; Maintainer: Stefan Monnier <monnier@iro.umontreal.ca>
7 ;; Keywords: comment uncomment
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; This library contains functions and variables for commenting and
28 ;; uncommenting source code.
30 ;; Prior to calling any `comment-*' function, you should ensure that
31 ;; `comment-normalize-vars' is first called to set up the appropriate
32 ;; variables; except for the `comment-*' commands, which call
33 ;; `comment-normalize-vars' automatically as a subroutine.
35 ;;; Bugs:
37 ;; - boxed comments in Perl are not properly uncommented because they are
38 ;; uncommented one-line at a time.
39 ;; - nested comments in sgml-mode are not properly quoted.
40 ;; - single-char nestable comment-start can only do the "\\s<+" stuff
41 ;; if the corresponding closing marker happens to be right.
42 ;; - uncomment-region with a numeric argument can render multichar
43 ;; comment markers invalid.
44 ;; - comment-indent or comment-region when called inside a comment
45 ;; will happily break the surrounding comment.
46 ;; - comment-quote-nested will not (un)quote properly all nested comment
47 ;; markers if there are more than just comment-start and comment-end.
48 ;; For example, in Pascal where {...*) and (*...} are possible.
50 ;;; Todo:
52 ;; - rebox.el-style refill.
53 ;; - quantized steps in comment-alignment.
54 ;; - try to align tail comments.
55 ;; - check what c-comment-line-break-function has to say.
56 ;; - spill auto-fill of comments onto the end of the next line.
57 ;; - uncomment-region with a consp (for blocks) or somehow make the
58 ;; deletion of continuation markers less dangerous.
59 ;; - drop block-comment-<foo> unless it's really used.
60 ;; - uncomment-region on a subpart of a comment.
61 ;; - support gnu-style "multi-line with space in continue".
62 ;; - somehow allow comment-dwim to use the region even if transient-mark-mode
63 ;; is not turned on.
65 ;; - when auto-filling a comment, try to move the comment to the left
66 ;; rather than break it (if possible).
67 ;; - sometimes default the comment-column to the same
68 ;; one used on the preceding line(s).
70 ;;; Code:
72 ;;;###autoload
73 (defalias 'indent-for-comment 'comment-indent)
74 ;;;###autoload
75 (defalias 'set-comment-column 'comment-set-column)
76 ;;;###autoload
77 (defalias 'kill-comment 'comment-kill)
78 ;;;###autoload
79 (defalias 'indent-new-comment-line 'comment-indent-new-line)
81 (defgroup comment nil
82 "Indenting and filling of comments."
83 :prefix "comment-"
84 :version "21.1"
85 :group 'fill)
87 ;; Autoload this to avoid warnings, since some major modes define it.
88 ;;;###autoload
89 (defvar comment-use-syntax 'undecided
90 "Non-nil if syntax-tables can be used instead of regexps.
91 Can also be `undecided' which means that a somewhat expensive test will
92 be used to try to determine whether syntax-tables should be trusted
93 to understand comments or not in the given buffer.
94 Major modes should set this variable.")
96 (defcustom comment-fill-column nil
97 "Column to use for `comment-indent'. If nil, use `fill-column' instead."
98 :type '(choice (const nil) integer)
99 :group 'comment)
101 ;;;###autoload
102 (defcustom comment-column 32
103 "Column to indent right-margin comments to.
104 Each mode may establish a different default value for this variable; you
105 can set the value for a particular mode using that mode's hook.
106 Comments might be indented to a different value in order not to go beyond
107 `comment-fill-column' or in order to align them with surrounding comments."
108 :type 'integer
109 :group 'comment)
110 (make-variable-buffer-local 'comment-column)
111 ;;;###autoload
112 (put 'comment-column 'safe-local-variable 'integerp)
114 ;;;###autoload
115 (defvar comment-start nil
116 "String to insert to start a new comment, or nil if no comment syntax.")
117 ;;;###autoload
118 (put 'comment-start 'safe-local-variable 'string-or-null-p)
120 ;;;###autoload
121 (defvar comment-start-skip nil
122 "Regexp to match the start of a comment plus everything up to its body.
123 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
124 at the place matched by the close of the first pair.")
125 ;;;###autoload
126 (put 'comment-start-skip 'safe-local-variable 'stringp)
128 ;;;###autoload
129 (defvar comment-end-skip nil
130 "Regexp to match the end of a comment plus everything back to its body.")
131 ;;;###autoload
132 (put 'comment-end-skip 'safe-local-variable 'stringp)
134 ;;;###autoload
135 (defvar comment-end (purecopy "")
136 "String to insert to end a new comment.
137 Should be an empty string if comments are terminated by end-of-line.")
138 ;;;###autoload
139 (put 'comment-end 'safe-local-variable 'stringp)
141 ;;;###autoload
142 (defvar comment-indent-function 'comment-indent-default
143 "Function to compute desired indentation for a comment.
144 This function is called with no args with point at the beginning of
145 the comment's starting delimiter and should return either the desired
146 column indentation or nil.
147 If nil is returned, indentation is delegated to `indent-according-to-mode'.")
149 ;;;###autoload
150 (defvar comment-insert-comment-function nil
151 "Function to insert a comment when a line doesn't contain one.
152 The function has no args.
154 Applicable at least in modes for languages like fixed-format Fortran where
155 comments always start in column zero.")
157 (defvar comment-region-function 'comment-region-default
158 "Function to comment a region.
159 Its args are the same as those of `comment-region', but BEG and END are
160 guaranteed to be correctly ordered. It is called within `save-excursion'.
162 Applicable at least in modes for languages like fixed-format Fortran where
163 comments always start in column zero.")
165 (defvar uncomment-region-function 'uncomment-region-default
166 "Function to uncomment a region.
167 Its args are the same as those of `uncomment-region', but BEG and END are
168 guaranteed to be correctly ordered. It is called within `save-excursion'.
170 Applicable at least in modes for languages like fixed-format Fortran where
171 comments always start in column zero.")
173 ;; ?? never set
174 (defvar block-comment-start nil)
175 (defvar block-comment-end nil)
177 (defvar comment-quote-nested t
178 "Non-nil if nested comments should be quoted.
179 This should be locally set by each major mode if needed.")
181 (defvar comment-continue nil
182 "Continuation string to insert for multiline comments.
183 This string will be added at the beginning of each line except the very
184 first one when commenting a region with a commenting style that allows
185 comments to span several lines.
186 It should generally have the same length as `comment-start' in order to
187 preserve indentation.
188 If it is nil a value will be automatically derived from `comment-start'
189 by replacing its first character with a space.")
191 (defvar comment-add 0
192 "How many more comment chars should be inserted by `comment-region'.
193 This determines the default value of the numeric argument of `comment-region'.
194 The `plain' comment style doubles this value.
196 This should generally stay 0, except for a few modes like Lisp where
197 it is 1 so that regions are commented with two or three semi-colons.")
199 ;;;###autoload
200 (defconst comment-styles
201 '((plain nil nil nil nil
202 "Start in column 0 (do not indent), as in Emacs-20")
203 (indent-or-triple nil nil nil multi-char
204 "Start in column 0, but only for single-char starters")
205 (indent nil nil nil t
206 "Full comment per line, ends not aligned")
207 (aligned nil t nil t
208 "Full comment per line, ends aligned")
209 (box nil t t t
210 "Full comment per line, ends aligned, + top and bottom")
211 (extra-line t nil t t
212 "One comment for all lines, end on a line by itself")
213 (multi-line t nil nil t
214 "One comment for all lines, end on last commented line")
215 (box-multi t t t t
216 "One comment for all lines, + top and bottom"))
217 "Comment region style definitions.
218 Each style is defined with a form (STYLE . (MULTI ALIGN EXTRA INDENT DOC)).
219 DOC should succinctly describe the style.
220 STYLE should be a mnemonic symbol.
221 MULTI specifies that comments are allowed to span multiple lines.
222 e.g. in C it comments regions as
223 /* blabla
224 * bli */
225 rather than
226 /* blabla */
227 /* bli */
228 if `comment-end' is empty, this has no effect.
230 ALIGN specifies that the `comment-end' markers should be aligned.
231 e.g. in C it comments regions as
232 /* blabla */
233 /* bli */
234 rather than
235 /* blabla */
236 /* bli */
237 if `comment-end' is empty, this has no effect, unless EXTRA is also set,
238 in which case the comment gets wrapped in a box.
240 EXTRA specifies that an extra line should be used before and after the
241 region to comment (to put the `comment-end' and `comment-start').
242 e.g. in C it comments regions as
244 * blabla
245 * bli
247 rather than
248 /* blabla
249 * bli */
250 if the comment style is not multi line, this has no effect, unless ALIGN
251 is also set, in which case the comment gets wrapped in a box.
253 INDENT specifies that the `comment-start' markers should not be put at the
254 left margin but at the current indentation of the region to comment.
255 If INDENT is `multi-char', that means indent multi-character
256 comment starters, but not one-character comment starters.")
258 ;;;###autoload
259 (defcustom comment-style 'indent
260 "Style to be used for `comment-region'.
261 See `comment-styles' for a list of available styles."
262 :type (if (boundp 'comment-styles)
263 `(choice
264 ,@(mapcar (lambda (s)
265 `(const :tag ,(format "%s: %s" (car s) (nth 5 s))
266 ,(car s)))
267 comment-styles))
268 'symbol)
269 :version "23.1"
270 :group 'comment)
272 ;;;###autoload
273 (defcustom comment-padding (purecopy " ")
274 "Padding string that `comment-region' puts between comment chars and text.
275 Can also be an integer which will be automatically turned into a string
276 of the corresponding number of spaces.
278 Extra spacing between the comment characters and the comment text
279 makes the comment easier to read. Default is 1. nil means 0."
280 :type '(choice string integer (const nil))
281 :group 'comment)
283 (defcustom comment-inline-offset 1
284 "Inline comments have to be preceded by at least this many spaces.
285 This is useful when style-conventions require a certain minimal offset.
286 Python's PEP8 for example recommends two spaces, so you could do:
288 \(add-hook 'python-mode-hook
289 (lambda () (set (make-local-variable 'comment-inline-offset) 2)))
291 See `comment-padding' for whole-line comments."
292 :version "24.3"
293 :type 'integer
294 :group 'comment)
296 ;;;###autoload
297 (defcustom comment-multi-line nil
298 "Non-nil means `comment-indent-new-line' continues comments.
299 That is, it inserts no new terminator or starter.
300 This affects `auto-fill-mode', which is the main reason to
301 customize this variable.
303 It also affects \\[indent-new-comment-line]. However, if you want this
304 behavior for explicit filling, you might as well use \\[newline-and-indent]."
305 :type 'boolean
306 :group 'comment)
308 (defcustom comment-empty-lines nil
309 "If nil, `comment-region' does not comment out empty lines.
310 If t, it always comments out empty lines.
311 If `eol' it only comments out empty lines if comments are
312 terminated by the end of line (i.e. `comment-end' is empty)."
313 :type '(choice (const :tag "Never" nil)
314 (const :tag "Always" t)
315 (const :tag "EOl-terminated" 'eol))
316 :group 'comment)
318 ;;;;
319 ;;;; Helpers
320 ;;;;
322 (defun comment-string-strip (str beforep afterp)
323 "Strip STR of any leading (if BEFOREP) and/or trailing (if AFTERP) space."
324 (string-match (concat "\\`" (if beforep "\\s-*")
325 "\\(.*?\\)" (if afterp "\\s-*\n?")
326 "\\'") str)
327 (match-string 1 str))
329 (defun comment-string-reverse (s)
330 "Return the mirror image of string S, without any trailing space."
331 (comment-string-strip (concat (nreverse (string-to-list s))) nil t))
333 ;;;###autoload
334 (defun comment-normalize-vars (&optional noerror)
335 "Check and set up variables needed by other commenting functions.
336 All the `comment-*' commands call this function to set up various
337 variables, like `comment-start', to ensure that the commenting
338 functions work correctly. Lisp callers of any other `comment-*'
339 function should first call this function explicitly."
340 (unless (and (not comment-start) noerror)
341 (unless comment-start
342 (let ((cs (read-string "No comment syntax is defined. Use: ")))
343 (if (zerop (length cs))
344 (error "No comment syntax defined")
345 (set (make-local-variable 'comment-start) cs)
346 (set (make-local-variable 'comment-start-skip) cs))))
347 ;; comment-use-syntax
348 (when (eq comment-use-syntax 'undecided)
349 (set (make-local-variable 'comment-use-syntax)
350 (let ((st (syntax-table))
351 (cs comment-start)
352 (ce (if (string= "" comment-end) "\n" comment-end)))
353 ;; Try to skip over a comment using forward-comment
354 ;; to see if the syntax tables properly recognize it.
355 (with-temp-buffer
356 (set-syntax-table st)
357 (insert cs " hello " ce)
358 (goto-char (point-min))
359 (and (forward-comment 1) (eobp))))))
360 ;; comment-padding
361 (unless comment-padding (setq comment-padding 0))
362 (when (integerp comment-padding)
363 (setq comment-padding (make-string comment-padding ? )))
364 ;; comment markers
365 ;;(setq comment-start (comment-string-strip comment-start t nil))
366 ;;(setq comment-end (comment-string-strip comment-end nil t))
367 ;; comment-continue
368 (unless (or comment-continue (string= comment-end ""))
369 (set (make-local-variable 'comment-continue)
370 (concat (if (string-match "\\S-\\S-" comment-start) " " "|")
371 (substring comment-start 1)))
372 ;; Hasn't been necessary yet.
373 ;; (unless (string-match comment-start-skip comment-continue)
374 ;; (kill-local-variable 'comment-continue))
376 ;; comment-skip regexps
377 (unless (and comment-start-skip
378 ;; In case comment-start has changed since last time.
379 (string-match comment-start-skip comment-start))
380 (set (make-local-variable 'comment-start-skip)
381 (concat "\\(\\(^\\|[^\\\n]\\)\\(\\\\\\\\\\)*\\)\\(\\s<+\\|"
382 (regexp-quote (comment-string-strip comment-start t t))
383 ;; Let's not allow any \s- but only [ \t] since \n
384 ;; might be both a comment-end marker and \s-.
385 "+\\)[ \t]*")))
386 (unless (and comment-end-skip
387 ;; In case comment-end has changed since last time.
388 (string-match comment-end-skip
389 (if (string= "" comment-end) "\n" comment-end)))
390 (let ((ce (if (string= "" comment-end) "\n"
391 (comment-string-strip comment-end t t))))
392 (set (make-local-variable 'comment-end-skip)
393 ;; We use [ \t] rather than \s- because we don't want to
394 ;; remove ^L in C mode when uncommenting.
395 (concat "[ \t]*\\(\\s>" (if comment-quote-nested "" "+")
396 "\\|" (regexp-quote (substring ce 0 1))
397 (if (and comment-quote-nested (<= (length ce) 1)) "" "+")
398 (regexp-quote (substring ce 1))
399 "\\)"))))))
401 (defun comment-quote-re (str unp)
402 (concat (regexp-quote (substring str 0 1))
403 "\\\\" (if unp "+" "*")
404 (regexp-quote (substring str 1))))
406 (defun comment-quote-nested (cs ce unp)
407 "Quote or unquote nested comments.
408 If UNP is non-nil, unquote nested comment markers."
409 (setq cs (comment-string-strip cs t t))
410 (setq ce (comment-string-strip ce t t))
411 (when (and comment-quote-nested (> (length ce) 0))
412 (let ((re (concat (comment-quote-re ce unp)
413 "\\|" (comment-quote-re cs unp))))
414 (goto-char (point-min))
415 (while (re-search-forward re nil t)
416 (goto-char (match-beginning 0))
417 (forward-char 1)
418 (if unp (delete-char 1) (insert "\\"))
419 (when (= (length ce) 1)
420 ;; If the comment-end is a single char, adding a \ after that
421 ;; "first" char won't deactivate it, so we turn such a CE
422 ;; into !CS. I.e. for pascal, we turn } into !{
423 (if (not unp)
424 (when (string= (match-string 0) ce)
425 (replace-match (concat "!" cs) t t))
426 (when (and (< (point-min) (match-beginning 0))
427 (string= (buffer-substring (1- (match-beginning 0))
428 (1- (match-end 0)))
429 (concat "!" cs)))
430 (backward-char 2)
431 (delete-char (- (match-end 0) (match-beginning 0)))
432 (insert ce))))))))
434 ;;;;
435 ;;;; Navigation
436 ;;;;
438 (defvar comment-use-global-state t
439 "Non-nil means that the global syntactic context is used.
440 More specifically, it means that `syntax-ppss' is used to find out whether
441 point is within a string or not. Major modes whose syntax is not faithfully
442 described by the syntax-tables (or where `font-lock-syntax-table' is radically
443 different from the main syntax table) can set this to nil,
444 then `syntax-ppss' cache won't be used in comment-related routines.")
446 (make-obsolete-variable 'comment-use-global-state 'comment-use-syntax "24.4")
448 (defun comment-search-forward (limit &optional noerror)
449 "Find a comment start between point and LIMIT.
450 Moves point to inside the comment and returns the position of the
451 comment-starter. If no comment is found, moves point to LIMIT
452 and raises an error or returns nil if NOERROR is non-nil.
454 Ensure that `comment-normalize-vars' has been called before you use this."
455 (if (not comment-use-syntax)
456 (if (re-search-forward comment-start-skip limit noerror)
457 (or (match-end 1) (match-beginning 0))
458 (goto-char limit)
459 (unless noerror (error "No comment")))
460 (let* ((pt (point))
461 ;; Assume (at first) that pt is outside of any string.
462 (s (parse-partial-sexp pt (or limit (point-max)) nil nil
463 (if comment-use-global-state (syntax-ppss pt))
464 t)))
465 (when (and (nth 8 s) (nth 3 s) (not comment-use-global-state))
466 ;; The search ended at eol inside a string. Try to see if it
467 ;; works better when we assume that pt is inside a string.
468 (setq s (parse-partial-sexp
469 pt (or limit (point-max)) nil nil
470 (list nil nil nil (nth 3 s) nil nil nil nil)
471 t)))
472 (if (or (not (and (nth 8 s) (not (nth 3 s))))
473 ;; Make sure the comment starts after PT.
474 (< (nth 8 s) pt))
475 (unless noerror (error "No comment"))
476 ;; We found the comment.
477 (let ((pos (point))
478 (start (nth 8 s))
479 (bol (line-beginning-position))
480 (end nil))
481 (while (and (null end) (>= (point) bol))
482 (if (looking-at comment-start-skip)
483 (setq end (min (or limit (point-max)) (match-end 0)))
484 (backward-char)))
485 (goto-char (or end pos))
486 start)))))
488 (defun comment-search-backward (&optional limit noerror)
489 "Find a comment start between LIMIT and point.
490 Moves point to inside the comment and returns the position of the
491 comment-starter. If no comment is found, moves point to LIMIT
492 and raises an error or returns nil if NOERROR is non-nil.
494 Ensure that `comment-normalize-vars' has been called before you use this."
495 ;; FIXME: If a comment-start appears inside a comment, we may erroneously
496 ;; stop there. This can be rather bad in general, but since
497 ;; comment-search-backward is only used to find the comment-column (in
498 ;; comment-set-column) and to find the comment-start string (via
499 ;; comment-beginning) in indent-new-comment-line, it should be harmless.
500 (if (not (re-search-backward comment-start-skip limit t))
501 (unless noerror (error "No comment"))
502 (beginning-of-line)
503 (let* ((end (match-end 0))
504 (cs (comment-search-forward end t))
505 (pt (point)))
506 (if (not cs)
507 (progn (beginning-of-line)
508 (comment-search-backward limit noerror))
509 (while (progn (goto-char cs)
510 (comment-forward)
511 (and (< (point) end)
512 (setq cs (comment-search-forward end t))))
513 (setq pt (point)))
514 (goto-char pt)
515 cs))))
517 (defun comment-beginning ()
518 "Find the beginning of the enclosing comment.
519 Returns nil if not inside a comment, else moves point and returns
520 the same as `comment-search-backward'."
521 (if (and comment-use-syntax comment-use-global-state)
522 (let ((state (syntax-ppss)))
523 (when (nth 4 state)
524 (goto-char (nth 8 state))
525 (prog1 (point)
526 (when (looking-at comment-start-skip)
527 (goto-char (match-end 0))))))
528 ;; Can't rely on the syntax table, let's guess based on font-lock.
529 (unless (eq (get-text-property (point) 'face) 'font-lock-string-face)
530 (let ((pt (point))
531 (cs (comment-search-backward nil t)))
532 (when cs
533 (if (save-excursion
534 (goto-char cs)
535 (and
536 ;; For modes where comment-start and comment-end are the same,
537 ;; the search above may have found a `ce' rather than a `cs'.
538 (or (if comment-end-skip (not (looking-at comment-end-skip)))
539 ;; Maybe font-lock knows that it's a `cs'?
540 (eq (get-text-property (match-end 0) 'face)
541 'font-lock-comment-face)
542 (unless (eq (get-text-property (point) 'face)
543 'font-lock-comment-face)
544 ;; Let's assume it's a `cs' if we're on the same line.
545 (>= (line-end-position) pt)))
546 ;; Make sure that PT is not past the end of the comment.
547 (if (comment-forward 1) (> (point) pt) (eobp))))
549 (goto-char pt)
550 nil))))))
552 (defun comment-forward (&optional n)
553 "Skip forward over N comments.
554 Just like `forward-comment' but only for positive N
555 and can use regexps instead of syntax."
556 (setq n (or n 1))
557 (if (< n 0) (error "No comment-backward")
558 (if comment-use-syntax (forward-comment n)
559 (while (> n 0)
560 (setq n
561 (if (or (forward-comment 1)
562 (and (looking-at comment-start-skip)
563 (goto-char (match-end 0))
564 (re-search-forward comment-end-skip nil 'move)))
565 (1- n) -1)))
566 (= n 0))))
568 (defun comment-enter-backward ()
569 "Move from the end of a comment to the end of its content.
570 Point is assumed to be just at the end of a comment."
571 (if (bolp)
572 ;; comment-end = ""
573 (progn (backward-char) (skip-syntax-backward " "))
574 (cond
575 ((save-excursion
576 (save-restriction
577 (narrow-to-region (line-beginning-position) (point))
578 (goto-char (point-min))
579 (re-search-forward (concat comment-end-skip "\\'") nil t)))
580 (goto-char (match-beginning 0)))
581 ;; comment-end-skip not found probably because it was not set
582 ;; right. Since \\s> should catch the single-char case, let's
583 ;; check that we're looking at a two-char comment ender.
584 ((not (or (<= (- (point-max) (line-beginning-position)) 1)
585 (zerop (logand (car (syntax-after (- (point) 1)))
586 ;; Here we take advantage of the fact that
587 ;; the syntax class " " is encoded to 0,
588 ;; so " 4" gives us just the 4 bit.
589 (car (string-to-syntax " 4"))))
590 (zerop (logand (car (syntax-after (- (point) 2)))
591 (car (string-to-syntax " 3"))))))
592 (backward-char 2)
593 (skip-chars-backward (string (char-after)))
594 (skip-syntax-backward " "))
595 ;; No clue what's going on: maybe we're really not right after the
596 ;; end of a comment. Maybe we're at the "end" because of EOB rather
597 ;; than because of a marker.
598 (t (skip-syntax-backward " ")))))
600 ;;;;
601 ;;;; Commands
602 ;;;;
604 ;;;###autoload
605 (defun comment-indent-default ()
606 "Default for `comment-indent-function'."
607 (if (and (looking-at "\\s<\\s<\\(\\s<\\)?")
608 (or (match-end 1) (/= (current-column) (current-indentation))))
610 (when (or (/= (current-column) (current-indentation))
611 (and (> comment-add 0) (looking-at "\\s<\\(\\S<\\|\\'\\)")))
612 comment-column)))
614 (defun comment-choose-indent (&optional indent)
615 "Choose the indentation to use for a right-hand-side comment.
616 The criteria are (in this order):
617 - try to keep the comment's text within `comment-fill-column'.
618 - try to align with surrounding comments.
619 - prefer INDENT (or `comment-column' if nil).
620 Point is expected to be at the start of the comment."
621 (unless indent (setq indent comment-column))
622 ;; Avoid moving comments past the fill-column.
623 (let ((max (+ (current-column)
624 (- (or comment-fill-column fill-column)
625 (save-excursion (end-of-line) (current-column)))))
626 (other nil)
627 (min (save-excursion (skip-chars-backward " \t")
628 (if (bolp) 0 (+ comment-inline-offset (current-column))))))
629 ;; Fix up the range.
630 (if (< max min) (setq max min))
631 ;; Don't move past the fill column.
632 (if (<= max indent) (setq indent max))
633 ;; We can choose anywhere between min..max.
634 ;; Let's try to align to a comment on the previous line.
635 (save-excursion
636 (when (and (zerop (forward-line -1))
637 (setq other (comment-search-forward
638 (line-end-position) t)))
639 (goto-char other) (setq other (current-column))))
640 (if (and other (<= other max) (>= other min))
641 ;; There is a comment and it's in the range: bingo!
642 other
643 ;; Can't align to a previous comment: let's try to align to comments
644 ;; on the following lines, then. These have not been re-indented yet,
645 ;; so we can't directly align ourselves with them. All we do is to try
646 ;; and choose an indentation point with which they will be able to
647 ;; align themselves.
648 (save-excursion
649 (while (and (zerop (forward-line 1))
650 (setq other (comment-search-forward
651 (line-end-position) t)))
652 (goto-char other)
653 (let ((omax (+ (current-column)
654 (- (or comment-fill-column fill-column)
655 (save-excursion (end-of-line) (current-column)))))
656 (omin (save-excursion (skip-chars-backward " \t")
657 (1+ (current-column)))))
658 (if (and (>= omax min) (<= omin max))
659 (progn (setq min (max omin min))
660 (setq max (min omax max)))
661 ;; Can't align with this anyway, so exit the loop.
662 (goto-char (point-max))))))
663 ;; Return the closest point to indent within min..max.
664 (max min (min max indent)))))
666 ;;;###autoload
667 (defun comment-indent (&optional continue)
668 "Indent this line's comment to `comment-column', or insert an empty comment.
669 If CONTINUE is non-nil, use the `comment-continue' markers if any."
670 (interactive "*")
671 (comment-normalize-vars)
672 (let* ((empty (save-excursion (beginning-of-line)
673 (looking-at "[ \t]*$")))
674 (starter (or (and continue comment-continue)
675 (and empty block-comment-start) comment-start))
676 (ender (or (and continue comment-continue "")
677 (and empty block-comment-end) comment-end)))
678 (unless starter (error "No comment syntax defined"))
679 (beginning-of-line)
680 (let* ((eolpos (line-end-position))
681 (begpos (comment-search-forward eolpos t))
682 cpos indent)
683 (if (and comment-insert-comment-function (not begpos))
684 ;; If no comment and c-i-c-f is set, let it do everything.
685 (funcall comment-insert-comment-function)
686 ;; An existing comment?
687 (if begpos
688 (progn
689 (if (and (not (looking-at "[\t\n ]"))
690 (looking-at comment-end-skip))
691 ;; The comment is empty and we have skipped all its space
692 ;; and landed right before the comment-ender:
693 ;; Go back to the middle of the space.
694 (forward-char (/ (skip-chars-backward " \t") -2)))
695 (setq cpos (point-marker)))
696 ;; If none, insert one.
697 (save-excursion
698 ;; Some `comment-indent-function's insist on not moving
699 ;; comments that are in column 0, so we first go to the
700 ;; likely target column.
701 (indent-to comment-column)
702 ;; Ensure there's a space before the comment for things
703 ;; like sh where it matters (as well as being neater).
704 (unless (memq (char-before) '(nil ?\n ?\t ?\s))
705 (insert ?\s))
706 (setq begpos (point))
707 (insert starter)
708 (setq cpos (point-marker))
709 (insert ender)))
710 (goto-char begpos)
711 ;; Compute desired indent.
712 (setq indent (save-excursion (funcall comment-indent-function)))
713 ;; If `indent' is nil and there's code before the comment, we can't
714 ;; use `indent-according-to-mode', so we default to comment-column.
715 (unless (or indent (save-excursion (skip-chars-backward " \t") (bolp)))
716 (setq indent comment-column))
717 (if (not indent)
718 ;; comment-indent-function refuses: delegate to line-indent.
719 (indent-according-to-mode)
720 ;; If the comment is at the right of code, adjust the indentation.
721 (unless (save-excursion (skip-chars-backward " \t") (bolp))
722 (setq indent (comment-choose-indent indent)))
723 ;; Update INDENT to leave at least one space
724 ;; after other nonwhite text on the line.
725 (save-excursion
726 (skip-chars-backward " \t")
727 (unless (bolp)
728 (setq indent (max indent
729 (+ (current-column) comment-inline-offset)))))
730 ;; If that's different from comment's current position, change it.
731 (unless (= (current-column) indent)
732 (delete-region (point) (progn (skip-chars-backward " \t") (point)))
733 (indent-to indent)))
734 (goto-char cpos)
735 (set-marker cpos nil)))))
737 ;;;###autoload
738 (defun comment-set-column (arg)
739 "Set the comment column based on point.
740 With no ARG, set the comment column to the current column.
741 With just minus as arg, kill any comment on this line.
742 With any other arg, set comment column to indentation of the previous comment
743 and then align or create a comment on this line at that column."
744 (interactive "P")
745 (cond
746 ((eq arg '-) (comment-kill nil))
747 (arg
748 (comment-normalize-vars)
749 (save-excursion
750 (beginning-of-line)
751 (comment-search-backward)
752 (beginning-of-line)
753 (goto-char (comment-search-forward (line-end-position)))
754 (setq comment-column (current-column))
755 (message "Comment column set to %d" comment-column))
756 (comment-indent))
757 (t (setq comment-column (current-column))
758 (message "Comment column set to %d" comment-column))))
760 ;;;###autoload
761 (defun comment-kill (arg)
762 "Kill the first comment on this line, if any.
763 With prefix ARG, kill comments on that many lines starting with this one."
764 (interactive "P")
765 (comment-normalize-vars)
766 (dotimes (_i (prefix-numeric-value arg))
767 (save-excursion
768 (beginning-of-line)
769 (let ((cs (comment-search-forward (line-end-position) t)))
770 (when cs
771 (goto-char cs)
772 (skip-syntax-backward " ")
773 (setq cs (point))
774 (comment-forward)
775 (kill-region cs (if (bolp) (1- (point)) (point)))
776 (indent-according-to-mode))))
777 (if arg (forward-line 1))))
779 (defun comment-padright (str &optional n)
780 "Construct a string composed of STR plus `comment-padding'.
781 It also adds N copies of the last non-whitespace chars of STR.
782 If STR already contains padding, the corresponding amount is
783 ignored from `comment-padding'.
784 N defaults to 0.
785 If N is `re', a regexp is returned instead, that would match
786 the string for any N."
787 (setq n (or n 0))
788 (when (and (stringp str) (not (string= "" str)))
789 ;; Separate the actual string from any leading/trailing padding
790 (string-match "\\`\\s-*\\(.*?\\)\\s-*\\'" str)
791 (let ((s (match-string 1 str)) ;actual string
792 (lpad (substring str 0 (match-beginning 1))) ;left padding
793 (rpad (concat (substring str (match-end 1)) ;original right padding
794 (substring comment-padding ;additional right padding
795 (min (- (match-end 0) (match-end 1))
796 (length comment-padding)))))
797 ;; We can only duplicate C if the comment-end has multiple chars
798 ;; or if comments can be nested, else the comment-end `}' would
799 ;; be turned into `}}}' where only the first ends the comment
800 ;; and the rest becomes bogus junk.
801 (multi (not (and comment-quote-nested
802 ;; comment-end is a single char
803 (string-match "\\`\\s-*\\S-\\s-*\\'" comment-end)))))
804 (if (not (symbolp n))
805 (concat lpad s (when multi (make-string n (aref str (1- (match-end 1))))) rpad)
806 ;; construct a regexp that would match anything from just S
807 ;; to any possible output of this function for any N.
808 (concat (mapconcat (lambda (c) (concat (regexp-quote (string c)) "?"))
809 lpad "") ;padding is not required
810 (regexp-quote s)
811 (when multi "+") ;the last char of S might be repeated
812 (mapconcat (lambda (c) (concat (regexp-quote (string c)) "?"))
813 rpad "")))))) ;padding is not required
815 (defun comment-padleft (str &optional n)
816 "Construct a string composed of `comment-padding' plus STR.
817 It also adds N copies of the first non-whitespace chars of STR.
818 If STR already contains padding, the corresponding amount is
819 ignored from `comment-padding'.
820 N defaults to 0.
821 If N is `re', a regexp is returned instead, that would match
822 the string for any N."
823 (setq n (or n 0))
824 (when (and (stringp str) (not (string= "" str)))
825 ;; Only separate the left pad because we assume there is no right pad.
826 (string-match "\\`\\s-*" str)
827 (let ((s (substring str (match-end 0)))
828 (pad (concat (substring comment-padding
829 (min (- (match-end 0) (match-beginning 0))
830 (length comment-padding)))
831 (match-string 0 str)))
832 (c (aref str (match-end 0))) ;the first non-space char of STR
833 ;; We can only duplicate C if the comment-end has multiple chars
834 ;; or if comments can be nested, else the comment-end `}' would
835 ;; be turned into `}}}' where only the first ends the comment
836 ;; and the rest becomes bogus junk.
837 (multi (not (and comment-quote-nested
838 ;; comment-end is a single char
839 (string-match "\\`\\s-*\\S-\\s-*\\'" comment-end)))))
840 (if (not (symbolp n))
841 (concat pad (when multi (make-string n c)) s)
842 ;; Construct a regexp that would match anything from just S
843 ;; to any possible output of this function for any N.
844 ;; We match any number of leading spaces because this regexp will
845 ;; be used for uncommenting where we might want to remove
846 ;; uncomment markers with arbitrary leading space (because
847 ;; they were aligned).
848 (concat "\\s-*"
849 (if multi (concat (regexp-quote (string c)) "*"))
850 (regexp-quote s))))))
852 ;;;###autoload
853 (defun uncomment-region (beg end &optional arg)
854 "Uncomment each line in the BEG .. END region.
855 The numeric prefix ARG can specify a number of chars to remove from the
856 comment markers."
857 (interactive "*r\nP")
858 (comment-normalize-vars)
859 (when (> beg end) (setq beg (prog1 end (setq end beg))))
860 ;; Bind `comment-use-global-state' to nil. While uncommenting a region
861 ;; (which works a line at a time), a comment can appear to be
862 ;; included in a mult-line string, but it is actually not.
863 (let ((comment-use-global-state nil))
864 (save-excursion
865 (funcall uncomment-region-function beg end arg))))
867 (defun uncomment-region-default (beg end &optional arg)
868 "Uncomment each line in the BEG .. END region.
869 The numeric prefix ARG can specify a number of chars to remove from the
870 comment markers."
871 (goto-char beg)
872 (setq end (copy-marker end))
873 (let* ((numarg (prefix-numeric-value arg))
874 (ccs comment-continue)
875 (srei (comment-padright ccs 're))
876 (csre (comment-padright comment-start 're))
877 (sre (and srei (concat "^\\s-*?\\(" srei "\\)")))
878 spt)
879 (while (and (< (point) end)
880 (setq spt (comment-search-forward end t)))
881 (let ((ipt (point))
882 ;; Find the end of the comment.
883 (ept (progn
884 (goto-char spt)
885 (unless (or (comment-forward)
886 ;; Allow non-terminated comments.
887 (eobp))
888 (error "Can't find the comment end"))
889 (point)))
890 (box nil)
891 (box-equal nil)) ;Whether we might be using `=' for boxes.
892 (save-restriction
893 (narrow-to-region spt ept)
895 ;; Remove the comment-start.
896 (goto-char ipt)
897 (skip-syntax-backward " ")
898 ;; A box-comment starts with a looong comment-start marker.
899 (when (and (or (and (= (- (point) (point-min)) 1)
900 (setq box-equal t)
901 (looking-at "=\\{7\\}")
902 (not (eq (char-before (point-max)) ?\n))
903 (skip-chars-forward "="))
904 (> (- (point) (point-min) (length comment-start)) 7))
905 (> (count-lines (point-min) (point-max)) 2))
906 (setq box t))
907 ;; Skip the padding. Padding can come from comment-padding and/or
908 ;; from comment-start, so we first check comment-start.
909 (if (or (save-excursion (goto-char (point-min)) (looking-at csre))
910 (looking-at (regexp-quote comment-padding)))
911 (goto-char (match-end 0)))
912 (when (and sre (looking-at (concat "\\s-*\n\\s-*" srei)))
913 (goto-char (match-end 0)))
914 (if (null arg) (delete-region (point-min) (point))
915 (let ((opoint (point-marker)))
916 (skip-syntax-backward " ")
917 (delete-char (- numarg))
918 (unless (and (not (bobp))
919 (save-excursion (goto-char (point-min))
920 (looking-at comment-start-skip)))
921 ;; If there's something left but it doesn't look like
922 ;; a comment-start any more, just remove it.
923 (delete-region (point-min) opoint))))
925 ;; Remove the end-comment (and leading padding and such).
926 (goto-char (point-max)) (comment-enter-backward)
927 ;; Check for special `=' used sometimes in comment-box.
928 (when (and box-equal (not (eq (char-before (point-max)) ?\n)))
929 (let ((pos (point)))
930 ;; skip `=' but only if there are at least 7.
931 (when (> (skip-chars-backward "=") -7) (goto-char pos))))
932 (unless (looking-at "\\(\n\\|\\s-\\)*\\'")
933 (when (and (bolp) (not (bobp))) (backward-char))
934 (if (null arg) (delete-region (point) (point-max))
935 (skip-syntax-forward " ")
936 (delete-char numarg)
937 (unless (or (eobp) (looking-at comment-end-skip))
938 ;; If there's something left but it doesn't look like
939 ;; a comment-end any more, just remove it.
940 (delete-region (point) (point-max)))))
942 ;; Unquote any nested end-comment.
943 (comment-quote-nested comment-start comment-end t)
945 ;; Eliminate continuation markers as well.
946 (when sre
947 (let* ((cce (comment-string-reverse (or comment-continue
948 comment-start)))
949 (erei (and box (comment-padleft cce 're)))
950 (ere (and erei (concat "\\(" erei "\\)\\s-*$"))))
951 (goto-char (point-min))
952 (while (progn
953 (if (and ere (re-search-forward
954 ere (line-end-position) t))
955 (replace-match "" t t nil (if (match-end 2) 2 1))
956 (setq ere nil))
957 (forward-line 1)
958 (re-search-forward sre (line-end-position) t))
959 (replace-match "" t t nil (if (match-end 2) 2 1)))))
960 ;; Go to the end for the next comment.
961 (goto-char (point-max))))))
962 (set-marker end nil))
964 (defun comment-make-extra-lines (cs ce ccs cce min-indent max-indent &optional block)
965 "Make the leading and trailing extra lines.
966 This is used for `extra-line' style (or `box' style if BLOCK is specified)."
967 (let ((eindent 0))
968 (if (not block)
969 ;; Try to match CS and CE's content so they align aesthetically.
970 (progn
971 (setq ce (comment-string-strip ce t t))
972 (when (string-match "\\(.+\\).*\n\\(.*?\\)\\1" (concat ce "\n" cs))
973 (setq eindent
974 (max (- (match-end 2) (match-beginning 2) (match-beginning 0))
975 0))))
976 ;; box comment
977 (let* ((width (- max-indent min-indent))
978 (s (concat cs "a=m" cce))
979 (e (concat ccs "a=m" ce))
980 (c (if (string-match ".*\\S-\\S-" cs)
981 (aref cs (1- (match-end 0)))
982 (if (and (equal comment-end "") (string-match ".*\\S-" cs))
983 (aref cs (1- (match-end 0))) ?=)))
984 (re "\\s-*a=m\\s-*")
985 (_ (string-match re s))
986 (lcs (length cs))
987 (fill
988 (make-string (+ width (- (match-end 0)
989 (match-beginning 0) lcs 3)) c)))
990 (setq cs (replace-match fill t t s))
991 (when (and (not (string-match comment-start-skip cs))
992 (string-match "a=m" s))
993 ;; The whitespace around CS cannot be ignored: put it back.
994 (setq re "a=m")
995 (setq fill (make-string (- width lcs) c))
996 (setq cs (replace-match fill t t s)))
997 (string-match re e)
998 (setq ce (replace-match fill t t e))))
999 (cons (concat cs "\n" (make-string min-indent ? ) ccs)
1000 (concat cce "\n" (make-string (+ min-indent eindent) ? ) ce))))
1002 (defmacro comment-with-narrowing (beg end &rest body)
1003 "Execute BODY with BEG..END narrowing.
1004 Space is added (and then removed) at the beginning for the text's
1005 indentation to be kept as it was before narrowing."
1006 (declare (debug t) (indent 2))
1007 (let ((bindent (make-symbol "bindent")))
1008 `(let ((,bindent (save-excursion (goto-char ,beg) (current-column))))
1009 (save-restriction
1010 (narrow-to-region ,beg ,end)
1011 (goto-char (point-min))
1012 (insert (make-string ,bindent ? ))
1013 (prog1
1014 (progn ,@body)
1015 ;; remove the bindent
1016 (save-excursion
1017 (goto-char (point-min))
1018 (when (looking-at " *")
1019 (let ((n (min (- (match-end 0) (match-beginning 0)) ,bindent)))
1020 (delete-char n)
1021 (setq ,bindent (- ,bindent n))))
1022 (end-of-line)
1023 (let ((e (point)))
1024 (beginning-of-line)
1025 (while (and (> ,bindent 0) (re-search-forward " *" e t))
1026 (let ((n (min ,bindent (- (match-end 0) (match-beginning 0) 1))))
1027 (goto-char (match-beginning 0))
1028 (delete-char n)
1029 (setq ,bindent (- ,bindent n)))))))))))
1031 (defun comment-add (arg)
1032 "Compute the number of extra comment starter characters.
1033 \(Extra semicolons in Lisp mode, extra stars in C mode, etc.)
1034 If ARG is non-nil, just follow ARG.
1035 If the comment starter is multi-char, just follow ARG.
1036 Otherwise obey `comment-add'."
1037 (if (and (null arg) (= (string-match "[ \t]*\\'" comment-start) 1))
1038 (* comment-add 1)
1039 (1- (prefix-numeric-value arg))))
1041 (defun comment-region-internal (beg end cs ce
1042 &optional ccs cce block lines indent)
1043 "Comment region BEG .. END.
1044 CS and CE are the comment start string and comment end string,
1045 respectively. CCS and CCE are the comment continuation strings
1046 for the start and end of lines, respectively (default to CS and CE).
1047 BLOCK indicates that end of lines should be marked with either CCE,
1048 CE or CS \(if CE is empty) and that those markers should be aligned.
1049 LINES indicates that an extra lines will be used at the beginning
1050 and end of the region for CE and CS.
1051 INDENT indicates to put CS and CCS at the current indentation of
1052 the region rather than at left margin."
1053 ;;(assert (< beg end))
1054 (let ((no-empty (not (or (eq comment-empty-lines t)
1055 (and comment-empty-lines (zerop (length ce))))))
1056 ce-sanitized)
1057 ;; Sanitize CE and CCE.
1058 (if (and (stringp ce) (string= "" ce)) (setq ce nil))
1059 (setq ce-sanitized ce)
1060 (if (and (stringp cce) (string= "" cce)) (setq cce nil))
1061 ;; If CE is empty, multiline cannot be used.
1062 (unless ce (setq ccs nil cce nil))
1063 ;; Should we mark empty lines as well ?
1064 (if (or ccs block lines) (setq no-empty nil))
1065 ;; Make sure we have end-markers for BLOCK mode.
1066 (when block (unless ce (setq ce (comment-string-reverse cs))))
1067 ;; If BLOCK is not requested, we don't need CCE.
1068 (unless block (setq cce nil))
1069 ;; Continuation defaults to the same as CS and CE.
1070 (unless ccs (setq ccs cs cce ce))
1072 (save-excursion
1073 (goto-char end)
1074 ;; If the end is not at the end of a line and the comment-end
1075 ;; is implicit (i.e. a newline), explicitly insert a newline.
1076 (unless (or ce-sanitized (eolp)) (insert "\n") (indent-according-to-mode))
1077 (comment-with-narrowing beg end
1078 (let ((min-indent (point-max))
1079 (max-indent 0))
1080 (goto-char (point-min))
1081 ;; Quote any nested comment marker
1082 (comment-quote-nested comment-start comment-end nil)
1084 ;; Loop over all lines to find the needed indentations.
1085 (goto-char (point-min))
1086 (while
1087 (progn
1088 (unless (looking-at "[ \t]*$")
1089 (setq min-indent (min min-indent (current-indentation))))
1090 (end-of-line)
1091 (setq max-indent (max max-indent (current-column)))
1092 (not (or (eobp) (progn (forward-line) nil)))))
1094 (setq max-indent
1095 (+ max-indent (max (length cs) (length ccs))
1096 ;; Inserting ccs can change max-indent by (1- tab-width)
1097 ;; but only if there are TABs in the boxed text, of course.
1098 (if (save-excursion (goto-char beg)
1099 (search-forward "\t" end t))
1100 (1- tab-width) 0)))
1101 (unless indent (setq min-indent 0))
1103 ;; make the leading and trailing lines if requested
1104 (when lines
1105 (let ((csce
1106 (comment-make-extra-lines
1107 cs ce ccs cce min-indent max-indent block)))
1108 (setq cs (car csce))
1109 (setq ce (cdr csce))))
1111 (goto-char (point-min))
1112 ;; Loop over all lines from BEG to END.
1113 (while
1114 (progn
1115 (unless (and no-empty (looking-at "[ \t]*$"))
1116 (move-to-column min-indent t)
1117 (insert cs) (setq cs ccs) ;switch to CCS after the first line
1118 (end-of-line)
1119 (if (eobp) (setq cce ce))
1120 (when cce
1121 (when block (move-to-column max-indent t))
1122 (insert cce)))
1123 (end-of-line)
1124 (not (or (eobp) (progn (forward-line) nil))))))))))
1126 ;;;###autoload
1127 (defun comment-region (beg end &optional arg)
1128 "Comment or uncomment each line in the region.
1129 With just \\[universal-argument] prefix arg, uncomment each line in region BEG .. END.
1130 Numeric prefix ARG means use ARG comment characters.
1131 If ARG is negative, delete that many comment characters instead.
1133 The strings used as comment starts are built from `comment-start'
1134 and `comment-padding'; the strings used as comment ends are built
1135 from `comment-end' and `comment-padding'.
1137 By default, the `comment-start' markers are inserted at the
1138 current indentation of the region, and comments are terminated on
1139 each line (even for syntaxes in which newline does not end the
1140 comment and blank lines do not get comments). This can be
1141 changed with `comment-style'."
1142 (interactive "*r\nP")
1143 (comment-normalize-vars)
1144 (if (> beg end) (let (mid) (setq mid beg beg end end mid)))
1145 (save-excursion
1146 ;; FIXME: maybe we should call uncomment depending on ARG.
1147 (funcall comment-region-function beg end arg)))
1149 (defun comment-region-default (beg end &optional arg)
1150 (let* ((numarg (prefix-numeric-value arg))
1151 (style (cdr (assoc comment-style comment-styles)))
1152 (lines (nth 2 style))
1153 (block (nth 1 style))
1154 (multi (nth 0 style)))
1156 ;; We use `chars' instead of `syntax' because `\n' might be
1157 ;; of end-comment syntax rather than of whitespace syntax.
1158 ;; sanitize BEG and END
1159 (goto-char beg) (skip-chars-forward " \t\n\r") (beginning-of-line)
1160 (setq beg (max beg (point)))
1161 (goto-char end) (skip-chars-backward " \t\n\r") (end-of-line)
1162 (setq end (min end (point)))
1163 (if (>= beg end) (error "Nothing to comment"))
1165 ;; sanitize LINES
1166 (setq lines
1167 (and
1168 lines ;; multi
1169 (progn (goto-char beg) (beginning-of-line)
1170 (skip-syntax-forward " ")
1171 (>= (point) beg))
1172 (progn (goto-char end) (end-of-line) (skip-syntax-backward " ")
1173 (<= (point) end))
1174 (or block (not (string= "" comment-end)))
1175 (or block (progn (goto-char beg) (search-forward "\n" end t)))))
1177 ;; don't add end-markers just because the user asked for `block'
1178 (unless (or lines (string= "" comment-end)) (setq block nil))
1180 (cond
1181 ((consp arg) (uncomment-region beg end))
1182 ((< numarg 0) (uncomment-region beg end (- numarg)))
1184 (let ((multi-char (/= (string-match "[ \t]*\\'" comment-start) 1))
1185 indent triple)
1186 (if (eq (nth 3 style) 'multi-char)
1187 (save-excursion
1188 (goto-char beg)
1189 (setq indent multi-char
1190 ;; Triple if we will put the comment starter at the margin
1191 ;; and the first line of the region isn't indented
1192 ;; at least two spaces.
1193 triple (and (not multi-char) (looking-at "\t\\| "))))
1194 (setq indent (nth 3 style)))
1196 ;; In Lisp and similar modes with one-character comment starters,
1197 ;; double it by default if `comment-add' says so.
1198 ;; If it isn't indented, triple it.
1199 (if (and (null arg) (not multi-char))
1200 (setq numarg (* comment-add (if triple 2 1)))
1201 (setq numarg (1- (prefix-numeric-value arg))))
1203 (comment-region-internal
1204 beg end
1205 (let ((s (comment-padright comment-start numarg)))
1206 (if (string-match comment-start-skip s) s
1207 (comment-padright comment-start)))
1208 (let ((s (comment-padleft comment-end numarg)))
1209 (and s (if (string-match comment-end-skip s) s
1210 (comment-padright comment-end))))
1211 (if multi (comment-padright comment-continue numarg))
1212 (if multi
1213 (comment-padleft (comment-string-reverse comment-continue) numarg))
1214 block
1215 lines
1216 indent))))))
1218 ;;;###autoload
1219 (defun comment-box (beg end &optional arg)
1220 "Comment out the BEG .. END region, putting it inside a box.
1221 The numeric prefix ARG specifies how many characters to add to begin- and
1222 end- comment markers additionally to what variable `comment-add' already
1223 specifies."
1224 (interactive "*r\np")
1225 (comment-normalize-vars)
1226 (let ((comment-style (if (cadr (assoc comment-style comment-styles))
1227 'box-multi 'box)))
1228 (comment-region beg end (+ comment-add arg))))
1230 (defun comment-only-p (beg end)
1231 "Return non-nil if the text between BEG and END is all comments."
1232 (save-excursion
1233 (goto-char beg)
1234 (comment-forward (point-max))
1235 (<= end (point))))
1237 ;;;###autoload
1238 (defun comment-or-uncomment-region (beg end &optional arg)
1239 "Call `comment-region', unless the region only consists of comments,
1240 in which case call `uncomment-region'. If a prefix arg is given, it
1241 is passed on to the respective function."
1242 (interactive "*r\nP")
1243 (comment-normalize-vars)
1244 (funcall (if (comment-only-p beg end)
1245 'uncomment-region 'comment-region)
1246 beg end arg))
1248 ;;;###autoload
1249 (defun comment-dwim (arg)
1250 "Call the comment command you want (Do What I Mean).
1251 If the region is active and `transient-mark-mode' is on, call
1252 `comment-region' (unless it only consists of comments, in which
1253 case it calls `uncomment-region').
1254 Else, if the current line is empty, call `comment-insert-comment-function'
1255 if it is defined, otherwise insert a comment and indent it.
1256 Else if a prefix ARG is specified, call `comment-kill'.
1257 Else, call `comment-indent'.
1258 You can configure `comment-style' to change the way regions are commented."
1259 (interactive "*P")
1260 (comment-normalize-vars)
1261 (if (and mark-active transient-mark-mode)
1262 (comment-or-uncomment-region (region-beginning) (region-end) arg)
1263 (if (save-excursion (beginning-of-line) (not (looking-at "\\s-*$")))
1264 ;; FIXME: If there's no comment to kill on this line and ARG is
1265 ;; specified, calling comment-kill is not very clever.
1266 (if arg (comment-kill (and (integerp arg) arg)) (comment-indent))
1267 ;; Inserting a comment on a blank line. comment-indent calls
1268 ;; c-i-c-f if needed in the non-blank case.
1269 (if comment-insert-comment-function
1270 (funcall comment-insert-comment-function)
1271 (let ((add (comment-add arg)))
1272 ;; Some modes insist on keeping column 0 comment in column 0
1273 ;; so we need to move away from it before inserting the comment.
1274 (indent-according-to-mode)
1275 (insert (comment-padright comment-start add))
1276 (save-excursion
1277 (unless (string= "" comment-end)
1278 (insert (comment-padleft comment-end add)))
1279 (indent-according-to-mode)))))))
1281 ;;;###autoload
1282 (defcustom comment-auto-fill-only-comments nil
1283 "Non-nil means to only auto-fill inside comments.
1284 This has no effect in modes that do not define a comment syntax."
1285 :type 'boolean
1286 :group 'comment)
1288 (defun comment-valid-prefix-p (prefix compos)
1289 "Check that the adaptive fill prefix is consistent with the context.
1290 PREFIX is the prefix (presumably guessed by `adaptive-fill-mode').
1291 COMPOS is the position of the beginning of the comment we're in, or nil
1292 if we're not inside a comment."
1293 ;; This consistency checking is mostly needed to workaround the limitation
1294 ;; of auto-fill-mode whose paragraph-determination doesn't pay attention
1295 ;; to comment boundaries.
1296 (if (null compos)
1297 ;; We're not inside a comment: the prefix shouldn't match
1298 ;; a comment-starter.
1299 (not (and comment-start comment-start-skip
1300 (string-match comment-start-skip prefix)))
1302 ;; Accept any prefix if the current comment is not EOL-terminated.
1303 (save-excursion (goto-char compos) (comment-forward) (not (bolp)))
1304 ;; Accept any prefix that starts with the same comment-start marker
1305 ;; as the current one.
1306 (when (string-match (concat "\\`[ \t]*\\(?:" comment-start-skip "\\)")
1307 prefix)
1308 (let ((prefix-com (comment-string-strip (match-string 0 prefix) nil t)))
1309 (string-match "\\`[ \t]*" prefix-com)
1310 (let* ((prefix-space (match-string 0 prefix-com))
1311 (prefix-indent (string-width prefix-space))
1312 (prefix-comstart (substring prefix-com (match-end 0))))
1313 (save-excursion
1314 (goto-char compos)
1315 ;; The comstart marker is the same.
1316 (and (looking-at (regexp-quote prefix-comstart))
1317 ;; The indentation as well.
1318 (or (= prefix-indent
1319 (- (current-column) (current-left-margin)))
1320 ;; Check the indentation in two different ways, just
1321 ;; to try and avoid most of the potential funny cases.
1322 (equal prefix-space
1323 (buffer-substring (point)
1324 (progn (move-to-left-margin)
1325 (point)))))))))))))
1328 ;;;###autoload
1329 (defun comment-indent-new-line (&optional soft)
1330 "Break line at point and indent, continuing comment if within one.
1331 This indents the body of the continued comment
1332 under the previous comment line.
1334 This command is intended for styles where you write a comment per line,
1335 starting a new comment (and terminating it if necessary) on each line.
1336 If you want to continue one comment across several lines, use \\[newline-and-indent].
1338 If a fill column is specified, it overrides the use of the comment column
1339 or comment indentation.
1341 The inserted newline is marked hard if variable `use-hard-newlines' is true,
1342 unless optional argument SOFT is non-nil."
1343 (interactive)
1344 (comment-normalize-vars t)
1345 (let (compos comin)
1346 ;; If we are not inside a comment and we only auto-fill comments,
1347 ;; don't do anything (unless no comment syntax is defined).
1348 (unless (and comment-start
1349 comment-auto-fill-only-comments
1350 (not (called-interactively-p 'interactive))
1351 (not (save-excursion
1352 (prog1 (setq compos (comment-beginning))
1353 (setq comin (point))))))
1355 ;; Now we know we should auto-fill.
1356 ;; Insert the newline before removing empty space so that markers
1357 ;; get preserved better.
1358 (if soft (insert-and-inherit ?\n) (newline 1))
1359 (save-excursion (forward-char -1) (delete-horizontal-space))
1360 (delete-horizontal-space)
1362 (if (and fill-prefix (not adaptive-fill-mode))
1363 ;; Blindly trust a non-adaptive fill-prefix.
1364 (progn
1365 (indent-to-left-margin)
1366 (insert-before-markers-and-inherit fill-prefix))
1368 ;; If necessary check whether we're inside a comment.
1369 (unless (or compos (null comment-start))
1370 (save-excursion
1371 (backward-char)
1372 (setq compos (comment-beginning))
1373 (setq comin (point))))
1375 (cond
1376 ;; If there's an adaptive prefix, use it unless we're inside
1377 ;; a comment and the prefix is not a comment starter.
1378 ((and fill-prefix
1379 (comment-valid-prefix-p fill-prefix compos))
1380 (indent-to-left-margin)
1381 (insert-and-inherit fill-prefix))
1382 ;; If we're not inside a comment, just try to indent.
1383 ((not compos) (indent-according-to-mode))
1385 (let* ((comment-column
1386 ;; The continuation indentation should be somewhere between
1387 ;; the current line's indentation (plus 2 for good measure)
1388 ;; and the current comment's indentation, with a preference
1389 ;; for comment-column.
1390 (save-excursion
1391 ;; FIXME: use prev line's info rather than first line's.
1392 (goto-char compos)
1393 (min (current-column) (max comment-column
1394 (+ 2 (current-indentation))))))
1395 (comstart (buffer-substring compos comin))
1396 (normalp
1397 (string-match (regexp-quote (comment-string-strip
1398 comment-start t t))
1399 comstart))
1400 (comment-end
1401 (if normalp comment-end
1402 ;; The comment starter is not the normal comment-start
1403 ;; so we can't just use comment-end.
1404 (save-excursion
1405 (goto-char compos)
1406 (if (not (comment-forward)) comment-end
1407 (comment-string-strip
1408 (buffer-substring
1409 (save-excursion (comment-enter-backward) (point))
1410 (point))
1411 nil t)))))
1412 (comment-start comstart)
1413 (continuep (or comment-multi-line
1414 (cadr (assoc comment-style comment-styles))))
1415 ;; Force comment-continue to be recreated from comment-start.
1416 ;; FIXME: wrong if comment-continue was set explicitly!
1417 ;; FIXME: use prev line's continuation if available.
1418 (comment-continue nil))
1419 (if (and comment-multi-line (> (length comment-end) 0))
1420 (indent-according-to-mode)
1421 (insert-and-inherit ?\n)
1422 (forward-char -1)
1423 (comment-indent continuep)
1424 (save-excursion
1425 (let ((pt (point)))
1426 (end-of-line)
1427 (let ((comend (buffer-substring pt (point))))
1428 ;; The 1+ is to make sure we delete the \n inserted above.
1429 (delete-region pt (1+ (point)))
1430 (end-of-line 0)
1431 (insert comend))))))))))))
1433 (provide 'newcomment)
1435 ;;; newcomment.el ends here