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