*** empty log message ***
[bpt/emacs.git] / lisp / hl-line.el
index a3fbfb8..e37bdf4 100644 (file)
@@ -1,10 +1,10 @@
 ;;; hl-line.el --- highlight the current line
 
-;; Copyright (C) 1998, 2000 Free Software Foundation, Inc.
+;; Copyright (C) 1998, 2000, 2001 Free Software Foundation, Inc.
 
 ;; Author:  Dave Love <fx@gnu.org>
 ;; Created: 1998-09-13
-;; Keywords: faces, frames
+;; Keywords: faces, frames, emulation
 
 ;; This file is part of GNU Emacs.
 
@@ -31,8 +31,8 @@
 ;; a request for a feature of Lesser Editors.
 
 ;; You probably don't really want this; if the cursor is difficult to
-;; spot, try changing its colour or relying on `blink-cursor-mode' The
-;; hookery involved here might slow Emacs noticeably on a slow
+;; spot, try changing its colour, relying on `blink-cursor-mode' or
+;; both.  The hookery used might affect response noticeably on a slow
 ;; machine.
 
 ;; An overlay is used, active only on the selected window.  Hooks are
 ;; `hl-line-highlight', on `post-command-hook', activates it again
 ;; across the window width.
 
+;; You could make variable `hl-line-mode' buffer-local to avoid
+;; highlighting specific buffers.
+
 ;;; Code:
 
 (defgroup hl-line nil
-  "Highliight the current line."
+  "Highlight the current line."
   :version "21.1"
   :group 'editing)
 
-;;;###autoload
-(defcustom hl-line-mode nil
-  "Toggle Hl-Line mode.
-Setting this variable directly does not take effect;
-use either \\[customize] or the function `hl-line-mode'."
-  :set (lambda (symbol value)
-        (hl-line-mode (or value 0)))
-  :initialize 'custom-initialize-default
-  :type 'boolean
-  :group 'hl-line
-  :require 'hl-line)
-
 (defcustom hl-line-face 'highlight
   "Face with which to highlight the current line."
   :type 'face
   :group 'hl-line)
 
 (defvar hl-line-overlay nil)
-(make-variable-buffer-local 'hl-line-overlay)
 
 (defun hl-line-highlight ()
   "Active the Hl-Line overlay on the current line in the current window.
 \(Unless it's a minibuffer window.)"
-  (unless (window-minibuffer-p (selected-window)) ; silly in minibuffer
-    (unless hl-line-overlay            ; new overlay for this buffer
-      (setq hl-line-overlay (make-overlay 1 1))        ; to be moved
-      (overlay-put hl-line-overlay 'face hl-line-face))
-    (overlay-put hl-line-overlay 'window (selected-window))
-    (move-overlay hl-line-overlay
-                 (line-beginning-position) (1+ (line-end-position)))))
+  (when hl-line-mode                   ; Could be made buffer-local.
+    (unless (window-minibuffer-p (selected-window)) ; silly in minibuffer
+      (unless hl-line-overlay
+       (setq hl-line-overlay (make-overlay 1 1)) ; to be moved
+       (overlay-put hl-line-overlay 'face hl-line-face))
+      (overlay-put hl-line-overlay 'window (selected-window))
+      (move-overlay hl-line-overlay
+                   (line-beginning-position) (1+ (line-end-position))
+                   (current-buffer)))))
 
 (defun hl-line-unhighlight ()
   "Deactivate the Hl-Line overlay on the current line in the current window."
@@ -88,25 +80,24 @@ use either \\[customize] or the function `hl-line-mode'."
       (delete-overlay hl-line-overlay)))
 
 ;;;###autoload
-(defun hl-line-mode (&optional arg)
-  "Global minor mode to highlight the line about point in the current window.
-
+(define-minor-mode hl-line-mode
+  "Minor mode to highlight the line about point in the current window.
 With ARG, turn Hl-Line mode on if ARG is positive, off otherwise.
 Uses functions `hl-line-unhighlight' and `hl-line-highlight' on
 `pre-command-hook' and `post-command-hook'."
-  (interactive "P")
-  (setq hl-line-mode (if (null arg)
-                        (not hl-line-mode)
-                      (> (prefix-numeric-value arg) 0)))
-  (cond (hl-line-mode
-        (add-hook 'pre-command-hook #'hl-line-unhighlight)
-        (add-hook 'post-command-hook #'hl-line-highlight))
-       (t
-        (hl-line-unhighlight)
-        (remove-hook 'pre-command-hook #'hl-line-unhighlight)
-        (remove-hook 'post-command-hook #'hl-line-highlight)))
-  (if (interactive-p)
     (message "Hl-Line mode %sabled" (if hl-line-mode "en" "dis"))))
+  nil nil nil
+  (if hl-line-mode
+      (progn
+       (add-hook 'pre-command-hook #'hl-line-unhighlight)
+       (add-hook 'post-command-hook #'hl-line-highlight))
+    (hl-line-unhighlight)
+    (remove-hook 'pre-command-hook #'hl-line-unhighlight)
+    (remove-hook 'post-command-hook #'hl-line-highlight)))
+
+;;;###autoload
+(easy-mmode-define-global-mode
+ global-hl-line-mode hl-line-mode hl-line-mode
:group 'hl-line)
 
 (provide 'hl-line)