Mercurial > emacs
annotate lisp/reveal.el @ 60346:70a63281c541
(XASSERTS): Define to 0 if not already defined.
(xassert) [!XASSERTS]: Define dummy version.
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Wed, 02 Mar 2005 22:35:17 +0000 |
parents | f3c5c717aa02 |
children | bf372b4b92e9 e4694597cbf4 |
rev | line source |
---|---|
41621 | 1 ;;; reveal.el --- Automatically reveal hidden text at point |
2 | |
60301
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
3 ;; Copyright (C) 2000, 2001, 2004, 2005 Free Software Foundation, Inc. |
41621 | 4 |
5 ;; Author: Stefan Monnier <monnier@cs.yale.edu> | |
6 ;; Keywords: outlines | |
7 | |
42320 | 8 ;; This file is part of GNU Emacs. |
9 | |
45340 | 10 ;; GNU Emacs is free software; you can redistribute it and/or modify |
41621 | 11 ;; it under the terms of the GNU General Public License as published by |
12 ;; the Free Software Foundation; either version 2, or (at your option) | |
13 ;; any later version. | |
14 | |
45341 | 15 ;; GNU Emacs is distributed in the hope that it will be useful, |
41621 | 16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
22 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
24 | |
25 ;;; Commentary: | |
26 | |
27 ;; Reveal mode is a minor mode that makes sure that text around point | |
28 ;; is always visible. When point enters a region of hidden text, | |
29 ;; `reveal-mode' temporarily makes it visible. | |
30 ;; | |
31 ;; This is normally used in conjunction with `outline-minor-mode', | |
32 ;; `hs-minor-mode', `hide-ifdef-mode', ... | |
33 ;; | |
34 ;; It only works with packages that hide text using overlays. | |
35 ;; Packages can provide special support for it by placing | |
36 ;; a function in the `reveal-toggle-invisible' property on the symbol | |
37 ;; used as the value of the `invisible' overlay property. | |
38 ;; The function is called right after revealing (or re-hiding) the | |
39 ;; text with two arguments: the overlay and a boolean that's non-nil | |
40 ;; if we have just revealed the text. When revealing, that function | |
41 ;; may re-hide some of the text. | |
42 | |
43 ;;; Todo: | |
44 | |
45 ;; - find other hysteresis features. | |
46 | |
47 ;;; Code: | |
48 | |
49 (require 'pcvs-util) | |
50 | |
51 (defgroup reveal nil | |
52 "Reveal hidden text on the fly." | |
53 :group 'editing) | |
54 | |
55 (defcustom reveal-around-mark t | |
56 "Reveal text around the mark, if active." | |
57 :type 'boolean) | |
58 | |
59 (defvar reveal-open-spots nil) | |
60 (make-variable-buffer-local 'reveal-open-spots) | |
61 | |
57816
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
62 (defvar reveal-last-tick nil) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
63 (make-variable-buffer-local 'reveal-last-tick) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
64 |
41621 | 65 ;; Actual code |
66 | |
67 (defun reveal-post-command () | |
68 ;; Refresh the spots that might have changed. | |
69 ;; `Refreshing' here means to try and re-hide the corresponding text. | |
70 ;; We don't refresh everything correctly: | |
71 ;; - we only refresh spots in the current window. | |
72 ;; FIXME: do we actually know that (current-buffer) = (window-buffer) ? | |
73 (with-local-quit | |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
74 (condition-case err |
41621 | 75 (let* ((spots (cvs-partition |
76 (lambda (x) | |
77 ;; We refresh any spot in the current window as well | |
78 ;; as any spots associated with a dead window or a window | |
79 ;; which does not show this buffer any more. | |
80 (or (eq (car x) (selected-window)) | |
81 (not (window-live-p (car x))) | |
82 (not (eq (window-buffer (car x)) | |
83 (current-buffer))))) | |
84 reveal-open-spots)) | |
85 (old-ols (mapcar 'cdr (car spots))) | |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
86 (repeat t)) |
41621 | 87 (setq reveal-open-spots (cdr spots)) |
88 ;; Open new overlays. | |
89 (while repeat | |
90 (setq repeat nil) | |
91 (dolist (ol (nconc (when (and reveal-around-mark mark-active) | |
92 (overlays-at (mark))) | |
93 (overlays-at (point)))) | |
94 (push (cons (selected-window) ol) reveal-open-spots) | |
95 (setq old-ols (delq ol old-ols)) | |
60301
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
96 (let ((inv (overlay-get ol 'invisible)) open) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
97 (when (and inv |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
98 ;; There's an `invisible' property. Make sure it's |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
99 ;; actually invisible. |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
100 (or (not (listp buffer-invisibility-spec)) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
101 (memq inv buffer-invisibility-spec) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
102 (assq inv buffer-invisibility-spec)) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
103 (or (setq open |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
104 (or (overlay-get ol 'reveal-toggle-invisible) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
105 (and (symbolp inv) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
106 (get inv 'reveal-toggle-invisible)) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
107 (overlay-get ol 'isearch-open-invisible-temporary))) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
108 (overlay-get ol 'isearch-open-invisible) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
109 (and (consp buffer-invisibility-spec) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
110 (cdr (assq inv buffer-invisibility-spec)))) |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
111 (overlay-put ol 'reveal-invisible inv)) |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
112 (if (null open) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
113 (overlay-put ol 'invisible nil) |
41621 | 114 ;; Use the provided opening function and repeat (since the |
115 ;; opening function might have hidden a subpart around point). | |
116 (setq repeat t) | |
117 (condition-case err | |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
118 (funcall open ol nil) |
60301
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
119 (error (message "!!Reveal-show (funcall %s %s nil): %s !!" |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
120 open ol err) |
50374
73660951a233
(reveal-post-command): Better error handling and debugging.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48399
diff
changeset
|
121 ;; Let's default to a meaningful behavior to avoid |
73660951a233
(reveal-post-command): Better error handling and debugging.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48399
diff
changeset
|
122 ;; getting stuck in an infinite loop. |
50384
09ec24acd6a5
(reveal-post-command): Remove buggy debugging code.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50374
diff
changeset
|
123 (setq repeat nil) |
50374
73660951a233
(reveal-post-command): Better error handling and debugging.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48399
diff
changeset
|
124 (overlay-put ol 'invisible nil)))))))) |
41621 | 125 ;; Close old overlays. |
57816
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
126 (if (not (eq reveal-last-tick |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
127 (setq reveal-last-tick (buffer-modified-tick)))) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
128 ;; The buffer was modified since last command: let's refrain from |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
129 ;; closing any overlay because it tends to behave poorly when |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
130 ;; inserting text at the end of an overlay (basically the overlay |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
131 ;; should be rear-advance when it's open, but things like |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
132 ;; outline-minor-mode make it non-rear-advance because it's |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
133 ;; a better choice when it's closed). |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
134 (dolist (ol old-ols) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
135 (push (cons (selected-window) ol) reveal-open-spots)) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
136 ;; The last command was only a point motion or some such |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
137 ;; non-buffer-modifying command. Let's close whatever can be closed. |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
138 (dolist (ol old-ols) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
139 (when (and (eq (current-buffer) (overlay-buffer ol)) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
140 (not (rassq ol reveal-open-spots))) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
141 (if (and (>= (point) (save-excursion |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
142 (goto-char (overlay-start ol)) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
143 (line-beginning-position 1))) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
144 (<= (point) (save-excursion |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
145 (goto-char (overlay-end ol)) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
146 (line-beginning-position 2)))) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
147 ;; Still near the overlay: keep it open. |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
148 (push (cons (selected-window) ol) reveal-open-spots) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
149 ;; Really close it. |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
150 (let ((open (overlay-get ol 'reveal-toggle-invisible)) inv) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
151 (if (or open |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
152 (and (setq inv (overlay-get ol 'reveal-invisible)) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
153 (setq open (or (get inv 'reveal-toggle-invisible) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
154 (overlay-get ol 'isearch-open-invisible-temporary))))) |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
155 (condition-case err |
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
156 (funcall open ol t) |
60301
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
157 (error (message "!!Reveal-hide (funcall %s %s t): %s !!" |
f3c5c717aa02
(reveal-post-command): Don't try to reveal overlays which
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
58435
diff
changeset
|
158 open ol err))) |
57816
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
159 (overlay-put ol 'invisible inv)))))))) |
50384
09ec24acd6a5
(reveal-post-command): Remove buggy debugging code.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50374
diff
changeset
|
160 (error (message "Reveal: %s" err))))) |
41621 | 161 |
58435
180297c18beb
(reveal-mode-map): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57816
diff
changeset
|
162 (defvar reveal-mode-map |
180297c18beb
(reveal-mode-map): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57816
diff
changeset
|
163 (let ((map (make-sparse-keymap))) |
180297c18beb
(reveal-mode-map): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57816
diff
changeset
|
164 ;; Override the default move-end-of-line which skips valuable |
180297c18beb
(reveal-mode-map): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57816
diff
changeset
|
165 ;; invisible text. |
180297c18beb
(reveal-mode-map): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57816
diff
changeset
|
166 (define-key map [?\C-e] 'end-of-line) |
180297c18beb
(reveal-mode-map): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57816
diff
changeset
|
167 map)) |
180297c18beb
(reveal-mode-map): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57816
diff
changeset
|
168 |
41621 | 169 ;;;###autoload |
170 (define-minor-mode reveal-mode | |
171 "Toggle Reveal mode on or off. | |
172 Reveal mode renders invisible text around point visible again. | |
173 | |
174 Interactively, with no prefix argument, toggle the mode. | |
175 With universal prefix ARG (or if ARG is nil) turn mode on. | |
176 With zero or negative ARG turn mode off." | |
41778
19e76eadbf86
(reveal-mode): Fix reveal-mode's lighter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
41621
diff
changeset
|
177 :lighter (global-reveal-mode nil " Reveal") |
58435
180297c18beb
(reveal-mode-map): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57816
diff
changeset
|
178 :keymap reveal-mode-map |
41621 | 179 (if reveal-mode |
180 (progn | |
181 (set (make-local-variable 'search-invisible) t) | |
182 (add-hook 'post-command-hook 'reveal-post-command nil t)) | |
183 (kill-local-variable 'search-invisible) | |
184 (remove-hook 'post-command-hook 'reveal-post-command t))) | |
185 | |
186 ;;;###autoload | |
187 (define-minor-mode global-reveal-mode | |
188 "Toggle Reveal mode in all buffers on or off. | |
189 Reveal mode renders invisible text around point visible again. | |
190 | |
191 Interactively, with no prefix argument, toggle the mode. | |
192 With universal prefix ARG (or if ARG is nil) turn mode on. | |
193 With zero or negative ARG turn mode off." | |
48399
59fc5f077731
(global-reveal-mode): Add group.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
45428
diff
changeset
|
194 :global t :group 'reveal |
41621 | 195 (setq-default reveal-mode global-reveal-mode) |
196 (if global-reveal-mode | |
197 (progn | |
198 (setq search-invisible t) | |
199 (add-hook 'post-command-hook 'reveal-post-command)) | |
200 (setq search-invisible 'open) ;FIXME | |
201 (remove-hook 'post-command-hook 'reveal-post-command))) | |
202 | |
203 (provide 'reveal) | |
48399
59fc5f077731
(global-reveal-mode): Add group.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
45428
diff
changeset
|
204 |
57816
af6e1f8dd9e0
(reveal-last-tick): New var.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
205 ;; arch-tag: 96ba0242-2274-4ed7-8e10-26bc0707b4d8 |
41621 | 206 ;;; reveal.el ends here |