Mercurial > emacs
annotate lisp/textmodes/outline.el @ 17909:7833700e2a35
thomas, not mib
author | Joel N. Weber II <devnull@gnu.org> |
---|---|
date | Wed, 21 May 1997 05:16:30 +0000 |
parents | 3af728d1f6cf |
children | 170b16201f82 |
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 | |
17687
e6d5322b810c
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17249
diff
changeset
|
42 in the file it applies to. See also outline-heading-end-regexp." |
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]+")) | |
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 | |
150 '(;; Highlight headings according to the level. | |
151 ("^\\(\\*+\\)[ \t]*\\(.+\\)?[ \t]*$" | |
152 (1 font-lock-string-face) | |
153 (2 (let ((len (- (match-end 1) (match-beginning 1)))) | |
154 (or (cdr (assq len '((1 . font-lock-function-name-face) | |
155 (2 . font-lock-keyword-face) | |
156 (3 . font-lock-comment-face)))) | |
157 font-lock-variable-name-face)) | |
158 nil t)) | |
14040 | 159 ;; Highlight citations of the form [1] and [Mar94]. |
10950 | 160 ("\\[\\([A-Z][A-Za-z]+\\)*[0-9]+\\]" . font-lock-type-face)) |
161 "Additional expressions to highlight in Outline mode.") | |
162 | |
13259
11899bfa541c
(outline-view-change-hook): New hook variable.
Richard M. Stallman <rms@gnu.org>
parents:
12604
diff
changeset
|
163 (defvar outline-view-change-hook nil |
11899bfa541c
(outline-view-change-hook): New hook variable.
Richard M. Stallman <rms@gnu.org>
parents:
12604
diff
changeset
|
164 "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
|
165 |
17688
b02bb31c98b0
(outline-mode): Autoload cookie added.
Richard M. Stallman <rms@gnu.org>
parents:
17687
diff
changeset
|
166 ;;;###autoload |
10950 | 167 (defun outline-mode () |
168 "Set major mode for editing outlines with selective display. | |
169 Headings are lines which start with asterisks: one for major headings, | |
170 two for subheadings, etc. Lines not starting with asterisks are body lines. | |
171 | |
172 Body text or subheadings under a heading can be made temporarily | |
173 invisible, or visible again. Invisible lines are attached to the end | |
174 of the heading, so they move with it, if the line is killed and yanked | |
175 back. A heading with text hidden under it is marked with an ellipsis (...). | |
176 | |
177 Commands:\\<outline-mode-map> | |
178 \\[outline-next-visible-heading] outline-next-visible-heading move by visible headings | |
179 \\[outline-previous-visible-heading] outline-previous-visible-heading | |
180 \\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings | |
181 \\[outline-backward-same-level] outline-backward-same-level | |
182 \\[outline-up-heading] outline-up-heading move from subheading to heading | |
183 | |
184 \\[hide-body] make all text invisible (not headings). | |
185 \\[show-all] make everything in buffer visible. | |
186 | |
187 The remaining commands are used when point is on a heading line. | |
188 They apply to some of the body or subheadings of that heading. | |
189 \\[hide-subtree] hide-subtree make body and subheadings invisible. | |
190 \\[show-subtree] show-subtree make body and subheadings visible. | |
191 \\[show-children] show-children make direct subheadings visible. | |
192 No effect on body, or subheadings 2 or more levels down. | |
193 With arg N, affects subheadings N levels down. | |
194 \\[hide-entry] make immediately following body invisible. | |
195 \\[show-entry] make it visible. | |
196 \\[hide-leaves] make body under heading and under its subheadings invisible. | |
197 The subheadings remain visible. | |
198 \\[show-branches] make all subheadings at all levels visible. | |
199 | |
200 The variable `outline-regexp' can be changed to control what is a heading. | |
201 A line is a heading if `outline-regexp' matches something at the | |
202 beginning of the line. The longer the match, the deeper the level. | |
203 | |
204 Turning on outline mode calls the value of `text-mode-hook' and then of | |
205 `outline-mode-hook', if they are non-nil." | |
206 (interactive) | |
207 (kill-all-local-variables) | |
208 (use-local-map outline-mode-map) | |
209 (setq mode-name "Outline") | |
210 (setq major-mode 'outline-mode) | |
211 (define-abbrev-table 'text-mode-abbrev-table ()) | |
212 (setq local-abbrev-table text-mode-abbrev-table) | |
213 (set-syntax-table text-mode-syntax-table) | |
214 (make-local-variable 'line-move-ignore-invisible) | |
215 (setq line-move-ignore-invisible t) | |
216 ;; 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
|
217 (add-to-invisibility-spec '(outline . t)) |
10950 | 218 (make-local-variable 'paragraph-start) |
219 (setq paragraph-start (concat paragraph-start "\\|\\(" | |
220 outline-regexp "\\)")) | |
221 ;; Inhibit auto-filling of header lines. | |
222 (make-local-variable 'auto-fill-inhibit-regexp) | |
223 (setq auto-fill-inhibit-regexp outline-regexp) | |
224 (make-local-variable 'paragraph-separate) | |
225 (setq paragraph-separate (concat paragraph-separate "\\|\\(" | |
226 outline-regexp "\\)")) | |
227 (make-local-variable 'font-lock-defaults) | |
228 (setq font-lock-defaults '(outline-font-lock-keywords t)) | |
229 (make-local-variable 'change-major-mode-hook) | |
230 (add-hook 'change-major-mode-hook 'show-all) | |
231 (run-hooks 'text-mode-hook 'outline-mode-hook)) | |
232 | |
17687
e6d5322b810c
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17249
diff
changeset
|
233 (defcustom outline-minor-mode-prefix "\C-c@" |
10950 | 234 "*Prefix key to use for Outline commands in Outline minor mode. |
235 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
|
236 After that, changing the prefix key requires manipulating keymaps." |
e6d5322b810c
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17249
diff
changeset
|
237 :type 'string |
e6d5322b810c
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17249
diff
changeset
|
238 :group 'outlines) |
10950 | 239 |
240 (defvar outline-minor-mode-map nil) | |
241 (if outline-minor-mode-map | |
242 nil | |
243 (setq outline-minor-mode-map (make-sparse-keymap)) | |
244 (define-key outline-minor-mode-map [menu-bar] | |
245 outline-mode-menu-bar-map) | |
246 (define-key outline-minor-mode-map outline-minor-mode-prefix | |
247 outline-mode-prefix-map)) | |
248 | |
249 (or (assq 'outline-minor-mode minor-mode-map-alist) | |
250 (setq minor-mode-map-alist | |
251 (cons (cons 'outline-minor-mode outline-minor-mode-map) | |
252 minor-mode-map-alist))) | |
253 | |
17688
b02bb31c98b0
(outline-mode): Autoload cookie added.
Richard M. Stallman <rms@gnu.org>
parents:
17687
diff
changeset
|
254 ;;;###autoload |
10950 | 255 (defun outline-minor-mode (&optional arg) |
256 "Toggle Outline minor mode. | |
257 With arg, turn Outline minor mode on if arg is positive, off otherwise. | |
258 See the command `outline-mode' for more information on this mode." | |
259 (interactive "P") | |
260 (setq outline-minor-mode | |
261 (if (null arg) (not outline-minor-mode) | |
262 (> (prefix-numeric-value arg) 0))) | |
263 (if outline-minor-mode | |
264 (progn | |
15518
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
265 (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
|
266 ;; 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
|
267 (add-hook 'change-major-mode-hook |
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
268 '(lambda () (outline-minor-mode -1)) |
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
269 nil t) |
10950 | 270 (make-local-variable 'line-move-ignore-invisible) |
271 (setq line-move-ignore-invisible t) | |
272 ;; 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
|
273 (add-to-invisibility-spec '(outline . t)) |
10998 | 274 (run-hooks 'outline-minor-mode-hook)) |
10950 | 275 (setq line-move-ignore-invisible nil) |
276 ;; 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
|
277 (remove-from-invisibility-spec '(outline . t))) |
10998 | 278 ;; When turning off outline mode, get rid of any outline hiding. |
10950 | 279 (or outline-minor-mode |
10998 | 280 (show-all)) |
11575
090333911dc8
(outline-minor-mode): Use force-mode-line-update.
Karl Heuer <kwzh@gnu.org>
parents:
11455
diff
changeset
|
281 (force-mode-line-update)) |
10950 | 282 |
17687
e6d5322b810c
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17249
diff
changeset
|
283 (defcustom outline-level 'outline-level |
e6d5322b810c
Use defgroup and defcustom.
Richard M. Stallman <rms@gnu.org>
parents:
17249
diff
changeset
|
284 "*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
|
285 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
|
286 :type 'function |
17690
3fa9da85b3ea
Fix customization change.
Richard M. Stallman <rms@gnu.org>
parents:
17688
diff
changeset
|
287 :group 'outlines) |
10950 | 288 |
289 ;; This used to count columns rather than characters, but that made ^L | |
290 ;; appear to be at level 2 instead of 1. Columns would be better for | |
291 ;; tab handling, but the default regexp doesn't use tabs, and anyone | |
292 ;; who changes the regexp can also redefine the outline-level variable | |
293 ;; as appropriate. | |
294 (defun outline-level () | |
295 "Return the depth to which a statement is nested in the outline. | |
296 Point must be at the beginning of a header line. This is actually | |
297 the number of characters that `outline-regexp' matches." | |
298 (save-excursion | |
299 (looking-at outline-regexp) | |
300 (- (match-end 0) (match-beginning 0)))) | |
301 | |
302 (defun outline-next-preface () | |
303 "Skip forward to just before the next heading line. | |
304 If there's no following heading line, stop before the newline | |
305 at the end of the buffer." | |
306 (if (re-search-forward (concat "\n\\(" outline-regexp "\\)") | |
307 nil 'move) | |
308 (goto-char (match-beginning 0))) | |
309 (if (bolp) | |
310 (forward-char -1))) | |
311 | |
312 (defun outline-next-heading () | |
313 "Move to the next (possibly invisible) heading line." | |
314 (interactive) | |
10998 | 315 (if (re-search-forward (concat "\n\\(" outline-regexp "\\)") |
10950 | 316 nil 'move) |
317 (goto-char (1+ (match-beginning 0))))) | |
318 | |
319 (defsubst outline-visible () | |
320 "Non-nil if the character after point is visible." | |
321 (not (get-char-property (point) 'invisible))) | |
322 | |
323 (defun outline-back-to-heading () | |
324 "Move to previous heading line, or beg of this line if it's a heading. | |
325 Only visible heading lines are considered." | |
326 (beginning-of-line) | |
327 (or (outline-on-heading-p) | |
328 (let (found) | |
15518
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
329 (save-excursion |
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
330 (while (not found) |
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
331 (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
|
332 nil t) |
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
333 (error "before first heading")) |
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
334 (setq found (and (outline-visible) (point))))) |
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
335 (goto-char found) |
d01e58c9e431
(outline-minor-mode): No longer permanent local.
Richard M. Stallman <rms@gnu.org>
parents:
15466
diff
changeset
|
336 found))) |
10950 | 337 |
338 (defun outline-on-heading-p () | |
339 "Return t if point is on a (visible) heading line." | |
340 (save-excursion | |
341 (beginning-of-line) | |
342 (and (bolp) (outline-visible) | |
343 (looking-at outline-regexp)))) | |
344 | |
345 (defun outline-end-of-heading () | |
346 (if (re-search-forward outline-heading-end-regexp nil 'move) | |
347 (forward-char -1))) | |
348 | |
349 (defun outline-next-visible-heading (arg) | |
350 "Move to the next visible heading line. | |
351 With argument, repeats or can move backward if negative. | |
352 A heading line is one that starts with a `*' (or that | |
353 `outline-regexp' matches)." | |
354 (interactive "p") | |
355 (if (< arg 0) | |
356 (beginning-of-line) | |
357 (end-of-line)) | |
12604
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
358 (while (and (not (bobp)) (< arg 0)) |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
359 (while (and (not (bobp)) |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
360 (re-search-backward (concat "^\\(" outline-regexp "\\)") |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
361 nil 'move) |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
362 (not (outline-visible)))) |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
363 (setq arg (1+ arg))) |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
364 (while (and (not (eobp)) (> arg 0)) |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
365 (while (and (not (eobp)) |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
366 (re-search-forward (concat "^\\(" outline-regexp "\\)") |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
367 nil 'move) |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
368 (not (outline-visible)))) |
140e46e751a0
(outline-next-visible-heading): Rewritten to handle
Richard M. Stallman <rms@gnu.org>
parents:
11736
diff
changeset
|
369 (setq arg (1- arg))) |
10950 | 370 (beginning-of-line)) |
371 | |
372 (defun outline-previous-visible-heading (arg) | |
373 "Move to the previous heading line. | |
374 With argument, repeats or can move forward if negative. | |
375 A heading line is one that starts with a `*' (or that | |
376 `outline-regexp' matches)." | |
377 (interactive "p") | |
378 (outline-next-visible-heading (- arg))) | |
379 | |
17249
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
380 (defun outline-mark-subtree () |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
381 "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
|
382 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
|
383 (interactive) |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
384 (let ((beg)) |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
385 (if (outline-on-heading-p) |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
386 ;; we are already looking at a heading |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
387 (beginning-of-line) |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
388 ;; else go back to previous heading |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
389 (outline-previous-visible-heading 1)) |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
390 (setq beg (point)) |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
391 (outline-end-of-subtree) |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
392 (push-mark (point)) |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
393 (goto-char beg))) |
2dfc334bdc6f
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
17248
diff
changeset
|
394 |
10950 | 395 (defun outline-flag-region (from to flag) |
396 "Hides or shows lines from FROM to TO, according to FLAG. | |
397 If FLAG is nil then text is shown, while if FLAG is t the text is hidden." | |
398 (let ((inhibit-read-only t)) | |
399 (save-excursion | |
400 (goto-char from) | |
401 (end-of-line) | |
10996
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
402 (outline-discard-overlays (point) to 'outline) |
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
403 (if flag |
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
404 (let ((o (make-overlay (point) to))) |
17853
3af728d1f6cf
(outline-mode): Use `add-to-invisibility-spec' and
Richard M. Stallman <rms@gnu.org>
parents:
17690
diff
changeset
|
405 (overlay-put o 'invisible 'outline) |
13259
11899bfa541c
(outline-view-change-hook): New hook variable.
Richard M. Stallman <rms@gnu.org>
parents:
12604
diff
changeset
|
406 (overlay-put o 'outline t))))) |
11899bfa541c
(outline-view-change-hook): New hook variable.
Richard M. Stallman <rms@gnu.org>
parents:
12604
diff
changeset
|
407 (run-hooks 'outline-view-change-hook)) |
10996
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
408 |
10998 | 409 ;; Exclude from the region BEG ... END all overlays |
410 ;; with a non-nil PROP property. | |
411 ;; Exclude them by shrinking them to exclude BEG ... END, | |
412 ;; or even by splitting them if necessary. | |
413 ;; 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
|
414 (defun outline-discard-overlays (beg end prop) |
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
415 (if (< end beg) |
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
416 (setq beg (prog1 end (setq end beg)))) |
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
417 (save-excursion |
16678
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
418 (let ((overlays (overlays-in beg end))) |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
419 (while overlays |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
420 (let ((o (car overlays))) |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
421 (if (overlay-get o prop) |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
422 ;; Either push this overlay outside beg...end |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
423 ;; or split it to exclude beg...end |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
424 ;; or delete it entirely (if it is contained in beg...end). |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
425 (if (< (overlay-start o) beg) |
10996
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
426 (if (> (overlay-end o) end) |
16678
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
427 (let ((o1 (outline-copy-overlay o))) |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
428 (move-overlay o1 (overlay-start o1) beg) |
17248
cf25d78ebd75
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
16678
diff
changeset
|
429 (move-overlay o end (overlay-end o))) |
cf25d78ebd75
(outline-discard-overlays): Fix the case
Richard M. Stallman <rms@gnu.org>
parents:
16678
diff
changeset
|
430 (move-overlay o (overlay-start o) beg)) |
16678
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
431 (if (> (overlay-end o) end) |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
432 (move-overlay o end (overlay-end o)) |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
433 (delete-overlay o))))) |
9785672a3b84
(outline-discard-overlays):
Richard M. Stallman <rms@gnu.org>
parents:
15518
diff
changeset
|
434 (setq overlays (cdr overlays)))))) |
10996
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
435 |
10998 | 436 ;; 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
|
437 (defun outline-copy-overlay (o) |
10998 | 438 (let ((o1 (make-overlay (overlay-start o) (overlay-end o) |
439 (overlay-buffer o))) | |
10996
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
440 (props (overlay-properties o))) |
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
441 (while props |
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
442 (overlay-put o1 (car props) (nth 1 props)) |
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
443 (setq props (cdr (cdr props)))) |
356f658dbd65
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10950
diff
changeset
|
444 o1)) |
10950 | 445 |
446 (defun hide-entry () | |
447 "Hide the body directly following this heading." | |
448 (interactive) | |
449 (outline-back-to-heading) | |
450 (outline-end-of-heading) | |
451 (save-excursion | |
452 (outline-flag-region (point) (progn (outline-next-preface) (point)) t))) | |
453 | |
454 (defun show-entry () | |
455 "Show the body directly following this heading." | |
456 (interactive) | |
457 (save-excursion | |
458 (outline-flag-region (point) (progn (outline-next-preface) (point)) nil))) | |
459 | |
460 (defun hide-body () | |
461 "Hide all of buffer except headings." | |
462 (interactive) | |
463 (hide-region-body (point-min) (point-max))) | |
464 | |
465 (defun hide-region-body (start end) | |
466 "Hide all body lines in the region, but not headings." | |
467 (save-excursion | |
468 (save-restriction | |
469 (narrow-to-region start end) | |
470 (goto-char (point-min)) | |
471 (if (outline-on-heading-p) | |
472 (outline-end-of-heading)) | |
473 (while (not (eobp)) | |
474 (outline-flag-region (point) | |
475 (progn (outline-next-preface) (point)) t) | |
476 (if (not (eobp)) | |
477 (progn | |
478 (forward-char | |
479 (if (looking-at "\n\n") | |
480 2 1)) | |
481 (outline-end-of-heading))))))) | |
482 | |
483 (defun show-all () | |
484 "Show all of the text in the buffer." | |
485 (interactive) | |
486 (outline-flag-region (point-min) (point-max) nil)) | |
487 | |
488 (defun hide-subtree () | |
489 "Hide everything after this heading at deeper levels." | |
490 (interactive) | |
491 (outline-flag-subtree t)) | |
492 | |
493 (defun hide-leaves () | |
494 "Hide all body after this heading at deeper levels." | |
495 (interactive) | |
496 (outline-back-to-heading) | |
497 (outline-end-of-heading) | |
498 (hide-region-body (point) (progn (outline-end-of-subtree) (point)))) | |
499 | |
500 (defun show-subtree () | |
501 "Show everything after this heading at deeper levels." | |
502 (interactive) | |
503 (outline-flag-subtree nil)) | |
504 | |
505 (defun hide-sublevels (levels) | |
506 "Hide everything but the top LEVELS levels of headers, in whole buffer." | |
507 (interactive "p") | |
508 (if (< levels 1) | |
509 (error "Must keep at least one level of headers")) | |
510 (setq levels (1- levels)) | |
511 (save-excursion | |
512 (goto-char (point-min)) | |
513 ;; Keep advancing to the next top-level heading. | |
514 (while (or (and (bobp) (outline-on-heading-p)) | |
515 (outline-next-heading)) | |
516 (let ((end (save-excursion (outline-end-of-subtree) (point)))) | |
517 ;; Hide everything under that. | |
518 (outline-flag-region (point) end t) | |
519 ;; Show the first LEVELS levels under that. | |
520 (if (> levels 0) | |
521 (show-children levels)) | |
522 ;; Move to the next, since we already found it. | |
523 (goto-char end))))) | |
524 | |
525 (defun hide-other () | |
526 "Hide everything except for the current body and the parent headings." | |
527 (interactive) | |
528 (hide-sublevels 1) | |
529 (let ((last (point)) | |
530 (pos (point))) | |
531 (while (save-excursion | |
532 (and (end-of-line 0) | |
533 (not (outline-visible)))) | |
534 (save-excursion | |
535 (beginning-of-line) | |
536 (if (eq last (point)) | |
537 (progn | |
538 (outline-next-heading) | |
539 (outline-flag-region last (point) nil)) | |
540 (show-children) | |
541 (setq last (point))))))) | |
542 | |
543 (defun outline-flag-subtree (flag) | |
544 (save-excursion | |
545 (outline-back-to-heading) | |
546 (outline-end-of-heading) | |
547 (outline-flag-region (point) | |
548 (progn (outline-end-of-subtree) (point)) | |
549 flag))) | |
550 | |
551 (defun outline-end-of-subtree () | |
552 (outline-back-to-heading) | |
553 (let ((opoint (point)) | |
554 (first t) | |
555 (level (funcall outline-level))) | |
556 (while (and (not (eobp)) | |
557 (or first (> (funcall outline-level) level))) | |
558 (setq first nil) | |
559 (outline-next-heading)) | |
560 (if (bolp) | |
561 (progn | |
562 ;; Go to end of line before heading | |
563 (forward-char -1) | |
564 (if (bolp) | |
565 ;; leave blank line before heading | |
566 (forward-char -1)))))) | |
567 | |
568 (defun show-branches () | |
569 "Show all subheadings of this heading, but not their bodies." | |
570 (interactive) | |
571 (show-children 1000)) | |
572 | |
573 (defun show-children (&optional level) | |
574 "Show all direct subheadings of this heading. | |
575 Prefix arg LEVEL is how many levels below the current level should be shown. | |
576 Default is enough to cause the following heading to appear." | |
577 (interactive "P") | |
578 (setq level | |
579 (if level (prefix-numeric-value level) | |
580 (save-excursion | |
581 (outline-back-to-heading) | |
582 (let ((start-level (funcall outline-level))) | |
583 (outline-next-heading) | |
584 (if (eobp) | |
585 1 | |
586 (max 1 (- (funcall outline-level) start-level))))))) | |
587 (save-excursion | |
588 (save-restriction | |
589 (outline-back-to-heading) | |
590 (setq level (+ level (funcall outline-level))) | |
591 (narrow-to-region (point) | |
592 (progn (outline-end-of-subtree) | |
593 (if (eobp) (point-max) (1+ (point))))) | |
594 (goto-char (point-min)) | |
595 (while (and (not (eobp)) | |
596 (progn | |
597 (outline-next-heading) | |
598 (not (eobp)))) | |
599 (if (<= (funcall outline-level) level) | |
600 (save-excursion | |
601 (outline-flag-region (save-excursion | |
602 (forward-char -1) | |
603 (if (bolp) | |
604 (forward-char -1)) | |
605 (point)) | |
606 (progn (outline-end-of-heading) (point)) | |
607 nil))))))) | |
608 | |
609 (defun outline-up-heading (arg) | |
610 "Move to the heading line of which the present line is a subheading. | |
611 With argument, move up ARG levels." | |
612 (interactive "p") | |
613 (outline-back-to-heading) | |
614 (if (eq (funcall outline-level) 1) | |
15466
5affe3230dfb
(outline-up-heading): Fix error message.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
615 (error "Already at top level of the outline")) |
10950 | 616 (while (and (> (funcall outline-level) 1) |
617 (> arg 0) | |
618 (not (bobp))) | |
619 (let ((present-level (funcall outline-level))) | |
620 (while (not (< (funcall outline-level) present-level)) | |
621 (outline-previous-visible-heading 1)) | |
622 (setq arg (- arg 1))))) | |
623 | |
624 (defun outline-forward-same-level (arg) | |
625 "Move forward to the ARG'th subheading at same level as this one. | |
626 Stop at the first and last subheadings of a superior heading." | |
627 (interactive "p") | |
628 (outline-back-to-heading) | |
629 (while (> arg 0) | |
630 (let ((point-to-move-to (save-excursion | |
631 (outline-get-next-sibling)))) | |
632 (if point-to-move-to | |
633 (progn | |
634 (goto-char point-to-move-to) | |
635 (setq arg (1- arg))) | |
636 (progn | |
637 (setq arg 0) | |
15466
5affe3230dfb
(outline-up-heading): Fix error message.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
638 (error "No following same-level heading")))))) |
10950 | 639 |
640 (defun outline-get-next-sibling () | |
641 "Move to next heading of the same level, and return point or nil if none." | |
642 (let ((level (funcall outline-level))) | |
643 (outline-next-visible-heading 1) | |
644 (while (and (> (funcall outline-level) level) | |
645 (not (eobp))) | |
646 (outline-next-visible-heading 1)) | |
647 (if (< (funcall outline-level) level) | |
648 nil | |
649 (point)))) | |
650 | |
651 (defun outline-backward-same-level (arg) | |
652 "Move backward to the ARG'th subheading at same level as this one. | |
653 Stop at the first and last subheadings of a superior heading." | |
654 (interactive "p") | |
655 (outline-back-to-heading) | |
656 (while (> arg 0) | |
657 (let ((point-to-move-to (save-excursion | |
658 (outline-get-last-sibling)))) | |
659 (if point-to-move-to | |
660 (progn | |
661 (goto-char point-to-move-to) | |
662 (setq arg (1- arg))) | |
663 (progn | |
664 (setq arg 0) | |
15466
5affe3230dfb
(outline-up-heading): Fix error message.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
665 (error "No previous same-level heading")))))) |
10950 | 666 |
667 (defun outline-get-last-sibling () | |
668 "Move to next heading of the same level, and return point or nil if none." | |
669 (let ((level (funcall outline-level))) | |
670 (outline-previous-visible-heading 1) | |
671 (while (and (> (funcall outline-level) level) | |
672 (not (bobp))) | |
673 (outline-previous-visible-heading 1)) | |
674 (if (< (funcall outline-level) level) | |
675 nil | |
676 (point)))) | |
677 | |
678 (provide 'outline) | |
11736
07ac8009368c
Provide noutline as well as outline.
Richard M. Stallman <rms@gnu.org>
parents:
11713
diff
changeset
|
679 (provide 'noutline) |
10950 | 680 |
681 ;;; outline.el ends here |