Mercurial > emacs
annotate lisp/outline.el @ 75465:34448acdaf7e
Initial version.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Sun, 28 Jan 2007 02:51:26 +0000 |
parents | 6e4c04850090 |
children | 00669875e4fe f83d17e1ace6 |
rev | line source |
---|---|
51347 | 1 ;;; outline.el --- outline mode commands for Emacs |
2 | |
64762
41bb365f41c4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64091
diff
changeset
|
3 ;; Copyright (C) 1986, 1993, 1994, 1995, 1997, 2000, 2001, 2002, |
75347 | 4 ;; 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
51347 | 5 |
6 ;; Maintainer: FSF | |
7 ;; Keywords: outlines | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
64091 | 23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 ;; Boston, MA 02110-1301, USA. | |
51347 | 25 |
26 ;;; Commentary: | |
27 | |
28 ;; This package is a major mode for editing outline-format documents. | |
29 ;; An outline can be `abstracted' to show headers at any given level, | |
30 ;; with all stuff below hidden. See the Emacs manual for details. | |
31 | |
32 ;;; Todo: | |
33 | |
34 ;; - subtree-terminators | |
35 ;; - better handle comments before function bodies (i.e. heading) | |
36 ;; - don't bother hiding whitespace | |
37 | |
38 ;;; Code: | |
39 | |
65294
ecfa88bd9638
(font-lock-warning-face): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
65214
diff
changeset
|
40 (defvar font-lock-warning-face) |
ecfa88bd9638
(font-lock-warning-face): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
65214
diff
changeset
|
41 |
ecfa88bd9638
(font-lock-warning-face): Add defvar.
Juanma Barranquero <lekktu@gmail.com>
parents:
65214
diff
changeset
|
42 |
51347 | 43 (defgroup outlines nil |
64040
44cf3ecee23f
(outlines): Finish `defgroup' description with period.
Juanma Barranquero <lekktu@gmail.com>
parents:
62803
diff
changeset
|
44 "Support for hierarchical outlining." |
51347 | 45 :prefix "outline-" |
46 :group 'editing) | |
47 | |
48 (defcustom outline-regexp "[*\^L]+" | |
69297
c379d6c262b1
(hide-sublevels): Provide better interactive default.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
49 "Regular expression to match the beginning of a heading. |
51347 | 50 Any line whose beginning matches this regexp is considered to start a heading. |
51 Note that Outline mode only checks this regexp at the start of a line, | |
52 so the regexp need not (and usually does not) start with `^'. | |
53 The recommended way to set this is with a Local Variables: list | |
54 in the file it applies to. See also `outline-heading-end-regexp'." | |
55 :type '(choice regexp (const nil)) | |
56 :group 'outlines) | |
70590
63b772bfba93
Move `safe-local-variable' declarations to the respective files.
Reiner Steib <Reiner.Steib@gmx.de>
parents:
69297
diff
changeset
|
57 ;;;###autoload(put 'outline-regexp 'safe-local-variable 'string-or-null-p) |
51347 | 58 |
59 (defcustom outline-heading-end-regexp "\n" | |
69297
c379d6c262b1
(hide-sublevels): Provide better interactive default.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
60 "Regular expression to match the end of a heading line. |
51347 | 61 You can assume that point is at the beginning of a heading when this |
62 regexp is searched for. The heading ends at the end of the match. | |
63 The recommended way to set this is with a `Local Variables:' list | |
64 in the file it applies to." | |
65 :type 'regexp | |
66 :group 'outlines) | |
67 | |
68 (defvar outline-mode-prefix-map | |
69 (let ((map (make-sparse-keymap))) | |
70 (define-key map "@" 'outline-mark-subtree) | |
71 (define-key map "\C-n" 'outline-next-visible-heading) | |
72 (define-key map "\C-p" 'outline-previous-visible-heading) | |
73 (define-key map "\C-i" 'show-children) | |
74 (define-key map "\C-s" 'show-subtree) | |
75 (define-key map "\C-d" 'hide-subtree) | |
76 (define-key map "\C-u" 'outline-up-heading) | |
77 (define-key map "\C-f" 'outline-forward-same-level) | |
78 (define-key map "\C-b" 'outline-backward-same-level) | |
79 (define-key map "\C-t" 'hide-body) | |
80 (define-key map "\C-a" 'show-all) | |
81 (define-key map "\C-c" 'hide-entry) | |
82 (define-key map "\C-e" 'show-entry) | |
83 (define-key map "\C-l" 'hide-leaves) | |
84 (define-key map "\C-k" 'show-branches) | |
85 (define-key map "\C-q" 'hide-sublevels) | |
86 (define-key map "\C-o" 'hide-other) | |
87 (define-key map "\C-^" 'outline-move-subtree-up) | |
88 (define-key map "\C-v" 'outline-move-subtree-down) | |
89 (define-key map [(control ?<)] 'outline-promote) | |
90 (define-key map [(control ?>)] 'outline-demote) | |
91 (define-key map "\C-m" 'outline-insert-heading) | |
92 ;; Where to bind outline-cycle ? | |
93 map)) | |
94 | |
95 (defvar outline-mode-menu-bar-map | |
96 (let ((map (make-sparse-keymap))) | |
97 | |
98 (define-key map [hide] (cons "Hide" (make-sparse-keymap "Hide"))) | |
99 | |
100 (define-key map [hide hide-other] '("Hide Other" . hide-other)) | |
101 (define-key map [hide hide-sublevels] '("Hide Sublevels" . hide-sublevels)) | |
102 (define-key map [hide hide-subtree] '("Hide Subtree" . hide-subtree)) | |
103 (define-key map [hide hide-entry] '("Hide Entry" . hide-entry)) | |
104 (define-key map [hide hide-body] '("Hide Body" . hide-body)) | |
105 (define-key map [hide hide-leaves] '("Hide Leaves" . hide-leaves)) | |
106 | |
107 (define-key map [show] (cons "Show" (make-sparse-keymap "Show"))) | |
108 | |
109 (define-key map [show show-subtree] '("Show Subtree" . show-subtree)) | |
110 (define-key map [show show-children] '("Show Children" . show-children)) | |
111 (define-key map [show show-branches] '("Show Branches" . show-branches)) | |
112 (define-key map [show show-entry] '("Show Entry" . show-entry)) | |
113 (define-key map [show show-all] '("Show All" . show-all)) | |
114 | |
115 (define-key map [headings] | |
116 (cons "Headings" (make-sparse-keymap "Headings"))) | |
117 | |
118 (define-key map [headings demote-subtree] | |
119 '(menu-item "Demote subtree" outline-demote)) | |
120 (define-key map [headings promote-subtree] | |
121 '(menu-item "Promote subtree" outline-promote)) | |
122 (define-key map [headings move-subtree-down] | |
123 '(menu-item "Move subtree down" outline-move-subtree-down)) | |
124 (define-key map [headings move-subtree-up] | |
125 '(menu-item "Move subtree up" outline-move-subtree-up)) | |
126 (define-key map [headings copy] | |
127 '(menu-item "Copy to kill ring" outline-headers-as-kill | |
128 :enable mark-active)) | |
129 (define-key map [headings outline-insert-heading] | |
130 '("New heading" . outline-insert-heading)) | |
131 (define-key map [headings outline-backward-same-level] | |
132 '("Previous Same Level" . outline-backward-same-level)) | |
133 (define-key map [headings outline-forward-same-level] | |
134 '("Next Same Level" . outline-forward-same-level)) | |
135 (define-key map [headings outline-previous-visible-heading] | |
136 '("Previous" . outline-previous-visible-heading)) | |
137 (define-key map [headings outline-next-visible-heading] | |
138 '("Next" . outline-next-visible-heading)) | |
139 (define-key map [headings outline-up-heading] | |
140 '("Up" . outline-up-heading)) | |
141 map)) | |
142 | |
143 (defvar outline-minor-mode-menu-bar-map | |
144 (let ((map (make-sparse-keymap))) | |
145 (define-key map [outline] | |
146 (cons "Outline" | |
147 (nconc (make-sparse-keymap "Outline") | |
148 ;; Remove extra separator | |
149 (cdr | |
150 ;; Flatten the major mode's menus into a single menu. | |
151 (apply 'append | |
152 (mapcar (lambda (x) | |
153 (if (consp x) | |
154 ;; Add a separator between each | |
155 ;; part of the unified menu. | |
156 (cons '(--- "---") (cdr x)))) | |
157 outline-mode-menu-bar-map)))))) | |
158 map)) | |
52067
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
159 |
51347 | 160 |
161 (defvar outline-mode-map | |
162 (let ((map (make-sparse-keymap))) | |
163 (define-key map "\C-c" outline-mode-prefix-map) | |
164 (define-key map [menu-bar] outline-mode-menu-bar-map) | |
165 map)) | |
166 | |
167 (defvar outline-font-lock-keywords | |
168 '(;; | |
169 ;; Highlight headings according to the level. | |
170 (eval . (list (concat "^\\(?:" outline-regexp "\\).+") | |
171 0 '(outline-font-lock-face) nil t))) | |
172 "Additional expressions to highlight in Outline mode.") | |
173 | |
62803
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
174 (defface outline-1 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
175 '((t :inherit font-lock-function-name-face)) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
176 "Level 1." |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
177 :group 'outlines) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
178 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
179 (defface outline-2 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
180 '((t :inherit font-lock-variable-name-face)) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
181 "Level 2." |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
182 :group 'outlines) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
183 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
184 (defface outline-3 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
185 '((t :inherit font-lock-keyword-face)) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
186 "Level 3." |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
187 :group 'outlines) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
188 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
189 (defface outline-4 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
190 '((t :inherit font-lock-builtin-face)) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
191 "Level 4." |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
192 :group 'outlines) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
193 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
194 (defface outline-5 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
195 '((t :inherit font-lock-comment-face)) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
196 "Level 5." |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
197 :group 'outlines) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
198 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
199 (defface outline-6 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
200 '((t :inherit font-lock-constant-face)) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
201 "Level 6." |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
202 :group 'outlines) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
203 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
204 (defface outline-7 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
205 '((t :inherit font-lock-type-face)) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
206 "Level 7." |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
207 :group 'outlines) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
208 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
209 (defface outline-8 |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
210 '((t :inherit font-lock-string-face)) |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
211 "Level 8." |
5a1fd32a61a2
(outline-1, outline-2, outline-3, outline-4)
Lute Kamstra <lute@gnu.org>
parents:
57974
diff
changeset
|
212 :group 'outlines) |
51347 | 213 |
214 (defvar outline-font-lock-faces | |
215 [outline-1 outline-2 outline-3 outline-4 | |
216 outline-5 outline-6 outline-7 outline-8]) | |
217 | |
218 (defvar outline-font-lock-levels nil) | |
219 (make-variable-buffer-local 'outline-font-lock-levels) | |
220 | |
221 (defun outline-font-lock-face () | |
222 ;; (save-excursion | |
223 ;; (outline-back-to-heading t) | |
224 ;; (let* ((count 0) | |
225 ;; (start-level (funcall outline-level)) | |
226 ;; (level start-level) | |
227 ;; face-level) | |
228 ;; (while (not (setq face-level | |
229 ;; (if (or (bobp) (eq level 1)) 0 | |
230 ;; (cdr (assq level outline-font-lock-levels))))) | |
231 ;; (outline-up-heading 1 t) | |
232 ;; (setq count (1+ count)) | |
233 ;; (setq level (funcall outline-level))) | |
234 ;; ;; Remember for later. | |
235 ;; (unless (zerop count) | |
236 ;; (setq face-level (+ face-level count)) | |
237 ;; (push (cons start-level face-level) outline-font-lock-levels)) | |
238 ;; (condition-case nil | |
239 ;; (aref outline-font-lock-faces face-level) | |
240 ;; (error font-lock-warning-face)))) | |
241 (save-excursion | |
242 (goto-char (match-beginning 0)) | |
243 (looking-at outline-regexp) | |
244 (condition-case nil | |
245 (aref outline-font-lock-faces (1- (funcall outline-level))) | |
246 (error font-lock-warning-face)))) | |
247 | |
248 (defvar outline-view-change-hook nil | |
249 "Normal hook to be run after outline visibility changes.") | |
250 | |
52067
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
251 (defvar outline-mode-hook nil |
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
252 "*This hook is run when outline mode starts.") |
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
253 |
55273
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
254 (defvar outline-blank-line nil |
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
255 "*Non-nil means to leave unhidden blank line before heading.") |
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
256 |
51347 | 257 ;;;###autoload |
258 (define-derived-mode outline-mode text-mode "Outline" | |
259 "Set major mode for editing outlines with selective display. | |
260 Headings are lines which start with asterisks: one for major headings, | |
261 two for subheadings, etc. Lines not starting with asterisks are body lines. | |
262 | |
263 Body text or subheadings under a heading can be made temporarily | |
264 invisible, or visible again. Invisible lines are attached to the end | |
265 of the heading, so they move with it, if the line is killed and yanked | |
266 back. A heading with text hidden under it is marked with an ellipsis (...). | |
267 | |
268 Commands:\\<outline-mode-map> | |
269 \\[outline-next-visible-heading] outline-next-visible-heading move by visible headings | |
270 \\[outline-previous-visible-heading] outline-previous-visible-heading | |
271 \\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings | |
272 \\[outline-backward-same-level] outline-backward-same-level | |
273 \\[outline-up-heading] outline-up-heading move from subheading to heading | |
274 | |
275 \\[hide-body] make all text invisible (not headings). | |
276 \\[show-all] make everything in buffer visible. | |
277 \\[hide-sublevels] make only the first N levels of headers visible. | |
278 | |
279 The remaining commands are used when point is on a heading line. | |
280 They apply to some of the body or subheadings of that heading. | |
281 \\[hide-subtree] hide-subtree make body and subheadings invisible. | |
282 \\[show-subtree] show-subtree make body and subheadings visible. | |
283 \\[show-children] show-children make direct subheadings visible. | |
284 No effect on body, or subheadings 2 or more levels down. | |
285 With arg N, affects subheadings N levels down. | |
286 \\[hide-entry] make immediately following body invisible. | |
287 \\[show-entry] make it visible. | |
288 \\[hide-leaves] make body under heading and under its subheadings invisible. | |
289 The subheadings remain visible. | |
290 \\[show-branches] make all subheadings at all levels visible. | |
291 | |
292 The variable `outline-regexp' can be changed to control what is a heading. | |
293 A line is a heading if `outline-regexp' matches something at the | |
294 beginning of the line. The longer the match, the deeper the level. | |
295 | |
296 Turning on outline mode calls the value of `text-mode-hook' and then of | |
297 `outline-mode-hook', if they are non-nil." | |
298 (make-local-variable 'line-move-ignore-invisible) | |
299 (setq line-move-ignore-invisible t) | |
300 ;; Cause use of ellipses for invisible text. | |
301 (add-to-invisibility-spec '(outline . t)) | |
302 (set (make-local-variable 'paragraph-start) | |
303 (concat paragraph-start "\\|\\(?:" outline-regexp "\\)")) | |
304 ;; Inhibit auto-filling of header lines. | |
305 (set (make-local-variable 'auto-fill-inhibit-regexp) outline-regexp) | |
306 (set (make-local-variable 'paragraph-separate) | |
307 (concat paragraph-separate "\\|\\(?:" outline-regexp "\\)")) | |
308 (set (make-local-variable 'font-lock-defaults) | |
309 '(outline-font-lock-keywords t nil nil backward-paragraph)) | |
310 (setq imenu-generic-expression | |
311 (list (list nil (concat "^\\(?:" outline-regexp "\\).*$") 0))) | |
52070
318ea3203ba5
(outline-mode): Revert part of last patch (outline-mode already runs the hook).
Juanma Barranquero <lekktu@gmail.com>
parents:
52067
diff
changeset
|
312 (add-hook 'change-major-mode-hook 'show-all nil t)) |
51347 | 313 |
314 (defcustom outline-minor-mode-prefix "\C-c@" | |
315 "*Prefix key to use for Outline commands in Outline minor mode. | |
316 The value of this variable is checked as part of loading Outline mode. | |
317 After that, changing the prefix key requires manipulating keymaps." | |
318 :type 'string | |
319 :group 'outlines) | |
320 | |
321 ;;;###autoload | |
322 (define-minor-mode outline-minor-mode | |
323 "Toggle Outline minor mode. | |
324 With arg, turn Outline minor mode on if arg is positive, off otherwise. | |
325 See the command `outline-mode' for more information on this mode." | |
326 nil " Outl" (list (cons [menu-bar] outline-minor-mode-menu-bar-map) | |
327 (cons outline-minor-mode-prefix outline-mode-prefix-map)) | |
328 :group 'outlines | |
329 (if outline-minor-mode | |
330 (progn | |
331 ;; Turn off this mode if we change major modes. | |
332 (add-hook 'change-major-mode-hook | |
333 (lambda () (outline-minor-mode -1)) | |
334 nil t) | |
335 (set (make-local-variable 'line-move-ignore-invisible) t) | |
336 ;; Cause use of ellipses for invisible text. | |
337 (add-to-invisibility-spec '(outline . t))) | |
338 (setq line-move-ignore-invisible nil) | |
339 ;; Cause use of ellipses for invisible text. | |
340 (remove-from-invisibility-spec '(outline . t)) | |
341 ;; When turning off outline mode, get rid of any outline hiding. | |
342 (show-all))) | |
343 | |
344 (defvar outline-level 'outline-level | |
345 "*Function of no args to compute a header's nesting level in an outline. | |
346 It can assume point is at the beginning of a header line and that the match | |
347 data reflects the `outline-regexp'.") | |
348 | |
349 (defvar outline-heading-alist () | |
350 "Alist associating a heading for every possible level. | |
351 Each entry is of the form (HEADING . LEVEL). | |
352 This alist is used two ways: to find the heading corresponding to | |
353 a given level and to find the level of a given heading. | |
354 If a mode or document needs several sets of outline headings (for example | |
355 numbered and unnumbered sections), list them set by set and sorted by level | |
356 within each set. For example in texinfo mode: | |
357 | |
358 (setq outline-heading-alist | |
359 '((\"@chapter\" . 2) (\"@section\" . 3) (\"@subsection\" . 4) | |
360 (\"@subsubsection\" . 5) | |
361 (\"@unnumbered\" . 2) (\"@unnumberedsec\" . 3) | |
362 (\"@unnumberedsubsec\" . 4) (\"@unnumberedsubsubsec\" . 5) | |
363 (\"@appendix\" . 2) (\"@appendixsec\" . 3)... | |
364 (\"@appendixsubsec\" . 4) (\"@appendixsubsubsec\" . 5) ..)) | |
365 | |
366 Instead of sorting the entries in each set, you can also separate the | |
367 sets with nil.") | |
368 (make-variable-buffer-local 'outline-heading-alist) | |
369 | |
370 ;; This used to count columns rather than characters, but that made ^L | |
371 ;; appear to be at level 2 instead of 1. Columns would be better for | |
372 ;; tab handling, but the default regexp doesn't use tabs, and anyone | |
373 ;; who changes the regexp can also redefine the outline-level variable | |
374 ;; as appropriate. | |
375 (defun outline-level () | |
376 "Return the depth to which a statement is nested in the outline. | |
377 Point must be at the beginning of a header line. | |
378 This is actually either the level specified in `outline-heading-alist' | |
379 or else the number of characters matched by `outline-regexp'." | |
380 (or (cdr (assoc (match-string 0) outline-heading-alist)) | |
381 (- (match-end 0) (match-beginning 0)))) | |
382 | |
383 (defun outline-next-preface () | |
384 "Skip forward to just before the next heading line. | |
385 If there's no following heading line, stop before the newline | |
386 at the end of the buffer." | |
387 (if (re-search-forward (concat "\n\\(?:" outline-regexp "\\)") | |
388 nil 'move) | |
389 (goto-char (match-beginning 0))) | |
55273
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
390 (if (and (bolp) (or outline-blank-line (eobp)) (not (bobp))) |
51347 | 391 (forward-char -1))) |
392 | |
393 (defun outline-next-heading () | |
394 "Move to the next (possibly invisible) heading line." | |
395 (interactive) | |
396 ;; Make sure we don't match the heading we're at. | |
397 (if (and (bolp) (not (eobp))) (forward-char 1)) | |
398 (if (re-search-forward (concat "^\\(?:" outline-regexp "\\)") | |
399 nil 'move) | |
400 (goto-char (match-beginning 0)))) | |
401 | |
402 (defun outline-previous-heading () | |
403 "Move to the previous (possibly invisible) heading line." | |
404 (interactive) | |
405 (re-search-backward (concat "^\\(?:" outline-regexp "\\)") | |
406 nil 'move)) | |
407 | |
408 (defsubst outline-invisible-p (&optional pos) | |
409 "Non-nil if the character after point is invisible." | |
410 (get-char-property (or pos (point)) 'invisible)) | |
411 | |
412 (defun outline-visible () | |
413 (not (outline-invisible-p))) | |
414 (make-obsolete 'outline-visible 'outline-invisible-p) | |
415 | |
416 (defun outline-back-to-heading (&optional invisible-ok) | |
417 "Move to previous heading line, or beg of this line if it's a heading. | |
418 Only visible heading lines are considered, unless INVISIBLE-OK is non-nil." | |
419 (beginning-of-line) | |
420 (or (outline-on-heading-p invisible-ok) | |
421 (let (found) | |
422 (save-excursion | |
423 (while (not found) | |
424 (or (re-search-backward (concat "^\\(?:" outline-regexp "\\)") | |
425 nil t) | |
426 (error "before first heading")) | |
427 (setq found (and (or invisible-ok (not (outline-invisible-p))) | |
428 (point))))) | |
429 (goto-char found) | |
430 found))) | |
431 | |
432 (defun outline-on-heading-p (&optional invisible-ok) | |
433 "Return t if point is on a (visible) heading line. | |
434 If INVISIBLE-OK is non-nil, an invisible heading line is ok too." | |
435 (save-excursion | |
436 (beginning-of-line) | |
437 (and (bolp) (or invisible-ok (not (outline-invisible-p))) | |
438 (looking-at outline-regexp)))) | |
439 | |
440 (defun outline-insert-heading () | |
441 "Insert a new heading at same depth at point." | |
442 (interactive) | |
443 (let ((head (save-excursion | |
444 (condition-case nil | |
445 (outline-back-to-heading) | |
446 (error (outline-next-heading))) | |
447 (if (eobp) | |
448 (or (caar outline-heading-alist) "") | |
449 (match-string 0))))) | |
450 (unless (or (string-match "[ \t]\\'" head) | |
53648
cb1748b5a52b
(outline-insert-heading): Tighten up match.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
451 (not (string-match (concat "\\`\\(?:" outline-regexp "\\)") |
cb1748b5a52b
(outline-insert-heading): Tighten up match.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
52401
diff
changeset
|
452 (concat head " ")))) |
51347 | 453 (setq head (concat head " "))) |
454 (unless (bolp) (end-of-line) (newline)) | |
455 (insert head) | |
456 (unless (eolp) | |
457 (save-excursion (newline-and-indent))) | |
458 (run-hooks 'outline-insert-heading-hook))) | |
459 | |
65158
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
460 (defun outline-invent-heading (head up) |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
461 (save-match-data |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
462 ;; Let's try to invent one by repeating or deleting the last char. |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
463 (let ((new-head (if up (substring head 0 -1) |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
464 (concat head (substring head -1))))) |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
465 (if (string-match (concat "\\`\\(?:" outline-regexp "\\)") |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
466 new-head) |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
467 ;; Why bother checking that it is indeed higher/lower level ? |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
468 new-head |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
469 ;; Didn't work, so ask what to do. |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
470 (read-string (format "%s heading for `%s': " |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
471 (if up "Parent" "Demoted") head) |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
472 head nil nil t))))) |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
473 |
75441
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
474 (defun outline-promote (&optional which) |
51347 | 475 "Promote headings higher up the tree. |
75441
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
476 If transient-mark-mode is on, and mark is active, promote headings in |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
477 the region (from a Lisp program, pass `region' for WHICH). Otherwise: |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
478 without prefix argument, promote current heading and all headings in the |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
479 subtree (from a Lisp program, pass `subtree' for WHICH); with prefix |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
480 argument, promote just the current heading (from a Lisp program, pass |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
481 nil for WHICH, or do not pass any argument)." |
51347 | 482 (interactive |
483 (list (if (and transient-mark-mode mark-active) 'region | |
484 (outline-back-to-heading) | |
485 (if current-prefix-arg nil 'subtree)))) | |
486 (cond | |
75441
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
487 ((eq which 'region) |
51347 | 488 (outline-map-region 'outline-promote (region-beginning) (region-end))) |
75441
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
489 (which |
51347 | 490 (outline-map-region 'outline-promote |
491 (point) | |
492 (save-excursion (outline-get-next-sibling) (point)))) | |
493 (t | |
494 (outline-back-to-heading t) | |
65147
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
495 (let* ((head (match-string-no-properties 0)) |
51347 | 496 (level (save-match-data (funcall outline-level))) |
497 (up-head (or (outline-head-from-level (1- level) head) | |
65147
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
498 ;; Use the parent heading, if it is really |
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
499 ;; one level less. |
51347 | 500 (save-excursion |
501 (save-match-data | |
502 (outline-up-heading 1 t) | |
65147
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
503 (and (= (1- level) (funcall outline-level)) |
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
504 (match-string-no-properties 0)))) |
65158
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
505 ;; Bummer!! There is no lower level heading. |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
506 (outline-invent-heading head 'up)))) |
52067
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
507 |
51347 | 508 (unless (rassoc level outline-heading-alist) |
509 (push (cons head level) outline-heading-alist)) | |
52067
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
510 |
51347 | 511 (replace-match up-head nil t))))) |
512 | |
75441
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
513 (defun outline-demote (&optional which) |
51347 | 514 "Demote headings lower down the tree. |
75441
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
515 If transient-mark-mode is on, and mark is active, demote headings in |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
516 the region (from a Lisp program, pass `region' for WHICH). Otherwise: |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
517 without prefix argument, demote current heading and all headings in the |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
518 subtree (from a Lisp program, pass `subtree' for WHICH); with prefix |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
519 argument, demote just the current heading (from a Lisp program, pass |
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
520 nil for WHICH, or do not pass any argument)." |
51347 | 521 (interactive |
522 (list (if (and transient-mark-mode mark-active) 'region | |
523 (outline-back-to-heading) | |
524 (if current-prefix-arg nil 'subtree)))) | |
525 (cond | |
75441
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
526 ((eq which 'region) |
51347 | 527 (outline-map-region 'outline-demote (region-beginning) (region-end))) |
75441
6e4c04850090
(outline-promote, outline-demote): Doc fix. Rename the arg CHILDREN -> WHICH.
Eli Zaretskii <eliz@gnu.org>
parents:
75347
diff
changeset
|
528 (which |
51347 | 529 (outline-map-region 'outline-demote |
530 (point) | |
531 (save-excursion (outline-get-next-sibling) (point)))) | |
532 (t | |
65147
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
533 (let* ((head (match-string-no-properties 0)) |
51347 | 534 (level (save-match-data (funcall outline-level))) |
535 (down-head | |
536 (or (outline-head-from-level (1+ level) head) | |
537 (save-excursion | |
538 (save-match-data | |
539 (while (and (progn (outline-next-heading) (not (eobp))) | |
540 (<= (funcall outline-level) level))) | |
541 (when (eobp) | |
542 ;; Try again from the beginning of the buffer. | |
543 (goto-char (point-min)) | |
544 (while (and (progn (outline-next-heading) (not (eobp))) | |
545 (<= (funcall outline-level) level)))) | |
546 (unless (eobp) | |
547 (looking-at outline-regexp) | |
65147
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
548 (match-string-no-properties 0)))) |
65158
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
549 ;; Bummer!! There is no higher-level heading in the buffer. |
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
550 (outline-invent-heading head nil)))) |
51347 | 551 |
65147
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
552 (unless (rassoc level outline-heading-alist) |
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
553 (push (cons head level) outline-heading-alist)) |
c5c1bf7f3c59
(outline-promote): Try shortening the heading.
Richard M. Stallman <rms@gnu.org>
parents:
64762
diff
changeset
|
554 (replace-match down-head nil t))))) |
51347 | 555 |
556 (defun outline-head-from-level (level head &optional alist) | |
557 "Get new heading with level LEVEL from ALIST. | |
558 If there are no such entries, return nil. | |
559 ALIST defaults to `outline-heading-alist'. | |
560 Similar to (car (rassoc LEVEL ALIST)). | |
561 If there are several different entries with same new level, choose | |
562 the one with the smallest distance to the assocation of HEAD in the alist. | |
563 This makes it possible for promotion to work in modes with several | |
564 independent sets of headings (numbered, unnumbered, appendix...)" | |
565 (unless alist (setq alist outline-heading-alist)) | |
566 (let ((l (rassoc level alist)) | |
567 ll h hl l2 l2l) | |
568 (cond | |
569 ((null l) nil) | |
570 ;; If there's no HEAD after L, any other entry for LEVEL after L | |
571 ;; can't be much better than L. | |
572 ((null (setq h (assoc head (setq ll (memq l alist))))) (car l)) | |
573 ;; If there's no other entry for LEVEL, just keep L. | |
574 ((null (setq l2 (rassoc level (cdr ll)))) (car l)) | |
575 ;; Now we have L, L2, and H: see if L2 seems better than L. | |
576 ;; If H is after L2, L2 is better. | |
577 ((memq h (setq l2l (memq l2 (cdr ll)))) | |
578 (outline-head-from-level level head l2l)) | |
579 ;; Now we have H between L and L2. | |
580 ;; If there's a separator between L and H, prefer L2. | |
581 ((memq h (memq nil ll)) | |
582 (outline-head-from-level level head l2l)) | |
583 ;; If there's a separator between L2 and H, prefer L. | |
584 ((memq l2 (memq nil (setq hl (memq h ll)))) (car l)) | |
585 ;; No separator between L and L2, check the distance. | |
586 ((< (* 2 (length hl)) (+ (length ll) (length l2l))) | |
587 (outline-head-from-level level head l2l)) | |
588 ;; If all else fails, just keep L. | |
589 (t (car l))))) | |
590 | |
591 (defun outline-map-region (fun beg end) | |
592 "Call FUN for every heading between BEG and END. | |
593 When FUN is called, point is at the beginning of the heading and | |
594 the match data is set appropriately." | |
595 (save-excursion | |
596 (setq end (copy-marker end)) | |
597 (goto-char beg) | |
598 (when (re-search-forward (concat "^\\(?:" outline-regexp "\\)") end t) | |
599 (goto-char (match-beginning 0)) | |
600 (funcall fun) | |
601 (while (and (progn | |
602 (outline-next-heading) | |
603 (< (point) end)) | |
604 (not (eobp))) | |
605 (funcall fun))))) | |
606 | |
607 ;; Vertical tree motion | |
608 | |
609 (defun outline-move-subtree-up (&optional arg) | |
610 "Move the currrent subtree up past ARG headlines of the same level." | |
611 (interactive "p") | |
612 (outline-move-subtree-down (- arg))) | |
613 | |
614 (defun outline-move-subtree-down (&optional arg) | |
615 "Move the currrent subtree down past ARG headlines of the same level." | |
616 (interactive "p") | |
65158
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
617 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling |
51347 | 618 'outline-get-last-sibling)) |
619 (ins-point (make-marker)) | |
620 (cnt (abs arg)) | |
65158
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
621 beg end folded) |
51347 | 622 ;; Select the tree |
623 (outline-back-to-heading) | |
624 (setq beg (point)) | |
52067
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
625 (save-match-data |
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
626 (save-excursion (outline-end-of-heading) |
51347 | 627 (setq folded (outline-invisible-p))) |
628 (outline-end-of-subtree)) | |
629 (if (= (char-after) ?\n) (forward-char 1)) | |
630 (setq end (point)) | |
631 ;; Find insertion point, with error handling | |
632 (goto-char beg) | |
633 (while (> cnt 0) | |
634 (or (funcall movfunc) | |
635 (progn (goto-char beg) | |
636 (error "Cannot move past superior level"))) | |
637 (setq cnt (1- cnt))) | |
638 (if (> arg 0) | |
639 ;; Moving forward - still need to move over subtree | |
52067
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
640 (progn (outline-end-of-subtree) |
51347 | 641 (if (= (char-after) ?\n) (forward-char 1)))) |
642 (move-marker ins-point (point)) | |
643 (insert (delete-and-extract-region beg end)) | |
644 (goto-char ins-point) | |
645 (if folded (hide-subtree)) | |
646 (move-marker ins-point nil))) | |
647 | |
648 (defun outline-end-of-heading () | |
649 (if (re-search-forward outline-heading-end-regexp nil 'move) | |
650 (forward-char -1))) | |
651 | |
652 (defun outline-next-visible-heading (arg) | |
653 "Move to the next visible heading line. | |
654 With argument, repeats or can move backward if negative. | |
655 A heading line is one that starts with a `*' (or that | |
656 `outline-regexp' matches)." | |
657 (interactive "p") | |
658 (if (< arg 0) | |
659 (beginning-of-line) | |
660 (end-of-line)) | |
74823
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
661 (let (found-heading-p) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
662 (while (and (not (bobp)) (< arg 0)) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
663 (while (and (not (bobp)) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
664 (setq found-heading-p |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
665 (re-search-backward |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
666 (concat "^\\(?:" outline-regexp "\\)") |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
667 nil 'move)) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
668 (outline-invisible-p))) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
669 (setq arg (1+ arg))) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
670 (while (and (not (eobp)) (> arg 0)) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
671 (while (and (not (eobp)) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
672 (setq found-heading-p |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
673 (re-search-forward |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
674 (concat "^\\(?:" outline-regexp "\\)") |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
675 nil 'move)) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
676 (outline-invisible-p (match-beginning 0)))) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
677 (setq arg (1- arg))) |
dfa668ddf262
(outline-next-visible-heading): Fix the case with a header at end-of-file
Eli Zaretskii <eliz@gnu.org>
parents:
74669
diff
changeset
|
678 (if found-heading-p (beginning-of-line)))) |
51347 | 679 |
680 (defun outline-previous-visible-heading (arg) | |
681 "Move to the previous heading line. | |
682 With argument, repeats or can move forward if negative. | |
683 A heading line is one that starts with a `*' (or that | |
684 `outline-regexp' matches)." | |
685 (interactive "p") | |
686 (outline-next-visible-heading (- arg))) | |
687 | |
688 (defun outline-mark-subtree () | |
689 "Mark the current subtree in an outlined document. | |
690 This puts point at the start of the current subtree, and mark at the end." | |
691 (interactive) | |
692 (let ((beg)) | |
693 (if (outline-on-heading-p) | |
694 ;; we are already looking at a heading | |
695 (beginning-of-line) | |
696 ;; else go back to previous heading | |
697 (outline-previous-visible-heading 1)) | |
698 (setq beg (point)) | |
699 (outline-end-of-subtree) | |
65842
6b4c115f4d14
(outline-mark-subtree): Activate the mark.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65294
diff
changeset
|
700 (push-mark (point) nil t) |
51347 | 701 (goto-char beg))) |
702 | |
703 | |
74669
900d63313056
(outline-isearch-open-invisible-function): New defvar.
Kim F. Storm <storm@cua.dk>
parents:
74384
diff
changeset
|
704 (defvar outline-isearch-open-invisible-function nil |
900d63313056
(outline-isearch-open-invisible-function): New defvar.
Kim F. Storm <storm@cua.dk>
parents:
74384
diff
changeset
|
705 "Function called if `isearch' finishes in an invisible overlay. |
900d63313056
(outline-isearch-open-invisible-function): New defvar.
Kim F. Storm <storm@cua.dk>
parents:
74384
diff
changeset
|
706 The function is called with the overlay as its only argument. |
900d63313056
(outline-isearch-open-invisible-function): New defvar.
Kim F. Storm <storm@cua.dk>
parents:
74384
diff
changeset
|
707 If nil, `show-entry' is called to reveal the invisible text.") |
900d63313056
(outline-isearch-open-invisible-function): New defvar.
Kim F. Storm <storm@cua.dk>
parents:
74384
diff
changeset
|
708 |
51347 | 709 (put 'outline 'reveal-toggle-invisible 'outline-reveal-toggle-invisible) |
710 (defun outline-flag-region (from to flag) | |
711 "Hide or show lines from FROM to TO, according to FLAG. | |
712 If FLAG is nil then text is shown, while if FLAG is t the text is hidden." | |
713 (remove-overlays from to 'invisible 'outline) | |
714 (when flag | |
715 (let ((o (make-overlay from to))) | |
716 (overlay-put o 'invisible 'outline) | |
74669
900d63313056
(outline-isearch-open-invisible-function): New defvar.
Kim F. Storm <storm@cua.dk>
parents:
74384
diff
changeset
|
717 (overlay-put o 'isearch-open-invisible |
900d63313056
(outline-isearch-open-invisible-function): New defvar.
Kim F. Storm <storm@cua.dk>
parents:
74384
diff
changeset
|
718 (or outline-isearch-open-invisible-function |
900d63313056
(outline-isearch-open-invisible-function): New defvar.
Kim F. Storm <storm@cua.dk>
parents:
74384
diff
changeset
|
719 'outline-isearch-open-invisible)))) |
51347 | 720 ;; Seems only used by lazy-lock. I.e. obsolete. |
721 (run-hooks 'outline-view-change-hook)) | |
722 | |
723 (defun outline-reveal-toggle-invisible (o hidep) | |
724 (save-excursion | |
725 (goto-char (overlay-start o)) | |
726 (if hidep | |
727 ;; When hiding the area again, we could just clean it up and let | |
728 ;; reveal do the rest, by simply doing: | |
729 ;; (remove-overlays (overlay-start o) (overlay-end o) | |
730 ;; 'invisible 'outline) | |
52067
36323dc1a2ac
(outline-mode-hook): Define it.
Juanma Barranquero <lekktu@gmail.com>
parents:
51347
diff
changeset
|
731 ;; |
51347 | 732 ;; That works fine as long as everything is in sync, but if the |
733 ;; structure of the document is changed while revealing parts of it, | |
734 ;; the resulting behavior can be ugly. I.e. we need to make | |
735 ;; sure that we hide exactly a subtree. | |
736 (progn | |
737 (let ((end (overlay-end o))) | |
738 (delete-overlay o) | |
739 (while (progn | |
740 (hide-subtree) | |
741 (outline-next-visible-heading 1) | |
742 (and (not (eobp)) (< (point) end)))))) | |
743 | |
744 ;; When revealing, we just need to reveal sublevels. If point is | |
745 ;; inside one of the sublevels, reveal will call us again. | |
746 ;; But we need to preserve the original overlay. | |
747 (let ((o1 (copy-overlay o))) | |
748 (overlay-put o 'invisible nil) ;Show (most of) the text. | |
749 (while (progn | |
750 (show-entry) | |
751 (show-children) | |
752 ;; Normally just the above is needed. | |
753 ;; But in odd cases, the above might fail to show anything. | |
754 ;; To avoid an infinite loop, we have to make sure that | |
755 ;; *something* gets shown. | |
756 (and (equal (overlay-start o) (overlay-start o1)) | |
757 (< (point) (overlay-end o)) | |
758 (= 0 (forward-line 1))))) | |
759 ;; If still nothing was shown, just kill the damn thing. | |
760 (when (equal (overlay-start o) (overlay-start o1)) | |
761 ;; I've seen it happen at the end of buffer. | |
762 (delete-overlay o1)))))) | |
763 | |
764 ;; Function to be set as an outline-isearch-open-invisible' property | |
765 ;; to the overlay that makes the outline invisible (see | |
766 ;; `outline-flag-region'). | |
767 (defun outline-isearch-open-invisible (overlay) | |
768 ;; We rely on the fact that isearch places point on the matched text. | |
769 (show-entry)) | |
770 | |
771 (defun hide-entry () | |
772 "Hide the body directly following this heading." | |
773 (interactive) | |
774 (save-excursion | |
65214
aefa34357e06
(hide-entry, hide-leaves, outline-toggle-children):
Juri Linkov <juri@jurta.org>
parents:
65158
diff
changeset
|
775 (outline-back-to-heading) |
55228
53c5c7a2f4a8
(outline-next-preface, outline-show-heading): Don't leave unhidden blank line before heading.
Juri Linkov <juri@jurta.org>
parents:
53648
diff
changeset
|
776 (outline-end-of-heading) |
51347 | 777 (outline-flag-region (point) (progn (outline-next-preface) (point)) t))) |
778 | |
779 (defun show-entry () | |
780 "Show the body directly following this heading. | |
781 Show the heading too, if it is currently invisible." | |
782 (interactive) | |
783 (save-excursion | |
784 (outline-back-to-heading t) | |
785 (outline-flag-region (1- (point)) | |
786 (progn (outline-next-preface) (point)) nil))) | |
787 | |
788 (defun hide-body () | |
57974
be8ba6e58a49
(hide-body): Don't hide lines at the top of the file
Eli Zaretskii <eliz@gnu.org>
parents:
57527
diff
changeset
|
789 "Hide all body lines in buffer, leaving all headings visible." |
51347 | 790 (interactive) |
791 (hide-region-body (point-min) (point-max))) | |
792 | |
793 (defun hide-region-body (start end) | |
794 "Hide all body lines in the region, but not headings." | |
795 ;; Nullify the hook to avoid repeated calls to `outline-flag-region' | |
796 ;; wasting lots of time running `lazy-lock-fontify-after-outline' | |
797 ;; and run the hook finally. | |
798 (let (outline-view-change-hook) | |
799 (save-excursion | |
800 (save-restriction | |
801 (narrow-to-region start end) | |
802 (goto-char (point-min)) | |
803 (if (outline-on-heading-p) | |
57974
be8ba6e58a49
(hide-body): Don't hide lines at the top of the file
Eli Zaretskii <eliz@gnu.org>
parents:
57527
diff
changeset
|
804 (outline-end-of-heading) |
be8ba6e58a49
(hide-body): Don't hide lines at the top of the file
Eli Zaretskii <eliz@gnu.org>
parents:
57527
diff
changeset
|
805 (outline-next-preface)) |
51347 | 806 (while (not (eobp)) |
807 (outline-flag-region (point) | |
808 (progn (outline-next-preface) (point)) t) | |
809 (unless (eobp) | |
810 (forward-char (if (looking-at "\n\n") 2 1)) | |
811 (outline-end-of-heading)))))) | |
812 (run-hooks 'outline-view-change-hook)) | |
813 | |
814 (defun show-all () | |
815 "Show all of the text in the buffer." | |
816 (interactive) | |
817 (outline-flag-region (point-min) (point-max) nil)) | |
818 | |
819 (defun hide-subtree () | |
820 "Hide everything after this heading at deeper levels." | |
821 (interactive) | |
822 (outline-flag-subtree t)) | |
823 | |
824 (defun hide-leaves () | |
68269
4747977f1afa
(hide-leaves): Don't call outline-end-of-heading.
Richard M. Stallman <rms@gnu.org>
parents:
65842
diff
changeset
|
825 "Hide the body after this heading and at deeper levels." |
51347 | 826 (interactive) |
827 (save-excursion | |
65214
aefa34357e06
(hide-entry, hide-leaves, outline-toggle-children):
Juri Linkov <juri@jurta.org>
parents:
65158
diff
changeset
|
828 (outline-back-to-heading) |
68279 | 829 ;; Turned off to fix bug reported by Otto Maddox on 22 Nov 2005. |
68269
4747977f1afa
(hide-leaves): Don't call outline-end-of-heading.
Richard M. Stallman <rms@gnu.org>
parents:
65842
diff
changeset
|
830 ;; (outline-end-of-heading) |
51347 | 831 (hide-region-body (point) (progn (outline-end-of-subtree) (point))))) |
832 | |
833 (defun show-subtree () | |
834 "Show everything after this heading at deeper levels." | |
835 (interactive) | |
836 (outline-flag-subtree nil)) | |
837 | |
838 (defun outline-show-heading () | |
839 "Show the current heading and move to its end." | |
55273
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
840 (outline-flag-region (- (point) |
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
841 (if (bobp) 0 |
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
842 (if (and outline-blank-line |
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
843 (eq (char-before (1- (point))) ?\n)) |
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
844 2 1))) |
51347 | 845 (progn (outline-end-of-heading) (point)) |
846 nil)) | |
847 | |
848 (defun hide-sublevels (levels) | |
849 "Hide everything but the top LEVELS levels of headers, in whole buffer." | |
69297
c379d6c262b1
(hide-sublevels): Provide better interactive default.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
850 (interactive (list |
c379d6c262b1
(hide-sublevels): Provide better interactive default.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
851 (cond |
c379d6c262b1
(hide-sublevels): Provide better interactive default.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
852 (current-prefix-arg (prefix-numeric-value current-prefix-arg)) |
c379d6c262b1
(hide-sublevels): Provide better interactive default.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
853 ((save-excursion (beginning-of-line) |
c379d6c262b1
(hide-sublevels): Provide better interactive default.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
854 (looking-at outline-regexp)) |
c379d6c262b1
(hide-sublevels): Provide better interactive default.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
855 (funcall outline-level)) |
c379d6c262b1
(hide-sublevels): Provide better interactive default.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
856 (t 1)))) |
51347 | 857 (if (< levels 1) |
858 (error "Must keep at least one level of headers")) | |
859 (let (outline-view-change-hook) | |
860 (save-excursion | |
861 (goto-char (point-min)) | |
862 ;; Skip the prelude, if any. | |
863 (unless (outline-on-heading-p t) (outline-next-heading)) | |
864 ;; First hide everything. | |
865 (outline-flag-region (point) (point-max) t) | |
866 ;; Then unhide the top level headers. | |
867 (outline-map-region | |
868 (lambda () | |
869 (if (<= (funcall outline-level) levels) | |
870 (outline-show-heading))) | |
871 (point) (point-max)))) | |
872 (run-hooks 'outline-view-change-hook)) | |
873 | |
874 (defun hide-other () | |
875 "Hide everything except current body and parent and top-level headings." | |
876 (interactive) | |
877 (hide-sublevels 1) | |
878 (let (outline-view-change-hook) | |
879 (save-excursion | |
880 (outline-back-to-heading t) | |
881 (show-entry) | |
57527
21785c190853
(hide-other): Call outline-up-heading with INVISIBLE-OK=t.
Richard M. Stallman <rms@gnu.org>
parents:
55273
diff
changeset
|
882 (while (condition-case nil (progn (outline-up-heading 1 t) (not (bobp))) |
51347 | 883 (error nil)) |
884 (outline-flag-region (1- (point)) | |
885 (save-excursion (forward-line 1) (point)) | |
886 nil)))) | |
887 (run-hooks 'outline-view-change-hook)) | |
888 | |
889 (defun outline-toggle-children () | |
890 "Show or hide the current subtree depending on its current state." | |
891 (interactive) | |
65214
aefa34357e06
(hide-entry, hide-leaves, outline-toggle-children):
Juri Linkov <juri@jurta.org>
parents:
65158
diff
changeset
|
892 (save-excursion |
aefa34357e06
(hide-entry, hide-leaves, outline-toggle-children):
Juri Linkov <juri@jurta.org>
parents:
65158
diff
changeset
|
893 (outline-back-to-heading) |
aefa34357e06
(hide-entry, hide-leaves, outline-toggle-children):
Juri Linkov <juri@jurta.org>
parents:
65158
diff
changeset
|
894 (if (not (outline-invisible-p (line-end-position))) |
aefa34357e06
(hide-entry, hide-leaves, outline-toggle-children):
Juri Linkov <juri@jurta.org>
parents:
65158
diff
changeset
|
895 (hide-subtree) |
aefa34357e06
(hide-entry, hide-leaves, outline-toggle-children):
Juri Linkov <juri@jurta.org>
parents:
65158
diff
changeset
|
896 (show-children) |
aefa34357e06
(hide-entry, hide-leaves, outline-toggle-children):
Juri Linkov <juri@jurta.org>
parents:
65158
diff
changeset
|
897 (show-entry)))) |
51347 | 898 |
899 (defun outline-flag-subtree (flag) | |
900 (save-excursion | |
901 (outline-back-to-heading) | |
902 (outline-end-of-heading) | |
903 (outline-flag-region (point) | |
904 (progn (outline-end-of-subtree) (point)) | |
905 flag))) | |
906 | |
907 (defun outline-end-of-subtree () | |
908 (outline-back-to-heading) | |
65158
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
909 (let ((first t) |
51347 | 910 (level (funcall outline-level))) |
911 (while (and (not (eobp)) | |
912 (or first (> (funcall outline-level) level))) | |
913 (setq first nil) | |
914 (outline-next-heading)) | |
74384
4bb58e866a28
(outline-end-of-subtree): Don't leave an empty
Richard M. Stallman <rms@gnu.org>
parents:
70590
diff
changeset
|
915 (if (and (bolp) (not (eolp))) |
4bb58e866a28
(outline-end-of-subtree): Don't leave an empty
Richard M. Stallman <rms@gnu.org>
parents:
70590
diff
changeset
|
916 ;; We stopped at a nonempty line (the next heading). |
51347 | 917 (progn |
918 ;; Go to end of line before heading | |
55273
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
919 (forward-char -1) |
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
920 (if (and outline-blank-line (bolp)) |
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
921 ;; leave blank line before heading |
8362eef794e3
(outline-blank-line): New var.
Juri Linkov <juri@jurta.org>
parents:
55228
diff
changeset
|
922 (forward-char -1)))))) |
51347 | 923 |
924 (defun show-branches () | |
925 "Show all subheadings of this heading, but not their bodies." | |
926 (interactive) | |
927 (show-children 1000)) | |
928 | |
929 (defun show-children (&optional level) | |
930 "Show all direct subheadings of this heading. | |
931 Prefix arg LEVEL is how many levels below the current level should be shown. | |
932 Default is enough to cause the following heading to appear." | |
933 (interactive "P") | |
934 (setq level | |
935 (if level (prefix-numeric-value level) | |
936 (save-excursion | |
937 (outline-back-to-heading) | |
938 (let ((start-level (funcall outline-level))) | |
939 (outline-next-heading) | |
940 (if (eobp) | |
941 1 | |
942 (max 1 (- (funcall outline-level) start-level))))))) | |
943 (let (outline-view-change-hook) | |
944 (save-excursion | |
945 (outline-back-to-heading) | |
946 (setq level (+ level (funcall outline-level))) | |
947 (outline-map-region | |
948 (lambda () | |
949 (if (<= (funcall outline-level) level) | |
950 (outline-show-heading))) | |
951 (point) | |
952 (progn (outline-end-of-subtree) | |
953 (if (eobp) (point-max) (1+ (point))))))) | |
954 (run-hooks 'outline-view-change-hook)) | |
955 | |
956 | |
957 | |
958 (defun outline-up-heading (arg &optional invisible-ok) | |
959 "Move to the visible heading line of which the present line is a subheading. | |
960 With argument, move up ARG levels. | |
961 If INVISIBLE-OK is non-nil, also consider invisible lines." | |
962 (interactive "p") | |
55228
53c5c7a2f4a8
(outline-next-preface, outline-show-heading): Don't leave unhidden blank line before heading.
Juri Linkov <juri@jurta.org>
parents:
53648
diff
changeset
|
963 (and (eq this-command 'outline-up-heading) |
53c5c7a2f4a8
(outline-next-preface, outline-show-heading): Don't leave unhidden blank line before heading.
Juri Linkov <juri@jurta.org>
parents:
53648
diff
changeset
|
964 (or (eq last-command 'outline-up-heading) (push-mark))) |
51347 | 965 (outline-back-to-heading invisible-ok) |
966 (let ((start-level (funcall outline-level))) | |
967 (if (eq start-level 1) | |
968 (error "Already at top level of the outline")) | |
969 (while (and (> start-level 1) (> arg 0) (not (bobp))) | |
970 (let ((level start-level)) | |
971 (while (not (or (< level start-level) (bobp))) | |
972 (if invisible-ok | |
973 (outline-previous-heading) | |
974 (outline-previous-visible-heading 1)) | |
975 (setq level (funcall outline-level))) | |
976 (setq start-level level)) | |
977 (setq arg (- arg 1)))) | |
978 (looking-at outline-regexp)) | |
979 | |
980 (defun outline-forward-same-level (arg) | |
981 "Move forward to the ARG'th subheading at same level as this one. | |
982 Stop at the first and last subheadings of a superior heading." | |
983 (interactive "p") | |
984 (outline-back-to-heading) | |
985 (while (> arg 0) | |
986 (let ((point-to-move-to (save-excursion | |
987 (outline-get-next-sibling)))) | |
988 (if point-to-move-to | |
989 (progn | |
990 (goto-char point-to-move-to) | |
991 (setq arg (1- arg))) | |
992 (progn | |
993 (setq arg 0) | |
994 (error "No following same-level heading")))))) | |
995 | |
996 (defun outline-get-next-sibling () | |
997 "Move to next heading of the same level, and return point or nil if none." | |
998 (let ((level (funcall outline-level))) | |
999 (outline-next-visible-heading 1) | |
1000 (while (and (not (eobp)) (> (funcall outline-level) level)) | |
1001 (outline-next-visible-heading 1)) | |
1002 (if (or (eobp) (< (funcall outline-level) level)) | |
1003 nil | |
1004 (point)))) | |
1005 | |
1006 (defun outline-backward-same-level (arg) | |
1007 "Move backward to the ARG'th subheading at same level as this one. | |
1008 Stop at the first and last subheadings of a superior heading." | |
1009 (interactive "p") | |
1010 (outline-back-to-heading) | |
1011 (while (> arg 0) | |
1012 (let ((point-to-move-to (save-excursion | |
1013 (outline-get-last-sibling)))) | |
1014 (if point-to-move-to | |
1015 (progn | |
1016 (goto-char point-to-move-to) | |
1017 (setq arg (1- arg))) | |
1018 (progn | |
1019 (setq arg 0) | |
1020 (error "No previous same-level heading")))))) | |
1021 | |
1022 (defun outline-get-last-sibling () | |
1023 "Move to previous heading of the same level, and return point or nil if none." | |
1024 (let ((level (funcall outline-level))) | |
1025 (outline-previous-visible-heading 1) | |
1026 (while (and (> (funcall outline-level) level) | |
1027 (not (bobp))) | |
1028 (outline-previous-visible-heading 1)) | |
1029 (if (< (funcall outline-level) level) | |
1030 nil | |
1031 (point)))) | |
1032 | |
1033 (defun outline-headers-as-kill (beg end) | |
1034 "Save the visible outline headers in region at the start of the kill ring. | |
1035 | |
1036 Text shown between the headers isn't copied. Two newlines are | |
1037 inserted between saved headers. Yanking the result may be a | |
1038 convenient way to make a table of contents of the buffer." | |
1039 (interactive "r") | |
1040 (save-excursion | |
1041 (save-restriction | |
1042 (narrow-to-region beg end) | |
1043 (goto-char (point-min)) | |
1044 (let ((buffer (current-buffer)) | |
1045 start end) | |
1046 (with-temp-buffer | |
1047 (with-current-buffer buffer | |
1048 ;; Boundary condition: starting on heading: | |
1049 (when (outline-on-heading-p) | |
1050 (outline-back-to-heading) | |
1051 (setq start (point) | |
1052 end (progn (outline-end-of-heading) | |
1053 (point))) | |
1054 (insert-buffer-substring buffer start end) | |
1055 (insert "\n\n"))) | |
1056 (let ((temp-buffer (current-buffer))) | |
1057 (with-current-buffer buffer | |
1058 (while (outline-next-heading) | |
1059 (unless (outline-invisible-p) | |
1060 (setq start (point) | |
1061 end (progn (outline-end-of-heading) (point))) | |
1062 (with-current-buffer temp-buffer | |
1063 (insert-buffer-substring buffer start end) | |
1064 (insert "\n\n")))))) | |
1065 (kill-new (buffer-string))))))) | |
1066 | |
1067 (provide 'outline) | |
1068 (provide 'noutline) | |
1069 | |
65158
1dc0c9b5d66a
(outline-invent-heading): New fun.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
65147
diff
changeset
|
1070 ;; arch-tag: 1724410e-7d4d-4f46-b801-49e18171e874 |
51347 | 1071 ;;; outline.el ends here |