Mercurial > emacs
annotate lisp/reveal.el @ 51747:b4fb79bf98ba
Fixed some autoload problems: Try to ensure that the entry for ".c"
extension comes before the one for ".C" on auto-mode-alist', to behave
better on case insensitive OS:es. Fixed incorrect entries that were added
to interpreter-mode-alist'. Moved the autoload directives for AWK to the
top level since they aren't recognized anywhere else. Do not use the new
AWK mode doc in the autoload form for the old AWK mode.
author | Martin Stjernholm <mast@lysator.liu.se> |
---|---|
date | Sat, 05 Jul 2003 19:53:33 +0000 |
parents | 9582ab8af8fe |
children | 695cf19ef79e |
rev | line source |
---|---|
41621 | 1 ;;; reveal.el --- Automatically reveal hidden text at point |
2 | |
3 ;; Copyright (C) 2000, 2001 Free Software Foundation, Inc. | |
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 | |
62 ;; Actual code | |
63 | |
64 (defun reveal-post-command () | |
65 ;; Refresh the spots that might have changed. | |
66 ;; `Refreshing' here means to try and re-hide the corresponding text. | |
67 ;; We don't refresh everything correctly: | |
68 ;; - we only refresh spots in the current window. | |
69 ;; FIXME: do we actually know that (current-buffer) = (window-buffer) ? | |
70 (with-local-quit | |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
71 (condition-case err |
41621 | 72 (let* ((spots (cvs-partition |
73 (lambda (x) | |
74 ;; We refresh any spot in the current window as well | |
75 ;; as any spots associated with a dead window or a window | |
76 ;; which does not show this buffer any more. | |
77 (or (eq (car x) (selected-window)) | |
78 (not (window-live-p (car x))) | |
79 (not (eq (window-buffer (car x)) | |
80 (current-buffer))))) | |
81 reveal-open-spots)) | |
82 (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
|
83 (repeat t)) |
41621 | 84 (setq reveal-open-spots (cdr spots)) |
85 ;; Open new overlays. | |
86 (while repeat | |
87 (setq repeat nil) | |
88 (dolist (ol (nconc (when (and reveal-around-mark mark-active) | |
89 (overlays-at (mark))) | |
90 (overlays-at (point)))) | |
91 (push (cons (selected-window) ol) reveal-open-spots) | |
92 (setq old-ols (delq ol old-ols)) | |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
93 (let ((open (overlay-get ol 'reveal-toggle-invisible))) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
94 (when (or open |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
95 (let ((inv (overlay-get ol 'invisible))) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
96 (and inv (symbolp inv) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
97 (or (setq open (or (get inv 'reveal-toggle-invisible) |
50617
9582ab8af8fe
(reveal-post-command): Use overlay-get for overlays.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50384
diff
changeset
|
98 (overlay-get ol 'isearch-open-invisible-temporary))) |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
99 (overlay-get ol 'isearch-open-invisible) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
100 (and (consp buffer-invisibility-spec) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
101 (assq inv buffer-invisibility-spec))) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
102 (overlay-put ol 'reveal-invisible inv)))) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
103 (if (null open) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
104 (overlay-put ol 'invisible nil) |
41621 | 105 ;; Use the provided opening function and repeat (since the |
106 ;; opening function might have hidden a subpart around point). | |
107 (setq repeat t) | |
108 (condition-case err | |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
109 (funcall open ol nil) |
50384
09ec24acd6a5
(reveal-post-command): Remove buggy debugging code.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50374
diff
changeset
|
110 (error (message "!!Reveal-show: %s !!" err) |
50374
73660951a233
(reveal-post-command): Better error handling and debugging.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48399
diff
changeset
|
111 ;; 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
|
112 ;; 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
|
113 (setq repeat nil) |
50374
73660951a233
(reveal-post-command): Better error handling and debugging.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
48399
diff
changeset
|
114 (overlay-put ol 'invisible nil)))))))) |
41621 | 115 ;; Close old overlays. |
116 (dolist (ol old-ols) | |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
117 (when (and (eq (current-buffer) (overlay-buffer ol)) |
41621 | 118 (not (rassq ol reveal-open-spots))) |
119 (if (and (>= (point) (save-excursion | |
120 (goto-char (overlay-start ol)) | |
121 (line-beginning-position 1))) | |
122 (<= (point) (save-excursion | |
123 (goto-char (overlay-end ol)) | |
124 (line-beginning-position 2)))) | |
125 ;; Still near the overlay: keep it open. | |
126 (push (cons (selected-window) ol) reveal-open-spots) | |
127 ;; Really close it. | |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
128 (let ((open (overlay-get ol 'reveal-toggle-invisible)) inv) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
129 (if (or open |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
130 (and (setq inv (overlay-get ol 'reveal-invisible)) |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
131 (setq open (or (get inv 'reveal-toggle-invisible) |
50617
9582ab8af8fe
(reveal-post-command): Use overlay-get for overlays.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50384
diff
changeset
|
132 (overlay-get ol 'isearch-open-invisible-temporary))))) |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
133 (condition-case err |
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
134 (funcall open ol t) |
50384
09ec24acd6a5
(reveal-post-command): Remove buggy debugging code.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50374
diff
changeset
|
135 (error (message "!!Reveal-hide: %s !!" err))) |
45428
ac7e0cc03aed
(reveal-post-command): Reverse the semantics of
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
45341
diff
changeset
|
136 (overlay-put ol 'invisible inv))))))) |
50384
09ec24acd6a5
(reveal-post-command): Remove buggy debugging code.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
50374
diff
changeset
|
137 (error (message "Reveal: %s" err))))) |
41621 | 138 |
139 ;;;###autoload | |
140 (define-minor-mode reveal-mode | |
141 "Toggle Reveal mode on or off. | |
142 Reveal mode renders invisible text around point visible again. | |
143 | |
144 Interactively, with no prefix argument, toggle the mode. | |
145 With universal prefix ARG (or if ARG is nil) turn mode on. | |
146 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
|
147 :lighter (global-reveal-mode nil " Reveal") |
41621 | 148 (if reveal-mode |
149 (progn | |
150 (set (make-local-variable 'search-invisible) t) | |
151 (add-hook 'post-command-hook 'reveal-post-command nil t)) | |
152 (kill-local-variable 'search-invisible) | |
153 (remove-hook 'post-command-hook 'reveal-post-command t))) | |
154 | |
155 ;;;###autoload | |
156 (define-minor-mode global-reveal-mode | |
157 "Toggle Reveal mode in all buffers on or off. | |
158 Reveal mode renders invisible text around point visible again. | |
159 | |
160 Interactively, with no prefix argument, toggle the mode. | |
161 With universal prefix ARG (or if ARG is nil) turn mode on. | |
162 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
|
163 :global t :group 'reveal |
41621 | 164 (setq-default reveal-mode global-reveal-mode) |
165 (if global-reveal-mode | |
166 (progn | |
167 (setq search-invisible t) | |
168 (add-hook 'post-command-hook 'reveal-post-command)) | |
169 (setq search-invisible 'open) ;FIXME | |
170 (remove-hook 'post-command-hook 'reveal-post-command))) | |
171 | |
172 (provide 'reveal) | |
48399
59fc5f077731
(global-reveal-mode): Add group.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
45428
diff
changeset
|
173 |
41621 | 174 ;;; reveal.el ends here |