(diary-face, holiday-face): Add dark-background variants.
[bpt/emacs.git] / lisp / newcomment.el
index a5ff8b8..b4bdc16 100644 (file)
@@ -2,25 +2,28 @@
 
 ;; Copyright (C) 1999-2000  Free Software Foundation Inc.
 
-;; Author: FSF??
+;; 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.8 2000/05/14 00:56:10 monnier Exp $
+;; Revision: $Id: newcomment.el,v 1.21 2000/10/05 22:43:22 monnier Exp $
 
-;; This program is free software; you can redistribute it and/or modify
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2 of the License, or
-;; (at your option) any later version.
-;; 
-;; This program is distributed in the hope that it will be useful,
+;; the Free Software Foundation; either version 2, or (at your option)
+;; any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;; GNU General Public License for more details.
-;; 
+
 ;; You should have received a copy of the GNU General Public License
-;; along with this program; if not, write to the Free Software
-;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
 
 ;; - comment-box in TeXinfo generate bogus comments @ccccc@
 ;; - uncomment-region with a numeric argument can render multichar
 ;;   comment markers invalid.
+;; - comment-indent or comment-region when called inside a comment
+;;   will happily break the surrounding comment.
+;; - comment-quote-nested will not (un)quote properly all nested comment
+;;   markers if there are more than just comment-start and comment-end.
+;;   For example, in Pascal where {...*) and (*...} are possible.
 
 ;;; Todo:
 
 ;; - support gnu-style "multi-line with space in continue"
 ;; - somehow allow comment-dwim to use the region even if transient-mark-mode
 ;;   is not turned on.
-;; - (from c-comment-line-break-function): c-ignore-auto-fill so that you can
-;;   auto-fill comments but not code.  This should probably be moved directly
-;;   inside do-auto-fill.
+
+;; - 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:
 
