Mercurial > emacs
annotate lisp/hl-line.el @ 34767:0be0c72fb0ad
(mail-mode): Set `comment-start' to the yank prefix.
author | Miles Bader <miles@gnu.org> |
---|---|
date | Thu, 21 Dec 2000 02:11:01 +0000 |
parents | b8a47482f3cd |
children | c42fc96648de |
rev | line source |
---|---|
24961 | 1 ;;; hl-line.el --- highlight the current line |
2 | |
27228 | 3 ;; Copyright (C) 1998, 2000 Free Software Foundation, Inc. |
24961 | 4 |
5 ;; Author: Dave Love <fx@gnu.org> | |
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 | 8 |
29087 | 9 ;; This file is part of GNU Emacs. |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
24961 | 12 ;; it under the terms of the GNU General Public License as published by |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
29087 | 16 ;; GNU Emacs is distributed in the hope that it will be useful, |
24961 | 17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 ;; Boston, MA 02111-1307, USA. | |
25 | |
26 ;;; Commentary: | |
27 | |
28 ;; Provides a global minor mode (toggled by M-x hl-line-mode) to | |
27228 | 29 ;; highlight, on a suitable terminal, the line in the current window |
30 ;; on which point is (except in a minibuffer window). Done to satisfy | |
31 ;; a request for a feature of Lesser Editors. | |
24961 | 32 |
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 | 35 ;; both. The hookery used might affect response noticeably on a slow |
27228 | 36 ;; machine. |
24961 | 37 |
38 ;; An overlay is used, active only on the selected window. Hooks are | |
39 ;; added to `pre-command-hook' and `post-command-hook' to activate and | |
40 ;; deactivate (by deleting) the overlay. `hl-line-unhighlight', on | |
41 ;; `pre-command-hook', deactivates it unconditionally in case the | |
42 ;; command changes the selected window. (It does so rather than | |
43 ;; keeping track of changes in the selected window). | |
44 ;; `hl-line-highlight', on `post-command-hook', activates it again | |
45 ;; across the window width. | |
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 | 50 ;;; Code: |
51 | |
52 (defgroup hl-line nil | |
53 "Highliight the current line." | |
25174 | 54 :version "21.1" |
24961 | 55 :group 'editing) |
56 | |
57 (defcustom hl-line-face 'highlight | |
58 "Face with which to highlight the current line." | |
59 :type 'face | |
60 :group 'hl-line) | |
61 | |
62 (defvar hl-line-overlay nil) | |
63 | |
64 (defun hl-line-highlight () | |
65 "Active the Hl-Line overlay on the current line in the current window. | |
66 \(Unless it's a minibuffer window.)" | |
30274
428e9eb82841
(hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents:
30034
diff
changeset
|
67 (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
|
68 (unless (window-minibuffer-p (selected-window)) ; silly in minibuffer |
31846
6e48fd527039
(hl-line-overlay): Don't make it buffer-local.
Dave Love <fx@gnu.org>
parents:
30274
diff
changeset
|
69 (unless hl-line-overlay |
30274
428e9eb82841
(hl-line-highlight): Check hl-line-mode.
Dave Love <fx@gnu.org>
parents:
30034
diff
changeset
|
70 (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
|
71 (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
|
72 (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
|
73 (move-overlay hl-line-overlay |
31846
6e48fd527039
(hl-line-overlay): Don't make it buffer-local.
Dave Love <fx@gnu.org>
parents:
30274
diff
changeset
|
74 (line-beginning-position) (1+ (line-end-position)) |
6e48fd527039
(hl-line-overlay): Don't make it buffer-local.
Dave Love <fx@gnu.org>
parents:
30274
diff
changeset
|
75 (current-buffer))))) |
24961 | 76 |
77 (defun hl-line-unhighlight () | |
78 "Deactivate the Hl-Line overlay on the current line in the current window." | |
79 (if hl-line-overlay | |
80 (delete-overlay hl-line-overlay))) | |
81 | |
25051
64e3159f0c7b
(hl-line-mode): Add autload cookies.
Dave Love <fx@gnu.org>
parents:
24961
diff
changeset
|
82 ;;;###autoload |
29369
48dc52f114f3
Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents:
29087
diff
changeset
|
83 (define-minor-mode hl-line-mode |
27228 | 84 "Global minor mode to highlight the line about point in the current window. |
24961 | 85 With ARG, turn Hl-Line mode on if ARG is positive, off otherwise. |
86 Uses functions `hl-line-unhighlight' and `hl-line-highlight' on | |
87 `pre-command-hook' and `post-command-hook'." | |
33187
b8a47482f3cd
(hl-line-mode): Drop unneeded positional args.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
31846
diff
changeset
|
88 :global t |
29369
48dc52f114f3
Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents:
29087
diff
changeset
|
89 (if hl-line-mode |
48dc52f114f3
Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents:
29087
diff
changeset
|
90 (progn |
48dc52f114f3
Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents:
29087
diff
changeset
|
91 (add-hook 'pre-command-hook #'hl-line-unhighlight) |
48dc52f114f3
Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents:
29087
diff
changeset
|
92 (add-hook 'post-command-hook #'hl-line-highlight)) |
48dc52f114f3
Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents:
29087
diff
changeset
|
93 (hl-line-unhighlight) |
48dc52f114f3
Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents:
29087
diff
changeset
|
94 (remove-hook 'pre-command-hook #'hl-line-unhighlight) |
48dc52f114f3
Rewritten using define-minor-mode.
Dave Love <fx@gnu.org>
parents:
29087
diff
changeset
|
95 (remove-hook 'post-command-hook #'hl-line-highlight))) |
24961 | 96 |
97 (provide 'hl-line) | |
98 | |
99 ;;; hl-line.el ends here |