emacs: lisp/newcomment.el comparison

comparison lisp/newcomment.el @ 29037:238233843fc1

(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.

author	Stefan Monnier <monnier@iro.umontreal.ca>
date	Sun, 21 May 2000 00:27:31 +0000
parents	80e6f0d6eac1
children	720287a2312f

comparison

equal deleted inserted replaced

-:91115e6a0f53
+:238233843fc1
 ;; 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.10 2000/05/17 19:32:32 monnier Exp $
+;; Revision: $Id: newcomment.el,v 1.11 2000/05/19 15:37:41 monnier Exp $
 ;; 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
 '((plain	. (nil nil nil nil))
 (indent	. (nil nil nil t))
 (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.
 ALIGN specifies that the `comment-end' markers should be aligned.
 EXTRA specifies that an extra line should be used before and after the
 ;;(setq comment-start (comment-string-strip comment-start t nil))
 ;;(setq comment-end (comment-string-strip comment-end nil t))
 ;; 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)
 	   (concat "\\(\\(^\\|[^\\\\\n]\\)\\(\\\\\\\\\\)*\\)\\(\\s<+\\|"
 		   (regexp-quote (comment-string-strip comment-start t t))
 "Find a comment start between point and LIMIT.
 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)
+(if (re-search-forward comment-start-skip limit noerror)
-	(or (match-end 1) (match-beginning 0)))
+	  (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)))
 (when (and (nth 8 s) (nth 3 s))
 	  ;; The search ended inside a string.  Try to see if it
 		   (list nil nil nil (nth 3 s) nil nil nil nil)
 		   t)))
 (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)
 "Find a comment start between LIMIT and point.
 Moves point to inside the comment and returns the position of the
 ((null starter)
 (error "No comment syntax defined"))
 (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))))
 (skip-chars-backward " \t")
 (delete-region (point) begpos)
 (indent-to indent))
 ;; An existing comment?
 (if cpos
-(progn (goto-char cpos)
+(progn (goto-char cpos) (set-marker cpos nil))
-(set-marker cpos nil))
 ;; No, insert one.
 (insert starter)
 (save-excursion
 (insert ender))))))))
 (let ((s (match-string 1 str))	;actual string
 	  (lpad (substring str 0 (match-beginning 1))) ;left padding
 	  (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
 (defun comment-padleft (str &optional n)
 "Construct a string composed of `comment-padding' plus STR.
 	  (save-restriction
 	    (narrow-to-region spt ept)
 	    ;; 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))
 	    (when (looking-at (regexp-quote comment-padding))
 	      (goto-char (match-end 0)))
 	      (skip-syntax-backward " ")
 	      (delete-char (- numarg)))
 	    ;; Remove the end-comment (and leading padding and such).
 	    (goto-char (point-max)) (comment-enter-backward)
-	    (unless (string-match "\\`\\(\n\\|\\s-\\)*\\'"
+	    ;; Check for special `=' used sometimes in comment-box.
-				  (buffer-substring (point) (point-max)))
+	    (when (and (= (- (point-max) (point)) 1) (> (point) 7)
+		       (save-excursion (backward-char 7)
+				       (looking-at "=\\{7\\}")))
+	      (skip-chars-backward "="))
+	    (unless (looking-at "\\(\n\\|\\s-\\)*\\'")
 	      (when (and (bolp) (not (bobp))) (backward-char))
 	      (if (null arg) (delete-region (point) (point-max))
 		(skip-syntax-forward " ")
 		(delete-char numarg)))
 (set-marker end nil))))
 (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 ((eindent 0))
-(let* ((s (concat cs "a=m" cce "\n"
+(if (not block)
-			(make-string min-indent ? ) ccs))
+	;; Try to match CS and CE's content so they align aesthetically.
-	     (e (concat cce "\n" (make-string min-indent ? )
+	(progn
-			ccs "a=m" ce))
+	  (setq ce (comment-string-strip ce t t))
-	     ;;(_ (assert (string-match "\\s-*\\(a=m\\)\\s-*" s)))
+	  (when (string-match "\\(.+\\).*\n\\(.*?\\)\\1" (concat ce "\n" cs))
-	     (fill (make-string (+ (- max-indent
+	    (setq eindent
-				      min-indent
+		  (max (- (match-end 2) (match-beginning 2) (match-beginning 0))
-				      (match-beginning 0))
+		       0))))
-				   (- (match-end 0)
+;; box comment
-				      (match-end 1)))
+(let* ((width (- max-indent min-indent))
-				(aref s (match-end 0)))))
+	     (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))) ?=))
+	     (_ (assert (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))
+	(assert (string-match "\\s-*a=m\\s-*" e))
-	(setq ce (replace-match fill t t e)))
+	(setq ce (replace-match fill t t e))))
-(when (and ce (string-match "\\`\\s-*\\(.*\\S-\\)\\s-*\\'" ce))
+(cons (concat cs "\n" (make-string min-indent ? ) ccs)
-(setq ce (match-string 1 ce)))
+	  (concat cce "\n" (make-string (+ min-indent eindent) ? ) 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))
 (def-edebug-spec comment-with-narrowing t)
 (put 'comment-with-narrowing 'lisp-indent-function 2)
 (defmacro comment-with-narrowing (beg end &rest body)
 "Execute BODY with BEG..END narrowing.
 (if (>= beg end) (error "Nothing to comment"))
 ;; sanitize LINES
 (setq lines
 	    (and
-	     lines multi
+	     lines ;; multi
 	     (progn (goto-char beg) (beginning-of-line)
 		    (skip-syntax-forward " ")
 		    (>= (point) beg))
 	     (progn (goto-char end) (end-of-line) (skip-syntax-backward " ")
 		    (<= (point) end))
 (defun comment-box (beg end &optional arg)
 "Comment out the BEG..END region, putting it inside a box.
 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))))
 (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
 (provide 'newcomment)
 ;;; Change Log:
 ;; $Log: newcomment.el,v $
+;; 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

Mercurial > emacs

comparison lisp/newcomment.el @ 29037:238233843fc1