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