X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/e468b87f91f26e66a8cde087c1a9c89c67b96d12..6665a6fd1968288bc83ff8857665168b29828a8b:/lisp/hl-line.el diff --git a/lisp/hl-line.el b/lisp/hl-line.el index 6a988d47c4..8164d8ad79 100644 --- a/lisp/hl-line.el +++ b/lisp/hl-line.el @@ -1,19 +1,18 @@ ;;; hl-line.el --- highlight the current line -;; Copyright (C) 1998, 2000, 2001, 2002, 2003, 2004, -;; 2005, 2006, 2007 Free Software Foundation, Inc. +;; Copyright (C) 1998, 2000-2012 Free Software Foundation, Inc. ;; Author: Dave Love ;; Maintainer: FSF ;; Created: 1998-09-13 -;; Keywords: faces, frames, emulation +;; Keywords: faces, frames, emulations ;; 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 3, 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 @@ -21,9 +20,7 @@ ;; 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 . ;;; Commentary: @@ -40,7 +37,7 @@ ;; 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. @@ -74,7 +71,7 @@ (defgroup hl-line nil "Highlight the current line." :version "21.1" - :group 'editing) + :group 'convenience) (defface hl-line '((t :inherit highlight)) @@ -96,14 +93,26 @@ (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 the HL-Line mode highlight appears 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." +the command `hl-line-mode' to turn Hl-Line mode on. + +This variable has no effect in Global Highlight Line mode. +For that, use `global-hl-line-sticky-flag'." :type 'boolean :version "22.1" :group 'hl-line) +(defcustom global-hl-line-sticky-flag nil + "Non-nil means the Global HL-Line mode highlight appears in all windows. +Otherwise Global Hl-Line mode will highlight only in the selected +window. Setting this variable takes effect the next time you use +the command `global-hl-line-mode' to turn Global Hl-Line mode on." + :type 'boolean + :version "24.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 @@ -115,10 +124,13 @@ This variable is expected to be made buffer-local by modes.") ;;;###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. + "Toggle highlighting of the current line (Hl-Line mode). +With a prefix argument ARG, enable Hl-Line mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -If `hl-line-sticky-flag' is non-nil, Hl-Line mode highlights the +Hl-Line mode is a buffer-local minor mode. 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 @@ -157,13 +169,19 @@ addition to `hl-line-highlight' on `post-command-hook'." (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 - "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. + "Toggle line highlighting in all buffers (Global Hl-Line mode). +With a prefix argument ARG, enable Global Hl-Line mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +If `global-hl-line-sticky-flag' is non-nil, Global Hl-Line mode +highlights the line about the current buffer's point in all +windows. Global-Hl-Line mode uses the functions `global-hl-line-unhighlight' and `global-hl-line-highlight' on `pre-command-hook' and `post-command-hook'." @@ -178,19 +196,21 @@ Global-Hl-Line mode uses the functions `global-hl-line-unhighlight' and (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." + "Highlight 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)) + (overlay-put global-hl-line-overlay 'window + (unless global-hl-line-sticky-flag + (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))) + (when global-hl-line-overlay + (delete-overlay global-hl-line-overlay))) (defun hl-line-move (overlay) "Move the Hl-Line overlay. @@ -209,7 +229,16 @@ the line including the point by OVERLAY." (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 ;;; hl-line.el ends here