(defgroup outlines nil
"Support for hierarchical outlining"
:prefix "outline-"
:group 'editing)
(defcustom outline-regexp "[*\^L]+"
"*Regular expression to match the beginning of a heading.
Any line whose beginning matches this regexp is considered to start a heading.
Note that Outline mode only checks this regexp at the start of a line,
so the regexp need not (and usually does not) start with `^'.
The recommended way to set this is with a Local Variables: list
in the file it applies to. See also `outline-heading-end-regexp'."
:type '(choice regexp (const nil))
:group 'outlines)
(defcustom outline-heading-end-regexp "\n"
"*Regular expression to match the end of a heading line.
You can assume that point is at the beginning of a heading when this
regexp is searched for. The heading ends at the end of the match.
The recommended way to set this is with a `Local Variables:' list
in the file it applies to."
:type 'regexp
:group 'outlines)
(defvar outline-mode-prefix-map nil)
(if outline-mode-prefix-map
nil
(setq outline-mode-prefix-map (make-sparse-keymap))
(define-key outline-mode-prefix-map "@" 'outline-mark-subtree)
(define-key outline-mode-prefix-map "\C-n" 'outline-next-visible-heading)
(define-key outline-mode-prefix-map "\C-p" 'outline-previous-visible-heading)
(define-key outline-mode-prefix-map "\C-i" 'show-children)
(define-key outline-mode-prefix-map "\C-s" 'show-subtree)
(define-key outline-mode-prefix-map "\C-d" 'hide-subtree)
(define-key outline-mode-prefix-map "\C-u" 'outline-up-heading)
(define-key outline-mode-prefix-map "\C-f" 'outline-forward-same-level)
(define-key outline-mode-prefix-map "\C-b" 'outline-backward-same-level)
(define-key outline-mode-prefix-map "\C-t" 'hide-body)
(define-key outline-mode-prefix-map "\C-a" 'show-all)
(define-key outline-mode-prefix-map "\C-c" 'hide-entry)
(define-key outline-mode-prefix-map "\C-e" 'show-entry)
(define-key outline-mode-prefix-map "\C-l" 'hide-leaves)
(define-key outline-mode-prefix-map "\C-k" 'show-branches)
(define-key outline-mode-prefix-map "\C-q" 'hide-sublevels)
(define-key outline-mode-prefix-map "\C-o" 'hide-other))
(defvar outline-mode-menu-bar-map nil)
(if outline-mode-menu-bar-map
nil
(setq outline-mode-menu-bar-map (make-sparse-keymap))
(define-key outline-mode-menu-bar-map [hide]
(cons "Hide" (make-sparse-keymap "Hide")))
(define-key outline-mode-menu-bar-map [hide hide-other]
'("Hide Other" . hide-other))
(define-key outline-mode-menu-bar-map [hide hide-sublevels]
'("Hide Sublevels" . hide-sublevels))
(define-key outline-mode-menu-bar-map [hide hide-subtree]
'("Hide Subtree" . hide-subtree))
(define-key outline-mode-menu-bar-map [hide hide-entry]
'("Hide Entry" . hide-entry))
(define-key outline-mode-menu-bar-map [hide hide-body]
'("Hide Body" . hide-body))
(define-key outline-mode-menu-bar-map [hide hide-leaves]
'("Hide Leaves" . hide-leaves))
(define-key outline-mode-menu-bar-map [show]
(cons "Show" (make-sparse-keymap "Show")))
(define-key outline-mode-menu-bar-map [show show-subtree]
'("Show Subtree" . show-subtree))
(define-key outline-mode-menu-bar-map [show show-children]
'("Show Children" . show-children))
(define-key outline-mode-menu-bar-map [show show-branches]
'("Show Branches" . show-branches))
(define-key outline-mode-menu-bar-map [show show-entry]
'("Show Entry" . show-entry))
(define-key outline-mode-menu-bar-map [show show-all]
'("Show All" . show-all))
(define-key outline-mode-menu-bar-map [headings]
(cons "Headings" (make-sparse-keymap "Headings")))
(define-key outline-mode-menu-bar-map [headings copy]
'(menu-item "Copy to kill ring" outline-headers-as-kill
:enable mark-active))
(define-key outline-mode-menu-bar-map [headings outline-backward-same-level]
'("Previous Same Level" . outline-backward-same-level))
(define-key outline-mode-menu-bar-map [headings outline-forward-same-level]
'("Next Same Level" . outline-forward-same-level))
(define-key outline-mode-menu-bar-map [headings outline-previous-visible-heading]
'("Previous" . outline-previous-visible-heading))
(define-key outline-mode-menu-bar-map [headings outline-next-visible-heading]
'("Next" . outline-next-visible-heading))
(define-key outline-mode-menu-bar-map [headings outline-up-heading]
'("Up" . outline-up-heading)))
(defvar outline-mode-map nil "")
(if outline-mode-map
nil
(setq outline-mode-map (nconc (make-sparse-keymap) text-mode-map))
(define-key outline-mode-map "\C-c" outline-mode-prefix-map)
(define-key outline-mode-map [menu-bar] outline-mode-menu-bar-map))
(defvar outline-font-lock-keywords
'( (eval . (list (concat "^" outline-regexp ".+")
0 '(or (cdr (assq (outline-font-lock-level)
'((1 . font-lock-function-name-face)
(2 . font-lock-variable-name-face)
(3 . font-lock-keyword-face)
(4 . font-lock-builtin-face)
(5 . font-lock-comment-face)
(6 . font-lock-constant-face)
(7 . font-lock-type-face)
(8 . font-lock-string-face))))
font-lock-warning-face)
nil t)))
"Additional expressions to highlight in Outline mode.")
(defun outline-font-lock-level ()
(let ((count 1))
(save-excursion
(outline-back-to-heading t)
(while (and (not (bobp))
(not (eq (funcall outline-level) 1)))
(outline-up-heading-all 1)
(setq count (1+ count)))
count)))
(defvar outline-view-change-hook nil
"Normal hook to be run after outline visibility changes.")
(define-derived-mode outline-mode text-mode "Outline"
"Set major mode for editing outlines with selective display.
Headings are lines which start with asterisks: one for major headings,
two for subheadings, etc. Lines not starting with asterisks are body lines.
Body text or subheadings under a heading can be made temporarily
invisible, or visible again. Invisible lines are attached to the end
of the heading, so they move with it, if the line is killed and yanked
back. A heading with text hidden under it is marked with an ellipsis (...).
Commands:\\<outline-mode-map>
\\[outline-next-visible-heading] outline-next-visible-heading move by visible headings
\\[outline-previous-visible-heading] outline-previous-visible-heading
\\[outline-forward-same-level] outline-forward-same-level similar but skip subheadings
\\[outline-backward-same-level] outline-backward-same-level
\\[outline-up-heading] outline-up-heading move from subheading to heading
\\[hide-body] make all text invisible (not headings).
\\[show-all] make everything in buffer visible.
The remaining commands are used when point is on a heading line.
They apply to some of the body or subheadings of that heading.
\\[hide-subtree] hide-subtree make body and subheadings invisible.
\\[show-subtree] show-subtree make body and subheadings visible.
\\[show-children] show-children make direct subheadings visible.
No effect on body, or subheadings 2 or more levels down.
With arg N, affects subheadings N levels down.
\\[hide-entry] make immediately following body invisible.
\\[show-entry] make it visible.
\\[hide-leaves] make body under heading and under its subheadings invisible.
The subheadings remain visible.
\\[show-branches] make all subheadings at all levels visible.
The variable `outline-regexp' can be changed to control what is a heading.
A line is a heading if `outline-regexp' matches something at the
beginning of the line. The longer the match, the deeper the level.
Turning on outline mode calls the value of `text-mode-hook' and then of
`outline-mode-hook', if they are non-nil."
(make-local-variable 'line-move-ignore-invisible)
(setq line-move-ignore-invisible t)
(add-to-invisibility-spec '(outline . t))
(set (make-local-variable 'paragraph-start)
(concat paragraph-start "\\|\\(" outline-regexp "\\)"))
(set (make-local-variable 'auto-fill-inhibit-regexp) outline-regexp)
(set (make-local-variable 'paragraph-separate)
(concat paragraph-separate "\\|\\(" outline-regexp "\\)"))
(set (make-local-variable 'font-lock-defaults)
'(outline-font-lock-keywords t nil nil backward-paragraph))
(setq imenu-generic-expression
(list (list nil (concat "^\\(?:" outline-regexp "\\).*$") 0)))
(add-hook 'change-major-mode-hook 'show-all nil t))
(defcustom outline-minor-mode-prefix "\C-c@"
"*Prefix key to use for Outline commands in Outline minor mode.
The value of this variable is checked as part of loading Outline mode.
After that, changing the prefix key requires manipulating keymaps."
:type 'string
:group 'outlines)
(define-minor-mode outline-minor-mode
"Toggle Outline minor mode.
With arg, turn Outline minor mode on if arg is positive, off otherwise.
See the command `outline-mode' for more information on this mode."
nil " Outl" (list (cons [menu-bar] outline-mode-menu-bar-map)
(cons outline-minor-mode-prefix outline-mode-prefix-map))
(if outline-minor-mode
(progn
(add-hook 'change-major-mode-hook
(lambda () (outline-minor-mode -1))
nil t)
(set (make-local-variable 'line-move-ignore-invisible) t)
(add-to-invisibility-spec '(outline . t)))
(setq line-move-ignore-invisible nil)
(remove-from-invisibility-spec '(outline . t)))
(or outline-minor-mode
(show-all)))
(defcustom outline-level 'outline-level
"*Function of no args to compute a header's nesting level in an outline.
It can assume point is at the beginning of a header line."
:type 'function
:group 'outlines)
(defun outline-level ()
"Return the depth to which a statement is nested in the outline.
Point must be at the beginning of a header line. This is actually
the number of characters that `outline-regexp' matches."
(save-excursion
(looking-at outline-regexp)
(- (match-end 0) (match-beginning 0))))
(defun outline-next-preface ()
"Skip forward to just before the next heading line.
If there's no following heading line, stop before the newline
at the end of the buffer."
(if (re-search-forward (concat "\n\\(" outline-regexp "\\)")
nil 'move)
(goto-char (match-beginning 0)))
(if (and (bolp) (not (bobp)))
(forward-char -1)))
(defun outline-next-heading ()
"Move to the next (possibly invisible) heading line."
(interactive)
(if (re-search-forward (concat "\n\\(" outline-regexp "\\)")
nil 'move)
(goto-char (1+ (match-beginning 0)))))
(defun outline-previous-heading ()
"Move to the previous (possibly invisible) heading line."
(interactive)
(re-search-backward (concat "^\\(" outline-regexp "\\)")
nil 'move))
(defsubst outline-invisible-p ()
"Non-nil if the character after point is invisible."
(get-char-property (point) 'invisible))
(defun outline-visible ()
"Obsolete. Use `outline-invisible-p'."
(not (outline-invisible-p)))
(defun outline-back-to-heading (&optional invisible-ok)
"Move to previous heading line, or beg of this line if it's a heading.
Only visible heading lines are considered, unless INVISIBLE-OK is non-nil."
(beginning-of-line)
(or (outline-on-heading-p invisible-ok)
(let (found)
(save-excursion
(while (not found)
(or (re-search-backward (concat "^\\(" outline-regexp "\\)")
nil t)
(error "before first heading"))
(setq found (and (or invisible-ok (outline-visible)) (point)))))
(goto-char found)
found)))
(defun outline-on-heading-p (&optional invisible-ok)
"Return t if point is on a (visible) heading line.
If INVISIBLE-OK is non-nil, an invisible heading line is ok too."
(save-excursion
(beginning-of-line)
(and (bolp) (or invisible-ok (outline-visible))
(looking-at outline-regexp))))
(defun outline-end-of-heading ()
(if (re-search-forward outline-heading-end-regexp nil 'move)
(forward-char -1)))
(defun outline-next-visible-heading (arg)
"Move to the next visible heading line.
With argument, repeats or can move backward if negative.
A heading line is one that starts with a `*' (or that
`outline-regexp' matches)."
(interactive "p")
(if (< arg 0)
(beginning-of-line)
(end-of-line))
(while (and (not (bobp)) (< arg 0))
(while (and (not (bobp))
(re-search-backward (concat "^\\(" outline-regexp "\\)")
nil 'move)
(not (outline-visible))))
(setq arg (1+ arg)))
(while (and (not (eobp)) (> arg 0))
(while (and (not (eobp))
(re-search-forward (concat "^\\(" outline-regexp "\\)")
nil 'move)
(not (outline-visible))))
(setq arg (1- arg)))
(beginning-of-line))
(defun outline-previous-visible-heading (arg)
"Move to the previous heading line.
With argument, repeats or can move forward if negative.
A heading line is one that starts with a `*' (or that
`outline-regexp' matches)."
(interactive "p")
(outline-next-visible-heading (- arg)))
(defun outline-mark-subtree ()
"Mark the current subtree in an outlined document.
This puts point at the start of the current subtree, and mark at the end."
(interactive)
(let ((beg))
(if (outline-on-heading-p)
(beginning-of-line)
(outline-previous-visible-heading 1))
(setq beg (point))
(outline-end-of-subtree)
(push-mark (point))
(goto-char beg)))
(defun outline-flag-region (from to flag)
"Hides or shows lines from FROM to TO, according to FLAG.
If FLAG is nil then text is shown, while if FLAG is t the text is hidden."
(save-excursion
(goto-char from)
(end-of-line)
(outline-discard-overlays (point) to 'outline)
(if flag
(let ((o (make-overlay (point) to)))
(overlay-put o 'invisible 'outline)
(overlay-put o 'isearch-open-invisible
'outline-isearch-open-invisible))))
(run-hooks 'outline-view-change-hook))
(defun outline-isearch-open-invisible (overlay)
(show-entry))
(defun outline-discard-overlays (beg end prop)
(if (< end beg)
(setq beg (prog1 end (setq end beg))))
(save-excursion
(dolist (o (overlays-in beg end))
(if (eq (overlay-get o 'invisible) prop)
(if (< (overlay-start o) beg)
(if (> (overlay-end o) end)
(progn
(move-overlay (outline-copy-overlay o)
(overlay-start o) beg)
(move-overlay o end (overlay-end o)))
(move-overlay o (overlay-start o) beg))
(if (> (overlay-end o) end)
(move-overlay o end (overlay-end o))
(delete-overlay o)))))))
(defun outline-copy-overlay (o)
(let ((o1 (make-overlay (overlay-start o) (overlay-end o)
(overlay-buffer o)))
(props (overlay-properties o)))
(while props
(overlay-put o1 (car props) (nth 1 props))
(setq props (cdr (cdr props))))
o1))
(defun hide-entry ()
"Hide the body directly following this heading."
(interactive)
(outline-back-to-heading)
(outline-end-of-heading)
(save-excursion
(outline-flag-region (point) (progn (outline-next-preface) (point)) t)))
(defun show-entry ()
"Show the body directly following this heading.
Show the heading too, if it is currently invisible."
(interactive)
(save-excursion
(outline-back-to-heading t)
(outline-flag-region (1- (point))
(progn (outline-next-preface) (point)) nil)))
(defun hide-body ()
"Hide all of buffer except headings."
(interactive)
(hide-region-body (point-min) (point-max)))
(defun hide-region-body (start end)
"Hide all body lines in the region, but not headings."
(let (outline-view-change-hook)
(save-excursion
(save-restriction
(narrow-to-region start end)
(goto-char (point-min))
(if (outline-on-heading-p)
(outline-end-of-heading))
(while (not (eobp))
(outline-flag-region (point)
(progn (outline-next-preface) (point)) t)
(unless (eobp)
(forward-char (if (looking-at "\n\n") 2 1))
(outline-end-of-heading))))))
(run-hooks 'outline-view-change-hook))
(defun show-all ()
"Show all of the text in the buffer."
(interactive)
(outline-flag-region (point-min) (point-max) nil))
(defun hide-subtree ()
"Hide everything after this heading at deeper levels."
(interactive)
(outline-flag-subtree t))
(defun hide-leaves ()
"Hide all body after this heading at deeper levels."
(interactive)
(outline-back-to-heading)
(save-excursion
(outline-end-of-heading)
(hide-region-body (point) (progn (outline-end-of-subtree) (point)))))
(defun show-subtree ()
"Show everything after this heading at deeper levels."
(interactive)
(outline-flag-subtree nil))
(defun hide-sublevels (levels)
"Hide everything but the top LEVELS levels of headers, in whole buffer."
(interactive "p")
(if (< levels 1)
(error "Must keep at least one level of headers"))
(setq levels (1- levels))
(let (outline-view-change-hook)
(save-excursion
(goto-char (point-min))
(while (or (and (bobp) (outline-on-heading-p))
(outline-next-heading))
(let ((end (save-excursion (outline-end-of-subtree) (point))))
(outline-flag-region (point) end t)
(if (> levels 0)
(show-children levels))
(goto-char end)))))
(run-hooks 'outline-view-change-hook))
(defun hide-other ()
"Hide everything except current body and parent and top-level headings."
(interactive)
(hide-sublevels 1)
(let (outline-view-change-hook)
(save-excursion
(outline-back-to-heading t)
(show-entry)
(while (condition-case nil (progn (outline-up-heading 1) (not (bobp)))
(error nil))
(outline-flag-region (1- (point))
(save-excursion (forward-line 1) (point))
nil))))
(run-hooks 'outline-view-change-hook))
(defun outline-flag-subtree (flag)
(save-excursion
(outline-back-to-heading)
(outline-end-of-heading)
(outline-flag-region (point)
(progn (outline-end-of-subtree) (point))
flag)))
(defun outline-end-of-subtree ()
(outline-back-to-heading)
(let ((opoint (point))
(first t)
(level (funcall outline-level)))
(while (and (not (eobp))
(or first (> (funcall outline-level) level)))
(setq first nil)
(outline-next-heading))
(if (bolp)
(progn
(forward-char -1)
(if (bolp)
(forward-char -1))))))
(defun show-branches ()
"Show all subheadings of this heading, but not their bodies."
(interactive)
(show-children 1000))
(defun show-children (&optional level)
"Show all direct subheadings of this heading.
Prefix arg LEVEL is how many levels below the current level should be shown.
Default is enough to cause the following heading to appear."
(interactive "P")
(setq level
(if level (prefix-numeric-value level)
(save-excursion
(outline-back-to-heading)
(let ((start-level (funcall outline-level)))
(outline-next-heading)
(if (eobp)
1
(max 1 (- (funcall outline-level) start-level)))))))
(let (outline-view-change-hook)
(save-excursion
(save-restriction
(outline-back-to-heading)
(setq level (+ level (funcall outline-level)))
(narrow-to-region (point)
(progn (outline-end-of-subtree)
(if (eobp) (point-max) (1+ (point)))))
(goto-char (point-min))
(while (and (not (eobp))
(progn
(outline-next-heading)
(not (eobp))))
(if (<= (funcall outline-level) level)
(save-excursion
(outline-flag-region (save-excursion
(forward-char -1)
(if (bolp)
(forward-char -1))
(point))
(progn (outline-end-of-heading) (point))
nil)))))))
(run-hooks 'outline-view-change-hook))
(defun outline-up-heading-all (arg)
"Move to the heading line of which the present line is a subheading.
This function considers both visible and invisible heading lines.
With argument, move up ARG levels."
(outline-back-to-heading t)
(if (eq (funcall outline-level) 1)
(error "Already at top level of the outline"))
(while (and (> (funcall outline-level) 1)
(> arg 0)
(not (bobp)))
(let ((present-level (funcall outline-level)))
(while (and (not (< (funcall outline-level) present-level))
(not (bobp)))
(outline-previous-heading))
(setq arg (- arg 1)))))
(defun outline-up-heading (arg)
"Move to the visible heading line of which the present line is a subheading.
With argument, move up ARG levels."
(interactive "p")
(outline-back-to-heading)
(if (eq (funcall outline-level) 1)
(error "Already at top level of the outline"))
(while (and (> (funcall outline-level) 1)
(> arg 0)
(not (bobp)))
(let ((present-level (funcall outline-level)))
(while (and (not (< (funcall outline-level) present-level))
(not (bobp)))
(outline-previous-visible-heading 1))
(setq arg (- arg 1)))))
(defun outline-forward-same-level (arg)
"Move forward to the ARG'th subheading at same level as this one.
Stop at the first and last subheadings of a superior heading."
(interactive "p")
(outline-back-to-heading)
(while (> arg 0)
(let ((point-to-move-to (save-excursion
(outline-get-next-sibling))))
(if point-to-move-to
(progn
(goto-char point-to-move-to)
(setq arg (1- arg)))
(progn
(setq arg 0)
(error "No following same-level heading"))))))
(defun outline-get-next-sibling ()
"Move to next heading of the same level, and return point or nil if none."
(let ((level (funcall outline-level)))
(outline-next-visible-heading 1)
(while (and (> (funcall outline-level) level)
(not (eobp)))
(outline-next-visible-heading 1))
(if (< (funcall outline-level) level)
nil
(point))))
(defun outline-backward-same-level (arg)
"Move backward to the ARG'th subheading at same level as this one.
Stop at the first and last subheadings of a superior heading."
(interactive "p")
(outline-back-to-heading)
(while (> arg 0)
(let ((point-to-move-to (save-excursion
(outline-get-last-sibling))))
(if point-to-move-to
(progn
(goto-char point-to-move-to)
(setq arg (1- arg)))
(progn
(setq arg 0)
(error "No previous same-level heading"))))))
(defun outline-get-last-sibling ()
"Move to previous heading of the same level, and return point or nil if none."
(let ((level (funcall outline-level)))
(outline-previous-visible-heading 1)
(while (and (> (funcall outline-level) level)
(not (bobp)))
(outline-previous-visible-heading 1))
(if (< (funcall outline-level) level)
nil
(point))))
(defun outline-headers-as-kill (beg end)
"Save the visible outline headers in region at the start of the kill ring.
Text shown between the headers isn't copied. Two newlines are
inserted between saved headers. Yanking the result may be a
convenient way to make a table of contents of the buffer."
(interactive "r")
(save-excursion
(save-restriction
(narrow-to-region beg end)
(goto-char (point-min))
(let ((buffer (current-buffer))
start end)
(with-temp-buffer
(with-current-buffer buffer
(when (outline-on-heading-p)
(outline-back-to-heading)
(setq start (point)
end (progn (outline-end-of-heading)
(point)))
(insert-buffer-substring buffer start end)
(insert "\n\n")))
(let ((temp-buffer (current-buffer)))
(with-current-buffer buffer
(while (outline-next-heading)
(when (outline-visible)
(setq start (point)
end (progn (outline-end-of-heading) (point)))
(with-current-buffer temp-buffer
(insert-buffer-substring buffer start end)
(insert "\n\n"))))))
(kill-new (buffer-string)))))))
(provide 'outline)
(provide 'noutline)