Close bug#5755.
[emacs.git] / lisp / outline.el
blobed7d5f33a35c8311217bbd7b5c6f95e86dbc4374
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, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: outlines
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 3 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This package is a major mode for editing outline-format documents.
27 ;; An outline can be `abstracted' to show headers at any given level,
28 ;; with all stuff below hidden. See the Emacs manual for details.
30 ;;; Todo:
32 ;; - subtree-terminators
33 ;; - better handle comments before function bodies (i.e. heading)
34 ;; - don't bother hiding whitespace
36 ;;; Code:
38 (defvar font-lock-warning-face)
41 (defgroup outlines nil
42 "Support for hierarchical outlining."
43 :prefix "outline-"
44 :group 'wp)
46 (defcustom outline-regexp "[*\^L]+"
47 "Regular expression to match the beginning of a heading.
48 Any line whose beginning matches this regexp is considered to start a heading.
49 Note that Outline mode only checks this regexp at the start of a line,
50 so the regexp need not (and usually does not) start with `^'.
51 The recommended way to set this is with a Local Variables: list
52 in the file it applies to. See also `outline-heading-end-regexp'."
53 :type '(choice regexp (const nil))
54 :group 'outlines)
55 ;;;###autoload(put 'outline-regexp 'safe-local-variable 'string-or-null-p)
57 (defcustom outline-heading-end-regexp "\n"
58 "Regular expression to match the end of a heading line.
59 You can assume that point is at the beginning of a heading when this
60 regexp is searched for. The heading ends at the end of the match.
61 The recommended way to set this is with a `Local Variables:' list
62 in the file it applies to."
63 :type 'regexp
64 :group 'outlines)
66 (defvar outline-mode-prefix-map
67 (let ((map (make-sparse-keymap)))
68 (define-key map "@" 'outline-mark-subtree)
69 (define-key map "\C-n" 'outline-next-visible-heading)
70 (define-key map "\C-p" 'outline-previous-visible-heading)
71 (define-key map "\C-i" 'show-children)
72 (define-key map "\C-s" 'show-subtree)
73 (define-key map "\C-d" 'hide-subtree)
74 (define-key map "\C-u" 'outline-up-heading)
75 (define-key map "\C-f" 'outline-forward-same-level)
76 (define-key map "\C-b" 'outline-backward-same-level)
77 (define-key map "\C-t" 'hide-body)
78 (define-key map "\C-a" 'show-all)
79 (define-key map "\C-c" 'hide-entry)
80 (define-key map "\C-e" 'show-entry)
81 (define-key map "\C-l" 'hide-leaves)
82 (define-key map "\C-k" 'show-branches)
83 (define-key map "\C-q" 'hide-sublevels)
84 (define-key map "\C-o" 'hide-other)
85 (define-key map "\C-^" 'outline-move-subtree-up)
86 (define-key map "\C-v" 'outline-move-subtree-down)
87 (define-key map [(control ?<)] 'outline-promote)
88 (define-key map [(control ?>)] 'outline-demote)
89 (define-key map "\C-m" 'outline-insert-heading)
90 ;; Where to bind outline-cycle ?
91 map))
93 (defvar outline-mode-menu-bar-map
94 (let ((map (make-sparse-keymap)))
96 (define-key map [hide] (cons "Hide" (make-sparse-keymap "Hide")))
98 (define-key map [hide hide-other]
99 '(menu-item "Hide Other" hide-other
100 :help "Hide everything except current body and parent and top-level headings"))
101 (define-key map [hide hide-sublevels]
102 '(menu-item "Hide Sublevels" hide-sublevels
103 :help "Hide everything but the top LEVELS levels of headers, in whole buffer"))
104 (define-key map [hide hide-subtree]
105 '(menu-item "Hide Subtree" hide-subtree
106 :help "Hide everything after this heading at deeper levels"))
107 (define-key map [hide hide-entry]
108 '(menu-item "Hide Entry" hide-entry
109 :help "Hide the body directly following this heading"))
110 (define-key map [hide hide-body]
111 '(menu-item "Hide Body" hide-body
112 :help "Hide all body lines in buffer, leaving all headings visible"))
113 (define-key map [hide hide-leaves]
114 '(menu-item "Hide Leaves" hide-leaves
115 :help "Hide the body after this heading and at deeper levels"))
117 (define-key map [show] (cons "Show" (make-sparse-keymap "Show")))
119 (define-key map [show show-subtree]
120 '(menu-item "Show Subtree" show-subtree
121 :help "Show everything after this heading at deeper levels"))
122 (define-key map [show show-children]
123 '(menu-item "Show Children" show-children
124 :help "Show all direct subheadings of this heading"))
125 (define-key map [show show-branches]
126 '(menu-item "Show Branches" show-branches
127 :help "Show all subheadings of this heading, but not their bodies"))
128 (define-key map [show show-entry]
129 '(menu-item "Show Entry" show-entry
130 :help "Show the body directly following this heading"))
131 (define-key map [show show-all]
132 '(menu-item "Show All" show-all
133 :help "Show all of the text in the buffer"))
135 (define-key map [headings]
136 (cons "Headings" (make-sparse-keymap "Headings")))
138 (define-key map [headings demote-subtree]
139 '(menu-item "Demote subtree" outline-demote
140 :help "Demote headings lower down the tree"))
141 (define-key map [headings promote-subtree]
142 '(menu-item "Promote subtree" outline-promote
143 :help "Promote headings higher up the tree"))
144 (define-key map [headings move-subtree-down]
145 '(menu-item "Move subtree down" outline-move-subtree-down
146 :help "Move the currrent subtree down past arg headlines of the same level"))
147 (define-key map [headings move-subtree-up]
148 '(menu-item "Move subtree up" outline-move-subtree-up
149 :help "Move the currrent subtree up past arg headlines of the same level"))
150 (define-key map [headings copy]
151 '(menu-item "Copy to kill ring" outline-headers-as-kill
152 :enable mark-active
153 :help "Save the visible outline headers in region at the start of the kill ring"))
154 (define-key map [headings outline-insert-heading]
156 '(menu-item "New heading" outline-insert-heading
157 :help "Insert a new heading at same depth at point"))
158 (define-key map [headings outline-backward-same-level]
160 '(menu-item "Previous Same Level" outline-backward-same-level
161 :help "Move backward to the arg'th subheading at same level as this one."))
162 (define-key map [headings outline-forward-same-level]
164 '(menu-item "Next Same Level" outline-forward-same-level
165 :help "Move forward to the arg'th subheading at same level as this one"))
166 (define-key map [headings outline-previous-visible-heading]
168 '(menu-item "Previous" outline-previous-visible-heading
169 :help "Move to the previous heading line"))
170 (define-key map [headings outline-next-visible-heading]
172 '(menu-item "Next" outline-next-visible-heading
173 :help "Move to the next visible heading line"))
174 (define-key map [headings outline-up-heading]
176 '(menu-item "Up" outline-up-heading
177 :help "Move to the visible heading line of which the present line is a subheading"))
178 map))
180 (defvar outline-minor-mode-menu-bar-map
181 (let ((map (make-sparse-keymap)))
182 (define-key map [outline]
183 (cons "Outline"
184 (nconc (make-sparse-keymap "Outline")
185 ;; Remove extra separator
186 (cdr
187 ;; Flatten the major mode's menus into a single menu.
188 (apply 'append
189 (mapcar (lambda (x)
190 (if (consp x)
191 ;; Add a separator between each
192 ;; part of the unified menu.
193 (cons '(--- "---") (cdr x))))
194 outline-mode-menu-bar-map))))))
195 map))
198 (defvar outline-mode-map
199 (let ((map (make-sparse-keymap)))
200 (define-key map "\C-c" outline-mode-prefix-map)
201 (define-key map [menu-bar] outline-mode-menu-bar-map)
202 map))
204 (defvar outline-font-lock-keywords
205 '(;;
206 ;; Highlight headings according to the level.
207 (eval . (list (concat "^\\(?:" outline-regexp "\\).+")
208 0 '(outline-font-lock-face) nil t)))
209 "Additional expressions to highlight in Outline mode.")
211 (defface outline-1
212 '((t :inherit font-lock-function-name-face))
213 "Level 1."
214 :group 'outlines)
216 (defface outline-2
217 '((t :inherit font-lock-variable-name-face))
218 "Level 2."
219 :group 'outlines)
221 (defface outline-3
222 '((t :inherit font-lock-keyword-face))
223 "Level 3."
224 :group 'outlines)
226 (defface outline-4
227 '((t :inherit font-lock-comment-face))
228 "Level 4."
229 :group 'outlines)
231 (defface outline-5
232 '((t :inherit font-lock-type-face))
233 "Level 5."
234 :group 'outlines)
236 (defface outline-6
237 '((t :inherit font-lock-constant-face))
238 "Level 6."
239 :group 'outlines)
241 (defface outline-7
242 '((t :inherit font-lock-builtin-face))
243 "Level 7."
244 :group 'outlines)
246 (defface outline-8
247 '((t :inherit font-lock-string-face))
248 "Level 8."
249 :group 'outlines)
251 (defvar outline-font-lock-faces
252 [outline-1 outline-2 outline-3 outline-4
253 outline-5 outline-6 outline-7 outline-8])
255 ;; (defvar outline-font-lock-levels nil)
256 ;; (make-variable-buffer-local 'outline-font-lock-levels)
258 (defun outline-font-lock-face ()
259 ;; (save-excursion
260 ;; (outline-back-to-heading t)
261 ;; (let* ((count 0)
262 ;; (start-level (funcall outline-level))
263 ;; (level start-level)
264 ;; face-level)
265 ;; (while (not (setq face-level
266 ;; (if (or (bobp) (eq level 1)) 0
267 ;; (cdr (assq level outline-font-lock-levels)))))
268 ;; (outline-up-heading 1 t)
269 ;; (setq count (1+ count))
270 ;; (setq level (funcall outline-level)))
271 ;; ;; Remember for later.
272 ;; (unless (zerop count)
273 ;; (setq face-level (+ face-level count))
274 ;; (push (cons start-level face-level) outline-font-lock-levels))
275 ;; (condition-case nil
276 ;; (aref outline-font-lock-faces face-level)
277 ;; (error font-lock-warning-face))))
278 (save-excursion
279 (goto-char (match-beginning 0))
280 (looking-at outline-regexp)
281 (aref outline-font-lock-faces (% (1- (funcall outline-level)) (length outline-font-lock-faces)))))
283 (defvar outline-view-change-hook nil
284 "Normal hook to be run after outline visibility changes.")
286 (defvar outline-mode-hook nil
287 "*This hook is run when outline mode starts.")
289 (defvar outline-blank-line nil
290 "*Non-nil means to leave unhidden blank line before heading.")
292 ;;;###autoload
293 (define-derived-mode outline-mode text-mode "Outline"
294 "Set major mode for editing outlines with selective display.
295 Headings are lines which start with asterisks: one for major headings,
296 two for subheadings, etc. Lines not starting with asterisks are body lines.
298 Body text or subheadings under a heading can be made temporarily
299 invisible, or visible again. Invisible lines are attached to the end
300 of the heading, so they move with it, if the line is killed and yanked
301 back. A heading with text hidden under it is marked with an ellipsis (...).
303 Commands:\\<outline-mode-map>
304 \\[outline-next-visible-heading] outline-next-visible-heading move by visible headings
305 \\[outline-previous-visible-heading] outline-previous-visible-heading
306 \\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings
307 \\[outline-backward-same-level] outline-backward-same-level
308 \\[outline-up-heading] outline-up-heading move from subheading to heading
310 \\[hide-body] make all text invisible (not headings).
311 \\[show-all] make everything in buffer visible.
312 \\[hide-sublevels] make only the first N levels of headers visible.
314 The remaining commands are used when point is on a heading line.
315 They apply to some of the body or subheadings of that heading.
316 \\[hide-subtree] hide-subtree make body and subheadings invisible.
317 \\[show-subtree] show-subtree make body and subheadings visible.
318 \\[show-children] show-children make direct subheadings visible.
319 No effect on body, or subheadings 2 or more levels down.
320 With arg N, affects subheadings N levels down.
321 \\[hide-entry] make immediately following body invisible.
322 \\[show-entry] make it visible.
323 \\[hide-leaves] make body under heading and under its subheadings invisible.
324 The subheadings remain visible.
325 \\[show-branches] make all subheadings at all levels visible.
327 The variable `outline-regexp' can be changed to control what is a heading.
328 A line is a heading if `outline-regexp' matches something at the
329 beginning of the line. The longer the match, the deeper the level.
331 Turning on outline mode calls the value of `text-mode-hook' and then of
332 `outline-mode-hook', if they are non-nil."
333 (make-local-variable 'line-move-ignore-invisible)
334 (setq line-move-ignore-invisible t)
335 ;; Cause use of ellipses for invisible text.
336 (add-to-invisibility-spec '(outline . t))
337 (set (make-local-variable 'paragraph-start)
338 (concat paragraph-start "\\|\\(?:" outline-regexp "\\)"))
339 ;; Inhibit auto-filling of header lines.
340 (set (make-local-variable 'auto-fill-inhibit-regexp) outline-regexp)
341 (set (make-local-variable 'paragraph-separate)
342 (concat paragraph-separate "\\|\\(?:" outline-regexp "\\)"))
343 (set (make-local-variable 'font-lock-defaults)
344 '(outline-font-lock-keywords t nil nil backward-paragraph))
345 (setq imenu-generic-expression
346 (list (list nil (concat "^\\(?:" outline-regexp "\\).*$") 0)))
347 (add-hook 'change-major-mode-hook 'show-all nil t))
349 (defcustom outline-minor-mode-prefix "\C-c@"
350 "Prefix key to use for Outline commands in Outline minor mode.
351 The value of this variable is checked as part of loading Outline mode.
352 After that, changing the prefix key requires manipulating keymaps."
353 :type 'string
354 :group 'outlines)
356 ;;;###autoload
357 (define-minor-mode outline-minor-mode
358 "Toggle Outline minor mode.
359 With arg, turn Outline minor mode on if arg is positive, off otherwise.
360 See the command `outline-mode' for more information on this mode."
361 nil " Outl" (list (cons [menu-bar] outline-minor-mode-menu-bar-map)
362 (cons outline-minor-mode-prefix outline-mode-prefix-map))
363 :group 'outlines
364 (if outline-minor-mode
365 (progn
366 ;; Turn off this mode if we change major modes.
367 (add-hook 'change-major-mode-hook
368 (lambda () (outline-minor-mode -1))
369 nil t)
370 (set (make-local-variable 'line-move-ignore-invisible) t)
371 ;; Cause use of ellipses for invisible text.
372 (add-to-invisibility-spec '(outline . t)))
373 (setq line-move-ignore-invisible nil)
374 ;; Cause use of ellipses for invisible text.
375 (remove-from-invisibility-spec '(outline . t))
376 ;; When turning off outline mode, get rid of any outline hiding.
377 (show-all)))
379 (defvar outline-level 'outline-level
380 "*Function of no args to compute a header's nesting level in an outline.
381 It can assume point is at the beginning of a header line and that the match
382 data reflects the `outline-regexp'.")
383 ;;;###autoload(put 'outline-level 'risky-local-variable t)
385 (defvar outline-heading-alist ()
386 "Alist associating a heading for every possible level.
387 Each entry is of the form (HEADING . LEVEL).
388 This alist is used two ways: to find the heading corresponding to
389 a given level and to find the level of a given heading.
390 If a mode or document needs several sets of outline headings (for example
391 numbered and unnumbered sections), list them set by set and sorted by level
392 within each set. For example in texinfo mode:
394 (setq outline-heading-alist
395 '((\"@chapter\" . 2) (\"@section\" . 3) (\"@subsection\" . 4)
396 (\"@subsubsection\" . 5)
397 (\"@unnumbered\" . 2) (\"@unnumberedsec\" . 3)
398 (\"@unnumberedsubsec\" . 4) (\"@unnumberedsubsubsec\" . 5)
399 (\"@appendix\" . 2) (\"@appendixsec\" . 3)...
400 (\"@appendixsubsec\" . 4) (\"@appendixsubsubsec\" . 5) ..))
402 Instead of sorting the entries in each set, you can also separate the
403 sets with nil.")
404 (make-variable-buffer-local 'outline-heading-alist)
406 ;; This used to count columns rather than characters, but that made ^L
407 ;; appear to be at level 2 instead of 1. Columns would be better for
408 ;; tab handling, but the default regexp doesn't use tabs, and anyone
409 ;; who changes the regexp can also redefine the outline-level variable
410 ;; as appropriate.
411 (defun outline-level ()
412 "Return the depth to which a statement is nested in the outline.
413 Point must be at the beginning of a header line.
414 This is actually either the level specified in `outline-heading-alist'
415 or else the number of characters matched by `outline-regexp'."
416 (or (cdr (assoc (match-string 0) outline-heading-alist))
417 (- (match-end 0) (match-beginning 0))))
419 (defun outline-next-preface ()
420 "Skip forward to just before the next heading line.
421 If there's no following heading line, stop before the newline
422 at the end of the buffer."
423 (if (re-search-forward (concat "\n\\(?:" outline-regexp "\\)")
424 nil 'move)
425 (goto-char (match-beginning 0)))
426 (if (and (bolp) (or outline-blank-line (eobp)) (not (bobp)))
427 (forward-char -1)))
429 (defun outline-next-heading ()
430 "Move to the next (possibly invisible) heading line."
431 (interactive)
432 ;; Make sure we don't match the heading we're at.
433 (if (and (bolp) (not (eobp))) (forward-char 1))
434 (if (re-search-forward (concat "^\\(?:" outline-regexp "\\)")
435 nil 'move)
436 (goto-char (match-beginning 0))))
438 (defun outline-previous-heading ()
439 "Move to the previous (possibly invisible) heading line."
440 (interactive)
441 (re-search-backward (concat "^\\(?:" outline-regexp "\\)")
442 nil 'move))
444 (defsubst outline-invisible-p (&optional pos)
445 "Non-nil if the character after point is invisible."
446 (get-char-property (or pos (point)) 'invisible))
448 (defun outline-visible ()
449 (not (outline-invisible-p)))
450 (make-obsolete 'outline-visible 'outline-invisible-p "21.1")
452 (defun outline-back-to-heading (&optional invisible-ok)
453 "Move to previous heading line, or beg of this line if it's a heading.
454 Only visible heading lines are considered, unless INVISIBLE-OK is non-nil."
455 (beginning-of-line)
456 (or (outline-on-heading-p invisible-ok)
457 (let (found)
458 (save-excursion
459 (while (not found)
460 (or (re-search-backward (concat "^\\(?:" outline-regexp "\\)")
461 nil t)
462 (error "before first heading"))
463 (setq found (and (or invisible-ok (not (outline-invisible-p)))
464 (point)))))
465 (goto-char found)
466 found)))
468 (defun outline-on-heading-p (&optional invisible-ok)
469 "Return t if point is on a (visible) heading line.
470 If INVISIBLE-OK is non-nil, an invisible heading line is ok too."
471 (save-excursion
472 (beginning-of-line)
473 (and (bolp) (or invisible-ok (not (outline-invisible-p)))
474 (looking-at outline-regexp))))
476 (defun outline-insert-heading ()
477 "Insert a new heading at same depth at point."
478 (interactive)
479 (let ((head (save-excursion
480 (condition-case nil
481 (outline-back-to-heading)
482 (error (outline-next-heading)))
483 (if (eobp)
484 (or (caar outline-heading-alist) "")
485 (match-string 0)))))
486 (unless (or (string-match "[ \t]\\'" head)
487 (not (string-match (concat "\\`\\(?:" outline-regexp "\\)")
488 (concat head " "))))
489 (setq head (concat head " ")))
490 (unless (bolp) (end-of-line) (newline))
491 (insert head)
492 (unless (eolp)
493 (save-excursion (newline-and-indent)))
494 (run-hooks 'outline-insert-heading-hook)))
496 (defun outline-invent-heading (head up)
497 (save-match-data
498 ;; Let's try to invent one by repeating or deleting the last char.
499 (let ((new-head (if up (substring head 0 -1)
500 (concat head (substring head -1)))))
501 (if (string-match (concat "\\`\\(?:" outline-regexp "\\)")
502 new-head)
503 ;; Why bother checking that it is indeed higher/lower level ?
504 new-head
505 ;; Didn't work, so ask what to do.
506 (read-string (format "%s heading for `%s': "
507 (if up "Parent" "Demoted") head)
508 head nil nil t)))))
510 (defun outline-promote (&optional which)
511 "Promote headings higher up the tree.
512 If transient-mark-mode is on, and mark is active, promote headings in
513 the region (from a Lisp program, pass `region' for WHICH). Otherwise:
514 without prefix argument, promote current heading and all headings in the
515 subtree (from a Lisp program, pass `subtree' for WHICH); with prefix
516 argument, promote just the current heading (from a Lisp program, pass
517 nil for WHICH, or do not pass any argument)."
518 (interactive
519 (list (if (and transient-mark-mode mark-active) 'region
520 (outline-back-to-heading)
521 (if current-prefix-arg nil 'subtree))))
522 (cond
523 ((eq which 'region)
524 (outline-map-region 'outline-promote (region-beginning) (region-end)))
525 (which
526 (outline-map-region 'outline-promote
527 (point)
528 (save-excursion (outline-get-next-sibling) (point))))
530 (outline-back-to-heading t)
531 (let* ((head (match-string-no-properties 0))
532 (level (save-match-data (funcall outline-level)))
533 (up-head (or (outline-head-from-level (1- level) head)
534 ;; Use the parent heading, if it is really
535 ;; one level less.
536 (save-excursion
537 (save-match-data
538 (outline-up-heading 1 t)
539 (and (= (1- level) (funcall outline-level))
540 (match-string-no-properties 0))))
541 ;; Bummer!! There is no lower level heading.
542 (outline-invent-heading head 'up))))
544 (unless (rassoc level outline-heading-alist)
545 (push (cons head level) outline-heading-alist))
547 (replace-match up-head nil t)))))
549 (defun outline-demote (&optional which)
550 "Demote headings lower down the tree.
551 If transient-mark-mode is on, and mark is active, demote headings in
552 the region (from a Lisp program, pass `region' for WHICH). Otherwise:
553 without prefix argument, demote current heading and all headings in the
554 subtree (from a Lisp program, pass `subtree' for WHICH); with prefix
555 argument, demote just the current heading (from a Lisp program, pass
556 nil for WHICH, or do not pass any argument)."
557 (interactive
558 (list (if (and transient-mark-mode mark-active) 'region
559 (outline-back-to-heading)
560 (if current-prefix-arg nil 'subtree))))
561 (cond
562 ((eq which 'region)
563 (outline-map-region 'outline-demote (region-beginning) (region-end)))
564 (which
565 (outline-map-region 'outline-demote
566 (point)
567 (save-excursion (outline-get-next-sibling) (point))))
569 (let* ((head (match-string-no-properties 0))
570 (level (save-match-data (funcall outline-level)))
571 (down-head
572 (or (outline-head-from-level (1+ level) head)
573 (save-excursion
574 (save-match-data
575 (while (and (progn (outline-next-heading) (not (eobp)))
576 (<= (funcall outline-level) level)))
577 (when (eobp)
578 ;; Try again from the beginning of the buffer.
579 (goto-char (point-min))
580 (while (and (progn (outline-next-heading) (not (eobp)))
581 (<= (funcall outline-level) level))))
582 (unless (eobp)
583 (looking-at outline-regexp)
584 (match-string-no-properties 0))))
585 ;; Bummer!! There is no higher-level heading in the buffer.
586 (outline-invent-heading head nil))))
588 (unless (rassoc level outline-heading-alist)
589 (push (cons head level) outline-heading-alist))
590 (replace-match down-head nil t)))))
592 (defun outline-head-from-level (level head &optional alist)
593 "Get new heading with level LEVEL from ALIST.
594 If there are no such entries, return nil.
595 ALIST defaults to `outline-heading-alist'.
596 Similar to (car (rassoc LEVEL ALIST)).
597 If there are several different entries with same new level, choose
598 the one with the smallest distance to the association of HEAD in the alist.
599 This makes it possible for promotion to work in modes with several
600 independent sets of headings (numbered, unnumbered, appendix...)"
601 (unless alist (setq alist outline-heading-alist))
602 (let ((l (rassoc level alist))
603 ll h hl l2 l2l)
604 (cond
605 ((null l) nil)
606 ;; If there's no HEAD after L, any other entry for LEVEL after L
607 ;; can't be much better than L.
608 ((null (setq h (assoc head (setq ll (memq l alist))))) (car l))
609 ;; If there's no other entry for LEVEL, just keep L.
610 ((null (setq l2 (rassoc level (cdr ll)))) (car l))
611 ;; Now we have L, L2, and H: see if L2 seems better than L.
612 ;; If H is after L2, L2 is better.
613 ((memq h (setq l2l (memq l2 (cdr ll))))
614 (outline-head-from-level level head l2l))
615 ;; Now we have H between L and L2.
616 ;; If there's a separator between L and H, prefer L2.
617 ((memq h (memq nil ll))
618 (outline-head-from-level level head l2l))
619 ;; If there's a separator between L2 and H, prefer L.
620 ((memq l2 (memq nil (setq hl (memq h ll)))) (car l))
621 ;; No separator between L and L2, check the distance.
622 ((< (* 2 (length hl)) (+ (length ll) (length l2l)))
623 (outline-head-from-level level head l2l))
624 ;; If all else fails, just keep L.
625 (t (car l)))))
627 (defun outline-map-region (fun beg end)
628 "Call FUN for every heading between BEG and END.
629 When FUN is called, point is at the beginning of the heading and
630 the match data is set appropriately."
631 (save-excursion
632 (setq end (copy-marker end))
633 (goto-char beg)
634 (when (re-search-forward (concat "^\\(?:" outline-regexp "\\)") end t)
635 (goto-char (match-beginning 0))
636 (funcall fun)
637 (while (and (progn
638 (outline-next-heading)
639 (< (point) end))
640 (not (eobp)))
641 (funcall fun)))))
643 ;; Vertical tree motion
645 (defun outline-move-subtree-up (&optional arg)
646 "Move the currrent subtree up past ARG headlines of the same level."
647 (interactive "p")
648 (outline-move-subtree-down (- arg)))
650 (defun outline-move-subtree-down (&optional arg)
651 "Move the currrent subtree down past ARG headlines of the same level."
652 (interactive "p")
653 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
654 'outline-get-last-sibling))
655 (ins-point (make-marker))
656 (cnt (abs arg))
657 beg end folded)
658 ;; Select the tree
659 (outline-back-to-heading)
660 (setq beg (point))
661 (save-match-data
662 (save-excursion (outline-end-of-heading)
663 (setq folded (outline-invisible-p)))
664 (outline-end-of-subtree))
665 (if (= (char-after) ?\n) (forward-char 1))
666 (setq end (point))
667 ;; Find insertion point, with error handling
668 (goto-char beg)
669 (while (> cnt 0)
670 (or (funcall movfunc)
671 (progn (goto-char beg)
672 (error "Cannot move past superior level")))
673 (setq cnt (1- cnt)))
674 (if (> arg 0)
675 ;; Moving forward - still need to move over subtree
676 (progn (outline-end-of-subtree)
677 (if (= (char-after) ?\n) (forward-char 1))))
678 (move-marker ins-point (point))
679 (insert (delete-and-extract-region beg end))
680 (goto-char ins-point)
681 (if folded (hide-subtree))
682 (move-marker ins-point nil)))
684 (defun outline-end-of-heading ()
685 (if (re-search-forward outline-heading-end-regexp nil 'move)
686 (forward-char -1)))
688 (defun outline-next-visible-heading (arg)
689 "Move to the next visible heading line.
690 With argument, repeats or can move backward if negative.
691 A heading line is one that starts with a `*' (or that
692 `outline-regexp' matches)."
693 (interactive "p")
694 (if (< arg 0)
695 (beginning-of-line)
696 (end-of-line))
697 (let (found-heading-p)
698 (while (and (not (bobp)) (< arg 0))
699 (while (and (not (bobp))
700 (setq found-heading-p
701 (re-search-backward
702 (concat "^\\(?:" outline-regexp "\\)")
703 nil 'move))
704 (outline-invisible-p)))
705 (setq arg (1+ arg)))
706 (while (and (not (eobp)) (> arg 0))
707 (while (and (not (eobp))
708 (setq found-heading-p
709 (re-search-forward
710 (concat "^\\(?:" outline-regexp "\\)")
711 nil 'move))
712 (outline-invisible-p (match-beginning 0))))
713 (setq arg (1- arg)))
714 (if found-heading-p (beginning-of-line))))
716 (defun outline-previous-visible-heading (arg)
717 "Move to the previous heading line.
718 With argument, repeats or can move forward if negative.
719 A heading line is one that starts with a `*' (or that
720 `outline-regexp' matches)."
721 (interactive "p")
722 (outline-next-visible-heading (- arg)))
724 (defun outline-mark-subtree ()
725 "Mark the current subtree in an outlined document.
726 This puts point at the start of the current subtree, and mark at the end."
727 (interactive)
728 (let ((beg))
729 (if (outline-on-heading-p)
730 ;; we are already looking at a heading
731 (beginning-of-line)
732 ;; else go back to previous heading
733 (outline-previous-visible-heading 1))
734 (setq beg (point))
735 (outline-end-of-subtree)
736 (push-mark (point) nil t)
737 (goto-char beg)))
740 (defvar outline-isearch-open-invisible-function nil
741 "Function called if `isearch' finishes in an invisible overlay.
742 The function is called with the overlay as its only argument.
743 If nil, `show-entry' is called to reveal the invisible text.")
745 (put 'outline 'reveal-toggle-invisible 'outline-reveal-toggle-invisible)
746 (defun outline-flag-region (from to flag)
747 "Hide or show lines from FROM to TO, according to FLAG.
748 If FLAG is nil then text is shown, while if FLAG is t the text is hidden."
749 (remove-overlays from to 'invisible 'outline)
750 (when flag
751 ;; We use `front-advance' here because the invisible text begins at the
752 ;; very end of the heading, before the newline, so text inserted at FROM
753 ;; belongs to the heading rather than to the entry.
754 (let ((o (make-overlay from to nil 'front-advance)))
755 (overlay-put o 'invisible 'outline)
756 (overlay-put o 'isearch-open-invisible
757 (or outline-isearch-open-invisible-function
758 'outline-isearch-open-invisible))))
759 ;; Seems only used by lazy-lock. I.e. obsolete.
760 (run-hooks 'outline-view-change-hook))
762 (defun outline-reveal-toggle-invisible (o hidep)
763 (save-excursion
764 (goto-char (overlay-start o))
765 (if hidep
766 ;; When hiding the area again, we could just clean it up and let
767 ;; reveal do the rest, by simply doing:
768 ;; (remove-overlays (overlay-start o) (overlay-end o)
769 ;; 'invisible 'outline)
771 ;; That works fine as long as everything is in sync, but if the
772 ;; structure of the document is changed while revealing parts of it,
773 ;; the resulting behavior can be ugly. I.e. we need to make
774 ;; sure that we hide exactly a subtree.
775 (progn
776 (let ((end (overlay-end o)))
777 (delete-overlay o)
778 (while (progn
779 (hide-subtree)
780 (outline-next-visible-heading 1)
781 (and (not (eobp)) (< (point) end))))))
783 ;; When revealing, we just need to reveal sublevels. If point is
784 ;; inside one of the sublevels, reveal will call us again.
785 ;; But we need to preserve the original overlay.
786 (let ((o1 (copy-overlay o)))
787 (overlay-put o 'invisible nil) ;Show (most of) the text.
788 (while (progn
789 (show-entry)
790 (show-children)
791 ;; Normally just the above is needed.
792 ;; But in odd cases, the above might fail to show anything.
793 ;; To avoid an infinite loop, we have to make sure that
794 ;; *something* gets shown.
795 (and (equal (overlay-start o) (overlay-start o1))
796 (< (point) (overlay-end o))
797 (= 0 (forward-line 1)))))
798 ;; If still nothing was shown, just kill the damn thing.
799 (when (equal (overlay-start o) (overlay-start o1))
800 ;; I've seen it happen at the end of buffer.
801 (delete-overlay o1))))))
803 ;; Function to be set as an outline-isearch-open-invisible' property
804 ;; to the overlay that makes the outline invisible (see
805 ;; `outline-flag-region').
806 (defun outline-isearch-open-invisible (overlay)
807 ;; We rely on the fact that isearch places point on the matched text.
808 (show-entry))
810 (defun hide-entry ()
811 "Hide the body directly following this heading."
812 (interactive)
813 (save-excursion
814 (outline-back-to-heading)
815 (outline-end-of-heading)
816 (outline-flag-region (point) (progn (outline-next-preface) (point)) t)))
818 (defun show-entry ()
819 "Show the body directly following this heading.
820 Show the heading too, if it is currently invisible."
821 (interactive)
822 (save-excursion
823 (outline-back-to-heading t)
824 (outline-flag-region (1- (point))
825 (progn (outline-next-preface) (point)) nil)))
827 (defun hide-body ()
828 "Hide all body lines in buffer, leaving all headings visible."
829 (interactive)
830 (hide-region-body (point-min) (point-max)))
832 (defun hide-region-body (start end)
833 "Hide all body lines in the region, but not headings."
834 ;; Nullify the hook to avoid repeated calls to `outline-flag-region'
835 ;; wasting lots of time running `lazy-lock-fontify-after-outline'
836 ;; and run the hook finally.
837 (let (outline-view-change-hook)
838 (save-excursion
839 (save-restriction
840 (narrow-to-region start end)
841 (goto-char (point-min))
842 (if (outline-on-heading-p)
843 (outline-end-of-heading)
844 (outline-next-preface))
845 (while (not (eobp))
846 (outline-flag-region (point)
847 (progn (outline-next-preface) (point)) t)
848 (unless (eobp)
849 (forward-char (if (looking-at "\n\n") 2 1))
850 (outline-end-of-heading))))))
851 (run-hooks 'outline-view-change-hook))
853 (defun show-all ()
854 "Show all of the text in the buffer."
855 (interactive)
856 (outline-flag-region (point-min) (point-max) nil))
858 (defun hide-subtree ()
859 "Hide everything after this heading at deeper levels."
860 (interactive)
861 (outline-flag-subtree t))
863 (defun hide-leaves ()
864 "Hide the body after this heading and at deeper levels."
865 (interactive)
866 (save-excursion
867 (outline-back-to-heading)
868 ;; Turned off to fix bug reported by Otto Maddox on 22 Nov 2005.
869 ;; (outline-end-of-heading)
870 (hide-region-body (point) (progn (outline-end-of-subtree) (point)))))
872 (defun show-subtree ()
873 "Show everything after this heading at deeper levels."
874 (interactive)
875 (outline-flag-subtree nil))
877 (defun outline-show-heading ()
878 "Show the current heading and move to its end."
879 (outline-flag-region (- (point)
880 (if (bobp) 0
881 (if (and outline-blank-line
882 (eq (char-before (1- (point))) ?\n))
883 2 1)))
884 (progn (outline-end-of-heading) (point))
885 nil))
887 (defun hide-sublevels (levels)
888 "Hide everything but the top LEVELS levels of headers, in whole buffer."
889 (interactive (list
890 (cond
891 (current-prefix-arg (prefix-numeric-value current-prefix-arg))
892 ((save-excursion (beginning-of-line)
893 (looking-at outline-regexp))
894 (funcall outline-level))
895 (t 1))))
896 (if (< levels 1)
897 (error "Must keep at least one level of headers"))
898 (save-excursion
899 (let* (outline-view-change-hook
900 (beg (progn
901 (goto-char (point-min))
902 ;; Skip the prelude, if any.
903 (unless (outline-on-heading-p t) (outline-next-heading))
904 (point)))
905 (end (progn
906 (goto-char (point-max))
907 ;; Keep empty last line, if available.
908 (if (bolp) (1- (point)) (point)))))
909 (if (< end beg)
910 (setq beg (prog1 end (setq end beg))))
911 ;; First hide everything.
912 (outline-flag-region beg end t)
913 ;; Then unhide the top level headers.
914 (outline-map-region
915 (lambda ()
916 (if (<= (funcall outline-level) levels)
917 (outline-show-heading)))
918 beg end)
919 ;; Finally unhide any trailing newline.
920 (goto-char (point-max))
921 (if (and (bolp) (not (bobp)) (outline-invisible-p (1- (point))))
922 (outline-flag-region (1- (point)) (point) nil))))
923 (run-hooks 'outline-view-change-hook))
925 (defun hide-other ()
926 "Hide everything except current body and parent and top-level headings."
927 (interactive)
928 (hide-sublevels 1)
929 (let (outline-view-change-hook)
930 (save-excursion
931 (outline-back-to-heading t)
932 (show-entry)
933 (while (condition-case nil (progn (outline-up-heading 1 t) (not (bobp)))
934 (error nil))
935 (outline-flag-region (1- (point))
936 (save-excursion (forward-line 1) (point))
937 nil))))
938 (run-hooks 'outline-view-change-hook))
940 (defun outline-toggle-children ()
941 "Show or hide the current subtree depending on its current state."
942 (interactive)
943 (save-excursion
944 (outline-back-to-heading)
945 (if (not (outline-invisible-p (line-end-position)))
946 (hide-subtree)
947 (show-children)
948 (show-entry))))
950 (defun outline-flag-subtree (flag)
951 (save-excursion
952 (outline-back-to-heading)
953 (outline-end-of-heading)
954 (outline-flag-region (point)
955 (progn (outline-end-of-subtree) (point))
956 flag)))
958 (defun outline-end-of-subtree ()
959 (outline-back-to-heading)
960 (let ((first t)
961 (level (funcall outline-level)))
962 (while (and (not (eobp))
963 (or first (> (funcall outline-level) level)))
964 (setq first nil)
965 (outline-next-heading))
966 (if (and (bolp) (not (eolp)))
967 ;; We stopped at a nonempty line (the next heading).
968 (progn
969 ;; Go to end of line before heading
970 (forward-char -1)
971 (if (and outline-blank-line (bolp))
972 ;; leave blank line before heading
973 (forward-char -1))))))
975 (defun show-branches ()
976 "Show all subheadings of this heading, but not their bodies."
977 (interactive)
978 (show-children 1000))
980 (defun show-children (&optional level)
981 "Show all direct subheadings of this heading.
982 Prefix arg LEVEL is how many levels below the current level should be shown.
983 Default is enough to cause the following heading to appear."
984 (interactive "P")
985 (setq level
986 (if level (prefix-numeric-value level)
987 (save-excursion
988 (outline-back-to-heading)
989 (let ((start-level (funcall outline-level)))
990 (outline-next-heading)
991 (if (eobp)
993 (max 1 (- (funcall outline-level) start-level)))))))
994 (let (outline-view-change-hook)
995 (save-excursion
996 (outline-back-to-heading)
997 (setq level (+ level (funcall outline-level)))
998 (outline-map-region
999 (lambda ()
1000 (if (<= (funcall outline-level) level)
1001 (outline-show-heading)))
1002 (point)
1003 (progn (outline-end-of-subtree)
1004 (if (eobp) (point-max) (1+ (point)))))))
1005 (run-hooks 'outline-view-change-hook))
1009 (defun outline-up-heading (arg &optional invisible-ok)
1010 "Move to the visible heading line of which the present line is a subheading.
1011 With argument, move up ARG levels.
1012 If INVISIBLE-OK is non-nil, also consider invisible lines."
1013 (interactive "p")
1014 (and (eq this-command 'outline-up-heading)
1015 (or (eq last-command 'outline-up-heading) (push-mark)))
1016 (outline-back-to-heading invisible-ok)
1017 (let ((start-level (funcall outline-level)))
1018 (when (<= start-level 1)
1019 (error "Already at top level of the outline"))
1020 (while (and (> start-level 1) (> arg 0) (not (bobp)))
1021 (let ((level start-level))
1022 (while (not (or (< level start-level) (bobp)))
1023 (if invisible-ok
1024 (outline-previous-heading)
1025 (outline-previous-visible-heading 1))
1026 (setq level (funcall outline-level)))
1027 (setq start-level level))
1028 (setq arg (- arg 1))))
1029 (looking-at outline-regexp))
1031 (defun outline-forward-same-level (arg)
1032 "Move forward to the ARG'th subheading at same level as this one.
1033 Stop at the first and last subheadings of a superior heading."
1034 (interactive "p")
1035 (outline-back-to-heading)
1036 (while (> arg 0)
1037 (let ((point-to-move-to (save-excursion
1038 (outline-get-next-sibling))))
1039 (if point-to-move-to
1040 (progn
1041 (goto-char point-to-move-to)
1042 (setq arg (1- arg)))
1043 (progn
1044 (setq arg 0)
1045 (error "No following same-level heading"))))))
1047 (defun outline-get-next-sibling ()
1048 "Move to next heading of the same level, and return point.
1049 If there is no such heading, return nil."
1050 (let ((level (funcall outline-level)))
1051 (outline-next-visible-heading 1)
1052 (while (and (not (eobp)) (> (funcall outline-level) level))
1053 (outline-next-visible-heading 1))
1054 (if (or (eobp) (< (funcall outline-level) level))
1056 (point))))
1058 (defun outline-backward-same-level (arg)
1059 "Move backward to the ARG'th subheading at same level as this one.
1060 Stop at the first and last subheadings of a superior heading."
1061 (interactive "p")
1062 (outline-back-to-heading)
1063 (while (> arg 0)
1064 (let ((point-to-move-to (save-excursion
1065 (outline-get-last-sibling))))
1066 (if point-to-move-to
1067 (progn
1068 (goto-char point-to-move-to)
1069 (setq arg (1- arg)))
1070 (progn
1071 (setq arg 0)
1072 (error "No previous same-level heading"))))))
1074 (defun outline-get-last-sibling ()
1075 "Move to previous heading of the same level, and return point.
1076 If there is no such heading, return nil."
1077 (let ((opoint (point))
1078 (level (funcall outline-level)))
1079 (outline-previous-visible-heading 1)
1080 (when (and (/= (point) opoint) (outline-on-heading-p))
1081 (while (and (> (funcall outline-level) level)
1082 (not (bobp)))
1083 (outline-previous-visible-heading 1))
1084 (if (< (funcall outline-level) level)
1086 (point)))))
1088 (defun outline-headers-as-kill (beg end)
1089 "Save the visible outline headers in region at the start of the kill ring.
1091 Text shown between the headers isn't copied. Two newlines are
1092 inserted between saved headers. Yanking the result may be a
1093 convenient way to make a table of contents of the buffer."
1094 (interactive "r")
1095 (save-excursion
1096 (save-restriction
1097 (narrow-to-region beg end)
1098 (goto-char (point-min))
1099 (let ((buffer (current-buffer))
1100 start end)
1101 (with-temp-buffer
1102 (with-current-buffer buffer
1103 ;; Boundary condition: starting on heading:
1104 (when (outline-on-heading-p)
1105 (outline-back-to-heading)
1106 (setq start (point)
1107 end (progn (outline-end-of-heading)
1108 (point)))
1109 (insert-buffer-substring buffer start end)
1110 (insert "\n\n")))
1111 (let ((temp-buffer (current-buffer)))
1112 (with-current-buffer buffer
1113 (while (outline-next-heading)
1114 (unless (outline-invisible-p)
1115 (setq start (point)
1116 end (progn (outline-end-of-heading) (point)))
1117 (with-current-buffer temp-buffer
1118 (insert-buffer-substring buffer start end)
1119 (insert "\n\n"))))))
1120 (kill-new (buffer-string)))))))
1122 (provide 'outline)
1123 (provide 'noutline)
1125 ;; arch-tag: 1724410e-7d4d-4f46-b801-49e18171e874
1126 ;;; outline.el ends here