]> code.delx.au - gnu-emacs/blobdiff - lisp/paren.el
(insert-for-yank): Set yank-undo-function after calling FUNCTION,
[gnu-emacs] / lisp / paren.el
index 51b75388b83dfd78a1c2f6995876829e63cd4c03..a88c1f39857c6a562d86885c065e7e5a3e1bf714 100644 (file)
@@ -1,8 +1,8 @@
-;;; paren.el --- highlight matching paren.
+;;; paren.el --- highlight matching paren
 
 
-;; Copyright (C) 1993, 1996 Free Software Foundation, Inc.
+;; Copyright (C) 1993, 1996, 2001 Free Software Foundation, Inc.
 
 
-;; Author: rms@gnu.ai.mit.edu
+;; Author: rms@gnu.org
 ;; Maintainer: FSF
 ;; Keywords: languages, faces
 
 ;; Maintainer: FSF
 ;; Keywords: languages, faces
 
 
 ;;; Commentary:
 
 
 ;;; Commentary:
 
-;; Load this and it will display highlighting on whatever
-;; paren matches the one before or after point.
+;; Put this into your ~/.emacs:
+
+;;  (show-paren-mode t)
+
+;; It will display highlighting on whatever paren matches the one
+;; before or after point.
 
 ;;; Code:
 
 
 ;;; Code:
 
