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