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