+(defgroup paren-showing nil
+  "Showing (un)matching of parens and expressions."
+  :prefix "show-paren-"
+  :group 'paren-matching)
+
 ;; This is the overlay used to highlight the matching paren.
 (defvar show-paren-overlay nil)
 ;; This is the overlay used to highlight the closeparen right before point.
 (defvar show-paren-overlay-1 nil)
 
 ;; This is the overlay used to highlight the matching paren.
 (defvar show-paren-overlay nil)
 ;; This is the overlay used to highlight the closeparen right before point.
 (defvar show-paren-overlay-1 nil)
 
-(defvar show-paren-mode nil)
-(defvar show-paren-idle-timer nil)
+(defcustom show-paren-style 'parenthesis
+  "*Style used when showing a matching paren.
+Valid styles are `parenthesis' (meaning show the matching paren),
+`expression' (meaning show the entire expression enclosed by the paren) and
+`mixed' (meaning show the matching paren if it is visible, and the expression
+otherwise)."
+  :type '(choice (const parenthesis) (const expression) (const mixed))
+  :group 'paren-showing)
+
+(defcustom show-paren-delay
+  (if (featurep 'lisp-float-type) (/ (float 1) (float 8)) 1)
+  "*Time in seconds to delay before showing a matching paren."
+  :type '(number :tag "seconds")
+  :group 'paren-showing)
+
+(defcustom show-paren-priority 1000
+  "*Priority of paren highlighting overlays."
+  :type 'integer
+  :group 'paren-showing
+  :version "21.1")
+  
+(defcustom show-paren-ring-bell-on-mismatch nil
+  "*If non-nil, beep if mismatched paren is detected."
+  :type 'boolean
+  :group 'paren-showing
+  :version "20.3")
+  
+(defface show-paren-match-face
+  '((((class color) (background light))
+     :background "turquoise")          ; looks OK on tty (becomes cyan)
+    (((class color) (background dark))
+     :background "steelblue3")         ; looks OK on tty (becomes blue)
+    (((background dark))
+     :background "grey50")
+    (t
+     :background "gray"))
+  "Show Paren mode face used for a matching paren."
+  :group 'faces
+  :group 'paren-showing)
+
+(defface show-paren-mismatch-face
+  '((((class color)) (:foreground "white" :background "purple"))
+    (t (:inverse-video t)))
+  "Show Paren mode face used for a mismatching paren."
+  :group 'faces
+  :group 'paren-showing)
 
 
-(defvar show-paren-mismatch-face nil)
-
-(defvar show-paren-delay (if (featurep 'lisp-float-type) 0.125 1)
-  "*Time in seconds to delay before showing the matching paren.")
-
-(defvar show-paren-face 'region
-  "*Name of the face to use for showing the matching paren.")
+(defvar show-paren-idle-timer nil)
 
 ;;;###autoload
 
 ;;;###autoload
-(defun show-paren-mode (&optional arg)
+(define-minor-mode show-paren-mode
   "Toggle Show Paren mode.
 With prefix ARG, turn Show Paren mode on if and only if ARG is positive.
 Returns the new status of Show Paren mode (non-nil means on).
 
 When Show Paren mode is enabled, any matching parenthesis is highlighted
   "Toggle Show Paren mode.
 With prefix ARG, turn Show Paren mode on if and only if ARG is positive.
 Returns the new status of Show Paren mode (non-nil means on).
 
 When Show Paren mode is enabled, any matching parenthesis is highlighted
-after `show-paren-delay' seconds of Emacs idle time."
-  (interactive "P")
-  (if window-system
-      (let ((on-p (if arg
-                     (> (prefix-numeric-value arg) 0)
-                   (not show-paren-mode))))
-       (setq blink-matching-paren-on-screen (not on-p))
-       (and show-paren-idle-timer (cancel-timer show-paren-idle-timer))
-       (if on-p
-           (setq show-paren-idle-timer (run-with-idle-timer show-paren-delay t
-                                        'show-paren-function))
-         (and show-paren-overlay (overlay-buffer show-paren-overlay)
-              (delete-overlay show-paren-overlay))
-         (and show-paren-overlay-1 (overlay-buffer show-paren-overlay-1)
-              (delete-overlay show-paren-overlay-1)))
-       (setq show-paren-mode on-p))))
+in `show-paren-style' after `show-paren-delay' seconds of Emacs idle time."
+  :global t :group 'paren-showing
+    ;; Turn off the usual paren-matching method
+    ;; when this one is turned on.
+    (if (local-variable-p 'show-paren-mode)
+       (make-local-variable 'blink-matching-paren-on-screen)
+      (kill-local-variable 'blink-matching-paren-on-screen))
+    (setq blink-matching-paren-on-screen (not show-paren-mode))
+
+    ;; Now enable or disable the mechanism.
+    ;; First get rid of the old idle timer.
+    (if show-paren-idle-timer
+       (cancel-timer show-paren-idle-timer))
+    (setq show-paren-idle-timer nil)
+    ;; If show-paren-mode is enabled in some buffer now,
+    ;; set up a new timer.
+    (when (memq t (mapcar (lambda (buffer)
+                           (with-current-buffer buffer
+                             show-paren-mode))
+                         (buffer-list)))
+      (setq show-paren-idle-timer (run-with-idle-timer
+                                  show-paren-delay t
+                                  'show-paren-function)))
+    (unless show-paren-mode
+      (and show-paren-overlay
+          (eq (overlay-buffer show-paren-overlay) (current-buffer))
+          (delete-overlay show-paren-overlay))
+      (and show-paren-overlay-1
+          (eq (overlay-buffer show-paren-overlay-1) (current-buffer))
+          (delete-overlay show-paren-overlay-1))))
 
 ;; Find the place to show, if there is one,
 ;; and show it until input arrives.
 (defun show-paren-function ()
 
 ;; Find the place to show, if there is one,
 ;; and show it until input arrives.
 (defun show-paren-function ()
-  ;; Do nothing if no window system to display results with.
-  ;; Do nothing if executing keyboard macro.
-  ;; Do nothing if input is pending.
-  (if window-system
-      (let (pos dir mismatch (oldpos (point))
-               (face show-paren-face))
-       (cond ((eq (char-syntax (preceding-char)) ?\))
-              (setq dir -1))
-             ((eq (char-syntax (following-char)) ?\()
-              (setq dir 1)))
-       (if dir
-           (save-excursion
-             (save-restriction
-               ;; Determine the range within which to look for a match.
-               (if blink-matching-paren-distance
-                   (narrow-to-region (max (point-min)
-                                          (- (point) blink-matching-paren-distance))
-                                     (min (point-max)
-                                          (+ (point) blink-matching-paren-distance))))
-               ;; Scan across one sexp within that range.
-               ;; Errors or nil mean there is a mismatch.
-               (condition-case ()
-                   (setq pos (scan-sexps (point) dir))
-                 (error (setq pos t
-                              mismatch t)))
-               ;; If found a "matching" paren, see if it is the right
-               ;; kind of paren to match the one we started at.
-               (if (integerp pos)
-                   (let ((beg (min pos oldpos)) (end (max pos oldpos)))
-                     (and (/= (char-syntax (char-after beg)) ?\$)
-                          (setq mismatch
-                                (not (eq (char-before end)
-                                         ;; This can give nil.
-                                         (matching-paren (char-after beg))))))))
-               ;; If they don't properly match, use a different face,
-               ;; or print a message.
-               (if mismatch
-                   (progn
-                     (and (null show-paren-mismatch-face)
-                          (x-display-color-p)
-                          (progn
-                            (add-to-list 'facemenu-unlisted-faces 
-                                         'paren-mismatch)
-                            (make-face 'paren-mismatch)
-                            (or (face-nontrivial-p 'paren-mismatch t)
-                                (progn
-                                  (set-face-background 'paren-mismatch
-                                                       "purple")
-                                  (set-face-foreground 'paren-mismatch
-                                                       "white")))
-                            (setq show-paren-mismatch-face 'paren-mismatch)))
-                     (if show-paren-mismatch-face
-                         (setq face show-paren-mismatch-face)
-                       (message "Paren mismatch"))))
-               )))
-       (cond (pos
-              (if (or (= dir -1)
-                      (not (integerp pos)))
-                  ;; If matching backwards, highlight the closeparen
-                  ;; before point as well as its matching open.
-                  ;; If matching forward, and the openparen is unbalanced,
-                  ;; highlight the paren at point to indicate misbalance.
-                  (let ((from (if (= dir 1)
-                                  (point)
-                                (forward-point -1)))
-                        (to (if (= dir 1)
-                                (forward-point 1)
-                              (point))))
-                    (if show-paren-overlay-1
-                        (move-overlay show-paren-overlay-1
-                                      from to
-                                      (current-buffer))
-                      (setq show-paren-overlay-1
-                            (make-overlay from to)))
-                    ;; Always set the overlay face, since it varies.
-                    (overlay-put show-paren-overlay-1 'face face))
-                ;; Otherwise, turn off any such highlighting.
-                (and show-paren-overlay-1
-                     (overlay-buffer show-paren-overlay-1)
-                     (delete-overlay show-paren-overlay-1)))
-              ;; Turn on highlighting for the matching paren, if found.
-              ;; If it's an unmatched paren, turn off any such highlighting.
-              (or (and (not (integerp pos))
-                       (delete-overlay show-paren-overlay))
-                  (save-excursion
-                    (goto-char pos)
-                    (if show-paren-overlay
-                        (move-overlay show-paren-overlay
-                                      (forward-point (- dir))
-                                      pos
-                                      (current-buffer))
-                      (setq show-paren-overlay
-                            (make-overlay (forward-point (- dir)) pos)))))
-              ;; Always set the overlay face, since it varies.
-              (overlay-put show-paren-overlay 'face face))
-             (t
-              ;; If not at a paren that has a match,
-              ;; turn off any previous paren highlighting.
-              (and show-paren-overlay (overlay-buffer show-paren-overlay)
-                   (delete-overlay show-paren-overlay))
-              (and show-paren-overlay-1 (overlay-buffer show-paren-overlay-1)
-                   (delete-overlay show-paren-overlay-1)))))))
-
-;;; For back compatibility we turn ourselves on if we're dumped or loaded.
-(add-hook 'window-setup-hook '(lambda () (show-paren-mode t)))
-(show-paren-mode t)
+  (if show-paren-mode
+      (let ((oldpos (point))
+           (dir (cond ((eq (car (syntax-after (1- (point)))) 5) -1)
+                      ((eq (car (syntax-after (point))) 4) 1)))
+           pos mismatch face)
+       ;;
+       ;; Find the other end of the sexp.
+       (when dir
+         (save-excursion
+           (save-restriction
+             ;; Determine the range within which to look for a match.
+             (when blink-matching-paren-distance
+               (narrow-to-region
+                (max (point-min) (- (point) blink-matching-paren-distance))
+                (min (point-max) (+ (point) blink-matching-paren-distance))))
+             ;; Scan across one sexp within that range.
+             ;; Errors or nil mean there is a mismatch.
+             (condition-case ()
+                 (setq pos (scan-sexps (point) dir))
+               (error (setq pos t mismatch t)))
+             ;; Move back the other way and verify we get back to the
+             ;; starting point.  If not, these two parens don't really match.
+             ;; Maybe the one at point is escaped and doesn't really count.
+             (when (integerp pos)
+               (unless (condition-case ()
+                           (eq (point) (scan-sexps pos (- dir)))
+                         (error nil))
+                 (setq pos nil)))
+             ;; If found a "matching" paren, see if it is the right
+             ;; kind of paren to match the one we started at.
+             (when (integerp pos)
+               (let ((beg (min pos oldpos)) (end (max pos oldpos)))
+                 (when (/= (char-syntax (char-after beg)) ?\$)
+                   (setq mismatch
+                         (not (eq (char-before end)
+                                  ;; This can give nil.
+                                  (matching-paren (char-after beg)))))))))))
+       ;;
+       ;; Highlight the other end of the sexp, or unhighlight if none.
+       (if (not pos)
+           (progn
+             ;; If not at a paren that has a match,
+             ;; turn off any previous paren highlighting.
+             (and show-paren-overlay (overlay-buffer show-paren-overlay)
+                  (delete-overlay show-paren-overlay))
+             (and show-paren-overlay-1 (overlay-buffer show-paren-overlay-1)
+                  (delete-overlay show-paren-overlay-1)))
+         ;;
+         ;; Use the correct face.
+         (if mismatch
+             (progn
+               (if show-paren-ring-bell-on-mismatch
+                   (beep))
+               (setq face 'show-paren-mismatch-face))
+           (setq face 'show-paren-match-face))
+         ;;
+         ;; If matching backwards, highlight the closeparen
+         ;; before point as well as its matching open.
+         ;; If matching forward, and the openparen is unbalanced,
+         ;; highlight the paren at point to indicate misbalance.
+         ;; Otherwise, turn off any such highlighting.
+         (if (and (= dir 1) (integerp pos))
+             (when (and show-paren-overlay-1
+                        (overlay-buffer show-paren-overlay-1))
+               (delete-overlay show-paren-overlay-1))
+           (let ((from (if (= dir 1)
+                           (point)
+                         (forward-point -1)))
+                 (to (if (= dir 1)
+                         (forward-point 1)
+                       (point))))
+             (if show-paren-overlay-1
+                 (move-overlay show-paren-overlay-1 from to (current-buffer))
+               (setq show-paren-overlay-1 (make-overlay from to)))
+             ;; Always set the overlay face, since it varies.
+             (overlay-put show-paren-overlay-1 'priority show-paren-priority)
+             (overlay-put show-paren-overlay-1 'face face)))
+         ;;
+         ;; Turn on highlighting for the matching paren, if found.
+         ;; If it's an unmatched paren, turn off any such highlighting.
+         (unless (integerp pos)
+           (delete-overlay show-paren-overlay))
+         (let ((to (if (or (eq show-paren-style 'expression)
+                           (and (eq show-paren-style 'mixed)
+                                (not (pos-visible-in-window-p pos))))
+                       (point)
+                     pos))
+               (from (if (or (eq show-paren-style 'expression)
+                             (and (eq show-paren-style 'mixed)
+                                  (not (pos-visible-in-window-p pos))))
+                         pos
+                       (save-excursion
+                         (goto-char pos)
+                         (forward-point (- dir))))))
+           (if show-paren-overlay
+               (move-overlay show-paren-overlay from to (current-buffer))
+             (setq show-paren-overlay (make-overlay from to))))
+         ;;
+         ;; Always set the overlay face, since it varies.
+         (overlay-put show-paren-overlay 'priority show-paren-priority)
+         (overlay-put show-paren-overlay 'face face)))
+    ;; show-paren-mode is nil in this buffer.
+    (and show-paren-overlay
+        (delete-overlay show-paren-overlay))
+    (and show-paren-overlay-1
+        (delete-overlay show-paren-overlay-1))))
 
 (provide 'paren)
 
 
 (provide 'paren)