annotate lisp/textmodes/ooutline.el @ 9975:e21b0674f37c

* etags.c (<errno.h>): #include added. (etags_getcwd): Check return value from getcwd.
author Francesco Potortì <pot@gnu.org>
date Wed, 16 Nov 1994 10:29:33 +0000
parents a8077b802b9e
children 388da827814c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
659
505130d1ddf8 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 258
diff changeset
1 ;;; outline.el --- outline mode commands for Emacs
7298
4fd40bd394fe Update copyright.
Karl Heuer <kwzh@gnu.org>
parents: 7269
diff changeset
2 ;; Copyright (C) 1986, 1993, 1994 Free Software Foundation, Inc.
845
213978acbc1e entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 807
diff changeset
3
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 730
diff changeset
4 ;; Maintainer: FSF
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
5
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
6 ;; This file is part of GNU Emacs.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
7
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
9 ;; it under the terms of the GNU General Public License as published by
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 730
diff changeset
10 ;; the Free Software Foundation; either version 2, or (at your option)
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
11 ;; any later version.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
12
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
13 ;; GNU Emacs is distributed in the hope that it will be useful,
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
16 ;; GNU General Public License for more details.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
17
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
18 ;; You should have received a copy of the GNU General Public License
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
19 ;; along with GNU Emacs; see the file COPYING. If not, write to
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
20 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
21
2308
f287613dfc28 Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 845
diff changeset
22 ;;; Commentary:
f287613dfc28 Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 845
diff changeset
23
f287613dfc28 Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 845
diff changeset
24 ;; This package is a major mode for editing outline-format documents.
f287613dfc28 Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 845
diff changeset
25 ;; An outline can be `abstracted' to show headers at any given level,
f287613dfc28 Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 845
diff changeset
26 ;; with all stuff below hidden. See the Emacs manual for details.
f287613dfc28 Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 845
diff changeset
27
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 730
diff changeset
28 ;;; Code:
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 730
diff changeset
29
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
30 ;; Jan '86, Some new features added by Peter Desnoyers and rewritten by RMS.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
31
6274
ec7e22ebd6b3 (outline-regexp): Initialize outside the defvar.
Karl Heuer <kwzh@gnu.org>
parents: 6175
diff changeset
32 (defvar outline-regexp nil
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
33 "*Regular expression to match the beginning of a heading.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
34 Any line whose beginning matches this regexp is considered to start a heading.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
35 The recommended way to set this is with a Local Variables: list
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
36 in the file it applies to. See also outline-heading-end-regexp.")
6274
ec7e22ebd6b3 (outline-regexp): Initialize outside the defvar.
Karl Heuer <kwzh@gnu.org>
parents: 6175
diff changeset
37
ec7e22ebd6b3 (outline-regexp): Initialize outside the defvar.
Karl Heuer <kwzh@gnu.org>
parents: 6175
diff changeset
38 ;; Can't initialize this in the defvar above -- some major modes have
ec7e22ebd6b3 (outline-regexp): Initialize outside the defvar.
Karl Heuer <kwzh@gnu.org>
parents: 6175
diff changeset
39 ;; already assigned a local value to it.
ec7e22ebd6b3 (outline-regexp): Initialize outside the defvar.
Karl Heuer <kwzh@gnu.org>
parents: 6175
diff changeset
40 (or (default-value 'outline-regexp)
ec7e22ebd6b3 (outline-regexp): Initialize outside the defvar.
Karl Heuer <kwzh@gnu.org>
parents: 6175
diff changeset
41 (setq-default outline-regexp "[*\^L]+"))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
42
2900
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
43 (defvar outline-heading-end-regexp "[\n\^M]"
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
44 "*Regular expression to match the end of a heading line.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
45 You can assume that point is at the beginning of a heading when this
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
46 regexp is searched for. The heading ends at the end of the match.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
47 The recommended way to set this is with a \"Local Variables:\" list
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
48 in the file it applies to.")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
49
8643
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
50 (defvar outline-mode-prefix-map nil)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
51
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
52 (if outline-mode-prefix-map
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
53 nil
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
54 (setq outline-mode-prefix-map (make-sparse-keymap))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
55 (define-key outline-mode-prefix-map "\C-n" 'outline-next-visible-heading)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
56 (define-key outline-mode-prefix-map "\C-p" 'outline-previous-visible-heading)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
57 (define-key outline-mode-prefix-map "\C-i" 'show-children)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
58 (define-key outline-mode-prefix-map "\C-s" 'show-subtree)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
59 (define-key outline-mode-prefix-map "\C-d" 'hide-subtree)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
60 (define-key outline-mode-prefix-map "\C-u" 'outline-up-heading)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
61 (define-key outline-mode-prefix-map "\C-f" 'outline-forward-same-level)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
62 (define-key outline-mode-prefix-map "\C-b" 'outline-backward-same-level)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
63 (define-key outline-mode-prefix-map "\C-t" 'hide-body)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
64 (define-key outline-mode-prefix-map "\C-a" 'show-all)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
65 (define-key outline-mode-prefix-map "\C-c" 'hide-entry)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
66 (define-key outline-mode-prefix-map "\C-e" 'show-entry)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
67 (define-key outline-mode-prefix-map "\C-l" 'hide-leaves)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
68 (define-key outline-mode-prefix-map "\C-k" 'show-branches)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
69 (define-key outline-mode-prefix-map "\C-q" 'hide-sublevels)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
70 (define-key outline-mode-prefix-map "\C-o" 'hide-other))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
71
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
72 (defvar outline-mode-menu-bar-map nil)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
73 (if outline-mode-menu-bar-map
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
74 nil
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
75 (setq outline-mode-menu-bar-map (make-sparse-keymap))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
76
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
77 (define-key outline-mode-menu-bar-map [hide]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
78 (cons "Hide" (make-sparse-keymap "Hide")))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
79
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
80 (define-key outline-mode-menu-bar-map [hide hide-other]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
81 '("Hide Other" . hide-other))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
82 (define-key outline-mode-menu-bar-map [hide hide-sublevels]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
83 '("Hide Sublevels" . hide-sublevels))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
84 (define-key outline-mode-menu-bar-map [hide hide-subtree]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
85 '("Hide Subtree" . hide-subtree))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
86 (define-key outline-mode-menu-bar-map [hide hide-entry]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
87 '("Hide Entry" . hide-entry))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
88 (define-key outline-mode-menu-bar-map [hide hide-body]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
89 '("Hide Body" . hide-body))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
90 (define-key outline-mode-menu-bar-map [hide hide-leaves]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
91 '("Hide Leaves" . hide-leaves))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
92
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
93 (define-key outline-mode-menu-bar-map [show]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
94 (cons "Show" (make-sparse-keymap "Show")))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
95
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
96 (define-key outline-mode-menu-bar-map [show show-subtree]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
97 '("Show Subtree" . show-subtree))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
98 (define-key outline-mode-menu-bar-map [show show-children]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
99 '("Show Children" . show-children))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
100 (define-key outline-mode-menu-bar-map [show show-branches]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
101 '("Show Branches" . show-branches))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
102 (define-key outline-mode-menu-bar-map [show show-entry]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
103 '("Show Entry" . show-entry))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
104 (define-key outline-mode-menu-bar-map [show show-all]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
105 '("Show All" . show-all))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
106
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
107 (define-key outline-mode-menu-bar-map [headings]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
108 (cons "Headings" (make-sparse-keymap "Headings")))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
109
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
110 (define-key outline-mode-menu-bar-map [headings outline-backward-same-level]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
111 '("Previous Same Level" . outline-backward-same-level))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
112 (define-key outline-mode-menu-bar-map [headings outline-forward-same-level]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
113 '("Next Same Level" . outline-forward-same-level))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
114 (define-key outline-mode-menu-bar-map [headings outline-previous-visible-heading]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
115 '("Previous" . outline-previous-visible-heading))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
116 (define-key outline-mode-menu-bar-map [headings outline-next-visible-heading]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
117 '("Next" . outline-next-visible-heading))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
118 (define-key outline-mode-menu-bar-map [headings outline-up-heading]
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
119 '("Up" . outline-up-heading)))
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
120
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
121 (defvar outline-mode-map nil "")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
122
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
123 (if outline-mode-map
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
124 nil
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
125 (setq outline-mode-map (nconc (make-sparse-keymap) text-mode-map))
8643
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
126 (define-key outline-mode-map "\C-c" outline-mode-prefix-map)
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
127 (define-key outline-mode-map [menu-bar] outline-mode-menu-bar-map))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
128
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
129 (defvar outline-minor-mode nil
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
130 "Non-nil if using Outline mode as a minor mode of some other mode.")
2934
7c4226d1ea65 (outline-minor-mode): Make var permanent local in all buffers.
Richard M. Stallman <rms@gnu.org>
parents: 2900
diff changeset
131 (make-variable-buffer-local 'outline-minor-mode)
7c4226d1ea65 (outline-minor-mode): Make var permanent local in all buffers.
Richard M. Stallman <rms@gnu.org>
parents: 2900
diff changeset
132 (put 'outline-minor-mode 'permanent-local t)
5693
e54c2697692b (minor-mode-alist): Don't add "Outl" if already added.
Richard M. Stallman <rms@gnu.org>
parents: 5306
diff changeset
133 (or (assq 'outline-minor-mode minor-mode-alist)
e54c2697692b (minor-mode-alist): Don't add "Outl" if already added.
Richard M. Stallman <rms@gnu.org>
parents: 5306
diff changeset
134 (setq minor-mode-alist (append minor-mode-alist
e54c2697692b (minor-mode-alist): Don't add "Outl" if already added.
Richard M. Stallman <rms@gnu.org>
parents: 5306
diff changeset
135 (list '(outline-minor-mode " Outl")))))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
136
9378
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
137 (defvar outline-font-lock-keywords
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
138 '(;; Highlight headings according to the level.
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
139 ("^\\(\\*+\\)[ \t]*\\(.+\\)?[ \t]*$"
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
140 (1 font-lock-string-face)
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
141 (2 (let ((len (- (match-end 1) (match-beginning 1))))
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
142 (or (cdr (assq len '((1 . font-lock-function-name-face)
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
143 (2 . font-lock-keyword-face)
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
144 (3 . font-lock-comment-face))))
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
145 font-lock-variable-name-face))
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
146 nil t))
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
147 ;; Highight citations of the form [1] and [Mar94].
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
148 ("\\[\\([A-Z][A-Za-z]+\\)*[0-9]+\\]" . font-lock-type-face))
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
149 "Additional expressions to highlight in Outline mode.")
1c9b8b3971a0 (outline-font-lock-keywords): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8688
diff changeset
150
258
1e0bc00dca7a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 234
diff changeset
151 ;;;###autoload
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
152 (defun outline-mode ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
153 "Set major mode for editing outlines with selective display.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
154 Headings are lines which start with asterisks: one for major headings,
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
155 two for subheadings, etc. Lines not starting with asterisks are body lines.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
156
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
157 Body text or subheadings under a heading can be made temporarily
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
158 invisible, or visible again. Invisible lines are attached to the end
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
159 of the heading, so they move with it, if the line is killed and yanked
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
160 back. A heading with text hidden under it is marked with an ellipsis (...).
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
161
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
162 Commands:\\<outline-mode-map>
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
163 \\[outline-next-visible-heading] outline-next-visible-heading move by visible headings
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
164 \\[outline-previous-visible-heading] outline-previous-visible-heading
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
165 \\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
166 \\[outline-backward-same-level] outline-backward-same-level
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
167 \\[outline-up-heading] outline-up-heading move from subheading to heading
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
168
6298
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
169 \\[hide-body] make all text invisible (not headings).
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
170 \\[show-all] make everything in buffer visible.
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
171
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
172 The remaining commands are used when point is on a heading line.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
173 They apply to some of the body or subheadings of that heading.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
174 \\[hide-subtree] hide-subtree make body and subheadings invisible.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
175 \\[show-subtree] show-subtree make body and subheadings visible.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
176 \\[show-children] show-children make direct subheadings visible.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
177 No effect on body, or subheadings 2 or more levels down.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
178 With arg N, affects subheadings N levels down.
6298
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
179 \\[hide-entry] make immediately following body invisible.
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
180 \\[show-entry] make it visible.
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
181 \\[hide-leaves] make body under heading and under its subheadings invisible.
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
182 The subheadings remain visible.
6298
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
183 \\[show-branches] make all subheadings at all levels visible.
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
184
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
185 The variable `outline-regexp' can be changed to control what is a heading.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
186 A line is a heading if `outline-regexp' matches something at the
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
187 beginning of the line. The longer the match, the deeper the level.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
188
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
189 Turning on outline mode calls the value of `text-mode-hook' and then of
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
190 `outline-mode-hook', if they are non-nil."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
191 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
192 (kill-all-local-variables)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
193 (setq selective-display t)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
194 (use-local-map outline-mode-map)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
195 (setq mode-name "Outline")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
196 (setq major-mode 'outline-mode)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
197 (define-abbrev-table 'text-mode-abbrev-table ())
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
198 (setq local-abbrev-table text-mode-abbrev-table)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
199 (set-syntax-table text-mode-syntax-table)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
200 (make-local-variable 'paragraph-start)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
201 (setq paragraph-start (concat paragraph-start "\\|^\\("
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
202 outline-regexp "\\)"))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
203 ;; Inhibit auto-filling of header lines.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
204 (make-local-variable 'auto-fill-inhibit-regexp)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
205 (setq auto-fill-inhibit-regexp outline-regexp)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
206 (make-local-variable 'paragraph-separate)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
207 (setq paragraph-separate (concat paragraph-separate "\\|^\\("
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
208 outline-regexp "\\)"))
9478
a8077b802b9e * outline.el: (outline-mode): Set font-lock-defaults.
Simon Marshall <simon@gnu.org>
parents: 9378
diff changeset
209 (make-local-variable 'font-lock-defaults)
a8077b802b9e * outline.el: (outline-mode): Set font-lock-defaults.
Simon Marshall <simon@gnu.org>
parents: 9378
diff changeset
210 (setq font-lock-defaults '(outline-font-lock-keywords t))
7919
5823cf320f61 (outline-mode): Make change-major-mode-hook buffer-local.
Richard M. Stallman <rms@gnu.org>
parents: 7467
diff changeset
211 (make-local-variable 'change-major-mode-hook)
5876
82e1a78ab625 (outline-mode): Fix spelling of add-hook.
Karl Heuer <kwzh@gnu.org>
parents: 5855
diff changeset
212 (add-hook 'change-major-mode-hook 'show-all)
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
213 (run-hooks 'text-mode-hook 'outline-mode-hook))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
214
6077
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
215 (defvar outline-minor-mode-prefix "\C-c\C-o"
8688
1aba2fd3fd13 (outline-minor-mode-prefix): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 8643
diff changeset
216 "*Prefix key to use for Outline commands in Outline minor mode.
1aba2fd3fd13 (outline-minor-mode-prefix): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 8643
diff changeset
217 The value of this variable is checked as part of loading Outline mode.
1aba2fd3fd13 (outline-minor-mode-prefix): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 8643
diff changeset
218 After that, changing the prefix key requires manipulating keymaps.")
4622
a55b9c08e4af (outline-minor-mode-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 4187
diff changeset
219
2900
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
220 (defvar outline-minor-mode-map nil)
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
221 (if outline-minor-mode-map
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
222 nil
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
223 (setq outline-minor-mode-map (make-sparse-keymap))
3987
4eada6c0b8d4 (outline-mode-map): Add menu bar items.
Richard M. Stallman <rms@gnu.org>
parents: 3531
diff changeset
224 (define-key outline-minor-mode-map [menu-bar]
8643
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
225 outline-mode-menu-bar-map)
4622
a55b9c08e4af (outline-minor-mode-prefix): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 4187
diff changeset
226 (define-key outline-minor-mode-map outline-minor-mode-prefix
8643
e98aa03e22c5 (outline-mode-prefix-map): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 8153
diff changeset
227 outline-mode-prefix-map))
2900
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
228
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
229 (or (assq 'outline-minor-mode minor-mode-map-alist)
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
230 (setq minor-mode-map-alist
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
231 (cons (cons 'outline-minor-mode outline-minor-mode-map)
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
232 minor-mode-map-alist)))
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
233
3531
0732700eb6c0 (outline-minor-mode): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents: 3376
diff changeset
234 ;;;###autoload
2900
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
235 (defun outline-minor-mode (&optional arg)
2934
7c4226d1ea65 (outline-minor-mode): Make var permanent local in all buffers.
Richard M. Stallman <rms@gnu.org>
parents: 2900
diff changeset
236 "Toggle Outline minor mode.
7c4226d1ea65 (outline-minor-mode): Make var permanent local in all buffers.
Richard M. Stallman <rms@gnu.org>
parents: 2900
diff changeset
237 With arg, turn Outline minor mode on if arg is positive, off otherwise.
7c4226d1ea65 (outline-minor-mode): Make var permanent local in all buffers.
Richard M. Stallman <rms@gnu.org>
parents: 2900
diff changeset
238 See the command `outline-mode' for more information on this mode."
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
239 (interactive "P")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
240 (setq outline-minor-mode
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
241 (if (null arg) (not outline-minor-mode)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
242 (> (prefix-numeric-value arg) 0)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
243 (if outline-minor-mode
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
244 (progn
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
245 (setq selective-display t)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
246 (run-hooks 'outline-minor-mode-hook))
4763
a57b0b715c04 (outline-minor-mode): Force update of modeline when outline-minor-mode
Brian Fox <bfox@gnu.org>
parents: 4623
diff changeset
247 (setq selective-display nil))
5306
a2f8f9c4e29b (outline-minor-mode): When turning off the mode, turn ^Ms back to \n's.
Richard M. Stallman <rms@gnu.org>
parents: 4763
diff changeset
248 ;; When turning off outline mode, get rid of any ^M's.
a2f8f9c4e29b (outline-minor-mode): When turning off the mode, turn ^Ms back to \n's.
Richard M. Stallman <rms@gnu.org>
parents: 4763
diff changeset
249 (or outline-minor-mode
a2f8f9c4e29b (outline-minor-mode): When turning off the mode, turn ^Ms back to \n's.
Richard M. Stallman <rms@gnu.org>
parents: 4763
diff changeset
250 (outline-flag-region (point-min) (point-max) ?\n))
4763
a57b0b715c04 (outline-minor-mode): Force update of modeline when outline-minor-mode
Brian Fox <bfox@gnu.org>
parents: 4623
diff changeset
251 (set-buffer-modified-p (buffer-modified-p)))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
252
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
253 (defvar outline-level 'outline-level
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
254 "Function of no args to compute a header's nesting level in an outline.
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
255 It can assume point is at the beginning of a header line.")
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
256
6299
d0a9fa0d0a8d Add a comment to document the reason for the change in outline-level.
Karl Heuer <kwzh@gnu.org>
parents: 6298
diff changeset
257 ;; This used to count columns rather than characters, but that made ^L
d0a9fa0d0a8d Add a comment to document the reason for the change in outline-level.
Karl Heuer <kwzh@gnu.org>
parents: 6298
diff changeset
258 ;; appear to be at level 2 instead of 1. Columns would be better for
d0a9fa0d0a8d Add a comment to document the reason for the change in outline-level.
Karl Heuer <kwzh@gnu.org>
parents: 6298
diff changeset
259 ;; tab handling, but the default regexp doesn't use tabs, and anyone
d0a9fa0d0a8d Add a comment to document the reason for the change in outline-level.
Karl Heuer <kwzh@gnu.org>
parents: 6298
diff changeset
260 ;; who changes the regexp can also redefine the outline-level variable
d0a9fa0d0a8d Add a comment to document the reason for the change in outline-level.
Karl Heuer <kwzh@gnu.org>
parents: 6298
diff changeset
261 ;; as appropriate.
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
262 (defun outline-level ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
263 "Return the depth to which a statement is nested in the outline.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
264 Point must be at the beginning of a header line. This is actually
6298
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
265 the number of characters that `outline-regexp' matches."
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
266 (save-excursion
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
267 (looking-at outline-regexp)
6298
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
268 (- (match-end 0) (match-beginning 0))))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
269
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
270 (defun outline-next-preface ()
8153
d21f64e53295 (outline-next-preface): Undo previous change: do stop before final newline.
Richard M. Stallman <rms@gnu.org>
parents: 7919
diff changeset
271 "Skip forward to just before the next heading line.
d21f64e53295 (outline-next-preface): Undo previous change: do stop before final newline.
Richard M. Stallman <rms@gnu.org>
parents: 7919
diff changeset
272 If there's no following heading line, stop before the newline
d21f64e53295 (outline-next-preface): Undo previous change: do stop before final newline.
Richard M. Stallman <rms@gnu.org>
parents: 7919
diff changeset
273 at the end of the buffer."
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
274 (if (re-search-forward (concat "[\n\^M]\\(" outline-regexp "\\)")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
275 nil 'move)
8153
d21f64e53295 (outline-next-preface): Undo previous change: do stop before final newline.
Richard M. Stallman <rms@gnu.org>
parents: 7919
diff changeset
276 (goto-char (match-beginning 0)))
d21f64e53295 (outline-next-preface): Undo previous change: do stop before final newline.
Richard M. Stallman <rms@gnu.org>
parents: 7919
diff changeset
277 (if (memq (preceding-char) '(?\n ?\^M))
d21f64e53295 (outline-next-preface): Undo previous change: do stop before final newline.
Richard M. Stallman <rms@gnu.org>
parents: 7919
diff changeset
278 (forward-char -1)))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
279
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
280 (defun outline-next-heading ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
281 "Move to the next (possibly invisible) heading line."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
282 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
283 (if (re-search-forward (concat "[\n\^M]\\(" outline-regexp "\\)")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
284 nil 'move)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
285 (goto-char (1+ (match-beginning 0)))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
286
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
287 (defun outline-back-to-heading ()
6175
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
288 "Move to previous heading line, or beg of this line if it's a heading.
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
289 Only visible heading lines are considered."
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
290 (beginning-of-line)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
291 (or (outline-on-heading-p)
6298
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
292 (re-search-backward (concat "^\\(" outline-regexp "\\)") nil t)
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
293 (error "before first heading")))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
294
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
295 (defun outline-on-heading-p ()
7269
66715349c911 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 6965
diff changeset
296 "Return t if point is on a (visible) heading line."
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
297 (save-excursion
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
298 (beginning-of-line)
6298
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
299 (and (bolp)
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
300 (looking-at outline-regexp))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
301
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
302 (defun outline-end-of-heading ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
303 (if (re-search-forward outline-heading-end-regexp nil 'move)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
304 (forward-char -1)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
305
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
306 (defun outline-next-visible-heading (arg)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
307 "Move to the next visible heading line.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
308 With argument, repeats or can move backward if negative.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
309 A heading line is one that starts with a `*' (or that
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
310 `outline-regexp' matches)."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
311 (interactive "p")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
312 (if (< arg 0)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
313 (beginning-of-line)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
314 (end-of-line))
6298
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
315 (or (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t arg)
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
316 (error ""))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
317 (beginning-of-line))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
318
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
319 (defun outline-previous-visible-heading (arg)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
320 "Move to the previous heading line.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
321 With argument, repeats or can move forward if negative.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
322 A heading line is one that starts with a `*' (or that
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
323 `outline-regexp' matches)."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
324 (interactive "p")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
325 (outline-next-visible-heading (- arg)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
326
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
327 (defun outline-flag-region (from to flag)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
328 "Hides or shows lines from FROM to TO, according to FLAG.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
329 If FLAG is `\\n' (newline character) then text is shown,
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
330 while if FLAG is `\\^M' (control-M) the text is hidden."
3376
898d7a33c038 (outline-flag-region): Pass t as NOUNDO arg
Richard M. Stallman <rms@gnu.org>
parents: 2934
diff changeset
331 (let (buffer-read-only)
898d7a33c038 (outline-flag-region): Pass t as NOUNDO arg
Richard M. Stallman <rms@gnu.org>
parents: 2934
diff changeset
332 (subst-char-in-region from to
898d7a33c038 (outline-flag-region): Pass t as NOUNDO arg
Richard M. Stallman <rms@gnu.org>
parents: 2934
diff changeset
333 (if (= flag ?\n) ?\^M ?\n)
898d7a33c038 (outline-flag-region): Pass t as NOUNDO arg
Richard M. Stallman <rms@gnu.org>
parents: 2934
diff changeset
334 flag t)))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
335
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
336 (defun hide-entry ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
337 "Hide the body directly following this heading."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
338 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
339 (outline-back-to-heading)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
340 (outline-end-of-heading)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
341 (save-excursion
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
342 (outline-flag-region (point) (progn (outline-next-preface) (point)) ?\^M)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
343
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
344 (defun show-entry ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
345 "Show the body directly following this heading."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
346 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
347 (save-excursion
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
348 (outline-flag-region (point) (progn (outline-next-preface) (point)) ?\n)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
349
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
350 (defun hide-body ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
351 "Hide all of buffer except headings."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
352 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
353 (hide-region-body (point-min) (point-max)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
354
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
355 (defun hide-region-body (start end)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
356 "Hide all body lines in the region, but not headings."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
357 (save-excursion
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
358 (save-restriction
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
359 (narrow-to-region start end)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
360 (goto-char (point-min))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
361 (if (outline-on-heading-p)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
362 (outline-end-of-heading))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
363 (while (not (eobp))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
364 (outline-flag-region (point)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
365 (progn (outline-next-preface) (point)) ?\^M)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
366 (if (not (eobp))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
367 (progn
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
368 (forward-char
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
369 (if (looking-at "[\n\^M][\n\^M]")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
370 2 1))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
371 (outline-end-of-heading)))))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
372
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
373 (defun show-all ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
374 "Show all of the text in the buffer."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
375 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
376 (outline-flag-region (point-min) (point-max) ?\n))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
377
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
378 (defun hide-subtree ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
379 "Hide everything after this heading at deeper levels."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
380 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
381 (outline-flag-subtree ?\^M))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
382
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
383 (defun hide-leaves ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
384 "Hide all body after this heading at deeper levels."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
385 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
386 (outline-back-to-heading)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
387 (outline-end-of-heading)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
388 (hide-region-body (point) (progn (outline-end-of-subtree) (point))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
389
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
390 (defun show-subtree ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
391 "Show everything after this heading at deeper levels."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
392 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
393 (outline-flag-subtree ?\n))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
394
6320
799e5e721233 (hide-other, hide-sublevels): Renamed from outline-...
Richard M. Stallman <rms@gnu.org>
parents: 6299
diff changeset
395 (defun hide-sublevels (levels)
7269
66715349c911 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 6965
diff changeset
396 "Hide everything but the top LEVELS levels of headers, in whole buffer."
6077
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
397 (interactive "p")
6080
2f02deab5b9e (hide-sublevels): Doc fix. Rename arg.
Richard M. Stallman <rms@gnu.org>
parents: 6077
diff changeset
398 (if (< levels 1)
6077
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
399 (error "Must keep at least one level of headers"))
6080
2f02deab5b9e (hide-sublevels): Doc fix. Rename arg.
Richard M. Stallman <rms@gnu.org>
parents: 6077
diff changeset
400 (setq levels (1- levels))
6077
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
401 (save-excursion
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
402 (goto-char (point-min))
7312
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
403 ;; Keep advancing to the next top-level heading.
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
404 (while (or (and (bobp) (outline-on-heading-p))
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
405 (outline-next-heading))
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
406 (let ((end (save-excursion (outline-end-of-subtree) (point))))
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
407 ;; Hide everything under that.
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
408 (outline-flag-region (point) end ?\^M)
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
409 ;; Show the first LEVELS levels under that.
7316
00e2b88a5a8b (hide-sublevels): Typo in previous change.
Richard M. Stallman <rms@gnu.org>
parents: 7312
diff changeset
410 (if (> levels 0)
7312
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
411 (show-children levels))
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
412 ;; Move to the next, since we already found it.
102e78c0fb9a (hide-sublevels): No need for condition-case.
Richard M. Stallman <rms@gnu.org>
parents: 7298
diff changeset
413 (goto-char end)))))
6077
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
414
6320
799e5e721233 (hide-other, hide-sublevels): Renamed from outline-...
Richard M. Stallman <rms@gnu.org>
parents: 6299
diff changeset
415 (defun hide-other ()
6077
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
416 "Hide everything except for the current body and the parent headings."
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
417 (interactive)
6320
799e5e721233 (hide-other, hide-sublevels): Renamed from outline-...
Richard M. Stallman <rms@gnu.org>
parents: 6299
diff changeset
418 (hide-sublevels 1)
6077
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
419 (let ((last (point))
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
420 (pos (point)))
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
421 (while (save-excursion
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
422 (and (re-search-backward "[\n\r]" nil t)
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
423 (eq (following-char) ?\r)))
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
424 (save-excursion
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
425 (beginning-of-line)
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
426 (if (eq last (point))
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
427 (progn
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
428 (outline-next-heading)
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
429 (outline-flag-region last (point) ?\n))
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
430 (show-children)
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
431 (setq last (point)))))))
7c17887a0daf (outline-minor-mode-prefix): Change to C-c C-o.
Richard M. Stallman <rms@gnu.org>
parents: 5876
diff changeset
432
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
433 (defun outline-flag-subtree (flag)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
434 (save-excursion
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
435 (outline-back-to-heading)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
436 (outline-end-of-heading)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
437 (outline-flag-region (point)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
438 (progn (outline-end-of-subtree) (point))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
439 flag)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
440
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
441 (defun outline-end-of-subtree ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
442 (outline-back-to-heading)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
443 (let ((opoint (point))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
444 (first t)
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
445 (level (funcall outline-level)))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
446 (while (and (not (eobp))
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
447 (or first (> (funcall outline-level) level)))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
448 (setq first nil)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
449 (outline-next-heading))
6953
cd88b5f54ae3 (outline-end-of-subtree): Stop before final newline.
Karl Heuer <kwzh@gnu.org>
parents: 6320
diff changeset
450 (if (memq (preceding-char) '(?\n ?\^M))
cd88b5f54ae3 (outline-end-of-subtree): Stop before final newline.
Karl Heuer <kwzh@gnu.org>
parents: 6320
diff changeset
451 (progn
6965
7fd01c621b82 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 6953
diff changeset
452 ;; Go to end of line before heading
6953
cd88b5f54ae3 (outline-end-of-subtree): Stop before final newline.
Karl Heuer <kwzh@gnu.org>
parents: 6320
diff changeset
453 (forward-char -1)
cd88b5f54ae3 (outline-end-of-subtree): Stop before final newline.
Karl Heuer <kwzh@gnu.org>
parents: 6320
diff changeset
454 (if (memq (preceding-char) '(?\n ?\^M))
cd88b5f54ae3 (outline-end-of-subtree): Stop before final newline.
Karl Heuer <kwzh@gnu.org>
parents: 6320
diff changeset
455 ;; leave blank line before heading
cd88b5f54ae3 (outline-end-of-subtree): Stop before final newline.
Karl Heuer <kwzh@gnu.org>
parents: 6320
diff changeset
456 (forward-char -1))))))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
457
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
458 (defun show-branches ()
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
459 "Show all subheadings of this heading, but not their bodies."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
460 (interactive)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
461 (show-children 1000))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
462
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
463 (defun show-children (&optional level)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
464 "Show all direct subheadings of this heading.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
465 Prefix arg LEVEL is how many levels below the current level should be shown.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
466 Default is enough to cause the following heading to appear."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
467 (interactive "P")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
468 (setq level
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
469 (if level (prefix-numeric-value level)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
470 (save-excursion
6175
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
471 (outline-back-to-heading)
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
472 (let ((start-level (funcall outline-level)))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
473 (outline-next-heading)
5711
6f772d7f1289 (show-children): Don't call outline-level at eob.
Richard M. Stallman <rms@gnu.org>
parents: 5693
diff changeset
474 (if (eobp)
6f772d7f1289 (show-children): Don't call outline-level at eob.
Richard M. Stallman <rms@gnu.org>
parents: 5693
diff changeset
475 1
6f772d7f1289 (show-children): Don't call outline-level at eob.
Richard M. Stallman <rms@gnu.org>
parents: 5693
diff changeset
476 (max 1 (- (funcall outline-level) start-level)))))))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
477 (save-excursion
6175
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
478 (save-restriction
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
479 (outline-back-to-heading)
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
480 (setq level (+ level (funcall outline-level)))
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
481 (narrow-to-region (point)
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
482 (progn (outline-end-of-subtree)
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
483 (if (eobp) (point-max) (1+ (point)))))
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
484 (goto-char (point-min))
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
485 (while (and (not (eobp))
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
486 (progn
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
487 (outline-next-heading)
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
488 (not (eobp))))
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
489 (if (<= (funcall outline-level) level)
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
490 (save-excursion
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
491 (outline-flag-region (save-excursion
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
492 (forward-char -1)
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
493 (if (memq (preceding-char) '(?\n ?\^M))
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
494 (forward-char -1))
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
495 (point))
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
496 (progn (outline-end-of-heading) (point))
340f5eb2e8b6 (outline-on-heading-p): Use bolp.
Richard M. Stallman <rms@gnu.org>
parents: 6080
diff changeset
497 ?\n)))))))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
498
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
499 (defun outline-up-heading (arg)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
500 "Move to the heading line of which the present line is a subheading.
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
501 With argument, move up ARG levels."
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
502 (interactive "p")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
503 (outline-back-to-heading)
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
504 (if (eq (funcall outline-level) 1)
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
505 (error ""))
6298
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
506 (while (and (> (funcall outline-level) 1)
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
507 (> arg 0)
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
508 (not (bobp)))
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
509 (let ((present-level (funcall outline-level)))
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
510 (while (not (< (funcall outline-level) present-level))
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
511 (outline-previous-visible-heading 1))
4f65581e0972 (outline-mode, outline-level): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 6274
diff changeset
512 (setq arg (- arg 1)))))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
513
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
514 (defun outline-forward-same-level (arg)
7269
66715349c911 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 6965
diff changeset
515 "Move forward to the ARG'th subheading at same level as this one.
66715349c911 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 6965
diff changeset
516 Stop at the first and last subheadings of a superior heading."
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
517 (interactive "p")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
518 (outline-back-to-heading)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
519 (while (> arg 0)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
520 (let ((point-to-move-to (save-excursion
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
521 (outline-get-next-sibling))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
522 (if point-to-move-to
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
523 (progn
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
524 (goto-char point-to-move-to)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
525 (setq arg (1- arg)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
526 (progn
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
527 (setq arg 0)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
528 (error ""))))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
529
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
530 (defun outline-get-next-sibling ()
7269
66715349c911 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 6965
diff changeset
531 "Move to next heading of the same level, and return point or nil if none."
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
532 (let ((level (funcall outline-level)))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
533 (outline-next-visible-heading 1)
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
534 (while (and (> (funcall outline-level) level)
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
535 (not (eobp)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
536 (outline-next-visible-heading 1))
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
537 (if (< (funcall outline-level) level)
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
538 nil
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
539 (point))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
540
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
541 (defun outline-backward-same-level (arg)
7269
66715349c911 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 6965
diff changeset
542 "Move backward to the ARG'th subheading at same level as this one.
66715349c911 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 6965
diff changeset
543 Stop at the first and last subheadings of a superior heading."
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
544 (interactive "p")
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
545 (outline-back-to-heading)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
546 (while (> arg 0)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
547 (let ((point-to-move-to (save-excursion
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
548 (outline-get-last-sibling))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
549 (if point-to-move-to
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
550 (progn
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
551 (goto-char point-to-move-to)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
552 (setq arg (1- arg)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
553 (progn
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
554 (setq arg 0)
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
555 (error ""))))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
556
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
557 (defun outline-get-last-sibling ()
7269
66715349c911 Doc fixes.
Richard M. Stallman <rms@gnu.org>
parents: 6965
diff changeset
558 "Move to next heading of the same level, and return point or nil if none."
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
559 (let ((level (funcall outline-level)))
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
560 (outline-previous-visible-heading 1)
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
561 (while (and (> (funcall outline-level) level)
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
562 (not (bobp)))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
563 (outline-previous-visible-heading 1))
4623
3c1c4e9a4464 (outline-level): New var. Everything funcalls this
Richard M. Stallman <rms@gnu.org>
parents: 4622
diff changeset
564 (if (< (funcall outline-level) level)
234
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
565 nil
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
566 (point))))
ae820c28cee2 Initial revision
Brian Preble <rassilon@gnu.org>
parents:
diff changeset
567
2900
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
568 (provide 'outline)
443ebd8f59d2 (outline-heading-end-regexp): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 2308
diff changeset
569
659
505130d1ddf8 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 258
diff changeset
570 ;;; outline.el ends here