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