-(eval-when-compile (require 'cl))
+;;;###autoload
+(defalias 'indent-for-comment 'comment-indent)
+;;;###autoload
+(defalias 'set-comment-column 'comment-set-column)
+;;;###autoload
+(defalias 'kill-comment 'comment-kill)
+;;;###autoload
+(defalias 'indent-new-comment-line 'comment-indent-new-line)
 
+;;;###autoload
 (defgroup comment nil
   "Indenting and filling of comments."
   :prefix "comment-"
+  :version "21.1"
   :group 'fill)
 
 (defvar comment-use-syntax 'undecided
@@ -66,6 +85,7 @@ be used to try to determine whether syntax-tables should be trusted
 to understand comments or not in the given buffer.
 Major modes should set this variable.")
 
+;;;###autoload
 (defcustom comment-column 32
   "*Column to indent right-margin comments to.
 Setting this variable automatically makes it local to the current buffer.
@@ -75,31 +95,32 @@ can set the value for a particular mode using that mode's hook."
   :group 'comment)
 (make-variable-buffer-local 'comment-column)
 
+;;;###autoload
 (defvar comment-start nil
   "*String to insert to start a new comment, or nil if no comment syntax.")
 
+;;;###autoload
 (defvar comment-start-skip nil
   "*Regexp to match the start of a comment plus everything up to its body.
 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
 at the place matched by the close of the first pair.")
 
+;;;###autoload
 (defvar comment-end-skip nil
   "Regexp to match the end of a comment plus everything up to its body.")
 
+;;;###autoload
 (defvar comment-end ""
   "*String to insert to end a new comment.
 Should be an empty string if comments are terminated by end-of-line.")
 
-(defvar comment-indent-hook nil
-  "Obsolete variable for 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.")
-
-(defvar comment-indent-function
-  (lambda () comment-column)
+;;;###autoload
+(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)
@@ -131,7 +152,8 @@ two semi-colons.")
     (aligned   . (nil t nil t))
     (multi-line        . (t nil nil t))
     (extra-line        . (t nil t t))
-    (box       . (t t t t)))
+    (box       . (nil t t t))
+    (box-multi . (t t t t)))
   "Possible comment styles of the form (STYLE . (MULTI ALIGN EXTRA INDENT)).
 STYLE should be a mnemonic symbol.
 MULTI specifies that comments are allowed to span multiple lines.
@@ -141,13 +163,17 @@ EXTRA specifies that an extra line should be used before and after the
 INDENT specifies that the `comment-start' markers should not be put at the
   left margin but at the current indentation of the region to comment.")
 
+;;;###autoload
 (defcustom comment-style 'plain
   "*Style to be used for `comment-region'.
 See `comment-styles' for a list of available styles."
   :group 'comment
-  :type `(choice ,@(mapcar (lambda (s) `(const ,(car s))) comment-styles)))
+  :type (if (boundp 'comment-styles)
+           `(choice ,@(mapcar (lambda (s) `(const ,(car s))) comment-styles))
+         'symbol))
 
-(defcustom comment-padding 1
+;;;###autoload
+(defcustom comment-padding " "
   "Padding string that `comment-region' puts between comment chars and text.
 Can also be an integer which will be automatically turned into a string
 of the corresponding number of spaces.
@@ -155,9 +181,9 @@ of the corresponding number of spaces.
 Extra spacing between the comment characters and the comment text
 makes the comment easier to read.  Default is 1.  nil means 0.")
 
+;;;###autoload
 (defcustom comment-multi-line nil
-  "*Non-nil means \\[indent-new-comment-line] should continue same comment
-on new line, with no new terminator or starter.
+  "*Non-nil means \\[comment-indent-new-line] continues comments, with no new terminator or starter.
 This is obsolete because you might as well use \\[newline-and-indent]."
   :type 'boolean
   :group 'comment)
@@ -201,7 +227,8 @@ This is obsolete because you might as well use \\[newline-and-indent]."
     ;; comment-continue
     (unless (or comment-continue (string= comment-end ""))
       (set (make-local-variable 'comment-continue)
-          (concat " " (substring comment-start 1))))
+          (concat (if (string-match "\\S-\\S-" comment-start) " " "|")
+                  (substring comment-start 1))))
     ;; comment-skip regexps
     (unless comment-start-skip
       (set (make-local-variable 'comment-start-skip)
@@ -261,8 +288,10 @@ Moves point to inside the comment and returns the position of the
 comment-starter.  If no comment is found, moves point to LIMIT
 and raises an error or returns nil of NOERROR is non-nil."
   (if (not comment-use-syntax)
-      (when (re-search-forward comment-start-skip limit noerror)
-       (or (match-end 1) (match-beginning 0)))
+      (if (re-search-forward comment-start-skip limit noerror)
+         (or (match-end 1) (match-beginning 0))
+       (goto-char limit)
+       (unless noerror (error "No comment")))
     (let* ((pt (point))
           ;; Assume (at first) that pt is outside of any string.
           (s (parse-partial-sexp pt (or limit (point-max)) nil nil nil t)))
@@ -276,15 +305,15 @@ and raises an error or returns nil of NOERROR is non-nil."
       (if (not (and (nth 8 s) (not (nth 3 s))))
          (unless noerror (error "No comment"))
        ;; We found the comment.
-       (let ((pt (point))
+       (let ((pos (point))
              (start (nth 8 s))
-             (bol (save-excursion (beginning-of-line) (point)))
+             (bol (line-beginning-position))
              (end nil))
          (while (and (null end) (>= (point) bol))
            (if (looking-at comment-start-skip)
                (setq end (min (or limit (point-max)) (match-end 0)))
              (backward-char)))
-         (goto-char end)
+         (goto-char (or end pos))
          start)))))
 
 (defun comment-search-backward (&optional limit noerror)
@@ -321,7 +350,9 @@ the same as `comment-search-forward'."
   (let ((pt (point))
        (cs (comment-search-backward nil t)))
     (when cs
-      (if (save-excursion (goto-char cs) (comment-forward 1) (> (point) pt))
+      (if (save-excursion
+           (goto-char cs)
+           (if (comment-forward 1) (> (point) pt) (eobp)))
          cs
        (goto-char pt)
        nil))))
@@ -335,10 +366,10 @@ and can use regexps instead of syntax."
     (if comment-use-syntax (forward-comment n)
       (while (> n 0)
        (skip-syntax-forward " ")
-       (if (and (looking-at comment-start-skip)
-                (re-search-forward comment-end-skip nil 'move))
-           (decf n)
-         (setq n -1)))
+       (setq n
+             (if (and (looking-at comment-start-skip)
+                      (re-search-forward comment-end-skip nil 'move))
+                 (1- n) -1)))
       (= n 0))))
 
 (defun comment-enter-backward ()
@@ -365,7 +396,15 @@ Point is assumed to be just at the end of a comment."
 ;;;; Commands
 ;;;;
 
-(defalias 'indent-for-comment 'comment-indent)
+;;;###autoload
+(defun comment-indent-default ()
+  "Default for `comment-indent-function'."
+  (if (looking-at "\\s<\\s<\\s<") 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.
 If CONTINUE is non-nil, use the `comment-continuation' markers if any."
@@ -383,30 +422,36 @@ If CONTINUE is non-nil, use the `comment-continuation' markers if any."
      (t (let* ((eolpos (line-end-position))
                cpos indent begpos)
           (beginning-of-line)
-          (when (setq begpos (comment-search-forward eolpos t))
+          (if (not (setq begpos (comment-search-forward eolpos t)))
+             (setq begpos (point))
            (setq cpos (point-marker))
            (goto-char begpos))
-         (setq begpos (point))
-          ;; Compute desired indent.
-          (if (= (current-column)
-                 (setq indent (if comment-indent-hook
-                                  (funcall comment-indent-hook)
-                                (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))))))))
-
-(defalias 'set-comment-column 'comment-set-column)
+         ;; Compute desired indent.
+         (setq indent (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))))))
+           ;; An existing comment?
+           (if cpos
+               (progn (goto-char cpos) (set-marker cpos nil))
+             ;; No, insert one.
+             (insert starter)
+             (save-excursion
+               (insert ender)))))))))
+
+;;;###autoload
 (defun comment-set-column (arg)
   "Set the comment column based on point.
 With no ARG, set the comment column to the current column.
@@ -428,7 +473,7 @@ With any other arg, set comment column to indentation of the previous comment
    (t (setq comment-column (current-column))
       (message "Comment column set to %d" comment-column))))
 
-(defalias 'kill-comment 'comment-kill)
+;;;###autoload
 (defun comment-kill (arg)
   "Kill the comment on this line, if any.
 With prefix ARG, kill comments on that many lines starting with this one."
@@ -463,14 +508,22 @@ the string for any N."
          (rpad (concat (substring str (match-end 1)) ;original right padding
                        (substring comment-padding ;additional right padding
                                   (min (- (match-end 0) (match-end 1))
-                                       (length comment-padding))))))
+                                       (length comment-padding)))))
+         ;; We can only duplicate C if the comment-end has multiple chars
+         ;; or if comments can be nested, else the comment-end `}' would
+         ;; be turned into `}}}' where only the first ends the comment
+         ;; and the rest becomes bogus junk.
+         (multi (not (and comment-quote-nested
+                          ;; comment-end is a single char
+                          (string-match "\\`\\s-*\\S-\\s-*\\'" comment-end)))))
       (if (not (symbolp n))
-         (concat lpad s (make-string n (aref str (1- (match-end 1)))) rpad)
+         (concat lpad s (when multi (make-string n (aref str (1- (match-end 1))))) rpad)
        ;; construct a regexp that would match anything from just S
        ;; to any possible output of this function for any N.
        (concat (mapconcat (lambda (c) (concat (regexp-quote (string c)) "?"))
                           lpad "")     ;padding is not required
-               (regexp-quote s) "+"    ;the last char of S might be repeated
+               (regexp-quote s)
+               (when multi "+")        ;the last char of S might be repeated
                (mapconcat (lambda (c) (concat (regexp-quote (string c)) "?"))
                           rpad "")))))) ;padding is not required
 
