annotate lisp/hl-line.el @ 30274:428e9eb82841

(hl-line-highlight): Check hl-line-mode.
author Dave Love <fx@gnu.org>
date Tue, 18 Jul 2000 11:51:43 +0000
parents f0e0228afe6e
children 6e48fd527039
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
1 ;;; hl-line.el --- highlight the current line
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
2
27228
b4676dda4b53 (hl-line-mode): Fix defcustom.
Dave Love <fx@gnu.org>
parents: 25174
diff changeset
3 ;; Copyright (C) 1998, 2000 Free Software Foundation, Inc.
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
4
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
5 ;; Author: Dave Love <fx@gnu.org>
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
6 ;; Created: 1998-09-13
29369
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
7 ;; Keywords: faces, frames, emulation
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
8
29087
d6e90113152f Fix boilerplate comments.
Dave Love <fx@gnu.org>
parents: 27228
diff changeset
9 ;; This file is part of GNU Emacs.
d6e90113152f Fix boilerplate comments.
Dave Love <fx@gnu.org>
parents: 27228
diff changeset
10
d6e90113152f Fix boilerplate comments.
Dave Love <fx@gnu.org>
parents: 27228
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
14 ;; any later version.
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
15
29087
d6e90113152f Fix boilerplate comments.
Dave Love <fx@gnu.org>
parents: 27228
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
20
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
24 ;; Boston, MA 02111-1307, USA.
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
25
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
26 ;;; Commentary:
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
27
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
28 ;; Provides a global minor mode (toggled by M-x hl-line-mode) to
27228
b4676dda4b53 (hl-line-mode): Fix defcustom.
Dave Love <fx@gnu.org>
parents: 25174
diff changeset
29 ;; highlight, on a suitable terminal, the line in the current window
b4676dda4b53 (hl-line-mode): Fix defcustom.
Dave Love <fx@gnu.org>
parents: 25174
diff changeset
30 ;; on which point is (except in a minibuffer window). Done to satisfy
b4676dda4b53 (hl-line-mode): Fix defcustom.
Dave Love <fx@gnu.org>
parents: 25174
diff changeset
31 ;; a request for a feature of Lesser Editors.
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
32
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
33 ;; You probably don't really want this; if the cursor is difficult to
29369
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
34 ;; spot, try changing its colour, relying on `blink-cursor-mode' or
29610
a66af23236bf Fixed a typo in commentary.
Eli Zaretskii <eliz@gnu.org>
parents: 29425
diff changeset
35 ;; both. The hookery used might affect response noticeably on a slow
27228
b4676dda4b53 (hl-line-mode): Fix defcustom.
Dave Love <fx@gnu.org>
parents: 25174
diff changeset
36 ;; machine.
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
37
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
38 ;; An overlay is used, active only on the selected window. Hooks are
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
39 ;; added to `pre-command-hook' and `post-command-hook' to activate and
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
40 ;; deactivate (by deleting) the overlay. `hl-line-unhighlight', on
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
41 ;; `pre-command-hook', deactivates it unconditionally in case the
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
42 ;; command changes the selected window. (It does so rather than
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
43 ;; keeping track of changes in the selected window).
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
44 ;; `hl-line-highlight', on `post-command-hook', activates it again
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
45 ;; across the window width.
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
46
30274
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
47 ;; You could make variable `hl-line-mode' buffer-local to avoid
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
48 ;; highlighting specific buffers.
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
49
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
50 ;;; Code:
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
51
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
52 (defgroup hl-line nil
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
53 "Highliight the current line."
25174
caaa177b2390 (hl-line): Fix :version.
Dave Love <fx@gnu.org>
parents: 25051
diff changeset
54 :version "21.1"
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
55 :group 'editing)
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
56
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
57 (defcustom hl-line-face 'highlight
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
58 "Face with which to highlight the current line."
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
59 :type 'face
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
60 :group 'hl-line)
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
61
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
62 (defvar hl-line-overlay nil)
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
63 (make-variable-buffer-local 'hl-line-overlay)
30034
f0e0228afe6e (hl-line-overlay): Make it permanent-local.
Dave Love <fx@gnu.org>
parents: 29610
diff changeset
64 (put 'hl-line-overlay 'permanent-local t)
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
65
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
66 (defun hl-line-highlight ()
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
67 "Active the Hl-Line overlay on the current line in the current window.
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
68 \(Unless it's a minibuffer window.)"
30274
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
69 (when hl-line-mode ; Could be made buffer-local.
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
70 (unless (window-minibuffer-p (selected-window)) ; silly in minibuffer
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
71 (unless hl-line-overlay ; new overlay for this buffer
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
72 (setq hl-line-overlay (make-overlay 1 1)) ; to be moved
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
73 (overlay-put hl-line-overlay 'face hl-line-face))
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
74 (overlay-put hl-line-overlay 'window (selected-window))
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
75 (move-overlay hl-line-overlay
428e9eb82841 (hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents: 30034
diff changeset
76 (line-beginning-position) (1+ (line-end-position))))))
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
77
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
78 (defun hl-line-unhighlight ()
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
79 "Deactivate the Hl-Line overlay on the current line in the current window."
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
80 (if hl-line-overlay
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
81 (delete-overlay hl-line-overlay)))
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
82
25051
64e3159f0c7b (hl-line-mode): Add autload cookies.
Dave Love <fx@gnu.org>
parents: 24961
diff changeset
83 ;;;###autoload
29369
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
84 (define-minor-mode hl-line-mode
27228
b4676dda4b53 (hl-line-mode): Fix defcustom.
Dave Love <fx@gnu.org>
parents: 25174
diff changeset
85 "Global minor mode to highlight the line about point in the current window.
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
86 With ARG, turn Hl-Line mode on if ARG is positive, off otherwise.
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
87 Uses functions `hl-line-unhighlight' and `hl-line-highlight' on
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
88 `pre-command-hook' and `post-command-hook'."
29425
846240c6fd38 * autoarg.el (autoarg-mode, autoarg-kp-mode):
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29369
diff changeset
89 nil nil nil :global t
29369
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
90
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
91 (if hl-line-mode
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
92 (progn
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
93 (add-hook 'pre-command-hook #'hl-line-unhighlight)
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
94 (add-hook 'post-command-hook #'hl-line-highlight))
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
95 (hl-line-unhighlight)
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
96 (remove-hook 'pre-command-hook #'hl-line-unhighlight)
48dc52f114f3 Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents: 29087
diff changeset
97 (remove-hook 'post-command-hook #'hl-line-highlight)))
24961
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
98
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
99 (provide 'hl-line)
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
100
4d9ce81656da Initial revision
Dave Love <fx@gnu.org>
parents:
diff changeset
101 ;;; hl-line.el ends here