;;; newcomment.el --- (un)comment regions of buffers
-;; Copyright (C) 1999-2000 Free Software Foundation Inc.
+;; Copyright (C) 1999, 2000 Free Software Foundation Inc.
;; Author: code extracted from Emacs-20's simple.el
;; Maintainer: Stefan Monnier <monnier@cs.yale.edu>
;; Keywords: comment uncomment
-;; Version: $Name: $
-;; Revision: $Id: newcomment.el,v 1.17 2000/06/20 09:40:36 fx Exp $
+;; Revision: $Id: newcomment.el,v 1.30 2001/02/22 01:47:40 monnier Exp $
;; This file is part of GNU Emacs.
;; - somehow allow comment-dwim to use the region even if transient-mark-mode
;; is not turned on.
+;; - when auto-filling a comment, try to move the comment to the left
+;; rather than break it (if possible).
+;; - sometimes default the comment-column to the same
+;; one used on the preceding line(s).
+
;;; Code:
;;;###autoload
Should be an empty string if comments are terminated by end-of-line.")
;;;###autoload
-(defvar comment-indent-function
- (lambda () comment-column)
+(defvar comment-indent-function 'comment-indent-default
"Function to compute desired indentation for a comment.
This function is called with no args with point at the beginning of
-the comment's starting delimiter.")
+the comment's starting delimiter and should return either the desired
+column indentation or nil.
+If nil is returned, indentation is delegated to `indent-according-to-mode'.")
(defvar block-comment-start nil)
(defvar block-comment-end nil)
(set (make-local-variable 'comment-start-skip)
(concat "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)\\(\\s<+\\|"
(regexp-quote (comment-string-strip comment-start t t))
- "+\\)\\s-*")))
+ ;; Let's not allow any \s- but only [ \t] since \n
+ ;; might be both a comment-end marker and \s-.
+ "+\\)[ \t]*")))
(unless comment-end-skip
(let ((ce (if (string= "" comment-end) "\n"
(comment-string-strip comment-end t t))))
"Find the beginning of the enclosing comment.
Returns nil if not inside a comment, else moves point and returns
the same as `comment-search-forward'."
- (let ((pt (point))
- (cs (comment-search-backward nil t)))
- (when cs
- (if (save-excursion
- (goto-char cs)
- (if (comment-forward 1) (> (point) pt) (eobp)))
- cs
- (goto-char pt)
- nil))))
+ ;; HACK ATTACK!
+ ;; We should really test `in-string-p' but that can be expensive.
+ (unless (eq (get-text-property (point) 'face) 'font-lock-string-face)
+ (let ((pt (point))
+ (cs (comment-search-backward nil t)))
+ (when cs
+ (if (save-excursion
+ (goto-char cs)
+ (if (comment-forward 1) (> (point) pt) (eobp)))
+ cs
+ (goto-char pt)
+ nil)))))
(defun comment-forward (&optional n)
"Skip forward over N comments.
(skip-syntax-forward " ")
(setq n
(if (and (looking-at comment-start-skip)
+ (goto-char (match-end 0))
(re-search-forward comment-end-skip nil 'move))
(1- n) -1)))
(= n 0))))
;;;; Commands
;;;;
+;;;###autoload
+(defun comment-indent-default ()
+ "Default for `comment-indent-function'."
+ (if (and (looking-at "\\s<\\s<\\(\\s<\\)?")
+ (or (match-end 1) (/= (current-column) (current-indentation))))
+ 0
+ (when (or (/= (current-column) (current-indentation))
+ (and (> comment-add 0) (looking-at "\\s<\\S<")))
+ comment-column)))
+
;;;###autoload
(defun comment-indent (&optional continue)
"Indent this line's comment to comment column, or insert an empty comment.
(and empty block-comment-start) comment-start))
(ender (or (and continue comment-continue "")
(and empty block-comment-end) comment-end)))
- (cond
- ((null starter)
- (error "No comment syntax defined"))
- (t (let* ((eolpos (line-end-position))
- cpos indent begpos)
- (beginning-of-line)
- (if (not (setq begpos (comment-search-forward eolpos t)))
- (setq begpos (point))
+ (unless starter (error "No comment syntax defined"))
+ (beginning-of-line)
+ (let* ((eolpos (line-end-position))
+ (begpos (comment-search-forward eolpos t))
+ cpos indent)
+ ;; An existing comment?
+ (if begpos (setq cpos (point-marker))
+ ;; If none, insert one.
+ (save-excursion
+ ;; Some comment-indent-function insist on not moving comments that
+ ;; are in column 0, so we insert a space to avoid this special case
+ (insert " ")
+ (setq begpos (point))
+ (insert starter)
(setq cpos (point-marker))
- (goto-char begpos))
- ;; Compute desired indent.
- (if (= (current-column)
- (setq indent (funcall comment-indent-function)))
- (goto-char begpos)
- ;; If that's different from current, change it.
- (skip-chars-backward " \t")
- (delete-region (point) begpos)
- (indent-to indent))
- ;; An existing comment?
- (if cpos
- (progn (goto-char cpos) (set-marker cpos nil))
- ;; No, insert one.
- (insert starter)
- (save-excursion
- (insert ender))))))))
+ (insert ender)))
+ (goto-char begpos)
+ ;; Compute desired indent.
+ (setq indent (save-excursion (funcall comment-indent-function)))
+ (if (not indent)
+ ;; comment-indent-function refuses delegates to indent.
+ (indent-according-to-mode)
+ ;; Avoid moving comments past the fill-column.
+ (setq indent
+ (min indent
+ (+ (current-column)
+ (- fill-column
+ (save-excursion (end-of-line) (current-column))))))
+ (if (= (current-column) indent)
+ (goto-char begpos)
+ ;; If that's different from current, change it.
+ (skip-chars-backward " \t")
+ (delete-region (point) begpos)
+ (indent-to (if (bolp) indent
+ (max indent (1+ (current-column)))))))
+ (goto-char cpos)
+ (set-marker cpos nil))))
;;;###autoload
(defun comment-set-column (arg)
;;;###autoload
(defun comment-region (beg end &optional arg)
"Comment or uncomment each line in the region.
-With just \\[universal-prefix] prefix arg, uncomment each line in region BEG..END.
+With just \\[universal-argument] prefix arg, uncomment each line in region BEG..END.
Numeric prefix arg ARG means use ARG comment characters.
If ARG is negative, delete that many comment characters instead.
By default, comments start at the left margin, are terminated on each line,
(defun comment-dwim (arg)
"Call the comment command you want (Do What I Mean).
If the region is active and `transient-mark-mode' is on, call
- `comment-region' (unless it only consists in comments, in which
+ `comment-region' (unless it only consists of comments, in which
case it calls `uncomment-region').
Else, if the current line is empty, insert a comment and indent it.
Else if a prefix ARG is specified, call `comment-kill'.
(if arg (comment-kill (and (integerp arg) arg)) (comment-indent))
(let ((add (if arg (prefix-numeric-value arg)
(if (= (length comment-start) 1) comment-add 0))))
+ ;; Some modes insist on keeping column 0 comment in column 0
+ ;; so we need to move away from it before inserting the comment.
+ (indent-according-to-mode)
(insert (comment-padright comment-start add))
(save-excursion
(unless (string= "" comment-end)
(setq comin (point))))))
;; Now we know we should auto-fill.
- (delete-region (progn (skip-chars-backward " \t") (point))
- (progn (skip-chars-forward " \t") (point)))
+ (delete-horizontal-space)
(if soft (insert-and-inherit ?\n) (newline 1))
(if fill-prefix
(progn
(provide 'newcomment)
-;;; Change Log:
-;; $Log: newcomment.el,v $
-;; Revision 1.17 2000/06/20 09:40:36 fx
-;; (comment) <defgroup>: Add :version.
-;; (comment-multi-line): Doc fix.
-;;
-;; Revision 1.16 2000/06/04 22:02:11 monnier
-;; (comment-indent): Ignore comment-indent-hook.
-;;
-;; Revision 1.15 2000/05/25 19:05:46 monnier
-;; Add abundant autoload cookies.
-;; (comment-style): Be careful not to depend on runtime data at compile-time.
-;; (comment-indent-hook): Remove.
-;; (comment-indent): Check if comment-indent-hook is bound.
-;; (comment-region): Docstring fix.
-;;
-;; Revision 1.14 2000/05/23 20:06:10 monnier
-;; (comment-make-extra-lines): Don't use `assert'.
-;;
-;; Revision 1.13 2000/05/22 04:23:37 monnier
-;; (comment-region-internal): Go back to BEG after quoting
-;; the nested comment markers.
-;;
-;; Revision 1.12 2000/05/21 00:27:31 monnier
-;; (comment-styles): New `box-multi'.
-;; (comment-normalize-vars): Better default for comment-continue to
-;; avoid whitespace-only continuations.
-;; (comment-search-forward): Always move even in the no-syntax case.
-;; (comment-padright): Only obey N if it's only obeyed for padleft.
-;; (comment-make-extra-lines): Better handling of empty continuations.
-;; Use `=' for the filler if comment-start has only one character.
-;; (uncomment-region): Try handling the special `=' filler.
-;; (comment-region): Allow LINES even if MULTI is nil.
-;; (comment-box): Choose box style based on comment-style.
-;;
-;; Revision 1.11 2000/05/19 15:37:41 monnier
-;; Fix license text and author.
-;; Move aliases (indent-for-comment, set-comment-column, kill-comment
-;; and indent-new-comment-line) to the beginning of the file.
-;; Get rid of the last few CLisms.
-;; (comment-forward): Avoid decf.
-;; (comment-make-extra-lines): Comment-out asserts.
-;; (comment-with-narrowing): Properly create uninterned symbol.
-;; (comment-region-internal): Comment-out asserts. Avoid incf and decf.
-;; (comment-indent-new-line): Fix bug where compt could be set but
-;; not comstart. Set comment-column more carefully.
-;;
-;; Revision 1.10 2000/05/17 19:32:32 monnier
-;; (comment-beginning): Handle unclosed comment.
-;; (comment-auto-fill-only-comments): New var.
-;; (comment-indent-new-line): Obey comment-auto-fill-only-comments.
-;; Align with comment-column rather than previous comment if previous
-;; comment's indentation is greater than comment-column.
-;;
-;; Revision 1.9 2000/05/16 22:02:37 monnier
-;; (comment-string-strip): Strip terminating newlines.
-;; (comment-search-forward): Make LIMIT compulsory.
-;; If an unterminated string (rather than a comment) is found, try again,
-;; assuming that the region starts inside a string.
-;; (comment-beginning): Make sure we don't move if we find a comment but
-;; it's not the one we're in.
-;; (comment-enter-backward): Handle the case where comment-end-skip fails.
-;; (comment-indent): Normalize variables and use line-end-position.
-;; (comment-kill): Use line-end-position.
-;; (comment-spill): Remove.
-;; (comment-indent-new-line): Renamed from indent-new-comment-line.
-;; Cleaned up old commented-out code.
-;; Reset comment-continue and comment-end before calling comment-indent.
-;;
-;; Revision 1.8 2000/05/14 00:56:10 monnier
-;; (comment-start, comment-start-skip, comment-end): Made `defvar'.
-;; (comment-style): Extract the choice out of comment-styles.
-;; (comment-continue): Just a simple string now.
-;; (comment-normalize-vars): Update for the new comment-continue.
-;; (until, comment-end-quote-re): Removed.
-;; (comment-quote-re, comment-quote-nested): New functions for quoting.
-;; These quote both the end and the start and also work for single-chars.
-;; (comment-padright): Added lots of comments.
-;; (comment-padleft): Added more comments. Check comment-end rather than
-;; STR to determine whether N can be applied or not.
-;; (uncomment-region): Rename BLOCK to BOX.
-;; Use the new comment-quote-nested.
-;; Use only one marker and properly set it back to nil.
-;; Be more picky when eliminating continuation markers.
-;;
-;; Revision 1.7 2000/05/13 19:41:08 monnier
-;; (comment-use-syntax): Change `maybe' to `undecided'.
-;; (comment-quote-nested): New. Replaces comment-nested.
-;; (comment-add): Turn into a mere defvar or a integer.
-;; (comment-style): Change default to `plain'.
-;; (comment-styles): Rename `plain' to `indent' and create a new plainer `plain'
-;; (comment-string-reverse): Use nreverse.
-;; (comment-normalize-vars): Change `maybe' to `undecided', add comments.
-;; Don't infer the setting of comment-nested anymore (the default for
-;; comment-quote-nested is safe). Use comment-quote-nested.
-;; (comment-end-quote-re): Use comment-quote-nested.
-;; (comment-search-forward): Obey LIMIT.
-;; (comment-indent): Don't skip forward further past comment-search-forward.
-;; (comment-padleft): Use comment-quote-nested.
-;; (comment-make-extra-lines): Use `cons' rather than `values'.
-;; (comment-region-internal): New arg INDENT. Use line-end-position.
-;; Avoid multiple-value-setq.
-;; (comment-region): Follow the new comment-add semantics.
-;; Don't do box comments any more.
-;; (comment-box): New function.
-;; (comment-dwim): Only do the region stuff is transient-mark-active.
-;;
-;; Revision 1.6 1999/12/08 00:19:51 monnier
-;; various fixes and gratuitous movements.
-;;
-;; Revision 1.5 1999/11/30 16:20:55 monnier
-;; (comment-style(s)): Replaces comment-extra-lines (and comment-multi-line).
-;; (comment-use-syntax): Whether to use the syntax-table or just the regexps.
-;; (comment-end-skip): To find the end of the text.
-;; ...
-;;
-;; Revision 1.4 1999/11/29 01:31:47 monnier
-;; (comment-find): New function.
-;; (indent-for-comment, set-comment-column, kill-comment): use it.
-;;
-;; Revision 1.3 1999/11/29 00:49:18 monnier
-;; (kill-comment): Fixed by rewriting it with syntax-tables rather than regexps
-;; (comment-normalize-vars): Set default (cdr comment-continue)
-;; (comment-end-quote-re): new function taken out of `comment-region-internal'
-;; (uncomment-region): Rewritten using syntax-tables. Also unquotes
-;; nested comment-ends and eliminates continuation markers.
-;; (comment-region-internal): Don't create a default for cce.
-;; Use `comment-end-quote-re'.
-;;
-;; Revision 1.2 1999/11/28 21:33:55 monnier
-;; (comment-make-extra-lines): Moved out of comment-region-internal.
-;; (comment-with-narrowing): New macro. Provides a way to preserve
-;; indentation inside narrowing.
-;; (comment-region-internal): Add "\n" to close the comment if necessary.
-;; Correctly handle commenting-out when BEG is not bolp.
-;;
-;; Revision 1.1 1999/11/28 18:51:06 monnier
-;; First "working" version:
-;; - uncomment-region doesn't work for some unknown reason
-;; - comment-multi-line allows the use of multi line comments
-;; - comment-extra-lines allows yet another style choice
-;; - comment-add allows to default to `;;'
-;; - comment-region on a comment calls uncomment-region
-;; - C-u C-u comment-region aligns comment end markers
-;; - C-u C-u C-u comment-region puts the comment inside a rectangle
-;; - comment-region will try to quote comment-end markers inside the region
-;; - comment-start markers are placed at the indentation level
-;;
-
;;; newcomment.el ends here