@@ -511,6 +564,7 @@ If N is `re', a regexp is returned instead, that would match
                (if multi (concat (regexp-quote (string c)) "*"))
                (regexp-quote s))))))
 
+;;;###autoload
 (defun uncomment-region (beg end &optional arg)
   "Uncomment each line in the BEG..END region.
 The numeric prefix ARG can specify a number of chars to remove from the
@@ -541,6 +595,9 @@ comment markers."
            ;; Remove the comment-start.
            (goto-char ipt)
            (skip-syntax-backward " ")
+           ;; Check for special `=' used sometimes in comment-box.
+           (when (and (= (- (point) (point-min)) 1) (looking-at "=\\{7\\}"))
+             (skip-chars-forward "="))
            ;; A box-comment starts with a looong comment-start marker.
            (when (> (- (point) (point-min) (length comment-start)) 7)
              (setq box t))
@@ -554,8 +611,12 @@ comment markers."
 
            ;; Remove the end-comment (and leading padding and such).
            (goto-char (point-max)) (comment-enter-backward)
-           (unless (string-match "\\`\\(\n\\|\\s-\\)*\\'"
-                                 (buffer-substring (point) (point-max)))
+           ;; Check for special `=' used sometimes in comment-box.
+           (when (= (- (point-max) (point)) 1)
+             (let ((pos (point)))
+               ;; skip `=' but only if there are at least 7.
+               (when (> (skip-chars-backward "=") -7) (goto-char pos))))
+           (unless (looking-at "\\(\n\\|\\s-\\)*\\'")
              (when (and (bolp) (not (bobp))) (backward-char))
              (if (null arg) (delete-region (point) (point-max))
                (skip-syntax-forward " ")
@@ -586,33 +647,30 @@ comment markers."
 (defun comment-make-extra-lines (cs ce ccs cce min-indent max-indent &optional block)
   "Make the leading and trailing extra lines.
 This is used for `extra-line' style (or `box' style if BLOCK is specified)."
-  (if block
-      (let* ((s (concat cs "a=m" cce "\n"
-                       (make-string min-indent ? ) ccs))
-            (e (concat cce "\n" (make-string min-indent ? )
-                       ccs "a=m" ce))
-            (_ (assert (string-match "\\s-*\\(a=m\\)\\s-*" s)))
-            (fill (make-string (+ (- max-indent
-                                     min-indent
-                                     (match-beginning 0))
-                                  (- (match-end 0)
-                                     (match-end 1)))
-                               (aref s (match-end 0)))))
+  (let ((eindent 0))
+    (if (not block)
+       ;; Try to match CS and CE's content so they align aesthetically.
+       (progn
+         (setq ce (comment-string-strip ce t t))
+         (when (string-match "\\(.+\\).*\n\\(.*?\\)\\1" (concat ce "\n" cs))
+           (setq eindent
+                 (max (- (match-end 2) (match-beginning 2) (match-beginning 0))
+                      0))))
+      ;; box comment
+      (let* ((width (- max-indent min-indent))
+            (s (concat cs "a=m" cce))
+            (e (concat ccs "a=m" ce))
+            (c (if (string-match ".*\\S-\\S-" cs)
+                   (aref cs (1- (match-end 0))) ?=))
+            (_ (string-match "\\s-*a=m\\s-*" s))
+            (fill
+             (make-string (+ width (- (match-end 0)
+                                      (match-beginning 0) (length cs) 3)) c)))
        (setq cs (replace-match fill t t s))
-       (assert (string-match "\\s-*\\(a=m\\)\\s-*" e))
-       (setq ce (replace-match fill t t e)))
-    (when (and ce (string-match "\\`\\s-*\\(.*\\S-\\)\\s-*\\'" ce))
-      (setq ce (match-string 1 ce)))
-    (let* ((c (concat ce "a=m" cs))
-          (indent (if (string-match "\\(.+\\).*a=m\\(.*\\)\\1" c)
-                      (max (+ min-indent
-                              (- (match-end 2) (match-beginning 2))
-                              (- (match-beginning 0)))
-                           0)
-                    min-indent)))
-      (setq ce (concat cce "\n" (make-string indent ? ) (or ce cs)))
-      (setq cs (concat cs "\n" (make-string min-indent ? ) ccs))))
-  (cons cs ce))
+       (string-match "\\s-*a=m\\s-*" e)
+       (setq ce (replace-match fill t t e))))
+    (cons (concat cs "\n" (make-string min-indent ? ) ccs)
+         (concat cce "\n" (make-string (+ min-indent eindent) ? ) ce))))
 
 (def-edebug-spec comment-with-narrowing t)
 (put 'comment-with-narrowing 'lisp-indent-function 2)
@@ -620,34 +678,35 @@ This is used for `extra-line' style (or `box' style if BLOCK is specified)."
   "Execute BODY with BEG..END narrowing.
 Space is added (and then removed) at the beginning for the text's
 indentation to be kept as it was before narrowing."
-  `(let ((-bindent (save-excursion (goto-char beg) (current-column))))
-     (save-restriction
-       (narrow-to-region beg end)
-       (goto-char (point-min))
-       (insert (make-string -bindent ? ))
-       (prog1
-          (progn ,@body)
-        ;; remove the -bindent
-        (save-excursion
-          (goto-char (point-min))
-          (when (looking-at " *")
-            (let ((n (min (- (match-end 0) (match-beginning 0)) -bindent)))
-              (delete-char n)
-              (decf -bindent n)))
-          (end-of-line)
-          (let ((e (point)))
-            (beginning-of-line)
-            (while (and (> -bindent 0) (re-search-forward "  +" e t))
-              (let ((n (min -bindent (- (match-end 0) (match-beginning 0) 1))))
-                (goto-char (match-beginning 0))
+  (let ((bindent (make-symbol "bindent")))
+    `(let ((,bindent (save-excursion (goto-char beg) (current-column))))
+       (save-restriction
+        (narrow-to-region beg end)
+        (goto-char (point-min))
+        (insert (make-string ,bindent ? ))
+        (prog1
+            (progn ,@body)
+          ;; remove the bindent
+          (save-excursion
+            (goto-char (point-min))
+            (when (looking-at " *")
+              (let ((n (min (- (match-end 0) (match-beginning 0)) ,bindent)))
                 (delete-char n)
-                (decf -bindent n)))))))))
+                (setq ,bindent (- ,bindent n))))
+            (end-of-line)
+            (let ((e (point)))
+              (beginning-of-line)
+              (while (and (> ,bindent 0) (re-search-forward "   *" e t))
+                (let ((n (min ,bindent (- (match-end 0) (match-beginning 0) 1))))
+                  (goto-char (match-beginning 0))
+                  (delete-char n)
+                  (setq ,bindent (- ,bindent n)))))))))))
 
 (defun comment-region-internal (beg end cs ce
                                    &optional ccs cce block lines indent)
   "Comment region BEG..END.
-CS and CE are the comment start resp. end string.
-CCS and CCE are the comment continuation strings for the start resp. end
+CS and CE are the comment start resp end string.
+CCS and CCE are the comment continuation strings for the start resp end
 of lines (default to CS and CE).
 BLOCK indicates that end of lines should be marked with either CCE, CE or CS
 \(if CE is empty) and that those markers should be aligned.
@@ -655,7 +714,7 @@ LINES indicates that an extra lines will be used at the beginning and end
 of the region for CE and CS.
 INDENT indicates to put CS and CCS at the current indentation of the region
 rather than at left margin."
-  (assert (< beg end))
+  ;;(assert (< beg end))
   (let ((no-empty t))
     ;; Sanitize CE and CCE.
     (if (and (stringp ce) (string= "" ce)) (setq ce nil))
@@ -684,6 +743,7 @@ rather than at left margin."
          (comment-quote-nested comment-start comment-end nil)
 
          ;; Loop over all lines to find the needed indentations.
+         (goto-char (point-min))
          (while
              (progn
                (unless (looking-at "[ \t]*$")
@@ -693,7 +753,8 @@ rather than at left margin."
                (not (or (eobp) (progn (forward-line) nil)))))
          
          ;; Inserting ccs can change max-indent by (1- tab-width).
-         (incf max-indent (+ (max (length cs) (length ccs)) -1 tab-width))
+         (setq max-indent
+               (+ max-indent (max (length cs) (length ccs)) tab-width -1))
          (unless indent (setq min-indent 0))
 
          ;; make the leading and trailing lines if requested
@@ -719,13 +780,15 @@ rather than at left margin."
                (end-of-line)
                (not (or (eobp) (progn (forward-line) nil))))))))))
 
