|
0
|
1 ;;; foldout.el --- Folding extensions for outline-mode and outline-minor-mode.
|
|
|
2
|
|
|
3 ;; Copyright (C) 1994 Free Software Foundation, Inc.
|
|
|
4
|
|
|
5 ;; Author: Kevin Broadey <KevinB@bartley.demon.co.uk>
|
|
|
6 ;; Created: 27 Jan 1994
|
|
|
7 ;; Version: foldout.el 1.10 dated 94/05/19 at 17:09:12
|
|
|
8 ;; Keywords: folding, outline
|
|
|
9
|
|
|
10 ;; This file is part of XEmacs.
|
|
|
11
|
|
|
12 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
13 ;; under the terms of the GNU General Public License as published by
|
|
|
14 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
15 ;; any later version.
|
|
|
16
|
|
|
17 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
20 ;; General Public License for more details.
|
|
|
21
|
|
|
22 ;; You should have received a copy of the GNU General Public License
|
|
|
23 ;; along with XEmacs; see the file COPYING. If not, write to the Free
|
|
2
|
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
|
25 ;; 02111-1307, USA.
|
|
0
|
26
|
|
2
|
27 ;;; Synched up with: FSF 19.34.
|
|
0
|
28
|
|
|
29 ;;; Commentary:
|
|
|
30
|
|
|
31 ;; This file provides folding editor extensions for outline-mode and
|
|
|
32 ;; outline-minor-mode buffers. What's a "folding editor"? Read on...
|
|
|
33 ;;
|
|
|
34 ;; Imagine you're in an outline-mode buffer and you've hidden all the text and
|
|
|
35 ;; subheadings under your level-1 headings. You now want to look at the stuff
|
|
|
36 ;; hidden under one of these headings. Normally you'd do C-c C-e (show-entry)
|
|
|
37 ;; to expose the body or C-c C-i to expose the child (level-2) headings.
|
|
|
38 ;;
|
|
|
39 ;; With foldout, you do C-c C-z (foldout-zoom-subtree). This exposes the body
|
|
|
40 ;; and child subheadings and narrows the buffer so that only the level-1
|
|
|
41 ;; heading, the body and the level-2 headings are visible. If you now want to
|
|
|
42 ;; look under one of the level-2 headings, position the cursor on it and do C-c
|
|
|
43 ;; C-z again. This exposes the level-2 body and its level-3 child subheadings
|
|
|
44 ;; and narrows the buffer again. You can keep on zooming in on successive
|
|
|
45 ;; subheadings as much as you like. A string in the modeline tells you how
|
|
|
46 ;; deep you've gone.
|
|
|
47 ;;
|
|
|
48 ;; When zooming in on a heading you might only want to see the child
|
|
|
49 ;; subheadings. You do this by specifying a numeric argument: C-u C-c C-z.
|
|
|
50 ;; You can specify the number of levels of children too (c.f. show-children):
|
|
|
51 ;; e.g. M-2 C-c C-z exposes two levels of child subheadings. Alternatively,
|
|
|
52 ;; you might only be interested in the body. You do this by specifying a
|
|
|
53 ;; negative argument: M-- C-c C-z. You can also cause the whole subtree to be
|
|
|
54 ;; expanded, similar to C-c C-s (show-subtree), by specifying a zero argument:
|
|
|
55 ;; M-0 C-c C-z.
|
|
|
56 ;;
|
|
|
57 ;; While you're zoomed in you can still use outline-mode's exposure and hiding
|
|
|
58 ;; functions. It won't upset foldout at all. Also, since the buffer is
|
|
|
59 ;; narrowed, "global" editing actions will only affect the stuff under the
|
|
|
60 ;; zoomed-in heading. This is useful for restricting changes to a particular
|
|
|
61 ;; chapter or section of your document.
|
|
|
62 ;;
|
|
|
63 ;; You unzoom (exit) a fold by doing C-c C-x (foldout-exit-fold). This hides
|
|
|
64 ;; all the text and subheadings under the top-level heading and returns you to
|
|
|
65 ;; the previous view of the buffer. Specifying a numeric argument exits that
|
|
|
66 ;; many folds. Specifying a zero argument exits *all* folds.
|
|
|
67 ;;
|
|
|
68 ;; You might want to exit a fold *without* hiding the text and subheadings.
|
|
|
69 ;; You do this by specifying a negative argument. For example, M--2 C-c C-x
|
|
|
70 ;; exits two folds and leaves the text and subheadings exposed.
|
|
|
71 ;;
|
|
|
72 ;; Foldout also provides mouse bindings for entering and exiting folds and for
|
|
|
73 ;; showing and hiding text. Hold down Meta and Control, then click a mouse
|
|
|
74 ;; button as follows:-
|
|
|
75 ;;
|
|
|
76 ;; mouse-1 (foldout-mouse-zoom) zooms in on the heading clicked on:-
|
|
|
77 ;;
|
|
|
78 ;; single click expose body
|
|
|
79 ;; double click expose subheadings
|
|
|
80 ;; triple click expose body and subheadings
|
|
|
81 ;; quad click expose entire subtree
|
|
|
82 ;;
|
|
|
83 ;; mouse-2 (foldout-mouse-show) exposes text under the heading clicked on:-
|
|
|
84 ;;
|
|
|
85 ;; single click expose body
|
|
|
86 ;; double click expose subheadings
|
|
|
87 ;; triple click expose body and subheadings
|
|
|
88 ;; quad click expose entire subtree
|
|
|
89 ;;
|
|
|
90 ;; mouse-3 (foldout-mouse-hide-or-exit) hides text under the heading clicked
|
|
|
91 ;; on or exits the fold:-
|
|
|
92 ;;
|
|
|
93 ;; single click hide subtree
|
|
|
94 ;; double click exit fold and hide text
|
|
|
95 ;; triple click exit fold without hiding text
|
|
|
96 ;; quad click exit all folds and hide text
|
|
|
97 ;;
|
|
|
98 ;; You can change the modifier keys used by setting `foldout-mouse-modifiers'.
|
|
|
99
|
|
|
100 ;;; Installation:
|
|
|
101
|
|
|
102 ;; To use foldout, put this in your .emacs:-
|
|
|
103 ;;
|
|
|
104 ;; (require 'foldout)
|
|
|
105 ;;
|
|
|
106 ;; If you don't want it loaded until you need it, try this instead:-
|
|
|
107 ;;
|
|
|
108 ;; (eval-after-load "outline" '(require 'foldout))
|
|
|
109
|
|
|
110 ;;; Advertisements:
|
|
|
111
|
|
|
112 ;; Get out-xtra.el by Per Abrahamsen <abraham@iesd.auc.dk> for more
|
|
|
113 ;; outline-mode goodies. In particular, `outline-hide-sublevels' makes
|
|
|
114 ;; setup a lot easier.
|
|
|
115 ;;
|
|
|
116 ;; folding.el by Jamie Lokier <u90jl@ecs.ox.ac.uk> supports folding by
|
|
|
117 ;; recognising special marker text in you file.
|
|
|
118 ;;
|
|
|
119 ;; c-outline.el (by me) provides outline-mode support to recognise `C'
|
|
|
120 ;; statements as outline headings, so with foldout you can have a folding `C'
|
|
|
121 ;; code editor without having to put in start- and end-of-fold markers. This
|
|
|
122 ;; is a real winner!
|
|
|
123
|
|
|
124 ;;; ChangeLog:
|
|
|
125
|
|
|
126 ;; 1.10 21-Mar-94
|
|
|
127 ;; foldout.el is now part of the GNU Emacs distribution!!
|
|
|
128 ;; Put in changes made by RMS to version 1.8 to keep the diffs to a minimum.
|
|
|
129 ;; bugfix: numeric arg to foldout-exit-fold wasn't working - looks like I don't
|
|
|
130 ;; know how to use the Common LISP `loop' macro after all, so use `while'
|
|
|
131 ;; instead.
|
|
|
132
|
|
|
133 ;; 1.9 15-Mar-94
|
|
|
134 ;; Didn't test that very well, did I? The change to foldout-zoom-subtree
|
|
|
135 ;; affected foldout-mouse-zoom: if the heading under the `level n' one clicked
|
|
|
136 ;; on was at `level n+2' then it didn't get exposed. Sorry about that!
|
|
|
137
|
|
|
138 ;; 1.8 15-Mar-94
|
|
|
139 ;; Changed meaning of prefix arg to foldout-zoom-subtree. arg > 0 now means
|
|
|
140 ;; "expose that many children" instead of just "expose children" so it is more
|
|
|
141 ;; like `show-children' (C-c C-i). Arg of C-u on its own only shows one level
|
|
|
142 ;; of children, though, so you can still zoom by doing C-u C-c C-z.
|
|
|
143 ;;
|
|
|
144 ;; I can't think of a good meaning for the value of a negative prefix. Any
|
|
|
145 ;; suggestions?
|
|
|
146 ;;
|
|
|
147 ;; Added advertisement for my c-outline.el package. Now you can have a folding
|
|
|
148 ;; editor for c-mode without any effort!
|
|
|
149
|
|
|
150 ;; 1.7 7-Mar-94
|
|
|
151 ;; I got fed up trying to work out how many blank lines there were outside the
|
|
|
152 ;; narrowed region when inside a fold. Now *all* newlines before the following
|
|
|
153 ;; heading are *in* the narrowed region. Thus, if the cursor is at point-max,
|
|
|
154 ;; the number of blank lines above it is the number you'll get above the next
|
|
|
155 ;; heading.
|
|
|
156 ;;
|
|
|
157 ;; Since all newlines are now inside the narrowed region, when exiting a fold
|
|
|
158 ;; add a newline at the end of the region if there isn't one so that the
|
|
|
159 ;; following heading doesn't accidentally get joined to the body text.
|
|
|
160 ;;
|
|
|
161 ;; Bugfix: `foldout-mouse-modifiers' should be `defvar', not `defconst'.
|
|
|
162 ;;
|
|
|
163 ;; Use "cond" instead of "case" so that lemacs-19.9 users can use the mouse.
|
|
|
164 ;;
|
|
|
165 ;; Improve "Commentary" entry on using the mouse.
|
|
|
166 ;;
|
|
|
167 ;; Add "Installation" keyword.
|
|
|
168
|
|
|
169 ;; 1.6 3-Mar-94
|
|
|
170 ;; Add mouse support functions foldout-mouse-zoom, foldout-mouse-show,
|
|
|
171 ;; foldout-mouse-hide-or-exit.
|
|
|
172
|
|
|
173 ;; 1.5 11-Feb-94
|
|
|
174 ;; Rename `foldout-enter-subtree' to `foldout-zoom-subtree' and change
|
|
|
175 ;; keystroke from C-g to C-z. This is more mnemonic and leaves C-g alone, as
|
|
|
176 ;; users expect this to cancel the current key sequence.
|
|
|
177 ;;
|
|
|
178 ;; Added better commentary at the request of RMS. Added stuff to comply with
|
|
|
179 ;; the lisp-mnt.el conventions. Added instructions on how best to load the
|
|
|
180 ;; package.
|
|
|
181
|
|
|
182 ;; 1.4 2-Feb-94
|
|
|
183 ;; Bugfix: end-of-fold marking was wrong:-
|
|
|
184 ;;
|
|
|
185 ;; End of narrowed region should be one character on from
|
|
|
186 ;; (outline-end-of-subtree) so it includes the end-of-line at the end of the
|
|
|
187 ;; last line of the subtree.
|
|
|
188 ;;
|
|
|
189 ;; End-of-fold marker should be outside the narrowed region so text inserted
|
|
|
190 ;; at the end of the region goes before the marker. Need to make a special
|
|
|
191 ;; case for end-of-buffer because it is impossible to set a marker that will
|
|
|
192 ;; follow eob. Bummer.
|
|
|
193
|
|
|
194 ;; 1.3 28-Jan-94
|
|
|
195 ;; Changed `foldout-zoom-subtree'. A zero arg now makes it expose the entire
|
|
|
196 ;; subtree on entering the fold. As before, < 0 shows only the body and > 0
|
|
|
197 ;; shows only the subheadings.
|
|
|
198
|
|
|
199 ;; 1.2 28-Jan-94
|
|
|
200 ;; Fixed a dumb bug - didn't make `foldout-modeline-string' buffer-local :-(
|
|
|
201 ;;
|
|
|
202 ;; Changed `foldout-exit-fold' to use prefix arg to say how many folds to exit.
|
|
|
203 ;; Negative arg means exit but don't hide text. Zero arg means exit all folds.
|
|
|
204 ;;
|
|
|
205 ;; Added `foldout-inhibit-key-bindings' to inhibit key bindings.
|
|
|
206
|
|
|
207 ;; 1.1 27-Jan-94
|
|
|
208 ;; Released to the net. Inspired by a question in gnu.emacs.help from
|
|
|
209 ;; Jason D Lohn <jlohn@eng.umd.edu>.
|
|
|
210
|
|
|
211 ;;; Code:
|
|
|
212
|
|
|
213 (require 'outline)
|
|
|
214
|
|
|
215 ;; something has gone very wrong if outline-minor-mode isn't bound now.
|
|
|
216 (if (not (boundp 'outline-minor-mode))
|
|
|
217 (error "Can't find outline-minor-mode"))
|
|
|
218
|
|
|
219 (defconst foldout-fold-list nil
|
|
|
220 "List of start and end markers for the folds currently entered.
|
|
|
221 An end marker of NIL means the fold ends after (point-max).")
|
|
|
222 (make-variable-buffer-local 'foldout-fold-list)
|
|
|
223
|
|
|
224 (defconst foldout-modeline-string nil
|
|
|
225 "Modeline string announcing that we are in an outline fold.")
|
|
|
226 (make-variable-buffer-local 'foldout-modeline-string)
|
|
|
227
|
|
|
228 ;; put our minor mode string immediately following outline-minor-mode's
|
|
|
229 (or (assq 'foldout-modeline-string minor-mode-alist)
|
|
|
230 (let ((outl-entry (memq (assq 'outline-minor-mode minor-mode-alist)
|
|
|
231 minor-mode-alist))
|
|
|
232 (foldout-entry '((foldout-modeline-string foldout-modeline-string))))
|
|
|
233
|
|
|
234 ;; something's wrong with outline if we can't find it
|
|
|
235 (if (null outl-entry)
|
|
|
236 (error "Can't find outline-minor-mode in minor-mode-alist"))
|
|
|
237
|
|
|
238 ;; slip our fold announcement into the list
|
|
|
239 (setcdr outl-entry (nconc foldout-entry (cdr outl-entry)))
|
|
|
240 ))
|
|
|
241
|
|
|
242
|
|
|
243 (defun foldout-zoom-subtree (&optional exposure)
|
|
|
244 "Open the subtree under the current heading and narrow to it.
|
|
|
245
|
|
|
246 Normally the body and the immediate subheadings are exposed, but
|
|
|
247 optional arg EXPOSURE \(interactively with prefix arg\) changes this:-
|
|
|
248
|
|
|
249 EXPOSURE > 0 exposes n levels of subheadings (c.f. show-children)
|
|
|
250 EXPOSURE < 0 exposes only the body
|
|
|
251 EXPOSURE = 0 exposes the entire subtree"
|
|
|
252 (interactive "P")
|
|
|
253 (save-excursion
|
|
|
254 (widen)
|
|
|
255 (outline-back-to-heading)
|
|
|
256 (let* ((exposure-value (prefix-numeric-value exposure))
|
|
|
257 (start (point))
|
|
|
258 (start-marker (point-marker))
|
|
|
259 (end (progn (outline-end-of-subtree)
|
|
|
260 (skip-chars-forward "\n\^M")
|
|
|
261 (point)))
|
|
|
262 ;; I need a marker that will follow the end of the region even when
|
|
|
263 ;; text is inserted right at the end. Text gets inserted *after*
|
|
|
264 ;; markers, so I need it at end+1. Unfortunately I can't set a
|
|
|
265 ;; marker at (point-max)+1, so I use NIL to mean the region ends at
|
|
|
266 ;; (point-max).
|
|
|
267 (end-marker (if (eobp) nil (set-marker (make-marker) (1+ end))))
|
|
|
268 )
|
|
|
269
|
|
|
270 ;; narrow to this subtree
|
|
|
271 (narrow-to-region start end)
|
|
|
272
|
|
|
273 ;; show the body and/or subheadings for this heading
|
|
|
274 (goto-char start)
|
|
|
275 (cond
|
|
|
276 ((null exposure)
|
|
|
277 (show-entry)
|
|
|
278 (show-children))
|
|
|
279 ((< exposure-value 0)
|
|
|
280 (show-entry))
|
|
|
281 ((consp exposure)
|
|
|
282 (show-children))
|
|
|
283 ((> exposure-value 0)
|
|
|
284 (show-children exposure-value))
|
|
|
285 (t
|
|
|
286 (show-subtree))
|
|
|
287 )
|
|
|
288
|
|
|
289 ;; save the location of the fold we are entering
|
|
|
290 (setq foldout-fold-list (cons (cons start-marker end-marker)
|
|
|
291 foldout-fold-list))
|
|
|
292
|
|
|
293 ;; update the modeline
|
|
|
294 (foldout-update-modeline)
|
|
|
295 )))
|
|
|
296
|
|
|
297
|
|
|
298 (defun foldout-exit-fold (&optional num-folds)
|
|
|
299 "Return to the ARG'th enclosing fold view. With ARG = 0 exit all folds.
|
|
|
300
|
|
|
301 Normally causes exited folds to be hidden, but with ARG < 0, -ARG folds are
|
|
|
302 exited and text is left visible."
|
|
|
303 (interactive "p")
|
|
|
304 (let (start-marker end-marker (hide-fold t))
|
|
|
305
|
|
|
306 ;; check there are some folds to leave
|
|
|
307 (if (null foldout-fold-list)
|
|
|
308 (error "Not in a fold!"))
|
|
|
309
|
|
|
310 (cond
|
|
|
311 ;; catch a request to leave all folds
|
|
|
312 ((zerop num-folds)
|
|
|
313 (setq num-folds (length foldout-fold-list)))
|
|
|
314
|
|
|
315 ;; have we been told not to hide the fold?
|
|
|
316 ((< num-folds 0)
|
|
|
317 (setq hide-fold nil
|
|
|
318 num-folds (- num-folds)))
|
|
|
319 )
|
|
|
320
|
|
|
321 ;; limit the number of folds if we've been told to exit too many
|
|
|
322 (setq num-folds (min num-folds (length foldout-fold-list)))
|
|
|
323
|
|
|
324 ;; exit the folds
|
|
|
325 (widen)
|
|
|
326 (while (not (zerop num-folds))
|
|
|
327 ;; get the fold at the top of the stack
|
|
|
328 (setq start-marker (car (car foldout-fold-list))
|
|
|
329 end-marker (cdr (car foldout-fold-list))
|
|
|
330 foldout-fold-list (cdr foldout-fold-list)
|
|
|
331 num-folds (1- num-folds))
|
|
|
332
|
|
|
333 ;; Make sure there is a newline at the end of this fold,
|
|
|
334 ;; otherwise the following heading will get joined to the body
|
|
|
335 ;; text.
|
|
|
336 (if end-marker
|
|
|
337 (progn
|
|
|
338 (goto-char end-marker)
|
|
|
339 (forward-char -1)
|
|
|
340 (or (memq (preceding-char) '(?\n ?\^M))
|
|
|
341 (insert ?\n))))
|
|
|
342
|
|
|
343 ;; If this is the last fold to exit, hide the text unless we've
|
|
|
344 ;; been told not to. Note that at the moment point is at the
|
|
|
345 ;; beginning of the following heading if there is one.
|
|
|
346
|
|
|
347 ;; Also, make sure that the newline before the following heading
|
|
|
348 ;; is \n otherwise it will be hidden. If there is a newline
|
|
|
349 ;; before this one, make it visible too so we do the same as
|
|
|
350 ;; outline.el and leave a blank line before the heading.
|
|
|
351 (if (zerop num-folds)
|
|
|
352 (let ((beginning-of-heading (point))
|
|
|
353 (end-of-subtree (if end-marker
|
|
|
354 (progn
|
|
|
355 (forward-char -1)
|
|
|
356 (if (memq (preceding-char)
|
|
|
357 '(?\n ?\^M))
|
|
|
358 (forward-char -1))
|
|
|
359 (point))
|
|
|
360 (point-max))))
|
|
|
361 ;; hide the subtree
|
|
|
362 (if hide-fold
|
|
|
363 (outline-flag-region start-marker end-of-subtree ?\^M))
|
|
|
364
|
|
|
365 ;; make sure the next heading is exposed
|
|
|
366 (if end-marker
|
|
|
367 (outline-flag-region end-of-subtree
|
|
|
368 beginning-of-heading ?\n))
|
|
|
369 ))
|
|
|
370
|
|
|
371 ;; zap the markers so they don't slow down editing
|
|
|
372 (set-marker start-marker nil)
|
|
|
373 (if end-marker (set-marker end-marker nil))
|
|
|
374 )
|
|
|
375
|
|
|
376 ;; narrow to the enclosing fold if there is one
|
|
|
377 (if foldout-fold-list
|
|
|
378 (progn
|
|
|
379 (setq start-marker (car (car foldout-fold-list))
|
|
|
380 end-marker (cdr (car foldout-fold-list)))
|
|
|
381 (narrow-to-region start-marker
|
|
|
382 (if end-marker
|
|
|
383 (1- (marker-position end-marker))
|
|
|
384 (point-max)))
|
|
|
385 ))
|
|
|
386 (recenter)
|
|
|
387
|
|
|
388 ;; update the modeline
|
|
|
389 (foldout-update-modeline)
|
|
|
390 ))
|
|
|
391
|
|
|
392
|
|
|
393 (defun foldout-update-modeline ()
|
|
|
394 "Set the modeline string to indicate our fold depth."
|
|
|
395 (let ((depth (length foldout-fold-list)))
|
|
|
396 (setq foldout-modeline-string
|
|
|
397 (cond
|
|
|
398 ;; if we're not in a fold, keep quiet
|
|
|
399 ((zerop depth)
|
|
|
400 nil)
|
|
|
401 ;; in outline-minor-mode we're after "Outl:xx" in the modeline
|
|
|
402 (outline-minor-mode
|
|
|
403 (format ":%d" depth))
|
|
|
404 ;; otherwise just announce the depth (I guess we're in outline-mode)
|
|
|
405 ((= depth 1)
|
|
|
406 " Inside 1 fold")
|
|
|
407 (t
|
|
|
408 (format " Inside %d folds" depth))
|
|
|
409 ))))
|
|
|
410
|
|
|
411
|
|
|
412 (defun foldout-mouse-zoom (event)
|
|
|
413 "Zoom in on the heading clicked on.
|
|
|
414
|
|
|
415 How much is exposed by the zoom depends on the number of mouse clicks:-
|
|
|
416
|
|
|
417 1 expose body
|
|
|
418 2 expose subheadings
|
|
|
419 3 expose body and subheadings
|
|
|
420 4 expose entire subtree"
|
|
|
421 (interactive "@e")
|
|
|
422
|
|
|
423 ;; swallow intervening mouse events so we only get the final click-count.
|
|
|
424 (setq event (foldout-mouse-swallow-events event))
|
|
|
425
|
|
|
426 ;; go to the heading clicked on
|
|
|
427 (foldout-mouse-goto-heading event)
|
|
|
428
|
|
|
429 ;; zoom away
|
|
|
430 (foldout-zoom-subtree
|
|
|
431 (let ((nclicks (event-click-count event)))
|
|
|
432 (cond
|
|
|
433 ((= nclicks 1) -1) ; body only
|
|
|
434 ((= nclicks 2) '(1)) ; subheadings only
|
|
|
435 ((= nclicks 3) nil) ; body and subheadings
|
|
|
436 (t 0))))) ; entire subtree
|
|
|
437
|
|
|
438 (defun foldout-mouse-show (event)
|
|
|
439 "Show what is hidden under the heading clicked on.
|
|
|
440
|
|
|
441 What gets exposed depends on the number of mouse clicks:-
|
|
|
442
|
|
|
443 1 expose body
|
|
|
444 2 expose subheadings
|
|
|
445 3 expose body and subheadings
|
|
|
446 4 expose entire subtree"
|
|
|
447 (interactive "@e")
|
|
|
448
|
|
|
449 ;; swallow intervening mouse events so we only get the final click-count.
|
|
|
450 (setq event (foldout-mouse-swallow-events event))
|
|
|
451
|
|
|
452 ;; expose the text
|
|
|
453 (foldout-mouse-goto-heading event)
|
|
|
454 (let ((nclicks (event-click-count event)))
|
|
|
455 (cond
|
|
|
456 ((= nclicks 1) (show-entry))
|
|
|
457 ((= nclicks 2) (show-children))
|
|
|
458 ((= nclicks 3) (show-entry) (show-children))
|
|
|
459 (t (show-subtree)))))
|
|
|
460
|
|
|
461 (defun foldout-mouse-hide-or-exit (event)
|
|
|
462 "Hide the subtree under the heading clicked on, or exit a fold.
|
|
|
463
|
|
|
464 What happens depends on the number of mouse clicks:-
|
|
|
465
|
|
|
466 1 hide subtree
|
|
|
467 2 exit fold and hide text
|
|
|
468 3 exit fold without hiding text
|
|
|
469 4 exit all folds and hide text"
|
|
|
470 (interactive "@e")
|
|
|
471
|
|
|
472 ;; swallow intervening mouse events so we only get the final click-count.
|
|
|
473 (setq event (foldout-mouse-swallow-events event))
|
|
|
474
|
|
|
475 ;; hide or exit
|
|
|
476 (let ((nclicks (event-click-count event)))
|
|
|
477 (if (= nclicks 1)
|
|
|
478 (progn
|
|
|
479 (foldout-mouse-goto-heading event)
|
|
|
480 (hide-subtree))
|
|
|
481 (foldout-exit-fold
|
|
|
482 (cond
|
|
|
483 ((= nclicks 2) 1) ; exit and hide
|
|
|
484 ((= nclicks 3) -1) ; exit don't hide
|
|
|
485 (t 0)))))) ; exit all
|
|
|
486
|
|
|
487
|
|
|
488 (defun foldout-mouse-swallow-events (event)
|
|
|
489 "Swallow intervening mouse events so we only get the final click-count.
|
|
|
490 Signal an error if the final event isn't the same type as the first one."
|
|
|
491 (let ((initial-event-type (event-basic-type event)))
|
|
|
492 (while (null (sit-for 0 double-click-time 'nodisplay))
|
|
|
493 (setq event (read-event)))
|
|
|
494 (or (eq initial-event-type (event-basic-type event))
|
|
|
495 (error "")))
|
|
|
496 event)
|
|
|
497
|
|
|
498 (defun foldout-mouse-goto-heading (event)
|
|
|
499 "Go to the heading where the mouse event started. Signal an error
|
|
|
500 if the event didn't occur on a heading."
|
|
|
501 (goto-char (posn-point (event-start event)))
|
|
|
502 (or (outline-on-heading-p)
|
|
|
503 ;; outline.el sometimes treats beginning-of-buffer as a heading
|
|
|
504 ;; even though outline-on-heading returns nil.
|
|
|
505 (save-excursion (beginning-of-line) (bobp))
|
|
|
506 (error "Not a heading line")))
|
|
|
507
|
|
|
508
|
|
|
509 ;;; Keymaps:
|
|
|
510
|
|
|
511 (defvar foldout-inhibit-key-bindings nil
|
|
|
512 "Set non-NIL before loading foldout to inhibit key bindings.")
|
|
|
513
|
|
|
514 (defvar foldout-mouse-modifiers '(meta control)
|
|
|
515 "List of modifier keys to apply to foldout's mouse events.
|
|
|
516
|
|
|
517 The default (meta control) makes foldout bind its functions to
|
|
|
518 M-C-down-mouse-{1,2,3}.
|
|
|
519
|
|
|
520 Valid modifiers are shift, control, meta, alt, hyper and super.")
|
|
|
521
|
|
|
522 (if foldout-inhibit-key-bindings
|
|
|
523 ()
|
|
|
524 (define-key outline-mode-map "\C-c\C-z" 'foldout-zoom-subtree)
|
|
|
525 (define-key outline-mode-map "\C-c\C-x" 'foldout-exit-fold)
|
|
|
526 (define-key outline-minor-mode-map
|
|
|
527 (concat outline-minor-mode-prefix "\C-z") 'foldout-zoom-subtree)
|
|
|
528 (define-key outline-minor-mode-map
|
|
|
529 (concat outline-minor-mode-prefix "\C-x") 'foldout-exit-fold)
|
|
|
530
|
|
|
531 (let* ((modifiers (apply 'concat
|
|
|
532 (mapcar (function
|
|
|
533 (lambda (modifier)
|
|
|
534 (vector
|
|
|
535 (cond
|
|
|
536 ((eq modifier 'shift) ?S)
|
|
|
537 ((eq modifier 'control) ?C)
|
|
|
538 ((eq modifier 'meta) ?M)
|
|
|
539 ((eq modifier 'alt) ?A)
|
|
|
540 ((eq modifier 'hyper) ?H)
|
|
|
541 ((eq modifier 'super) ?s)
|
|
|
542 (t (error "invalid mouse modifier %s"
|
|
|
543 modifier)))
|
|
|
544 ?-)))
|
|
|
545 foldout-mouse-modifiers)))
|
|
|
546 (mouse-1 (vector (intern (concat modifiers "down-mouse-1"))))
|
|
|
547 (mouse-2 (vector (intern (concat modifiers "down-mouse-2"))))
|
|
|
548 (mouse-3 (vector (intern (concat modifiers "down-mouse-3")))))
|
|
|
549
|
|
|
550 (define-key outline-mode-map mouse-1 'foldout-mouse-zoom)
|
|
|
551 (define-key outline-mode-map mouse-2 'foldout-mouse-show)
|
|
|
552 (define-key outline-mode-map mouse-3 'foldout-mouse-hide-or-exit)
|
|
|
553
|
|
|
554 (define-key outline-minor-mode-map mouse-1 'foldout-mouse-zoom)
|
|
|
555 (define-key outline-minor-mode-map mouse-2 'foldout-mouse-show)
|
|
|
556 (define-key outline-minor-mode-map mouse-3 'foldout-mouse-hide-or-exit)
|
|
|
557 ))
|
|
|
558
|
|
|
559 (provide 'foldout)
|
|
|
560
|
|
|
561 ;;; foldout.el ends here
|
|
|
562
|
