;;; hl-line.el --- highlight the current line
-;; Copyright (C) 1998, 2000, 2001, 2003, 2005 Free Software Foundation, Inc.
+;; Copyright (C) 1998, 2000, 2001, 2002, 2003, 2004,
+;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Dave Love <fx@gnu.org>
;; Maintainer: FSF
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; 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., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; 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
+;; cursor is difficult to spot, try changing its color, 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.
;; it to nil to avoid highlighting specific buffers, when the global
;; mode is used.
-;; In default whole the line is highlighted. The range of highlighting
+;; 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:
+(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.")
+
(defgroup hl-line nil
"Highlight the current line."
:version "21.1"
:group 'editing)
-(defcustom hl-line-face 'highlight
- "Face with which to highlight the current line."
- :type 'face
+(defface hl-line
+ '((t :inherit highlight))
+ "Default face for highlighting the current line in Hl-Line mode."
+ :version "22.1"
:group 'hl-line)
+(defcustom hl-line-face 'hl-line
+ "Face with which to highlight the current line in Hl-Line mode."
+ :type 'face
+ :group 'hl-line
+ :set (lambda (symbol value)
+ (set symbol value)
+ (dolist (buffer (buffer-list))
+ (with-current-buffer buffer
+ (when hl-line-overlay
+ (overlay-put hl-line-overlay 'face hl-line-face))))
+ (when global-hl-line-overlay
+ (overlay-put global-hl-line-overlay 'face hl-line-face))))
+
(defcustom hl-line-sticky-flag t
- "*Non-nil means highlight the current line in all windows.
+ "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."
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.
(remove-hook 'pre-command-hook #'hl-line-unhighlight t)))
(defun hl-line-highlight ()
- "Active the Hl-Line overlay on the current line."
+ "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
(defun hl-line-unhighlight ()
"Deactivate the Hl-Line overlay on the current line."
- (if hl-line-overlay
- (delete-overlay hl-line-overlay)))
+ (when hl-line-overlay
+ (delete-overlay hl-line-overlay)))
;;;###autoload
(define-minor-mode global-hl-line-mode
(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)))
+ (when global-hl-line-overlay
+ (delete-overlay global-hl-line-overlay)))
(defun hl-line-move (overlay)
- "Move the hl-line-mode 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
+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
(move-overlay overlay b e)
(move-overlay overlay 1 1))))
+(defun hl-line-unload-function ()
+ "Unload the Hl-Line library."
+ (global-hl-line-mode -1)
+ (save-current-buffer
+ (dolist (buffer (buffer-list))
+ (set-buffer buffer)
+ (when hl-line-mode (hl-line-mode -1))))
+ ;; continue standard unloading
+ nil)
+
(provide 'hl-line)
-;;; arch-tag: ac806940-0876-4959-8c89-947563ee2833
+;; arch-tag: ac806940-0876-4959-8c89-947563ee2833
;;; hl-line.el ends here