* json.el: Bump version to 1.3; (json-alist-p, json-plist-p): Rewrite to avoid recursion.
[emacs.git] / lisp / outline.el
blobf864058c6fcca29339c0295e4115c090300f3962
1 ;;; outline.el --- outline mode commands for Emacs
3 ;; Copyright (C) 1986, 1993-1995, 1997, 2000-2011
4 ;; 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 'regexp
54 :group 'outlines)
55 ;;;###autoload(put 'outline-regexp 'safe-local-variable 'stringp)
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)
65 ;;;###autoload(put 'outline-heading-end-regexp 'safe-local-variable 'stringp)
67 (defvar outline-mode-prefix-map
68 (let ((map (make-sparse-keymap)))
69 (define-key map "@" 'outline-mark-subtree)
70 (define-key map "\C-n" 'outline-next-visible-heading)
71 (define-key map "\C-p" 'outline-previous-visible-heading)
72 (define-key map "\C-i" 'show-children)
73 (define-key map "\C-s" 'show-subtree)
74 (define-key map "\C-d" 'hide-subtree)
75 (define-key map "\C-u" 'outline-up-heading)
76 (define-key map "\C-f" 'outline-forward-same-level)
77 (define-key map "\C-b" 'outline-backward-same-level)
78 (define-key map "\C-t" 'hide-body)
79 (define-key map "\C-a" 'show-all)
80 (define-key map "\C-c" 'hide-entry)
81 (define-key map "\C-e" 'show-entry)
82 (define-key map "\C-l" 'hide-leaves)
83 (define-key map "\C-k" 'show-branches)
84 (define-key map "\C-q" 'hide-sublevels)
85 (define-key map "\C-o" 'hide-other)
86 (define-key map "\C-^" 'outline-move-subtree-up)
87 (define-key map "\C-v" 'outline-move-subtree-down)
88 (define-key map [(control ?<)] 'outline-promote)
89 (define-key map [(control ?>)] 'outline-demote)
90 (define-key map "\C-m" 'outline-insert-heading)
91 ;; Where to bind outline-cycle ?
92 map))
94 (defvar outline-mode-menu-bar-map
95 (let ((map (make-sparse-keymap)))
97 (define-key map [hide] (cons "Hide" (make-sparse-keymap "Hide")))
99 (define-key map [hide hide-other]
100 '(menu-item "Hide Other" hide-other
101 :help "Hide everything except current body and parent and top-level headings"))
102 (define-key map [hide hide-sublevels]
103 '(menu-item "Hide Sublevels" hide-sublevels
104 :help "Hide everything but the top LEVELS levels of headers, in whole buffer"))
105 (define-key map [hide hide-subtree]
106 '(menu-item "Hide Subtree" hide-subtree
107 :help "Hide everything after this heading at deeper levels"))
108 (define-key map [hide hide-entry]
109 '(menu-item "Hide Entry" hide-entry
110 :help "Hide the body directly following this heading"))
111 (define-key map [hide hide-body]
112 '(menu-item "Hide Body" hide-body
113 :help "Hide all body lines in buffer, leaving all headings visible"))
114 (define-key map [hide hide-leaves]
115 '(menu-item "Hide Leaves" hide-leaves
116 :help "Hide the body after this heading and at deeper levels"))
118 (define-key map [show] (cons "Show" (make-sparse-keymap "Show")))
120 (define-key map [show show-subtree]
121 '(menu-item "Show Subtree" show-subtree
122 :help "Show everything after this heading at deeper levels"))
123 (define-key map [show show-children]
124 '(menu-item "Show Children" show-children
125 :help "Show all direct subheadings of this heading"))
126 (define-key map [show show-branches]
127 '(menu-item "Show Branches" show-branches
128 :help "Show all subheadings of this heading, but not their bodies"))
129 (define-key map [show show-entry]
130 '(menu-item "Show Entry" show-entry
131 :help "Show the body directly following this heading"))
132 (define-key map [show show-all]
133 '(menu-item "Show All" show-all
134 :help "Show all of the text in the buffer"))
136 (define-key map [headings]
137 (cons "Headings" (make-sparse-keymap "Headings")))
139 (define-key map [headings demote-subtree]
140 '(menu-item "Demote Subtree" outline-demote
141 :help "Demote headings lower down the tree"))
142 (define-key map [headings promote-subtree]
143 '(menu-item "Promote Subtree" outline-promote
144 :help "Promote headings higher up the tree"))
145 (define-key map [headings move-subtree-down]
146 '(menu-item "Move Subtree Down" outline-move-subtree-down
147 :help "Move the currrent subtree down past arg headlines of the same level"))
148 (define-key map [headings move-subtree-up]
149 '(menu-item "Move Subtree Up" outline-move-subtree-up
150 :help "Move the currrent subtree up past arg headlines of the same level"))
151 (define-key map [headings copy]
152 '(menu-item "Copy to Kill Ring" outline-headers-as-kill
153 :enable mark-active
154 :help "Save the visible outline headers in region at the start of the kill ring"))
155 (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-back-to-heading (&optional invisible-ok)
449 "Move to previous heading line, or beg of this line if it's a heading.
450 Only visible heading lines are considered, unless INVISIBLE-OK is non-nil."
451 (beginning-of-line)
452 (or (outline-on-heading-p invisible-ok)
453 (let (found)
454 (save-excursion
455 (while (not found)
456 (or (re-search-backward (concat "^\\(?:" outline-regexp "\\)")
457 nil t)
458 (error "before first heading"))
459 (setq found (and (or invisible-ok (not (outline-invisible-p)))
460 (point)))))
461 (goto-char found)
462 found)))
464 (defun outline-on-heading-p (&optional invisible-ok)
465 "Return t if point is on a (visible) heading line.
466 If INVISIBLE-OK is non-nil, an invisible heading line is ok too."
467 (save-excursion
468 (beginning-of-line)
469 (and (bolp) (or invisible-ok (not (outline-invisible-p)))
470 (looking-at outline-regexp))))
472 (defun outline-insert-heading ()
473 "Insert a new heading at same depth at point."
474 (interactive)
475 (let ((head (save-excursion
476 (condition-case nil
477 (outline-back-to-heading)
478 (error (outline-next-heading)))
479 (if (eobp)
480 (or (caar outline-heading-alist) "")
481 (match-string 0)))))
482 (unless (or (string-match "[ \t]\\'" head)
483 (not (string-match (concat "\\`\\(?:" outline-regexp "\\)")
484 (concat head " "))))
485 (setq head (concat head " ")))
486 (unless (bolp) (end-of-line) (newline))
487 (insert head)
488 (unless (eolp)
489 (save-excursion (newline-and-indent)))
490 (run-hooks 'outline-insert-heading-hook)))
492 (defun outline-invent-heading (head up)
493 (save-match-data
494 ;; Let's try to invent one by repeating or deleting the last char.
495 (let ((new-head (if up (substring head 0 -1)
496 (concat head (substring head -1)))))
497 (if (string-match (concat "\\`\\(?:" outline-regexp "\\)")
498 new-head)
499 ;; Why bother checking that it is indeed higher/lower level ?
500 new-head
501 ;; Didn't work, so ask what to do.
502 (read-string (format "%s heading for `%s': "
503 (if up "Parent" "Demoted") head)
504 head nil nil t)))))
506 (defun outline-promote (&optional which)
507 "Promote headings higher up the tree.
508 If transient-mark-mode is on, and mark is active, promote headings in
509 the region (from a Lisp program, pass `region' for WHICH). Otherwise:
510 without prefix argument, promote current heading and all headings in the
511 subtree (from a Lisp program, pass `subtree' for WHICH); with prefix
512 argument, promote just the current heading (from a Lisp program, pass
513 nil for WHICH, or do not pass any argument)."
514 (interactive
515 (list (if (and transient-mark-mode mark-active) 'region
516 (outline-back-to-heading)
517 (if current-prefix-arg nil 'subtree))))
518 (cond
519 ((eq which 'region)
520 (outline-map-region 'outline-promote (region-beginning) (region-end)))
521 (which
522 (outline-map-region 'outline-promote
523 (point)
524 (save-excursion (outline-get-next-sibling) (point))))
526 (outline-back-to-heading t)
527 (let* ((head (match-string-no-properties 0))
528 (level (save-match-data (funcall outline-level)))
529 (up-head (or (outline-head-from-level (1- level) head)
530 ;; Use the parent heading, if it is really
531 ;; one level less.
532 (save-excursion
533 (save-match-data
534 (outline-up-heading 1 t)
535 (and (= (1- level) (funcall outline-level))
536 (match-string-no-properties 0))))
537 ;; Bummer!! There is no lower level heading.
538 (outline-invent-heading head 'up))))
540 (unless (rassoc level outline-heading-alist)
541 (push (cons head level) outline-heading-alist))
543 (replace-match up-head nil t)))))
545 (defun outline-demote (&optional which)
546 "Demote headings lower down the tree.
547 If transient-mark-mode is on, and mark is active, demote headings in
548 the region (from a Lisp program, pass `region' for WHICH). Otherwise:
549 without prefix argument, demote current heading and all headings in the
550 subtree (from a Lisp program, pass `subtree' for WHICH); with prefix
551 argument, demote just the current heading (from a Lisp program, pass
552 nil for WHICH, or do not pass any argument)."
553 (interactive
554 (list (if (and transient-mark-mode mark-active) 'region
555 (outline-back-to-heading)
556 (if current-prefix-arg nil 'subtree))))
557 (cond
558 ((eq which 'region)
559 (outline-map-region 'outline-demote (region-beginning) (region-end)))
560 (which
561 (outline-map-region 'outline-demote
562 (point)
563 (save-excursion (outline-get-next-sibling) (point))))
565 (let* ((head (match-string-no-properties 0))
566 (level (save-match-data (funcall outline-level)))
567 (down-head
568 (or (outline-head-from-level (1+ level) head)
569 (save-excursion
570 (save-match-data
571 (while (and (progn (outline-next-heading) (not (eobp)))
572 (<= (funcall outline-level) level)))
573 (when (eobp)
574 ;; Try again from the beginning of the buffer.
575 (goto-char (point-min))
576 (while (and (progn (outline-next-heading) (not (eobp)))
577 (<= (funcall outline-level) level))))
578 (unless (eobp)
579 (looking-at outline-regexp)
580 (match-string-no-properties 0))))
581 ;; Bummer!! There is no higher-level heading in the buffer.
582 (outline-invent-heading head nil))))
584 (unless (rassoc level outline-heading-alist)
585 (push (cons head level) outline-heading-alist))
586 (replace-match down-head nil t)))))
588 (defun outline-head-from-level (level head &optional alist)
589 "Get new heading with level LEVEL from ALIST.
590 If there are no such entries, return nil.
591 ALIST defaults to `outline-heading-alist'.
592 Similar to (car (rassoc LEVEL ALIST)).
593 If there are several different entries with same new level, choose
594 the one with the smallest distance to the association of HEAD in the alist.
595 This makes it possible for promotion to work in modes with several
596 independent sets of headings (numbered, unnumbered, appendix...)"
597 (unless alist (setq alist outline-heading-alist))
598 (let ((l (rassoc level alist))
599 ll h hl l2 l2l)
600 (cond
601 ((null l) nil)
602 ;; If there's no HEAD after L, any other entry for LEVEL after L
603 ;; can't be much better than L.
604 ((null (setq h (assoc head (setq ll (memq l alist))))) (car l))
605 ;; If there's no other entry for LEVEL, just keep L.
606 ((null (setq l2 (rassoc level (cdr ll)))) (car l))
607 ;; Now we have L, L2, and H: see if L2 seems better than L.
608 ;; If H is after L2, L2 is better.
609 ((memq h (setq l2l (memq l2 (cdr ll))))
610 (outline-head-from-level level head l2l))
611 ;; Now we have H between L and L2.
612 ;; If there's a separator between L and H, prefer L2.
613 ((memq h (memq nil ll))
614 (outline-head-from-level level head l2l))
615 ;; If there's a separator between L2 and H, prefer L.
616 ((memq l2 (memq nil (setq hl (memq h ll)))) (car l))
617 ;; No separator between L and L2, check the distance.
618 ((< (* 2 (length hl)) (+ (length ll) (length l2l)))
619 (outline-head-from-level level head l2l))
620 ;; If all else fails, just keep L.
621 (t (car l)))))
623 (defun outline-map-region (fun beg end)
624 "Call FUN for every heading between BEG and END.
625 When FUN is called, point is at the beginning of the heading and
626 the match data is set appropriately."
627 (save-excursion
628 (setq end (copy-marker end))
629 (goto-char beg)
630 (when (re-search-forward (concat "^\\(?:" outline-regexp "\\)") end t)
631 (goto-char (match-beginning 0))
632 (funcall fun)
633 (while (and (progn
634 (outline-next-heading)
635 (< (point) end))
636 (not (eobp)))
637 (funcall fun)))))
639 ;; Vertical tree motion
641 (defun outline-move-subtree-up (&optional arg)
642 "Move the currrent subtree up past ARG headlines of the same level."
643 (interactive "p")
644 (outline-move-subtree-down (- arg)))
646 (defun outline-move-subtree-down (&optional arg)
647 "Move the currrent subtree down past ARG headlines of the same level."
648 (interactive "p")
649 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
650 'outline-get-last-sibling))
651 (ins-point (make-marker))
652 (cnt (abs arg))
653 beg end folded)
654 ;; Select the tree
655 (outline-back-to-heading)
656 (setq beg (point))
657 (save-match-data
658 (save-excursion (outline-end-of-heading)
659 (setq folded (outline-invisible-p)))
660 (outline-end-of-subtree))
661 (if (= (char-after) ?\n) (forward-char 1))
662 (setq end (point))
663 ;; Find insertion point, with error handling
664 (goto-char beg)
665 (while (> cnt 0)
666 (or (funcall movfunc)
667 (progn (goto-char beg)
668 (error "Cannot move past superior level")))
669 (setq cnt (1- cnt)))
670 (if (> arg 0)
671 ;; Moving forward - still need to move over subtree
672 (progn (outline-end-of-subtree)
673 (if (= (char-after) ?\n) (forward-char 1))))
674 (move-marker ins-point (point))
675 (insert (delete-and-extract-region beg end))
676 (goto-char ins-point)
677 (if folded (hide-subtree))
678 (move-marker ins-point nil)))
680 (defun outline-end-of-heading ()
681 (if (re-search-forward outline-heading-end-regexp nil 'move)
682 (forward-char -1)))
684 (defun outline-next-visible-heading (arg)
685 "Move to the next visible heading line.
686 With argument, repeats or can move backward if negative.
687 A heading line is one that starts with a `*' (or that
688 `outline-regexp' matches)."
689 (interactive "p")
690 (if (< arg 0)
691 (beginning-of-line)
692 (end-of-line))
693 (let (found-heading-p)
694 (while (and (not (bobp)) (< arg 0))
695 (while (and (not (bobp))
696 (setq found-heading-p
697 (re-search-backward
698 (concat "^\\(?:" outline-regexp "\\)")
699 nil 'move))
700 (outline-invisible-p)))
701 (setq arg (1+ arg)))
702 (while (and (not (eobp)) (> arg 0))
703 (while (and (not (eobp))
704 (setq found-heading-p
705 (re-search-forward
706 (concat "^\\(?:" outline-regexp "\\)")
707 nil 'move))
708 (outline-invisible-p (match-beginning 0))))
709 (setq arg (1- arg)))
710 (if found-heading-p (beginning-of-line))))
712 (defun outline-previous-visible-heading (arg)
713 "Move to the previous heading line.
714 With argument, repeats or can move forward if negative.
715 A heading line is one that starts with a `*' (or that
716 `outline-regexp' matches)."
717 (interactive "p")
718 (outline-next-visible-heading (- arg)))
720 (defun outline-mark-subtree ()
721 "Mark the current subtree in an outlined document.
722 This puts point at the start of the current subtree, and mark at the end."
723 (interactive)
724 (let ((beg))
725 (if (outline-on-heading-p)
726 ;; we are already looking at a heading
727 (beginning-of-line)
728 ;; else go back to previous heading
729 (outline-previous-visible-heading 1))
730 (setq beg (point))
731 (outline-end-of-subtree)
732 (push-mark (point) nil t)
733 (goto-char beg)))
736 (defvar outline-isearch-open-invisible-function nil
737 "Function called if `isearch' finishes in an invisible overlay.
738 The function is called with the overlay as its only argument.
739 If nil, `show-entry' is called to reveal the invisible text.")
741 (put 'outline 'reveal-toggle-invisible 'outline-reveal-toggle-invisible)
742 (defun outline-flag-region (from to flag)
743 "Hide or show lines from FROM to TO, according to FLAG.
744 If FLAG is nil then text is shown, while if FLAG is t the text is hidden."
745 (remove-overlays from to 'invisible 'outline)
746 (when flag
747 ;; We use `front-advance' here because the invisible text begins at the
748 ;; very end of the heading, before the newline, so text inserted at FROM
749 ;; belongs to the heading rather than to the entry.
750 (let ((o (make-overlay from to nil 'front-advance)))
751 (overlay-put o 'invisible 'outline)
752 (overlay-put o 'isearch-open-invisible
753 (or outline-isearch-open-invisible-function
754 'outline-isearch-open-invisible))))
755 ;; Seems only used by lazy-lock. I.e. obsolete.
756 (run-hooks 'outline-view-change-hook))
758 (defun outline-reveal-toggle-invisible (o hidep)
759 (save-excursion
760 (goto-char (overlay-start o))
761 (if hidep
762 ;; When hiding the area again, we could just clean it up and let
763 ;; reveal do the rest, by simply doing:
764 ;; (remove-overlays (overlay-start o) (overlay-end o)
765 ;; 'invisible 'outline)
767 ;; That works fine as long as everything is in sync, but if the
768 ;; structure of the document is changed while revealing parts of it,
769 ;; the resulting behavior can be ugly. I.e. we need to make
770 ;; sure that we hide exactly a subtree.
771 (progn
772 (let ((end (overlay-end o)))
773 (delete-overlay o)
774 (while (progn
775 (hide-subtree)
776 (outline-next-visible-heading 1)
777 (and (not (eobp)) (< (point) end))))))
779 ;; When revealing, we just need to reveal sublevels. If point is
780 ;; inside one of the sublevels, reveal will call us again.
781 ;; But we need to preserve the original overlay.
782 (let ((o1 (copy-overlay o)))
783 (overlay-put o 'invisible nil) ;Show (most of) the text.
784 (while (progn
785 (show-entry)
786 (show-children)
787 ;; Normally just the above is needed.
788 ;; But in odd cases, the above might fail to show anything.
789 ;; To avoid an infinite loop, we have to make sure that
790 ;; *something* gets shown.
791 (and (equal (overlay-start o) (overlay-start o1))
792 (< (point) (overlay-end o))
793 (= 0 (forward-line 1)))))
794 ;; If still nothing was shown, just kill the damn thing.
795 (when (equal (overlay-start o) (overlay-start o1))
796 ;; I've seen it happen at the end of buffer.
797 (delete-overlay o1))))))
799 ;; Function to be set as an outline-isearch-open-invisible' property
800 ;; to the overlay that makes the outline invisible (see
801 ;; `outline-flag-region').
802 (defun outline-isearch-open-invisible (_overlay)
803 ;; We rely on the fact that isearch places point on the matched text.
804 (show-entry))
806 (defun hide-entry ()
807 "Hide the body directly following this heading."
808 (interactive)
809 (save-excursion
810 (outline-back-to-heading)
811 (outline-end-of-heading)
812 (outline-flag-region (point) (progn (outline-next-preface) (point)) t)))
814 (defun show-entry ()
815 "Show the body directly following this heading.
816 Show the heading too, if it is currently invisible."
817 (interactive)
818 (save-excursion
819 (outline-back-to-heading t)
820 (outline-flag-region (1- (point))
821 (progn (outline-next-preface) (point)) nil)))
823 (defun hide-body ()
824 "Hide all body lines in buffer, leaving all headings visible."
825 (interactive)
826 (hide-region-body (point-min) (point-max)))
828 (defun hide-region-body (start end)
829 "Hide all body lines in the region, but not headings."
830 ;; Nullify the hook to avoid repeated calls to `outline-flag-region'
831 ;; wasting lots of time running `lazy-lock-fontify-after-outline'
832 ;; and run the hook finally.
833 (let (outline-view-change-hook)
834 (save-excursion
835 (save-restriction
836 (narrow-to-region start end)
837 (goto-char (point-min))
838 (if (outline-on-heading-p)
839 (outline-end-of-heading)
840 (outline-next-preface))
841 (while (not (eobp))
842 (outline-flag-region (point)
843 (progn (outline-next-preface) (point)) t)
844 (unless (eobp)
845 (forward-char (if (looking-at "\n\n") 2 1))
846 (outline-end-of-heading))))))
847 (run-hooks 'outline-view-change-hook))
849 (defun show-all ()
850 "Show all of the text in the buffer."
851 (interactive)
852 (outline-flag-region (point-min) (point-max) nil))
854 (defun hide-subtree ()
855 "Hide everything after this heading at deeper levels."
856 (interactive)
857 (outline-flag-subtree t))
859 (defun hide-leaves ()
860 "Hide the body after this heading and at deeper levels."
861 (interactive)
862 (save-excursion
863 (outline-back-to-heading)
864 ;; Turned off to fix bug reported by Otto Maddox on 22 Nov 2005.
865 ;; (outline-end-of-heading)
866 (hide-region-body (point) (progn (outline-end-of-subtree) (point)))))
868 (defun show-subtree ()
869 "Show everything after this heading at deeper levels."
870 (interactive)
871 (outline-flag-subtree nil))
873 (defun outline-show-heading ()
874 "Show the current heading and move to its end."
875 (outline-flag-region (- (point)
876 (if (bobp) 0
877 (if (and outline-blank-line
878 (eq (char-before (1- (point))) ?\n))
879 2 1)))
880 (progn (outline-end-of-heading) (point))
881 nil))
883 (defun hide-sublevels (levels)
884 "Hide everything but the top LEVELS levels of headers, in whole buffer."
885 (interactive (list
886 (cond
887 (current-prefix-arg (prefix-numeric-value current-prefix-arg))
888 ((save-excursion (beginning-of-line)
889 (looking-at outline-regexp))
890 (funcall outline-level))
891 (t 1))))
892 (if (< levels 1)
893 (error "Must keep at least one level of headers"))
894 (save-excursion
895 (let* (outline-view-change-hook
896 (beg (progn
897 (goto-char (point-min))
898 ;; Skip the prelude, if any.
899 (unless (outline-on-heading-p t) (outline-next-heading))
900 (point)))
901 (end (progn
902 (goto-char (point-max))
903 ;; Keep empty last line, if available.
904 (if (bolp) (1- (point)) (point)))))
905 (if (< end beg)
906 (setq beg (prog1 end (setq end beg))))
907 ;; First hide everything.
908 (outline-flag-region beg end t)
909 ;; Then unhide the top level headers.
910 (outline-map-region
911 (lambda ()
912 (if (<= (funcall outline-level) levels)
913 (outline-show-heading)))
914 beg end)
915 ;; Finally unhide any trailing newline.
916 (goto-char (point-max))
917 (if (and (bolp) (not (bobp)) (outline-invisible-p (1- (point))))
918 (outline-flag-region (1- (point)) (point) nil))))
919 (run-hooks 'outline-view-change-hook))
921 (defun hide-other ()
922 "Hide everything except current body and parent and top-level headings."
923 (interactive)
924 (hide-sublevels 1)
925 (let (outline-view-change-hook)
926 (save-excursion
927 (outline-back-to-heading t)
928 (show-entry)
929 (while (condition-case nil (progn (outline-up-heading 1 t) (not (bobp)))
930 (error nil))
931 (outline-flag-region (1- (point))
932 (save-excursion (forward-line 1) (point))
933 nil))))
934 (run-hooks 'outline-view-change-hook))
936 (defun outline-toggle-children ()
937 "Show or hide the current subtree depending on its current state."
938 (interactive)
939 (save-excursion
940 (outline-back-to-heading)
941 (if (not (outline-invisible-p (line-end-position)))
942 (hide-subtree)
943 (show-children)
944 (show-entry))))
946 (defun outline-flag-subtree (flag)
947 (save-excursion
948 (outline-back-to-heading)
949 (outline-end-of-heading)
950 (outline-flag-region (point)
951 (progn (outline-end-of-subtree) (point))
952 flag)))
954 (defun outline-end-of-subtree ()
955 (outline-back-to-heading)
956 (let ((first t)
957 (level (funcall outline-level)))
958 (while (and (not (eobp))
959 (or first (> (funcall outline-level) level)))
960 (setq first nil)
961 (outline-next-heading))
962 (if (and (bolp) (not (eolp)))
963 ;; We stopped at a nonempty line (the next heading).
964 (progn
965 ;; Go to end of line before heading
966 (forward-char -1)
967 (if (and outline-blank-line (bolp))
968 ;; leave blank line before heading
969 (forward-char -1))))))
971 (defun show-branches ()
972 "Show all subheadings of this heading, but not their bodies."
973 (interactive)
974 (show-children 1000))
976 (defun show-children (&optional level)
977 "Show all direct subheadings of this heading.
978 Prefix arg LEVEL is how many levels below the current level should be shown.
979 Default is enough to cause the following heading to appear."
980 (interactive "P")
981 (setq level
982 (if level (prefix-numeric-value level)
983 (save-excursion
984 (outline-back-to-heading)
985 (let ((start-level (funcall outline-level)))
986 (outline-next-heading)
987 (if (eobp)
989 (max 1 (- (funcall outline-level) start-level)))))))
990 (let (outline-view-change-hook)
991 (save-excursion
992 (outline-back-to-heading)
993 (setq level (+ level (funcall outline-level)))
994 (outline-map-region
995 (lambda ()
996 (if (<= (funcall outline-level) level)
997 (outline-show-heading)))
998 (point)
999 (progn (outline-end-of-subtree)
1000 (if (eobp) (point-max) (1+ (point)))))))
1001 (run-hooks 'outline-view-change-hook))
1005 (defun outline-up-heading (arg &optional invisible-ok)
1006 "Move to the visible heading line of which the present line is a subheading.
1007 With argument, move up ARG levels.
1008 If INVISIBLE-OK is non-nil, also consider invisible lines."
1009 (interactive "p")
1010 (and (eq this-command 'outline-up-heading)
1011 (or (eq last-command 'outline-up-heading) (push-mark)))
1012 (outline-back-to-heading invisible-ok)
1013 (let ((start-level (funcall outline-level)))
1014 (when (<= start-level 1)
1015 (error "Already at top level of the outline"))
1016 (while (and (> start-level 1) (> arg 0) (not (bobp)))
1017 (let ((level start-level))
1018 (while (not (or (< level start-level) (bobp)))
1019 (if invisible-ok
1020 (outline-previous-heading)
1021 (outline-previous-visible-heading 1))
1022 (setq level (funcall outline-level)))
1023 (setq start-level level))
1024 (setq arg (- arg 1))))
1025 (looking-at outline-regexp))
1027 (defun outline-forward-same-level (arg)
1028 "Move forward to the ARG'th subheading at same level as this one.
1029 Stop at the first and last subheadings of a superior heading."
1030 (interactive "p")
1031 (outline-back-to-heading)
1032 (while (> arg 0)
1033 (let ((point-to-move-to (save-excursion
1034 (outline-get-next-sibling))))
1035 (if point-to-move-to
1036 (progn
1037 (goto-char point-to-move-to)
1038 (setq arg (1- arg)))
1039 (progn
1040 (setq arg 0)
1041 (error "No following same-level heading"))))))
1043 (defun outline-get-next-sibling ()
1044 "Move to next heading of the same level, and return point.
1045 If there is no such heading, return nil."
1046 (let ((level (funcall outline-level)))
1047 (outline-next-visible-heading 1)
1048 (while (and (not (eobp)) (> (funcall outline-level) level))
1049 (outline-next-visible-heading 1))
1050 (if (or (eobp) (< (funcall outline-level) level))
1052 (point))))
1054 (defun outline-backward-same-level (arg)
1055 "Move backward to the ARG'th subheading at same level as this one.
1056 Stop at the first and last subheadings of a superior heading."
1057 (interactive "p")
1058 (outline-back-to-heading)
1059 (while (> arg 0)
1060 (let ((point-to-move-to (save-excursion
1061 (outline-get-last-sibling))))
1062 (if point-to-move-to
1063 (progn
1064 (goto-char point-to-move-to)
1065 (setq arg (1- arg)))
1066 (progn
1067 (setq arg 0)
1068 (error "No previous same-level heading"))))))
1070 (defun outline-get-last-sibling ()
1071 "Move to previous heading of the same level, and return point.
1072 If there is no such heading, return nil."
1073 (let ((opoint (point))
1074 (level (funcall outline-level)))
1075 (outline-previous-visible-heading 1)
1076 (when (and (/= (point) opoint) (outline-on-heading-p))
1077 (while (and (> (funcall outline-level) level)
1078 (not (bobp)))
1079 (outline-previous-visible-heading 1))
1080 (if (< (funcall outline-level) level)
1082 (point)))))
1084 (defun outline-headers-as-kill (beg end)
1085 "Save the visible outline headers in region at the start of the kill ring.
1087 Text shown between the headers isn't copied. Two newlines are
1088 inserted between saved headers. Yanking the result may be a
1089 convenient way to make a table of contents of the buffer."
1090 (interactive "r")
1091 (save-excursion
1092 (save-restriction
1093 (narrow-to-region beg end)
1094 (goto-char (point-min))
1095 (let ((buffer (current-buffer))
1096 start end)
1097 (with-temp-buffer
1098 (with-current-buffer buffer
1099 ;; Boundary condition: starting on heading:
1100 (when (outline-on-heading-p)
1101 (outline-back-to-heading)
1102 (setq start (point)
1103 end (progn (outline-end-of-heading)
1104 (point)))
1105 (insert-buffer-substring buffer start end)
1106 (insert "\n\n")))
1107 (let ((temp-buffer (current-buffer)))
1108 (with-current-buffer buffer
1109 (while (outline-next-heading)
1110 (unless (outline-invisible-p)
1111 (setq start (point)
1112 end (progn (outline-end-of-heading) (point)))
1113 (with-current-buffer temp-buffer
1114 (insert-buffer-substring buffer start end)
1115 (insert "\n\n"))))))
1116 (kill-new (buffer-string)))))))
1118 (provide 'outline)
1119 (provide 'noutline)
1121 ;;; outline.el ends here