;; Maintainer: Stefan Monnier <monnier@cs.yale.edu>
;; Keywords: comment uncomment
;; Version: $Name: $
-;; Revision: $Id: newcomment.el,v 1.12 2000/05/21 00:27:31 monnier Exp $
+;; Revision: $Id: newcomment.el,v 1.21 2000/10/05 22:43:22 monnier Exp $
;; This file is part of GNU Emacs.
;; - 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:
;; - 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
(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
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.
: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)
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.
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)
;;;; Commands
;;;;
+;;;###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."
(setq begpos (point))
(setq cpos (point-marker))
(goto-char begpos))
- ;; 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))))))))
-
+ ;; 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.
(t (setq comment-column (current-column))
(message "Comment column set to %d" comment-column))))
+;;;###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."
(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
;; Remove the end-comment (and leading padding and such).
(goto-char (point-max)) (comment-enter-backward)
;; Check for special `=' used sometimes in comment-box.
- (when (and (= (- (point-max) (point)) 1) (> (point) 7)
- (save-excursion (backward-char 7)
- (looking-at "=\\{7\\}")))
- (skip-chars-backward "="))
+ (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))
(e (concat ccs "a=m" ce))
(c (if (string-match ".*\\S-\\S-" cs)
(aref cs (1- (match-end 0))) ?=))
- (_ (assert (string-match "\\s-*a=m\\s-*" s)))
+ (_ (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))
+ (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))))
(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'."
'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
: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
(provide 'newcomment)
-;;; Change Log:
-;; $Log: newcomment.el,v $
-;; 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
HCoop / bpt / emacs.git / blobdiff