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