1 ;;; ooutline.el --- outline mode commands for Emacs
3 ;; Copyright (C) 1986, 1993, 1994, 1997 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; This package is a major mode for editing outline-format documents.
28 ;; An outline can be `abstracted' to show headers at any given level,
29 ;; with all stuff below hidden. See the Emacs manual for details.
33 ;; Jan '86, Some new features added by Peter Desnoyers and rewritten by RMS.
35 (defgroup outlines nil
36 "Support for hierarchical outlining"
41 (defcustom outline-regexp nil
42 "*Regular expression to match the beginning of a heading.
43 Any line whose beginning matches this regexp is considered to start a heading.
44 The recommended way to set this is with a Local Variables: list
45 in the file it applies to. See also outline-heading-end-regexp."
46 :type
'(choice regexp
(const nil
))
49 ;; Can't initialize this in the defvar above -- some major modes have
50 ;; already assigned a local value to it.
51 (or (default-value 'outline-regexp
)
52 (setq-default outline-regexp
"[*\^L]+"))
54 (defcustom outline-heading-end-regexp
"[\n\^M]"
55 "*Regular expression to match the end of a heading line.
56 You can assume that point is at the beginning of a heading when this
57 regexp is searched for. The heading ends at the end of the match.
58 The recommended way to set this is with a \"Local Variables:\" list
59 in the file it applies to."
63 (defvar outline-mode-prefix-map nil
)
65 (if outline-mode-prefix-map
67 (setq outline-mode-prefix-map
(make-sparse-keymap))
68 (define-key outline-mode-prefix-map
"\C-n" 'outline-next-visible-heading
)
69 (define-key outline-mode-prefix-map
"\C-p" 'outline-previous-visible-heading
)
70 (define-key outline-mode-prefix-map
"\C-i" 'show-children
)
71 (define-key outline-mode-prefix-map
"\C-s" 'show-subtree
)
72 (define-key outline-mode-prefix-map
"\C-d" 'hide-subtree
)
73 (define-key outline-mode-prefix-map
"\C-u" 'outline-up-heading
)
74 (define-key outline-mode-prefix-map
"\C-f" 'outline-forward-same-level
)
75 (define-key outline-mode-prefix-map
"\C-b" 'outline-backward-same-level
)
76 (define-key outline-mode-prefix-map
"\C-t" 'hide-body
)
77 (define-key outline-mode-prefix-map
"\C-a" 'show-all
)
78 (define-key outline-mode-prefix-map
"\C-c" 'hide-entry
)
79 (define-key outline-mode-prefix-map
"\C-e" 'show-entry
)
80 (define-key outline-mode-prefix-map
"\C-l" 'hide-leaves
)
81 (define-key outline-mode-prefix-map
"\C-k" 'show-branches
)
82 (define-key outline-mode-prefix-map
"\C-q" 'hide-sublevels
)
83 (define-key outline-mode-prefix-map
"\C-o" 'hide-other
))
85 (defvar outline-mode-menu-bar-map nil
)
86 (if outline-mode-menu-bar-map
88 (setq outline-mode-menu-bar-map
(make-sparse-keymap))
90 (define-key outline-mode-menu-bar-map
[hide]
91 (cons "Hide" (make-sparse-keymap "Hide")))
93 (define-key outline-mode-menu-bar-map [hide hide-other]
94 '("Hide Other" . hide-other))
95 (define-key outline-mode-menu-bar-map [hide hide-sublevels]
96 '("Hide Sublevels" . hide-sublevels))
97 (define-key outline-mode-menu-bar-map [hide hide-subtree]
98 '("Hide Subtree" . hide-subtree))
99 (define-key outline-mode-menu-bar-map [hide hide-entry]
100 '("Hide Entry" . hide-entry))
101 (define-key outline-mode-menu-bar-map [hide hide-body]
102 '("Hide Body" . hide-body))
103 (define-key outline-mode-menu-bar-map [hide hide-leaves]
104 '("Hide Leaves" . hide-leaves))
106 (define-key outline-mode-menu-bar-map [show]
107 (cons "Show" (make-sparse-keymap "Show")))
109 (define-key outline-mode-menu-bar-map [show show-subtree]
110 '("Show Subtree" . show-subtree))
111 (define-key outline-mode-menu-bar-map [show show-children]
112 '("Show Children" . show-children))
113 (define-key outline-mode-menu-bar-map [show show-branches]
114 '("Show Branches" . show-branches))
115 (define-key outline-mode-menu-bar-map [show show-entry]
116 '("Show Entry" . show-entry))
117 (define-key outline-mode-menu-bar-map [show show-all]
118 '("Show All" . show-all))
120 (define-key outline-mode-menu-bar-map [headings]
121 (cons "Headings" (make-sparse-keymap "Headings")))
123 (define-key outline-mode-menu-bar-map [headings outline-backward-same-level]
124 '("Previous Same Level" . outline-backward-same-level))
125 (define-key outline-mode-menu-bar-map [headings outline-forward-same-level]
126 '("Next Same Level" . outline-forward-same-level))
127 (define-key outline-mode-menu-bar-map [headings outline-previous-visible-heading]
128 '("Previous" . outline-previous-visible-heading))
129 (define-key outline-mode-menu-bar-map [headings outline-next-visible-heading]
130 '("Next" . outline-next-visible-heading))
131 (define-key outline-mode-menu-bar-map [headings outline-up-heading]
132 '("Up" . outline-up-heading)))
134 (defvar outline-mode-map nil "")
138 (setq outline-mode-map (nconc (make-sparse-keymap) text-mode-map))
139 (define-key outline-mode-map "\C-c" outline-mode-prefix-map)
140 (define-key outline-mode-map [menu-bar] outline-mode-menu-bar-map))
142 (defcustom outline-minor-mode nil
143 "Non-nil if using Outline mode as a minor mode of some other mode."
146 (make-variable-buffer-local 'outline-minor-mode)
147 (put 'outline-minor-mode 'permanent-local t)
148 (or (assq 'outline-minor-mode minor-mode-alist)
149 (setq minor-mode-alist (append minor-mode-alist
150 (list '(outline-minor-mode " Outl")))))
152 (defvar outline-font-lock-keywords
153 '(;; Highlight headings according to the level.
154 ("^\\([*]+\\)[ \t]*\\([^\n\r]+\\)?[ \t]*[\n\r]"
155 (1 font-lock-string-face)
156 (2 (let ((len (- (match-end 1) (match-beginning 1))))
157 (or (cdr (assq len '((1 . font-lock-function-name-face)
158 (2 . font-lock-keyword-face)
159 (3 . font-lock-comment-face))))
160 font-lock-variable-name-face))
162 ;; Highlight citations of the form [1] and [Mar94].
163 ("\\[\\([[:upper:]][[:alpha:]]+\\)*[0-9]+\\]" . font-lock-type-face))
164 "Additional expressions to highlight in Outline mode.")
166 (defun outline-mode ()
167 "Set major mode for editing outlines with selective display.
168 Headings are lines which start with asterisks: one for major headings,
169 two for subheadings, etc. Lines not starting with asterisks are body lines.
171 Body text or subheadings under a heading can be made temporarily
172 invisible, or visible again. Invisible lines are attached to the end
173 of the heading, so they move with it, if the line is killed and yanked
174 back. A heading with text hidden under it is marked with an ellipsis (...).
176 Commands:\\<outline-mode-map>
177 \\[outline-next-visible-heading] outline-next-visible-heading move by visible headings
178 \\[outline-previous-visible-heading] outline-previous-visible-heading
179 \\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings
180 \\[outline-backward-same-level] outline-backward-same-level
181 \\[outline-up-heading] outline-up-heading move from subheading to heading
183 \\[hide-body] make all text invisible (not headings).
184 \\[show-all] make everything in buffer visible.
186 The remaining commands are used when point is on a heading line.
187 They apply to some of the body or subheadings of that heading.
188 \\[hide-subtree] hide-subtree make body and subheadings invisible.
189 \\[show-subtree] show-subtree make body and subheadings visible.
190 \\[show-children] show-children make direct subheadings visible.
191 No effect on body, or subheadings 2 or more levels down.
192 With arg N, affects subheadings N levels down.
193 \\[hide-entry] make immediately following body invisible.
194 \\[show-entry] make it visible.
195 \\[hide-leaves] make body under heading and under its subheadings invisible.
196 The subheadings remain visible.
197 \\[show-branches] make all subheadings at all levels visible.
199 The variable `outline-regexp' can be changed to control what is a heading.
200 A line is a heading if `outline-regexp' matches something at the
201 beginning of the line. The longer the match, the deeper the level.
203 Turning on outline mode calls the value of `text-mode-hook' and then of
204 `outline-mode-hook', if they are non-nil."
206 (kill-all-local-variables)
207 (setq selective-display t)
208 (use-local-map outline-mode-map)
209 (setq mode-name "Outline")
210 (setq major-mode 'outline-mode)
211 (define-abbrev-table 'text-mode-abbrev-table ())
212 (setq local-abbrev-table text-mode-abbrev-table)
213 (set-syntax-table text-mode-syntax-table)
214 (make-local-variable 'paragraph-start)
215 (setq paragraph-start (concat paragraph-start "\\|\\("
216 outline-regexp "\\)"))
217 ;; Inhibit auto-filling of header lines.
218 (make-local-variable 'auto-fill-inhibit-regexp)
219 (setq auto-fill-inhibit-regexp outline-regexp)
220 (make-local-variable 'paragraph-separate)
221 (setq paragraph-separate (concat paragraph-separate "\\|\\("
222 outline-regexp "\\)"))
223 (make-local-variable 'font-lock-defaults)
224 (setq font-lock-defaults '(outline-font-lock-keywords t))
225 (make-local-variable 'change-major-mode-hook)
226 (add-hook 'change-major-mode-hook 'show-all)
227 (run-hooks 'text-mode-hook 'outline-mode-hook))
229 (defcustom outline-minor-mode-prefix "\C-c@"
230 "*Prefix key to use for Outline commands in Outline minor mode.
231 The value of this variable is checked as part of loading Outline mode.
232 After that, changing the prefix key requires manipulating keymaps."
236 (defvar outline-minor-mode-map nil)
237 (if outline-minor-mode-map
239 (setq outline-minor-mode-map (make-sparse-keymap))
240 (define-key outline-minor-mode-map [menu-bar]
241 outline-mode-menu-bar-map)
242 (define-key outline-minor-mode-map outline-minor-mode-prefix
243 outline-mode-prefix-map))
245 (or (assq 'outline-minor-mode minor-mode-map-alist)
246 (setq minor-mode-map-alist
247 (cons (cons 'outline-minor-mode outline-minor-mode-map)
248 minor-mode-map-alist)))
250 (defun outline-minor-mode (&optional arg)
251 "Toggle Outline minor mode.
252 With arg, turn Outline minor mode on if arg is positive, off otherwise.
253 See the command `outline-mode' for more information on this mode."
255 (setq outline-minor-mode
256 (if (null arg) (not outline-minor-mode)
257 (> (prefix-numeric-value arg) 0)))
258 (if outline-minor-mode
260 (setq selective-display t)
261 (run-hooks 'outline-minor-mode-hook))
262 (setq selective-display nil))
263 ;; When turning off outline mode, get rid of any ^M's.
264 (or outline-minor-mode
265 (outline-flag-region (point-min) (point-max) ?\n))
266 (force-mode-line-update))
268 (defvar outline-level 'outline-level
269 "Function of no args to compute a header's nesting level in an outline.
270 It can assume point is at the beginning of a header line.")
272 ;; This used to count columns rather than characters, but that made ^L
273 ;; appear to be at level 2 instead of 1. Columns would be better for
274 ;; tab handling, but the default regexp doesn't use tabs, and anyone
275 ;; who changes the regexp can also redefine the outline-level variable
277 (defun outline-level ()
278 "Return the depth to which a statement is nested in the outline.
279 Point must be at the beginning of a header line. This is actually
280 the number of characters that `outline-regexp' matches."
282 (looking-at outline-regexp)
283 (- (match-end 0) (match-beginning 0))))
285 (defun outline-next-preface ()
286 "Skip forward to just before the next heading line.
287 If there's no following heading line, stop before the newline
288 at the end of the buffer."
289 (if (re-search-forward (concat "[\n\^M]\\(" outline-regexp "\\)")
291 (goto-char (match-beginning 0)))
292 (if (memq (preceding-char) '(?\n ?\^M))
295 (defun outline-next-heading ()
296 "Move to the next (possibly invisible) heading line."
298 (if (re-search-forward (concat "[\n\^M]\\(" outline-regexp "\\)")
300 (goto-char (1+ (match-beginning 0)))))
302 (defun outline-back-to-heading ()
303 "Move to previous heading line, or beg of this line if it's a heading.
304 Only visible heading lines are considered."
306 (or (outline-on-heading-p)
307 (re-search-backward (concat "^\\(" outline-regexp "\\)") nil t)
308 (error "before first heading")))
310 (defun outline-on-heading-p ()
311 "Return t if point is on a (visible) heading line."
315 (looking-at outline-regexp))))
317 (defun outline-end-of-heading ()
318 (if (re-search-forward outline-heading-end-regexp nil 'move)
321 (defun outline-next-visible-heading (arg)
322 "Move to the next visible heading line.
323 With argument, repeats or can move backward if negative.
324 A heading line is one that starts with a `*' (or that
325 `outline-regexp' matches)."
330 (or (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t arg)
334 (defun outline-previous-visible-heading (arg)
335 "Move to the previous heading line.
336 With argument, repeats or can move forward if negative.
337 A heading line is one that starts with a `*' (or that
338 `outline-regexp' matches)."
340 (outline-next-visible-heading (- arg)))
342 (defun outline-flag-region (from to flag)
343 "Hides or shows lines from FROM to TO, according to FLAG.
344 If FLAG is `\\n' (newline character) then text is shown,
345 while if FLAG is `\\^M' (control-M) the text is hidden."
346 (let (buffer-read-only)
347 (subst-char-in-region from to
348 (if (= flag ?\n) ?\^M ?\n)
352 "Hide the body directly following this heading."
354 (outline-back-to-heading)
355 (outline-end-of-heading)
357 (outline-flag-region (point) (progn (outline-next-preface) (point)) ?\^M)))
360 "Show the body directly following this heading."
363 (outline-flag-region (point) (progn (outline-next-preface) (point)) ?\n)))
366 "Hide all of buffer except headings."
368 (hide-region-body (point-min) (point-max)))
370 (defun hide-region-body (start end)
371 "Hide all body lines in the region, but not headings."
374 (narrow-to-region start end)
375 (goto-char (point-min))
376 (if (outline-on-heading-p)
377 (outline-end-of-heading))
379 (outline-flag-region (point)
380 (progn (outline-next-preface) (point)) ?\^M)
384 (if (looking-at "[\n\^M][\n\^M]")
386 (outline-end-of-heading)))))))
389 "Show all of the text in the buffer."
391 (outline-flag-region (point-min) (point-max) ?\n))
393 (defun hide-subtree ()
394 "Hide everything after this heading at deeper levels."
396 (outline-flag-subtree ?\^M))
398 (defun hide-leaves ()
399 "Hide all body after this heading at deeper levels."
401 (outline-back-to-heading)
402 (outline-end-of-heading)
403 (hide-region-body (point) (progn (outline-end-of-subtree) (point))))
405 (defun show-subtree ()
406 "Show everything after this heading at deeper levels."
408 (outline-flag-subtree ?\n))
410 (defun hide-sublevels (levels)
411 "Hide everything but the top LEVELS levels of headers, in whole buffer."
414 (error "Must keep at least one level of headers"))
415 (setq levels (1- levels))
417 (goto-char (point-min))
418 ;; Keep advancing to the next top-level heading.
419 (while (or (and (bobp) (outline-on-heading-p))
420 (outline-next-heading))
421 (let ((end (save-excursion (outline-end-of-subtree) (point))))
422 ;; Hide everything under that.
423 (outline-flag-region (point) end ?\^M)
424 ;; Show the first LEVELS levels under that.
426 (show-children levels))
427 ;; Move to the next, since we already found it.
431 "Hide everything except for the current body and the parent headings."
436 (while (save-excursion
437 (and (re-search-backward "[\n\r]" nil t)
438 (eq (following-char) ?\r)))
441 (if (eq last (point))
443 (outline-next-heading)
444 (outline-flag-region last (point) ?\n))
446 (setq last (point)))))))
448 (defun outline-flag-subtree (flag)
450 (outline-back-to-heading)
451 (outline-end-of-heading)
452 (outline-flag-region (point)
453 (progn (outline-end-of-subtree) (point))
456 (defun outline-end-of-subtree ()
457 (outline-back-to-heading)
458 (let ((opoint (point))
460 (level (funcall outline-level)))
461 (while (and (not (eobp))
462 (or first (> (funcall outline-level) level)))
464 (outline-next-heading))
465 (if (memq (preceding-char) '(?\n ?\^M))
467 ;; Go to end of line before heading
469 (if (memq (preceding-char) '(?\n ?\^M))
470 ;; leave blank line before heading
471 (forward-char -1))))))
473 (defun show-branches ()
474 "Show all subheadings of this heading, but not their bodies."
476 (show-children 1000))
478 (defun show-children (&optional level)
479 "Show all direct subheadings of this heading.
480 Prefix arg LEVEL is how many levels below the current level should be shown.
481 Default is enough to cause the following heading to appear."
484 (if level (prefix-numeric-value level)
486 (outline-back-to-heading)
487 (let ((start-level (funcall outline-level)))
488 (outline-next-heading)
491 (max 1 (- (funcall outline-level) start-level)))))))
494 (outline-back-to-heading)
495 (setq level (+ level (funcall outline-level)))
496 (narrow-to-region (point)
497 (progn (outline-end-of-subtree)
498 (if (eobp) (point-max) (1+ (point)))))
499 (goto-char (point-min))
500 (while (and (not (eobp))
502 (outline-next-heading)
504 (if (<= (funcall outline-level) level)
506 (outline-flag-region (save-excursion
508 (if (memq (preceding-char) '(?\n ?\^M))
511 (progn (outline-end-of-heading) (point))
514 (defun outline-up-heading (arg)
515 "Move to the heading line of which the present line is a subheading.
516 With argument, move up ARG levels."
518 (outline-back-to-heading)
519 (if (eq (funcall outline-level) 1)
521 (while (and (> (funcall outline-level) 1)
524 (let ((present-level (funcall outline-level)))
525 (while (not (< (funcall outline-level) present-level))
526 (outline-previous-visible-heading 1))
527 (setq arg (- arg 1)))))
529 (defun outline-forward-same-level (arg)
530 "Move forward to the ARG'th subheading at same level as this one.
531 Stop at the first and last subheadings of a superior heading."
533 (outline-back-to-heading)
535 (let ((point-to-move-to (save-excursion
536 (outline-get-next-sibling))))
539 (goto-char point-to-move-to)
545 (defun outline-get-next-sibling ()
546 "Move to next heading of the same level, and return point or nil if none."
547 (let ((level (funcall outline-level)))
548 (outline-next-visible-heading 1)
549 (while (and (> (funcall outline-level) level)
551 (outline-next-visible-heading 1))
552 (if (< (funcall outline-level) level)
556 (defun outline-backward-same-level (arg)
557 "Move backward to the ARG'th subheading at same level as this one.
558 Stop at the first and last subheadings of a superior heading."
560 (outline-back-to-heading)
562 (let ((point-to-move-to (save-excursion
563 (outline-get-last-sibling))))
566 (goto-char point-to-move-to)
572 (defun outline-get-last-sibling ()
573 "Move to next heading of the same level, and return point or nil if none."
574 (let ((level (funcall outline-level)))
575 (outline-previous-visible-heading 1)
576 (while (and (> (funcall outline-level) level)
578 (outline-previous-visible-heading 1))
579 (if (< (funcall outline-level) level)
585 ;;; ooutline.el ends here