HCoop / bpt / emacs.git / blame
| Commit | Line | Data |
|---|---|---|
| 0997c25b | 1 | ;;; outline.el --- outline mode commands for Emacs |
| b578f267 | 2 | |
| c6a04157 | 3 | ;; Copyright (C) 1986, 1993, 1994, 1995, 1997 Free Software Foundation, Inc. |
| 0997c25b RS |
4 | |
| 5 | ;; Maintainer: FSF | |
| 612abcae | 6 | ;; Keywords: outlines |
| 0997c25b RS |
7 | |
| 8 | ;; This file is part of GNU Emacs. | |
| 9 | ||
| 10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
| 11 | ;; it under the terms of the GNU General Public License as published by | |
| 12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
| 13 | ;; any later version. | |
| 14 | ||
| 15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
| 16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 18 | ;; GNU General Public License for more details. | |
| 19 | ||
| 20 | ;; You should have received a copy of the GNU General Public License | |
| b578f267 EN |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
| 22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 23 | ;; Boston, MA 02111-1307, USA. | |
| 0997c25b RS |
24 | |
| 25 | ;;; Commentary: | |
| 26 | ||
| 27 | ;; This package is a major mode for editing outline-format documents. | |
| 28 | ;; An outline can be `abstracted' to show headers at any given level, | |
| 29 | ;; with all stuff below hidden. See the Emacs manual for details. | |
| 30 | ||
| 31 | ;;; Code: | |
| 32 | ||
| c6a04157 RS |
33 | (defgroup outlines nil |
| 34 | "Support for hierarchical outlining" | |
| 35 | :prefix "outline-" | |
| 36 | :group 'editing) | |
| 37 | ||
| 38 | (defcustom outline-regexp nil | |
| 0997c25b RS |
39 | "*Regular expression to match the beginning of a heading. |
| 40 | Any line whose beginning matches this regexp is considered to start a heading. | |
| 41 | The recommended way to set this is with a Local Variables: list | |
| c6a04157 RS |
42 | in the file it applies to. See also outline-heading-end-regexp." |
| 43 | :type '(choice regexp (const nil)) | |
| 44 | :group 'outlines) | |
| 0997c25b RS |
45 | |
| 46 | ;; Can't initialize this in the defvar above -- some major modes have | |
| 47 | ;; already assigned a local value to it. | |
| 48 | (or (default-value 'outline-regexp) | |
| 49 | (setq-default outline-regexp "[*\^L]+")) | |
| 50 | ||
| c6a04157 | 51 | (defcustom outline-heading-end-regexp "\n" |
| 0997c25b RS |
52 | "*Regular expression to match the end of a heading line. |
| 53 | You can assume that point is at the beginning of a heading when this | |
| 54 | regexp is searched for. The heading ends at the end of the match. | |
| 55 | The recommended way to set this is with a `Local Variables:' list | |
| c6a04157 RS |
56 | in the file it applies to." |
| 57 | :type 'regexp | |
| 58 | :group 'outlines) | |
| 0997c25b RS |
59 | |
| 60 | (defvar outline-mode-prefix-map nil) | |
| 61 | ||
| 62 | (if outline-mode-prefix-map | |
| 63 | nil | |
| 64 | (setq outline-mode-prefix-map (make-sparse-keymap)) | |
| 7e60d5d3 | 65 | (define-key outline-mode-prefix-map "@" 'outline-mark-subtree) |
| 0997c25b RS |
66 | (define-key outline-mode-prefix-map "\C-n" 'outline-next-visible-heading) |
| 67 | (define-key outline-mode-prefix-map "\C-p" 'outline-previous-visible-heading) | |
| 68 | (define-key outline-mode-prefix-map "\C-i" 'show-children) | |
| 69 | (define-key outline-mode-prefix-map "\C-s" 'show-subtree) | |
| 70 | (define-key outline-mode-prefix-map "\C-d" 'hide-subtree) | |
| 71 | (define-key outline-mode-prefix-map "\C-u" 'outline-up-heading) | |
| 72 | (define-key outline-mode-prefix-map "\C-f" 'outline-forward-same-level) | |
| 73 | (define-key outline-mode-prefix-map "\C-b" 'outline-backward-same-level) | |
| 74 | (define-key outline-mode-prefix-map "\C-t" 'hide-body) | |
| 75 | (define-key outline-mode-prefix-map "\C-a" 'show-all) | |
| 76 | (define-key outline-mode-prefix-map "\C-c" 'hide-entry) | |
| 77 | (define-key outline-mode-prefix-map "\C-e" 'show-entry) | |
| 78 | (define-key outline-mode-prefix-map "\C-l" 'hide-leaves) | |
| 79 | (define-key outline-mode-prefix-map "\C-k" 'show-branches) | |
| 80 | (define-key outline-mode-prefix-map "\C-q" 'hide-sublevels) | |
| 81 | (define-key outline-mode-prefix-map "\C-o" 'hide-other)) | |
| 82 | ||
| 83 | (defvar outline-mode-menu-bar-map nil) | |
| 84 | (if outline-mode-menu-bar-map | |
| 85 | nil | |
| 86 | (setq outline-mode-menu-bar-map (make-sparse-keymap)) | |
| 87 | ||
| 88 | (define-key outline-mode-menu-bar-map [hide] | |
| 89 | (cons "Hide" (make-sparse-keymap "Hide"))) | |
| 90 | ||
| 91 | (define-key outline-mode-menu-bar-map [hide hide-other] | |
| 92 | '("Hide Other" . hide-other)) | |
| 93 | (define-key outline-mode-menu-bar-map [hide hide-sublevels] | |
| 94 | '("Hide Sublevels" . hide-sublevels)) | |
| 95 | (define-key outline-mode-menu-bar-map [hide hide-subtree] | |
| 96 | '("Hide Subtree" . hide-subtree)) | |
| 97 | (define-key outline-mode-menu-bar-map [hide hide-entry] | |
| 98 | '("Hide Entry" . hide-entry)) | |
| 99 | (define-key outline-mode-menu-bar-map [hide hide-body] | |
| 100 | '("Hide Body" . hide-body)) | |
| 101 | (define-key outline-mode-menu-bar-map [hide hide-leaves] | |
| 102 | '("Hide Leaves" . hide-leaves)) | |
| 103 | ||
| 104 | (define-key outline-mode-menu-bar-map [show] | |
| 105 | (cons "Show" (make-sparse-keymap "Show"))) | |
| 106 | ||
| 107 | (define-key outline-mode-menu-bar-map [show show-subtree] | |
| 108 | '("Show Subtree" . show-subtree)) | |
| 109 | (define-key outline-mode-menu-bar-map [show show-children] | |
| 110 | '("Show Children" . show-children)) | |
| 111 | (define-key outline-mode-menu-bar-map [show show-branches] | |
| 112 | '("Show Branches" . show-branches)) | |
| 113 | (define-key outline-mode-menu-bar-map [show show-entry] | |
| 114 | '("Show Entry" . show-entry)) | |
| 115 | (define-key outline-mode-menu-bar-map [show show-all] | |
| 116 | '("Show All" . show-all)) | |
| 117 | ||
| 118 | (define-key outline-mode-menu-bar-map [headings] | |
| 119 | (cons "Headings" (make-sparse-keymap "Headings"))) | |
| 120 | ||
| 121 | (define-key outline-mode-menu-bar-map [headings outline-backward-same-level] | |
| 122 | '("Previous Same Level" . outline-backward-same-level)) | |
| 123 | (define-key outline-mode-menu-bar-map [headings outline-forward-same-level] | |
| 124 | '("Next Same Level" . outline-forward-same-level)) | |
| 125 | (define-key outline-mode-menu-bar-map [headings outline-previous-visible-heading] | |
| 126 | '("Previous" . outline-previous-visible-heading)) | |
| 127 | (define-key outline-mode-menu-bar-map [headings outline-next-visible-heading] | |
| 128 | '("Next" . outline-next-visible-heading)) | |
| 129 | (define-key outline-mode-menu-bar-map [headings outline-up-heading] | |
| 130 | '("Up" . outline-up-heading))) | |
| 131 | ||
| 132 | (defvar outline-mode-map nil "") | |
| 133 | ||
| 134 | (if outline-mode-map | |
| 135 | nil | |
| 136 | (setq outline-mode-map (nconc (make-sparse-keymap) text-mode-map)) | |
| 137 | (define-key outline-mode-map "\C-c" outline-mode-prefix-map) | |
| 138 | (define-key outline-mode-map [menu-bar] outline-mode-menu-bar-map)) | |
| 139 | ||
| c6a04157 RS |
140 | (defcustom outline-minor-mode nil |
| 141 | "Non-nil if using Outline mode as a minor mode of some other mode." | |
| 142 | :type 'boolean | |
| 143 | :group 'outlines) | |
| 0997c25b | 144 | (make-variable-buffer-local 'outline-minor-mode) |
| 0997c25b RS |
145 | (or (assq 'outline-minor-mode minor-mode-alist) |
| 146 | (setq minor-mode-alist (append minor-mode-alist | |
| 147 | (list '(outline-minor-mode " Outl"))))) | |
| 148 | ||
| 149 | (defvar outline-font-lock-keywords | |
| 150 | '(;; Highlight headings according to the level. | |
| 151 | ("^\\(\\*+\\)[ \t]*\\(.+\\)?[ \t]*$" | |
| 152 | (1 font-lock-string-face) | |
| 153 | (2 (let ((len (- (match-end 1) (match-beginning 1)))) | |
| 154 | (or (cdr (assq len '((1 . font-lock-function-name-face) | |
| 155 | (2 . font-lock-keyword-face) | |
| 156 | (3 . font-lock-comment-face)))) | |
| 157 | font-lock-variable-name-face)) | |
| 158 | nil t)) | |
| a7acbbe4 | 159 | ;; Highlight citations of the form [1] and [Mar94]. |
| 0997c25b RS |
160 | ("\\[\\([A-Z][A-Za-z]+\\)*[0-9]+\\]" . font-lock-type-face)) |
| 161 | "Additional expressions to highlight in Outline mode.") | |
| 162 | ||
| 203108d8 RS |
163 | (defvar outline-view-change-hook nil |
| 164 | "Normal hook to be run after outline visibility changes.") | |
| 165 | ||
| 322454d4 | 166 | ;;;###autoload |
| 0997c25b RS |
167 | (defun outline-mode () |
| 168 | "Set major mode for editing outlines with selective display. | |
| 169 | Headings are lines which start with asterisks: one for major headings, | |
| 170 | two for subheadings, etc. Lines not starting with asterisks are body lines. | |
| 171 | ||
| 172 | Body text or subheadings under a heading can be made temporarily | |
| 173 | invisible, or visible again. Invisible lines are attached to the end | |
| 174 | of the heading, so they move with it, if the line is killed and yanked | |
| 175 | back. A heading with text hidden under it is marked with an ellipsis (...). | |
| 176 | ||
| 177 | Commands:\\<outline-mode-map> | |
| 178 | \\[outline-next-visible-heading] outline-next-visible-heading move by visible headings | |
| 179 | \\[outline-previous-visible-heading] outline-previous-visible-heading | |
| 180 | \\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings | |
| 181 | \\[outline-backward-same-level] outline-backward-same-level | |
| 182 | \\[outline-up-heading] outline-up-heading move from subheading to heading | |
| 183 | ||
| 184 | \\[hide-body] make all text invisible (not headings). | |
| 185 | \\[show-all] make everything in buffer visible. | |
| 186 | ||
| 187 | The remaining commands are used when point is on a heading line. | |
| 188 | They apply to some of the body or subheadings of that heading. | |
| 189 | \\[hide-subtree] hide-subtree make body and subheadings invisible. | |
| 190 | \\[show-subtree] show-subtree make body and subheadings visible. | |
| 191 | \\[show-children] show-children make direct subheadings visible. | |
| 192 | No effect on body, or subheadings 2 or more levels down. | |
| 193 | With arg N, affects subheadings N levels down. | |
| 194 | \\[hide-entry] make immediately following body invisible. | |
| 195 | \\[show-entry] make it visible. | |
| 196 | \\[hide-leaves] make body under heading and under its subheadings invisible. | |
| 197 | The subheadings remain visible. | |
| 198 | \\[show-branches] make all subheadings at all levels visible. | |
| 199 | ||
| 200 | The variable `outline-regexp' can be changed to control what is a heading. | |
| 201 | A line is a heading if `outline-regexp' matches something at the | |
| 202 | beginning of the line. The longer the match, the deeper the level. | |
| 203 | ||
| 204 | Turning on outline mode calls the value of `text-mode-hook' and then of | |
| 205 | `outline-mode-hook', if they are non-nil." | |
| 206 | (interactive) | |
| 207 | (kill-all-local-variables) | |
| 208 | (use-local-map outline-mode-map) | |
| 209 | (setq mode-name "Outline") | |
| 210 | (setq major-mode 'outline-mode) | |
| 211 | (define-abbrev-table 'text-mode-abbrev-table ()) | |
| 212 | (setq local-abbrev-table text-mode-abbrev-table) | |
| 213 | (set-syntax-table text-mode-syntax-table) | |
| 214 | (make-local-variable 'line-move-ignore-invisible) | |
| 215 | (setq line-move-ignore-invisible t) | |
| 216 | ;; Cause use of ellipses for invisible text. | |
| 65c1b8a1 | 217 | (add-to-invisibility-spec '(outline . t)) |
| 0997c25b RS |
218 | (make-local-variable 'paragraph-start) |
| 219 | (setq paragraph-start (concat paragraph-start "\\|\\(" | |
| 220 | outline-regexp "\\)")) | |
| 221 | ;; Inhibit auto-filling of header lines. | |
| 222 | (make-local-variable 'auto-fill-inhibit-regexp) | |
| 223 | (setq auto-fill-inhibit-regexp outline-regexp) | |
| 224 | (make-local-variable 'paragraph-separate) | |
| 225 | (setq paragraph-separate (concat paragraph-separate "\\|\\(" | |
| 226 | outline-regexp "\\)")) | |
| 227 | (make-local-variable 'font-lock-defaults) | |
| 228 | (setq font-lock-defaults '(outline-font-lock-keywords t)) | |
| 229 | (make-local-variable 'change-major-mode-hook) | |
| 230 | (add-hook 'change-major-mode-hook 'show-all) | |
| 231 | (run-hooks 'text-mode-hook 'outline-mode-hook)) | |
| 232 | ||
| c6a04157 | 233 | (defcustom outline-minor-mode-prefix "\C-c@" |
| 0997c25b RS |
234 | "*Prefix key to use for Outline commands in Outline minor mode. |
| 235 | The value of this variable is checked as part of loading Outline mode. | |
| c6a04157 RS |
236 | After that, changing the prefix key requires manipulating keymaps." |
| 237 | :type 'string | |
| 238 | :group 'outlines) | |
| 0997c25b RS |
239 | |
| 240 | (defvar outline-minor-mode-map nil) | |
| 241 | (if outline-minor-mode-map | |
| 242 | nil | |
| 243 | (setq outline-minor-mode-map (make-sparse-keymap)) | |
| 244 | (define-key outline-minor-mode-map [menu-bar] | |
| 245 | outline-mode-menu-bar-map) | |
| 246 | (define-key outline-minor-mode-map outline-minor-mode-prefix | |
| 247 | outline-mode-prefix-map)) | |
| 248 | ||
| 249 | (or (assq 'outline-minor-mode minor-mode-map-alist) | |
| 250 | (setq minor-mode-map-alist | |
| 251 | (cons (cons 'outline-minor-mode outline-minor-mode-map) | |
| 252 | minor-mode-map-alist))) | |
| 253 | ||
| 322454d4 | 254 | ;;;###autoload |
| 0997c25b RS |
255 | (defun outline-minor-mode (&optional arg) |
| 256 | "Toggle Outline minor mode. | |
| 257 | With arg, turn Outline minor mode on if arg is positive, off otherwise. | |
| 258 | See the command `outline-mode' for more information on this mode." | |
| 259 | (interactive "P") | |
| 260 | (setq outline-minor-mode | |
| 261 | (if (null arg) (not outline-minor-mode) | |
| 262 | (> (prefix-numeric-value arg) 0))) | |
| 263 | (if outline-minor-mode | |
| 264 | (progn | |
| be166d17 RS |
265 | (make-local-hook 'change-major-mode-hook) |
| 266 | ;; Turn off this mode if we change major modes. | |
| 267 | (add-hook 'change-major-mode-hook | |
| 268 | '(lambda () (outline-minor-mode -1)) | |
| 269 | nil t) | |
| 0997c25b RS |
270 | (make-local-variable 'line-move-ignore-invisible) |
| 271 | (setq line-move-ignore-invisible t) | |
| 272 | ;; Cause use of ellipses for invisible text. | |
| 65c1b8a1 | 273 | (add-to-invisibility-spec '(outline . t)) |
| 6e2fb845 | 274 | (run-hooks 'outline-minor-mode-hook)) |
| 0997c25b RS |
275 | (setq line-move-ignore-invisible nil) |
| 276 | ;; Cause use of ellipses for invisible text. | |
| 65c1b8a1 | 277 | (remove-from-invisibility-spec '(outline . t))) |
| 6e2fb845 | 278 | ;; When turning off outline mode, get rid of any outline hiding. |
| 0997c25b | 279 | (or outline-minor-mode |
| 6e2fb845 | 280 | (show-all)) |
| a57c6a28 | 281 | (force-mode-line-update)) |
| 0997c25b | 282 | \f |
| c6a04157 RS |
283 | (defcustom outline-level 'outline-level |
| 284 | "*Function of no args to compute a header's nesting level in an outline. | |
| 285 | It can assume point is at the beginning of a header line." | |
| 286 | :type 'function | |
| 1438d2d5 | 287 | :group 'outlines) |
| 0997c25b RS |
288 | |
| 289 | ;; This used to count columns rather than characters, but that made ^L | |
| 290 | ;; appear to be at level 2 instead of 1. Columns would be better for | |
| 291 | ;; tab handling, but the default regexp doesn't use tabs, and anyone | |
| 292 | ;; who changes the regexp can also redefine the outline-level variable | |
| 293 | ;; as appropriate. | |
| 294 | (defun outline-level () | |
| 295 | "Return the depth to which a statement is nested in the outline. | |
| 296 | Point must be at the beginning of a header line. This is actually | |
| 297 | the number of characters that `outline-regexp' matches." | |
| 298 | (save-excursion | |
| 299 | (looking-at outline-regexp) | |
| 300 | (- (match-end 0) (match-beginning 0)))) | |
| 301 | ||
| 302 | (defun outline-next-preface () | |
| 303 | "Skip forward to just before the next heading line. | |
| 304 | If there's no following heading line, stop before the newline | |
| 305 | at the end of the buffer." | |
| 306 | (if (re-search-forward (concat "\n\\(" outline-regexp "\\)") | |
| 307 | nil 'move) | |
| 308 | (goto-char (match-beginning 0))) | |
| 309 | (if (bolp) | |
| 310 | (forward-char -1))) | |
| 311 | ||
| 312 | (defun outline-next-heading () | |
| 313 | "Move to the next (possibly invisible) heading line." | |
| 314 | (interactive) | |
| 6e2fb845 | 315 | (if (re-search-forward (concat "\n\\(" outline-regexp "\\)") |
| 0997c25b RS |
316 | nil 'move) |
| 317 | (goto-char (1+ (match-beginning 0))))) | |
| 318 | ||
| 319 | (defsubst outline-visible () | |
| 320 | "Non-nil if the character after point is visible." | |
| 321 | (not (get-char-property (point) 'invisible))) | |
| 322 | ||
| 323 | (defun outline-back-to-heading () | |
| 324 | "Move to previous heading line, or beg of this line if it's a heading. | |
| 325 | Only visible heading lines are considered." | |
| 326 | (beginning-of-line) | |
| 327 | (or (outline-on-heading-p) | |
| 328 | (let (found) | |
| be166d17 RS |
329 | (save-excursion |
| 330 | (while (not found) | |
| 331 | (or (re-search-backward (concat "^\\(" outline-regexp "\\)") | |
| 332 | nil t) | |
| 333 | (error "before first heading")) | |
| 334 | (setq found (and (outline-visible) (point))))) | |
| 335 | (goto-char found) | |
| 336 | found))) | |
| 0997c25b RS |
337 | |
| 338 | (defun outline-on-heading-p () | |
| 339 | "Return t if point is on a (visible) heading line." | |
| 340 | (save-excursion | |
| 341 | (beginning-of-line) | |
| 342 | (and (bolp) (outline-visible) | |
| 343 | (looking-at outline-regexp)))) | |
| 344 | ||
| 345 | (defun outline-end-of-heading () | |
| 346 | (if (re-search-forward outline-heading-end-regexp nil 'move) | |
| 347 | (forward-char -1))) | |
| 348 | ||
| 349 | (defun outline-next-visible-heading (arg) | |
| 350 | "Move to the next visible heading line. | |
| 351 | With argument, repeats or can move backward if negative. | |
| 352 | A heading line is one that starts with a `*' (or that | |
| 353 | `outline-regexp' matches)." | |
| 354 | (interactive "p") | |
| 355 | (if (< arg 0) | |
| 356 | (beginning-of-line) | |
| 357 | (end-of-line)) | |
| b297554a RS |
358 | (while (and (not (bobp)) (< arg 0)) |
| 359 | (while (and (not (bobp)) | |
| 360 | (re-search-backward (concat "^\\(" outline-regexp "\\)") | |
| 361 | nil 'move) | |
| 362 | (not (outline-visible)))) | |
| 363 | (setq arg (1+ arg))) | |
| 364 | (while (and (not (eobp)) (> arg 0)) | |
| 365 | (while (and (not (eobp)) | |
| 366 | (re-search-forward (concat "^\\(" outline-regexp "\\)") | |
| 367 | nil 'move) | |
| 368 | (not (outline-visible)))) | |
| 369 | (setq arg (1- arg))) | |
| 0997c25b RS |
370 | (beginning-of-line)) |
| 371 | ||
| 372 | (defun outline-previous-visible-heading (arg) | |
| 373 | "Move to the previous heading line. | |
| 374 | With argument, repeats or can move forward if negative. | |
| 375 | A heading line is one that starts with a `*' (or that | |
| 376 | `outline-regexp' matches)." | |
| 377 | (interactive "p") | |
| 378 | (outline-next-visible-heading (- arg))) | |
| 379 | ||
| 7e60d5d3 RS |
380 | (defun outline-mark-subtree () |
| 381 | "Mark the current subtree in an outlined document. | |
| 382 | This puts point at the start of the current subtree, and mark at the end." | |
| 383 | (interactive) | |
| 384 | (let ((beg)) | |
| 385 | (if (outline-on-heading-p) | |
| 386 | ;; we are already looking at a heading | |
| 387 | (beginning-of-line) | |
| 388 | ;; else go back to previous heading | |
| 389 | (outline-previous-visible-heading 1)) | |
| 390 | (setq beg (point)) | |
| 391 | (outline-end-of-subtree) | |
| 392 | (push-mark (point)) | |
| 393 | (goto-char beg))) | |
| 394 | \f | |
| 0997c25b RS |
395 | (defun outline-flag-region (from to flag) |
| 396 | "Hides or shows lines from FROM to TO, according to FLAG. | |
| 397 | If FLAG is nil then text is shown, while if FLAG is t the text is hidden." | |
| 398 | (let ((inhibit-read-only t)) | |
| 399 | (save-excursion | |
| 400 | (goto-char from) | |
| 401 | (end-of-line) | |
| e41ae6f1 RS |
402 | (outline-discard-overlays (point) to 'outline) |
| 403 | (if flag | |
| 404 | (let ((o (make-overlay (point) to))) | |
| 65c1b8a1 | 405 | (overlay-put o 'invisible 'outline) |
| 203108d8 RS |
406 | (overlay-put o 'outline t))))) |
| 407 | (run-hooks 'outline-view-change-hook)) | |
| e41ae6f1 | 408 | |
| 6e2fb845 RS |
409 | ;; Exclude from the region BEG ... END all overlays |
| 410 | ;; with a non-nil PROP property. | |
| 411 | ;; Exclude them by shrinking them to exclude BEG ... END, | |
| 412 | ;; or even by splitting them if necessary. | |
| 413 | ;; Overlays without a non-nil PROP property are not touched. | |
| e41ae6f1 RS |
414 | (defun outline-discard-overlays (beg end prop) |
| 415 | (if (< end beg) | |
| 416 | (setq beg (prog1 end (setq end beg)))) | |
| 417 | (save-excursion | |
| 24b96659 RS |
418 | (let ((overlays (overlays-in beg end)) |
| 419 | o | |
| 420 | o1) | |
| 21cd2849 | 421 | (while overlays |
| 24b96659 RS |
422 | (setq o (car overlays)) |
| 423 | (if (overlay-get o prop) | |
| 424 | ;; Either push this overlay outside beg...end | |
| 425 | ;; or split it to exclude beg...end | |
| 426 | ;; or delete it entirely (if it is contained in beg...end). | |
| 427 | (if (< (overlay-start o) beg) | |
| 21cd2849 | 428 | (if (> (overlay-end o) end) |
| 24b96659 RS |
429 | (progn |
| 430 | (setq o1 (outline-copy-overlay o)) | |
| 431 | (move-overlay o1 (overlay-start o1) beg) | |
| 432 | (move-overlay o end (overlay-end o))) | |
| 433 | (move-overlay o (overlay-start o) beg)) | |
| 434 | (if (> (overlay-end o) end) | |
| 435 | (move-overlay o end (overlay-end o)) | |
| 436 | (delete-overlay o)))) | |
| 21cd2849 | 437 | (setq overlays (cdr overlays)))))) |
| e41ae6f1 | 438 | |
| 6e2fb845 | 439 | ;; Make a copy of overlay O, with the same beginning, end and properties. |
| e41ae6f1 | 440 | (defun outline-copy-overlay (o) |
| 6e2fb845 RS |
441 | (let ((o1 (make-overlay (overlay-start o) (overlay-end o) |
| 442 | (overlay-buffer o))) | |
| e41ae6f1 RS |
443 | (props (overlay-properties o))) |
| 444 | (while props | |
| 445 | (overlay-put o1 (car props) (nth 1 props)) | |
| 446 | (setq props (cdr (cdr props)))) | |
| 447 | o1)) | |
| 0997c25b RS |
448 | \f |
| 449 | (defun hide-entry () | |
| 450 | "Hide the body directly following this heading." | |
| 451 | (interactive) | |
| 452 | (outline-back-to-heading) | |
| 453 | (outline-end-of-heading) | |
| 454 | (save-excursion | |
| 455 | (outline-flag-region (point) (progn (outline-next-preface) (point)) t))) | |
| 456 | ||
| 457 | (defun show-entry () | |
| 458 | "Show the body directly following this heading." | |
| 459 | (interactive) | |
| 460 | (save-excursion | |
| 461 | (outline-flag-region (point) (progn (outline-next-preface) (point)) nil))) | |
| 462 | ||
| 463 | (defun hide-body () | |
| 464 | "Hide all of buffer except headings." | |
| 465 | (interactive) | |
| 466 | (hide-region-body (point-min) (point-max))) | |
| 467 | ||
| 468 | (defun hide-region-body (start end) | |
| 469 | "Hide all body lines in the region, but not headings." | |
| 470 | (save-excursion | |
| 471 | (save-restriction | |
| 472 | (narrow-to-region start end) | |
| 473 | (goto-char (point-min)) | |
| 474 | (if (outline-on-heading-p) | |
| 475 | (outline-end-of-heading)) | |
| 476 | (while (not (eobp)) | |
| 477 | (outline-flag-region (point) | |
| 478 | (progn (outline-next-preface) (point)) t) | |
| 479 | (if (not (eobp)) | |
| 480 | (progn | |
| 481 | (forward-char | |
| 482 | (if (looking-at "\n\n") | |
| 483 | 2 1)) | |
| 484 | (outline-end-of-heading))))))) | |
| 485 | ||
| 486 | (defun show-all () | |
| 487 | "Show all of the text in the buffer." | |
| 488 | (interactive) | |
| 489 | (outline-flag-region (point-min) (point-max) nil)) | |
| 490 | ||
| 491 | (defun hide-subtree () | |
| 492 | "Hide everything after this heading at deeper levels." | |
| 493 | (interactive) | |
| 494 | (outline-flag-subtree t)) | |
| 495 | ||
| 496 | (defun hide-leaves () | |
| 497 | "Hide all body after this heading at deeper levels." | |
| 498 | (interactive) | |
| 499 | (outline-back-to-heading) | |
| 500 | (outline-end-of-heading) | |
| 501 | (hide-region-body (point) (progn (outline-end-of-subtree) (point)))) | |
| 502 | ||
| 503 | (defun show-subtree () | |
| 504 | "Show everything after this heading at deeper levels." | |
| 505 | (interactive) | |
| 506 | (outline-flag-subtree nil)) | |
| 507 | ||
| 508 | (defun hide-sublevels (levels) | |
| 509 | "Hide everything but the top LEVELS levels of headers, in whole buffer." | |
| 510 | (interactive "p") | |
| 511 | (if (< levels 1) | |
| 512 | (error "Must keep at least one level of headers")) | |
| 513 | (setq levels (1- levels)) | |
| 514 | (save-excursion | |
| 515 | (goto-char (point-min)) | |
| 516 | ;; Keep advancing to the next top-level heading. | |
| 517 | (while (or (and (bobp) (outline-on-heading-p)) | |
| 518 | (outline-next-heading)) | |
| 519 | (let ((end (save-excursion (outline-end-of-subtree) (point)))) | |
| 520 | ;; Hide everything under that. | |
| 521 | (outline-flag-region (point) end t) | |
| 522 | ;; Show the first LEVELS levels under that. | |
| 523 | (if (> levels 0) | |
| 524 | (show-children levels)) | |
| 525 | ;; Move to the next, since we already found it. | |
| 526 | (goto-char end))))) | |
| 527 | ||
| 528 | (defun hide-other () | |
| 529 | "Hide everything except for the current body and the parent headings." | |
| 530 | (interactive) | |
| 531 | (hide-sublevels 1) | |
| 532 | (let ((last (point)) | |
| 533 | (pos (point))) | |
| 534 | (while (save-excursion | |
| 535 | (and (end-of-line 0) | |
| 536 | (not (outline-visible)))) | |
| 537 | (save-excursion | |
| 538 | (beginning-of-line) | |
| 539 | (if (eq last (point)) | |
| 540 | (progn | |
| 541 | (outline-next-heading) | |
| 542 | (outline-flag-region last (point) nil)) | |
| 543 | (show-children) | |
| 544 | (setq last (point))))))) | |
| 545 | ||
| 546 | (defun outline-flag-subtree (flag) | |
| 547 | (save-excursion | |
| 548 | (outline-back-to-heading) | |
| 549 | (outline-end-of-heading) | |
| 550 | (outline-flag-region (point) | |
| 551 | (progn (outline-end-of-subtree) (point)) | |
| 552 | flag))) | |
| 553 | ||
| 554 | (defun outline-end-of-subtree () | |
| 555 | (outline-back-to-heading) | |
| 556 | (let ((opoint (point)) | |
| 557 | (first t) | |
| 558 | (level (funcall outline-level))) | |
| 559 | (while (and (not (eobp)) | |
| 560 | (or first (> (funcall outline-level) level))) | |
| 561 | (setq first nil) | |
| 562 | (outline-next-heading)) | |
| 563 | (if (bolp) | |
| 564 | (progn | |
| 565 | ;; Go to end of line before heading | |
| 566 | (forward-char -1) | |
| 567 | (if (bolp) | |
| 568 | ;; leave blank line before heading | |
| 569 | (forward-char -1)))))) | |
| 570 | \f | |
| 571 | (defun show-branches () | |
| 572 | "Show all subheadings of this heading, but not their bodies." | |
| 573 | (interactive) | |
| 574 | (show-children 1000)) | |
| 575 | ||
| 576 | (defun show-children (&optional level) | |
| 577 | "Show all direct subheadings of this heading. | |
| 578 | Prefix arg LEVEL is how many levels below the current level should be shown. | |
| 579 | Default is enough to cause the following heading to appear." | |
| 580 | (interactive "P") | |
| 581 | (setq level | |
| 582 | (if level (prefix-numeric-value level) | |
| 583 | (save-excursion | |
| 584 | (outline-back-to-heading) | |
| 585 | (let ((start-level (funcall outline-level))) | |
| 586 | (outline-next-heading) | |
| 587 | (if (eobp) | |
| 588 | 1 | |
| 589 | (max 1 (- (funcall outline-level) start-level))))))) | |
| 590 | (save-excursion | |
| 591 | (save-restriction | |
| 592 | (outline-back-to-heading) | |
| 593 | (setq level (+ level (funcall outline-level))) | |
| 594 | (narrow-to-region (point) | |
| 595 | (progn (outline-end-of-subtree) | |
| 596 | (if (eobp) (point-max) (1+ (point))))) | |
| 597 | (goto-char (point-min)) | |
| 598 | (while (and (not (eobp)) | |
| 599 | (progn | |
| 600 | (outline-next-heading) | |
| 601 | (not (eobp)))) | |
| 602 | (if (<= (funcall outline-level) level) | |
| 603 | (save-excursion | |
| 604 | (outline-flag-region (save-excursion | |
| 605 | (forward-char -1) | |
| 606 | (if (bolp) | |
| 607 | (forward-char -1)) | |
| 608 | (point)) | |
| 609 | (progn (outline-end-of-heading) (point)) | |
| 610 | nil))))))) | |
| 611 | \f | |
| 612 | (defun outline-up-heading (arg) | |
| 613 | "Move to the heading line of which the present line is a subheading. | |
| 614 | With argument, move up ARG levels." | |
| 615 | (interactive "p") | |
| 616 | (outline-back-to-heading) | |
| 617 | (if (eq (funcall outline-level) 1) | |
| 56ade261 | 618 | (error "Already at top level of the outline")) |
| 0997c25b RS |
619 | (while (and (> (funcall outline-level) 1) |
| 620 | (> arg 0) | |
| 621 | (not (bobp))) | |
| 622 | (let ((present-level (funcall outline-level))) | |
| 623 | (while (not (< (funcall outline-level) present-level)) | |
| 624 | (outline-previous-visible-heading 1)) | |
| 625 | (setq arg (- arg 1))))) | |
| 626 | ||
| 627 | (defun outline-forward-same-level (arg) | |
| 628 | "Move forward to the ARG'th subheading at same level as this one. | |
| 629 | Stop at the first and last subheadings of a superior heading." | |
| 630 | (interactive "p") | |
| 631 | (outline-back-to-heading) | |
| 632 | (while (> arg 0) | |
| 633 | (let ((point-to-move-to (save-excursion | |
| 634 | (outline-get-next-sibling)))) | |
| 635 | (if point-to-move-to | |
| 636 | (progn | |
| 637 | (goto-char point-to-move-to) | |
| 638 | (setq arg (1- arg))) | |
| 639 | (progn | |
| 640 | (setq arg 0) | |
| 56ade261 | 641 | (error "No following same-level heading")))))) |
| 0997c25b RS |
642 | |
| 643 | (defun outline-get-next-sibling () | |
| 644 | "Move to next heading of the same level, and return point or nil if none." | |
| 645 | (let ((level (funcall outline-level))) | |
| 646 | (outline-next-visible-heading 1) | |
| 647 | (while (and (> (funcall outline-level) level) | |
| 648 | (not (eobp))) | |
| 649 | (outline-next-visible-heading 1)) | |
| 650 | (if (< (funcall outline-level) level) | |
| 651 | nil | |
| 652 | (point)))) | |
| 653 | ||
| 654 | (defun outline-backward-same-level (arg) | |
| 655 | "Move backward to the ARG'th subheading at same level as this one. | |
| 656 | Stop at the first and last subheadings of a superior heading." | |
| 657 | (interactive "p") | |
| 658 | (outline-back-to-heading) | |
| 659 | (while (> arg 0) | |
| 660 | (let ((point-to-move-to (save-excursion | |
| 661 | (outline-get-last-sibling)))) | |
| 662 | (if point-to-move-to | |
| 663 | (progn | |
| 664 | (goto-char point-to-move-to) | |
| 665 | (setq arg (1- arg))) | |
| 666 | (progn | |
| 667 | (setq arg 0) | |
| 56ade261 | 668 | (error "No previous same-level heading")))))) |
| 0997c25b RS |
669 | |
| 670 | (defun outline-get-last-sibling () | |
| 671 | "Move to next heading of the same level, and return point or nil if none." | |
| 672 | (let ((level (funcall outline-level))) | |
| 673 | (outline-previous-visible-heading 1) | |
| 674 | (while (and (> (funcall outline-level) level) | |
| 675 | (not (bobp))) | |
| 676 | (outline-previous-visible-heading 1)) | |
| 677 | (if (< (funcall outline-level) level) | |
| 678 | nil | |
| 679 | (point)))) | |
| 680 | ||
| 681 | (provide 'outline) | |
| 7ca5423e | 682 | (provide 'noutline) |
| 0997c25b RS |
683 | |
| 684 | ;;; outline.el ends here |