1 ;;; outline.el --- outline mode commands for Emacs
3 ;; Copyright (C) 1986, 1993, 1994, 1995, 1997, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; This package is a major mode for editing outline-format documents.
29 ;; An outline can be `abstracted' to show headers at any given level,
30 ;; with all stuff below hidden. See the Emacs manual for details.
34 ;; - subtree-terminators
35 ;; - better handle comments before function bodies (i.e. heading)
36 ;; - don't bother hiding whitespace
40 (defvar font-lock-warning-face
)
43 (defgroup outlines nil
44 "Support for hierarchical outlining."
48 (defcustom outline-regexp
"[*\^L]+"
49 "Regular expression to match the beginning of a heading.
50 Any line whose beginning matches this regexp is considered to start a heading.
51 Note that Outline mode only checks this regexp at the start of a line,
52 so the regexp need not (and usually does not) start with `^'.
53 The recommended way to set this is with a Local Variables: list
54 in the file it applies to. See also `outline-heading-end-regexp'."
55 :type
'(choice regexp
(const nil
))
57 ;;;###autoload(put 'outline-regexp 'safe-local-variable 'string-or-null-p)
59 (defcustom outline-heading-end-regexp
"\n"
60 "Regular expression to match the end of a heading line.
61 You can assume that point is at the beginning of a heading when this
62 regexp is searched for. The heading ends at the end of the match.
63 The recommended way to set this is with a `Local Variables:' list
64 in the file it applies to."
68 (defvar outline-mode-prefix-map
69 (let ((map (make-sparse-keymap)))
70 (define-key map
"@" 'outline-mark-subtree
)
71 (define-key map
"\C-n" 'outline-next-visible-heading
)
72 (define-key map
"\C-p" 'outline-previous-visible-heading
)
73 (define-key map
"\C-i" 'show-children
)
74 (define-key map
"\C-s" 'show-subtree
)
75 (define-key map
"\C-d" 'hide-subtree
)
76 (define-key map
"\C-u" 'outline-up-heading
)
77 (define-key map
"\C-f" 'outline-forward-same-level
)
78 (define-key map
"\C-b" 'outline-backward-same-level
)
79 (define-key map
"\C-t" 'hide-body
)
80 (define-key map
"\C-a" 'show-all
)
81 (define-key map
"\C-c" 'hide-entry
)
82 (define-key map
"\C-e" 'show-entry
)
83 (define-key map
"\C-l" 'hide-leaves
)
84 (define-key map
"\C-k" 'show-branches
)
85 (define-key map
"\C-q" 'hide-sublevels
)
86 (define-key map
"\C-o" 'hide-other
)
87 (define-key map
"\C-^" 'outline-move-subtree-up
)
88 (define-key map
"\C-v" 'outline-move-subtree-down
)
89 (define-key map
[(control ?
<)] 'outline-promote
)
90 (define-key map
[(control ?
>)] 'outline-demote
)
91 (define-key map
"\C-m" 'outline-insert-heading
)
92 ;; Where to bind outline-cycle ?
95 (defvar outline-mode-menu-bar-map
96 (let ((map (make-sparse-keymap)))
98 (define-key map
[hide] (cons "Hide" (make-sparse-keymap "Hide")))
100 (define-key map [hide hide-other] '("Hide Other" . hide-other))
101 (define-key map [hide hide-sublevels] '("Hide Sublevels" . hide-sublevels))
102 (define-key map [hide hide-subtree] '("Hide Subtree" . hide-subtree))
103 (define-key map [hide hide-entry] '("Hide Entry" . hide-entry))
104 (define-key map [hide hide-body] '("Hide Body" . hide-body))
105 (define-key map [hide hide-leaves] '("Hide Leaves" . hide-leaves))
107 (define-key map [show] (cons "Show" (make-sparse-keymap "Show")))
109 (define-key map [show show-subtree] '("Show Subtree" . show-subtree))
110 (define-key map [show show-children] '("Show Children" . show-children))
111 (define-key map [show show-branches] '("Show Branches" . show-branches))
112 (define-key map [show show-entry] '("Show Entry" . show-entry))
113 (define-key map [show show-all] '("Show All" . show-all))
115 (define-key map [headings]
116 (cons "Headings" (make-sparse-keymap "Headings")))
118 (define-key map [headings demote-subtree]
119 '(menu-item "Demote subtree" outline-demote))
120 (define-key map [headings promote-subtree]
121 '(menu-item "Promote subtree" outline-promote))
122 (define-key map [headings move-subtree-down]
123 '(menu-item "Move subtree down" outline-move-subtree-down))
124 (define-key map [headings move-subtree-up]
125 '(menu-item "Move subtree up" outline-move-subtree-up))
126 (define-key map [headings copy]
127 '(menu-item "Copy to kill ring" outline-headers-as-kill
128 :enable mark-active))
129 (define-key map [headings outline-insert-heading]
130 '("New heading" . outline-insert-heading))
131 (define-key map [headings outline-backward-same-level]
132 '("Previous Same Level" . outline-backward-same-level))
133 (define-key map [headings outline-forward-same-level]
134 '("Next Same Level" . outline-forward-same-level))
135 (define-key map [headings outline-previous-visible-heading]
136 '("Previous" . outline-previous-visible-heading))
137 (define-key map [headings outline-next-visible-heading]
138 '("Next" . outline-next-visible-heading))
139 (define-key map [headings outline-up-heading]
140 '("Up" . outline-up-heading))
143 (defvar outline-minor-mode-menu-bar-map
144 (let ((map (make-sparse-keymap)))
145 (define-key map [outline]
147 (nconc (make-sparse-keymap "Outline")
148 ;; Remove extra separator
150 ;; Flatten the major mode's menus into a single menu.
154 ;; Add a separator between each
155 ;; part of the unified menu.
156 (cons '(--- "---") (cdr x))))
157 outline-mode-menu-bar-map))))))
161 (defvar outline-mode-map
162 (let ((map (make-sparse-keymap)))
163 (define-key map "\C-c" outline-mode-prefix-map)
164 (define-key map [menu-bar] outline-mode-menu-bar-map)
167 (defvar outline-font-lock-keywords
169 ;; Highlight headings according to the level.
170 (eval . (list (concat "^\\(?:" outline-regexp "\\).+")
171 0 '(outline-font-lock-face) nil t)))
172 "Additional expressions to highlight in Outline mode.")
175 '((t :inherit font-lock-function-name-face))
180 '((t :inherit font-lock-variable-name-face))
185 '((t :inherit font-lock-keyword-face))
190 '((t :inherit font-lock-builtin-face))
195 '((t :inherit font-lock-comment-face))
200 '((t :inherit font-lock-constant-face))
205 '((t :inherit font-lock-type-face))
210 '((t :inherit font-lock-string-face))
214 (defvar outline-font-lock-faces
215 [outline-1 outline-2 outline-3 outline-4
216 outline-5 outline-6 outline-7 outline-8])
218 (defvar outline-font-lock-levels nil)
219 (make-variable-buffer-local 'outline-font-lock-levels)
221 (defun outline-font-lock-face ()
223 ;; (outline-back-to-heading t)
225 ;; (start-level (funcall outline-level))
226 ;; (level start-level)
228 ;; (while (not (setq face-level
229 ;; (if (or (bobp) (eq level 1)) 0
230 ;; (cdr (assq level outline-font-lock-levels)))))
231 ;; (outline-up-heading 1 t)
232 ;; (setq count (1+ count))
233 ;; (setq level (funcall outline-level)))
234 ;; ;; Remember for later.
235 ;; (unless (zerop count)
236 ;; (setq face-level (+ face-level count))
237 ;; (push (cons start-level face-level) outline-font-lock-levels))
238 ;; (condition-case nil
239 ;; (aref outline-font-lock-faces face-level)
240 ;; (error font-lock-warning-face))))
242 (goto-char (match-beginning 0))
243 (looking-at outline-regexp)
245 (aref outline-font-lock-faces (1- (funcall outline-level)))
246 (error font-lock-warning-face))))
248 (defvar outline-view-change-hook nil
249 "Normal hook to be run after outline visibility changes.")
251 (defvar outline-mode-hook nil
252 "*This hook is run when outline mode starts.")
254 (defvar outline-blank-line nil
255 "*Non-nil means to leave unhidden blank line before heading.")
258 (define-derived-mode outline-mode text-mode "Outline"
259 "Set major mode for editing outlines with selective display.
260 Headings are lines which start with asterisks: one for major headings,
261 two for subheadings, etc. Lines not starting with asterisks are body lines.
263 Body text or subheadings under a heading can be made temporarily
264 invisible, or visible again. Invisible lines are attached to the end
265 of the heading, so they move with it, if the line is killed and yanked
266 back. A heading with text hidden under it is marked with an ellipsis (...).
268 Commands:\\<outline-mode-map>
269 \\[outline-next-visible-heading] outline-next-visible-heading move by visible headings
270 \\[outline-previous-visible-heading] outline-previous-visible-heading
271 \\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings
272 \\[outline-backward-same-level] outline-backward-same-level
273 \\[outline-up-heading] outline-up-heading move from subheading to heading
275 \\[hide-body] make all text invisible (not headings).
276 \\[show-all] make everything in buffer visible.
277 \\[hide-sublevels] make only the first N levels of headers visible.
279 The remaining commands are used when point is on a heading line.
280 They apply to some of the body or subheadings of that heading.
281 \\[hide-subtree] hide-subtree make body and subheadings invisible.
282 \\[show-subtree] show-subtree make body and subheadings visible.
283 \\[show-children] show-children make direct subheadings visible.
284 No effect on body, or subheadings 2 or more levels down.
285 With arg N, affects subheadings N levels down.
286 \\[hide-entry] make immediately following body invisible.
287 \\[show-entry] make it visible.
288 \\[hide-leaves] make body under heading and under its subheadings invisible.
289 The subheadings remain visible.
290 \\[show-branches] make all subheadings at all levels visible.
292 The variable `outline-regexp' can be changed to control what is a heading.
293 A line is a heading if `outline-regexp' matches something at the
294 beginning of the line. The longer the match, the deeper the level.
296 Turning on outline mode calls the value of `text-mode-hook' and then of
297 `outline-mode-hook', if they are non-nil."
298 (make-local-variable 'line-move-ignore-invisible)
299 (setq line-move-ignore-invisible t)
300 ;; Cause use of ellipses for invisible text.
301 (add-to-invisibility-spec '(outline . t))
302 (set (make-local-variable 'paragraph-start)
303 (concat paragraph-start "\\|\\(?:" outline-regexp "\\)"))
304 ;; Inhibit auto-filling of header lines.
305 (set (make-local-variable 'auto-fill-inhibit-regexp) outline-regexp)
306 (set (make-local-variable 'paragraph-separate)
307 (concat paragraph-separate "\\|\\(?:" outline-regexp "\\)"))
308 (set (make-local-variable 'font-lock-defaults)
309 '(outline-font-lock-keywords t nil nil backward-paragraph))
310 (setq imenu-generic-expression
311 (list (list nil (concat "^\\(?:" outline-regexp "\\).*$") 0)))
312 (add-hook 'change-major-mode-hook 'show-all nil t))
314 (defcustom outline-minor-mode-prefix "\C-c@"
315 "*Prefix key to use for Outline commands in Outline minor mode.
316 The value of this variable is checked as part of loading Outline mode.
317 After that, changing the prefix key requires manipulating keymaps."
322 (define-minor-mode outline-minor-mode
323 "Toggle Outline minor mode.
324 With arg, turn Outline minor mode on if arg is positive, off otherwise.
325 See the command `outline-mode' for more information on this mode."
326 nil " Outl" (list (cons [menu-bar] outline-minor-mode-menu-bar-map)
327 (cons outline-minor-mode-prefix outline-mode-prefix-map))
329 (if outline-minor-mode
331 ;; Turn off this mode if we change major modes.
332 (add-hook 'change-major-mode-hook
333 (lambda () (outline-minor-mode -1))
335 (set (make-local-variable 'line-move-ignore-invisible) t)
336 ;; Cause use of ellipses for invisible text.
337 (add-to-invisibility-spec '(outline . t)))
338 (setq line-move-ignore-invisible nil)
339 ;; Cause use of ellipses for invisible text.
340 (remove-from-invisibility-spec '(outline . t))
341 ;; When turning off outline mode, get rid of any outline hiding.
344 (defvar outline-level 'outline-level
345 "*Function of no args to compute a header's nesting level in an outline.
346 It can assume point is at the beginning of a header line and that the match
347 data reflects the `outline-regexp'.")
349 (defvar outline-heading-alist ()
350 "Alist associating a heading for every possible level.
351 Each entry is of the form (HEADING . LEVEL).
352 This alist is used two ways: to find the heading corresponding to
353 a given level and to find the level of a given heading.
354 If a mode or document needs several sets of outline headings (for example
355 numbered and unnumbered sections), list them set by set and sorted by level
356 within each set. For example in texinfo mode:
358 (setq outline-heading-alist
359 '((\"@chapter\" . 2) (\"@section\" . 3) (\"@subsection\" . 4)
360 (\"@subsubsection\" . 5)
361 (\"@unnumbered\" . 2) (\"@unnumberedsec\" . 3)
362 (\"@unnumberedsubsec\" . 4) (\"@unnumberedsubsubsec\" . 5)
363 (\"@appendix\" . 2) (\"@appendixsec\" . 3)...
364 (\"@appendixsubsec\" . 4) (\"@appendixsubsubsec\" . 5) ..))
366 Instead of sorting the entries in each set, you can also separate the
368 (make-variable-buffer-local 'outline-heading-alist)
370 ;; This used to count columns rather than characters, but that made ^L
371 ;; appear to be at level 2 instead of 1. Columns would be better for
372 ;; tab handling, but the default regexp doesn't use tabs, and anyone
373 ;; who changes the regexp can also redefine the outline-level variable
375 (defun outline-level ()
376 "Return the depth to which a statement is nested in the outline.
377 Point must be at the beginning of a header line.
378 This is actually either the level specified in `outline-heading-alist'
379 or else the number of characters matched by `outline-regexp'."
380 (or (cdr (assoc (match-string 0) outline-heading-alist))
381 (- (match-end 0) (match-beginning 0))))
383 (defun outline-next-preface ()
384 "Skip forward to just before the next heading line.
385 If there's no following heading line, stop before the newline
386 at the end of the buffer."
387 (if (re-search-forward (concat "\n\\(?:" outline-regexp "\\)")
389 (goto-char (match-beginning 0)))
390 (if (and (bolp) (or outline-blank-line (eobp)) (not (bobp)))
393 (defun outline-next-heading ()
394 "Move to the next (possibly invisible) heading line."
396 ;; Make sure we don't match the heading we're at.
397 (if (and (bolp) (not (eobp))) (forward-char 1))
398 (if (re-search-forward (concat "^\\(?:" outline-regexp "\\)")
400 (goto-char (match-beginning 0))))
402 (defun outline-previous-heading ()
403 "Move to the previous (possibly invisible) heading line."
405 (re-search-backward (concat "^\\(?:" outline-regexp "\\)")
408 (defsubst outline-invisible-p (&optional pos)
409 "Non-nil if the character after point is invisible."
410 (get-char-property (or pos (point)) 'invisible))
412 (defun outline-visible ()
413 (not (outline-invisible-p)))
414 (make-obsolete 'outline-visible 'outline-invisible-p)
416 (defun outline-back-to-heading (&optional invisible-ok)
417 "Move to previous heading line, or beg of this line if it's a heading.
418 Only visible heading lines are considered, unless INVISIBLE-OK is non-nil."
420 (or (outline-on-heading-p invisible-ok)
424 (or (re-search-backward (concat "^\\(?:" outline-regexp "\\)")
426 (error "before first heading"))
427 (setq found (and (or invisible-ok (not (outline-invisible-p)))
432 (defun outline-on-heading-p (&optional invisible-ok)
433 "Return t if point is on a (visible) heading line.
434 If INVISIBLE-OK is non-nil, an invisible heading line is ok too."
437 (and (bolp) (or invisible-ok (not (outline-invisible-p)))
438 (looking-at outline-regexp))))
440 (defun outline-insert-heading ()
441 "Insert a new heading at same depth at point."
443 (let ((head (save-excursion
445 (outline-back-to-heading)
446 (error (outline-next-heading)))
448 (or (caar outline-heading-alist) "")
450 (unless (or (string-match "[ \t]\\'" head)
451 (not (string-match (concat "\\`\\(?:" outline-regexp "\\)")
453 (setq head (concat head " ")))
454 (unless (bolp) (end-of-line) (newline))
457 (save-excursion (newline-and-indent)))
458 (run-hooks 'outline-insert-heading-hook)))
460 (defun outline-invent-heading (head up)
462 ;; Let's try to invent one by repeating or deleting the last char.
463 (let ((new-head (if up (substring head 0 -1)
464 (concat head (substring head -1)))))
465 (if (string-match (concat "\\`\\(?:" outline-regexp "\\)")
467 ;; Why bother checking that it is indeed higher/lower level ?
469 ;; Didn't work, so ask what to do.
470 (read-string (format "%s heading for `%s': "
471 (if up "Parent" "Demoted") head)
474 (defun outline-promote (&optional children)
475 "Promote headings higher up the tree.
476 If prefix argument CHILDREN is given, promote also all the children.
477 If the region is active in `transient-mark-mode', promote all headings
480 (list (if (and transient-mark-mode mark-active) 'region
481 (outline-back-to-heading)
482 (if current-prefix-arg nil 'subtree))))
484 ((eq children 'region)
485 (outline-map-region 'outline-promote (region-beginning) (region-end)))
487 (outline-map-region 'outline-promote
489 (save-excursion (outline-get-next-sibling) (point))))
491 (outline-back-to-heading t)
492 (let* ((head (match-string-no-properties 0))
493 (level (save-match-data (funcall outline-level)))
494 (up-head (or (outline-head-from-level (1- level) head)
495 ;; Use the parent heading, if it is really
499 (outline-up-heading 1 t)
500 (and (= (1- level) (funcall outline-level))
501 (match-string-no-properties 0))))
502 ;; Bummer!! There is no lower level heading.
503 (outline-invent-heading head 'up))))
505 (unless (rassoc level outline-heading-alist)
506 (push (cons head level) outline-heading-alist))
508 (replace-match up-head nil t)))))
510 (defun outline-demote (&optional children)
511 "Demote headings lower down the tree.
512 If prefix argument CHILDREN is given, demote also all the children.
513 If the region is active in `transient-mark-mode', demote all headings
516 (list (if (and transient-mark-mode mark-active) 'region
517 (outline-back-to-heading)
518 (if current-prefix-arg nil 'subtree))))
520 ((eq children 'region)
521 (outline-map-region 'outline-demote (region-beginning) (region-end)))
523 (outline-map-region 'outline-demote
525 (save-excursion (outline-get-next-sibling) (point))))
527 (let* ((head (match-string-no-properties 0))
528 (level (save-match-data (funcall outline-level)))
530 (or (outline-head-from-level (1+ level) head)
533 (while (and (progn (outline-next-heading) (not (eobp)))
534 (<= (funcall outline-level) level)))
536 ;; Try again from the beginning of the buffer.
537 (goto-char (point-min))
538 (while (and (progn (outline-next-heading) (not (eobp)))
539 (<= (funcall outline-level) level))))
541 (looking-at outline-regexp)
542 (match-string-no-properties 0))))
543 ;; Bummer!! There is no higher-level heading in the buffer.
544 (outline-invent-heading head nil))))
546 (unless (rassoc level outline-heading-alist)
547 (push (cons head level) outline-heading-alist))
548 (replace-match down-head nil t)))))
550 (defun outline-head-from-level (level head &optional alist)
551 "Get new heading with level LEVEL from ALIST.
552 If there are no such entries, return nil.
553 ALIST defaults to `outline-heading-alist'.
554 Similar to (car (rassoc LEVEL ALIST)).
555 If there are several different entries with same new level, choose
556 the one with the smallest distance to the assocation of HEAD in the alist.
557 This makes it possible for promotion to work in modes with several
558 independent sets of headings (numbered, unnumbered, appendix...)"
559 (unless alist (setq alist outline-heading-alist))
560 (let ((l (rassoc level alist))
564 ;; If there's no HEAD after L, any other entry for LEVEL after L
565 ;; can't be much better than L.
566 ((null (setq h (assoc head (setq ll (memq l alist))))) (car l))
567 ;; If there's no other entry for LEVEL, just keep L.
568 ((null (setq l2 (rassoc level (cdr ll)))) (car l))
569 ;; Now we have L, L2, and H: see if L2 seems better than L.
570 ;; If H is after L2, L2 is better.
571 ((memq h (setq l2l (memq l2 (cdr ll))))
572 (outline-head-from-level level head l2l))
573 ;; Now we have H between L and L2.
574 ;; If there's a separator between L and H, prefer L2.
575 ((memq h (memq nil ll))
576 (outline-head-from-level level head l2l))
577 ;; If there's a separator between L2 and H, prefer L.
578 ((memq l2 (memq nil (setq hl (memq h ll)))) (car l))
579 ;; No separator between L and L2, check the distance.
580 ((< (* 2 (length hl)) (+ (length ll) (length l2l)))
581 (outline-head-from-level level head l2l))
582 ;; If all else fails, just keep L.
585 (defun outline-map-region (fun beg end)
586 "Call FUN for every heading between BEG and END.
587 When FUN is called, point is at the beginning of the heading and
588 the match data is set appropriately."
590 (setq end (copy-marker end))
592 (when (re-search-forward (concat "^\\(?:" outline-regexp "\\)") end t)
593 (goto-char (match-beginning 0))
596 (outline-next-heading)
601 ;; Vertical tree motion
603 (defun outline-move-subtree-up (&optional arg)
604 "Move the currrent subtree up past ARG headlines of the same level."
606 (outline-move-subtree-down (- arg)))
608 (defun outline-move-subtree-down (&optional arg)
609 "Move the currrent subtree down past ARG headlines of the same level."
611 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
612 'outline-get-last-sibling))
613 (ins-point (make-marker))
617 (outline-back-to-heading)
620 (save-excursion (outline-end-of-heading)
621 (setq folded (outline-invisible-p)))
622 (outline-end-of-subtree))
623 (if (= (char-after) ?\n) (forward-char 1))
625 ;; Find insertion point, with error handling
628 (or (funcall movfunc)
629 (progn (goto-char beg)
630 (error "Cannot move past superior level")))
633 ;; Moving forward - still need to move over subtree
634 (progn (outline-end-of-subtree)
635 (if (= (char-after) ?\n) (forward-char 1))))
636 (move-marker ins-point (point))
637 (insert (delete-and-extract-region beg end))
638 (goto-char ins-point)
639 (if folded (hide-subtree))
640 (move-marker ins-point nil)))
642 (defun outline-end-of-heading ()
643 (if (re-search-forward outline-heading-end-regexp nil 'move)
646 (defun outline-next-visible-heading (arg)
647 "Move to the next visible heading line.
648 With argument, repeats or can move backward if negative.
649 A heading line is one that starts with a `*' (or that
650 `outline-regexp' matches)."
655 (let (found-heading-p)
656 (while (and (not (bobp)) (< arg 0))
657 (while (and (not (bobp))
658 (setq found-heading-p
660 (concat "^\\(?:" outline-regexp "\\)")
662 (outline-invisible-p)))
664 (while (and (not (eobp)) (> arg 0))
665 (while (and (not (eobp))
666 (setq found-heading-p
668 (concat "^\\(?:" outline-regexp "\\)")
670 (outline-invisible-p (match-beginning 0))))
672 (if found-heading-p (beginning-of-line))))
674 (defun outline-previous-visible-heading (arg)
675 "Move to the previous heading line.
676 With argument, repeats or can move forward if negative.
677 A heading line is one that starts with a `*' (or that
678 `outline-regexp' matches)."
680 (outline-next-visible-heading (- arg)))
682 (defun outline-mark-subtree ()
683 "Mark the current subtree in an outlined document.
684 This puts point at the start of the current subtree, and mark at the end."
687 (if (outline-on-heading-p)
688 ;; we are already looking at a heading
690 ;; else go back to previous heading
691 (outline-previous-visible-heading 1))
693 (outline-end-of-subtree)
694 (push-mark (point) nil t)
698 (defvar outline-isearch-open-invisible-function nil
699 "Function called if `isearch' finishes in an invisible overlay.
700 The function is called with the overlay as its only argument.
701 If nil, `show-entry' is called to reveal the invisible text.")
703 (put 'outline 'reveal-toggle-invisible 'outline-reveal-toggle-invisible)
704 (defun outline-flag-region (from to flag)
705 "Hide or show lines from FROM to TO, according to FLAG.
706 If FLAG is nil then text is shown, while if FLAG is t the text is hidden."
707 (remove-overlays from to 'invisible 'outline)
709 (let ((o (make-overlay from to)))
710 (overlay-put o 'invisible 'outline)
711 (overlay-put o 'isearch-open-invisible
712 (or outline-isearch-open-invisible-function
713 'outline-isearch-open-invisible))))
714 ;; Seems only used by lazy-lock. I.e. obsolete.
715 (run-hooks 'outline-view-change-hook))
717 (defun outline-reveal-toggle-invisible (o hidep)
719 (goto-char (overlay-start o))
721 ;; When hiding the area again, we could just clean it up and let
722 ;; reveal do the rest, by simply doing:
723 ;; (remove-overlays (overlay-start o) (overlay-end o)
724 ;; 'invisible 'outline)
726 ;; That works fine as long as everything is in sync, but if the
727 ;; structure of the document is changed while revealing parts of it,
728 ;; the resulting behavior can be ugly. I.e. we need to make
729 ;; sure that we hide exactly a subtree.
731 (let ((end (overlay-end o)))
735 (outline-next-visible-heading 1)
736 (and (not (eobp)) (< (point) end))))))
738 ;; When revealing, we just need to reveal sublevels. If point is
739 ;; inside one of the sublevels, reveal will call us again.
740 ;; But we need to preserve the original overlay.
741 (let ((o1 (copy-overlay o)))
742 (overlay-put o 'invisible nil) ;Show (most of) the text.
746 ;; Normally just the above is needed.
747 ;; But in odd cases, the above might fail to show anything.
748 ;; To avoid an infinite loop, we have to make sure that
749 ;; *something* gets shown.
750 (and (equal (overlay-start o) (overlay-start o1))
751 (< (point) (overlay-end o))
752 (= 0 (forward-line 1)))))
753 ;; If still nothing was shown, just kill the damn thing.
754 (when (equal (overlay-start o) (overlay-start o1))
755 ;; I've seen it happen at the end of buffer.
756 (delete-overlay o1))))))
758 ;; Function to be set as an outline-isearch-open-invisible' property
759 ;; to the overlay that makes the outline invisible (see
760 ;; `outline-flag-region').
761 (defun outline-isearch-open-invisible (overlay)
762 ;; We rely on the fact that isearch places point on the matched text.
766 "Hide the body directly following this heading."
769 (outline-back-to-heading)
770 (outline-end-of-heading)
771 (outline-flag-region (point) (progn (outline-next-preface) (point)) t)))
774 "Show the body directly following this heading.
775 Show the heading too, if it is currently invisible."
778 (outline-back-to-heading t)
779 (outline-flag-region (1- (point))
780 (progn (outline-next-preface) (point)) nil)))
783 "Hide all body lines in buffer, leaving all headings visible."
785 (hide-region-body (point-min) (point-max)))
787 (defun hide-region-body (start end)
788 "Hide all body lines in the region, but not headings."
789 ;; Nullify the hook to avoid repeated calls to `outline-flag-region'
790 ;; wasting lots of time running `lazy-lock-fontify-after-outline'
791 ;; and run the hook finally.
792 (let (outline-view-change-hook)
795 (narrow-to-region start end)
796 (goto-char (point-min))
797 (if (outline-on-heading-p)
798 (outline-end-of-heading)
799 (outline-next-preface))
801 (outline-flag-region (point)
802 (progn (outline-next-preface) (point)) t)
804 (forward-char (if (looking-at "\n\n") 2 1))
805 (outline-end-of-heading))))))
806 (run-hooks 'outline-view-change-hook))
809 "Show all of the text in the buffer."
811 (outline-flag-region (point-min) (point-max) nil))
813 (defun hide-subtree ()
814 "Hide everything after this heading at deeper levels."
816 (outline-flag-subtree t))
818 (defun hide-leaves ()
819 "Hide the body after this heading and at deeper levels."
822 (outline-back-to-heading)
823 ;; Turned off to fix bug reported by Otto Maddox on 22 Nov 2005.
824 ;; (outline-end-of-heading)
825 (hide-region-body (point) (progn (outline-end-of-subtree) (point)))))
827 (defun show-subtree ()
828 "Show everything after this heading at deeper levels."
830 (outline-flag-subtree nil))
832 (defun outline-show-heading ()
833 "Show the current heading and move to its end."
834 (outline-flag-region (- (point)
836 (if (and outline-blank-line
837 (eq (char-before (1- (point))) ?\n))
839 (progn (outline-end-of-heading) (point))
842 (defun hide-sublevels (levels)
843 "Hide everything but the top LEVELS levels of headers, in whole buffer."
846 (current-prefix-arg (prefix-numeric-value current-prefix-arg))
847 ((save-excursion (beginning-of-line)
848 (looking-at outline-regexp))
849 (funcall outline-level))
852 (error "Must keep at least one level of headers"))
853 (let (outline-view-change-hook)
855 (goto-char (point-min))
856 ;; Skip the prelude, if any.
857 (unless (outline-on-heading-p t) (outline-next-heading))
858 ;; First hide everything.
859 (outline-flag-region (point) (point-max) t)
860 ;; Then unhide the top level headers.
863 (if (<= (funcall outline-level) levels)
864 (outline-show-heading)))
865 (point) (point-max))))
866 (run-hooks 'outline-view-change-hook))
869 "Hide everything except current body and parent and top-level headings."
872 (let (outline-view-change-hook)
874 (outline-back-to-heading t)
876 (while (condition-case nil (progn (outline-up-heading 1 t) (not (bobp)))
878 (outline-flag-region (1- (point))
879 (save-excursion (forward-line 1) (point))
881 (run-hooks 'outline-view-change-hook))
883 (defun outline-toggle-children ()
884 "Show or hide the current subtree depending on its current state."
887 (outline-back-to-heading)
888 (if (not (outline-invisible-p (line-end-position)))
893 (defun outline-flag-subtree (flag)
895 (outline-back-to-heading)
896 (outline-end-of-heading)
897 (outline-flag-region (point)
898 (progn (outline-end-of-subtree) (point))
901 (defun outline-end-of-subtree ()
902 (outline-back-to-heading)
904 (level (funcall outline-level)))
905 (while (and (not (eobp))
906 (or first (> (funcall outline-level) level)))
908 (outline-next-heading))
909 (if (and (bolp) (not (eolp)))
910 ;; We stopped at a nonempty line (the next heading).
912 ;; Go to end of line before heading
914 (if (and outline-blank-line (bolp))
915 ;; leave blank line before heading
916 (forward-char -1))))))
918 (defun show-branches ()
919 "Show all subheadings of this heading, but not their bodies."
921 (show-children 1000))
923 (defun show-children (&optional level)
924 "Show all direct subheadings of this heading.
925 Prefix arg LEVEL is how many levels below the current level should be shown.
926 Default is enough to cause the following heading to appear."
929 (if level (prefix-numeric-value level)
931 (outline-back-to-heading)
932 (let ((start-level (funcall outline-level)))
933 (outline-next-heading)
936 (max 1 (- (funcall outline-level) start-level)))))))
937 (let (outline-view-change-hook)
939 (outline-back-to-heading)
940 (setq level (+ level (funcall outline-level)))
943 (if (<= (funcall outline-level) level)
944 (outline-show-heading)))
946 (progn (outline-end-of-subtree)
947 (if (eobp) (point-max) (1+ (point)))))))
948 (run-hooks 'outline-view-change-hook))
952 (defun outline-up-heading (arg &optional invisible-ok)
953 "Move to the visible heading line of which the present line is a subheading.
954 With argument, move up ARG levels.
955 If INVISIBLE-OK is non-nil, also consider invisible lines."
957 (and (eq this-command 'outline-up-heading)
958 (or (eq last-command 'outline-up-heading) (push-mark)))
959 (outline-back-to-heading invisible-ok)
960 (let ((start-level (funcall outline-level)))
961 (if (eq start-level 1)
962 (error "Already at top level of the outline"))
963 (while (and (> start-level 1) (> arg 0) (not (bobp)))
964 (let ((level start-level))
965 (while (not (or (< level start-level) (bobp)))
967 (outline-previous-heading)
968 (outline-previous-visible-heading 1))
969 (setq level (funcall outline-level)))
970 (setq start-level level))
971 (setq arg (- arg 1))))
972 (looking-at outline-regexp))
974 (defun outline-forward-same-level (arg)
975 "Move forward to the ARG'th subheading at same level as this one.
976 Stop at the first and last subheadings of a superior heading."
978 (outline-back-to-heading)
980 (let ((point-to-move-to (save-excursion
981 (outline-get-next-sibling))))
984 (goto-char point-to-move-to)
988 (error "No following same-level heading"))))))
990 (defun outline-get-next-sibling ()
991 "Move to next heading of the same level, and return point or nil if none."
992 (let ((level (funcall outline-level)))
993 (outline-next-visible-heading 1)
994 (while (and (not (eobp)) (> (funcall outline-level) level))
995 (outline-next-visible-heading 1))
996 (if (or (eobp) (< (funcall outline-level) level))
1000 (defun outline-backward-same-level (arg)
1001 "Move backward to the ARG'th subheading at same level as this one.
1002 Stop at the first and last subheadings of a superior heading."
1004 (outline-back-to-heading)
1006 (let ((point-to-move-to (save-excursion
1007 (outline-get-last-sibling))))
1008 (if point-to-move-to
1010 (goto-char point-to-move-to)
1011 (setq arg (1- arg)))
1014 (error "No previous same-level heading"))))))
1016 (defun outline-get-last-sibling ()
1017 "Move to previous heading of the same level, and return point or nil if none."
1018 (let ((level (funcall outline-level)))
1019 (outline-previous-visible-heading 1)
1020 (while (and (> (funcall outline-level) level)
1022 (outline-previous-visible-heading 1))
1023 (if (< (funcall outline-level) level)
1027 (defun outline-headers-as-kill (beg end)
1028 "Save the visible outline headers in region at the start of the kill ring.
1030 Text shown between the headers isn't copied. Two newlines are
1031 inserted between saved headers. Yanking the result may be a
1032 convenient way to make a table of contents of the buffer."
1036 (narrow-to-region beg end)
1037 (goto-char (point-min))
1038 (let ((buffer (current-buffer))
1041 (with-current-buffer buffer
1042 ;; Boundary condition: starting on heading:
1043 (when (outline-on-heading-p)
1044 (outline-back-to-heading)
1046 end (progn (outline-end-of-heading)
1048 (insert-buffer-substring buffer start end)
1050 (let ((temp-buffer (current-buffer)))
1051 (with-current-buffer buffer
1052 (while (outline-next-heading)
1053 (unless (outline-invisible-p)
1055 end (progn (outline-end-of-heading) (point)))
1056 (with-current-buffer temp-buffer
1057 (insert-buffer-substring buffer start end)
1058 (insert "\n\n"))))))
1059 (kill-new (buffer-string)))))))
1064 ;; arch-tag: 1724410e-7d4d-4f46-b801-49e18171e874
1065 ;;; outline.el ends here