1 ;;; outline.el --- outline mode commands for Emacs
3 ;; Copyright (C) 1986 Free Software Foundation, Inc.
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 ;; This package is a major mode for editing outline-format documents.
26 ;; An outline can be `abstracted' to show headers at any given level,
27 ;; with all stuff below hidden. See the Emacs manual for details.
31 ;; Jan '86, Some new features added by Peter Desnoyers and rewritten by RMS.
33 (defvar outline-regexp
"[*\^l]+"
34 "*Regular expression to match the beginning of a heading.
35 Any line whose beginning matches this regexp is considered to start a heading.
36 The recommended way to set this is with a Local Variables: list
37 in the file it applies to. See also outline-heading-end-regexp.")
39 (defvar outline-heading-end-regexp
"[\n\^M]"
40 "*Regular expression to match the end of a heading line.
41 You can assume that point is at the beginning of a heading when this
42 regexp is searched for. The heading ends at the end of the match.
43 The recommended way to set this is with a \"Local Variables:\" list
44 in the file it applies to.")
46 (defvar outline-mode-map nil
"")
50 (setq outline-mode-map
(nconc (make-sparse-keymap) text-mode-map
))
51 (define-key outline-mode-map
"\C-c\C-n" 'outline-next-visible-heading
)
52 (define-key outline-mode-map
"\C-c\C-p" 'outline-previous-visible-heading
)
53 (define-key outline-mode-map
"\C-c\C-i" 'show-children
)
54 (define-key outline-mode-map
"\C-c\C-s" 'show-subtree
)
55 (define-key outline-mode-map
"\C-c\C-h" 'hide-subtree
)
56 (define-key outline-mode-map
"\C-c\C-u" 'outline-up-heading
)
57 (define-key outline-mode-map
"\C-c\C-f" 'outline-forward-same-level
)
58 (define-key outline-mode-map
"\C-c\C-b" 'outline-backward-same-level
)
60 (define-key outline-mode-map
[menu-bar hide
]
61 (cons "Hide" (make-sparse-keymap "Hide")))
63 (define-key outline-mode-map
[menu-bar hide hide-subtree
]
64 '("Hide Subtree" . hide-subtree
))
65 (define-key outline-mode-map
[menu-bar hide hide-entry
]
66 '("Hide Entry" . hide-entry
))
67 (define-key outline-mode-map
[menu-bar hide hide-body
]
68 '("Hide Body" . hide-body
))
69 (define-key outline-mode-map
[menu-bar hide hide-leaves
]
70 '("Hide Leaves" . hide-leaves
))
72 (define-key outline-mode-map
[menu-bar show
]
73 (cons "Show" (make-sparse-keymap "Show")))
75 (define-key outline-mode-map
[menu-bar show show-subtree
]
76 '("Show Subtree" . show-subtree
))
77 (define-key outline-mode-map
[menu-bar show show-children
]
78 '("Show Children" . show-children
))
79 (define-key outline-mode-map
[menu-bar show show-branches
]
80 '("Show Branches" . show-branches
))
81 (define-key outline-mode-map
[menu-bar show show-entry
]
82 '("Show Entry" . show-entry
))
83 (define-key outline-mode-map
[menu-bar show show-all
]
84 '("Show All" . show-all
))
86 (define-key outline-mode-map
[menu-bar headings
]
87 (cons "Headings" (make-sparse-keymap "Headings")))
89 (define-key outline-mode-map
[menu-bar headings outline-backward-same-level
]
90 '("Previous Same Level" . outline-backward-same-level
))
91 (define-key outline-mode-map
[menu-bar headings outline-forward-same-level
]
92 '("Next Same Level" . outline-forward-same-level
))
93 (define-key outline-mode-map
[menu-bar headings outline-previous-visible-heading
]
94 '("Previous" . outline-previous-visible-heading
))
95 (define-key outline-mode-map
[menu-bar headings outline-next-visible-heading
]
96 '("Next" . outline-next-visible-heading
))
97 (define-key outline-mode-map
[menu-bar headings outline-up-heading
]
98 '("Up" . outline-up-heading
)))
100 (defvar outline-minor-mode nil
101 "Non-nil if using Outline mode as a minor mode of some other mode.")
102 (make-variable-buffer-local 'outline-minor-mode
)
103 (put 'outline-minor-mode
'permanent-local t
)
104 (setq minor-mode-alist
(append minor-mode-alist
105 (list '(outline-minor-mode " Outl"))))
108 (defun outline-mode ()
109 "Set major mode for editing outlines with selective display.
110 Headings are lines which start with asterisks: one for major headings,
111 two for subheadings, etc. Lines not starting with asterisks are body lines.
113 Body text or subheadings under a heading can be made temporarily
114 invisible, or visible again. Invisible lines are attached to the end
115 of the heading, so they move with it, if the line is killed and yanked
116 back. A heading with text hidden under it is marked with an ellipsis (...).
118 Commands:\\<outline-mode-map>
119 \\[outline-next-visible-heading] outline-next-visible-heading move by visible headings
120 \\[outline-previous-visible-heading] outline-previous-visible-heading
121 \\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings
122 \\[outline-backward-same-level] outline-backward-same-level
123 \\[outline-up-heading] outline-up-heading move from subheading to heading
125 M-x hide-body make all text invisible (not headings).
126 M-x show-all make everything in buffer visible.
128 The remaining commands are used when point is on a heading line.
129 They apply to some of the body or subheadings of that heading.
130 \\[hide-subtree] hide-subtree make body and subheadings invisible.
131 \\[show-subtree] show-subtree make body and subheadings visible.
132 \\[show-children] show-children make direct subheadings visible.
133 No effect on body, or subheadings 2 or more levels down.
134 With arg N, affects subheadings N levels down.
135 M-x hide-entry make immediately following body invisible.
136 M-x show-entry make it visible.
137 M-x hide-leaves make body under heading and under its subheadings invisible.
138 The subheadings remain visible.
139 M-x show-branches make all subheadings at all levels visible.
141 The variable `outline-regexp' can be changed to control what is a heading.
142 A line is a heading if `outline-regexp' matches something at the
143 beginning of the line. The longer the match, the deeper the level.
145 Turning on outline mode calls the value of `text-mode-hook' and then of
146 `outline-mode-hook', if they are non-nil."
148 (kill-all-local-variables)
149 (setq selective-display t
)
150 (use-local-map outline-mode-map
)
151 (setq mode-name
"Outline")
152 (setq major-mode
'outline-mode
)
153 (define-abbrev-table 'text-mode-abbrev-table
())
154 (setq local-abbrev-table text-mode-abbrev-table
)
155 (set-syntax-table text-mode-syntax-table
)
156 (make-local-variable 'paragraph-start
)
157 (setq paragraph-start
(concat paragraph-start
"\\|^\\("
158 outline-regexp
"\\)"))
159 ;; Inhibit auto-filling of header lines.
160 (make-local-variable 'auto-fill-inhibit-regexp
)
161 (setq auto-fill-inhibit-regexp outline-regexp
)
162 (make-local-variable 'paragraph-separate
)
163 (setq paragraph-separate
(concat paragraph-separate
"\\|^\\("
164 outline-regexp
"\\)"))
165 (run-hooks 'text-mode-hook
'outline-mode-hook
))
167 (defvar outline-minor-mode-map nil
)
168 (if outline-minor-mode-map
170 (setq outline-minor-mode-map
(make-sparse-keymap))
171 (define-key outline-minor-mode-map
[menu-bar
]
172 (lookup-key outline-mode-map
[menu-bar
]))
173 (define-key outline-minor-mode-map
"\C-c"
174 (lookup-key outline-mode-map
"\C-c")))
176 (or (assq 'outline-minor-mode minor-mode-map-alist
)
177 (setq minor-mode-map-alist
178 (cons (cons 'outline-minor-mode outline-minor-mode-map
)
179 minor-mode-map-alist
)))
182 (defun outline-minor-mode (&optional arg
)
183 "Toggle Outline minor mode.
184 With arg, turn Outline minor mode on if arg is positive, off otherwise.
185 See the command `outline-mode' for more information on this mode."
187 (setq outline-minor-mode
188 (if (null arg
) (not outline-minor-mode
)
189 (> (prefix-numeric-value arg
) 0)))
190 (if outline-minor-mode
192 (setq selective-display t
)
193 (run-hooks 'outline-minor-mode-hook
))
194 (setq selective-display nil
)))
196 (defun outline-level ()
197 "Return the depth to which a statement is nested in the outline.
198 Point must be at the beginning of a header line. This is actually
199 the column number of the end of what `outline-regexp matches'."
201 (looking-at outline-regexp
)
202 (save-excursion (goto-char (match-end 0)) (current-column))))
204 (defun outline-next-preface ()
205 "Skip forward to just before the next heading line."
206 (if (re-search-forward (concat "[\n\^M]\\(" outline-regexp
"\\)")
208 (goto-char (match-beginning 0)))
209 (if (memq (preceding-char) '(?
\n ?\^M
))
212 (defun outline-next-heading ()
213 "Move to the next (possibly invisible) heading line."
215 (if (re-search-forward (concat "[\n\^M]\\(" outline-regexp
"\\)")
217 (goto-char (1+ (match-beginning 0)))))
219 (defun outline-back-to-heading ()
220 "Move to previous (possibly invisible) heading line,
221 or to the beginning of this line if it is a heading line."
223 (or (outline-on-heading-p)
224 (re-search-backward (concat "^\\(" outline-regexp
"\\)") nil
'move
)))
226 (defun outline-on-heading-p ()
227 "Return T if point is on a header line."
230 (and (eq (preceding-char) ?
\n)
231 (looking-at outline-regexp
))))
233 (defun outline-end-of-heading ()
234 (if (re-search-forward outline-heading-end-regexp nil
'move
)
237 (defun outline-next-visible-heading (arg)
238 "Move to the next visible heading line.
239 With argument, repeats or can move backward if negative.
240 A heading line is one that starts with a `*' (or that
241 `outline-regexp' matches)."
246 (re-search-forward (concat "^\\(" outline-regexp
"\\)") nil nil arg
)
249 (defun outline-previous-visible-heading (arg)
250 "Move to the previous heading line.
251 With argument, repeats or can move forward if negative.
252 A heading line is one that starts with a `*' (or that
253 `outline-regexp' matches)."
255 (outline-next-visible-heading (- arg
)))
257 (defun outline-flag-region (from to flag
)
258 "Hides or shows lines from FROM to TO, according to FLAG.
259 If FLAG is `\\n' (newline character) then text is shown,
260 while if FLAG is `\\^M' (control-M) the text is hidden."
261 (let (buffer-read-only)
262 (subst-char-in-region from to
263 (if (= flag ?
\n) ?\^M ?
\n)
267 "Hide the body directly following this heading."
269 (outline-back-to-heading)
270 (outline-end-of-heading)
272 (outline-flag-region (point) (progn (outline-next-preface) (point)) ?\^M
)))
275 "Show the body directly following this heading."
278 (outline-flag-region (point) (progn (outline-next-preface) (point)) ?
\n)))
281 "Hide all of buffer except headings."
283 (hide-region-body (point-min) (point-max)))
285 (defun hide-region-body (start end
)
286 "Hide all body lines in the region, but not headings."
289 (narrow-to-region start end
)
290 (goto-char (point-min))
291 (if (outline-on-heading-p)
292 (outline-end-of-heading))
294 (outline-flag-region (point)
295 (progn (outline-next-preface) (point)) ?\^M
)
299 (if (looking-at "[\n\^M][\n\^M]")
301 (outline-end-of-heading)))))))
304 "Show all of the text in the buffer."
306 (outline-flag-region (point-min) (point-max) ?
\n))
308 (defun hide-subtree ()
309 "Hide everything after this heading at deeper levels."
311 (outline-flag-subtree ?\^M
))
313 (defun hide-leaves ()
314 "Hide all body after this heading at deeper levels."
316 (outline-back-to-heading)
317 (outline-end-of-heading)
318 (hide-region-body (point) (progn (outline-end-of-subtree) (point))))
320 (defun show-subtree ()
321 "Show everything after this heading at deeper levels."
323 (outline-flag-subtree ?
\n))
325 (defun outline-flag-subtree (flag)
327 (outline-back-to-heading)
328 (outline-end-of-heading)
329 (outline-flag-region (point)
330 (progn (outline-end-of-subtree) (point))
333 (defun outline-end-of-subtree ()
334 (outline-back-to-heading)
335 (let ((opoint (point))
337 (level (outline-level)))
338 (while (and (not (eobp))
339 (or first
(> (outline-level) level
)))
341 (outline-next-heading))
343 (if (memq (preceding-char) '(?
\n ?\^M
))
346 (defun show-branches ()
347 "Show all subheadings of this heading, but not their bodies."
349 (show-children 1000))
351 (defun show-children (&optional level
)
352 "Show all direct subheadings of this heading.
353 Prefix arg LEVEL is how many levels below the current level should be shown.
354 Default is enough to cause the following heading to appear."
357 (if level
(prefix-numeric-value level
)
360 (let ((start-level (outline-level)))
361 (outline-next-heading)
362 (max 1 (- (outline-level) start-level
))))))
366 (setq level
(+ level
(outline-level)))
367 (narrow-to-region (point)
368 (progn (outline-end-of-subtree) (1+ (point))))
369 (goto-char (point-min))
370 (while (and (not (eobp))
372 (outline-next-heading)
374 (if (<= (outline-level) level
)
376 (outline-flag-region (save-excursion
378 (if (memq (preceding-char) '(?
\n ?\^M
))
381 (progn (outline-end-of-heading) (point))
384 (defun outline-up-heading (arg)
385 "Move to the heading line of which the present line is a subheading.
386 With argument, move up ARG levels."
388 (outline-back-to-heading)
389 (if (eq (outline-level) 1)
391 (while (and (> (outline-level) 1)
394 (let ((present-level (outline-level)))
395 (while (not (< (outline-level) present-level
))
396 (outline-previous-visible-heading 1))
397 (setq arg
(- arg
1)))))
399 (defun outline-forward-same-level (arg)
400 "Move forward to the ARG'th subheading from here of the same level as the
401 present one. It stops at the first and last subheadings of a superior heading."
403 (outline-back-to-heading)
405 (let ((point-to-move-to (save-excursion
406 (outline-get-next-sibling))))
409 (goto-char point-to-move-to
)
415 (defun outline-get-next-sibling ()
416 "Position the point at the next heading of the same level,
417 and return that position or nil if it cannot be found."
418 (let ((level (outline-level)))
419 (outline-next-visible-heading 1)
420 (while (and (> (outline-level) level
)
422 (outline-next-visible-heading 1))
423 (if (< (outline-level) level
)
427 (defun outline-backward-same-level (arg)
428 "Move backward to the ARG'th subheading from here of the same level as the
429 present one. It stops at the first and last subheadings of a superior heading."
431 (outline-back-to-heading)
433 (let ((point-to-move-to (save-excursion
434 (outline-get-last-sibling))))
437 (goto-char point-to-move-to
)
443 (defun outline-get-last-sibling ()
444 "Position the point at the previous heading of the same level,
445 and return that position or nil if it cannot be found."
446 (let ((level (outline-level)))
447 (outline-previous-visible-heading 1)
448 (while (and (> (outline-level) level
)
450 (outline-previous-visible-heading 1))
451 (if (< (outline-level) level
)
457 ;;; outline.el ends here