annotate lisp/textmodes/outline.el @ 14108:cab8d383f10d

(easy-menu-define): Doc fix.
author Karl Heuer <kwzh@gnu.org>
date Tue, 09 Jan 1996 23:16:13 +0000
parents 187735b53d52
children 83f275dcd93a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 ;;; outline.el --- outline mode commands for Emacs
11713
5306e71f486c All autoload cookies disabled.
Richard M. Stallman <rms@gnu.org>
parents: 11647
diff changeset
2 ;; Copyright (C) 1986, 1993, 1994, 1995 Free Software Foundation, Inc.
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4 ;; Maintainer: FSF
11455
4235784197f3 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 10998
diff changeset
5 ;; Keywords: outlines
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 ;; This file is part of GNU Emacs.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 ;; it under the terms of the GNU General Public License as published by
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; the Free Software Foundation; either version 2, or (at your option)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; any later version.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; GNU Emacs is distributed in the hope that it will be useful,
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; GNU General Public License for more details.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; You should have received a copy of the GNU General Public License
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; along with GNU Emacs; see the file COPYING. If not, write to
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 ;;; Commentary:
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 ;; This package is a major mode for editing outline-format documents.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 ;; An outline can be `abstracted' to show headers at any given level,
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 ;; with all stuff below hidden. See the Emacs manual for details.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;;; Code:
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;; Jan '86, Some new features added by Peter Desnoyers and rewritten by RMS.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 (defvar outline-regexp nil
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 "*Regular expression to match the beginning of a heading.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 Any line whose beginning matches this regexp is considered to start a heading.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 The recommended way to set this is with a Local Variables: list
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 in the file it applies to. See also outline-heading-end-regexp.")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 ;; Can't initialize this in the defvar above -- some major modes have
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 ;; already assigned a local value to it.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 (or (default-value 'outline-regexp)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 (setq-default outline-regexp "[*\^L]+"))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 (defvar outline-heading-end-regexp "\n"
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 "*Regular expression to match the end of a heading line.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 You can assume that point is at the beginning of a heading when this
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 regexp is searched for. The heading ends at the end of the match.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 The recommended way to set this is with a `Local Variables:' list
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 in the file it applies to.")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 (defvar outline-mode-prefix-map nil)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 (if outline-mode-prefix-map
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 nil
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 (setq outline-mode-prefix-map (make-sparse-keymap))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 (define-key outline-mode-prefix-map "\C-n" 'outline-next-visible-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 (define-key outline-mode-prefix-map "\C-p" 'outline-previous-visible-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 (define-key outline-mode-prefix-map "\C-i" 'show-children)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 (define-key outline-mode-prefix-map "\C-s" 'show-subtree)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 (define-key outline-mode-prefix-map "\C-d" 'hide-subtree)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 (define-key outline-mode-prefix-map "\C-u" 'outline-up-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 (define-key outline-mode-prefix-map "\C-f" 'outline-forward-same-level)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 (define-key outline-mode-prefix-map "\C-b" 'outline-backward-same-level)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 (define-key outline-mode-prefix-map "\C-t" 'hide-body)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 (define-key outline-mode-prefix-map "\C-a" 'show-all)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 (define-key outline-mode-prefix-map "\C-c" 'hide-entry)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 (define-key outline-mode-prefix-map "\C-e" 'show-entry)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 (define-key outline-mode-prefix-map "\C-l" 'hide-leaves)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 (define-key outline-mode-prefix-map "\C-k" 'show-branches)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 (define-key outline-mode-prefix-map "\C-q" 'hide-sublevels)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 (define-key outline-mode-prefix-map "\C-o" 'hide-other))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 (defvar outline-mode-menu-bar-map nil)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 (if outline-mode-menu-bar-map
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 nil
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 (setq outline-mode-menu-bar-map (make-sparse-keymap))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78 (define-key outline-mode-menu-bar-map [hide]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 (cons "Hide" (make-sparse-keymap "Hide")))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 (define-key outline-mode-menu-bar-map [hide hide-other]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82 '("Hide Other" . hide-other))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 (define-key outline-mode-menu-bar-map [hide hide-sublevels]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 '("Hide Sublevels" . hide-sublevels))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 (define-key outline-mode-menu-bar-map [hide hide-subtree]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 '("Hide Subtree" . hide-subtree))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 (define-key outline-mode-menu-bar-map [hide hide-entry]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 '("Hide Entry" . hide-entry))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
89 (define-key outline-mode-menu-bar-map [hide hide-body]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 '("Hide Body" . hide-body))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91 (define-key outline-mode-menu-bar-map [hide hide-leaves]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92 '("Hide Leaves" . hide-leaves))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 (define-key outline-mode-menu-bar-map [show]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 (cons "Show" (make-sparse-keymap "Show")))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 (define-key outline-mode-menu-bar-map [show show-subtree]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 '("Show Subtree" . show-subtree))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 (define-key outline-mode-menu-bar-map [show show-children]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100 '("Show Children" . show-children))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 (define-key outline-mode-menu-bar-map [show show-branches]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 '("Show Branches" . show-branches))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 (define-key outline-mode-menu-bar-map [show show-entry]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 '("Show Entry" . show-entry))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 (define-key outline-mode-menu-bar-map [show show-all]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 '("Show All" . show-all))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108 (define-key outline-mode-menu-bar-map [headings]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109 (cons "Headings" (make-sparse-keymap "Headings")))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111 (define-key outline-mode-menu-bar-map [headings outline-backward-same-level]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 '("Previous Same Level" . outline-backward-same-level))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 (define-key outline-mode-menu-bar-map [headings outline-forward-same-level]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 '("Next Same Level" . outline-forward-same-level))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 (define-key outline-mode-menu-bar-map [headings outline-previous-visible-heading]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116 '("Previous" . outline-previous-visible-heading))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117 (define-key outline-mode-menu-bar-map [headings outline-next-visible-heading]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118 '("Next" . outline-next-visible-heading))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 (define-key outline-mode-menu-bar-map [headings outline-up-heading]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 '("Up" . outline-up-heading)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 (defvar outline-mode-map nil "")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 (if outline-mode-map
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 nil
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 (setq outline-mode-map (nconc (make-sparse-keymap) text-mode-map))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 (define-key outline-mode-map "\C-c" outline-mode-prefix-map)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128 (define-key outline-mode-map [menu-bar] outline-mode-menu-bar-map))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130 (defvar outline-minor-mode nil
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131 "Non-nil if using Outline mode as a minor mode of some other mode.")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132 (make-variable-buffer-local 'outline-minor-mode)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 (put 'outline-minor-mode 'permanent-local t)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134 (or (assq 'outline-minor-mode minor-mode-alist)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 (setq minor-mode-alist (append minor-mode-alist
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 (list '(outline-minor-mode " Outl")))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 (defvar outline-font-lock-keywords
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 '(;; Highlight headings according to the level.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 ("^\\(\\*+\\)[ \t]*\\(.+\\)?[ \t]*$"
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 (1 font-lock-string-face)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 (2 (let ((len (- (match-end 1) (match-beginning 1))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 (or (cdr (assq len '((1 . font-lock-function-name-face)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 (2 . font-lock-keyword-face)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 (3 . font-lock-comment-face))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 font-lock-variable-name-face))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147 nil t))
14040
187735b53d52 Comment fixes.
Karl Heuer <kwzh@gnu.org>
parents: 13259
diff changeset
148 ;; Highlight citations of the form [1] and [Mar94].
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
149 ("\\[\\([A-Z][A-Za-z]+\\)*[0-9]+\\]" . font-lock-type-face))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
150 "Additional expressions to highlight in Outline mode.")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
151
13259
11899bfa541c (outline-view-change-hook): New hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 12604
diff changeset
152 (defvar outline-view-change-hook nil
11899bfa541c (outline-view-change-hook): New hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 12604
diff changeset
153 "Normal hook to be run after outline visibility changes.")
11899bfa541c (outline-view-change-hook): New hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 12604
diff changeset
154
11713
5306e71f486c All autoload cookies disabled.
Richard M. Stallman <rms@gnu.org>
parents: 11647
diff changeset
155 ;;;autoload
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
156 (defun outline-mode ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
157 "Set major mode for editing outlines with selective display.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
158 Headings are lines which start with asterisks: one for major headings,
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
159 two for subheadings, etc. Lines not starting with asterisks are body lines.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
160
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
161 Body text or subheadings under a heading can be made temporarily
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
162 invisible, or visible again. Invisible lines are attached to the end
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
163 of the heading, so they move with it, if the line is killed and yanked
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
164 back. A heading with text hidden under it is marked with an ellipsis (...).
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
165
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
166 Commands:\\<outline-mode-map>
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
167 \\[outline-next-visible-heading] outline-next-visible-heading move by visible headings
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
168 \\[outline-previous-visible-heading] outline-previous-visible-heading
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
169 \\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
170 \\[outline-backward-same-level] outline-backward-same-level
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
171 \\[outline-up-heading] outline-up-heading move from subheading to heading
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
172
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
173 \\[hide-body] make all text invisible (not headings).
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
174 \\[show-all] make everything in buffer visible.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
175
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
176 The remaining commands are used when point is on a heading line.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
177 They apply to some of the body or subheadings of that heading.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
178 \\[hide-subtree] hide-subtree make body and subheadings invisible.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
179 \\[show-subtree] show-subtree make body and subheadings visible.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
180 \\[show-children] show-children make direct subheadings visible.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 No effect on body, or subheadings 2 or more levels down.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182 With arg N, affects subheadings N levels down.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183 \\[hide-entry] make immediately following body invisible.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184 \\[show-entry] make it visible.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 \\[hide-leaves] make body under heading and under its subheadings invisible.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186 The subheadings remain visible.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
187 \\[show-branches] make all subheadings at all levels visible.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 The variable `outline-regexp' can be changed to control what is a heading.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190 A line is a heading if `outline-regexp' matches something at the
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191 beginning of the line. The longer the match, the deeper the level.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 Turning on outline mode calls the value of `text-mode-hook' and then of
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194 `outline-mode-hook', if they are non-nil."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196 (kill-all-local-variables)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 (use-local-map outline-mode-map)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198 (setq mode-name "Outline")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
199 (setq major-mode 'outline-mode)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200 (define-abbrev-table 'text-mode-abbrev-table ())
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
201 (setq local-abbrev-table text-mode-abbrev-table)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 (set-syntax-table text-mode-syntax-table)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 (make-local-variable 'line-move-ignore-invisible)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 (setq line-move-ignore-invisible t)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 ;; Cause use of ellipses for invisible text.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
206 (setq buffer-invisibility-spec '((t . t)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207 (make-local-variable 'paragraph-start)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
208 (setq paragraph-start (concat paragraph-start "\\|\\("
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
209 outline-regexp "\\)"))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210 ;; Inhibit auto-filling of header lines.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
211 (make-local-variable 'auto-fill-inhibit-regexp)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212 (setq auto-fill-inhibit-regexp outline-regexp)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213 (make-local-variable 'paragraph-separate)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
214 (setq paragraph-separate (concat paragraph-separate "\\|\\("
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215 outline-regexp "\\)"))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216 (make-local-variable 'font-lock-defaults)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217 (setq font-lock-defaults '(outline-font-lock-keywords t))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218 (make-local-variable 'change-major-mode-hook)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 (add-hook 'change-major-mode-hook 'show-all)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220 (run-hooks 'text-mode-hook 'outline-mode-hook))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221
11647
290970a12db9 (outline-minor-mode-prefix): Change to C-c @.
Richard M. Stallman <rms@gnu.org>
parents: 11575
diff changeset
222 (defvar outline-minor-mode-prefix "\C-c@"
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223 "*Prefix key to use for Outline commands in Outline minor mode.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 The value of this variable is checked as part of loading Outline mode.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 After that, changing the prefix key requires manipulating keymaps.")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
227 (defvar outline-minor-mode-map nil)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
228 (if outline-minor-mode-map
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
229 nil
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
230 (setq outline-minor-mode-map (make-sparse-keymap))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231 (define-key outline-minor-mode-map [menu-bar]
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 outline-mode-menu-bar-map)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233 (define-key outline-minor-mode-map outline-minor-mode-prefix
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 outline-mode-prefix-map))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
235
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
236 (or (assq 'outline-minor-mode minor-mode-map-alist)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
237 (setq minor-mode-map-alist
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238 (cons (cons 'outline-minor-mode outline-minor-mode-map)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239 minor-mode-map-alist)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
240
11713
5306e71f486c All autoload cookies disabled.
Richard M. Stallman <rms@gnu.org>
parents: 11647
diff changeset
241 ;;;autoload
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
242 (defun outline-minor-mode (&optional arg)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
243 "Toggle Outline minor mode.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
244 With arg, turn Outline minor mode on if arg is positive, off otherwise.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
245 See the command `outline-mode' for more information on this mode."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
246 (interactive "P")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
247 (setq outline-minor-mode
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
248 (if (null arg) (not outline-minor-mode)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
249 (> (prefix-numeric-value arg) 0)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
250 (if outline-minor-mode
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
251 (progn
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
252 (make-local-variable 'line-move-ignore-invisible)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
253 (setq line-move-ignore-invisible t)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
254 ;; Cause use of ellipses for invisible text.
10998
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
255 (setq buffer-invisibility-spec '((t . t)))
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
256 (run-hooks 'outline-minor-mode-hook))
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
257 (setq line-move-ignore-invisible nil)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
258 ;; Cause use of ellipses for invisible text.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259 (setq buffer-invisibility-spec t))
10998
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
260 ;; When turning off outline mode, get rid of any outline hiding.
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261 (or outline-minor-mode
10998
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
262 (show-all))
11575
090333911dc8 (outline-minor-mode): Use force-mode-line-update.
Karl Heuer <kwzh@gnu.org>
parents: 11455
diff changeset
263 (force-mode-line-update))
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 (defvar outline-level 'outline-level
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266 "Function of no args to compute a header's nesting level in an outline.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267 It can assume point is at the beginning of a header line.")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
269 ;; This used to count columns rather than characters, but that made ^L
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
270 ;; appear to be at level 2 instead of 1. Columns would be better for
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
271 ;; tab handling, but the default regexp doesn't use tabs, and anyone
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
272 ;; who changes the regexp can also redefine the outline-level variable
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
273 ;; as appropriate.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
274 (defun outline-level ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
275 "Return the depth to which a statement is nested in the outline.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276 Point must be at the beginning of a header line. This is actually
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
277 the number of characters that `outline-regexp' matches."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
278 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
279 (looking-at outline-regexp)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
280 (- (match-end 0) (match-beginning 0))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
282 (defun outline-next-preface ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
283 "Skip forward to just before the next heading line.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
284 If there's no following heading line, stop before the newline
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
285 at the end of the buffer."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
286 (if (re-search-forward (concat "\n\\(" outline-regexp "\\)")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
287 nil 'move)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
288 (goto-char (match-beginning 0)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
289 (if (bolp)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
290 (forward-char -1)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
291
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
292 (defun outline-next-heading ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
293 "Move to the next (possibly invisible) heading line."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
294 (interactive)
10998
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
295 (if (re-search-forward (concat "\n\\(" outline-regexp "\\)")
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
296 nil 'move)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
297 (goto-char (1+ (match-beginning 0)))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
298
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
299 (defsubst outline-visible ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
300 "Non-nil if the character after point is visible."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
301 (not (get-char-property (point) 'invisible)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
302
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
303 (defun outline-back-to-heading ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
304 "Move to previous heading line, or beg of this line if it's a heading.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
305 Only visible heading lines are considered."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
306 (beginning-of-line)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
307 (or (outline-on-heading-p)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
308 (let (found)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
309 (while (not found)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
310 (setq found
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
311 (and (re-search-backward (concat "^\\(" outline-regexp "\\)")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
312 nil t)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
313 (outline-visible))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
314 found)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
315 (error "before first heading")))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
316
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
317 (defun outline-on-heading-p ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
318 "Return t if point is on a (visible) heading line."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
319 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
320 (beginning-of-line)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
321 (and (bolp) (outline-visible)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
322 (looking-at outline-regexp))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
323
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
324 (defun outline-end-of-heading ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
325 (if (re-search-forward outline-heading-end-regexp nil 'move)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
326 (forward-char -1)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
327
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
328 (defun outline-next-visible-heading (arg)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
329 "Move to the next visible heading line.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
330 With argument, repeats or can move backward if negative.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
331 A heading line is one that starts with a `*' (or that
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
332 `outline-regexp' matches)."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
333 (interactive "p")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
334 (if (< arg 0)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
335 (beginning-of-line)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
336 (end-of-line))
12604
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
337 (while (and (not (bobp)) (< arg 0))
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
338 (while (and (not (bobp))
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
339 (re-search-backward (concat "^\\(" outline-regexp "\\)")
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
340 nil 'move)
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
341 (not (outline-visible))))
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
342 (setq arg (1+ arg)))
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
343 (while (and (not (eobp)) (> arg 0))
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
344 (while (and (not (eobp))
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
345 (re-search-forward (concat "^\\(" outline-regexp "\\)")
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
346 nil 'move)
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
347 (not (outline-visible))))
140e46e751a0 (outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents: 11736
diff changeset
348 (setq arg (1- arg)))
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 (beginning-of-line))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
350
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351 (defun outline-previous-visible-heading (arg)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352 "Move to the previous heading line.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 With argument, repeats or can move forward if negative.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354 A heading line is one that starts with a `*' (or that
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
355 `outline-regexp' matches)."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
356 (interactive "p")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
357 (outline-next-visible-heading (- arg)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
358
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 (defun outline-flag-region (from to flag)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
360 "Hides or shows lines from FROM to TO, according to FLAG.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
361 If FLAG is nil then text is shown, while if FLAG is t the text is hidden."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362 (let ((inhibit-read-only t))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364 (goto-char from)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 (end-of-line)
10996
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
366 (outline-discard-overlays (point) to 'outline)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
367 (if flag
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
368 (let ((o (make-overlay (point) to)))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
369 (overlay-put o 'invisible flag)
13259
11899bfa541c (outline-view-change-hook): New hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 12604
diff changeset
370 (overlay-put o 'outline t)))))
11899bfa541c (outline-view-change-hook): New hook variable.
Richard M. Stallman <rms@gnu.org>
parents: 12604
diff changeset
371 (run-hooks 'outline-view-change-hook))
10996
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
372
10998
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
373 ;; Exclude from the region BEG ... END all overlays
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
374 ;; with a non-nil PROP property.
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
375 ;; Exclude them by shrinking them to exclude BEG ... END,
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
376 ;; or even by splitting them if necessary.
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
377 ;; Overlays without a non-nil PROP property are not touched.
10996
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
378 (defun outline-discard-overlays (beg end prop)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
379 (if (< end beg)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
380 (setq beg (prog1 end (setq end beg))))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
381 (save-excursion
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
382 (goto-char beg)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
383 (while (< (point) end)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
384 (let ((overlays (overlays-at (point))))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
385 (while overlays
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
386 (let ((o (car overlays)))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
387 (if (overlay-get o prop)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
388 ;; Either push this overlay outside beg...end
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
389 ;; or split it to exclude beg...end
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
390 ;; or delete it entirely (if it is contained in beg...end).
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
391 (if (< (overlay-start o) beg)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
392 (if (> (overlay-end o) end)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
393 (let ((o1 (outline-copy-overlay o)))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
394 (move-overlay o1 (overlay-start o1) beg)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
395 (move-overlay o (overlay-start o) beg)))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
396 (if (> (overlay-end o) end)
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
397 (move-overlay o end (overlay-end o))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
398 (delete-overlay o)))))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
399 (setq overlays (cdr overlays))))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
400 (goto-char (next-overlay-change (point))))))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
401
10998
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
402 ;; Make a copy of overlay O, with the same beginning, end and properties.
10996
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
403 (defun outline-copy-overlay (o)
10998
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
404 (let ((o1 (make-overlay (overlay-start o) (overlay-end o)
2c184ff2351d entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 10996
diff changeset
405 (overlay-buffer o)))
10996
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
406 (props (overlay-properties o)))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
407 (while props
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
408 (overlay-put o1 (car props) (nth 1 props))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
409 (setq props (cdr (cdr props))))
356f658dbd65 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10950
diff changeset
410 o1))
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 (defun hide-entry ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 "Hide the body directly following this heading."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 (outline-back-to-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416 (outline-end-of-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
418 (outline-flag-region (point) (progn (outline-next-preface) (point)) t)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
420 (defun show-entry ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
421 "Show the body directly following this heading."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
422 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
423 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424 (outline-flag-region (point) (progn (outline-next-preface) (point)) nil)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
426 (defun hide-body ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
427 "Hide all of buffer except headings."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
428 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
429 (hide-region-body (point-min) (point-max)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
430
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
431 (defun hide-region-body (start end)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
432 "Hide all body lines in the region, but not headings."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
433 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
434 (save-restriction
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
435 (narrow-to-region start end)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
436 (goto-char (point-min))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
437 (if (outline-on-heading-p)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
438 (outline-end-of-heading))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
439 (while (not (eobp))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
440 (outline-flag-region (point)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
441 (progn (outline-next-preface) (point)) t)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
442 (if (not (eobp))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443 (progn
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
444 (forward-char
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
445 (if (looking-at "\n\n")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
446 2 1))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
447 (outline-end-of-heading)))))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
448
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
449 (defun show-all ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
450 "Show all of the text in the buffer."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
451 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
452 (outline-flag-region (point-min) (point-max) nil))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
453
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
454 (defun hide-subtree ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
455 "Hide everything after this heading at deeper levels."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
456 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
457 (outline-flag-subtree t))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
458
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
459 (defun hide-leaves ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
460 "Hide all body after this heading at deeper levels."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
461 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
462 (outline-back-to-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
463 (outline-end-of-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
464 (hide-region-body (point) (progn (outline-end-of-subtree) (point))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
465
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
466 (defun show-subtree ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
467 "Show everything after this heading at deeper levels."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
469 (outline-flag-subtree nil))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
470
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 (defun hide-sublevels (levels)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472 "Hide everything but the top LEVELS levels of headers, in whole buffer."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 (interactive "p")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474 (if (< levels 1)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
475 (error "Must keep at least one level of headers"))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476 (setq levels (1- levels))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
478 (goto-char (point-min))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 ;; Keep advancing to the next top-level heading.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480 (while (or (and (bobp) (outline-on-heading-p))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481 (outline-next-heading))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
482 (let ((end (save-excursion (outline-end-of-subtree) (point))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
483 ;; Hide everything under that.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
484 (outline-flag-region (point) end t)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
485 ;; Show the first LEVELS levels under that.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
486 (if (> levels 0)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
487 (show-children levels))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
488 ;; Move to the next, since we already found it.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
489 (goto-char end)))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
490
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491 (defun hide-other ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 "Hide everything except for the current body and the parent headings."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
493 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494 (hide-sublevels 1)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495 (let ((last (point))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
496 (pos (point)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
497 (while (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498 (and (end-of-line 0)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499 (not (outline-visible))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501 (beginning-of-line)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502 (if (eq last (point))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
503 (progn
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
504 (outline-next-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
505 (outline-flag-region last (point) nil))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
506 (show-children)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507 (setq last (point)))))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
508
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
509 (defun outline-flag-subtree (flag)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
510 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511 (outline-back-to-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 (outline-end-of-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 (outline-flag-region (point)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 (progn (outline-end-of-subtree) (point))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515 flag)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
516
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
517 (defun outline-end-of-subtree ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518 (outline-back-to-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
519 (let ((opoint (point))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520 (first t)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
521 (level (funcall outline-level)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522 (while (and (not (eobp))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
523 (or first (> (funcall outline-level) level)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
524 (setq first nil)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
525 (outline-next-heading))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526 (if (bolp)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527 (progn
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528 ;; Go to end of line before heading
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529 (forward-char -1)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 (if (bolp)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531 ;; leave blank line before heading
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 (forward-char -1))))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 (defun show-branches ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 "Show all subheadings of this heading, but not their bodies."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 (interactive)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 (show-children 1000))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 (defun show-children (&optional level)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 "Show all direct subheadings of this heading.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541 Prefix arg LEVEL is how many levels below the current level should be shown.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542 Default is enough to cause the following heading to appear."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 (interactive "P")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 (setq level
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545 (if level (prefix-numeric-value level)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547 (outline-back-to-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 (let ((start-level (funcall outline-level)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 (outline-next-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 (if (eobp)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 1
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
552 (max 1 (- (funcall outline-level) start-level)))))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
553 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
554 (save-restriction
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
555 (outline-back-to-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
556 (setq level (+ level (funcall outline-level)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557 (narrow-to-region (point)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
558 (progn (outline-end-of-subtree)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
559 (if (eobp) (point-max) (1+ (point)))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 (goto-char (point-min))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561 (while (and (not (eobp))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562 (progn
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563 (outline-next-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564 (not (eobp))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565 (if (<= (funcall outline-level) level)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 (outline-flag-region (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 (forward-char -1)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569 (if (bolp)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 (forward-char -1))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
571 (point))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
572 (progn (outline-end-of-heading) (point))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
573 nil)))))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
574
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575 (defun outline-up-heading (arg)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
576 "Move to the heading line of which the present line is a subheading.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
577 With argument, move up ARG levels."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
578 (interactive "p")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579 (outline-back-to-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580 (if (eq (funcall outline-level) 1)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581 (error ""))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 (while (and (> (funcall outline-level) 1)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583 (> arg 0)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584 (not (bobp)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
585 (let ((present-level (funcall outline-level)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
586 (while (not (< (funcall outline-level) present-level))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587 (outline-previous-visible-heading 1))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 (setq arg (- arg 1)))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590 (defun outline-forward-same-level (arg)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591 "Move forward to the ARG'th subheading at same level as this one.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592 Stop at the first and last subheadings of a superior heading."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593 (interactive "p")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
594 (outline-back-to-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595 (while (> arg 0)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 (let ((point-to-move-to (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
597 (outline-get-next-sibling))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
598 (if point-to-move-to
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
599 (progn
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
600 (goto-char point-to-move-to)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601 (setq arg (1- arg)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602 (progn
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603 (setq arg 0)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604 (error ""))))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606 (defun outline-get-next-sibling ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 "Move to next heading of the same level, and return point or nil if none."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 (let ((level (funcall outline-level)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609 (outline-next-visible-heading 1)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 (while (and (> (funcall outline-level) level)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611 (not (eobp)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 (outline-next-visible-heading 1))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 (if (< (funcall outline-level) level)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 nil
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
615 (point))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617 (defun outline-backward-same-level (arg)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
618 "Move backward to the ARG'th subheading at same level as this one.
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619 Stop at the first and last subheadings of a superior heading."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 (interactive "p")
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
621 (outline-back-to-heading)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 (while (> arg 0)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
623 (let ((point-to-move-to (save-excursion
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
624 (outline-get-last-sibling))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
625 (if point-to-move-to
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626 (progn
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
627 (goto-char point-to-move-to)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628 (setq arg (1- arg)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
629 (progn
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
630 (setq arg 0)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
631 (error ""))))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633 (defun outline-get-last-sibling ()
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
634 "Move to next heading of the same level, and return point or nil if none."
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635 (let ((level (funcall outline-level)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636 (outline-previous-visible-heading 1)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 (while (and (> (funcall outline-level) level)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638 (not (bobp)))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 (outline-previous-visible-heading 1))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 (if (< (funcall outline-level) level)
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641 nil
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642 (point))))
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
644 (provide 'outline)
11736
07ac8009368c Provide noutline as well as outline.
Richard M. Stallman <rms@gnu.org>
parents: 11713
diff changeset
645 (provide 'noutline)
10950
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
646
d1990c517cc9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
647 ;;; outline.el ends here