;;; hl-line.el --- highlight the current line
-;; Copyright (C) 1998 Free Software Foundation, Inc.
+;; Copyright (C) 1998, 2000, 2001, 2002, 2003, 2004,
+;; 2005, 2006 Free Software Foundation, Inc.
;; Author: Dave Love <fx@gnu.org>
+;; Maintainer: FSF
;; Created: 1998-09-13
-;; Keywords: faces, frames
+;; Keywords: faces, frames, emulation
-;; Hl-Line mode 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, or (at your option)
;; any later version.
-;; Hl-Line mode is distributed in the hope that it will be useful,
+;; 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 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
-;; Provides a global minor mode (toggled by M-x hl-line-mode) to
-;; highlight, in a windowing system, the line on which point is
-;; (except in a minibuffer window) to satisfy 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 using a cursor blinking
-;; <URL:http://www.wonderworks.com/download/blinking-cursor.el.gz> or
-;; jiggling <URL:http://www.eskimo.com/%7Eseldon> package. (Cursor
-;; blinking will be built in to Emacs 21.) The hookery involved here
-;; might slow Emacs noticeably on a slow machine.
-
-;; An overlay is used, active only on the selected window. Hooks are
-;; added to `pre-command-hook' and `post-command-hook' to activate and
-;; deactivate (by deleting) the overlay. `hl-line-unhighlight', on
-;; `pre-command-hook', deactivates it unconditionally in case the
-;; command changes the selected window. (It does so rather than
-;; keeping track of changes in the selected window).
-;; `hl-line-highlight', on `post-command-hook', activates it again
-;; across the window width.
+;; Provides a local minor mode (toggled by M-x hl-line-mode) and
+;; a global minor mode (toggled by M-x global-hl-line-mode) to
+;; highlight, on a suitable terminal, the line on which point is. The
+;; global mode highlights the current line in the selected window only
+;; (except when the minibuffer window is selected). This was
+;; implemented to satisfy a request for a feature of Lesser Editors.
+;; The local mode is sticky: it highlights the line about the buffer's
+;; point even if the buffer's window is not selected. Caveat: the
+;; buffer's point might be different from the point of a non-selected
+;; window. Set the variable `hl-line-sticky-flag' to nil to make the
+;; local mode behave like the global mode.
+
+;; You probably don't really want to use the global mode; if the
+;; cursor is difficult to spot, try changing its colour, relying on
+;; `blink-cursor-mode' or both. The hookery used might affect
+;; response noticeably on a slow machine. The local mode may be
+;; useful in non-editing buffers such as Gnus or PCL-CVS though.
+
+;; An overlay is used. In the non-sticky cases, this overlay is
+;; active only on the selected window. A hook is added to
+;; `post-command-hook' to activate the overlay and move it to the line
+;; about point. To get the non-sticky behavior, `hl-line-unhighlight'
+;; is added to `pre-command-hook' as well. This function deactivates
+;; the overlay unconditionally in case the command changes the
+;; selected window. (It does so rather than keeping track of changes
+;; in the selected window).
+
+;; You could make variable `global-hl-line-mode' buffer-local and set
+;; it to nil to avoid highlighting specific buffers, when the global
+;; mode is used.
+
+;; By default the whole line is highlighted. The range of highlighting
+;; can be changed by defining an appropriate function as the
+;; buffer-local value of `hl-line-range-function'.
;;; Code:
(defgroup hl-line nil
- "Highliight the current line."
- :version "20.5"
+ "Highlight the current line."
+ :version "21.1"
:group 'editing)
-;;;###autoload
-(defcustom hl-line-mode nil
- "Non-nil if Hl-Line mode is enabled."
- :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)
+(defcustom hl-line-sticky-flag t
+ "*Non-nil means highlight the current line in all windows.
+Otherwise Hl-Line mode will highlight only in the selected
+window. Setting this variable takes effect the next time you use
+the command `hl-line-mode' to turn Hl-Line mode on."
+ :type 'boolean
+ :version "22.1"
+ :group 'hl-line)
+
+(defvar hl-line-range-function nil
+ "If non-nil, function to call to return highlight range.
+The function of no args should return a cons cell; its car value
+is the beginning position of highlight and its cdr value is the
+end position of highlight in the buffer.
+It should return nil if there's no region to be highlighted.
+
+This variable is expected to be made buffer-local by modes.")
+
+(defvar hl-line-overlay nil
+ "Overlay used by Hl-Line mode to highlight the current line.")
(make-variable-buffer-local 'hl-line-overlay)
+(defvar global-hl-line-overlay nil
+ "Overlay used by Global-Hl-Line mode to highlight the current line.")
+
+;;;###autoload
+(define-minor-mode hl-line-mode
+ "Buffer-local minor mode to highlight the line about point.
+With ARG, turn Hl-Line mode on if ARG is positive, off otherwise.
+
+If `hl-line-sticky-flag' is non-nil, Hl-Line mode highlights the
+line about the buffer's point in all windows. Caveat: the
+buffer's point might be different from the point of a
+non-selected window. Hl-Line mode uses the function
+`hl-line-highlight' on `post-command-hook' in this case.
+
+When `hl-line-sticky-flag' is nil, Hl-Line mode highlights the
+line about point in the selected window only. In this case, it
+uses the function `hl-line-unhighlight' on `pre-command-hook' in
+addition to `hl-line-highlight' on `post-command-hook'."
+ :group 'hl-line
+ (if hl-line-mode
+ (progn
+ ;; In case `kill-all-local-variables' is called.
+ (add-hook 'change-major-mode-hook #'hl-line-unhighlight nil t)
+ (if hl-line-sticky-flag
+ (remove-hook 'pre-command-hook #'hl-line-unhighlight t)
+ (add-hook 'pre-command-hook #'hl-line-unhighlight nil t))
+ (hl-line-highlight)
+ (add-hook 'post-command-hook #'hl-line-highlight nil t))
+ (remove-hook 'post-command-hook #'hl-line-highlight t)
+ (hl-line-unhighlight)
+ (remove-hook 'change-major-mode-hook #'hl-line-unhighlight t)
+ (remove-hook 'pre-command-hook #'hl-line-unhighlight t)))
+
(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)))))
+ "Activate the Hl-Line overlay on the current line."
+ (if hl-line-mode ; Might be changed outside the mode function.
+ (progn
+ (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 (unless hl-line-sticky-flag (selected-window)))
+ (hl-line-move hl-line-overlay))
+ (hl-line-unhighlight)))
(defun hl-line-unhighlight ()
- "Deactivate the Hl-Line overlay on the current line in the current window."
+ "Deactivate the Hl-Line overlay on the current line."
(if hl-line-overlay
(delete-overlay hl-line-overlay)))
;;;###autoload
-(defun hl-line-mode (&optional arg)
- "Global minor mode to highlight the line about point.
+(define-minor-mode global-hl-line-mode
+ "Global minor mode to highlight the line about point in the current window.
+With ARG, turn Global-Hl-Line mode on if ARG is positive, off otherwise.
-With ARG, turn Hl-Line mode on if ARG is positive, off otherwise.
-Only useful with a windowing system.
-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"))))
+Global-Hl-Line mode uses the functions `global-hl-line-unhighlight' and
+`global-hl-line-highlight' on `pre-command-hook' and `post-command-hook'."
+ :global t
+ :group 'hl-line
+ (if global-hl-line-mode
+ (progn
+ (add-hook 'pre-command-hook #'global-hl-line-unhighlight)
+ (add-hook 'post-command-hook #'global-hl-line-highlight))
+ (global-hl-line-unhighlight)
+ (remove-hook 'pre-command-hook #'global-hl-line-unhighlight)
+ (remove-hook 'post-command-hook #'global-hl-line-highlight)))
+
+(defun global-hl-line-highlight ()
+ "Active the Global-Hl-Line overlay on the current line in the current window."
+ (when global-hl-line-mode ; Might be changed outside the mode function.
+ (unless (window-minibuffer-p (selected-window))
+ (unless global-hl-line-overlay
+ (setq global-hl-line-overlay (make-overlay 1 1)) ; to be moved
+ (overlay-put global-hl-line-overlay 'face hl-line-face))
+ (overlay-put global-hl-line-overlay 'window (selected-window))
+ (hl-line-move global-hl-line-overlay))))
+
+(defun global-hl-line-unhighlight ()
+ "Deactivate the Global-Hl-Line overlay on the current line."
+ (if global-hl-line-overlay
+ (delete-overlay global-hl-line-overlay)))
+
+(defun hl-line-move (overlay)
+ "Move the Hl-Line overlay.
+If `hl-line-range-function' is non-nil, move the OVERLAY to the position
+where the function returns. If `hl-line-range-function' is nil, fill
+the line including the point by OVERLAY."
+ (let (tmp b e)
+ (if hl-line-range-function
+ (setq tmp (funcall hl-line-range-function)
+ b (car tmp)
+ e (cdr tmp))
+ (setq tmp t
+ b (line-beginning-position)
+ e (line-beginning-position 2)))
+ (if tmp
+ (move-overlay overlay b e)
+ (move-overlay overlay 1 1))))
(provide 'hl-line)
+;;; arch-tag: ac806940-0876-4959-8c89-947563ee2833
;;; hl-line.el ends here