annotate lisp/outline.el @ 77632:3a37dfe90e44

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