+;;;###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.
 Numeric prefix arg ARG means use ARG comment characters.
 If ARG is negative, delete that many comment characters instead.
-Comments are terminated on each line, even for syntax in which newline does
-not end the comment.  Blank lines do not get comments.
+By default, comments start at the left margin, are terminated on each line,
+even for syntax in which newline does not end the comment and blank lines
+do not get comments.  This can be changed with `comment-style'.
 
 The strings used as comment starts are built from
 `comment-start' without trailing spaces and `comment-padding'."
@@ -751,7 +814,7 @@ The strings used as comment starts are built from
       ;; sanitize LINES
       (setq lines
            (and
-            lines multi
+            lines ;; multi
             (progn (goto-char beg) (beginning-of-line)
                    (skip-syntax-forward " ")
                    (>= (point) beg))
@@ -767,8 +830,8 @@ The strings used as comment starts are built from
      ((consp arg) (uncomment-region beg end))
      ((< numarg 0) (uncomment-region beg end (- numarg)))
      (t
-      (if (and (null arg) (= (length comment-start) 1))
-         (setq numarg add) (decf numarg))
+      (setq numarg (if (and (null arg) (= (length comment-start) 1))
+                      add (1- numarg)))
       (comment-region-internal
        beg end
        (let ((s (comment-padright comment-start numarg)))
@@ -788,9 +851,11 @@ The strings used as comment starts are built from
 The numeric prefix ARG specifies how many characters to add to begin- and
 end- comment markers additionally to what `comment-add' already specifies."
   (interactive "*r\np")
-  (let ((comment-style 'box))
+  (let ((comment-style (if (cadr (assoc comment-style comment-styles))
+                          'box-multi 'box)))
     (comment-region beg end (+ comment-add arg))))
 
+;;;###autoload
 (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
@@ -822,7 +887,13 @@ Else, call `comment-indent'."
            (insert (comment-padleft comment-end add)))
          (indent-according-to-mode))))))
 
-(defalias 'indent-new-comment-line 'comment-indent-new-line)
+(defcustom comment-auto-fill-only-comments nil
+  "Non-nil means to only auto-fill inside comments.
+This has no effect in modes that do not define a comment syntax."
+  :type 'boolean
+  :group 'comment)
+
+;;;###autoload
 (defun comment-indent-new-line (&optional soft)
   "Break line at point and indent, continuing comment if within one.
 This indents the body of the continued comment
@@ -839,46 +910,62 @@ The inserted newline is marked hard if variable `use-hard-newlines' is true,
 unless optional argument SOFT is non-nil."
   (interactive)
   (comment-normalize-vars t)
-  (let (comcol comstart compt)
-    (delete-region (progn (skip-chars-backward " \t") (point))
-                  (progn (skip-chars-forward " \t") (point)))
-    (if soft (insert-and-inherit ?\n) (newline 1))
-    (if fill-prefix
-       (progn
-         (indent-to-left-margin)
-         (insert-and-inherit fill-prefix))
-      (unless comment-multi-line
-       (save-excursion
-         (backward-char)
-         (when (and comment-start
-                    (setq compt (comment-beginning)))
-           ;; The old line has a comment and point was inside the comment.
-           ;; Indent this line like what we found.
-           (setq comstart (buffer-substring compt (point)))
-           (goto-char compt)
-           (setq comcol (current-column)))))
-      (if compt
-         (let* ((comment-column comcol)
-                (normal-comment
+  (let (compos comin)
+    ;; If we are not inside a comment and we only auto-fill comments,
+    ;; don't do anything (unless no comment syntax is defined).
+    (unless (and comment-start
+                comment-auto-fill-only-comments
+                (not (save-excursion
+                       (prog1 (setq compos (comment-beginning))
+                         (setq comin (point))))))
+
+      ;; Now we know we should auto-fill.
+      (delete-region (progn (skip-chars-backward " \t") (point))
+                    (progn (skip-chars-forward  " \t") (point)))
+      (if soft (insert-and-inherit ?\n) (newline 1))
+      (if fill-prefix
+         (progn
+           (indent-to-left-margin)
+           (insert-and-inherit fill-prefix))
+
+       ;; If necessary check whether we're inside a comment.
+       (unless (or comment-multi-line compos (null comment-start))
+         (save-excursion
+           (backward-char)
+           (setq compos (comment-beginning))
+           (setq comin (point))))
+
+       ;; If we're not inside a comment, just try to indent.
+       (if (not compos) (indent-according-to-mode)
+         (let* ((comment-column
+                 ;; The continuation indentation should be somewhere between
+                 ;; the current line's indentation (plus 2 for good measure)
+                 ;; and the current comment's indentation, with a preference
+                 ;; for comment-column.
+                 (save-excursion
+                   (goto-char compos)
+                   (min (current-column) (max comment-column
+                                              (+ 2 (current-indentation))))))
+                (comstart (buffer-substring compos comin))
+                (normalp
                  (string-match (regexp-quote (comment-string-strip
                                               comment-start t t))
                                comstart))
-                ;; Force comment-continue to be recreated from comment-start.
-                (comment-continue nil) ;(if normal-comment comment-continue)
                 (comment-end
-                 (if normal-comment comment-end
+                 (if normalp comment-end
                    ;; The comment starter is not the normal comment-start
                    ;; so we can't just use comment-end.
                    (save-excursion
-                     (goto-char compt)
+                     (goto-char compos)
                      (if (not (comment-forward)) comment-end
                        (comment-string-strip
                         (buffer-substring
                          (save-excursion (comment-enter-backward) (point))
                          (point))
                         nil t)))))
-                (comment-start comstart))
-           ;;(if (not (eolp)) (setq comment-end ""))
+                (comment-start comstart)
+                ;; Force comment-continue to be recreated from comment-start.
+                (comment-continue nil))
            (insert-and-inherit ?\n)
            (forward-char -1)
            (comment-indent (cadr (assoc comment-style comment-styles)))
@@ -891,91 +978,8 @@ unless optional argument SOFT is non-nil."
                  (beginning-of-line)
                  (backward-char)
                  (insert comend)
-                 (forward-char)))))
-       (indent-according-to-mode)))))
+                 (forward-char))))))))))
 
 (provide 'newcomment)
 
-;;; Change Log:
-;; $Log: newcomment.el,v $
-;; 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