-;; allout.el - An extensive outline-mode for Emacs.
-;; Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
+;;; allout.el --- extensive outline mode for use alone and with other modes
-;; Author: Ken Manheimer <klm@nist.gov>
-;; Maintainer: Ken Manheimer <klm@nist.gov>
+;; Copyright (C) 1992, 1993, 1994, 2001, 2002 Free Software Foundation, Inc.
+
+;; Author: Ken Manheimer <klm@zope.com>
+;; Maintainer: Ken Manheimer <klm@zope.com>
;; Created: Dec 1991 - first release to usenet
-;; Version: $Id: allout.el,v 3.39 1994/03/05 17:39:51 klm Exp klm $||
-;; Keywords: outline mode
+;; Keywords: outlines mode wp languages
;; This file is part of GNU Emacs.
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
-
-;;; Note - the lines beginning with ';;;_' are outline topic headers.
-;;; Load this file (or 'eval-current-buffer') and revisit the
-;;; file to give it a whirl.
-
-;;;_* Provide
-(provide 'outline)
-
-;;;_ + LCD Archive Entry
-
-;;;_ + Description
-;; A full-fledged outline mode, based on the original rudimentary
-;; GNU emacs outline functionality.
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
+
+;;; Commentary:
+
+;; Allout outline mode provides extensive outline formatting and
+;; and manipulation beyond standard emacs outline mode. It provides
+;; for structured editing of outlines, as well as navigation and
+;; exposure. It also provides for syntax-sensitive text like
+;; programming languages. (For an example, see the allout code
+;; itself, which is organized in ;; an outline framework.)
;;
-;;Ken Manheimer 301 975-3539
-;;ken.manheimer@nist.gov FAX: 301 963-9137
+;; In addition to outline navigation and exposure, allout includes:
;;
-;;Computer Systems and Communications Division
+;; - topic-oriented repositioning, cut, and paste
+;; - integral outline exposure-layout
+;; - incremental search with dynamic exposure and reconcealment of hidden text
+;; - automatic topic-number maintenance
+;; - "Hot-spot" operation, for single-keystroke maneuvering and
+;; exposure control. (See the `allout-mode' docstring.)
;;
-;; Nat'l Institute of Standards and Technology
-;; Technology A151
-;; Gaithersburg, MD 20899
+;; and many other features.
+;;
+;; The outline menubar additions provide quick reference to many of
+;; the features, and see the docstring of the function `allout-init'
+;; for instructions on priming your emacs session for automatic
+;; activation of `allout-mode'.
+;;
+;; See the docstring of the variables `allout-layout' and
+;; `allout-auto-activation' for details on automatic activation of
+;; allout `allout-mode' as a minor mode. (It has changed since allout
+;; 3.x, for those of you that depend on the old method.)
+;;
+;; Note - the lines beginning with `;;;_' are outline topic headers.
+;; Just `ESC-x eval-current-buffer' to give it a whirl.
-;;;_* User Customization variables
+;; Ken Manheimer klm@zope.com
-;;;_ + Topic Header configuration
+;;; Code:
-;;;_ = outline-header-prefix
-(defvar outline-header-prefix "."
- "*Outline topic header lines are identified by a leading topic
+;;;_* Provide
+(provide 'allout)
+
+;;;_* USER CUSTOMIZATION VARIABLES:
+(defgroup allout nil
+ "Extensive outline mode for use alone and with other modes."
+ :prefix "allout-"
+ :group 'editing)
+
+;;;_ + Layout, Mode, and Topic Header Configuration
+
+;;;_ = allout-auto-activation
+(defcustom allout-auto-activation nil
+ "*Regulates auto-activation modality of allout outlines - see `allout-init'.
+
+Setq-default by `allout-init' to regulate whether or not allout
+outline mode is automatically activated when the buffer-specific
+variable `allout-layout' is non-nil, and whether or not the layout
+dictated by `allout-layout' should be imposed on mode activation.
+
+With value t, auto-mode-activation and auto-layout are enabled.
+\(This also depends on `allout-find-file-hook' being installed in
+`find-file-hook', which is also done by `allout-init'.)
+
+With value `ask', auto-mode-activation is enabled, and endorsement for
+performing auto-layout is asked of the user each time.
+
+With value `activate', only auto-mode-activation is enabled,
+auto-layout is not.
+
+With value nil, neither auto-mode-activation nor auto-layout are
+enabled.
+
+See the docstring for `allout-init' for the proper interface to
+this variable."
+ :type '(choice (const :tag "On" t)
+ (const :tag "Ask about layout" "ask")
+ (const :tag "Mode only" "activate")
+ (const :tag "Off" nil))
+ :group 'allout)
+;;;_ = allout-layout
+(defvar allout-layout nil
+ "*Layout specification and provisional mode trigger for allout outlines.
+
+Buffer-specific.
+
+A list value specifies a default layout for the current buffer, to be
+applied upon activation of `allout-mode'. Any non-nil value will
+automatically trigger `allout-mode', provided `allout-init'
+has been called to enable it.
+
+See the docstring for `allout-init' for details on setting up for
+auto-mode-activation, and for `allout-expose-topic' for the format of
+the layout specification.
+
+You can associate a particular outline layout with a file by setting
+this var via the file's local variables. For example, the following
+lines at the bottom of an Emacs Lisp file:
+
+;;;Local variables:
+;;;allout-layout: \(0 : -1 -1 0)
+;;;End:
+
+will, modulo the above-mentioned conditions, cause the mode to be
+activated when the file is visited, followed by the equivalent of
+`\(allout-expose-topic 0 : -1 -1 0)'. \(This is the layout used for
+the allout.el, itself.)
+
+Also, allout's mode-specific provisions will make topic prefixes default
+to the comment-start string, if any, of the language of the file. This
+is modulo the setting of `allout-use-mode-specific-leader', which see.")
+(make-variable-buffer-local 'allout-layout)
+;;;_ = allout-show-bodies
+(defcustom allout-show-bodies nil
+ "*If non-nil, show entire body when exposing a topic, rather than
+just the header."
+ :type 'boolean
+ :group 'allout)
+(make-variable-buffer-local 'allout-show-bodies)
+
+;;;_ = allout-header-prefix
+(defcustom allout-header-prefix "."
+ "*Leading string which helps distinguish topic headers.
+
+Outline topic header lines are identified by a leading topic
header prefix, which mostly have the value of this var at their front.
\(Level 1 topics are exceptions. They consist of only a single
-character, which is typically set to the outline-primary-bullet.")
-(make-variable-buffer-local 'outline-header-prefix)
-
-;;;_ = outline-mode-leaders
-(defvar outline-mode-leaders
- '((emacs-lisp-mode . "\;\;\;_")
- (lisp-mode . "\;\;\;_")
- (awk-mode . "#")
- (csh-mode . "#")
- (sh-mode . "#")
- (tcl-mode . "#")
- (perl-mode . "#")
- (c++-mode "//_")
- (c-mode "/*_"))
- "Respective outline-prefix leading strings per major modes. The
-strings should begin with a comment string for the mode. Preferably,
-they would have an extra character, eg an \"_\" underscore, to
-distinguish the lead string from regular comments that start at bol.
-\'#'-commented script modes, however, may need to use a bar \'#' in
-order for the script magic number \'#!' to serve as the top-level
-topic.")
-
-;;;_ = outline-primary-bullet
-(defvar outline-primary-bullet "*"
- "Outline topic header lines are identified by a leading topic header
+character, which is typically set to the `allout-primary-bullet'. Many
+outlines start at level 2 to avoid this discrepancy."
+ :type 'string
+ :group 'allout)
+(make-variable-buffer-local 'allout-header-prefix)
+;;;_ = allout-primary-bullet
+(defcustom allout-primary-bullet "*"
+ "Bullet used for top-level outline topics.
+
+Outline topic header lines are identified by a leading topic header
prefix, which is concluded by bullets that includes the value of this
-var and the respective outline-*-bullets-string vars.
-
-The value of an asterisk ('*') provides for backwards compatability
-with the original emacs outline mode. See outline-plain-bullets-string
-and outline-distinctive-bullets-string for the range of available
-bullets.")
-(make-variable-buffer-local 'outline-primary-bullet)
-
-;;;_ = outline-plain-bullets-string
-(defvar outline-plain-bullets-string (concat outline-primary-bullet
- "+-:.;,")
- "*The bullets normally used in outline topic prefixes. See
-'outline-distinctive-bullets-string' for the other kind of
+var and the respective allout-*-bullets-string vars.
+
+The value of an asterisk (`*') provides for backwards compatibility
+with the original emacs outline mode. See `allout-plain-bullets-string'
+and `allout-distinctive-bullets-string' for the range of available
+bullets."
+ :type 'string
+ :group 'allout)
+(make-variable-buffer-local 'allout-primary-bullet)
+;;;_ = allout-plain-bullets-string
+(defcustom allout-plain-bullets-string ".:,;"
+ "*The bullets normally used in outline topic prefixes.
+
+See `allout-distinctive-bullets-string' for the other kind of
bullets.
-DO NOT include the close-square-bracket, ']', as a bullet.
+DO NOT include the close-square-bracket, `]', as a bullet.
Outline mode has to be reactivated in order for changes to the value
-of this var to take effect.")
-(make-variable-buffer-local 'outline-plain-bullets-string)
-
-;;;_ = outline-distinctive-bullets-string
-(defvar outline-distinctive-bullets-string "=>([{}&!?#%\"X@$~\\"
- "*The bullets used for distinguishing outline topics. These
-bullets are not offered among the regular rotation, and are not
-changed when automatically rebulleting, as when shifting the
-level of a topic. See 'outline-plain-bullets-string' for the
-other kind of bullets.
-
-DO NOT include the close-square-bracket, ']', among any bullets.
-
-You must run 'set-outline-regexp' in order for changes
-to the value of this var to effect outline-mode operation.")
-(make-variable-buffer-local 'outline-distinctive-bullets-string)
-
-;;;_ = outline-old-style-prefixes
-(defvar outline-old-style-prefixes nil
- "*Non-nil restricts the topic creation and modification
+of this var to take effect."
+ :type 'string
+ :group 'allout)
+(make-variable-buffer-local 'allout-plain-bullets-string)
+;;;_ = allout-distinctive-bullets-string
+(defcustom allout-distinctive-bullets-string "*+-=>([{}&!?#%\"X@$~_\\"
+ "*Persistent outline header bullets used to distinguish special topics.
+
+These bullets are used to distinguish topics from the run-of-the-mill
+ones. They are not used in the standard topic headers created by
+the topic-opening, shifting, and rebulleting \(eg, on topic shift,
+topic paste, blanket rebulleting) routines, but are offered among the
+choices for rebulleting. They are not altered by the above automatic
+rebulleting, so they can be used to characterize topics, eg:
+
+ `?' question topics
+ `\(' parenthetic comment \(with a matching close paren inside)
+ `[' meta-note \(with a matching close ] inside)
+ `\"' a quote
+ `=' value settings
+ `~' \"more or less\"
+
+... just for example. (`#' typically has a special meaning to the
+software, according to the value of `allout-numbered-bullet'.)
+
+See `allout-plain-bullets-string' for the selection of
+alternating bullets.
+
+You must run `set-allout-regexp' in order for outline mode to
+reconcile to changes of this value.
+
+DO NOT include the close-square-bracket, `]', on either of the bullet
+strings."
+ :type 'string
+ :group 'allout)
+(make-variable-buffer-local 'allout-distinctive-bullets-string)
+
+;;;_ = allout-use-mode-specific-leader
+(defcustom allout-use-mode-specific-leader t
+ "*When non-nil, use mode-specific topic-header prefixes.
+
+Allout outline mode will use the mode-specific `allout-mode-leaders'
+and/or comment-start string, if any, to lead the topic prefix string,
+so topic headers look like comments in the programming language.
+
+String values are used as they stand.
+
+Value t means to first check for assoc value in `allout-mode-leaders'
+alist, then use comment-start string, if any, then use default \(`.').
+\(See note about use of comment-start strings, below.)
+
+Set to the symbol for either of `allout-mode-leaders' or
+`comment-start' to use only one of them, respectively.
+
+Value nil means to always use the default \(`.').
+
+comment-start strings that do not end in spaces are tripled, and an
+`_' underscore is tacked on the end, to distinguish them from regular
+comment strings. comment-start strings that do end in spaces are not
+tripled, but an underscore is substituted for the space. [This
+presumes that the space is for appearance, not comment syntax. You
+can use `allout-mode-leaders' to override this behavior, when
+incorrect.]"
+ :type '(choice (const t) (const nil) string
+ (const allout-mode-leaders)
+ (const comment-start))
+ :group 'allout)
+;;;_ = allout-mode-leaders
+(defvar allout-mode-leaders '()
+ "Specific allout-prefix leading strings per major modes.
+
+Entries will be used instead or in lieu of mode-specific
+comment-start strings. See also `allout-use-mode-specific-leader'.
+
+If you're constructing a string that will comment-out outline
+structuring so it can be included in program code, append an extra
+character, like an \"_\" underscore, to distinguish the lead string
+from regular comments that start at bol.")
+
+;;;_ = allout-old-style-prefixes
+(defcustom allout-old-style-prefixes nil
+ "*When non-nil, use only old-and-crusty `outline-mode' `*' topic prefixes.
+
+Non-nil restricts the topic creation and modification
functions to asterix-padded prefixes, so they look exactly
like the original emacs-outline style prefixes.
Whatever the setting of this variable, both old and new style prefixes
-are always respected by the topic maneuvering functions.")
-(make-variable-buffer-local 'outline-old-style-prefixes)
-
-;;;_ = outline-stylish-prefixes - new fangled topic prefixes
-(defvar outline-stylish-prefixes t
- "*Non-nil allows the topic creation and modification
-functions to vary the topic bullet char (the char that marks
-the topic depth) just preceding the start of the topic text)
-according to level. Otherwise, only asterisks ('*') and
-distinctive bullets are used.
-
-This is how an outline can look with stylish prefixes:
+are always respected by the topic maneuvering functions."
+ :type 'boolean
+ :group 'allout)
+(make-variable-buffer-local 'allout-old-style-prefixes)
+;;;_ = allout-stylish-prefixes - alternating bullets
+(defcustom allout-stylish-prefixes t
+ "*Do fancy stuff with topic prefix bullets according to level, etc.
+
+Non-nil enables topic creation, modification, and repositioning
+functions to vary the topic bullet char (the char that marks the topic
+depth) just preceding the start of the topic text) according to level.
+Otherwise, only asterisks (`*') and distinctive bullets are used.
+
+This is how an outline can look (but sans indentation) with stylish
+prefixes:
* Top level
.* A topic
. + One level 3 subtopic
. . One level 4 subtopic
+ . . A second 4 subtopic
. + Another level 3 subtopic
- . . A level 4 subtopic
- . #2 A distinguished, numbered level 4 subtopic
- . ! A distinguished ('!') level 4 subtopic
- . #4 Another numbered level 4 subtopic
+ . #1 A numbered level 4 subtopic
+ . #2 Another
+ . ! Another level 4 subtopic with a different distinctive bullet
+ . #4 And another numbered level 4 subtopic
- This would be an outline with stylish prefixes inhibited:
+This would be an outline with stylish prefixes inhibited (but the
+numbered and other distinctive bullets retained):
* Top level
.* A topic
- .! A distinctive (but measly) subtopic
- . * A sub-subtopic - no bullets from outline-plain-bullets-string but '*'
+ . * One level 3 subtopic
+ . * One level 4 subtopic
+ . * A second 4 subtopic
+ . * Another level 3 subtopic
+ . #1 A numbered level 4 subtopic
+ . #2 Another
+ . ! Another level 4 subtopic with a different distinctive bullet
+ . #4 And another numbered level 4 subtopic
Stylish and constant prefixes (as well as old-style prefixes) are
always respected by the topic maneuvering functions, regardless of
this variable setting.
-The setting of this var is not relevant when outline-old-style-prefixes
-is non-nil.")
-(make-variable-buffer-local 'outline-stylish-prefixes)
+The setting of this var is not relevant when `allout-old-style-prefixes'
+is non-nil."
+ :type 'boolean
+ :group 'allout)
+(make-variable-buffer-local 'allout-stylish-prefixes)
-;;;_ = outline-numbered-bullet
-(defvar outline-numbered-bullet "#"
- "*Topics having this bullet have automatic maintainence of a sibling
-sequence number tacked on just after the bullet. Conventionally set
-to \"#\", you can set it to a bullet of your choice. A nil value
-disables numbering maintainence.")
-(make-variable-buffer-local 'outline-numbered-bullet)
+;;;_ = allout-numbered-bullet
+(defcustom allout-numbered-bullet "#"
+ "*String designating bullet of topics that have auto-numbering; nil for none.
-;;;_ = outline-file-xref-bullet
-(defvar outline-file-xref-bullet "@"
- "*Set this var to the bullet you want to use for file cross-references.
-Set it 'nil' if you want to inhibit this capability.")
+Topics having this bullet have automatic maintenance of a sibling
+sequence-number tacked on, just after the bullet. Conventionally set
+to \"#\", you can set it to a bullet of your choice. A nil value
+disables numbering maintenance."
+ :type '(choice (const nil) string)
+ :group 'allout)
+(make-variable-buffer-local 'allout-numbered-bullet)
+;;;_ = allout-file-xref-bullet
+(defcustom allout-file-xref-bullet "@"
+ "*Bullet signifying file cross-references, for `allout-resolve-xref'.
+
+Set this var to the bullet you want to use for file cross-references."
+ :type '(choice (const nil) string)
+ :group 'allout)
+
+;;;_ = allout-presentation-padding
+(defcustom allout-presentation-padding 2
+ "*Presentation-format white-space padding factor, for greater indent."
+ :type 'integer
+ :group 'allout)
+
+(make-variable-buffer-local 'allout-presentation-padding)
+
+;;;_ = allout-abbreviate-flattened-numbering
+(defcustom allout-abbreviate-flattened-numbering nil
+ "*If non-nil, `allout-flatten-exposed-to-buffer' abbreviates topic
+numbers to minimal amount with some context. Otherwise, entire
+numbers are always used."
+ :type 'boolean
+ :group 'allout)
;;;_ + LaTeX formatting
-;;;_ - outline-number-pages
-(defvar outline-number-pages nil
- "*Non-nil turns on page numbering for LaTeX formatting of an outline.")
-;;;_ - outline-label-style
-(defvar outline-label-style "\\large\\bf"
- "*Font and size of labels for LaTeX formatting of an outline.")
-;;;_ - outline-head-line-style
-(defvar outline-head-line-style "\\large\\sl "
- "*Font and size of entries for LaTeX formatting of an outline.")
-;;;_ - outline-body-line-style
-(defvar outline-body-line-style " "
- "*Font and size of entries for LaTeX formatting of an outline.")
-;;;_ - outline-title-style
-(defvar outline-title-style "\\Large\\bf"
- "*Font and size of titles for LaTeX formatting of an outline.")
-;;;_ - outline-title
-(defvar outline-title '(or buffer-file-name (current-buffer-name))
+;;;_ - allout-number-pages
+(defcustom allout-number-pages nil
+ "*Non-nil turns on page numbering for LaTeX formatting of an outline."
+ :type 'boolean
+ :group 'allout)
+;;;_ - allout-label-style
+(defcustom allout-label-style "\\large\\bf"
+ "*Font and size of labels for LaTeX formatting of an outline."
+ :type 'string
+ :group 'allout)
+;;;_ - allout-head-line-style
+(defcustom allout-head-line-style "\\large\\sl "
+ "*Font and size of entries for LaTeX formatting of an outline."
+ :type 'string
+ :group 'allout)
+;;;_ - allout-body-line-style
+(defcustom allout-body-line-style " "
+ "*Font and size of entries for LaTeX formatting of an outline."
+ :type 'string
+ :group 'allout)
+;;;_ - allout-title-style
+(defcustom allout-title-style "\\Large\\bf"
+ "*Font and size of titles for LaTeX formatting of an outline."
+ :type 'string
+ :group 'allout)
+;;;_ - allout-title
+(defcustom allout-title '(or buffer-file-name (current-buffer-name))
"*Expression to be evaluated to determine the title for LaTeX
-formatted copy.")
-;;;_ - outline-line-skip
-(defvar outline-line-skip ".05cm"
- "*Space between lines for LaTeX formatting of an outline.")
-;;;_ - outline-indent
-(defvar outline-indent ".3cm"
- "*LaTeX formatted depth-indent spacing.")
+formatted copy."
+ :type 'sexp
+ :group 'allout)
+;;;_ - allout-line-skip
+(defcustom allout-line-skip ".05cm"
+ "*Space between lines for LaTeX formatting of an outline."
+ :type 'string
+ :group 'allout)
+;;;_ - allout-indent
+(defcustom allout-indent ".3cm"
+ "*LaTeX formatted depth-indent spacing."
+ :type 'string
+ :group 'allout)
;;;_ + Miscellaneous customization
-;;;_ = outline-keybindings-list
-;;; You have to reactivate outline-mode - '(outline-mode t)' - to
+;;;_ = allout-command-prefix
+(defcustom allout-command-prefix "\C-c"
+ "*Key sequence to be used as prefix for outline mode command key bindings."
+ :type 'string
+ :group 'allout)
+
+;;;_ = allout-keybindings-list
+;;; You have to reactivate allout-mode - `(allout-mode t)' - to
;;; institute changes to this var.
-(defvar outline-keybindings-list ()
- "*List of outline-mode key / function bindings, they will be locally
-bound on the outline-mode-map. The keys will be prefixed by
-outline-command-prefix unless the cell contains a third, no-nil
-element, in which case the initial string will be used as is.")
-(setq outline-keybindings-list
+(defvar allout-keybindings-list ()
+ "*List of `allout-mode' key / function bindings, for `allout-mode-map'.
+
+String or vector key will be prefaced with `allout-command-prefix',
+unless optional third, non-nil element is present.")
+(setq allout-keybindings-list
'(
; Motion commands:
- ("?t" outline-latexify-exposed)
- ("\C-n" outline-next-visible-heading)
- ("\C-p" outline-previous-visible-heading)
- ("\C-u" outline-up-current-level)
- ("\C-f" outline-forward-current-level)
- ("\C-b" outline-backward-current-level)
- ("\C-a" outline-beginning-of-current-entry)
- ("\C-e" outline-end-of-current-entry)
- ;;("\C-n" outline-next-line-or-topic)
- ;;("\C-p" outline-previous-line-or-topic)
+ ("\C-n" allout-next-visible-heading)
+ ("\C-p" allout-previous-visible-heading)
+ ("\C-u" allout-up-current-level)
+ ("\C-f" allout-forward-current-level)
+ ("\C-b" allout-backward-current-level)
+ ("\C-a" allout-beginning-of-current-entry)
+ ("\C-e" allout-end-of-current-entry)
; Exposure commands:
- ("\C-i" outline-show-children)
- ("\C-s" outline-show-current-subtree)
- ("\C-h" outline-hide-current-subtree)
- ("\C-o" outline-show-current-entry)
- ("!" outline-show-all)
+ ("\C-i" allout-show-children)
+ ("\C-s" allout-show-current-subtree)
+ ("\C-h" allout-hide-current-subtree)
+ ("\C-o" allout-show-current-entry)
+ ("!" allout-show-all)
; Alteration commands:
- (" " outline-open-sibtopic)
- ("." outline-open-subtopic)
- ("," outline-open-supertopic)
- ("'" outline-shift-in)
- (">" outline-shift-in)
- ("<" outline-shift-out)
- ("\C-m" outline-rebullet-topic)
- ("b" outline-rebullet-current-heading)
- ("#" outline-number-siblings)
- ("\C-k" outline-kill-line t)
- ("\C-y" outline-yank t)
- ("\M-y" outline-yank-pop t)
- ("\C-k" outline-kill-topic)
+ (" " allout-open-sibtopic)
+ ("." allout-open-subtopic)
+ ("," allout-open-supertopic)
+ ("'" allout-shift-in)
+ (">" allout-shift-in)
+ ("<" allout-shift-out)
+ ("\C-m" allout-rebullet-topic)
+ ("*" allout-rebullet-current-heading)
+ ("#" allout-number-siblings)
+ ("\C-k" allout-kill-line t)
+ ("\C-y" allout-yank t)
+ ("\M-y" allout-yank-pop t)
+ ("\C-k" allout-kill-topic)
; Miscellaneous commands:
- ("\C-@" outline-mark-topic)
- ("@" outline-resolve-xref)
- ("?c" outline-copy-exposed)))
-
-;;;_ = outline-command-prefix
-(defvar outline-command-prefix "\C-c"
- "*Key sequence to be used as prefix for outline mode command key bindings.")
-
-;;;_ = outline-enwrap-isearch-mode - any non-nil value fine in Emacs 19.
-(defvar outline-enwrap-isearch-mode "isearch-mode.el"
- "*Set this var non-nil if you're using Emacs 19 or Lucid emacs, or
-you're using Dan LaLiberte's 'isearch-mode' stuff. (If you have
-LaLiberte's package available but its' typically loaded, set the
-var to the name of the text, not the byte-compiled, load file.)
-
-The new isearch is required if you want isearches to expose hidden
-stuff encountered in the course of a search, and to reconceal it if
-you go past.
-
-Set the var nil if you're not using emacs 19 and you don't have the
-elisp-archive package, or if want to disable this feature.")
-
-;;;_ = outline-use-hanging-indents
-(defvar outline-use-hanging-indents t
- "*When non-nil, the default auto-indent for text of topic bodies is
-set to be even with the leading text of the header. Ie, it is
-indented to be just past the header prefix. This is relevant mostly
-for use with indented-text-mode, or other situations where auto-fill
-occurs.
-
-[This feature no longer depends in any way on the 'filladapt.el'
-lisp-archive package.]")
-(make-variable-buffer-local 'outline-use-hanging-indents)
-
-;;;_ = outline-reindent-bodies
-(defvar outline-reindent-bodies outline-use-hanging-indents
- "*Set this var non-nil if you want topic depth adjustments to
-reindent hanging bodies so they remain even with the beginning
-of heading text.")
-(make-variable-buffer-local 'outline-reindent-bodies)
-
-;;;_ = outline-sticky-header-motion
-(defvar outline-sticky-header-motion t
- "*Non-nil means that outline-{next,previous}-line or topic, bound
-to keys typically dedicated to {next,previous}-line, will move by
-topics when the cursor is moving from the first character of topic-
-header text. You can always move the cursor off of that first-char
-\"hot spot\" when you want to do regular next/previous line motions.")
-(make-variable-buffer-local 'outline-sticky-header-motion)
-
-;;;_ = outline-inhibit-protection
-(defvar outline-inhibit-protection nil
- "*Outline mode uses emacs change-triggered functions (not available
-before emacs 19) to detect unruly changes to concealed regions. Set
-this var non-nil to disable the protection, potentially increasing
-text-entry responsiveness a bit.
-
-The effect of this var occurs at outline-mode activation, so you may
-have to deactivate and then reactivate if you want to toggle the
-behavior.")
-
-;;;_* Code - no user customizations below.
-
-;;;_ #1 Outline Format, Internal Configuration, and Mode Activation
-;;;_ - Topic header format
-;;;_ = outline-regexp
-(defvar outline-regexp ""
+ ;([?\C-\ ] allout-mark-topic)
+ ("@" allout-resolve-xref)
+ ("=c" allout-copy-exposed-to-buffer)
+ ("=i" allout-indented-exposed-to-buffer)
+ ("=t" allout-latexify-exposed)
+ ("=p" allout-flatten-exposed-to-buffer)))
+
+;;;_ = allout-isearch-dynamic-expose
+(defcustom allout-isearch-dynamic-expose t
+ "*Non-nil enable dynamic exposure of hidden incremental-search
+targets as they're encountered."
+ :type 'boolean
+ :group 'allout)
+(make-variable-buffer-local 'allout-isearch-dynamic-expose)
+
+;;;_ = allout-use-hanging-indents
+(defcustom allout-use-hanging-indents t
+ "*If non-nil, topic body text auto-indent defaults to indent of the header.
+Ie, it is indented to be just past the header prefix. This is
+relevant mostly for use with indented-text-mode, or other situations
+where auto-fill occurs.
+
+\[This feature no longer depends in any way on the `filladapt.el'
+lisp-archive package.\]"
+ :type 'boolean
+ :group 'allout)
+(make-variable-buffer-local 'allout-use-hanging-indents)
+
+;;;_ = allout-reindent-bodies
+(defcustom allout-reindent-bodies (if allout-use-hanging-indents
+ 'text)
+ "*Non-nil enables auto-adjust of topic body hanging indent with depth shifts.
+
+When active, topic body lines that are indented even with or beyond
+their topic header are reindented to correspond with depth shifts of
+the header.
+
+A value of t enables reindent in non-programming-code buffers, ie
+those that do not have the variable `comment-start' set. A value of
+`force' enables reindent whether or not `comment-start' is set."
+ :type '(choice (const nil) (const t) (const text) (const force))
+ :group 'allout)
+
+(make-variable-buffer-local 'allout-reindent-bodies)
+
+;;;_ = allout-inhibit-protection
+(defcustom allout-inhibit-protection nil
+ "*Non-nil disables warnings and confirmation-checks for concealed-text edits.
+
+Outline mode uses emacs change-triggered functions to detect unruly
+changes to concealed regions. Set this var non-nil to disable the
+protection, potentially increasing text-entry responsiveness a bit.
+
+This var takes effect at `allout-mode' activation, so you may have to
+deactivate and then reactivate the mode if you want to toggle the
+behavior."
+ :type 'boolean
+ :group 'allout)
+
+;;;_* CODE - no user customizations below.
+
+;;;_ #1 Internal Outline Formatting and Configuration
+;;;_ : Version
+;;;_ = allout-version
+(defvar allout-version
+ (let ((rcs-rev "$Revision: 1.48 $"))
+ (condition-case err
+ (save-match-data
+ (string-match "Revision: \\([0-9]+\\.[0-9]+\\)" rcs-rev)
+ (substring rcs-rev (match-beginning 1) (match-end 1)))
+ ('error rcs-rev)))
+ "Revision number of currently loaded outline package. \(allout.el)")
+;;;_ > allout-version
+(defun allout-version (&optional here)
+ "Return string describing the loaded outline version."
+ (interactive "P")
+ (let ((msg (concat "Allout Outline Mode v " allout-version)))
+ (if here (insert msg))
+ (message "%s" msg)
+ msg))
+;;;_ : Topic header format
+;;;_ = allout-regexp
+(defvar allout-regexp ""
"*Regular expression to match the beginning of a heading line.
+
Any line whose beginning matches this regexp is considered a
heading. This var is set according to the user configuration vars
-by set-outline-regexp.")
-(make-variable-buffer-local 'outline-regexp)
-;;;_ = outline-bullets-string
-(defvar outline-bullets-string ""
- "A string dictating the valid set of outline topic bullets. This
-var should *not* be set by the user - it is set by 'set-outline-regexp',
-and is composed from the elements of 'outline-plain-bullets-string'
-and 'outline-distinctive-bullets-string'.")
-(make-variable-buffer-local 'outline-bullets-string)
-;;;_ = outline-bullets-string-len
-(defvar outline-bullets-string-len 0
- "Length of current buffers' outline-plain-bullets-string.")
-(make-variable-buffer-local 'outline-bullets-string-len)
-;;;_ = outline-line-boundary-regexp
-(defvar outline-line-boundary-regexp ()
- "outline-regexp with outline-style beginning of line anchor (ie,
-C-j, *or* C-m, for prefixes of hidden topics). This is properly
-set when outline-regexp is produced by 'set-outline-regexp', so
+by `set-allout-regexp'.")
+(make-variable-buffer-local 'allout-regexp)
+;;;_ = allout-bullets-string
+(defvar allout-bullets-string ""
+ "A string dictating the valid set of outline topic bullets.
+
+This var should *not* be set by the user - it is set by `set-allout-regexp',
+and is produced from the elements of `allout-plain-bullets-string'
+and `allout-distinctive-bullets-string'.")
+(make-variable-buffer-local 'allout-bullets-string)
+;;;_ = allout-bullets-string-len
+(defvar allout-bullets-string-len 0
+ "Length of current buffers' `allout-plain-bullets-string'.")
+(make-variable-buffer-local 'allout-bullets-string-len)
+;;;_ = allout-line-boundary-regexp
+(defvar allout-line-boundary-regexp ()
+ "`allout-regexp' with outline style beginning-of-line anchor.
+
+\(Ie, C-j, *or* C-m, for prefixes of hidden topics). This is properly
+set when `allout-regexp' is produced by `set-allout-regexp', so
that (match-beginning 2) and (match-end 2) delimit the prefix.")
-(make-variable-buffer-local 'outline-line-boundary-regexp)
-;;;_ = outline-bob-regexp
-(defvar outline-bob-regexp ()
- "Like outline-line-boundary-regexp, this is an outline-regexp for
-outline headers at the beginning of the buffer. (match-beginning 2)
-and (match-end 2) delimit the prefix.")
-(make-variable-buffer-local 'outline-bob-regexp)
-;;;_ = current-bullet
-(defvar current-bullet nil
- "Variable local to outline-rebullet-heading,but referenced by
-outline-make-topic-prefix, also. Should be resolved with explicitly
-parameterized communication between the two, if suitable.")
-;;;_ = outline-header-subtraction
-(defvar outline-header-subtraction (1- (length outline-header-prefix))
- "Length of outline-header prefix to subtract when computing depth
-from prefix length.")
-(make-variable-buffer-local 'outline-header-subtraction)
-;;;_ = outline-plain-bullets-string-len
-(defvar outline-plain-bullets-string-len (length outline-plain-bullets-string)
- "Length of outline-plain-bullets-string, updated by set-outline-regexp.")
-(make-variable-buffer-local 'outline-plain-bullets-string-len)
-
-
-;;;_ > outline-reset-header-lead (header-lead)
-(defun outline-reset-header-lead (header-lead)
+(make-variable-buffer-local 'allout-line-boundary-regexp)
+;;;_ = allout-bob-regexp
+(defvar allout-bob-regexp ()
+ "Like `allout-line-boundary-regexp', for headers at beginning of buffer.
+\(match-beginning 2) and \(match-end 2) delimit the prefix.")
+(make-variable-buffer-local 'allout-bob-regexp)
+;;;_ = allout-header-subtraction
+(defvar allout-header-subtraction (1- (length allout-header-prefix))
+ "Allout-header prefix length to subtract when computing topic depth.")
+(make-variable-buffer-local 'allout-header-subtraction)
+;;;_ = allout-plain-bullets-string-len
+(defvar allout-plain-bullets-string-len (length allout-plain-bullets-string)
+ "Length of `allout-plain-bullets-string', updated by `set-allout-regexp'.")
+(make-variable-buffer-local 'allout-plain-bullets-string-len)
+
+
+;;;_ X allout-reset-header-lead (header-lead)
+(defun allout-reset-header-lead (header-lead)
"*Reset the leading string used to identify topic headers."
(interactive "sNew lead string: ")
- (setq outline-header-prefix header-lead)
- (setq outline-header-subtraction (1- (length outline-header-prefix)))
- (set-outline-regexp))
-;;;_ > outline-lead-with-comment-string (header-lead)
-(defun outline-lead-with-comment-string (&optional header-lead)
- "*Set the topic-header leading string to specified string. Useful
-when for encapsulating outline structure in programming language
-comments. Returns the leading string."
+ (setq allout-header-prefix header-lead)
+ (setq allout-header-subtraction (1- (length allout-header-prefix)))
+ (set-allout-regexp))
+;;;_ X allout-lead-with-comment-string (header-lead)
+(defun allout-lead-with-comment-string (&optional header-lead)
+ "*Set the topic-header leading string to specified string.
+
+Useful when for encapsulating outline structure in programming
+language comments. Returns the leading string."
(interactive "P")
(if (not (stringp header-lead))
(setq header-lead (read-string
"String prefix for topic headers: ")))
- (setq outline-reindent-bodies nil)
- (outline-reset-header-lead header-lead)
+ (setq allout-reindent-bodies nil)
+ (allout-reset-header-lead header-lead)
header-lead)
-;;;_ > set-outline-regexp ()
-(defun set-outline-regexp ()
- "Generate proper topic-header regexp form for outline functions, from
-outline-plain-bullets-string and outline-distinctive-bullets-string."
+;;;_ > allout-infer-header-lead ()
+(defun allout-infer-header-lead ()
+ "Determine appropriate `allout-header-prefix'.
+
+Works according to settings of:
+
+ `comment-start'
+ `allout-header-prefix' (default)
+ `allout-use-mode-specific-leader'
+and `allout-mode-leaders'.
+
+Apply this via \(re)activation of `allout-mode', rather than
+invoking it directly."
+ (let* ((use-leader (and (boundp 'allout-use-mode-specific-leader)
+ (if (or (stringp allout-use-mode-specific-leader)
+ (memq allout-use-mode-specific-leader
+ '(allout-mode-leaders
+ comment-start
+ t)))
+ allout-use-mode-specific-leader
+ ;; Oops - garbled value, equate with effect of 't:
+ t)))
+ (leader
+ (cond
+ ((not use-leader) nil)
+ ;; Use the explicitly designated leader:
+ ((stringp use-leader) use-leader)
+ (t (or (and (memq use-leader '(t allout-mode-leaders))
+ ;; Get it from outline mode leaders?
+ (cdr (assq major-mode allout-mode-leaders)))
+ ;; ... didn't get from allout-mode-leaders...
+ (and (memq use-leader '(t comment-start))
+ comment-start
+ ;; Use comment-start, maybe tripled, and with
+ ;; underscore:
+ (concat
+ (if (string= " "
+ (substring comment-start
+ (1- (length comment-start))))
+ ;; Use comment-start, sans trailing space:
+ (substring comment-start 0 -1)
+ (concat comment-start comment-start comment-start))
+ ;; ... and append underscore, whichever:
+ "_")))))))
+ (if (not leader)
+ nil
+ (if (string= leader allout-header-prefix)
+ nil ; no change, nothing to do.
+ (setq allout-header-prefix leader)
+ allout-header-prefix))))
+;;;_ > allout-infer-body-reindent ()
+(defun allout-infer-body-reindent ()
+ "Determine proper setting for `allout-reindent-bodies'.
+
+Depends on default setting of `allout-reindent-bodies' \(which see)
+and presence of setting for `comment-start', to tell whether the
+file is programming code."
+ (if (and allout-reindent-bodies
+ comment-start
+ (not (eq 'force allout-reindent-bodies)))
+ (setq allout-reindent-bodies nil)))
+;;;_ > set-allout-regexp ()
+(defun set-allout-regexp ()
+ "Generate proper topic-header regexp form for outline functions.
+
+Works with respect to `allout-plain-bullets-string' and
+`allout-distinctive-bullets-string'."
(interactive)
- ;; Derive outline-bullets-string from user configured components:
- (setq outline-bullets-string "")
- (let ((strings (list 'outline-plain-bullets-string
- 'outline-distinctive-bullets-string))
+ ;; Derive allout-bullets-string from user configured components:
+ (setq allout-bullets-string "")
+ (let ((strings (list 'allout-plain-bullets-string
+ 'allout-distinctive-bullets-string
+ 'allout-primary-bullet))
cur-string
cur-len
cur-char
(setq cur-len (length (setq cur-string (symbol-value (car strings)))))
(while (< index cur-len)
(setq cur-char (aref cur-string index))
- (setq outline-bullets-string
- (concat outline-bullets-string
+ (setq allout-bullets-string
+ (concat allout-bullets-string
(cond
; Single dash would denote a
; sequence, repeated denotes
(setq index (1+ index)))
(setq strings (cdr strings)))
)
- ;; Derive next for repeated use in outline-pending-bullet:
- (setq outline-plain-bullets-string-len (length outline-plain-bullets-string))
- (setq outline-header-subtraction (1- (length outline-header-prefix)))
- ;; Produce the new outline-regexp:
- (setq outline-regexp (concat "\\(\\"
- outline-header-prefix
+ ;; Derive next for repeated use in allout-pending-bullet:
+ (setq allout-plain-bullets-string-len (length allout-plain-bullets-string))
+ (setq allout-header-subtraction (1- (length allout-header-prefix)))
+ ;; Produce the new allout-regexp:
+ (setq allout-regexp (concat "\\(\\"
+ allout-header-prefix
"[ \t]*["
- outline-bullets-string
+ allout-bullets-string
"]\\)\\|\\"
- outline-primary-bullet
+ allout-primary-bullet
"+\\|\^l"))
- (setq outline-line-boundary-regexp
- (concat "\\([\n\r]\\)\\(" outline-regexp "\\)"))
- (setq outline-bob-regexp
- (concat "\\(\\`\\)\\(" outline-regexp "\\)"))
+ (setq allout-line-boundary-regexp
+ (concat "\\([\n\r]\\)\\(" allout-regexp "\\)"))
+ (setq allout-bob-regexp
+ (concat "\\(\\`\\)\\(" allout-regexp "\\)"))
)
-;;;_ - Key bindings
-;;;_ = outline-prior-bindings
-(defvar outline-prior-bindings nil
- "Variable for use in V18, with outline-added-bindings, for
-resurrecting, on mode deactivation, bindings that existed before
-activation.")
-;;;_ = outline-added-bindings
-(defvar outline-added-bindings nil
- "Variable for use in V18, with outline-prior-bindings, for
-resurrecting, on mode deactivation, bindings that existed before
-activation.")
-;;;_ - Mode-Specific Variable Maintenance Utilities
-;;;_ = outline-mode-prior-settings
-(defvar outline-mode-prior-settings nil
- "For internal use by outline mode, registers settings to be resumed
-on mode deactivation.")
-(make-variable-buffer-local 'outline-mode-prior-settings)
-;;;_ > outline-resumptions (name &optional value)
-(defun outline-resumptions (name &optional value)
-
- "Registers information for later reference, or performs resumption of
-outline-mode specific values. First arg is NAME of variable affected.
-optional second arg is list containing outline-mode-specific VALUE to
-be imposed on named variable, and to be registered. (It's a list so you
-can specify registrations of null values.) If no value is specified,
-the registered value is returned (encapsulated in the list, so the
-caller can distinguish nil vs no value), and the registration is popped
+;;;_ : Key bindings
+;;;_ = allout-mode-map
+(defvar allout-mode-map nil "Keybindings for (allout) outline minor mode.")
+;;;_ > produce-allout-mode-map (keymap-alist &optional base-map)
+(defun produce-allout-mode-map (keymap-list &optional base-map)
+ "Produce keymap for use as allout-mode-map, from keymap-list.
+
+Built on top of optional BASE-MAP, or empty sparse map if none specified.
+See doc string for allout-keybindings-list for format of binding list."
+ (let ((map (or base-map (make-sparse-keymap)))
+ (pref (list allout-command-prefix)))
+ (mapcar (function
+ (lambda (cell)
+ (let ((add-pref (null (cdr (cdr cell))))
+ (key-suff (list (car cell))))
+ (apply 'define-key
+ (list map
+ (apply 'concat (if add-pref
+ (append pref key-suff)
+ key-suff))
+ (car (cdr cell)))))))
+ keymap-list)
+ map))
+
+;;;_ : Menu bar
+(defvar allout-mode-exposure-menu)
+(defvar allout-mode-editing-menu)
+(defvar allout-mode-navigation-menu)
+(defvar allout-mode-misc-menu)
+(defun produce-allout-mode-menubar-entries ()
+ (require 'easymenu)
+ (easy-menu-define allout-mode-exposure-menu
+ allout-mode-map
+ "Allout outline exposure menu."
+ '("Exposure"
+ ["Show Entry" allout-show-current-entry t]
+ ["Show Children" allout-show-children t]
+ ["Show Subtree" allout-show-current-subtree t]
+ ["Hide Subtree" allout-hide-current-subtree t]
+ ["Hide Leaves" allout-hide-current-leaves t]
+ "----"
+ ["Show All" allout-show-all t]))
+ (easy-menu-define allout-mode-editing-menu
+ allout-mode-map
+ "Allout outline editing menu."
+ '("Headings"
+ ["Open Sibling" allout-open-sibtopic t]
+ ["Open Subtopic" allout-open-subtopic t]
+ ["Open Supertopic" allout-open-supertopic t]
+ "----"
+ ["Shift Topic In" allout-shift-in t]
+ ["Shift Topic Out" allout-shift-out t]
+ ["Rebullet Topic" allout-rebullet-topic t]
+ ["Rebullet Heading" allout-rebullet-current-heading t]
+ ["Number Siblings" allout-number-siblings t]))
+ (easy-menu-define allout-mode-navigation-menu
+ allout-mode-map
+ "Allout outline navigation menu."
+ '("Navigation"
+ ["Next Visible Heading" allout-next-visible-heading t]
+ ["Previous Visible Heading"
+ allout-previous-visible-heading t]
+ "----"
+ ["Up Level" allout-up-current-level t]
+ ["Forward Current Level" allout-forward-current-level t]
+ ["Backward Current Level"
+ allout-backward-current-level t]
+ "----"
+ ["Beginning of Entry"
+ allout-beginning-of-current-entry t]
+ ["End of Entry" allout-end-of-current-entry t]
+ ["End of Subtree" allout-end-of-current-subtree t]))
+ (easy-menu-define allout-mode-misc-menu
+ allout-mode-map
+ "Allout outlines miscellaneous bindings."
+ '("Misc"
+ ["Version" allout-version t]
+ "----"
+ ["Duplicate Exposed" allout-copy-exposed-to-buffer t]
+ ["Duplicate Exposed, numbered"
+ allout-flatten-exposed-to-buffer t]
+ ["Duplicate Exposed, indented"
+ allout-indented-exposed-to-buffer t]
+ "----"
+ ["Set Header Lead" allout-reset-header-lead t]
+ ["Set New Exposure" allout-expose-topic t])))
+;;;_ : Mode-Specific Variable Maintenance Utilities
+;;;_ = allout-mode-prior-settings
+(defvar allout-mode-prior-settings nil
+ "Internal `allout-mode' use; settings to be resumed on mode deactivation.")
+(make-variable-buffer-local 'allout-mode-prior-settings)
+;;;_ > allout-resumptions (name &optional value)
+(defun allout-resumptions (name &optional value)
+
+ "Registers or resumes settings over `allout-mode' activation/deactivation.
+
+First arg is NAME of variable affected. Optional second arg is list
+containing allout-mode-specific VALUE to be imposed on named
+variable, and to be registered. (It's a list so you can specify
+registrations of null values.) If no value is specified, the
+registered value is returned (encapsulated in the list, so the caller
+can distinguish nil vs no value), and the registration is popped
from the list."
- (let ((on-list (assq name outline-mode-prior-settings))
- prior-capsule ; By 'capsule' i mean a list
+ (let ((on-list (assq name allout-mode-prior-settings))
+ prior-capsule ; By `capsule' i mean a list
; containing a value, so we can
; distinguish nil from no value.
)
(if on-list
nil ; Already preserved prior value - don't mess with it.
;; Register the old value, or nil if previously unbound:
- (setq outline-mode-prior-settings
+ (setq allout-mode-prior-settings
(cons (list name
(if (boundp name) (list (symbol-value name))))
- outline-mode-prior-settings)))
+ allout-mode-prior-settings)))
; And impose the new value, locally:
(progn (make-local-variable name)
(set name (car value))))
(makunbound name)) ; Previously unbound - demolish var.
; Remove registration:
(let (rebuild)
- (while outline-mode-prior-settings
- (if (not (eq (car outline-mode-prior-settings)
+ (while allout-mode-prior-settings
+ (if (not (eq (car allout-mode-prior-settings)
on-list))
(setq rebuild
- (cons (car outline-mode-prior-settings)
+ (cons (car allout-mode-prior-settings)
rebuild)))
- (setq outline-mode-prior-settings
- (cdr outline-mode-prior-settings)))
- (setq outline-mode-prior-settings rebuild)))))
+ (setq allout-mode-prior-settings
+ (cdr allout-mode-prior-settings)))
+ (setq allout-mode-prior-settings rebuild)))))
)
-;;;_ - Version
-;;;_ = outline-version
-(defvar outline-version
- (let ((rcs-rev "$Revision: 3.39 $"))
- (condition-case err
- (save-match-data
- (string-match "\\$Revision: \\([0-9]+\\.[0-9]+\\)" rcs-rev)
- (substring rcs-rev (match-beginning 1) (match-end 1)))
- (error rcs-rev)))
- "Revision number of currently loaded outline package. (Currently
-specific to allout.el.)")
-;;;_ > outline-version
-(defun outline-version (&optional here)
- "Return string describing the loaded outline version."
- (interactive "P")
- (let ((msg (concat "Allout Outline Mode v " outline-version)))
- (if here (insert-string msg))
- (message "%s" msg)
- msg))
-
-;;;_ - Mode activation
-;;;_ = outline-mode
-(defvar outline-mode () "Allout outline mode minor-mode flag.")
-(make-variable-buffer-local 'outline-mode)
-;;;_ = outline-mode-map
-(defvar outline-mode-map nil "Keybindings for (allout) outline minor mode.")
-;;;_ > outline-mode-p ()
-(defmacro outline-mode-p ()
- '(and (boundp 'outline-mode) outline-mode))
-
-;;;_ = outline-during-write-cue nil
-(defvar outline-during-write-cue nil
- "Indication, for outline-post-command-business, that we are in the
-process of writing a file, and need to inhibit change protection. See
-also, outline-write-file-hook, outline-before-change-protect,
-outline-post-command-business functions.")
-
-;;;_ > outline-write-file-hook ()
-(defun outline-write-file-hook ()
- "In outline mode, run as a local-write-file-hooks activity.
-Currently just sets 'outline-during-write-cue', so outline-change-
-protection knows to keep inactive during file write."
- (setq outline-during-write-cue t)
- nil)
-
-;;;_ = outline-override-protect nil
-(defvar outline-override-protect nil
- "In emacs v19 &c, outline-allout mode regulates alteration of concealed text
-so it's affected as a unit, or not at all. This is for use by competant
-(eg, native outline) functions to temporarily override that protection. It's
-automatically reset to nil after every buffer modification.")
-(make-variable-buffer-local 'outline-override-protect)
-;;;_ > outline-unprotected (expr)
-(defmacro outline-unprotected (expr)
- "Evaluate EXPRESSION with outline-override-protect
-let-bound 't'."
- (` (let ((outline-override-protect t))
- (, expr))))
-;;;_ = outline-undo-aggregation
-(defvar outline-undo-aggregation 30
+;;;_ : Mode-specific incidentals
+;;;_ = allout-during-write-cue nil
+(defvar allout-during-write-cue nil
+ "Used to inhibit outline change-protection during file write.
+
+See also `allout-post-command-business', `allout-write-file-hook',
+`allout-before-change-protect', and `allout-post-command-business'
+functions.")
+;;;_ = allout-pre-was-isearching nil
+(defvar allout-pre-was-isearching nil
+ "Cue for isearch-dynamic-exposure mechanism, implemented in
+allout-pre- and -post-command-hooks.")
+(make-variable-buffer-local 'allout-pre-was-isearching)
+;;;_ = allout-isearch-prior-pos nil
+(defvar allout-isearch-prior-pos nil
+ "Cue for isearch-dynamic-exposure tracking, used by allout-isearch-expose.")
+(make-variable-buffer-local 'allout-isearch-prior-pos)
+;;;_ = allout-isearch-did-quit
+(defvar allout-isearch-did-quit nil
+ "Distinguishes isearch conclusion and cancellation.
+
+Maintained by `allout-isearch-abort' \(which is wrapped around the real
+isearch-abort), and monitored by `allout-isearch-expose' for action.")
+(make-variable-buffer-local 'allout-isearch-did-quit)
+;;;_ = allout-override-protect nil
+(defvar allout-override-protect nil
+ "Used in `allout-mode' for regulate of concealed-text protection mechanism.
+
+Allout outline mode regulates alteration of concealed text to protect
+against inadvertent, unnoticed changes. This is for use by specific,
+native outline functions to temporarily override that protection.
+It's automatically reset to nil after every buffer modification.")
+(make-variable-buffer-local 'allout-override-protect)
+;;;_ > allout-unprotected (expr)
+(defmacro allout-unprotected (expr)
+ "Evaluate EXPRESSION with `allout-override-protect' let-bound t."
+ `(let ((allout-override-protect t))
+ ,expr))
+;;;_ = allout-undo-aggregation
+(defvar allout-undo-aggregation 30
"Amount of successive self-insert actions to bunch together per undo.
-This is purely a kludge variable, regulating the compensation for a bug in
-the way that before-change-function and undo interact.")
-(make-variable-buffer-local 'outline-undo-aggregation)
-;;;_ > produce-outline-mode-map (keymap-alist &optional base-map)
-(defun produce-outline-mode-map (keymap-list &optional base-map)
- "Produce keymap for use as outline-mode-map, from keymap-list.
-Built on top of optional BASE-MAP, or empty sparse map if none specified.
-See doc string for outline-keybindings-list for format of binding list."
- (let ((map (or base-map (make-sparse-keymap))))
- (mapcar (lambda (cell)
- (apply 'define-key map (if (null (cdr (cdr cell)))
- (cons (concat outline-command-prefix
- (car cell))
- (cdr cell))
- (list (car cell) (car (cdr cell))))))
- keymap-list)
- map))
-;;;_ > outline-mode (&optional toggle)
-;;;_ . Defun:
-(defvar outline-v18/9-file-var-hack nil
+This is purely a kludge variable, regulating the compensation for a bug in
+the way that before-change-functions and undo interact.")
+(make-variable-buffer-local 'allout-undo-aggregation)
+;;;_ = file-var-bug hack
+(defvar allout-v18/19-file-var-hack nil
"Horrible hack used to prevent invalid multiple triggering of outline
-mode from prop-line file-var activation. Used by outline-mode function
+mode from prop-line file-var activation. Used by `allout-mode' function
to track repeats.")
-(defun outline-mode (&optional toggle)
+;;;_ > allout-write-file-hook ()
+(defun allout-write-file-hook ()
+ "In `allout-mode', run as a `write-contents-functions' activity.
+
+Currently just sets `allout-during-write-cue', so outline change-protection
+knows to keep inactive during file write."
+ (setq allout-during-write-cue t)
+ nil)
+
+;;;_ #2 Mode activation
+;;;_ = allout-mode
+(defvar allout-mode () "Allout outline mode minor-mode flag.")
+(make-variable-buffer-local 'allout-mode)
+;;;_ > allout-mode-p ()
+(defmacro allout-mode-p ()
+ "Return t if `allout-mode' is active in current buffer."
+ 'allout-mode)
+;;;_ = allout-explicitly-deactivated
+(defvar allout-explicitly-deactivated nil
+ "Non-nil if `allout-mode' was last deliberately deactivated.
+So `allout-post-command-business' should not reactivate it...")
+(make-variable-buffer-local 'allout-explicitly-deactivated)
+;;;_ > allout-init (&optional mode)
+;;;###autoload
+(defun allout-init (&optional mode)
+ "Prime `allout-mode' to enable/disable auto-activation, wrt `allout-layout'.
+
+MODE is one of the following symbols:
+
+ - nil \(or no argument) deactivate auto-activation/layout;
+ - `activate', enable auto-activation only;
+ - `ask', enable auto-activation, and enable auto-layout but with
+ confirmation for layout operation solicited from user each time;
+ - `report', just report and return the current auto-activation state;
+ - anything else \(eg, t) for auto-activation and auto-layout, without
+ any confirmation check.
+
+Use this function to setup your emacs session for automatic activation
+of allout outline mode, contingent to the buffer-specific setting of
+the `allout-layout' variable. (See `allout-layout' and
+`allout-expose-topic' docstrings for more details on auto layout).
+
+`allout-init' works by setting up (or removing)
+`allout-find-file-hook' in `find-file-hook', and giving
+`allout-auto-activation' a suitable setting.
+
+To prime your emacs session for full auto-outline operation, include
+the following two lines in your emacs init file:
+
+\(require 'allout)
+\(allout-init t)"
+
+ (interactive)
+ (if (interactive-p)
+ (progn
+ (setq mode
+ (completing-read
+ (concat "Select outline auto setup mode "
+ "(empty for report, ? for options) ")
+ '(("nil")("full")("activate")("deactivate")
+ ("ask") ("report") (""))
+ nil
+ t))
+ (if (string= mode "")
+ (setq mode 'report)
+ (setq mode (intern-soft mode)))))
+ (let
+ ;; convenience aliases, for consistent ref to respective vars:
+ ((hook 'allout-find-file-hook)
+ (curr-mode 'allout-auto-activation))
+
+ (cond ((not mode)
+ (setq find-file-hook (delq hook find-file-hook))
+ (if (interactive-p)
+ (message "Allout outline mode auto-activation inhibited.")))
+ ((eq mode 'report)
+ (if (memq hook find-file-hook)
+ ;; Just punt and use the reports from each of the modes:
+ (allout-init (symbol-value curr-mode))
+ (allout-init nil)
+ (message "Allout outline mode auto-activation inhibited.")))
+ (t (add-hook 'find-file-hook hook)
+ (set curr-mode ; `set', not `setq'!
+ (cond ((eq mode 'activate)
+ (message
+ "Outline mode auto-activation enabled.")
+ 'activate)
+ ((eq mode 'report)
+ ;; Return the current mode setting:
+ (allout-init mode))
+ ((eq mode 'ask)
+ (message
+ (concat "Outline mode auto-activation and "
+ "-layout \(upon confirmation) enabled."))
+ 'ask)
+ ((message
+ "Outline mode auto-activation and -layout enabled.")
+ 'full)))))))
+
+;;;_ > allout-setup-menubar ()
+(defun allout-setup-menubar ()
+ "Populate the current buffer's menubar with `allout-mode' stuff."
+ (let ((menus (list allout-mode-exposure-menu
+ allout-mode-editing-menu
+ allout-mode-navigation-menu
+ allout-mode-misc-menu))
+ cur)
+ (while menus
+ (setq cur (car menus)
+ menus (cdr menus))
+ (easy-menu-add cur))))
+;;;_ > allout-mode (&optional toggle)
+;;;_ : Defun:
+(defun allout-mode (&optional toggle)
;;;_ . Doc string:
- "Toggle minor mode for controlling exposure of and editing text
-outlines. Optional arg forces mode activation iff arg is positive.
-
-Look below the description of the bindings for explanation of the
-terminology use in outline-mode commands.
-
-Exposure Commands Movement Commands
-C-c C-h outline-hide-current-subtree C-c C-n outline-next-visible-heading
-C-c C-i outline-show-children C-c C-p outline-previous-visible-heading
-C-c C-s outline-show-current-subtree C-c C-u outline-up-current-level
-C-c C-o outline-show-current-entry C-c C-f outline-forward-current-level
-C-c ! outline-show-all C-c C-b outline-backward-current-level
- outline-hide-current-leaves C-c C-e outline-end-of-current-entry
- C-c C-a outline-beginning-of-current-entry
-
-
-Topic Header Generation Commands
-C-c<SP> outline-open-sibtopic Create a new sibling after current topic
-C-c . outline-open-subtopic ... an offspring of current topic
-C-c , outline-open-supertopic ... a sibling of the current topics' parent
-
-Level and Prefix Adjustment Commands
-C-c > outline-shift-in Shift current topic and all offspring deeper
-C-c < outline-shift-out ... less deep
-C-c<CR> outline-rebullet-topic Reconcile bullets of topic and its offspring
- - distinctive bullets are not changed, all
- others set suitable according to depth
-C-c b outline-rebullet-current-heading Prompt for alternate bullet for
- current topic
-C-c # outline-number-siblings Number bullets of topic and siblings - the
+ "Toggle minor mode for controlling exposure and editing of text outlines.
+
+Optional arg forces mode to re-initialize iff arg is positive num or
+symbol. Allout outline mode always runs as a minor mode.
+
+Allout outline mode provides extensive outline oriented formatting and
+manipulation. It enables structural editing of outlines, as well as
+navigation and exposure. It also is specifically aimed at
+accommodating syntax-sensitive text like programming languages. \(For
+an example, see the allout code itself, which is organized as an allout
+outline.)
+
+In addition to outline navigation and exposure, allout includes:
+
+ - topic-oriented repositioning, cut, and paste
+ - integral outline exposure-layout
+ - incremental search with dynamic exposure and reconcealment of hidden text
+ - automatic topic-number maintenance
+ - \"Hot-spot\" operation, for single-keystroke maneuvering and
+ exposure control. \(See the allout-mode docstring.)
+
+and many other features.
+
+Below is a description of the bindings, and then explanation of
+special `allout-mode' features and terminology. See also the outline
+menubar additions for quick reference to many of the features, and see
+the docstring of the function `allout-init' for instructions on
+priming your emacs session for automatic activation of `allout-mode'.
+
+
+The bindings are dictated by the `allout-keybindings-list' and
+`allout-command-prefix' variables.
+
+ Navigation: Exposure Control:
+ ---------- ----------------
+C-c C-n allout-next-visible-heading | C-c C-h allout-hide-current-subtree
+C-c C-p allout-previous-visible-heading | C-c C-i allout-show-children
+C-c C-u allout-up-current-level | C-c C-s allout-show-current-subtree
+C-c C-f allout-forward-current-level | C-c C-o allout-show-current-entry
+C-c C-b allout-backward-current-level | ^U C-c C-s allout-show-all
+C-c C-e allout-end-of-current-entry | allout-hide-current-leaves
+C-c C-a allout-beginning-of-current-entry, alternately, goes to hot-spot
+
+ Topic Header Production:
+ -----------------------
+C-c<SP> allout-open-sibtopic Create a new sibling after current topic.
+C-c . allout-open-subtopic ... an offspring of current topic.
+C-c , allout-open-supertopic ... a sibling of the current topic's parent.
+
+ Topic Level and Prefix Adjustment:
+ ---------------------------------
+C-c > allout-shift-in Shift current topic and all offspring deeper.
+C-c < allout-shift-out ... less deep.
+C-c<CR> allout-rebullet-topic Reconcile bullets of topic and its offspring
+ - distinctive bullets are not changed, others
+ alternated according to nesting depth.
+C-c * allout-rebullet-current-heading Prompt for alternate bullet for
+ current topic.
+C-c # allout-number-siblings Number bullets of topic and siblings - the
offspring are not affected. With repeat
count, revoke numbering.
-Killing and Yanking - all keep siblings numbering reconciled as appropriate
-C-k outline-kill-line Regular kill line, but respects numbering ,etc
-C-c C-k outline-kill-topic Kill current topic, including offspring
-C-y outline-yank Yank, adjusting depth of yanked topic to
+ Topic-oriented Killing and Yanking:
+ ----------------------------------
+C-c C-k allout-kill-topic Kill current topic, including offspring.
+C-k allout-kill-line Like kill-line, but reconciles numbering, etc.
+C-y allout-yank Yank, adjusting depth of yanked topic to
depth of heading if yanking into bare topic
- heading (ie, prefix sans text)
-M-y outline-yank-pop Is to outline-yank as yank-pop is to yank
-
-Misc commands
-C-c @ outline-resolve-xref pop-to-buffer named by xref (cf
- outline-file-xref-bullet)
-C-c c outline-copy-exposed Copy outline sans all hidden stuff to
- another buffer whose name is derived
- from the current one - \"XXX exposed\"
-M-x outlineify-sticky Activate outline mode for current buffer
- and establish -*- outline -*- mode specifier
- as well as file local vars to automatically
- set exposure. Try it.
-
-\\<outline-mode-map>
- HOT-SPOT Operation (Not available in Emacs v18.)
-
-Hot-spot operation enables succinct outline operation. When the
-cursor is located on the bullet character of a topic, literal
-characters invoke the commands of the corresponding control chars in
-the outline-mode keymap. Thus, 'f' would invoke the command bound to
-<outline-command-prefix>-\C-f \(typically 'outline-forward-current-
-level').
-
-Thus, by positioning the cursor on a topic bullet, you can do each of
+ heading (ie, prefix sans text).
+M-y allout-yank-pop Is to allout-yank as yank-pop is to yank
+
+ Misc commands:
+ -------------
+M-x outlineify-sticky Activate outline mode for current buffer,
+ and establish a default file-var setting
+ for `allout-layout'.
+C-c C-SPC allout-mark-topic
+C-c = c allout-copy-exposed-to-buffer
+ Duplicate outline, sans concealed text, to
+ buffer with name derived from derived from
+ that of current buffer - \"*XXX exposed*\".
+C-c = p allout-flatten-exposed-to-buffer
+ Like above 'copy-exposed', but convert topic
+ prefixes to section.subsection... numeric
+ format.
+ESC ESC (allout-init t) Setup emacs session for outline mode
+ auto-activation.
+
+ HOT-SPOT Operation
+
+Hot-spot operation provides a means for easy, single-keystroke outline
+navigation and exposure control.
+
+\\<allout-mode-map>
+When the text cursor is positioned directly on the bullet character of
+a topic, regular characters (a to z) invoke the commands of the
+corresponding allout-mode keymap control chars. For example, \"f\"
+would invoke the command typically bound to \"C-c C-f\"
+\(\\[allout-forward-current-level] `allout-forward-current-level').
+
+Thus, by positioning the cursor on a topic bullet, you can execute
the outline navigation and manipulation commands with a single
-keystroke. Non-literal char do not get this special interpretation,
-even on the hot-spot, so you can use them to get off of it, and back
-to normal operation.
+keystroke. Non-literal chars never get this special translation, so
+you can use them to get away from the hot-spot, and back to normal
+operation.
-Note that the command outline-beginning-of-current-entry \(\\[outline-beginning-of-current-entry]\)
+Note that the command `allout-beginning-of-current-entry' \(\\[allout-beginning-of-current-entry]\)
will move to the hot-spot when the cursor is already located at the
-beginning of the current entry, so you can simply hit \\[outline-beginning-of-current-entry]
+beginning of the current entry, so you can simply hit \\[allout-beginning-of-current-entry]
twice in a row to get to the hot-spot.
- Terminology
+ Terminology
Topic hierarchy constituents - TOPICS and SUBTOPICS:
contain other topics, and it can be subsumed by other topics,
CURRENT topic:
The visible topic most immediately containing the cursor.
-DEPTH: The degree of nesting of a topic, it increases with
- containment. Also called the
+DEPTH: The degree of nesting of a topic; it increases with
+ containment. Also called the:
LEVEL: The same as DEPTH.
ANCESTORS:
PARENT: A topic's immediate ancestor. It has a depth one less than
the topic.
OFFSPRING:
- The topics contained by a topic,
+ The topics contained by a topic;
+SUBTOPIC:
+ An immediate offspring of a topic;
CHILDREN:
The immediate offspring of a topic.
SIBLINGS:
- Topics having the same parent.
-
+ Topics having the same parent and depth.
+
Topic text constituents:
HEADER: The first line of a topic, include the topic PREFIX and header
- text.
+ text.
PREFIX: The leading text of a topic which which distinguishes it from
normal text. It has a strict form, which consists of a
prefix-lead string, padding, and a bullet. The bullet may be
The relative length of the PREFIX determines the nesting depth
of the topic.
PREFIX-LEAD:
- The string at the beginning of a topic prefix, normally a '.'.
+ The string at the beginning of a topic prefix, normally a `.'.
It can be customized by changing the setting of
- 'outline-header-prefix' and then reinitializing outline-mode.
+ `allout-header-prefix' and then reinitializing `allout-mode'.
By setting the prefix-lead to the comment-string of a
- programming language, you can embed outline-structuring in
+ programming language, you can embed outline structuring in
program code without interfering with the language processing
- of that code.
+ of that code. See `allout-use-mode-specific-leader'
+ docstring for more detail.
PREFIX-PADDING:
Spaces or asterisks which separate the prefix-lead and the
bullet, according to the depth of the topic.
BULLET: A character at the end of the topic prefix, it must be one of
- the characters listed on 'outline-plain-bullets-string' or
- 'outline-distinctive-bullets-string'. (See the documentation
+ the characters listed on `allout-plain-bullets-string' or
+ `allout-distinctive-bullets-string'. (See the documentation
for these variables for more details.) The default choice of
bullet when generating varies in a cycle with the depth of the
topic.
EXPOSURE:
The state of a topic which determines the on-screen visibility
- of its' offspring and contained text.
+ of its offspring and contained text.
CONCEALED:
Topics and entry text whose display is inhibited. Contiguous
- units of concealed text is represented by '...' ellipses.
- (Ref the 'selective-display' var.)
+ units of concealed text is represented by `...' ellipses.
+ (Ref the `selective-display' var.)
Concealed topics are effectively collapsed within an ancestor.
CLOSED: A topic whose immediate offspring and body-text is concealed.
-OPEN: A topic that is not closed."
-
+OPEN: A topic that is not closed, though its offspring or body may be."
;;;_ . Code
(interactive "P")
(let* ((active (and (not (equal major-mode 'outline))
- (outline-mode-p)))
- ; Massage universal-arg 'toggle' val:
+ (allout-mode-p)))
+ ; Massage universal-arg `toggle' val:
(toggle (and toggle
- (or (and (listp toggle)(car toggle))
- toggle)))
- ; Activation specficially demanded?
+ (or (and (listp toggle)(car toggle))
+ toggle)))
+ ; Activation specifically demanded?
(explicit-activation (or
- ;;
- (and toggle
- (or (symbolp toggle)
- (and (natnump toggle)
- (not (zerop toggle)))))))
- ;; outline-mode already called once during this complex command?
- (same-complex-command (eq outline-v18/9-file-var-hack
- (car command-history))))
-
- ; See comments below re v19.18,.19 bug.
- (setq outline-v18/9-file-var-hack (car command-history))
+ ;;
+ (and toggle
+ (or (symbolp toggle)
+ (and (natnump toggle)
+ (not (zerop toggle)))))))
+ ;; allout-mode already called once during this complex command?
+ (same-complex-command (eq allout-v18/19-file-var-hack
+ (car command-history)))
+ do-layout
+ )
+
+ ; See comments below re v19.18,.19 bug.
+ (setq allout-v18/19-file-var-hack (car command-history))
(cond
- ;; Hitting v19.18, 19.19 bug?
+ ;; Provision for v19.18, 19.19 bug -
;; Emacs v 19.18, 19.19 file-var code invokes prop-line-designated
;; modes twice when file is visited. We have to avoid toggling mode
;; off on second invocation, so we detect it as best we can, and
;; skip everything.
((and same-complex-command ; Still in same complex command
- ; as last time outline-mode invoked.
- active ; Already activated.
- (not explicit-activation) ; Prop-line file-vars don't have args.
- (string-match "^19.1[89]" ; Bug only known to be in v19.18 and
- emacs-version)); 19.19.
+ ; as last time `allout-mode' invoked.
+ active ; Already activated.
+ (not explicit-activation) ; Prop-line file-vars don't have args.
+ (string-match "^19.1[89]" ; Bug only known to be in v19.18 and
+ emacs-version)); 19.19.
t)
-
- ;; Deactivate?
+
+ ;; Deactivation:
((and (not explicit-activation)
- (or active toggle))
- ; Activation not explicitly
- ; requested, and either in
- ; active state or *de*activation
- ; specifically requested:
- (if (string-match "^18\." emacs-version)
- ; Revoke those keys that remain
- ; as we set them:
- (let ((curr-loc (current-local-map)))
- (mapcar '(lambda (cell)
- (if (eq (lookup-key curr-loc (car cell))
- (car (cdr cell)))
- (define-key curr-loc (car cell)
- (assq (car cell) outline-prior-bindings))))
- outline-added-bindings)
- (outline-resumptions 'outline-added-bindings)
- (outline-resumptions 'outline-prior-bindings)))
-
- (if outline-old-style-prefixes
+ (or active toggle))
+ ; Activation not explicitly
+ ; requested, and either in
+ ; active state or *de*activation
+ ; specifically requested:
+ (setq allout-explicitly-deactivated t)
+
+ (if allout-old-style-prefixes
(progn
- (outline-resumptions 'outline-primary-bullet)
- (outline-resumptions 'outline-old-style-prefixes)))
- (outline-resumptions 'selective-display)
- (if (and (boundp 'before-change-function) before-change-function)
- (outline-resumptions 'before-change-function))
- (setq pre-command-hook (delq 'outline-pre-command-business
- pre-command-hook))
- (setq post-command-hook (delq 'outline-post-command-business
- post-command-hook))
- (setq local-write-file-hooks
- (delq 'outline-write-file-hook
- local-write-file-hooks))
- (outline-resumptions 'paragraph-start)
- (outline-resumptions 'paragraph-separate)
- (outline-resumptions (if (string-match "^18" emacs-version)
- 'auto-fill-hook
- 'auto-fill-function))
- (outline-resumptions 'outline-former-auto-filler)
- (setq outline-mode nil))
-
- ;; Activate?
+ (allout-resumptions 'allout-primary-bullet)
+ (allout-resumptions 'allout-old-style-prefixes)))
+ (allout-resumptions 'selective-display)
+ (if (and (boundp 'before-change-functions) before-change-functions)
+ (allout-resumptions 'before-change-functions))
+ (setq write-contents-functions
+ (delq 'allout-write-file-hook
+ write-contents-functions))
+ (allout-resumptions 'paragraph-start)
+ (allout-resumptions 'paragraph-separate)
+ (allout-resumptions (if (string-match "^18" emacs-version)
+ 'auto-fill-hook
+ 'auto-fill-function))
+ (allout-resumptions 'allout-former-auto-filler)
+ (setq allout-mode nil))
+
+ ;; Activation:
((not active)
- (if outline-old-style-prefixes
+ (setq allout-explicitly-deactivated nil)
+ (if allout-old-style-prefixes
(progn ; Inhibit all the fancy formatting:
- (outline-resumptions 'outline-primary-bullet '("*"))
- (outline-resumptions 'outline-old-style-prefixes '(()))))
- (set-outline-regexp)
- ; Produce map from current version
- ; of outline-keybindings-list:
+ (allout-resumptions 'allout-primary-bullet '("*"))
+ (allout-resumptions 'allout-old-style-prefixes '(()))))
+
+ (allout-infer-header-lead)
+ (allout-infer-body-reindent)
+
+ (set-allout-regexp)
+
+ ; Produce map from current version
+ ; of allout-keybindings-list:
(if (boundp 'minor-mode-map-alist)
(progn ; V19, and maybe lucid and
- ; epoch, minor-mode key bindings:
- (setq outline-mode-map
- (produce-outline-mode-map outline-keybindings-list))
- (fset 'outline-mode-map outline-mode-map)
- ; Include on minor-mode-map-alist,
- ; if not already there:
- (if (not (member '(outline-mode . outline-mode-map)
- minor-mode-map-alist))
- (setq minor-mode-map-alist
- (cons '(outline-mode . outline-mode-map)
- minor-mode-map-alist))))
-
- ; V18 minor-mode key bindings:
- ; Stash record of added bindings
- ; for later revocation:
- (outline-resumptions 'outline-added-bindings
- (list outline-keybindings-list))
- (outline-resumptions 'outline-prior-bindings
- (list (current-local-map)))
- ; and add them:
- (use-local-map (produce-outline-mode-map outline-keybindings-list
- (current-local-map)))
+ ; epoch, minor-mode key bindings:
+ (setq allout-mode-map
+ (produce-allout-mode-map allout-keybindings-list))
+ (produce-allout-mode-menubar-entries)
+ (fset 'allout-mode-map allout-mode-map)
+ ; Include on minor-mode-map-alist,
+ ; if not already there:
+ (if (not (member '(allout-mode . allout-mode-map)
+ minor-mode-map-alist))
+ (setq minor-mode-map-alist
+ (cons '(allout-mode . allout-mode-map)
+ minor-mode-map-alist))))
+
+ ; and add them:
+ (use-local-map (produce-allout-mode-map allout-keybindings-list
+ (current-local-map)))
)
-
- ; selective-display is the
- ; emacs conditional exposure
- ; mechanism:
- (outline-resumptions 'selective-display '(t))
- (if outline-inhibit-protection
+
+ ; selective-display is the
+ ; emacs conditional exposure
+ ; mechanism:
+ (allout-resumptions 'selective-display '(t))
+ (if allout-inhibit-protection
t
- (outline-resumptions 'before-change-function
- '(outline-before-change-protect)))
- (add-hook 'post-command-hook 'outline-post-command-business)
- (add-hook 'pre-command-hook 'outline-pre-command-business)
- ; Temporarily set by any outline
- ; functions that can be trusted to
- ; deal properly with concealed text.
- (add-hook 'local-write-file-hooks 'outline-write-file-hook)
- ; Custom auto-fill func, to support
- ; respect for topic headline,
- ; hanging-indents, etc:
+ (allout-resumptions 'before-change-functions
+ '(allout-before-change-protect)))
+ (add-hook 'pre-command-hook 'allout-pre-command-business)
+ (add-hook 'post-command-hook 'allout-post-command-business)
+ ; Temporarily set by any outline
+ ; functions that can be trusted to
+ ; deal properly with concealed text.
+ (add-hook 'write-contents-functions 'allout-write-file-hook)
+ ; Custom auto-fill func, to support
+ ; respect for topic headline,
+ ; hanging-indents, etc:
(let* ((fill-func-var (if (string-match "^18" emacs-version)
- 'auto-fill-hook
- 'auto-fill-function))
- (fill-func (symbol-value fill-func-var)))
- ;; Register prevailing fill func for use by outline-auto-fill:
- (outline-resumptions 'outline-former-auto-filler (list fill-func))
- ;; Register outline-auto-fill to be used if filling is active:
- (outline-resumptions fill-func-var '(outline-auto-fill)))
+ 'auto-fill-hook
+ 'auto-fill-function))
+ (fill-func (symbol-value fill-func-var)))
+ ;; Register prevailing fill func for use by allout-auto-fill:
+ (allout-resumptions 'allout-former-auto-filler (list fill-func))
+ ;; Register allout-auto-fill to be used if filling is active:
+ (allout-resumptions fill-func-var '(allout-auto-fill)))
;; Paragraphs are broken by topic headlines.
(make-local-variable 'paragraph-start)
- (outline-resumptions 'paragraph-start
- (list (concat paragraph-start "\\|^\\("
- outline-regexp "\\)")))
+ (allout-resumptions 'paragraph-start
+ (list (concat paragraph-start "\\|^\\("
+ allout-regexp "\\)")))
(make-local-variable 'paragraph-separate)
- (outline-resumptions 'paragraph-separate
- (list (concat paragraph-separate "\\|^\\("
- outline-regexp "\\)")))
+ (allout-resumptions 'paragraph-separate
+ (list (concat paragraph-separate "\\|^\\("
+ allout-regexp "\\)")))
- (or (assq 'outline-mode minor-mode-alist)
+ (or (assq 'allout-mode minor-mode-alist)
(setq minor-mode-alist
- (cons '(outline-mode " Outl") minor-mode-alist)))
+ (cons '(allout-mode " Allout") minor-mode-alist)))
- (if outline-enwrap-isearch-mode
- (outline-enwrap-isearch))
- (run-hooks 'outline-mode-hook)
- (setq outline-mode t))
+ (allout-setup-menubar)
+
+ (if allout-layout
+ (setq do-layout t))
+
+ (if (and allout-isearch-dynamic-expose
+ (not (fboundp 'allout-real-isearch-abort)))
+ (allout-enwrap-isearch))
+
+ (run-hooks 'allout-mode-hook)
+ (setq allout-mode t))
+
+ ;; Reactivation:
+ ((setq do-layout t)
+ (allout-infer-body-reindent))
) ; cond
- outline-mode
+
+ (if (and do-layout
+ allout-auto-activation
+ (listp allout-layout)
+ (and (not (eq allout-auto-activation 'activate))
+ (if (eq allout-auto-activation 'ask)
+ (if (y-or-n-p (format "Expose %s with layout '%s'? "
+ (buffer-name)
+ allout-layout))
+ t
+ (message "Skipped %s layout." (buffer-name))
+ nil)
+ t)))
+ (save-excursion
+ (message "Adjusting '%s' exposure..." (buffer-name))
+ (goto-char 0)
+ (allout-this-or-next-heading)
+ (condition-case err
+ (progn
+ (apply 'allout-expose-topic (list allout-layout))
+ (message "Adjusting '%s' exposure... done." (buffer-name)))
+ ;; Problem applying exposure - notify user, but don't
+ ;; interrupt, eg, file visit:
+ (error (message "%s" (car (cdr err)))
+ (sit-for 1)))))
+ allout-mode
) ; let*
- ) ; defun
-
+ ) ; defun
+;;;_ > allout-minor-mode
+;;; XXX released verion doesn't do this?
+(defalias 'allout-minor-mode 'allout-mode)
-;;;_ #2 Internal Position State-Tracking Variables
-;;; All basic outline functions which directly do string matches to
+;;;_ #3 Internal Position State-Tracking - "allout-recent-*" funcs
+;;; All the basic outline functions that directly do string matches to
;;; evaluate heading prefix location set the variables
-;;; outline-recent-prefix-beginning and outline-recent-prefix-end when
-;;; successful. Functions starting with 'outline-recent-' all use
-;;; this state, providing the means to avoid redundant searches for
-;;; just established data. This optimization can provide significant
-;;; speed improvement, but it must be employed carefully.
-;;;_ = outline-recent-prefix-beginning
-(defvar outline-recent-prefix-beginning 0
+;;; `allout-recent-prefix-beginning' and `allout-recent-prefix-end'
+;;; when successful. Functions starting with `allout-recent-' all
+;;; use this state, providing the means to avoid redundant searches
+;;; for just-established data. This optimization can provide
+;;; significant speed improvement, but it must be employed carefully.
+;;;_ = allout-recent-prefix-beginning
+(defvar allout-recent-prefix-beginning 0
"Buffer point of the start of the last topic prefix encountered.")
-(make-variable-buffer-local 'outline-recent-prefix-beginning)
-;;;_ = outline-recent-prefix-end
-(defvar outline-recent-prefix-end 0
+(make-variable-buffer-local 'allout-recent-prefix-beginning)
+;;;_ = allout-recent-prefix-end
+(defvar allout-recent-prefix-end 0
"Buffer point of the end of the last topic prefix encountered.")
-(make-variable-buffer-local 'outline-recent-prefix-end)
-;;;_ > outline-prefix-data (beg end)
-(defmacro outline-prefix-data (beg end)
- "Register outline-prefix state data - BEGINNING and END of prefix -
-for reference by 'outline-recent' funcs. Returns BEGINNING."
- (` (setq outline-recent-prefix-end (, end)
- outline-recent-prefix-beginning (, beg))))
-;;;_ > outline-recent-depth ()
-(defmacro outline-recent-depth ()
- "Return depth of last heading encountered by an outline maneuvering
-function.
+(make-variable-buffer-local 'allout-recent-prefix-end)
+;;;_ = allout-recent-end-of-subtree
+(defvar allout-recent-end-of-subtree 0
+ "Buffer point last returned by `allout-end-of-current-subtree'.")
+(make-variable-buffer-local 'allout-recent-end-of-subtree)
+;;;_ > allout-prefix-data (beg end)
+(defmacro allout-prefix-data (beg end)
+ "Register allout-prefix state data - BEGINNING and END of prefix.
+
+For reference by `allout-recent' funcs. Returns BEGINNING."
+ `(setq allout-recent-prefix-end ,end
+ allout-recent-prefix-beginning ,beg))
+;;;_ > allout-recent-depth ()
+(defmacro allout-recent-depth ()
+ "Return depth of last heading encountered by an outline maneuvering function.
All outline functions which directly do string matches to assess
-headings set the variables outline-recent-prefix-beginning and
-outline-recent-prefix-end if successful. This function uses those settings
+headings set the variables `allout-recent-prefix-beginning' and
+`allout-recent-prefix-end' if successful. This function uses those settings
to return the current depth."
- '(max 1 (- outline-recent-prefix-end
- outline-recent-prefix-beginning
- outline-header-subtraction)))
-;;;_ > outline-recent-prefix ()
-(defmacro outline-recent-prefix ()
- "Like outline-recent-depth, but returns text of last encountered prefix.
+ '(max 1 (- allout-recent-prefix-end
+ allout-recent-prefix-beginning
+ allout-header-subtraction)))
+;;;_ > allout-recent-prefix ()
+(defmacro allout-recent-prefix ()
+ "Like `allout-recent-depth', but returns text of last encountered prefix.
All outline functions which directly do string matches to assess
-headings set the variables outline-recent-prefix-beginning and
-outline-recent-prefix-end if successful. This function uses those settings
+headings set the variables `allout-recent-prefix-beginning' and
+`allout-recent-prefix-end' if successful. This function uses those settings
to return the current depth."
- '(buffer-substring outline-recent-prefix-beginning
- outline-recent-prefix-end))
-;;;_ > outline-recent-bullet ()
-(defmacro outline-recent-bullet ()
- "Like outline-recent-prefix, but returns bullet of last encountered
-prefix.
+ '(buffer-substring allout-recent-prefix-beginning
+ allout-recent-prefix-end))
+;;;_ > allout-recent-bullet ()
+(defmacro allout-recent-bullet ()
+ "Like allout-recent-prefix, but returns bullet of last encountered prefix.
All outline functions which directly do string matches to assess
-headings set the variables outline-recent-prefix-beginning and
-outline-recent-prefix-end if successful. This function uses those settings
+headings set the variables `allout-recent-prefix-beginning' and
+`allout-recent-prefix-end' if successful. This function uses those settings
to return the current depth of the most recently matched topic."
- '(buffer-substring (1- outline-recent-prefix-end)
- outline-recent-prefix-end))
+ '(buffer-substring (1- allout-recent-prefix-end)
+ allout-recent-prefix-end))
-;;;_ #3 Navigation
+;;;_ #4 Navigation
;;;_ - Position Assessment
;;;_ : Location Predicates
-;;;_ > outline-on-current-heading-p ()
-(defun outline-on-current-heading-p ()
- "Return prefix beginning point if point is on same line as current
-visible topics' header line."
+;;;_ > allout-on-current-heading-p ()
+(defun allout-on-current-heading-p ()
+ "Return non-nil if point is on current visible topics' header line.
+
+Actually, returns prefix beginning point."
(save-excursion
(beginning-of-line)
- (and (looking-at outline-regexp)
- (outline-prefix-data (match-beginning 0) (match-end 0)))))
-;;;_ > outline-e-o-prefix-p ()
-(defun outline-e-o-prefix-p ()
- "True if point is located where current topic prefix ends, heading
-begins."
+ (and (looking-at allout-regexp)
+ (allout-prefix-data (match-beginning 0) (match-end 0)))))
+;;;_ > allout-on-heading-p ()
+(defalias 'allout-on-heading-p 'allout-on-current-heading-p)
+;;;_ > allout-e-o-prefix-p ()
+(defun allout-e-o-prefix-p ()
+ "True if point is located where current topic prefix ends, heading begins."
(and (save-excursion (beginning-of-line)
- (looking-at outline-regexp))
- (= (point)(save-excursion (outline-end-of-prefix)(point)))))
-;;;_ > outline-hidden-p ()
-(defmacro outline-hidden-p ()
+ (looking-at allout-regexp))
+ (= (point)(save-excursion (allout-end-of-prefix)(point)))))
+;;;_ > allout-hidden-p ()
+(defmacro allout-hidden-p ()
"True if point is in hidden text."
'(save-excursion
(and (re-search-backward "[\n\r]" () t)
(= ?\r (following-char)))))
-;;;_ > outline-visible-p ()
-(defmacro outline-visible-p ()
+;;;_ > allout-visible-p ()
+(defmacro allout-visible-p ()
"True if point is not in hidden text."
(interactive)
- '(not (outline-hidden-p)))
+ '(not (allout-hidden-p)))
;;;_ : Location attributes
-;;;_ > outline-depth ()
-(defmacro outline-depth ()
- "Like outline-current-depth, but respects hidden as well as visible
-topics."
- '(save-excursion
- (if (outline-goto-prefix)
- (outline-recent-depth)
- (progn
- ;; Oops, no prefix, zero prefix data:
- (outline-prefix-data (point)(point))
- ;; ... and return 0:
- 0))))
-;;;_ > outline-current-depth ()
-(defmacro outline-current-depth ()
- "Return the depth to which the current containing visible topic is
-nested in the outline."
+;;;_ > allout-depth ()
+(defsubst allout-depth ()
+ "Like `allout-current-depth', but respects hidden as well as visible topics."
+ (save-excursion
+ (if (allout-goto-prefix)
+ (allout-recent-depth)
+ (progn
+ ;; Oops, no prefix, zero prefix data:
+ (allout-prefix-data (point)(point))
+ ;; ... and return 0:
+ 0))))
+;;;_ > allout-current-depth ()
+(defmacro allout-current-depth ()
+ "Return nesting depth of visible topic most immediately containing point."
'(save-excursion
- (if (outline-back-to-current-heading)
+ (if (allout-back-to-current-heading)
(max 1
- (- outline-recent-prefix-end
- outline-recent-prefix-beginning
- outline-header-subtraction))
+ (- allout-recent-prefix-end
+ allout-recent-prefix-beginning
+ allout-header-subtraction))
0)))
-;;;_ > outline-get-current-prefix ()
-(defun outline-get-current-prefix ()
+;;;_ > allout-get-current-prefix ()
+(defun allout-get-current-prefix ()
"Topic prefix of the current topic."
(save-excursion
- (if (outline-goto-prefix)
- (outline-recent-prefix))))
-;;;_ > outline-get-bullet ()
-(defun outline-get-bullet ()
+ (if (allout-goto-prefix)
+ (allout-recent-prefix))))
+;;;_ > allout-get-bullet ()
+(defun allout-get-bullet ()
"Return bullet of containing topic (visible or not)."
(save-excursion
- (and (outline-goto-prefix)
- (outline-recent-bullet))))
-;;;_ > outline-current-bullet ()
-(defun outline-current-bullet ()
+ (and (allout-goto-prefix)
+ (allout-recent-bullet))))
+;;;_ > allout-current-bullet ()
+(defun allout-current-bullet ()
"Return bullet of current (visible) topic heading, or none if none found."
(condition-case err
(save-excursion
- (outline-back-to-current-heading)
- (buffer-substring (- outline-recent-prefix-end 1)
- outline-recent-prefix-end))
+ (allout-back-to-current-heading)
+ (buffer-substring (- allout-recent-prefix-end 1)
+ allout-recent-prefix-end))
;; Quick and dirty provision, ostensibly for missing bullet:
- (args-out-of-range nil))
+ ('args-out-of-range nil))
)
-;;;_ > outline-get-prefix-bullet (prefix)
-(defun outline-get-prefix-bullet (prefix)
+;;;_ > allout-get-prefix-bullet (prefix)
+(defun allout-get-prefix-bullet (prefix)
"Return the bullet of the header prefix string PREFIX."
;; Doesn't make sense if we're old-style prefixes, but this just
;; oughtn't be called then, so forget about it...
- (if (string-match outline-regexp prefix)
+ (if (string-match allout-regexp prefix)
(substring prefix (1- (match-end 0)) (match-end 0))))
+;;;_ > allout-sibling-index (&optional depth)
+(defun allout-sibling-index (&optional depth)
+ "Item number of this prospective topic among its siblings.
+
+If optional arg depth is greater than current depth, then we're
+opening a new level, and return 0.
+
+If less than this depth, ascend to that depth and count..."
+
+ (save-excursion
+ (cond ((and depth (<= depth 0) 0))
+ ((or (not depth) (= depth (allout-depth)))
+ (let ((index 1))
+ (while (allout-previous-sibling (allout-recent-depth) nil)
+ (setq index (1+ index)))
+ index))
+ ((< depth (allout-recent-depth))
+ (allout-ascend-to-depth depth)
+ (allout-sibling-index))
+ (0))))
+;;;_ > allout-topic-flat-index ()
+(defun allout-topic-flat-index ()
+ "Return a list indicating point's numeric section.subsect.subsubsect...
+Outermost is first."
+ (let* ((depth (allout-depth))
+ (next-index (allout-sibling-index depth))
+ (rev-sibls nil))
+ (while (> next-index 0)
+ (setq rev-sibls (cons next-index rev-sibls))
+ (setq depth (1- depth))
+ (setq next-index (allout-sibling-index depth)))
+ rev-sibls)
+ )
;;;_ - Navigation macros
-;;;_ > outline-next-heading ()
-(defmacro outline-next-heading ()
+;;;_ > allout-next-heading ()
+(defsubst allout-next-heading ()
"Move to the heading for the topic \(possibly invisible) before this one.
Returns the location of the heading, or nil if none found."
- '(if (and (bobp) (not (eobp)))
+ (if (and (bobp) (not (eobp)))
(forward-char 1))
- '(if (re-search-forward outline-line-boundary-regexp nil 0)
- (progn ; Got valid location state - set vars:
- (outline-prefix-data
- (goto-char (or (match-beginning 2)
- outline-recent-prefix-beginning))
- (or (match-end 2) outline-recent-prefix-end)))))
-;;;_ > outline-previous-heading ()
-(defmacro outline-previous-heading ()
- "Move to the next \(possibly invisible) heading line.
+ (if (re-search-forward allout-line-boundary-regexp nil 0)
+ (allout-prefix-data ; Got valid location state - set vars:
+ (goto-char (or (match-beginning 2)
+ allout-recent-prefix-beginning))
+ (or (match-end 2) allout-recent-prefix-end))))
+;;;_ : allout-this-or-next-heading
+(defun allout-this-or-next-heading ()
+ "Position cursor on current or next heading."
+ ;; A throwaway non-macro that is defined after allout-next-heading
+ ;; and usable by allout-mode.
+ (if (not (allout-goto-prefix)) (allout-next-heading)))
+;;;_ > allout-previous-heading ()
+(defmacro allout-previous-heading ()
+ "Move to the prior \(possibly invisible) heading line.
Return the location of the beginning of the heading, or nil if not found."
'(if (bobp)
nil
- (outline-goto-prefix)
+ (allout-goto-prefix)
(if
;; searches are unbounded and return nil if failed:
- (or (re-search-backward outline-line-boundary-regexp nil 0)
- (looking-at outline-bob-regexp))
- (progn;; Got some valid location state - set vars:
- (outline-prefix-data
+ (or (re-search-backward allout-line-boundary-regexp nil 0)
+ (looking-at allout-bob-regexp))
+ (progn ; Got valid location state - set vars:
+ (allout-prefix-data
(goto-char (or (match-beginning 2)
- outline-recent-prefix-beginning))
- (or (match-end 2) outline-recent-prefix-end))))))
+ allout-recent-prefix-beginning))
+ (or (match-end 2) allout-recent-prefix-end))))))
;;;_ - Subtree Charting
;;;_ " These routines either produce or assess charts, which are
;;; Use of charts enables efficient navigation of subtrees, by
;;; requiring only a single regexp-search based traversal, to scope
;;; out the subtopic locations. The chart then serves as the basis
-;;; for whatever assessment or adjustment of the subtree that is
-;;; required, without requiring redundant topic-traversal procedures.
-
-;;;_ > outline-chart-subtree (&optional orig-level prev-level)
-(defun outline-chart-subtree (&optional orig-level prev-level)
- "Produce a location 'chart' of subtopics of the containing topic.
-The entries for each immediate child consists of an integer for the
-point of the beginning of the topic, followed by a 'chart' of the
-immediate offspring of the subtopic, if any.
-
-Use of charts enables efficient navigation of subtrees, by requiring
-only a single regexp-search based traversal, to scope out the subtopic
-locations. The chart then serves as the basis for whatever assessment
-or adjustment of the subtree that is required, without requiring
-redundant topic-traversal procedures.
-
-The function parameters are for internal recursion, and should not be
-designated by external callers."
-
- ;; We're constantly looking ahead. Impressive, huh?
-
- (let ((original (not orig-level)) ; 'here' passed only during recursion.
- chart here level)
- ; Initialize if not passed in:
- (if original
- (progn (setq orig-level (outline-depth))
- (outline-next-heading)))
- ; Consider only contents of orig topic:
- (if (not prev-level)
- (setq prev-level (1+ orig-level)))
-
- ;; Loop, rather than recurse, over the current levels' siblings, to
- ;; avoid overloading the typically quite constrained emacs max-lisp-
- ;; eval-depth.
+;;; for assessment or adjustment of the subtree, without redundant
+;;; traversal of the structure.
+
+;;;_ > allout-chart-subtree (&optional levels orig-depth prev-depth)
+(defun allout-chart-subtree (&optional levels orig-depth prev-depth)
+ "Produce a location \"chart\" of subtopics of the containing topic.
+
+Optional argument LEVELS specifies the depth \(relative to start
+depth) for the chart. Subsequent optional args are not for public
+use.
+
+Charts are used to capture outline structure, so that outline altering
+routines need assess the structure only once, and then use the chart
+for their elaborate manipulations.
+
+Topics are entered in the chart so the last one is at the car.
+The entry for each topic consists of an integer indicating the point
+at the beginning of the topic. Charts for offspring consists of a
+list containing, recursively, the charts for the respective subtopics.
+The chart for a topics' offspring precedes the entry for the topic
+itself.
+
+The other function parameters are for internal recursion, and should
+not be specified by external callers. ORIG-DEPTH is depth of topic at
+starting point, and PREV-DEPTH is depth of prior topic."
+
+ (let ((original (not orig-depth)) ; `orig-depth' set only in recursion.
+ chart curr-depth)
+
+ (if original ; Just starting?
+ ; Register initial settings and
+ ; position to first offspring:
+ (progn (setq orig-depth (allout-depth))
+ (or prev-depth (setq prev-depth (1+ orig-depth)))
+ (allout-next-heading)))
+
+ ;; Loop over the current levels' siblings. Besides being more
+ ;; efficient than tail-recursing over a level, it avoids exceeding
+ ;; the typically quite constrained emacs max-lisp-eval-depth.
+ ;;
+ ;; Probably would speed things up to implement loop-based stack
+ ;; operation rather than recursing for lower levels. Bah.
+
(while (and (not (eobp))
- (< orig-level (setq level (outline-recent-depth)))
- ; Still within original topic:
- (cond ((= prev-level level)
- (setq chart ; Register this one and move on:
- (cons (point) chart))
- (outline-next-heading))
-
- ((< prev-level level) ; Do higher level, then
- ; continue with this one:
- (setq chart (cons (outline-chart-subtree orig-level
- level)
- chart))))))
-
- (if original ; We're at the end of the level...
- ; Position to the end of the branch:
+ ; Still within original topic?
+ (< orig-depth (setq curr-depth (allout-recent-depth)))
+ (cond ((= prev-depth curr-depth)
+ ;; Register this one and move on:
+ (setq chart (cons (point) chart))
+ (if (and levels (<= levels 1))
+ ;; At depth limit - skip sublevels:
+ (or (allout-next-sibling curr-depth)
+ ;; or no more siblings - proceed to
+ ;; next heading at lesser depth:
+ (while (and (<= curr-depth
+ (allout-recent-depth))
+ (allout-next-heading))))
+ (allout-next-heading)))
+
+ ((and (< prev-depth curr-depth)
+ (or (not levels)
+ (> levels 0)))
+ ;; Recurse on deeper level of curr topic:
+ (setq chart
+ (cons (allout-chart-subtree (and levels
+ (1- levels))
+ orig-depth
+ curr-depth)
+ chart))
+ ;; ... then continue with this one.
+ )
+
+ ;; ... else nil if we've ascended back to prev-depth.
+
+ )))
+
+ (if original ; We're at the last sibling on
+ ; the original level. Position
+ ; to the end of it:
(progn (and (not (eobp)) (forward-char -1))
- (and (memq (preceding-char) '(?\n ?\^M))
+ (and (memq (preceding-char) '(?\n ?\r))
(memq (aref (buffer-substring (max 1 (- (point) 3))
(point))
1)
- '(?\n ?\^M))
- (forward-char -1))))
-
+ '(?\n ?\r))
+ (forward-char -1))
+ (setq allout-recent-end-of-subtree (point))))
+
chart ; (nreverse chart) not necessary,
; and maybe not preferable.
))
-;;;_ > outline-chart-topic (&optional orig-level prev-level)
-(defmacro outline-chart-topic ()
- "Return a location 'chart' for the current topic and its subtopics,if any.
-See 'outline-chart-subtree' for an explanation of charts."
-
- '(if (outline-goto-prefix)
- (let ((here (point))
- (subtree (outline-chart-subtree orig-level prev-level)))
- (if subtree
- (list here subtree)
- (list here)))))
-;;;_ > outline-chart-siblings (&optional start end)
-(defun outline-chart-siblings (&optional start end)
+;;;_ > allout-chart-siblings (&optional start end)
+(defun allout-chart-siblings (&optional start end)
"Produce a list of locations of this and succeeding sibling topics.
-Effectively a top-level chart of siblings. See 'outline-chart-subtree'
+Effectively a top-level chart of siblings. See `allout-chart-subtree'
for an explanation of charts."
(save-excursion
- (if (outline-goto-prefix)
+ (if (allout-goto-prefix)
(let ((chart (list (point))))
- (while (outline-next-sibling)
+ (while (allout-next-sibling)
(setq chart (cons (point) chart)))
- (if chart (setq chart (nreverse chart))))))
- )
-;;;_ > outline-chart-to-reveal (chart depth)
-(defun outline-chart-to-reveal (chart depth)
+ (if chart (setq chart (nreverse chart)))))))
+;;;_ > allout-chart-to-reveal (chart depth)
+(defun allout-chart-to-reveal (chart depth)
- "Return a flat list of the points in subtree CHART, up to DEPTH, which
-are hidden.
+ "Return a flat list of hidden points in subtree CHART, up to DEPTH.
-Note that point can wind up at any of the points on chart, or at the
+Note that point can be left at any of the points on chart, or at the
start point."
(let (result here)
chart)
(setq here (car chart))
(if (listp here)
- (let ((further (outline-chart-to-reveal here (or (eq depth t)
+ (let ((further (allout-chart-to-reveal here (or (eq depth t)
(1- depth)))))
;; We're on the start of a subtree - recurse with it, if there's
;; more depth to go:
(setq result (cons here result)))
(setq chart (cdr chart))))
result))
-;;;_ > outline-chart-spec (chart spec &optional exposing)
-(defun outline-chart-spec (chart spec &optional exposing)
- "Given a topic/subtree CHART and an exposure SPEC, produce a list of
-exposure directive, indicating the locations to be exposed and the
-prescribed exposure status. Optional arg EXPOSING is an integer, with
-0 indicating pending concealment, anything higher indicating depth to
+;;;_ X allout-chart-spec (chart spec &optional exposing)
+(defun allout-chart-spec (chart spec &optional exposing)
+ "Not yet \(if ever) implemented.
+
+Produce exposure directives given topic/subtree CHART and an exposure SPEC.
+
+Exposure spec indicates the locations to be exposed and the prescribed
+exposure status. Optional arg EXPOSING is an integer, with 0
+indicating pending concealment, anything higher indicating depth to
which subtopic headers should be exposed, and negative numbers
indicating (negative of) the depth to which subtopic headers and
bodies should be exposed.
The produced list can have two types of entries. Bare numbers
indicate points in the buffer where topic headers that should be
exposed reside.
+
- bare negative numbers indicates that the topic starting at the
point which is the negative of the number should be opened,
including their entries.
- bare positive values indicate that this topic header should be
- openned.
+ opened.
- Lists signify the beginning and end points of regions that should
- be flagged, and the flag to employ. (For concealment: '\(\?r\)', and
+ be flagged, and the flag to employ. (For concealment: `\(\?r\)', and
exposure:"
(while spec
- (cond ((listp spec)
+ (cond ((listp spec)
)
)
(setq spec (cdr spec)))
)
;;;_ - Within Topic
-;;;_ > outline-goto-prefix ()
-(defun outline-goto-prefix ()
- "Put point at beginning of outline prefix for immediately containing
-topic, visible or not.
-
-Returns a the point at the beginning of the prefix, or nil if none."
-
- (if (= (point-min)(point-max))
- nil
- (let (done)
- (while (and (not done)
- (re-search-backward "[\n\r]" nil 1))
- (forward-char 1)
- (if (looking-at outline-regexp)
- (setq done (outline-prefix-data (match-beginning 0)
- (match-end 0)))
- (forward-char -1)))
- (if (and (bobp)
- (looking-at outline-regexp))
- (outline-prefix-data (match-beginning 0)(match-end 0))
- done))))
-;;;_ > outline-end-of-prefix ()
-(defun outline-end-of-prefix (&optional ignore-decorations)
- "Position cursor at beginning of header text, or just after bullet
-if optional IGNORE-DECORATIONS non-nil."
-
- (if (not (outline-goto-prefix))
+;;;_ > allout-goto-prefix ()
+(defun allout-goto-prefix ()
+ "Put point at beginning of immediately containing outline topic.
+
+Goes to most immediate subsequent topic if none immediately containing.
+
+Not sensitive to topic visibility.
+
+Returns the point at the beginning of the prefix, or nil if none."
+
+ (let (done)
+ (while (and (not done)
+ (re-search-backward "[\n\r]" nil 1))
+ (forward-char 1)
+ (if (looking-at allout-regexp)
+ (setq done (allout-prefix-data (match-beginning 0)
+ (match-end 0)))
+ (forward-char -1)))
+ (if (bobp)
+ (cond ((looking-at allout-regexp)
+ (allout-prefix-data (match-beginning 0)(match-end 0)))
+ ((allout-next-heading))
+ (done))
+ done)))
+;;;_ > allout-end-of-prefix ()
+(defun allout-end-of-prefix (&optional ignore-decorations)
+ "Position cursor at beginning of header text.
+
+If optional IGNORE-DECORATIONS is non-nil, put just after bullet,
+otherwise skip white space between bullet and ensuing text."
+
+ (if (not (allout-goto-prefix))
nil
(let ((match-data (match-data)))
(goto-char (match-end 0))
(if (and (not (eolp)) (looking-at "\\s-")) (forward-char 1)))
(store-match-data match-data))
;; Reestablish where we are:
- (outline-current-depth)))
-;;;_ > outline-current-bullet-pos ()
-(defun outline-current-bullet-pos ()
+ (allout-current-depth)))
+;;;_ > allout-current-bullet-pos ()
+(defun allout-current-bullet-pos ()
"Return position of current \(visible) topic's bullet."
- (if (not (outline-current-depth))
+ (if (not (allout-current-depth))
nil
(1- (match-end 0))))
-;;;_ > outline-back-to-current-heading ()
-(defun outline-back-to-current-heading ()
- "Move to heading line of current visible topic, or beginning of heading
-if already on visible heading line."
+;;;_ > allout-back-to-current-heading ()
+(defun allout-back-to-current-heading ()
+ "Move to heading line of current topic, or beginning if already on the line."
+
(beginning-of-line)
- (prog1 (or (outline-on-current-heading-p)
- (and (re-search-backward (concat "^\\(" outline-regexp "\\)")
+ (prog1 (or (allout-on-current-heading-p)
+ (and (re-search-backward (concat "^\\(" allout-regexp "\\)")
nil
'move)
- (outline-prefix-data (match-beginning 1)(match-end 1))))
- (if (interactive-p) (outline-end-of-prefix))))
-;;;_ > outline-pre-next-preface ()
-(defun outline-pre-next-preface ()
+ (allout-prefix-data (match-beginning 1)(match-end 1))))
+ (if (interactive-p) (allout-end-of-prefix))))
+;;;_ > allout-back-to-heading ()
+(defalias 'allout-back-to-heading 'allout-back-to-current-heading)
+;;;_ > allout-pre-next-preface ()
+(defun allout-pre-next-preface ()
"Skip forward to just before the next heading line.
Returns that character position."
- (if (re-search-forward outline-line-boundary-regexp nil 'move)
+ (if (re-search-forward allout-line-boundary-regexp nil 'move)
(prog1 (goto-char (match-beginning 0))
- (outline-prefix-data (match-beginning 2)(match-end 2)))))
-;;;_ > outline-end-of-current-subtree ()
-(defun outline-end-of-current-subtree ()
+ (allout-prefix-data (match-beginning 2)(match-end 2)))))
+;;;_ > allout-end-of-current-subtree ()
+(defun allout-end-of-current-subtree ()
"Put point at the end of the last leaf in the currently visible topic."
(interactive)
- (outline-back-to-current-heading)
- (let ((opoint (point))
- (level (outline-recent-depth)))
- (outline-next-heading)
+ (allout-back-to-current-heading)
+ (let ((level (allout-recent-depth)))
+ (allout-next-heading)
(while (and (not (eobp))
- (> (outline-recent-depth) level))
- (outline-next-heading))
+ (> (allout-recent-depth) level))
+ (allout-next-heading))
(and (not (eobp)) (forward-char -1))
- (and (memq (preceding-char) '(?\n ?\^M))
+ (and (memq (preceding-char) '(?\n ?\r))
(memq (aref (buffer-substring (max 1 (- (point) 3)) (point)) 1)
- '(?\n ?\^M))
+ '(?\n ?\r))
(forward-char -1))
- (point)))
-;;;_ > outline-beginning-of-current-entry ()
-(defun outline-beginning-of-current-entry ()
- "When not already there, position the point at the beginning of the
-body of the current topic.
+ (setq allout-recent-end-of-subtree (point))))
+;;;_ > allout-beginning-of-current-entry ()
+(defun allout-beginning-of-current-entry ()
+ "When not already there, position point at beginning of current topic's body.
If already there, move cursor to bullet for hot-spot operation.
-\(See outline-mode doc string for details on hot-spot operation.)"
+\(See `allout-mode' doc string for details on hot-spot operation.)"
(interactive)
(let ((start-point (point)))
- (outline-end-of-prefix)
+ (allout-end-of-prefix)
(if (and (interactive-p)
(= (point) start-point))
- (goto-char (outline-current-bullet-pos)))))
-;;;_ > outline-end-of-current-entry ()
-(defun outline-end-of-current-entry ()
+ (goto-char (allout-current-bullet-pos)))))
+;;;_ > allout-end-of-current-entry ()
+(defun allout-end-of-current-entry ()
"Position the point at the end of the current topics' entry."
(interactive)
- (outline-show-entry)
- (prog1 (outline-pre-next-preface)
+ (allout-show-entry)
+ (prog1 (allout-pre-next-preface)
(if (and (not (bobp))(looking-at "^$"))
- (forward-char -1)))
-)
+ (forward-char -1))))
+;;;_ > allout-end-of-current-heading ()
+(defun allout-end-of-current-heading ()
+ (interactive)
+ (allout-beginning-of-current-entry)
+ (forward-line -1)
+ (end-of-line))
+(defalias 'allout-end-of-heading 'allout-end-of-current-heading)
;;;_ - Depth-wise
-;;;_ > outline-ascend-to-depth (depth)
-(defun outline-ascend-to-depth (depth)
+;;;_ > allout-ascend-to-depth (depth)
+(defun allout-ascend-to-depth (depth)
"Ascend to depth DEPTH, returning depth if successful, nil if not."
- (if (and (> depth 0)(<= depth (outline-depth)))
+ (if (and (> depth 0)(<= depth (allout-depth)))
(let ((last-good (point)))
- (while (and (< depth (outline-depth))
+ (while (and (< depth (allout-depth))
(setq last-good (point))
- (outline-beginning-of-level)
- (outline-previous-heading)))
- (if (= (outline-recent-depth) depth)
- (progn (goto-char outline-recent-prefix-beginning)
+ (allout-beginning-of-level)
+ (allout-previous-heading)))
+ (if (= (allout-recent-depth) depth)
+ (progn (goto-char allout-recent-prefix-beginning)
depth)
(goto-char last-good)
nil))
- (if (interactive-p) (outline-end-of-prefix))))
-;;;_ > outline-descend-to-depth (depth)
-(defun outline-descend-to-depth (depth)
- "Descend to depth DEPTH within current topic, returning depth if
-successful, nil if not."
+ (if (interactive-p) (allout-end-of-prefix))))
+;;;_ > allout-ascend ()
+(defun allout-ascend ()
+ "Ascend one level, returning t if successful, nil if not."
+ (prog1
+ (if (allout-beginning-of-level)
+ (allout-previous-heading))
+ (if (interactive-p) (allout-end-of-prefix))))
+;;;_ > allout-descend-to-depth (depth)
+(defun allout-descend-to-depth (depth)
+ "Descend to depth DEPTH within current topic.
+
+Returning depth if successful, nil if not."
(let ((start-point (point))
- (start-depth (outline-depth)))
+ (start-depth (allout-depth)))
(while
- (and (> (outline-depth) 0)
- (not (= depth (outline-recent-depth))) ; ... not there yet
- (outline-next-heading) ; ... go further
- (< start-depth (outline-recent-depth)))) ; ... still in topic
- (if (and (> (outline-depth) 0)
- (= (outline-recent-depth) depth))
+ (and (> (allout-depth) 0)
+ (not (= depth (allout-recent-depth))) ; ... not there yet
+ (allout-next-heading) ; ... go further
+ (< start-depth (allout-recent-depth)))) ; ... still in topic
+ (if (and (> (allout-depth) 0)
+ (= (allout-recent-depth) depth))
depth
(goto-char start-point)
nil))
)
-;;;_ > outline-up-current-level (arg &optional dont-complain)
-(defun outline-up-current-level (arg &optional dont-complain)
- "Move to the heading line of which the present line is a subheading.
-With argument, move up ARG levels. Don't return an error if
-second, optional argument DONT-COMPLAIN, is non-nil."
+;;;_ > allout-up-current-level (arg &optional dont-complain)
+(defun allout-up-current-level (arg &optional dont-complain)
+ "Move out ARG levels from current visible topic.
+
+Positions on heading line of containing topic. Error if unable to
+ascend that far, or nil if unable to ascend but optional arg
+DONT-COMPLAIN is non-nil."
(interactive "p")
- (outline-back-to-current-heading)
- (let ((present-level (outline-recent-depth)))
+ (allout-back-to-current-heading)
+ (let ((present-level (allout-recent-depth))
+ (last-good (point))
+ failed
+ return)
;; Loop for iterating arg:
- (while (and (> (outline-recent-depth) 1)
+ (while (and (> (allout-recent-depth) 1)
(> arg 0)
- (not (bobp)))
+ (not (bobp))
+ (not failed))
+ (setq last-good (point))
;; Loop for going back over current or greater depth:
- (while (and (not (< (outline-recent-depth) present-level))
- (outline-previous-visible-heading 1)))
- (setq present-level (outline-current-depth))
+ (while (and (not (< (allout-recent-depth) present-level))
+ (or (allout-previous-visible-heading 1)
+ (not (setq failed present-level)))))
+ (setq present-level (allout-current-depth))
(setq arg (- arg 1)))
- )
- (prog1 (if (<= arg 0)
- outline-recent-prefix-beginning
- (if (interactive-p) (outline-end-of-prefix))
- (if (not dont-complain)
- (error "Can't ascend past outermost level.")))
- (if (interactive-p) (outline-end-of-prefix)))
- )
+ (if (or failed
+ (> arg 0))
+ (progn (goto-char last-good)
+ (if (interactive-p) (allout-end-of-prefix))
+ (if (not dont-complain)
+ (error "Can't ascend past outermost level")
+ (if (interactive-p) (allout-end-of-prefix))
+ nil))
+ (if (interactive-p) (allout-end-of-prefix))
+ allout-recent-prefix-beginning)))
;;;_ - Linear
-;;;_ > outline-next-sibling (&optional depth backward)
-(defun outline-next-sibling (&optional depth backward)
- "Like outline-forward-current-level, but respects invisible topics.
+;;;_ > allout-next-sibling (&optional depth backward)
+(defun allout-next-sibling (&optional depth backward)
+ "Like `allout-forward-current-level', but respects invisible topics.
Traverse at optional DEPTH, or current depth if none specified.
(if (and backward (bobp))
nil
- (let ((start-depth (or depth (outline-depth)))
+ (let ((start-depth (or depth (allout-depth)))
(start-point (point))
last-depth)
(while (and (not (if backward (bobp) (eobp)))
- (if backward (outline-previous-heading)
- (outline-next-heading))
- (> (setq last-depth (outline-recent-depth)) start-depth)))
+ (if backward (allout-previous-heading)
+ (allout-next-heading))
+ (> (setq last-depth (allout-recent-depth)) start-depth)))
(if (and (not (eobp))
- (and (> (or last-depth (outline-depth)) 0)
- (= (outline-recent-depth) start-depth)))
- outline-recent-prefix-beginning
+ (and (> (or last-depth (allout-depth)) 0)
+ (= (allout-recent-depth) start-depth)))
+ allout-recent-prefix-beginning
(goto-char start-point)
- (if depth (outline-depth) start-depth)
+ (if depth (allout-depth) start-depth)
nil))))
-;;;_ > outline-previous-sibling (&optional depth backward)
-(defun outline-previous-sibling (&optional depth backward)
- "Like outline-forward-current-level, but goes backwards and respects
-invisible topics.
+;;;_ > allout-previous-sibling (&optional depth backward)
+(defun allout-previous-sibling (&optional depth backward)
+ "Like `allout-forward-current-level', but backwards & respect invisible topics.
Optional DEPTH specifies depth to traverse, default current depth.
Optional BACKWARD reverses direction.
Return depth if successful, nil otherwise."
- (outline-next-sibling depth (not backward))
+ (allout-next-sibling depth (not backward))
)
-;;;_ > outline-snug-back ()
-(defun outline-snug-back ()
- "Position cursor at end of previous topic, presuming that we are at
-the start of a topic prefix."
+;;;_ > allout-snug-back ()
+(defun allout-snug-back ()
+ "Position cursor at end of previous topic
+
+Presumes point is at the start of a topic prefix."
(if (or (bobp) (eobp))
nil
(forward-char -1))
- (if (or (bobp) (not (memq (preceding-char) '(?\n ?\^M))))
+ (if (or (bobp) (not (memq (preceding-char) '(?\n ?\r))))
nil
(forward-char -1)
- (if (or (bobp) (not (memq (preceding-char) '(?\n ?\^M))))
+ (if (or (bobp) (not (memq (preceding-char) '(?\n ?\r))))
(forward-char -1)))
(point))
-;;;_ > outline-beginning-of-level ()
-(defun outline-beginning-of-level ()
+;;;_ > allout-beginning-of-level ()
+(defun allout-beginning-of-level ()
"Go back to the first sibling at this level, visible or not."
- (outline-end-of-level 'backward))
-;;;_ > outline-end-of-level (&optional backward)
-(defun outline-end-of-level (&optional backward)
+ (allout-end-of-level 'backward))
+;;;_ > allout-end-of-level (&optional backward)
+(defun allout-end-of-level (&optional backward)
"Go to the last sibling at this level, visible or not."
- (let ((depth (outline-depth)))
- (while (outline-previous-sibling depth nil))
- (prog1 (outline-recent-depth)
- (if (interactive-p) (outline-end-of-prefix)))))
-;;;_ > outline-next-visible-heading (arg)
-(defun outline-next-visible-heading (arg)
- "Move to the next visible heading line, or as far as possible in
-indicated direction if no more headings to be found.
+ (let ((depth (allout-depth)))
+ (while (allout-previous-sibling depth nil))
+ (prog1 (allout-recent-depth)
+ (if (interactive-p) (allout-end-of-prefix)))))
+;;;_ > allout-next-visible-heading (arg)
+(defun allout-next-visible-heading (arg)
+ "Move to the next ARG'th visible heading line, backward if arg is negative.
-With argument, repeats, backward if negative."
+Move as far as possible in indicated direction \(beginning or end of
+buffer) if headings are exhausted."
(interactive "p")
(let* ((backward (if (< arg 0) (setq arg (* -1 arg))))
(step (if backward -1 1))
+ (start-point (point))
prev got)
(while (> arg 0) ; limit condition
(while (and (not (if backward (bobp)(eobp))) ; boundary condition
- (progn
- ;; Move, skipping over all those concealed lines:
- (forward-line step)
- (not (setq got (looking-at outline-regexp))))))
+ ;; Move, skipping over all those concealed lines:
+ (< -1 (forward-line step))
+ (not (setq got (looking-at allout-regexp)))))
;; Register this got, it may be the last:
(if got (setq prev got))
(setq arg (1- arg)))
(cond (got ; Last move was to a prefix:
- (outline-prefix-data (match-beginning 0) (match-end 0))
- (outline-end-of-prefix))
+ (allout-prefix-data (match-beginning 0) (match-end 0))
+ (allout-end-of-prefix))
(prev ; Last move wasn't, but prev was:
- (outline-prefix-data (match-beginning 0) (match-end 0)))
+ (allout-prefix-data (match-beginning 0) (match-end 0)))
((not backward) (end-of-line) nil))))
-;;;_ > outline-previous-visible-heading (arg)
-(defun outline-previous-visible-heading (arg)
+;;;_ > allout-previous-visible-heading (arg)
+(defun allout-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
+A heading line is one that starts with a `*' (or that `allout-regexp'
matches)."
(interactive "p")
- (outline-next-visible-heading (- arg)))
-;;;_ > outline-forward-current-level (arg)
-(defun outline-forward-current-level (arg)
- "Position the point at the next heading of the same level, taking
-optional repeat-count.
+ (allout-next-visible-heading (- arg)))
+;;;_ > allout-forward-current-level (arg)
+(defun allout-forward-current-level (arg)
+ "Position point at the next heading of the same level.
-Non-nil optional arg BACKWARD reverses direction.
+Takes optional repeat-count, goes backward if count is negative.
-Returns that position, else nil if is not found."
+Returns resulting position, else nil if none found."
(interactive "p")
- (if (and (< arg 0) (bobp))
- nil
- (let ((start-depth (save-excursion
- (outline-back-to-current-heading)
- (outline-depth)))
- (start-point (point))
- (backward (> 0 arg))
- last-depth
- (last-good (point)))
- (if backward (setq arg (* -1 arg)))
- (while (> arg 0)
- (while (and (not (if backward (bobp) (eobp)))
- (if backward (outline-previous-visible-heading 1)
- (outline-next-visible-heading 1))
- (> (setq last-depth (outline-recent-depth)) start-depth)))
- (if (and last-depth (= last-depth start-depth) )
- (setq last-good (point)
- arg (1- arg))
- (setq arg -1)))
- (if (and (not (eobp))
- (and (> (or last-depth (outline-depth)) 0)
- (= (outline-recent-depth) start-depth)))
- outline-recent-prefix-beginning
- (goto-char last-good)
- (if (not (interactive-p))
- nil
- (outline-end-of-prefix)
- (error "This is the %s topic on level %d."
- (if backward "first" "last")
- (outline-recent-depth)))))))
-;;;_ > outline-backward-current-level (arg)
-(defun outline-backward-current-level (arg)
- "Position the point at the previous heading of the same level, taking
-optional repeat-count.
-
-Returns that position, else nil if is not found."
+ (let ((start-depth (allout-current-depth))
+ (start-point (point))
+ (start-arg arg)
+ (backward (> 0 arg))
+ last-depth
+ (last-good (point))
+ at-boundary)
+ (if (= 0 start-depth)
+ (error "No siblings, not in a topic..."))
+ (if backward (setq arg (* -1 arg)))
+ (while (not (or (zerop arg)
+ at-boundary))
+ (while (and (not (if backward (bobp) (eobp)))
+ (if backward (allout-previous-visible-heading 1)
+ (allout-next-visible-heading 1))
+ (> (setq last-depth (allout-recent-depth)) start-depth)))
+ (if (and last-depth (= last-depth start-depth)
+ (not (if backward (bobp) (eobp))))
+ (setq last-good (point)
+ arg (1- arg))
+ (setq at-boundary t)))
+ (if (and (not (eobp))
+ (= arg 0)
+ (and (> (or last-depth (allout-depth)) 0)
+ (= (allout-recent-depth) start-depth)))
+ allout-recent-prefix-beginning
+ (goto-char last-good)
+ (if (not (interactive-p))
+ nil
+ (allout-end-of-prefix)
+ (error "Hit %s level %d topic, traversed %d of %d requested"
+ (if backward "first" "last")
+ (allout-recent-depth)
+ (- (abs start-arg) arg)
+ (abs start-arg))))))
+;;;_ > allout-backward-current-level (arg)
+(defun allout-backward-current-level (arg)
+ "Inverse of `allout-forward-current-level'."
(interactive "p")
- (unwind-protect
- (if (interactive-p)
- (let ((current-prefix-arg (* -1 arg)))
- (call-interactively 'outline-forward-current-level))
- (outline-forward-current-level (* -1 arg)))
- (outline-end-of-prefix)))
+ (if (interactive-p)
+ (let ((current-prefix-arg (* -1 arg)))
+ (call-interactively 'allout-forward-current-level))
+ (allout-forward-current-level (* -1 arg))))
-;;;_ #4 Alteration
+;;;_ #5 Alteration
;;;_ - Fundamental
-;;;_ > outline-before-change-protect (beg end)
-(defun outline-before-change-protect (beg end)
- "Reveal concealed text pending improper (non-integral) changes, and
+;;;_ > allout-before-change-protect (beg end)
+(defun allout-before-change-protect (beg end)
+ "Outline before-change hook, regulates changes to concealed text.
+
+Reveal concealed text that would be changed by current command, and
offer user choice to commit or forego the change. Unchanged text is
reconcealed. User has option to have changed text reconcealed.
\(This is for the sake of functions that do change the file during
writes, like crypt and zip modes.)
-Locally bound in outline buffers to 'before-change-function', which
-in emacs 19 is run before any change to the buffer. (Has no effect
-in Emacs 18, which doesn't support before-change-function.)
+Locally bound in outline buffers to `before-change-functions', which
+in emacs 19 is run before any change to the buffer.
-Any functions which set ['this-command' to 'undo', or which set]
-'outline-override-protect' non-nil (as does, eg, outline-flag-chars)
+Any functions which set [`this-command' to `undo', or which set]
+`allout-override-protect' non-nil (as does, eg, allout-flag-chars)
are exempt from this restriction."
- (if (and (outline-mode-p)
- ; outline-override-protect
+ (if (and (allout-mode-p)
+ ; allout-override-protect
; set by functions that know what
; they're doing, eg outline internals:
- (not outline-override-protect)
- (not outline-during-write-cue)
+ (not allout-override-protect)
+ (not allout-during-write-cue)
(save-match-data ; Preserve operation position state.
; Both beginning and end chars must
; be exposed:
(setq beg (1+ beg)
end (1+ end)))
(goto-char beg)
- (or (outline-hidden-p)
+ (or (allout-hidden-p)
(and (not (= beg end))
(goto-char end)
- (outline-hidden-p))))))
+ (allout-hidden-p))))))
(save-match-data
(if (equal this-command 'undo)
;; Allow undo without inhibition.
;; - Undo may be users' only recourse in protection faults.
;; So, expose what getting changed:
(progn (message "Undo! - exposing concealed target...")
- (sit-for 0)
- (if (outline-hidden-p)
- (outline-show-children))
- (message "Undo!")
- (sit-for 0))
+ (if (allout-hidden-p)
+ (allout-show-children))
+ (message "Undo!"))
(let (response
- (rehide-completely (save-excursion (outline-goto-prefix)
- (outline-hidden-p)))
+ (rehide-completely (save-excursion (allout-goto-prefix)
+ (allout-hidden-p)))
rehide-place)
-
+
(save-excursion
(if (condition-case err
;; Condition case to catch keyboard quits during reads.
; Give them a peek where
(save-excursion
(if (eolp) (setq rehide-place
- (outline-goto-prefix)))
- (outline-show-entry))
+ (allout-goto-prefix)))
+ (allout-show-entry))
; Present the message, but...
; leave the cursor at the location
; until they respond:
; Then interpret the response:
(while
- (progn
+ (progn
(message (concat "Change inside concealed"
" region - do it? "
"(n or 'y'/'r'eclose)"))
t)
((eq response ??)
(message
- "'r' means 'yes, then reclose")
+ "`r' means `yes, then reclose'")
nil)
(t (message "Please answer y, n, or r")
(sit-for 1)
nil)))))
response)
- (quit nil))
+ ('quit nil))
; Continue:
(if (eq response 'reclose)
(save-excursion
(if rehide-place (goto-char rehide-place))
(if rehide-completely
- (outline-hide-current-entry-completely)
- (outline-hide-current-entry)))
- (if (outline-ascend-to-depth (1- (outline-recent-depth)))
- (outline-show-children)
- (outline-show-to-offshoot)))
+ (allout-hide-current-entry-completely)
+ (allout-hide-current-entry)))
+ (if (allout-ascend-to-depth (1- (allout-recent-depth)))
+ (allout-show-children)
+ (allout-show-to-offshoot)))
; Prevent:
(if rehide-completely
(save-excursion
(if rehide-place (goto-char rehide-place))
- (outline-hide-current-entry-completely))
- (outline-hide-current-entry))
+ (allout-hide-current-entry-completely))
+ (allout-hide-current-entry))
(error (concat
"Change within concealed region prevented.")))))))
) ; if
) ; defun
-;;;_ = outline-post-goto-bullet
-(defvar outline-post-goto-bullet nil
- "Outline internal var, when set tells post-processing to reposition
-on topic bullet, and then unset it. Set by outline-pre-command-
-business when implementing hot-spot operation, where literal
-characters typed over a topic bullet are mapped to the command
-of the corresponding control-key on the outline-mode-map.")
-(make-variable-buffer-local 'outline-post-goto-bullet)
-;;;_ > outline-post-command-business ()
-(defun outline-post-command-business ()
- "A post-command-hook function for outline buffers, takes care of some
-loose ends left by outline-before-change-protect.
-
-- Nulls outline-override-protect, so it's not left open.
-
-- Implements (and clears) outline-post-goto-bullet, for hot-spot
+;;;_ = allout-post-goto-bullet
+(defvar allout-post-goto-bullet nil
+ "Outline internal var, for `allout-pre-command-business' hot-spot operation.
+
+When set, tells post-processing to reposition on topic bullet, and
+then unset it. Set by `allout-pre-command-business' when implementing
+hot-spot operation, where literal characters typed over a topic bullet
+are mapped to the command of the corresponding control-key on the
+`allout-mode-map'.")
+(make-variable-buffer-local 'allout-post-goto-bullet)
+;;;_ > allout-post-command-business ()
+(defun allout-post-command-business ()
+ "Outline `post-command-hook' function.
+
+- Null `allout-override-protect', so it's not left open.
+
+- Implement (and clear) `allout-post-goto-bullet', for hot-spot
outline commands.
- Massages buffer-undo-list so successive, standard character self-inserts are
aggregated. This kludge compensates for lack of undo bunching when
- before-change-function is used."
+ `before-change-functions' is used."
; Apply any external change func:
- (if (outline-mode-p) ; In outline-mode.
- (progn
- (setq outline-override-protect nil)
- (and outline-during-write-cue
- (setq outline-during-write-cue nil))
- ;; Undo bunching business:
- (if (and (listp buffer-undo-list) ; Undo history being kept.
- (equal this-command 'self-insert-command)
- (equal last-command 'self-insert-command))
- (let* ((prev-stuff (cdr buffer-undo-list))
- (before-prev-stuff (cdr (cdr prev-stuff)))
- cur-cell cur-from cur-to
- prev-cell prev-from prev-to)
- (if (and before-prev-stuff ; Goes back far enough to bother,
- (not (car prev-stuff)) ; and break before current,
- (not (car before-prev-stuff)) ; !and break before prev!
- (setq prev-cell (car (cdr prev-stuff))) ; contents now,
- (setq cur-cell (car buffer-undo-list)) ; contents prev.
-
- ;; cur contents denote a single char insertion:
- (numberp (setq cur-from (car cur-cell)))
- (numberp (setq cur-to (cdr cur-cell)))
- (= 1 (- cur-to cur-from))
-
- ;; prev contents denote fewer than aggregate-limit
- ;; insertions:
- (numberp (setq prev-from (car prev-cell)))
- (numberp (setq prev-to (cdr prev-cell)))
+ (if (not (allout-mode-p)) ; In allout-mode.
+ nil
+ (setq allout-override-protect nil)
+ (if allout-isearch-dynamic-expose
+ (allout-isearch-rectification))
+ (if allout-during-write-cue
+ ;; Was used by allout-before-change-protect, done with it now:
+ (setq allout-during-write-cue nil))
+ ;; Undo bunching business:
+ (if (and (listp buffer-undo-list) ; Undo history being kept.
+ (equal this-command 'self-insert-command)
+ (equal last-command 'self-insert-command))
+ (let* ((prev-stuff (cdr buffer-undo-list))
+ (before-prev-stuff (cdr (cdr prev-stuff)))
+ cur-cell cur-from cur-to
+ prev-cell prev-from prev-to)
+ (if (and before-prev-stuff ; Goes back far enough to bother,
+ (not (car prev-stuff)) ; and break before current,
+ (not (car before-prev-stuff)) ; !and break before prev!
+ (setq prev-cell (car (cdr prev-stuff))) ; contents now,
+ (setq cur-cell (car buffer-undo-list)) ; contents prev.
+
+ ;; cur contents denote a single char insertion:
+ (numberp (setq cur-from (car cur-cell)))
+ (numberp (setq cur-to (cdr cur-cell)))
+ (= 1 (- cur-to cur-from))
+
+ ;; prev contents denote fewer than aggregate-limit
+ ;; insertions:
+ (numberp (setq prev-from (car prev-cell)))
+ (numberp (setq prev-to (cdr prev-cell)))
; Below threshold:
- (> outline-undo-aggregation (- prev-to prev-from)))
- (setq buffer-undo-list
- (cons (cons prev-from cur-to)
- (cdr (cdr (cdr buffer-undo-list))))))))
- ;; Implement -post-goto-bullet, if set: (must be after undo business)
- (if (and outline-post-goto-bullet
- (outline-current-bullet-pos))
- (progn (goto-char (outline-current-bullet-pos))
- (setq outline-post-goto-bullet nil)))
- )))
-;;;_ > outline-pre-command-business ()
-(defun outline-pre-command-business ()
- "A pre-command-hook function for outline buffers. Implements
-special behavior when cursor is on bullet char.
-
-Self-insert characters are reinterpreted control-character references
-into the outline-mode-map. The outline-mode post-command hook will
-position a cursor that has moved as a result of such reinterpretation,
-on the destination topic's bullet, when the cursor wound up in the
-
-The upshot is that you can get easy, single (unmodified) key outline
-maneuvering and general operations by positioning the cursor on the
-bullet char, and it continues until you deliberately some non-outline
-motion command to relocate the cursor off of a bullet char."
-
- (if (and (eq this-command 'self-insert-command)
- (eq (point)(outline-current-bullet-pos)))
-
- (let* ((this-key-num (if (numberp last-command-event)
- last-command-event))
- mapped-binding)
-
+ (> allout-undo-aggregation (- prev-to prev-from)))
+ (setq buffer-undo-list
+ (cons (cons prev-from cur-to)
+ (cdr (cdr (cdr buffer-undo-list))))))))
+ ;; Implement -post-goto-bullet, if set: (must be after undo business)
+ (if (and allout-post-goto-bullet
+ (allout-current-bullet-pos))
+ (progn (goto-char (allout-current-bullet-pos))
+ (setq allout-post-goto-bullet nil)))
+ ))
+;;;_ > allout-pre-command-business ()
+(defun allout-pre-command-business ()
+ "Outline `pre-command-hook' function for outline buffers.
+Implements special behavior when cursor is on bullet character.
+
+When the cursor is on the bullet character, self-insert characters are
+reinterpreted as the corresponding control-character in the
+`allout-mode-map'. The `allout-mode' `post-command-hook' insures that
+the cursor which has moved as a result of such reinterpretation is
+positioned on the bullet character of the destination topic.
+
+The upshot is that you can get easy, single (ie, unmodified) key
+outline maneuvering operations by positioning the cursor on the bullet
+char. When in this mode you can use regular cursor-positioning
+command/keystrokes to relocate the cursor off of a bullet character to
+return to regular interpretation of self-insert characters."
+ (if (not (allout-mode-p))
+ ;; Shouldn't be invoked if not in allout allout-mode, but just in case:
+ nil
+ ;; Register isearch status:
+ (if (and (boundp 'isearch-mode) isearch-mode)
+ (setq allout-pre-was-isearching t)
+ (setq allout-pre-was-isearching nil))
+ ;; Hot-spot navigation provisions:
+ (if (and (eq this-command 'self-insert-command)
+ (eq (point)(allout-current-bullet-pos)))
+ (let* ((this-key-num (cond
+ ((numberp last-command-char)
+ last-command-char)
+ ;; XXX Only xemacs has characterp.
+ ((and (fboundp 'characterp)
+ (characterp last-command-char))
+ (char-to-int last-command-char))
+ (t 0)))
+ mapped-binding)
+ (if (zerop this-key-num)
+ nil
; Map upper-register literals
; to lower register:
- (if (<= 96 this-key-num)
- (setq this-key-num (- this-key-num 32)))
+ (if (<= 96 this-key-num)
+ (setq this-key-num (- this-key-num 32)))
; Check if we have a literal:
- (if (and (<= 64 this-key-num)
- (>= 96 this-key-num))
- (setq mapped-binding
- (lookup-key 'outline-mode-map
- (concat outline-command-prefix
- (char-to-string (- this-key-num 64))))))
- (if mapped-binding
- (setq outline-post-goto-bullet t
- this-command mapped-binding)))))
+ (if (and (<= 64 this-key-num)
+ (>= 96 this-key-num))
+ (setq mapped-binding
+ (lookup-key 'allout-mode-map
+ (concat allout-command-prefix
+ (char-to-string (- this-key-num
+ 64))))))
+ (if mapped-binding
+ (setq allout-post-goto-bullet t
+ this-command mapped-binding)))))))
+;;;_ > allout-find-file-hook ()
+(defun allout-find-file-hook ()
+ "Activate `allout-mode' when `allout-auto-activation' & `allout-layout' are non-nil.
+
+See `allout-init' for setup instructions."
+ (if (and allout-auto-activation
+ (not (allout-mode-p))
+ allout-layout)
+ (allout-mode t)))
+;;;_ > allout-isearch-rectification
+(defun allout-isearch-rectification ()
+ "Rectify outline exposure before, during, or after isearch.
+
+Called as part of `allout-post-command-business'."
+
+ (let ((isearching (and (boundp 'isearch-mode) isearch-mode)))
+ (cond ((and isearching (not allout-pre-was-isearching))
+ (allout-isearch-expose 'start))
+ ((and isearching allout-pre-was-isearching)
+ (allout-isearch-expose 'continue))
+ ((and (not isearching) allout-pre-was-isearching)
+ (allout-isearch-expose 'final))
+ ;; Not and wasn't isearching:
+ (t (setq allout-isearch-prior-pos nil)
+ (setq allout-isearch-did-quit nil)))))
+;;;_ = allout-isearch-was-font-lock
+(defvar allout-isearch-was-font-lock
+ (and (boundp 'font-lock-mode) font-lock-mode))
+
+;;;_ > allout-flag-region (from to flag)
+(defmacro allout-flag-region (from to flag)
+ "Hide or show lines from FROM to TO, via emacs selective-display FLAG char.
+Ie, text following flag C-m \(carriage-return) is hidden until the
+next C-j (newline) char.
+
+Returns the endpoint of the region."
+ `(let ((buffer-read-only nil)
+ (allout-override-protect t))
+ (subst-char-in-region ,from ,to
+ (if (= ,flag ?\n) ?\r ?\n)
+ ,flag t)))
+
+;;;_ > allout-isearch-expose (mode)
+(defun allout-isearch-expose (mode)
+ "Mode is either 'clear, 'start, 'continue, or 'final."
+ ;; allout-isearch-prior-pos encodes exposure status of prior pos:
+ ;; (pos was-vis header-pos end-pos)
+ ;; pos - point of concern
+ ;; was-vis - t, else 'topic if entire topic was exposed, 'entry otherwise
+ ;; Do reclosure or prior pos, as necessary:
+ (if (eq mode 'start)
+ (setq allout-isearch-was-font-lock (and (boundp 'font-lock-mode)
+ font-lock-mode)
+ font-lock-mode nil)
+ (if (eq mode 'final)
+ (setq font-lock-mode allout-isearch-was-font-lock))
+ (if (and allout-isearch-prior-pos
+ (listp allout-isearch-prior-pos))
+ ;; Conceal prior peek:
+ (allout-flag-region (car (cdr allout-isearch-prior-pos))
+ (car (cdr (cdr allout-isearch-prior-pos)))
+ ?\r)))
+ (if (allout-visible-p)
+ (setq allout-isearch-prior-pos nil)
+ (if (not (eq mode 'final))
+ (setq allout-isearch-prior-pos (cons (point) (allout-show-entry)))
+ (if allout-isearch-did-quit
+ nil
+ (setq allout-isearch-prior-pos nil)
+ (allout-show-children))))
+ (setq allout-isearch-did-quit nil))
+;;;_ > allout-enwrap-isearch ()
+(defun allout-enwrap-isearch ()
+ "Impose `allout-mode' isearch-abort wrapper for dynamic exposure in isearch.
+
+The function checks to ensure that the rebinding is done only once."
+
+ (add-hook 'isearch-mode-end-hook 'allout-isearch-rectification)
+ (if (fboundp 'allout-real-isearch-abort)
+ ;;
+ nil
+ ; Ensure load of isearch-mode:
+ (if (or (and (fboundp 'isearch-mode)
+ (fboundp 'isearch-abort))
+ (condition-case error
+ (load-library "isearch-mode")
+ ('file-error (message
+ "Skipping isearch-mode provisions - %s '%s'"
+ (car (cdr error))
+ (car (cdr (cdr error))))
+ (sit-for 1)
+ ;; Inhibit subsequent tries and return nil:
+ (setq allout-isearch-dynamic-expose nil))))
+ ;; Isearch-mode loaded, encapsulate specific entry points for
+ ;; outline dynamic-exposure business:
+ (progn
+ ;; stash crucial isearch-mode funcs under known, private
+ ;; names, then register wrapper functions under the old
+ ;; names, in their stead:
+ (fset 'allout-real-isearch-abort (symbol-function 'isearch-abort))
+ (fset 'isearch-abort 'allout-isearch-abort)))))
+;;;_ > allout-isearch-abort ()
+(defun allout-isearch-abort ()
+ "Wrapper for `allout-real-isearch-abort' \(which see), to register
+actual quits."
+ (interactive)
+ (setq allout-isearch-did-quit nil)
+ (condition-case what
+ (allout-real-isearch-abort)
+ ('quit (setq allout-isearch-did-quit t)
+ (signal 'quit nil))))
+
+;;; Prevent unnecessary font-lock while isearching!
+(defvar isearch-was-font-locking nil)
+(defun isearch-inhibit-font-lock ()
+ "Inhibit `font-lock-mode' while isearching - for use on `isearch-mode-hook'."
+ (if (and (allout-mode-p) (boundp 'font-lock-mode) font-lock-mode)
+ (setq isearch-was-font-locking t
+ font-lock-mode nil)))
+(add-hook 'isearch-mode-hook 'isearch-inhibit-font-lock)
+(defun isearch-reenable-font-lock ()
+ "Reenable font-lock after isearching - for use on isearch-mode-end-hook."
+ (if (and (boundp 'font-lock-mode) font-lock-mode)
+ (if (and (allout-mode-p) isearch-was-font-locking)
+ (setq isearch-was-font-locking nil
+ font-lock-mode t))))
+(add-hook 'isearch-mode-end-hook 'isearch-reenable-font-lock)
;;;_ - Topic Format Assessment
-;;;_ > outline-solicit-alternate-bullet (depth &optional current-bullet)
-(defun outline-solicit-alternate-bullet (depth &optional current-bullet)
-
- "Prompt for and return a bullet char as an alternative to the
-current one. Offer one suitable for current depth DEPTH as default."
-
- (let* ((default-bullet (or current-bullet
- (outline-bullet-for-depth depth)))
- (sans-escapes (regexp-sans-escapes outline-bullets-string))
- (choice (solicit-char-in-string
- (format "Select bullet: %s ('%s' default): "
- sans-escapes
- default-bullet)
- sans-escapes
- t)))
- (if (string= choice "") default-bullet choice))
- )
-;;;_ > outline-sibling-index (&optional depth)
-(defun outline-sibling-index (&optional depth)
- "Item number of this prospective topic among its siblings.
+;;;_ > allout-solicit-alternate-bullet (depth &optional current-bullet)
+(defun allout-solicit-alternate-bullet (depth &optional current-bullet)
-If optional arg depth is greater than current depth, then we're
-opening a new level, and return 0.
+ "Prompt for and return a bullet char as an alternative to the current one.
-If less than this depth, ascend to that depth and count..."
+Offer one suitable for current depth DEPTH as default."
- (save-excursion
- (cond ((and depth (<= depth 0) 0))
- ((or (not depth) (= depth (outline-depth)))
- (let ((index 1))
- (while (outline-previous-sibling (outline-recent-depth) nil)
- (setq index (1+ index)))
- index))
- ((< depth (outline-recent-depth))
- (outline-ascend-to-depth depth)
- (outline-sibling-index))
- (0))))
-;;;_ > outline-distinctive-bullet (bullet)
-(defun outline-distinctive-bullet (bullet)
- "True if bullet is one of those on outline-distinctive-bullets-string."
- (string-match (regexp-quote bullet) outline-distinctive-bullets-string))
-;;;_ > outline-numbered-type-prefix (&optional prefix)
-(defun outline-numbered-type-prefix (&optional prefix)
+ (let* ((default-bullet (or (and (stringp current-bullet) current-bullet)
+ (allout-bullet-for-depth depth)))
+ (sans-escapes (regexp-sans-escapes allout-bullets-string))
+ choice)
+ (save-excursion
+ (goto-char (allout-current-bullet-pos))
+ (setq choice (solicit-char-in-string
+ (format "Select bullet: %s ('%s' default): "
+ sans-escapes
+ default-bullet)
+ sans-escapes
+ t)))
+ (message "")
+ (if (string= choice "") default-bullet choice))
+ )
+;;;_ > allout-distinctive-bullet (bullet)
+(defun allout-distinctive-bullet (bullet)
+ "True if bullet is one of those on `allout-distinctive-bullets-string'."
+ (string-match (regexp-quote bullet) allout-distinctive-bullets-string))
+;;;_ > allout-numbered-type-prefix (&optional prefix)
+(defun allout-numbered-type-prefix (&optional prefix)
"True if current header prefix bullet is numbered bullet."
- (and outline-numbered-bullet
- (string= outline-numbered-bullet
+ (and allout-numbered-bullet
+ (string= allout-numbered-bullet
(if prefix
- (outline-get-prefix-bullet prefix)
- (outline-get-bullet)))))
-;;;_ > outline-bullet-for-depth (&optional depth)
-(defun outline-bullet-for-depth (&optional depth)
- "Return outline topic bullet suited to DEPTH, or for current depth if none
-specified."
+ (allout-get-prefix-bullet prefix)
+ (allout-get-bullet)))))
+;;;_ > allout-bullet-for-depth (&optional depth)
+(defun allout-bullet-for-depth (&optional depth)
+ "Return outline topic bullet suited to optional DEPTH, or current depth."
;; Find bullet in plain-bullets-string modulo DEPTH.
- (if outline-stylish-prefixes
- (char-to-string (aref outline-plain-bullets-string
+ (if allout-stylish-prefixes
+ (char-to-string (aref allout-plain-bullets-string
(% (max 0 (- depth 2))
- outline-plain-bullets-string-len)))
- outline-primary-bullet)
+ allout-plain-bullets-string-len)))
+ allout-primary-bullet)
)
;;;_ - Topic Production
-;;;_ > outline-make-topic-prefix (&optional prior-bullet
-(defun outline-make-topic-prefix (&optional prior-bullet
+;;;_ > allout-make-topic-prefix (&optional prior-bullet
+(defun allout-make-topic-prefix (&optional prior-bullet
new
depth
solicit
;; changing level of current topic.
;; Solicit dominates specified bullet-char.
;;;_ . Doc string:
- "Generate a topic prefix suitable for optional arg DEPTH, or current
-depth if not specified.
+ "Generate a topic prefix suitable for optional arg DEPTH, or current depth.
All the arguments are optional.
PRIOR-BULLET indicates the bullet of the prefix being changed, or
nil if none. This bullet may be preserved (other options
-notwithstanding) if it is on the outline-distinctive-bullets-string,
+notwithstanding) if it is on the `allout-distinctive-bullets-string',
for instance.
Second arg NEW indicates that a new topic is being opened after the
Third arg DEPTH forces the topic prefix to that depth, regardless of
the current topics' depth.
-Fourth arg SOLICIT non-nil provokes solicitation from the user of a
-choice among the valid bullets. (This overrides other all the
-options, including, eg, a distinctive PRIOR-BULLET.)
+If SOLICIT is non-nil, then the choice of bullet is solicited from
+user. If it's a character, then that character is offered as the
+default, otherwise the one suited to the context \(according to
+distinction or depth) is offered. \(This overrides other options,
+including, eg, a distinctive PRIOR-BULLET.) If non-nil, then the
+context-specific bullet is used.
-Fifth arg, NUMBER-CONTROL, matters only if 'outline-numbered-bullet'
+Fifth arg, NUMBER-CONTROL, matters only if `allout-numbered-bullet'
is non-nil *and* soliciting was not explicitly invoked. Then
NUMBER-CONTROL non-nil forces prefix to either numbered or
denumbered format, depending on the value of the sixth arg, INDEX.
that the index for the numbered prefix will be derived, by counting
siblings back to start of level. If INDEX is a number, then that
number is used as the index for the numbered prefix (allowing, eg,
-sequential renumbering to not requre this function counting back the
+sequential renumbering to not require this function counting back the
index for each successive sibling)."
;;;_ . Code:
;; The options are ordered in likely frequence of use, most common
(let* (body
numbering
denumbering
- (depth (or depth (outline-depth)))
- (header-lead outline-header-prefix)
+ (depth (or depth (allout-depth)))
+ (header-lead allout-header-prefix)
(bullet-char
;; Getting value for bullet char is practically the whole job:
(cond
; Simplest situation - level 1:
- ((<= depth 1) (setq header-lead "") outline-primary-bullet)
+ ((<= depth 1) (setq header-lead "") allout-primary-bullet)
; Simple, too: all asterisks:
- (outline-old-style-prefixes
+ (allout-old-style-prefixes
;; Cheat - make body the whole thing, null out header-lead and
;; bullet-char:
(setq body (make-string depth
- (string-to-char outline-primary-bullet)))
+ (string-to-char allout-primary-bullet)))
(setq header-lead "")
"")
((progn (setq body (make-string (- depth 2) ?\ ))
;; The actual condition:
solicit)
- (let* ((got (outline-solicit-alternate-bullet depth)))
+ (let* ((got (allout-solicit-alternate-bullet depth solicit)))
;; Gotta check whether we're numbering and got a numbered bullet:
- (setq numbering (and outline-numbered-bullet
+ (setq numbering (and allout-numbered-bullet
(not (and number-control (not index)))
- (string= got outline-numbered-bullet)))
+ (string= got allout-numbered-bullet)))
;; Now return what we got, regardless:
got))
;; Numbering invoked through args:
- ((and outline-numbered-bullet number-control)
+ ((and allout-numbered-bullet number-control)
(if (setq numbering (not (setq denumbering (not index))))
- outline-numbered-bullet
- (if (and current-bullet
- (not (string= outline-numbered-bullet
- current-bullet)))
- current-bullet
- (outline-bullet-for-depth depth))))
+ allout-numbered-bullet
+ (if (and prior-bullet
+ (not (string= allout-numbered-bullet
+ prior-bullet)))
+ prior-bullet
+ (allout-bullet-for-depth depth))))
;;; Neither soliciting nor controlled numbering ;;;
;;; (may be controlled denumbering, tho) ;;;
;; Check wrt previous sibling:
((and new ; only check for new prefixes
- (<= depth (outline-depth))
- outline-numbered-bullet ; ... & numbering enabled
+ (<= depth (allout-depth))
+ allout-numbered-bullet ; ... & numbering enabled
(not denumbering)
(let ((sibling-bullet
(save-excursion
;; Locate correct sibling:
- (or (>= depth (outline-depth))
- (outline-ascend-to-depth depth))
- (outline-get-bullet))))
+ (or (>= depth (allout-depth))
+ (allout-ascend-to-depth depth))
+ (allout-get-bullet))))
(if (and sibling-bullet
- (string= outline-numbered-bullet sibling-bullet))
+ (string= allout-numbered-bullet sibling-bullet))
(setq numbering sibling-bullet)))))
;; Distinctive prior bullet?
((and prior-bullet
- (outline-distinctive-bullet prior-bullet)
+ (allout-distinctive-bullet prior-bullet)
;; Either non-numbered:
- (or (not (and outline-numbered-bullet
- (string= prior-bullet outline-numbered-bullet)))
+ (or (not (and allout-numbered-bullet
+ (string= prior-bullet allout-numbered-bullet)))
;; or numbered, and not denumbering:
(setq numbering (not denumbering)))
;; Here 'tis:
prior-bullet))
;; Else, standard bullet per depth:
- ((outline-bullet-for-depth depth)))))
+ ((allout-bullet-for-depth depth)))))
(concat header-lead
body
bullet-char
(if numbering
(format "%d" (cond ((and index (numberp index)) index)
- (new (1+ (outline-sibling-index depth)))
- ((outline-sibling-index))))))
+ (new (1+ (allout-sibling-index depth)))
+ ((allout-sibling-index))))))
)
)
-;;;_ > outline-open-topic (relative-depth &optional before)
-(defun outline-open-topic (relative-depth &optional before)
- "Open a new topic at depth DEPTH. New topic is situated after current
-one, unless optional flag BEFORE is non-nil, or unless current line
-is complete empty (not even whitespace), in which case open is done
-on current line.
+;;;_ > allout-open-topic (relative-depth &optional before use_sib_bullet)
+(defun allout-open-topic (relative-depth &optional before use_sib_bullet)
+ "Open a new topic at depth DEPTH.
+
+New topic is situated after current one, unless optional flag BEFORE
+is non-nil, or unless current line is complete empty (not even
+whitespace), in which case open is done on current line.
+
+If USE_SIB_BULLET is true, use the bullet of the prior sibling.
Nuances:
- Creation of sibling or nested topics is with respect to the topic
you're starting from, even when creating backwards. This way you
can easily create a sibling in front of the current topic without
- having to go to its preceeding sibling, and then open forward
+ having to go to its preceding sibling, and then open forward
from there."
- (let* ((depth (+ (outline-current-depth) relative-depth))
+ (let* ((depth (+ (allout-current-depth) relative-depth))
(opening-on-blank (if (looking-at "^\$")
(not (setq before nil))))
opening-numbered ; Will get while computing ref-topic, below
- ref-depth ; Will get while computing ref-topic, next
+ ref-depth ; Will get while computing ref-topic, below
+ ref-bullet ; Will get while computing ref-topic, next
(ref-topic (save-excursion
(cond ((< relative-depth 0)
- (outline-ascend-to-depth depth))
+ (allout-ascend-to-depth depth))
((>= relative-depth 1) nil)
- (t (outline-back-to-current-heading)))
- (setq ref-depth (outline-recent-depth))
+ (t (allout-back-to-current-heading)))
+ (setq ref-depth (allout-recent-depth))
+ (setq ref-bullet
+ (if (> allout-recent-prefix-end 1)
+ (allout-recent-bullet)
+ ""))
(setq opening-numbered
(save-excursion
- (and outline-numbered-bullet
+ (and allout-numbered-bullet
(or (<= relative-depth 0)
- (outline-descend-to-depth depth))
- (if (outline-numbered-type-prefix)
- outline-numbered-bullet))))
+ (allout-descend-to-depth depth))
+ (if (allout-numbered-type-prefix)
+ allout-numbered-bullet))))
(point)))
dbl-space
doing-beginning)
; Positioning and vertical
; padding - only if not
; opening-on-blank:
- (progn
+ (progn
(goto-char ref-topic)
(setq dbl-space ; Determine double space action:
(or (and (<= relative-depth 0) ; not descending;
(save-excursion
- ;; at b-o-b or preceeded by a blank line?
+ ;; at b-o-b or preceded by a blank line?
(or (> 0 (forward-line -1))
(looking-at "^\\s-*$")
(bobp)))
(save-excursion
;; succeeded by a blank line?
- (outline-end-of-current-subtree)
+ (allout-end-of-current-subtree)
(bolp)))
(and (= ref-depth 1)
(or before
(save-excursion
;; Don't already have following
;; vertical padding:
- (not (outline-pre-next-preface)))))))
+ (not (allout-pre-next-preface)))))))
; Position to prior heading,
; if inserting backwards, and
; not going outwards:
(if (and before (>= relative-depth 0))
- (progn (outline-back-to-current-heading)
+ (progn (allout-back-to-current-heading)
(setq doing-beginning (bobp))
(if (not (bobp))
- (outline-previous-heading)))
+ (allout-previous-heading)))
(if (and before (bobp))
- (outline-unprotected (open-line 1))))
+ (allout-unprotected (open-line 1))))
(if (<= relative-depth 0)
;; Not going inwards, don't snug up:
(if doing-beginning
- (outline-unprotected (open-line (if dbl-space 2 1)))
+ (allout-unprotected (open-line (if dbl-space 2 1)))
(if before
(progn (end-of-line)
- (outline-pre-next-preface)
+ (allout-pre-next-preface)
(while (= ?\r (following-char))
(forward-char 1))
(if (not (looking-at "^$"))
- (outline-unprotected (open-line 1))))
- (outline-end-of-current-subtree)))
+ (allout-unprotected (open-line 1))))
+ (allout-end-of-current-subtree)))
;; Going inwards - double-space if first offspring is,
;; otherwise snug up.
(end-of-line) ; So we skip any concealed progeny.
- (outline-pre-next-preface)
+ (allout-pre-next-preface)
(if (bolp)
;; Blank lines between current header body and next
;; header - get to last substantive (non-white-space)
;; line in body:
(re-search-backward "[^ \t\n]" nil t))
(if (save-excursion
- (outline-next-heading)
- (if (> (outline-recent-depth) ref-depth)
+ (allout-next-heading)
+ (if (> (allout-recent-depth) ref-depth)
;; This is an offspring.
(progn (forward-line -1)
(looking-at "^\\s-*$"))))
(progn (forward-line 1)
- (outline-unprotected (open-line 1))))
+ (allout-unprotected (open-line 1))))
(end-of-line))
;;(if doing-beginning (goto-char doing-beginning))
(if (not (bobp))
(progn (if (and (not (> depth ref-depth))
(not before))
- (outline-unprotected (open-line 1))
+ (allout-unprotected (open-line 1))
(if (> depth ref-depth)
- (outline-unprotected (newline 1))
+ (allout-unprotected (newline 1))
(if dbl-space
- (outline-unprotected (open-line 1))
+ (allout-unprotected (open-line 1))
(if (not before)
- (outline-unprotected (newline 1))))))
+ (allout-unprotected (newline 1))))))
(if dbl-space
- (outline-unprotected (newline 1)))
+ (allout-unprotected (newline 1)))
(if (and (not (eobp))
(not (bolp)))
(forward-char 1))))
))
- (insert-string (concat (outline-make-topic-prefix opening-numbered
- t
- depth)
- " "))
+ (insert (concat (allout-make-topic-prefix opening-numbered
+ t
+ depth)
+ " "))
;;(if doing-beginning (save-excursion (newline (if dbl-space 2 1))))
- (outline-rebullet-heading nil ;;; solicit
- depth ;;; depth
- nil ;;; number-control
- nil ;;; index
+ (allout-rebullet-heading (and use_sib_bullet ref-bullet);;; solicit
+ depth ;;; depth
+ nil ;;; number-control
+ nil ;;; index
t) (end-of-line)
)
)
;;;_ . open-topic contingencies
;;;_ ; base topic - one from which open was issued
;;;_ , beginning char
-;;;_ , amount of space before will be used, unless openning in place
+;;;_ , amount of space before will be used, unless opening in place
;;;_ , end char will be used, unless opening before (and it still may)
;;;_ ; absolute depth of new topic
;;;_ ! insert in place - overrides most stuff
;;;_ ; buffer boundaries - special provisions for beginning and end ob
;;;_ ; level 1 topics have special provisions also - double space.
;;;_ ; location of new topic
-;;;_ .
-;;;_ > outline-open-subtopic (arg)
-(defun outline-open-subtopic (arg)
+;;;_ > allout-open-subtopic (arg)
+(defun allout-open-subtopic (arg)
"Open new topic header at deeper level than the current one.
Negative universal arg means to open deeper, but place the new topic
prior to the current one."
(interactive "p")
- (outline-open-topic 1 (> 0 arg)))
-;;;_ > outline-open-sibtopic (arg)
-(defun outline-open-sibtopic (arg)
- "Open new topic header at same level as the current one. Negative
-universal arg means to place the new topic prior to the current
+ (allout-open-topic 1 (> 0 arg)))
+;;;_ > allout-open-sibtopic (arg)
+(defun allout-open-sibtopic (arg)
+ "Open new topic header at same level as the current one.
+
+Positive universal arg means to use the bullet of the prior sibling.
+
+Negative universal arg means to place the new topic prior to the current
one."
(interactive "p")
- (outline-open-topic 0 (> 0 arg)))
-;;;_ > outline-open-supertopic (arg)
-(defun outline-open-supertopic (arg)
+ (allout-open-topic 0 (> 0 arg) (< 1 arg)))
+;;;_ > allout-open-supertopic (arg)
+(defun allout-open-supertopic (arg)
"Open new topic header at shallower level than the current one.
+
Negative universal arg means to open shallower, but place the new
topic prior to the current one."
(interactive "p")
- (outline-open-topic -1 (> 0 arg)))
+ (allout-open-topic -1 (> 0 arg)))
;;;_ - Outline Alteration
;;;_ : Topic Modification
-;;;_ = outline-former-auto-filler
-(defvar outline-former-auto-filler nil
- "Name of modal fill function being wrapped by outline-auto-fill.")
-;;;_ > outline-auto-fill ()
-(defun outline-auto-fill ()
- "Do normal autofill, maintaining outline hanging topic indentation
-if outline-use-hanging-indents is set."
- (let ((fill-prefix (if outline-use-hanging-indents
+;;;_ = allout-former-auto-filler
+(defvar allout-former-auto-filler nil
+ "Name of modal fill function being wrapped by `allout-auto-fill'.")
+;;;_ > allout-auto-fill ()
+(defun allout-auto-fill ()
+ "`allout-mode' autofill function.
+
+Maintains outline hanging topic indentation if
+`allout-use-hanging-indents' is set."
+ (let ((fill-prefix (if allout-use-hanging-indents
;; Check for topic header indentation:
(save-excursion
(beginning-of-line)
- (if (looking-at outline-regexp)
+ (if (looking-at allout-regexp)
;; ... construct indentation to account for
;; length of topic prefix:
- (make-string (progn (outline-end-of-prefix)
+ (make-string (progn (allout-end-of-prefix)
(current-column))
?\ ))))))
- (if (or outline-former-auto-filler outline-use-hanging-indents)
+ (if (or allout-former-auto-filler allout-use-hanging-indents)
(do-auto-fill))))
-;;;_ > outline-reindent-body (old-depth new-depth &optional number)
-(defun outline-reindent-body (old-depth new-depth &optional number)
+;;;_ > allout-reindent-body (old-depth new-depth &optional number)
+(defun allout-reindent-body (old-depth new-depth &optional number)
"Reindent body lines which were indented at old-depth to new-depth.
Optional arg NUMBER indicates numbering is being added, and it must
-be accomodated.
+be accommodated.
Note that refill of indented paragraphs is not done."
(save-excursion
- (outline-end-of-prefix)
+ (allout-end-of-prefix)
(let* ((new-margin (current-column))
excess old-indent-begin old-indent-end
curr-ind
;; *before* the prefix was changed, so we infer it relative
;; to the new margin and the shift in depth:
(old-margin (+ old-depth (- new-margin new-depth))))
-
+
;; Process lines up to (but excluding) next topic header:
- (outline-unprotected
+ (allout-unprotected
(save-match-data
(while
(and (re-search-forward "[\n\r]\\(\\s-*\\)"
nil
t)
;; Register the indent data, before we reset the
- ;; match data with a subsequent 'looking-at':
+ ;; match data with a subsequent `looking-at':
(setq old-indent-begin (match-beginning 1)
old-indent-end (match-end 1))
- (not (looking-at outline-regexp)))
+ (not (looking-at allout-regexp)))
(if (> 0 (setq excess (- (current-column)
old-margin)))
;; Text starts left of old margin - don't adjust:
;; beyond the old margin:
(delete-region old-indent-begin old-indent-end)
(indent-to (+ new-margin excess)))))))))
-;;;_ > outline-rebullet-current-heading (arg)
-(defun outline-rebullet-current-heading (arg)
- "Like non-interactive version 'outline-rebullet-heading', but work on
-\(only) visible heading containing point.
-
-With repeat count, solicit for bullet."
- (interactive "P")
- (save-excursion (outline-back-to-current-heading)
- (outline-end-of-prefix)
- (outline-rebullet-heading (not arg) ;;; solicit
- nil ;;; depth
- nil ;;; number-control
- nil ;;; index
- t) ;;; do-successors
- )
- )
-;;;_ > outline-rebullet-heading (&optional solicit ...)
-(defun outline-rebullet-heading (&optional solicit
+;;;_ > allout-rebullet-current-heading (arg)
+(defun allout-rebullet-current-heading (arg)
+ "Solicit new bullet for current visible heading."
+ (interactive "p")
+ (let ((initial-col (current-column))
+ (on-bullet (eq (point)(allout-current-bullet-pos)))
+ (backwards (if (< arg 0)
+ (setq arg (* arg -1)))))
+ (while (> arg 0)
+ (save-excursion (allout-back-to-current-heading)
+ (allout-end-of-prefix)
+ (allout-rebullet-heading t ;;; solicit
+ nil ;;; depth
+ nil ;;; number-control
+ nil ;;; index
+ t)) ;;; do-successors
+ (setq arg (1- arg))
+ (if (<= arg 0)
+ nil
+ (setq initial-col nil) ; Override positioning back to init col
+ (if (not backwards)
+ (allout-next-visible-heading 1)
+ (allout-goto-prefix)
+ (allout-next-visible-heading -1))))
+ (message "Done.")
+ (cond (on-bullet (goto-char (allout-current-bullet-pos)))
+ (initial-col (move-to-column initial-col)))))
+;;;_ > allout-rebullet-heading (&optional solicit ...)
+(defun allout-rebullet-heading (&optional solicit
new-depth
number-control
index
All args are optional.
-If SOLICIT is non-nil then the choice of bullet is solicited from
-user. Otherwise the distinctiveness of the bullet or the topic
-depth determines it.
+If SOLICIT is non-nil, then the choice of bullet is solicited from
+user. If it's a character, then that character is offered as the
+default, otherwise the one suited to the context \(according to
+distinction or depth) is offered. If non-nil, then the
+context-specific bullet is just used.
Second arg DEPTH forces the topic prefix to that depth, regardless
-of the topics current depth.
+of the topic's current depth.
Third arg NUMBER-CONTROL can force the prefix to or away from
-numbered form. It has effect only if 'outline-numbered-bullet' is
+numbered form. It has effect only if `allout-numbered-bullet' is
non-nil and soliciting was not explicitly invoked (via first arg).
Its effect, numbering or denumbering, then depends on the setting
-of the forth arg, INDEX.
+of the fourth arg, INDEX.
-If NUMBER-CONTROL is non-nil and forth arg INDEX is nil, then the
+If NUMBER-CONTROL is non-nil and fourth arg INDEX is nil, then the
prefix of the topic is forced to be non-numbered. Null index and
non-nil NUMBER-CONTROL forces denumbering. Non-nil INDEX (and
non-nil NUMBER-CONTROL) forces a numbered-prefix form. If non-nil
INDEX is a number, then that number is used for the numbered
prefix. Non-nil and non-number means that the index for the
-numbered prefix will be derived by outline-make-topic-prefix.
+numbered prefix will be derived by `allout-make-topic-prefix'.
Fifth arg DO-SUCCESSORS t means re-resolve count on succeeding
siblings.
-Cf vars 'outline-stylish-prefixes', 'outline-old-style-prefixes',
-and 'outline-numbered-bullet', which all affect the behavior of
+Cf vars `allout-stylish-prefixes', `allout-old-style-prefixes',
+and `allout-numbered-bullet', which all affect the behavior of
this function."
- (let* ((current-depth (outline-depth))
+ (let* ((current-depth (allout-depth))
(new-depth (or new-depth current-depth))
- (mb outline-recent-prefix-beginning)
- (me outline-recent-prefix-end)
+ (mb allout-recent-prefix-beginning)
+ (me allout-recent-prefix-end)
(current-bullet (buffer-substring (- me 1) me))
- (new-prefix (outline-make-topic-prefix current-bullet
+ (new-prefix (allout-make-topic-prefix current-bullet
nil
new-depth
solicit
;; New prefix probably different from old:
; get rid of old one:
- (outline-unprotected (delete-region mb me))
+ (allout-unprotected (delete-region mb me))
(goto-char mb)
; Dispense with number if
; numbered-bullet prefix:
- (if (and outline-numbered-bullet
- (string= outline-numbered-bullet current-bullet)
+ (if (and allout-numbered-bullet
+ (string= allout-numbered-bullet current-bullet)
(looking-at "[0-9]+"))
- (outline-unprotected
+ (allout-unprotected
(delete-region (match-beginning 0)(match-end 0))))
; Put in new prefix:
- (outline-unprotected (insert-string new-prefix))
+ (allout-unprotected (insert new-prefix))
;; Reindent the body if elected and margin changed:
- (if (and outline-reindent-bodies
+ (if (and allout-reindent-bodies
(not (= new-depth current-depth)))
- (outline-reindent-body current-depth new-depth))
+ (allout-reindent-body current-depth new-depth))
;; Recursively rectify successive siblings of orig topic if
;; caller elected for it:
(if do-successors
(save-excursion
- (while (outline-next-sibling new-depth nil)
+ (while (allout-next-sibling new-depth nil)
(setq index
(cond ((numberp index) (1+ index))
- ((not number-control) (outline-sibling-index))))
- (if (outline-numbered-type-prefix)
- (outline-rebullet-heading nil ;;; solicit
+ ((not number-control) (allout-sibling-index))))
+ (if (allout-numbered-type-prefix)
+ (allout-rebullet-heading nil ;;; solicit
new-depth ;;; new-depth
number-control;;; number-control
index ;;; index
nil))))) ;;;(dont!)do-successors
) ; (if (and (= current-depth new-depth)...))
- ) ; let* ((current-depth (outline-depth))...)
+ ) ; let* ((current-depth (allout-depth))...)
) ; defun
-;;;_ > outline-rebullet-topic (arg)
-(defun outline-rebullet-topic (arg)
- "Like outline-rebullet-topic-grunt, but start from topic visible at point.
+;;;_ > allout-rebullet-topic (arg)
+(defun allout-rebullet-topic (arg)
+ "Like `allout-rebullet-topic-grunt', but start from topic visible at point.
+
Descends into invisible as well as visible topics, however.
With repeat count, shift topic depth by that amount."
((listp arg) (setq arg (car arg))))
;; Fill the user in, in case we're shifting a big topic:
(if (not (zerop arg)) (message "Shifting..."))
- (outline-back-to-current-heading)
- (if (<= (+ (outline-recent-depth) arg) 0)
+ (allout-back-to-current-heading)
+ (if (<= (+ (allout-recent-depth) arg) 0)
(error "Attempt to shift topic below level 1"))
- (outline-rebullet-topic-grunt arg)
+ (allout-rebullet-topic-grunt arg)
(if (not (zerop arg)) (message "Shifting... done.")))
(move-to-column (max 0 (+ start-col arg)))))
-;;;_ > outline-rebullet-topic-grunt (&optional relative-depth ...)
-(defun outline-rebullet-topic-grunt (&optional relative-depth
+;;;_ > allout-rebullet-topic-grunt (&optional relative-depth ...)
+(defun allout-rebullet-topic-grunt (&optional relative-depth
starting-depth
starting-point
index
do-successors)
"Rebullet the topic at point, visible or invisible, and all
-contained subtopics. See outline-rebullet-heading for rebulleting
+contained subtopics. See `allout-rebullet-heading' for rebulleting
behavior.
All arguments are optional.
itself. The are STARTING-DEPTH, STARTING-POINT, and INDEX."
(let* ((relative-depth (or relative-depth 0))
- (new-depth (outline-depth))
+ (new-depth (allout-depth))
(starting-depth (or starting-depth new-depth))
(on-starting-call (null starting-point))
(index (or index
;; calculates it at what might be new depth:
(and (or (zerop relative-depth)
(not on-starting-call))
- (outline-sibling-index))))
+ (allout-sibling-index))))
(moving-outwards (< 0 relative-depth))
(starting-point (or starting-point (point))))
(and on-starting-call
moving-outwards
(> 0 (+ starting-depth relative-depth))
- (error "Attempt to shift topic out beyond level 1.")) ;;; ====>
+ (error "Attempt to shift topic out beyond level 1")) ;;; ====>
(cond ((= starting-depth new-depth)
;; We're at depth to work on this one:
- (outline-rebullet-heading nil ;;; solicit
+ (allout-rebullet-heading nil ;;; solicit
(+ starting-depth ;;; starting-depth
relative-depth)
nil ;;; number
nil) ;;; do-successors
;; ... and work on subsequent ones which are at greater depth:
(setq index 0)
- (outline-next-heading)
+ (allout-next-heading)
(while (and (not (eobp))
- (< starting-depth (outline-recent-depth)))
+ (< starting-depth (allout-recent-depth)))
(setq index (1+ index))
- (outline-rebullet-topic-grunt relative-depth ;;; relative-depth
+ (allout-rebullet-topic-grunt relative-depth ;;; relative-depth
(1+ starting-depth);;;starting-depth
starting-point ;;; starting-point
index))) ;;; index
((< starting-depth new-depth)
;; Rare case - subtopic more than one level deeper than parent.
;; Treat this one at an even deeper level:
- (outline-rebullet-topic-grunt relative-depth ;;; relative-depth
+ (allout-rebullet-topic-grunt relative-depth ;;; relative-depth
new-depth ;;; starting-depth
starting-point ;;; starting-point
index))) ;;; index
;; if topic has changed depth
(if (or do-successors
(and (not (zerop relative-depth))
- (or (= (outline-recent-depth) starting-depth)
- (= (outline-recent-depth) (+ starting-depth
+ (or (= (allout-recent-depth) starting-depth)
+ (= (allout-recent-depth) (+ starting-depth
relative-depth)))))
- (outline-rebullet-heading nil nil nil nil t))
+ (allout-rebullet-heading nil nil nil nil t))
;; Now rectify numbering of new siblings of the adjusted topic,
;; if depth has been changed:
(progn (goto-char starting-point)
(if (not (zerop relative-depth))
- (outline-rebullet-heading nil nil nil nil t)))))
+ (allout-rebullet-heading nil nil nil nil t)))))
)
)
-;;;_ > outline-renumber-to-depth (&optional depth)
-(defun outline-renumber-to-depth (&optional depth)
- "Renumber siblings at current depth, from point, and shallower
-if optional arg DEPTH is less than current depth.
+;;;_ > allout-renumber-to-depth (&optional depth)
+(defun allout-renumber-to-depth (&optional depth)
+ "Renumber siblings at current depth.
+
+Affects superior topics if optional arg DEPTH is less than current depth.
Returns final depth."
;; Proceed by level, processing subsequent siblings on each,
;; ascending until we get shallower than the start depth:
- (let ((ascender (outline-depth)))
+ (let ((ascender (allout-depth))
+ was-eobp)
(while (and (not (eobp))
- (outline-depth)
- (>= (outline-recent-depth) depth)
+ (allout-depth)
+ (>= (allout-recent-depth) depth)
(>= ascender depth))
; Skip over all topics at
; lesser depths, which can not
; have been disturbed:
- (while (and (not (eobp))
- (> (outline-recent-depth) ascender))
- (outline-next-heading))
+ (while (and (not (setq was-eobp (eobp)))
+ (> (allout-recent-depth) ascender))
+ (allout-next-heading))
; Prime ascender for ascension:
- (setq ascender (1- (outline-recent-depth)))
- (if (>= (outline-recent-depth) depth)
- (outline-rebullet-heading nil ;;; solicit
+ (setq ascender (1- (allout-recent-depth)))
+ (if (>= (allout-recent-depth) depth)
+ (allout-rebullet-heading nil ;;; solicit
nil ;;; depth
nil ;;; number-control
nil ;;; index
- t))));;; do-successors
- (outline-recent-depth))
-;;;_ > outline-number-siblings (&optional denumber)
-(defun outline-number-siblings (&optional denumber)
+ t)) ;;; do-successors
+ (if was-eobp (goto-char (point-max)))))
+ (allout-recent-depth))
+;;;_ > allout-number-siblings (&optional denumber)
+(defun allout-number-siblings (&optional denumber)
"Assign numbered topic prefix to this topic and its siblings.
With universal argument, denumber - assign default bullet to this
(interactive "P")
(save-excursion
- (outline-back-to-current-heading)
- (outline-beginning-of-level)
- (let ((depth (outline-recent-depth))
+ (allout-back-to-current-heading)
+ (allout-beginning-of-level)
+ (let ((depth (allout-recent-depth))
(index (if (not denumber) 1))
(use-bullet (equal '(16) denumber))
(more t))
(while more
- (outline-rebullet-heading use-bullet ;;; solicit
+ (allout-rebullet-heading use-bullet ;;; solicit
depth ;;; depth
t ;;; number-control
index ;;; index
nil) ;;; do-successors
(if index (setq index (1+ index)))
- (setq more (outline-next-sibling depth nil))))))
-;;;_ > outline-shift-in (arg)
-(defun outline-shift-in (arg)
- "Decrease prefix depth of current heading and any topics collapsed
-within it."
+ (setq more (allout-next-sibling depth nil))))))
+;;;_ > allout-shift-in (arg)
+(defun allout-shift-in (arg)
+ "Increase depth of current heading and any topics collapsed within it."
(interactive "p")
- (outline-rebullet-topic arg))
-;;;_ > outline-shift-out (arg)
-(defun outline-shift-out (arg)
- "Decrease prefix depth of current heading and any topics collapsed
-within it."
+ (allout-rebullet-topic arg))
+;;;_ > allout-shift-out (arg)
+(defun allout-shift-out (arg)
+ "Decrease depth of current heading and any topics collapsed within it."
(interactive "p")
- (outline-rebullet-topic (* arg -1)))
+ (allout-rebullet-topic (* arg -1)))
;;;_ : Surgery (kill-ring) functions with special provisions for outlines:
-;;;_ > outline-kill-line (&optional arg)
-(defun outline-kill-line (&optional arg)
+;;;_ > allout-kill-line (&optional arg)
+(defun allout-kill-line (&optional arg)
"Kill line, adjusting subsequent lines suitably for outline mode."
(interactive "*P")
- (if (not (and (outline-mode-p) ; active outline mode,
- outline-numbered-bullet ; numbers may need adjustment,
+ (if (not (and (allout-mode-p) ; active outline mode,
+ allout-numbered-bullet ; numbers may need adjustment,
(bolp) ; may be clipping topic head,
- (looking-at outline-regexp))) ; are clipping topic head.
+ (looking-at allout-regexp))) ; are clipping topic head.
;; Above conditions do not obtain - just do a regular kill:
(kill-line arg)
;; Ah, have to watch out for adjustments:
- (let* ((depth (outline-depth)))
+ (let* ((depth (allout-depth)))
; Do the kill:
(kill-line arg)
; Provide some feedback:
(save-excursion
; Start with the topic
; following killed line:
- (if (not (looking-at outline-regexp))
- (outline-next-heading))
- (outline-renumber-to-depth depth)))))
-;;;_ > outline-kill-topic ()
-(defun outline-kill-topic ()
+ (if (not (looking-at allout-regexp))
+ (allout-next-heading))
+ (allout-renumber-to-depth depth)))))
+;;;_ > allout-kill-topic ()
+(defun allout-kill-topic ()
"Kill topic together with subtopics.
Leaves primary topic's trailing vertical whitespace, if any."
;; a lag *after* the kill has been performed.
(interactive)
- (let* ((beg (prog1 (outline-back-to-current-heading)(beginning-of-line)))
- (depth (outline-recent-depth)))
- (outline-end-of-current-subtree)
+ (let* ((beg (prog1 (allout-back-to-current-heading)(beginning-of-line)))
+ (depth (allout-recent-depth)))
+ (allout-end-of-current-subtree)
(if (not (eobp))
(if (or (not (looking-at "^$"))
;; A blank line - cut it with this topic *unless* this
;; we'll leave the blank line as part of the
;; containing topic:
(save-excursion
- (and (outline-next-heading)
- (>= (outline-recent-depth) depth))))
+ (and (allout-next-heading)
+ (>= (allout-recent-depth) depth))))
(forward-char 1)))
-
+
(kill-region beg (point))
(sit-for 0)
(save-excursion
- (outline-renumber-to-depth depth))))
-;;;_ > outline-yank-processing ()
-(defun outline-yank-processing (&optional arg)
+ (allout-renumber-to-depth depth))))
+;;;_ > allout-yank-processing ()
+(defun allout-yank-processing (&optional arg)
+
+ "Incidental outline specific business to be done just after text yanks.
- "Incidental outline-specific business to be done just after text yanks.
Does depth adjustment of yanked topics, when:
1 the stuff being yanked starts with a valid outline header prefix, and
2 it is being yanked at the end of a line which consists of only a valid
topic prefix.
-Also, adjusts numbering of subsequent siblings when appropropriate.
+Also, adjusts numbering of subsequent siblings when appropriate.
Depth adjustment alters the depth of all the topics being yanked
the amount it takes to make the first topic have the depth of the
The point is left in front of yanked, adjusted topics, rather than
at the end (and vice-versa with the mark). Non-adjusted yanks,
-however, are left exactly like normal, non-outline-specific yanks."
+however, are left exactly like normal, not outline specific yanks."
(interactive "*P")
; Get to beginning, leaving
; region around subject:
- (if (< (mark-marker) (point))
+ (if (< (my-mark-marker t) (point))
(exchange-point-and-mark))
(let* ((subj-beg (point))
- (subj-end (mark-marker))
+ (subj-end (my-mark-marker t))
;; 'resituate' if yanking an entire topic into topic header:
- (resituate (and (outline-e-o-prefix-p)
- (looking-at (concat "\\(" outline-regexp "\\)"))
- (outline-prefix-data (match-beginning 1)
+ (resituate (and (allout-e-o-prefix-p)
+ (looking-at (concat "\\(" allout-regexp "\\)"))
+ (allout-prefix-data (match-beginning 1)
(match-end 1))))
- ;; 'rectify-numbering' if resituating (where several topics may
+ ;; `rectify-numbering' if resituating (where several topics may
;; be resituating) or yanking a topic into a topic slot (bol):
(rectify-numbering (or resituate
- (and (bolp) (looking-at outline-regexp)))))
+ (and (bolp) (looking-at allout-regexp)))))
(if resituate
; The yanked stuff is a topic:
(let* ((prefix-len (- (match-end 1) subj-beg))
- (subj-depth (outline-recent-depth))
- (prefix-bullet (outline-recent-bullet))
+ (subj-depth (allout-recent-depth))
+ (prefix-bullet (allout-recent-bullet))
(adjust-to-depth
;; Nil if adjustment unnecessary, otherwise depth to which
;; adjustment should be made:
(and (goto-char subj-end)
(eolp)
(goto-char subj-beg)
- (and (looking-at outline-regexp)
+ (and (looking-at allout-regexp)
(progn
(beginning-of-line)
(not (= (point) subj-beg)))
- (looking-at outline-regexp)
- (outline-prefix-data (match-beginning 0)
+ (looking-at allout-regexp)
+ (allout-prefix-data (match-beginning 0)
(match-end 0)))
- (outline-recent-depth))))
+ (allout-recent-depth))))
done
(more t))
- (setq rectify-numbering outline-numbered-bullet)
+ (setq rectify-numbering allout-numbered-bullet)
(if adjust-to-depth
; Do the adjustment:
(progn
; line at end, if any:
(goto-char (point-max))
(if (looking-at "^$")
- (outline-unprotected (delete-char -1)))
+ (allout-unprotected (delete-char -1)))
; Work backwards, with each
; shallowest level,
; successively excluding the
; last processed topic from
; the narrow region:
(while more
- (outline-back-to-current-heading)
+ (allout-back-to-current-heading)
; go as high as we can in each bunch:
- (while (outline-ascend-to-depth (1- (outline-depth))))
+ (while (allout-ascend-to-depth (1- (allout-depth))))
(save-excursion
- (outline-rebullet-topic-grunt (- adjust-to-depth
+ (allout-rebullet-topic-grunt (- adjust-to-depth
subj-depth))
- (outline-depth))
+ (allout-depth))
(if (setq more (not (bobp)))
(progn (widen)
(forward-char -1)
;; Preserve new bullet if it's a distinctive one, otherwise
;; use old one:
(if (string-match (regexp-quote prefix-bullet)
- outline-distinctive-bullets-string)
+ allout-distinctive-bullets-string)
; Delete from bullet of old to
; before bullet of new:
(progn
(beginning-of-line)
(delete-region (point) subj-beg)
- (set-marker (mark-marker) subj-end)
+ (set-marker (my-mark-marker t) subj-end)
(goto-char subj-beg)
- (outline-end-of-prefix))
+ (allout-end-of-prefix))
; Delete base subj prefix,
; leaving old one:
(delete-region (point) (+ (point)
(if (looking-at " ") (delete-char 1))))
(exchange-point-and-mark))))
(if rectify-numbering
- (progn
+ (progn
(save-excursion
; Give some preliminary feedback:
(message "... reconciling numbers") (sit-for 0)
; ... and renumber, in case necessary:
(goto-char subj-beg)
- (if (outline-goto-prefix)
- (outline-rebullet-heading nil ;;; solicit
- (outline-depth) ;;; depth
+ (if (allout-goto-prefix)
+ (allout-rebullet-heading nil ;;; solicit
+ (allout-depth) ;;; depth
nil ;;; number-control
nil ;;; index
t))
(message ""))))
(if (not resituate)
(exchange-point-and-mark))))
-;;;_ > outline-yank (&optional arg)
-(defun outline-yank (&optional arg)
- "Like yank, with depth and numbering adjustment of yanked topics in
-outline mode. Non-topic yanks work no differntly than normal yanks.
+;;;_ > allout-yank (&optional arg)
+(defun allout-yank (&optional arg)
+ "`allout-mode' yank, with depth and numbering adjustment of yanked topics.
+
+Non-topic yanks work no differently than normal yanks.
If a topic is being yanked into a bare topic prefix, the depth of the
yanked topic is adjusted to the depth of the topic prefix.
- 1 we're yanking in an outline-mode buffer
+ 1 we're yanking in an `allout-mode' buffer
2 the stuff being yanked starts with a valid outline header prefix, and
3 it is being yanked at the end of a line which consists of only a valid
topic prefix.
however, (ones that don't qualify for adjustment) are handled
exactly like normal yanks.
-Numbering of yanked topics, and the succesive siblings at the depth
+Numbering of yanked topics, and the successive siblings at the depth
into which they're being yanked, is adjusted.
-Outline-yank-pop works with outline-yank just like normal yank-pop
+`allout-yank-pop' works with `allout-yank' just like normal yank-pop
works with normal yank in non-outline buffers."
(interactive "*P")
(setq this-command 'yank)
(yank arg)
- (if (outline-mode-p)
- (outline-yank-processing)))
-;;;_ > outline-yank-pop (&optional arg)
-(defun outline-yank-pop (&optional arg)
- "Just like yank-pop, but works like outline-yank when popping
-topics just after fresh outline prefixes. Adapts level of popped
-stuff to level of fresh prefix.
+ (if (allout-mode-p)
+ (allout-yank-processing)))
+;;;_ > allout-yank-pop (&optional arg)
+(defun allout-yank-pop (&optional arg)
+ "Yank-pop like `allout-yank' when popping to bare outline prefixes.
+
+Adapts level of popped topics to level of fresh prefix.
Note - prefix changes to distinctive bullets will stick, if followed
by pops to non-distinctive yanks. Bug..."
(interactive "*p")
(setq this-command 'yank)
(yank-pop arg)
- (if (outline-mode-p)
- (outline-yank-processing)))
+ (if (allout-mode-p)
+ (allout-yank-processing)))
;;;_ - Specialty bullet functions
;;;_ : File Cross references
-;;;_ > outline-resolve-xref ()
-(defun outline-resolve-xref ()
- "Pop to file associated with current heading, if it has an xref bullet
-\(according to setting of 'outline-file-xref-bullet')."
+;;;_ > allout-resolve-xref ()
+(defun allout-resolve-xref ()
+ "Pop to file associated with current heading, if it has an xref bullet.
+
+\(Works according to setting of `allout-file-xref-bullet')."
(interactive)
- (if (not outline-file-xref-bullet)
+ (if (not allout-file-xref-bullet)
(error
- "outline cross references disabled - no 'outline-file-xref-bullet'")
- (if (not (string= (outline-current-bullet) outline-file-xref-bullet))
- (error "current heading lacks cross-reference bullet '%s'"
- outline-file-xref-bullet)
+ "outline cross references disabled - no `allout-file-xref-bullet'")
+ (if (not (string= (allout-current-bullet) allout-file-xref-bullet))
+ (error "current heading lacks cross-reference bullet `%s'"
+ allout-file-xref-bullet)
(let (file-name)
(save-excursion
- (let* ((text-start outline-recent-prefix-end)
- (heading-end (progn (outline-pre-next-preface)
- (point))))
+ (let* ((text-start allout-recent-prefix-end)
+ (heading-end (progn (end-of-line) (point))))
(goto-char text-start)
(setq file-name
(if (re-search-forward "\\s-\\(\\S-*\\)" heading-end t)
(setq file-name
(if (not (= (aref file-name 0) ?:))
(expand-file-name file-name)
- ; A registry-files ref, strip the ':'
+ ; A registry-files ref, strip the `:'
; and try to follow it:
(let ((reg-ref (reference-registered-file
(substring file-name 1) nil t)))
(error "%s not found and can't be created" file-name)))
(condition-case failure
(find-file-other-window file-name)
- (error failure))
+ ('error failure))
(error "%s not found" file-name))
)
)
)
)
-;;;_ > outline-to-entry-end - Unmaintained compatability - ignore this!
-;-------------------------------------------------------------------
-; Something added solely for use by a "smart menu" package someone got
-; off the net. I have no idea whether this is appropriate code.
-
-(defvar next-entry-exists nil "Used by outline-to-entry-end, dunno why.")
-(defun outline-to-entry-end (&optional include-sub-entries curr-entry-level)
- "Go to end of whole entry if optional INCLUDE-SUB-ENTRIES is non-nil.
-CURR-ENTRY-LEVEL is an integer representing the length of the current level
-string which matched to 'outline-regexp'. If INCLUDE-SUB-ENTRIES is nil,
-CURR-ENTRY-LEVEL is not needed."
- (while (and (setq next-entry-exists
- (re-search-forward outline-regexp nil t))
- include-sub-entries
- (save-excursion
- (beginning-of-line)
- (> (outline-depth) curr-entry-level))))
- (if next-entry-exists
- (progn (beginning-of-line) (point))
- (goto-char (point-max))))
-
-;;; Outline topic prefix and level adjustment funcs:
-
-;;;_ #5 Exposure Control and Processing
-
-;;;_ - Fundamental
-;;;_ > outline-flag-region (from to flag)
-(defmacro outline-flag-region (from to flag)
- "Hides or shows lines from FROM to TO, according to
-emacs selective-display FLAG char. Ie, text following flag C-m
-\(carriage-return) is hidden until the next C-j (newline) char.
-
-Returns nil iff no changes were effected."
- (` (let ((buffer-read-only nil)
- (outline-override-protect t))
- (subst-char-in-region (, from) (, to)
- (if (= (, flag) ?\n) ?\r ?\n)
- (, flag) t))))
-;;;_ > outline-flag-current-subtree (flag)
-(defun outline-flag-current-subtree (flag)
- (save-excursion
- (outline-back-to-current-heading)
- (outline-flag-region (point)
- (progn (outline-end-of-current-subtree) (1- (point)))
- flag)))
-
-;;;_ - Mapping and processing of topics
-;;;_ " See also chart functions, in navigation
-;;;_ > outline-listify-exposed (&optional start end)
-(defun outline-listify-exposed (&optional start end)
- "Produce a list representing exposed topics in current region.
-This list can then be used by 'outline-process-exposed' to manipulate
-the subject region.
+;;;_ #6 Exposure Control
-List is composed of elements that may themselves be lists representing
-exposed components in subtopic.
+;;;_ - Fundamental
+;;;_ > allout-flag-current-subtree (flag)
+(defun allout-flag-current-subtree (flag)
+ "Hide or show subtree of currently-visible topic.
-Each component list contains:
- - a number representing the depth of the topic,
- - a string representing the header-prefix (ref. 'outline-header-prefix'),
- - a string representing the bullet character,
- - and a series of strings, each containing one line of the exposed
- portion of the topic entry."
+See `allout-flag-region' for more details."
- (interactive "r")
(save-excursion
- (let* (strings pad result depth bullet beg next done) ; State vars.
- (goto-char start)
- (beginning-of-line)
- (if (not (outline-goto-prefix)) ; Get initial position within a topic:
- (outline-next-visible-heading 1))
- (while (and (not done)
- (not (eobp)) ; Loop until we've covered the region.
- (not (> (point) end)))
- (setq depth (outline-recent-depth) ; Current topics' depth,
- bullet (outline-recent-bullet) ; ... bullet,
- beg (progn (outline-end-of-prefix t) (point))) ; and beginning.
- (setq done ; The boundary for the current topic:
- (not (outline-next-visible-heading 1)))
- (beginning-of-line)
- (setq next (point))
- (goto-char beg)
- (setq strings nil)
- (while (> next (point)) ; Get all the exposed text in
- (setq strings
- (cons (buffer-substring
- beg
- ;To hidden text or end of line:
- (progn
- (search-forward "\r"
- (save-excursion (end-of-line)
- (point))
- 1)
- (if (= (preceding-char) ?\r)
- (1- (point))
- (point))))
- strings))
- (if (< (point) next) ; Resume from after hid text, if any.
- (forward-line 1))
- (setq beg (point)))
- ;; Accumulate list for this topic:
- (setq result
- (cons (append (list depth
- outline-header-prefix
- bullet)
- (nreverse strings))
- result)))
- ;; Put the list with first at front, to last at back:
- (nreverse result))))
-;;;_ > outline-process-exposed (arg &optional tobuf)
-(defun outline-process-exposed (&optional func from to frombuf tobuf)
- "Apply FUNCTION \(default 'outline-insert-listified) to exposed
-portions FROM position TO position \(default region, or the entire
-buffer if no region active) in buffer FROMBUF \(default current
-buffer) to buffer TOBUF \(default is buffer named like frombuf but
-with \"*\" prepended and \" exposed*\" appended).
-
-The function must as its arguments the elements of the list
-representations of topic entries produced by outline-listify-exposed."
-
- ; Resolve arguments,
- ; defaulting if necessary:
- (if (not func) (setq func 'outline-insert-listified))
- (if (not (and from to))
- (if mark-active
- (setq from (region-beginning) to (region-end))
- (setq from (point-min) to (point-max))))
- (if frombuf
- (if (not (bufferp frombuf))
- ;; Specified but not a buffer - get it:
- (let ((got (get-buffer frombuf)))
- (if (not got)
- (error (concat "outline-process-exposed: source buffer "
- frombuf
- " not found."))
- (setq frombuf got))))
- ;; not specified - default it:
- (setq frombuf (current-buffer)))
- (if tobuf
- (if (not (bufferp tobuf))
- (setq tobuf (get-buffer-create tobuf)))
- ;; not specified - default it:
- (setq tobuf (concat "*" (buffer-name frombuf) " exposed*")))
-
- (let* ((listified (progn (set-buffer frombuf)
- (outline-listify-exposed from to)))
- (prefix outline-header-prefix) ; ... as set in frombuf.
- curr)
- (set-buffer tobuf)
- (while listified
- (setq curr (car listified))
- (setq listified (cdr listified))
- (apply func (list (car curr) ; depth
- (car (cdr curr)) ; header-prefix
- (car (cdr (cdr curr))) ; bullet
- (cdr (cdr (cdr curr)))))) ; list of text lines
- (pop-to-buffer tobuf)))
+ (allout-back-to-current-heading)
+ (allout-flag-region (point)
+ (progn (allout-end-of-current-subtree) (1- (point)))
+ flag)))
;;;_ - Topic-specific
-;;;_ > outline-show-entry ()
-; outline-show-entry basically for isearch dynamic exposure, as is...
-(defun outline-show-entry ()
- "Like outline-show-current-entry, but reveals an entry that is nested
-within hidden topics.
+;;;_ > allout-show-entry ()
+(defun allout-show-entry ()
+ "Like `allout-show-current-entry', reveals entries nested in hidden topics.
This is a way to give restricted peek at a concealed locality without the
expense of exposing its context, but can leave the outline with aberrant
-exposure. outline-hide-current-entry-completely or outline-show-offshoot
+exposure. `allout-hide-current-entry-completely' or `allout-show-to-offshoot'
should be used after the peek to rectify the exposure."
(interactive)
(save-excursion
- (outline-goto-prefix)
- (outline-flag-region (if (bobp) (point) (1- (point)))
- (or (outline-pre-next-preface) (point))
- ?\n)))
-;;;_ > outline-show-children (&optional level strict)
-(defun outline-show-children (&optional level strict)
+ (let ((at (point))
+ beg end)
+ (allout-goto-prefix)
+ (setq beg (if (= (preceding-char) ?\r) (1- (point)) (point)))
+ (re-search-forward "[\n\r]" nil t)
+ (setq end (1- (if (< at (point))
+ ;; We're on topic head line - show only it:
+ (point)
+ ;; or we're in body - include it:
+ (max beg (or (allout-pre-next-preface) (point))))))
+ (allout-flag-region beg end ?\n)
+ (list beg end))))
+;;;_ > allout-show-children (&optional level strict)
+(defun allout-show-children (&optional level strict)
"If point is visible, show all direct subheadings of this heading.
-Otherwise, do outline-show-to-offshoot, and then show subheadings.
+
+Otherwise, do `allout-show-to-offshoot', and then show subheadings.
Optional LEVEL specifies how many levels below the current level
should be shown, or all levels if t. Default is 1.
Optional STRICT means don't resort to -show-to-offshoot, no matter
what. This is basically so -show-to-offshoot, which is called by
this function, can employ the pure offspring-revealing capabilities of
-it."
+it.
- (interactive "p")
- (if (and (not strict)
- (outline-hidden-p))
+Returns point at end of subtree that was opened, if any. (May get a
+point of non-opened subtree?)"
- (progn (outline-show-to-offshoot) ; Point's concealed, open to expose it.
- ;; Then recurse, but with "strict" set so we don't
- ;; infinite regress:
- (outline-show-children level t))
+ (interactive "p")
+ (let (max-pos)
+ (if (and (not strict)
+ (allout-hidden-p))
- (save-excursion
- (save-restriction
- (let* ((start-pt (point))
- (chart (outline-chart-subtree))
- (e-o-subtree (point))
- (to-reveal (outline-chart-to-reveal chart (or level 1))))
- (goto-char start-pt)
- (if (and strict (= (preceding-char) ?\r))
- ;; Concealed root would already have been taken care of,
- ;; unless strict was set.
- (outline-flag-region (point) (outline-snug-back) ?\n))
- (while to-reveal
- (goto-char (car to-reveal))
- (outline-flag-region (point) (outline-snug-back) ?\n)
- (setq to-reveal (cdr to-reveal))))))))
-;;;_ x outline-show-current-children (&optional level strict)
-(defun outline-show-current-children (&optional level strict)
- "This command was misnamed, 'outline-show-children' is the proper
-name. Use it instead.
-
-\(The \"current\" in the name is supposed to imply that it works on
-the visible topic containing point, while it really works with respect
-to the most immediate topic, concealed or not. I'll leave this old
-name around for a bit, but i'll soon activate an annoying message to
-warn people about the change, and then deprecate this alias."
+ (progn (allout-show-to-offshoot) ; Point's concealed, open to
+ ; expose it.
+ ;; Then recurse, but with "strict" set so we don't
+ ;; infinite regress:
+ (setq max-pos (allout-show-children level t)))
- (interactive "p")
- ;;(beep)
- ;;(message (format "Use '%s' instead of '%s' (%s)."
- ;; "outline-show-children"
- ;; "outline-show-current-children"
- ;; (buffer-name (current-buffer))))
- (outline-show-children level strict))
-;;;_ > outline-hide-point-reconcile ()
-(defun outline-hide-reconcile ()
- "Like outline-hide-current-entry, but hides completely if contained within
-hidden region.
+ (save-excursion
+ (save-restriction
+ (let* ((start-pt (point))
+ (chart (allout-chart-subtree (or level 1)))
+ (to-reveal (allout-chart-to-reveal chart (or level 1))))
+ (goto-char start-pt)
+ (if (and strict (= (preceding-char) ?\r))
+ ;; Concealed root would already have been taken care of,
+ ;; unless strict was set.
+ (progn
+ (allout-flag-region (point) (allout-snug-back) ?\n)
+ (if allout-show-bodies
+ (progn (goto-char (car to-reveal))
+ (allout-show-current-entry)))))
+ (while to-reveal
+ (goto-char (car to-reveal))
+ (allout-flag-region (point) (allout-snug-back) ?\n)
+ (if allout-show-bodies
+ (progn (goto-char (car to-reveal))
+ (allout-show-current-entry)))
+ (setq to-reveal (cdr to-reveal)))))))))
+;;;_ > allout-hide-point-reconcile ()
+(defun allout-hide-reconcile ()
+ "Like `allout-hide-current-entry'; hides completely if within hidden region.
Specifically intended for aberrant exposure states, like entries that were
-exposed by outline-show-entry but are within otherwise concealed regions."
+exposed by `allout-show-entry' but are within otherwise concealed regions."
(interactive)
(save-excursion
- (outline-goto-prefix)
- (outline-flag-region (if (not (bobp)) (1- (point)) (point))
- (progn (outline-pre-next-preface)
+ (allout-goto-prefix)
+ (allout-flag-region (if (not (bobp)) (1- (point)) (point))
+ (progn (allout-pre-next-preface)
(if (= ?\r (following-char))
(point)
(1- (point))))
?\r)))
-;;;_ > outline-show-to-offshoot ()
-(defun outline-show-to-offshoot ()
- "Like outline-show-entry, but reveals opens all concealed ancestors,
-as well.
+;;;_ > allout-show-to-offshoot ()
+(defun allout-show-to-offshoot ()
+ "Like `allout-show-entry', but reveals all concealed ancestors, as well.
-Like outline-hide-current-entry-completely, useful for rectifying aberrant
-exposure states produced by outline-show-entry."
+As with `allout-hide-current-entry-completely', useful for rectifying
+aberrant exposure states produced by `allout-show-entry'."
(interactive)
(save-excursion
(let ((orig-pt (point))
- (orig-pref (outline-goto-prefix))
+ (orig-pref (allout-goto-prefix))
(last-at (point))
bag-it)
(while (or bag-it (= (preceding-char) ?\r))
;; Oops, we're not making any progress! Show the current
;; topic completely, and bag this try.
(progn (beginning-of-line)
- (outline-show-current-subtree)
+ (allout-show-current-subtree)
(goto-char orig-pt)
(setq bag-it t)
(beep)
(message "%s: %s"
- "outline-show-to-offshoot: "
+ "allout-show-to-offshoot: "
"Aberrant nesting encountered.")))
- (outline-show-children)
+ (allout-show-children)
(goto-char orig-pref))
- (goto-char orig-pt)
- (outline-show-entry))))
-;;;_ > outline-hide-current-entry ()
-(defun outline-hide-current-entry ()
+ (goto-char orig-pt)))
+ (if (allout-hidden-p)
+ (allout-show-entry)))
+;;;_ > allout-hide-current-entry ()
+(defun allout-hide-current-entry ()
"Hide the body directly following this heading."
(interactive)
- (outline-back-to-current-heading)
+ (allout-back-to-current-heading)
(save-excursion
- (outline-flag-region (point)
- (progn (outline-end-of-current-entry) (point))
- ?\^M)))
-;;;_ > outline-show-current-entry (&optional arg)
-(defun outline-show-current-entry (&optional arg)
+ (allout-flag-region (point)
+ (progn (allout-end-of-current-entry) (point))
+ ?\r)))
+;;;_ > allout-show-current-entry (&optional arg)
+(defun allout-show-current-entry (&optional arg)
- "Show body following current heading, or hide the entry if repeat
-count."
+ "Show body following current heading, or hide the entry if repeat count."
(interactive "P")
(if arg
- (outline-hide-current-entry)
+ (allout-hide-current-entry)
(save-excursion
- (outline-flag-region (point)
- (progn (outline-end-of-current-entry) (point))
- ?\n))))
-;;;_ > outline-hide-current-entry-completely ()
-; ... outline-hide-current-entry-completely also for isearch dynamic exposure:
-(defun outline-hide-current-entry-completely ()
- "Like outline-hide-current-entry, but conceal topic completely.
+ (allout-flag-region (point)
+ (progn (allout-end-of-current-entry) (point))
+ ?\n))))
+;;;_ > allout-hide-current-entry-completely ()
+; ... allout-hide-current-entry-completely also for isearch dynamic exposure:
+(defun allout-hide-current-entry-completely ()
+ "Like `allout-hide-current-entry', but conceal topic completely.
Specifically intended for aberrant exposure states, like entries that were
-exposed by outline-show-entry but are within otherwise concealed regions."
+exposed by `allout-show-entry' but are within otherwise concealed regions."
(interactive)
(save-excursion
- (outline-goto-prefix)
- (outline-flag-region (if (not (bobp)) (1- (point)) (point))
- (progn (outline-pre-next-preface)
+ (allout-goto-prefix)
+ (allout-flag-region (if (not (bobp)) (1- (point)) (point))
+ (progn (allout-pre-next-preface)
(if (= ?\r (following-char))
(point)
(1- (point))))
?\r)))
-;;;_ > outline-show-current-subtree ()
-(defun outline-show-current-subtree ()
- "Show everything after this heading at deeper levels."
- (interactive)
- (outline-flag-current-subtree ?\n))
-;;;_ > outline-hide-current-subtree (&optional just-close)
-(defun outline-hide-current-subtree (&optional just-close)
-
- "Hide everything after this heading at deeper levels, or if it's
-already closed, and optional arg JUST-CLOSE is nil, hide the current
-level."
+;;;_ > allout-show-current-subtree (&optional arg)
+(defun allout-show-current-subtree (&optional arg)
+ "Show everything within the current topic. With a repeat-count,
+expose this topic and its siblings."
+ (interactive "P")
+ (save-excursion
+ (if (<= (allout-current-depth) 0)
+ ;; Outside any topics - try to get to the first:
+ (if (not (allout-next-heading))
+ (error "No topics")
+ ;; got to first, outermost topic - set to expose it and siblings:
+ (message "Above outermost topic - exposing all.")
+ (allout-flag-region (point-min)(point-max) ?\n))
+ (if (not arg)
+ (allout-flag-current-subtree ?\n)
+ (allout-beginning-of-level)
+ (allout-expose-topic '(* :))))))
+;;;_ > allout-hide-current-subtree (&optional just-close)
+(defun allout-hide-current-subtree (&optional just-close)
+ "Close the current topic, or containing topic if this one is already closed.
+
+If this topic is closed and it's a top level topic, close this topic
+and its siblings.
+
+If optional arg JUST-CLOSE is non-nil, do not treat the parent or
+siblings, even if the target topic is already closed."
(interactive)
- (let ((orig-eol (save-excursion
- (end-of-line)(outline-goto-prefix)(end-of-line)(point))))
- (outline-flag-current-subtree ?\^M)
- (if (and (= orig-eol (save-excursion (goto-char orig-eol)
- (end-of-line)
- (point)))
+ (let ((from (point))
+ (orig-eol (progn (end-of-line)
+ (if (not (allout-goto-prefix))
+ (error "No topics found")
+ (end-of-line)(point)))))
+ (allout-flag-current-subtree ?\r)
+ (goto-char from)
+ (if (and (= orig-eol (progn (goto-char orig-eol)
+ (end-of-line)
+ (point)))
+ (not just-close)
;; Structure didn't change - try hiding current level:
- (if (not just-close)
- (outline-up-current-level 1 t)))
- (outline-hide-current-subtree))))
-;;;_ > outline-show-current-branches ()
-(defun outline-show-current-branches ()
+ (goto-char from)
+ (if (allout-up-current-level 1 t)
+ t
+ (goto-char 0)
+ (let ((msg
+ "Top-level topic already closed - closing siblings..."))
+ (message msg)
+ (allout-expose-topic '(0 :))
+ (message (concat msg " Done.")))
+ nil)
+ (/= (allout-recent-depth) 0))
+ (allout-hide-current-subtree))
+ (goto-char from)))
+;;;_ > allout-show-current-branches ()
+(defun allout-show-current-branches ()
"Show all subheadings of this heading, but not their bodies."
(interactive)
(beginning-of-line)
- (outline-show-children t))
-;;;_ > outline-hide-current-leaves ()
-(defun outline-hide-current-leaves ()
- "Hide the bodies of the current topic and all its' offspring."
+ (allout-show-children t))
+;;;_ > allout-hide-current-leaves ()
+(defun allout-hide-current-leaves ()
+ "Hide the bodies of the current topic and all its offspring."
(interactive)
- (outline-back-to-current-heading)
- (outline-hide-region-body (point) (progn (outline-end-of-current-subtree)
+ (allout-back-to-current-heading)
+ (allout-hide-region-body (point) (progn (allout-end-of-current-subtree)
(point))))
;;;_ - Region and beyond
-;;;_ > outline-show-all ()
-(defun outline-show-all ()
+;;;_ > allout-show-all ()
+(defun allout-show-all ()
"Show all of the text in the buffer."
(interactive)
- (outline-flag-region (point-min) (point-max) ?\n))
-;;;_ > outline-hide-bodies ()
-(defun outline-hide-bodies ()
+ (message "Exposing entire buffer...")
+ (allout-flag-region (point-min) (point-max) ?\n)
+ (message "Exposing entire buffer... Done."))
+;;;_ > allout-hide-bodies ()
+(defun allout-hide-bodies ()
"Hide all of buffer except headings."
(interactive)
- (outline-hide-region-body (point-min) (point-max)))
-;;;_ > outline-hide-region-body (start end)
-(defun outline-hide-region-body (start end)
+ (allout-hide-region-body (point-min) (point-max)))
+;;;_ > allout-hide-region-body (start end)
+(defun allout-hide-region-body (start end)
"Hide all body lines in the region, but not headings."
(save-excursion
(save-restriction
(narrow-to-region start end)
(goto-char (point-min))
(while (not (eobp))
- (outline-flag-region (point)
- (progn (outline-pre-next-preface) (point)) ?\^M)
+ (allout-flag-region (point)
+ (progn (allout-pre-next-preface) (point)) ?\r)
(if (not (eobp))
(forward-char
(if (looking-at "[\n\r][\n\r]")
2 1)))))))
-;;;_ > outline-expose-topic (spec &optional prev-spec)
-(defun outline-expose-topic (spec &optional prev-spec)
- "Dictate wholesale exposure scheme for current level.
+;;;_ > allout-expose-topic (spec)
+(defun allout-expose-topic (spec)
+ "Apply exposure specs to successive outline topic items.
-Unless you want the args to be evaluated, you probably want to use the
-frontend `outline-new-exposure', instead.
+Use the more convenient frontend, `allout-new-exposure', if you don't
+need evaluation of the arguments, or even better, the `allout-layout'
+variable-keyed mode-activation/auto-exposure feature of allout outline
+mode. See the respective documentation strings for more details.
Cursor is left at start position.
-SPEC is either a number or, recursively, a list.
+SPEC is either a number or a list.
+
+Successive specs on a list are applied to successive sibling topics.
A simple spec \(either a number, one of a few symbols, or the null
-list) dictates the overall exposure for the current topic.
+list) dictates the exposure for the corresponding topic.
+
+Non-null lists recursively designate exposure specs for respective
+subtopics of the current topic.
-Non null lists are complex specs, designating exposure for the current
-topic and its respective siblings. The ':' repeat spec is used to
-specify exposure for any number of successive siblings, up to the
-trailing ones for which there are explicit specs following the ':'.
+The `:' repeat spec is used to specify exposure for any number of
+successive siblings, up to the trailing ones for which there are
+explicit specs following the `:'.
Simple (numeric and null-list) specs are interpreted as follows:
- - Numbers indicate the relative depth to open the corresponding topic.
- - negative numbers force the topic to be closed before opening to the
- absolute value of the number, so all siblings are open only to
- that level.
- - positive numbers open to the relative depth indicated by the
- number, but do not force already opened subtopics to be closed.
- - 0 means to close topic - hide all offspring.
- - ':' 'repeat'
+ Numbers indicate the relative depth to open the corresponding topic.
+ - negative numbers force the topic to be closed before opening to the
+ absolute value of the number, so all siblings are open only to
+ that level.
+ - positive numbers open to the relative depth indicated by the
+ number, but do not force already opened subtopics to be closed.
+ - 0 means to close topic - hide all offspring.
+ : - `repeat'
apply prior element to all siblings at current level, *up to*
- those siblings that would be covered by specs following the ':'
+ those siblings that would be covered by specs following the `:'
on the list. Ie, apply to all topics at level but the last
ones. \(Only first of multiple colons at same level is
respected - subsequent ones are discarded.)
- - '*' completely opens the topic, including bodies.
- - '+' shows all the sub headers, but not the bodies
- - '-' exposes the body and immediate offspring of the corresponding topic.
-
-If the spec is a list, the first element must be a number, which
-dictates the exposure depth of the topic as a whole. Subsequent
-elements of the list are nested SPECs, dictating the specific exposure
-for the corresponding offspring of the topic.
+ * - completely opens the topic, including bodies.
+ + - shows all the sub headers, but not the bodies
+ - - exposes the body of the corresponding topic.
Examples:
-\(outline-expose-topic '(-1 : 0))
+\(allout-expose-topic '(-1 : 0))
Close this and all following topics at current level, exposing
only their immediate children, but close down the last topic
at this current level completely.
-\(outline-expose-topic '(-1 () : 1 0))
+\(allout-expose-topic '(-1 () : 1 0))
Close current topic so only the immediate subtopics are shown;
show the children in the second to last topic, and completely
close the last one.
-\(outline-expose-topic -2 ': -1 '*))
+\(allout-expose-topic '(-2 : -1 *))
Expose children and grandchildren of all topics at current
level except the last two; expose children of the second to
last and completely open the last one."
(interactive "xExposure spec: ")
- (let ((depth (outline-current-depth))
- done
- max-pos)
- (cond ((null spec) nil)
- ((symbolp spec)
- (cond ((eq spec '*) (outline-show-current-subtree))
- ((eq spec '+) (outline-show-current-branches))
- ((eq spec '-) (outline-show-current-entry))
- ((eq spec ':)
- ;; Whoops. ':' should have been caught at superior
- ;; level.
- (error
- "outline-expose-topic: improper exposure spec - bare ':'"))))
- ((numberp spec)
- (if (>= 0 spec)
- (save-excursion (outline-hide-current-subtree t)
- (end-of-line)
- (if (or (not max-pos)
- (> (point) max-pos))
- (setq max-pos (point)))
- (if (> 0 spec)
- (setq spec (* -1 spec)))))
- (if (> spec 0)
- (outline-show-children spec)))
- ((listp spec)
- (if (eq (car spec) ':)
- (setq spec
- ;; Expand the 'repeat' spec to an explicit version,
- ;; w.r.t. remaining siblings:
- (let* (;; Assign rest-spec to preserve first elem in cdr.
- (rest-spec (delq ': (cdr spec)))
- ;; residue: # of sibs not covered by remaining spec
- (residue (- (length (outline-chart-siblings))
- (length rest-spec))))
- (if (>= 0 residue)
- ;; remaining spec covers all - just use it:
- rest-spec
- ;; cover residue by prev-spec, rest by rest-spec:
- (nconc (make-list residue prev-spec) rest-spec)))))
- (setq max-pos (or (outline-expose-topic (car spec) prev-spec)
- max-pos))
- (setq prev-spec (car spec))
- (setq spec (cdr spec))
- (and
- (if max-pos
- ;; Capitalize on max-pos state to get us nearer next sibling:
- (progn (goto-char (min (point-max) max-pos))
- (outline-next-heading))
- (outline-next-sibling depth))
- (let ((got (outline-expose-topic spec prev-spec)))
- (if (and got (or (not max-pos) (> got max-pos)))
- (setq max-pos got))))))
- max-pos))
-;;;_ > outline-old-expose-topic (spec &rest followers)
-(defun outline-old-expose-topic (spec &rest followers)
-
- "Dictate wholesale exposure scheme for current topic, according to SPEC.
+ (if (not (listp spec))
+ nil
+ (let ((depth (allout-depth))
+ (max-pos 0)
+ prev-elem curr-elem
+ stay done
+ snug-back
+ )
+ (while spec
+ (setq prev-elem curr-elem
+ curr-elem (car spec)
+ spec (cdr spec))
+ (cond ; Do current element:
+ ((null curr-elem) nil)
+ ((symbolp curr-elem)
+ (cond ((eq curr-elem '*) (allout-show-current-subtree)
+ (if (> allout-recent-end-of-subtree max-pos)
+ (setq max-pos allout-recent-end-of-subtree)))
+ ((eq curr-elem '+) (allout-show-current-branches)
+ (if (> allout-recent-end-of-subtree max-pos)
+ (setq max-pos allout-recent-end-of-subtree)))
+ ((eq curr-elem '-) (allout-show-current-entry))
+ ((eq curr-elem ':)
+ (setq stay t)
+ ;; Expand the `repeat' spec to an explicit version,
+ ;; w.r.t. remaining siblings:
+ (let ((residue ; = # of sibs not covered by remaining spec
+ ;; Dang - could be nice to make use of the chart, sigh:
+ (- (length (allout-chart-siblings))
+ (length spec))))
+ (if (< 0 residue)
+ ;; Some residue - cover it with prev-elem:
+ (setq spec (append (make-list residue prev-elem)
+ spec)))))))
+ ((numberp curr-elem)
+ (if (and (>= 0 curr-elem) (allout-visible-p))
+ (save-excursion (allout-hide-current-subtree t)
+ (if (> 0 curr-elem)
+ nil
+ (if (> allout-recent-end-of-subtree max-pos)
+ (setq max-pos
+ allout-recent-end-of-subtree)))))
+ (if (> (abs curr-elem) 0)
+ (progn (allout-show-children (abs curr-elem))
+ (if (> allout-recent-end-of-subtree max-pos)
+ (setq max-pos allout-recent-end-of-subtree)))))
+ ((listp curr-elem)
+ (if (allout-descend-to-depth (1+ depth))
+ (let ((got (allout-expose-topic curr-elem)))
+ (if (and got (> got max-pos)) (setq max-pos got))))))
+ (cond (stay (setq stay nil))
+ ((listp (car spec)) nil)
+ ((> max-pos (point))
+ ;; Capitalize on max-pos state to get us nearer next sibling:
+ (progn (goto-char (min (point-max) max-pos))
+ (allout-next-heading)))
+ ((allout-next-sibling depth))))
+ max-pos)))
+;;;_ > allout-old-expose-topic (spec &rest followers)
+(defun allout-old-expose-topic (spec &rest followers)
+
+ "Deprecated. Use `allout-expose-topic' \(with different schema
+format) instead.
+
+Dictate wholesale exposure scheme for current topic, according to SPEC.
SPEC is either a number or a list. Optional successive args
dictate exposure for subsequent siblings of current topic.
absolute value of the number.
- positive numbers just open to the relative depth indicated by the number.
- 0 just closes
- - '*' completely opens the topic, including bodies.
- - '+' shows all the sub headers, but not the bodies
- - '-' exposes the body and immediate offspring of the corresponding topic.
+ - `*' completely opens the topic, including bodies.
+ - `+' shows all the sub headers, but not the bodies
+ - `-' exposes the body and immediate offspring of the corresponding topic.
If the spec is a list, the first element must be a number, which
dictates the exposure depth of the topic as a whole. Subsequent
Optional FOLLOWER arguments dictate exposure for succeeding siblings."
(interactive "xExposure spec: ")
- (let ((depth (outline-current-depth))
+ (let ((depth (allout-current-depth))
done
max-pos)
(cond ((null spec) nil)
((symbolp spec)
- (if (eq spec '*) (outline-show-current-subtree))
- (if (eq spec '+) (outline-show-current-branches))
- (if (eq spec '-) (outline-show-current-entry)))
+ (if (eq spec '*) (allout-show-current-subtree))
+ (if (eq spec '+) (allout-show-current-branches))
+ (if (eq spec '-) (allout-show-current-entry)))
((numberp spec)
(if (>= 0 spec)
- (save-excursion (outline-hide-current-subtree t)
+ (save-excursion (allout-hide-current-subtree t)
(end-of-line)
(if (or (not max-pos)
(> (point) max-pos))
(if (> 0 spec)
(setq spec (* -1 spec)))))
(if (> spec 0)
- (outline-show-children spec)))
+ (allout-show-children spec)))
((listp spec)
- ;(let ((got (outline-old-expose-topic (car spec))))
+ ;(let ((got (allout-old-expose-topic (car spec))))
; (if (and got (or (not max-pos) (> got max-pos)))
; (setq max-pos got)))
- (let ((new-depth (+ (outline-current-depth) 1))
+ (let ((new-depth (+ (allout-current-depth) 1))
got)
- (setq max-pos (outline-old-expose-topic (car spec)))
+ (setq max-pos (allout-old-expose-topic (car spec)))
(setq spec (cdr spec))
(if (and spec
- (outline-descend-to-depth new-depth)
- (not (outline-hidden-p)))
- (progn (setq got (apply 'outline-old-expose-topic spec))
+ (allout-descend-to-depth new-depth)
+ (not (allout-hidden-p)))
+ (progn (setq got (apply 'allout-old-expose-topic spec))
(if (and got (or (not max-pos) (> got max-pos)))
(setq max-pos got)))))))
(while (and followers
(progn (goto-char max-pos)
(setq max-pos nil)))
(end-of-line)
- (outline-next-sibling depth)))
- (outline-old-expose-topic (car followers))
+ (allout-next-sibling depth)))
+ (allout-old-expose-topic (car followers))
(setq followers (cdr followers)))
max-pos))
-;;;_ > outline-new-exposure '()
-(defmacro outline-new-exposure (&rest spec)
- "Literal frontend for `outline-expose-topic', doesn't evaluate arguments.
-All arguments that would need to be quoted in outline-expose-topic need not
-be in outline-exposure.
+;;;_ > allout-new-exposure '()
+(defmacro allout-new-exposure (&rest spec)
+ "Literal frontend for `allout-expose-topic', doesn't evaluate arguments.
+Some arguments that would need to be quoted in `allout-expose-topic'
+need not be quoted in `allout-new-exposure'.
Cursor is left at start position.
-Use this instead of obsolete 'outline-exposure'.
+Use this instead of obsolete `allout-exposure'.
Examples:
-\(outline-exposure (-1 () () () 1) 0)
+\(allout-exposure (-1 () () () 1) 0)
Close current topic at current level so only the immediate
subtopics are shown, except also show the children of the
third subtopic; and close the next topic at the current level.
-\(outline-exposure : -1 0)
+\(allout-exposure : -1 0)
Close all topics at current level to expose only their
immediate children, except for the last topic at the current
- level, in which even its' immediate children are hidden.
-\(outline-exposure -2 : -1 *)
+ level, in which even its immediate children are hidden.
+\(allout-exposure -2 : -1 *)
Expose children and grandchildren of first topic at current
level, and expose children of subsequent topics at current
level *except* for the last, which should be opened completely."
(list 'save-excursion
- '(if (not (or (outline-goto-prefix)
- (outline-next-heading)))
- (error "outline-exposure: Can't find any outline topics."))
- (list 'outline-expose-topic (list 'quote spec))))
-;;;_ > outline-exposure '()
-(defmacro outline-exposure (&rest spec)
- "Being deprecated - use more recent 'outline-new-exposure' instead.
-
-Literal frontend for `outline-old-expose-topic', doesn't evaluate arguments
+ '(if (not (or (allout-goto-prefix)
+ (allout-next-heading)))
+ (error "allout-new-exposure: Can't find any outline topics"))
+ (list 'allout-expose-topic (list 'quote spec))))
+;;;_ > allout-exposure '()
+(defmacro allout-exposure (&rest spec)
+ "Being deprecated - use more recent `allout-new-exposure' instead.
+
+Literal frontend for `allout-old-expose-topic', doesn't evaluate arguments
and retains start position."
(list 'save-excursion
- '(if (not (or (outline-goto-prefix)
- (outline-next-heading)))
- (error "Can't find any outline topics."))
- (cons 'outline-old-expose-topic
- (mapcar '(lambda (x) (list 'quote x)) spec))))
-
-;;;_ #6 Search with Dynamic Exposure (requires v19 isearch or isearch-mode)
-;;;_ = outline-search-reconceal
-(defvar outline-search-reconceal nil
- "Used for outline isearch provisions, to track whether current search
-match was concealed outside of search. The value is the location of the
-match, if it was concealed, regular if the entire topic was concealed, in
-a list if the entry was concealed.")
-;;;_ = outline-search-quitting
-(defconst outline-search-quitting nil
- "Variable used by isearch-terminate/outline-provisions and
-isearch-done/outline-provisions to distinguish between a conclusion
-and cancellation of a search.")
-
-
-;;;_ > outline-enwrap-isearch ()
-(defun outline-enwrap-isearch ()
- "Impose isearch-mode wrappers so isearch progressively exposes and
-reconceals hidden topics when working in outline mode, but works
-elsewhere.
-
-The function checks to ensure that the rebindings are done only once."
-
- ; Should isearch-mode be employed,
- (if (or (not outline-enwrap-isearch-mode)
- ; or are preparations already done?
- (fboundp 'real-isearch-terminate))
-
- ;; ... no - skip this all:
- nil
+ '(if (not (or (allout-goto-prefix)
+ (allout-next-heading)))
+ (error "Can't find any outline topics"))
+ (cons 'allout-old-expose-topic
+ (mapcar (function (lambda (x) (list 'quote x))) spec))))
- ;; ... yes:
+;;;_ #7 Systematic outline presentation - copying, printing, flattening
- ; Ensure load of isearch-mode:
- (if (or (and (fboundp 'isearch-mode)
- (fboundp 'isearch-quote-char))
- (condition-case error
- (load-library outline-enwrap-isearch-mode)
- (file-error (message "Skipping isearch-mode provisions - %s '%s'"
- (car (cdr error))
- (car (cdr (cdr error))))
- (sit-for 1)
- ;; Inhibit subsequent tries and return nil:
- (setq outline-enwrap-isearch-mode nil))))
- ;; Isearch-mode loaded, encapsulate specific entry points for
- ;; outline dynamic-exposure business:
- (progn
-
- ; stash crucial isearch-mode
- ; funcs under known, private
- ; names, then register wrapper
- ; functions under the old
- ; names, in their stead:
- ; 'isearch-quit' is pre v 1.2:
- (fset 'real-isearch-terminate
- ; 'isearch-quit is pre v 1.2:
- (or (if (fboundp 'isearch-quit)
- (symbol-function 'isearch-quit))
- (if (fboundp 'isearch-abort)
- ; 'isearch-abort' is v 1.2 and on:
- (symbol-function 'isearch-abort))))
- (fset 'isearch-quit 'isearch-terminate/outline-provisions)
- (fset 'isearch-abort 'isearch-terminate/outline-provisions)
- (fset 'real-isearch-done (symbol-function 'isearch-done))
- (fset 'isearch-done 'isearch-done/outline-provisions)
- (fset 'real-isearch-update (symbol-function 'isearch-update))
- (fset 'isearch-update 'isearch-update/outline-provisions)
- (make-variable-buffer-local 'outline-search-reconceal)))))
-;;;_ > outline-isearch-arrival-business ()
-(defun outline-isearch-arrival-business ()
- "Do outline business like exposing current point, if necessary,
-registering reconcealment requirements in outline-search-reconceal
-accordingly.
-
-Set outline-search-reconceal to nil if current point is not
-concealed, to value of point if entire topic is concealed, and a
-list containing point if only the topic body is concealed.
-
-This will be used to determine whether outline-hide-current-entry
-or outline-hide-current-entry-completely will be necessary to
-restore the prior concealment state."
-
- (if (outline-mode-p)
- (setq outline-search-reconceal
- (if (outline-hidden-p)
- (save-excursion
- (if (re-search-backward outline-line-boundary-regexp nil 1)
- ;; Nil value means we got to b-o-b - wouldn't need
- ;; to advance.
- (forward-char 1))
- ; We'll return point or list
- ; containing point, depending
- ; on concealment state of
- ; topic prefix.
- (prog1 (if (outline-hidden-p) (point) (list (point)))
- ; And reveal the current
- ; search target:
- (outline-show-entry)))))))
-;;;_ > outline-isearch-advancing-business ()
-(defun outline-isearch-advancing-business ()
- "Do outline business like deexposing current point, if necessary,
-according to reconceal state registration."
- (if (and (outline-mode-p) outline-search-reconceal)
- (save-excursion
- (if (listp outline-search-reconceal)
- ;; Leave the topic visible:
- (progn (goto-char (car outline-search-reconceal))
- (outline-hide-current-entry))
- ;; Rehide the entire topic:
- (goto-char outline-search-reconceal)
- (outline-hide-current-entry-completely)))))
-;;;_ > isearch-terminate/outline-provisions ()
-(defun isearch-terminate/outline-provisions ()
- (interactive)
- (if (and (outline-mode-p) outline-enwrap-isearch-mode)
- (outline-isearch-advancing-business))
- (let ((outline-search-quitting t)
- (outline-search-reconceal nil))
- (real-isearch-terminate)))
-;;;_ > isearch-done/outline-provisions ()
-(defun isearch-done/outline-provisions (&optional nopush)
- (interactive)
- (if (and (outline-mode-p) outline-enwrap-isearch-mode)
- (progn (if (and outline-search-reconceal
- (not (listp outline-search-reconceal)))
- ;; The topic was concealed - reveal it, its siblings,
- ;; and any ancestors that are still concealed:
- (save-excursion
- (message "(exposing destination)")(sit-for 0)
- (outline-goto-prefix)
- ; There may be a closed blank
- ; line between prior and
- ; current topic that would be
- ; missed - provide for it:
- (if (not (bobp))
- (progn (forward-char -1) ; newline
- (if (eq ?\r (preceding-char))
- (outline-flag-region (1- (point))
- (point)
- ?\n))
- (forward-char 1)))
- ; Goto parent
- (outline-ascend-to-depth (1- (outline-recent-depth)))
- (outline-show-children)))
- (if (and (boundp 'outline-search-quitting)
- outline-search-quitting)
- nil
- ; We're concluding abort:
- (outline-isearch-arrival-business)
- (outline-show-children))))
- (if nopush
- ;; isearch-done in newer version of isearch mode takes arg:
- (real-isearch-done nopush)
- (real-isearch-done)))
-;;;_ > isearch-update/outline-provisions ()
-(defun isearch-update/outline-provisions ()
- "Wrapper around isearch which exposes and conceals hidden outline
-portions encountered in the course of searching."
- (if (not (and (outline-mode-p) outline-enwrap-isearch-mode))
- ;; Just do the plain business:
- (real-isearch-update)
-
- ;; Ah - provide for outline conditions:
- (outline-isearch-advancing-business)
- (real-isearch-update)
- (cond (isearch-success (outline-isearch-arrival-business))
- ((not isearch-success) (outline-isearch-advancing-business)))))
-
-;;;_ #7 Copying and printing
+;;;_ - Mapping and processing of topics
+;;;_ ( See also Subtree Charting, in Navigation code.)
+;;;_ > allout-stringify-flat-index (flat-index)
+(defun allout-stringify-flat-index (flat-index &optional context)
+ "Convert list representing section/subsection/... to document string.
+
+Optional arg CONTEXT indicates interior levels to include."
+ (let ((delim ".")
+ result
+ numstr
+ (context-depth (or (and context 2) 1)))
+ ;; Take care of the explicit context:
+ (while (> context-depth 0)
+ (setq numstr (int-to-string (car flat-index))
+ flat-index (cdr flat-index)
+ result (if flat-index
+ (cons delim (cons numstr result))
+ (cons numstr result))
+ context-depth (if flat-index (1- context-depth) 0)))
+ (setq delim " ")
+ ;; Take care of the indentation:
+ (if flat-index
+ (progn
+ (while flat-index
+ (setq result
+ (cons delim
+ (cons (make-string
+ (1+ (truncate (if (zerop (car flat-index))
+ 1
+ (log10 (car flat-index)))))
+ ? )
+ result)))
+ (setq flat-index (cdr flat-index)))
+ ;; Dispose of single extra delim:
+ (setq result (cdr result))))
+ (apply 'concat result)))
+;;;_ > allout-stringify-flat-index-plain (flat-index)
+(defun allout-stringify-flat-index-plain (flat-index)
+ "Convert list representing section/subsection/... to document string."
+ (let ((delim ".")
+ result)
+ (while flat-index
+ (setq result (cons (int-to-string (car flat-index))
+ (if result
+ (cons delim result))))
+ (setq flat-index (cdr flat-index)))
+ (apply 'concat result)))
+;;;_ > allout-stringify-flat-index-indented (flat-index)
+(defun allout-stringify-flat-index-indented (flat-index)
+ "Convert list representing section/subsection/... to document string."
+ (let ((delim ".")
+ result
+ numstr)
+ ;; Take care of the explicit context:
+ (setq numstr (int-to-string (car flat-index))
+ flat-index (cdr flat-index)
+ result (if flat-index
+ (cons delim (cons numstr result))
+ (cons numstr result)))
+ (setq delim " ")
+ ;; Take care of the indentation:
+ (if flat-index
+ (progn
+ (while flat-index
+ (setq result
+ (cons delim
+ (cons (make-string
+ (1+ (truncate (if (zerop (car flat-index))
+ 1
+ (log10 (car flat-index)))))
+ ? )
+ result)))
+ (setq flat-index (cdr flat-index)))
+ ;; Dispose of single extra delim:
+ (setq result (cdr result))))
+ (apply 'concat result)))
+;;;_ > allout-listify-exposed (&optional start end format)
+(defun allout-listify-exposed (&optional start end format)
-;;;_ - Copy exposed
-;;;_ > outline-insert-listified (depth prefix bullet text)
-(defun outline-insert-listified (depth prefix bullet text)
- (insert-string (concat (if (> depth 1) prefix "")
- (make-string (1- depth) ?\ )
- bullet))
- (while text
- (insert-string (car text))
- (if (setq text (cdr text))
- (insert-string "\n")))
- (insert-string "\n"))
-;;;_ > outline-copy-exposed (arg &optional tobuf)
-(defun outline-copy-exposed (arg &optional tobuf)
- "Duplicate exposed portions of current topic to buffer with
-current buffers' name with \" exposed\" appended to it.
+ "Produce a list representing exposed topics in current region.
-With repeat count, copy the exposed portions of entire buffer."
+This list can then be used by `allout-process-exposed' to manipulate
+the subject region.
+
+Optional START and END indicate bounds of region.
+
+optional arg, FORMAT, designates an alternate presentation form for
+the prefix:
+
+ list - Present prefix as numeric section.subsection..., starting with
+ section indicated by the list, innermost nesting first.
+ `indent' \(symbol) - Convert header prefixes to all white space,
+ except for distinctive bullets.
+
+The elements of the list produced are lists that represents a topic
+header and body. The elements of that list are:
+
+ - a number representing the depth of the topic,
+ - a string representing the header-prefix, including trailing whitespace and
+ bullet.
+ - a string representing the bullet character,
+ - and a series of strings, each containing one line of the exposed
+ portion of the topic entry."
+
+ (interactive "r")
+ (save-excursion
+ (let*
+ ;; state vars:
+ (strings prefix pad result depth new-depth out gone-out bullet beg
+ next done)
+
+ (goto-char start)
+ (beginning-of-line)
+ ;; Goto initial topic, and register preceeding stuff, if any:
+ (if (> (allout-goto-prefix) start)
+ ;; First topic follows beginning point - register preliminary stuff:
+ (setq result (list (list 0 "" nil
+ (buffer-substring start (1- (point)))))))
+ (while (and (not done)
+ (not (eobp)) ; Loop until we've covered the region.
+ (not (> (point) end)))
+ (setq depth (allout-recent-depth) ; Current topics depth,
+ bullet (allout-recent-bullet) ; ... bullet,
+ prefix (allout-recent-prefix)
+ beg (progn (allout-end-of-prefix t) (point))) ; and beginning.
+ (setq done ; The boundary for the current topic:
+ (not (allout-next-visible-heading 1)))
+ (setq new-depth (allout-recent-depth))
+ (setq gone-out out
+ out (< new-depth depth))
+ (beginning-of-line)
+ (setq next (point))
+ (goto-char beg)
+ (setq strings nil)
+ (while (> next (point)) ; Get all the exposed text in
+ (setq strings
+ (cons (buffer-substring
+ beg
+ ;To hidden text or end of line:
+ (progn
+ (search-forward "\r"
+ (save-excursion (end-of-line)
+ (point))
+ 1)
+ (if (= (preceding-char) ?\r)
+ (1- (point))
+ (point))))
+ strings))
+ (if (< (point) next) ; Resume from after hid text, if any.
+ (forward-line 1))
+ (setq beg (point)))
+ ;; Accumulate list for this topic:
+ (setq strings (nreverse strings))
+ (setq result
+ (cons
+ (if format
+ (let ((special (if (string-match
+ (regexp-quote bullet)
+ allout-distinctive-bullets-string)
+ bullet)))
+ (cond ((listp format)
+ (list depth
+ (if allout-abbreviate-flattened-numbering
+ (allout-stringify-flat-index format
+ gone-out)
+ (allout-stringify-flat-index-plain
+ format))
+ strings
+ special))
+ ((eq format 'indent)
+ (if special
+ (list depth
+ (concat (make-string (1+ depth) ? )
+ (substring prefix -1))
+ strings)
+ (list depth
+ (make-string depth ? )
+ strings)))
+ (t (error "allout-listify-exposed: %s %s"
+ "invalid format" format))))
+ (list depth prefix strings))
+ result))
+ ;; Reasses format, if any:
+ (if (and format (listp format))
+ (cond ((= new-depth depth)
+ (setq format (cons (1+ (car format))
+ (cdr format))))
+ ((> new-depth depth) ; descending - assume by 1:
+ (setq format (cons 1 format)))
+ (t
+ ; Pop the residue:
+ (while (< new-depth depth)
+ (setq format (cdr format))
+ (setq depth (1- depth)))
+ ; And increment the current one:
+ (setq format
+ (cons (1+ (or (car format)
+ -1))
+ (cdr format)))))))
+ ;; Put the list with first at front, to last at back:
+ (nreverse result))))
+;;;_ > allout-process-exposed (&optional func from to frombuf
+;;; tobuf format)
+(defun allout-process-exposed (&optional func from to frombuf tobuf
+ format &optional start-num)
+ "Map function on exposed parts of current topic; results to another buffer.
+
+All args are options; default values itemized below.
+
+Apply FUNCTION to exposed portions FROM position TO position in buffer
+FROMBUF to buffer TOBUF. Sixth optional arg, FORMAT, designates an
+alternate presentation form:
+
+ `flat' - Present prefix as numeric section.subsection..., starting with
+ section indicated by the start-num, innermost nesting first.
+ X`flat-indented' - Prefix is like `flat' for first topic at each
+ X level, but subsequent topics have only leaf topic
+ X number, padded with blanks to line up with first.
+ `indent' \(symbol) - Convert header prefixes to all white space,
+ except for distinctive bullets.
+
+Defaults:
+ FUNCTION: `allout-insert-listified'
+ FROM: region start, if region active, else start of buffer
+ TO: region end, if region active, else end of buffer
+ FROMBUF: current buffer
+ TOBUF: buffer name derived: \"*current-buffer-name exposed*\"
+ FORMAT: nil"
+
+ ; Resolve arguments,
+ ; defaulting if necessary:
+ (if (not func) (setq func 'allout-insert-listified))
+ (if (not (and from to))
+ (if (my-region-active-p)
+ (setq from (region-beginning) to (region-end))
+ (setq from (point-min) to (point-max))))
+ (if frombuf
+ (if (not (bufferp frombuf))
+ ;; Specified but not a buffer - get it:
+ (let ((got (get-buffer frombuf)))
+ (if (not got)
+ (error (concat "allout-process-exposed: source buffer "
+ frombuf
+ " not found."))
+ (setq frombuf got))))
+ ;; not specified - default it:
+ (setq frombuf (current-buffer)))
+ (if tobuf
+ (if (not (bufferp tobuf))
+ (setq tobuf (get-buffer-create tobuf)))
+ ;; not specified - default it:
+ (setq tobuf (concat "*" (buffer-name frombuf) " exposed*")))
+ (if (listp format)
+ (nreverse format))
+
+ (let* ((listified
+ (progn (set-buffer frombuf)
+ (allout-listify-exposed from to format))))
+ (set-buffer tobuf)
+ (mapcar func listified)
+ (pop-to-buffer tobuf)))
+
+;;;_ - Copy exposed
+;;;_ > allout-insert-listified (listified)
+(defun allout-insert-listified (listified)
+ "Insert contents of listified outline portion in current buffer.
+
+Listified is a list representing each topic header and body:
+
+ \`(depth prefix text)'
+
+or \`(depth prefix text bullet-plus)'
+
+If `bullet-plus' is specified, it is inserted just after the entire prefix."
+ (setq listified (cdr listified))
+ (let ((prefix (prog1
+ (car listified)
+ (setq listified (cdr listified))))
+ (text (prog1
+ (car listified)
+ (setq listified (cdr listified))))
+ (bullet-plus (car listified)))
+ (insert prefix)
+ (if bullet-plus (insert (concat " " bullet-plus)))
+ (while text
+ (insert (car text))
+ (if (setq text (cdr text))
+ (insert "\n")))
+ (insert "\n")))
+;;;_ > allout-copy-exposed-to-buffer (&optional arg tobuf format)
+(defun allout-copy-exposed-to-buffer (&optional arg tobuf format)
+ "Duplicate exposed portions of current outline to another buffer.
+
+Other buffer has current buffers name with \" exposed\" appended to it.
+
+With repeat count, copy the exposed parts of only the current topic.
+
+Optional second arg TOBUF is target buffer name.
+
+Optional third arg FORMAT, if non-nil, symbolically designates an
+alternate presentation format for the outline:
+
+ `flat' - Convert topic header prefixes to numeric
+ section.subsection... identifiers.
+ `indent' - Convert header prefixes to all white space, except for
+ distinctive bullets.
+ `indent-flat' - The best of both - only the first of each level has
+ the full path, the rest have only the section number
+ of the leaf, preceded by the right amount of indentation."
(interactive "P")
(if (not tobuf)
(setq tobuf (get-buffer-create (concat "*" (buffer-name) " exposed*"))))
(let* ((start-pt (point))
- (beg (if arg (point-min) (outline-back-to-current-heading)))
- (end (if arg (point-max) (outline-end-of-current-subtree)))
- (buf (current-buffer)))
+ (beg (if arg (allout-back-to-current-heading) (point-min)))
+ (end (if arg (allout-end-of-current-subtree) (point-max)))
+ (buf (current-buffer))
+ (start-list ()))
+ (if (eq format 'flat)
+ (setq format (if arg (save-excursion
+ (goto-char beg)
+ (allout-topic-flat-index))
+ '(1))))
(save-excursion (set-buffer tobuf)(erase-buffer))
- (outline-process-exposed 'outline-insert-listified
+ (allout-process-exposed 'allout-insert-listified
beg
end
(current-buffer)
- tobuf)
+ tobuf
+ format start-list)
(goto-char (point-min))
(pop-to-buffer buf)
(goto-char start-pt)))
+;;;_ > allout-flatten-exposed-to-buffer (&optional arg tobuf)
+(defun allout-flatten-exposed-to-buffer (&optional arg tobuf)
+ "Present numeric outline of outline's exposed portions in another buffer.
+
+The resulting outline is not compatable with outline mode - use
+`allout-copy-exposed-to-buffer' if you want that.
+
+Use `allout-indented-exposed-to-buffer' for indented presentation.
+
+With repeat count, copy the exposed portions of only current topic.
+
+Other buffer has current buffers name with \" exposed\" appended to
+it, unless optional second arg TOBUF is specified, in which case it is
+used verbatim."
+ (interactive "P")
+ (allout-copy-exposed-to-buffer arg tobuf 'flat))
+;;;_ > allout-indented-exposed-to-buffer (&optional arg tobuf)
+(defun allout-indented-exposed-to-buffer (&optional arg tobuf)
+ "Present indented outline of outline's exposed portions in another buffer.
+
+The resulting outline is not compatable with outline mode - use
+`allout-copy-exposed-to-buffer' if you want that.
+
+Use `allout-flatten-exposed-to-buffer' for numeric sectional presentation.
+
+With repeat count, copy the exposed portions of only current topic.
+
+Other buffer has current buffers name with \" exposed\" appended to
+it, unless optional second arg TOBUF is specified, in which case it is
+used verbatim."
+ (interactive "P")
+ (allout-copy-exposed-to-buffer arg tobuf 'indent))
;;;_ - LaTeX formatting
-;;;_ > outline-latex-verb-quote (str &optional flow)
-(defun outline-latex-verb-quote (str &optional flow)
- "Return copy of STRING which expresses the original characters
-\(including carriage returns) of the string across latex processing."
- (mapconcat '(lambda (char)
- ;;;mess: (cond ((memq char '(?"" ?$ ?% ?# ?& ?- ?" ?` ?^ ?- ?*));;;"))))
+;;;_ > allout-latex-verb-quote (str &optional flow)
+(defun allout-latex-verb-quote (str &optional flow)
+ "Return copy of STRING for literal reproduction across latex processing.
+Expresses the original characters \(including carriage returns) of the
+string across latex processing."
+ (mapconcat (function
+ (lambda (char)
(cond ((memq char '(?\\ ?$ ?% ?# ?& ?{ ?} ?_ ?^ ?- ?*))
(concat "\\char" (number-to-string char) "{}"))
((= char ?\n) "\\\\")
- (t (char-to-string char))))
+ (t (char-to-string char)))))
str
""))
-;;;_ > outline-latex-verbatim-quote-curr-line ()
-(defun outline-latex-verbatim-quote-curr-line ()
- "Adjust line contents so it is unaltered \(from the original line)
-across latex processing, within the context of a 'verbatim'
+;;;_ > allout-latex-verbatim-quote-curr-line ()
+(defun allout-latex-verbatim-quote-curr-line ()
+ "Express line for exact \(literal) representation across latex processing.
+
+Adjust line contents so it is unaltered \(from the original line)
+across latex processing, within the context of a `verbatim'
environment. Leaves point at the end of the line."
(beginning-of-line)
(let ((beg (point))
end ; bounded by end-of-line
1) ; no matches, move to end & return nil
(goto-char (match-beginning 0))
- (insert-string "\\")
+ (insert "\\")
(setq end (1+ end))
(goto-char (1+ (match-end 0))))))
-;;;_ > outline-insert-latex-header (buf)
-(defun outline-insert-latex-header (buf)
+;;;_ > allout-insert-latex-header (buf)
+(defun allout-insert-latex-header (buf)
"Insert initial latex commands at point in BUFFER."
;; Much of this is being derived from the stuff in appendix of E in
;; the TeXBook, pg 421.
(set-buffer buf)
(let ((doc-style (format "\n\\documentstyle{%s}\n"
"report"))
- (page-numbering (if outline-number-pages
+ (page-numbering (if allout-number-pages
"\\pagestyle{empty}\n"
""))
(linesdef (concat "\\def\\beginlines{"
"\\def\\endlines{"
"\\kern1pt\\endgroup\\medbreak\\noindent}\n"))
(titlecmd (format "\\newcommand{\\titlecmd}[1]{{%s #1}}\n"
- outline-title-style))
+ allout-title-style))
(labelcmd (format "\\newcommand{\\labelcmd}[1]{{%s #1}}\n"
- outline-label-style))
+ allout-label-style))
(headlinecmd (format "\\newcommand{\\headlinecmd}[1]{{%s #1}}\n"
- outline-head-line-style))
+ allout-head-line-style))
(bodylinecmd (format "\\newcommand{\\bodylinecmd}[1]{{%s #1}}\n"
- outline-body-line-style))
+ allout-body-line-style))
(setlength (format "%s%s%s%s"
"\\newlength{\\stepsize}\n"
"\\setlength{\\stepsize}{"
- outline-indent
+ allout-indent
"}\n"))
(oneheadline (format "%s%s%s%s%s%s%s"
"\\newcommand{\\OneHeadLine}[3]{%\n"
"\\hspace*{#2\\stepsize}%\n"
"\\labelcmd{#1}\\hspace*{.2cm}"
"\\headlinecmd{#3}\\\\["
- outline-line-skip
+ allout-line-skip
"]\n}\n"))
(onebodyline (format "%s%s%s%s%s%s"
"\\newcommand{\\OneBodyLine}[2]{%\n"
"\\noindent%\n"
"\\hspace*{#1\\stepsize}%\n"
"\\bodylinecmd{#2}\\\\["
- outline-line-skip
+ allout-line-skip
"]\n}\n"))
(begindoc "\\begin{document}\n\\begin{center}\n")
(title (format "%s%s%s%s"
"\\titlecmd{"
- (outline-latex-verb-quote (if outline-title
+ (allout-latex-verb-quote (if allout-title
(condition-case err
- (eval outline-title)
- (error "<unnamed buffer>"))
+ (eval allout-title)
+ ('error "<unnamed buffer>"))
"Unnamed Outline"))
"}\n"
"\\end{center}\n\n"))
hoffset
vspace)
)))
-;;;_ > outline-insert-latex-trailer (buf)
-(defun outline-insert-latex-trailer (buf)
+;;;_ > allout-insert-latex-trailer (buf)
+(defun allout-insert-latex-trailer (buf)
"Insert concluding latex commands at point in BUFFER."
(set-buffer buf)
(insert "\n\\end{document}\n"))
-;;;_ > outline-latexify-one-item (depth prefix bullet text)
-(defun outline-latexify-one-item (depth prefix bullet text)
- "Insert LaTeX commands for formatting one item - a topic header and
-its' body - of an outline. Args are the topics' numeric DEPTH, the
-header PREFIX lead string, the BULLET string, and a list of TEXT
-strings for the body."
+;;;_ > allout-latexify-one-item (depth prefix bullet text)
+(defun allout-latexify-one-item (depth prefix bullet text)
+ "Insert LaTeX commands for formatting one outline item.
+
+Args are the topics numeric DEPTH, the header PREFIX lead string, the
+BULLET string, and a list of TEXT strings for the body."
(let* ((head-line (if text (car text)))
(body-lines (cdr text))
(curr-line)
body-content bop)
; Do the head line:
- (insert-string (concat "\\OneHeadLine{\\verb\1 "
- (outline-latex-verb-quote bullet)
- "\1}{"
- depth
- "}{\\verb\1 "
- (if head-line
- (outline-latex-verb-quote head-line)
- "")
- "\1}\n"))
+ (insert (concat "\\OneHeadLine{\\verb\1 "
+ (allout-latex-verb-quote bullet)
+ "\1}{"
+ depth
+ "}{\\verb\1 "
+ (if head-line
+ (allout-latex-verb-quote head-line)
+ "")
+ "\1}\n"))
(if (not body-lines)
nil
- ;;(insert-string "\\beginlines\n")
- (insert-string "\\begin{verbatim}\n")
+ ;;(insert "\\beginlines\n")
+ (insert "\\begin{verbatim}\n")
(while body-lines
(setq curr-line (car body-lines))
(if (and (not body-content)
(setq curr-line (concat (substring curr-line 0 bop)
">"
(substring curr-line bop))))
- ;;(insert-string "|" (car body-lines) "|")
- (insert-string curr-line)
- (outline-latex-verbatim-quote-curr-line)
- (insert-string "\n")
+ ;;(insert "|" (car body-lines) "|")
+ (insert curr-line)
+ (allout-latex-verbatim-quote-curr-line)
+ (insert "\n")
(setq body-lines (cdr body-lines)))
(if body-content
(setq body-content nil)
(forward-char -1)
- (insert-string "\\ ")
+ (insert "\\ ")
(forward-char 1))
- ;;(insert-string "\\endlines\n")
- (insert-string "\\end{verbatim}\n")
+ ;;(insert "\\endlines\n")
+ (insert "\\end{verbatim}\n")
)))
-;;;_ > outline-latexify-exposed (arg &optional tobuf)
-(defun outline-latexify-exposed (arg &optional tobuf)
- "Copy exposed portions of current topic to TOBUF, formatted for
-latex processing. tobuf defaults to a buffer named the same as the
-current buffer, but with \"*\" prepended and \" latex-formed*\"
-appended.
+;;;_ > allout-latexify-exposed (arg &optional tobuf)
+(defun allout-latexify-exposed (arg &optional tobuf)
+ "Format current topics exposed portions to TOBUF for latex processing.
+TOBUF defaults to a buffer named the same as the current buffer, but
+with \"*\" prepended and \" latex-formed*\" appended.
With repeat count, copy the exposed portions of entire buffer."
(setq tobuf
(get-buffer-create (concat "*" (buffer-name) " latexified*"))))
(let* ((start-pt (point))
- (beg (if arg (point-min) (outline-back-to-current-heading)))
- (end (if arg (point-max) (outline-end-of-current-subtree)))
+ (beg (if arg (point-min) (allout-back-to-current-heading)))
+ (end (if arg (point-max) (allout-end-of-current-subtree)))
(buf (current-buffer)))
(set-buffer tobuf)
(erase-buffer)
- (outline-insert-latex-header tobuf)
+ (allout-insert-latex-header tobuf)
(goto-char (point-max))
- (outline-process-exposed 'outline-latexify-one-item
+ (allout-process-exposed 'allout-latexify-one-item
beg
end
buf
tobuf)
(goto-char (point-max))
- (outline-insert-latex-trailer tobuf)
+ (allout-insert-latex-trailer tobuf)
(goto-char (point-min))
(pop-to-buffer buf)
(goto-char start-pt)))
-
;;;_ #8 miscellaneous
-;;;_ > outline-mark-topic ()
-(defun outline-mark-topic ()
+;;;_ > allout-mark-topic ()
+(defun allout-mark-topic ()
"Put the region around topic currently containing point."
(interactive)
(beginning-of-line)
- (outline-goto-prefix)
+ (allout-goto-prefix)
(push-mark (point))
- (outline-end-of-current-subtree)
+ (allout-end-of-current-subtree)
(exchange-point-and-mark))
;;;_ > outlineify-sticky ()
+;; outlinify-sticky is correct spelling; provide this alias for sticklers:
+(defalias 'outlinify-sticky 'outlineify-sticky)
(defun outlineify-sticky (&optional arg)
- "Activate outline mode and establish file eval to set initial exposure.
-
-Invoke with a string argument to designate a string to prepend to
-topic prefixs, or with a universal argument to be prompted for the
-string to be used. Suitable defaults are provided for lisp,
-emacs-lisp, c, c++, awk, sh, csh, and perl modes."
-
- (interactive "P") (outline-mode t)
-
-
- (let ((leader-cell (assoc major-mode outline-mode-leaders)))
- (cond (arg (if (stringp arg)
- ;; Use arg as the header-prefix:
- (outline-lead-with-comment-string arg)
- ;; Otherwise, let function solicit string:
- (setq arg (outline-lead-with-comment-string))))
-
- (leader-cell
- (outline-lead-with-comment-string (cdr leader-cell))
- (setq arg (cdr leader-cell)))))
-
- (let* ((lead-prefix (format "%s%s"
- (concat outline-header-prefix (if arg " " ""))
- outline-primary-bullet))
- (lead-line (format "%s%s %s\n%s %s\n %s %s %s"
- (if arg outline-header-prefix "")
- outline-primary-bullet
- "Local emacs vars."
- "'(This topic sets initial outline exposure"
- "of the file when loaded by emacs,"
- "Encapsulate it in comments if"
- "file is a program"
- "otherwise ignore it,")))
+ "Activate outline mode and establish file var so it is started subsequently.
- (save-excursion
- ; Put a topic at the top, if
- ; none there already:
- (goto-char (point-min))
- (if (not (looking-at outline-regexp))
- (insert-string
- (if (not arg) outline-primary-bullet
- (format "%s%s\n" outline-header-prefix outline-primary-bullet))))
-
- ; File-vars stuff, at the bottom:
+See doc-string for `allout-layout' and `allout-init' for details on
+setup for auto-startup."
+
+ (interactive "P")
+
+ (allout-mode t)
+
+ (save-excursion
+ (goto-char (point-min))
+ (if (looking-at allout-regexp)
+ t
+ (allout-open-topic 2)
+ (insert (concat "Dummy outline topic header - see"
+ "`allout-mode' docstring: `^Hm'."))
+ (forward-line 1)
(goto-char (point-max))
- ; Insert preamble:
- (insert-string (format "\n\n%s\n%s %s %s\n%s %s\n"
- lead-line
- lead-prefix
- "local"
- "variables:"
- lead-prefix
- "eval:"))
- ; Insert outline-mode activation:
- (insert-string
- (format "\t %s\n\t\t%s\n\t\t\t%s\n"
- "(condition-case err"
- "(save-excursion"
- "(outline-mode t)"))
- ; Conditionally insert prefix
- ; leader customization:
- (if arg (insert-string (format "\t\t\t(%s \"%s\")\n"
- "outline-lead-with-comment-string"
- arg)))
- ; Insert ammouncement and
- ; exposure control:
- (insert-string
- (format "\t\t\t%s %s\n\t\t\t%s %s\n\t\t%s %s"
- "(message \"Adjusting '%s' exposure\""
- "(buffer-name))"
- "(goto-char 0)"
- "(outline-exposure -1 0))"
- "(error (message "
- "\"Failed file var 'allout' provisions\")))"))
- ; Insert postamble:
- (insert-string (format "\n%s End:\n)\n"
- lead-prefix)))))
+ (open-line 1)
+ (allout-open-topic 0)
+ (insert "Local emacs vars.\n")
+ (allout-open-topic 1)
+ (insert "(`allout-layout' is for allout.el allout-mode)\n")
+ (allout-open-topic 0)
+ (insert "Local variables:\n")
+ (allout-open-topic 0)
+ (insert (format "allout-layout: %s\n"
+ (or allout-layout
+ '(-1 : 0))))
+ (allout-open-topic 0)
+ (insert "End:\n"))))
;;;_ > solicit-char-in-string (prompt string &optional do-defaulting)
(defun solicit-char-in-string (prompt string &optional do-defaulting)
"Solicit (with first arg PROMPT) choice of a character from string STRING.
(message "%s" new-prompt)
;; We do our own reading here, so we can circumvent, eg, special
- ;; treatment for '?' character. (Might oughta change minibuffer
- ;; keymap instead, oh well.)
+ ;; treatment for `?' character. (Oughta use minibuffer keymap instead.)
(setq got
(char-to-string (let ((cursor-in-echo-area nil)) (read-char))))
- (if (null (string-match (regexp-quote got) string))
- (if (and do-defaulting (string= got "\^M"))
- ;; We're defaulting, return null string to indicate that:
- (setq got "")
- ;; Failed match and not defaulting,
- ;; set the prompt to give feedback,
- (setq new-prompt (concat prompt
- got
- " ...pick from: "
- string
- ""))
- ;; and set loop to try again:
- (setq got nil))
- ;; Got a match - give feedback:
- (message "")))
- ;; got something out of loop - return it:
- got)
+ (setq got
+ (cond ((string-match (regexp-quote got) string) got)
+ ((and do-defaulting (string= got "\r"))
+ ;; Return empty string to default:
+ "")
+ ((string= got "\C-g") (signal 'quit nil))
+ (t
+ (setq new-prompt (concat prompt
+ got
+ " ...pick from: "
+ string
+ ""))
+ nil))))
+ ;; got something out of loop - return it:
+ got)
)
;;;_ > regexp-sans-escapes (string)
(defun regexp-sans-escapes (regexp &optional successive-backslashes)
"Return a copy of REGEXP with all character escapes stripped out.
+
Representations of actual backslashes - '\\\\\\\\' - are left as a
single backslash.
(regexp-sans-escapes (substring regexp 1)))
;; Exclude first char, but maintain count:
(regexp-sans-escapes (substring regexp 1) successive-backslashes))))
-;;;_ - add-hook definition for v18
+;;;_ > my-region-active-p ()
+(defmacro my-region-active-p ()
+ (if (fboundp 'region-active-p)
+ '(region-active-p)
+ 'mark-active))
+;;;_ - add-hook definition for divergent emacsen
;;;_ > add-hook (hook function &optional append)
(if (not (fboundp 'add-hook))
(defun add-hook (hook function &optional append)
- "Add to the value of HOOK the function FUNCTION unless already present (it
-becomes the first hook on the list unless optional APPEND is non-nil, in
+ "Add to the value of HOOK the function FUNCTION unless already present.
+\(It becomes the first hook on the list unless optional APPEND is non-nil, in
which case it becomes the last). HOOK should be a symbol, and FUNCTION may be
any valid function. HOOK's value should be a list of functions, not a single
function. If HOOK is void, it is first set to nil."
(let ((tail (assoc (cdr function) (symbol-value hook))))
(equal function tail))
(memq function (symbol-value hook)))
- (set hook
+ (set hook
(if append
(nconc (symbol-value hook) (list function))
(cons function (symbol-value hook)))))))
+;;;_ : my-mark-marker to accommodate divergent emacsen:
+(defun my-mark-marker (&optional force buffer)
+ "Accommodate the different signature for mark-marker across emacsen.
+
+GNU XEmacs takes two optional args, while mainline GNU Emacs does not,
+so pass them along when appropriate."
+ (if (featurep 'xemacs)
+ (mark-marker force buffer)
+ (mark-marker)))
;;;_ #9 Under development
-;;;_ > outline-bullet-isearch (&optional bullet)
-(defun outline-bullet-isearch (&optional bullet)
- "Isearch \(regexp\) for topic with bullet BULLET."
+;;;_ > allout-bullet-isearch (&optional bullet)
+(defun allout-bullet-isearch (&optional bullet)
+ "Isearch \(regexp) for topic with bullet BULLET."
(interactive)
(if (not bullet)
(setq bullet (solicit-char-in-string
"ISearch for topic with bullet: "
- (regexp-sans-escapes outline-bullets-string))))
-
+ (regexp-sans-escapes allout-bullets-string))))
+
(let ((isearch-regexp t)
(isearch-string (concat "^"
- outline-header-prefix
+ allout-header-prefix
"[ \t]*"
bullet)))
(isearch-repeat 'forward)
(isearch-mode t)))
-;;;_ - Re hooking up with isearch - use isearch-op-fun rather than
- wrapping the isearch functions.
+;;;_ ? Re hooking up with isearch - use isearch-op-fun rather than
+;;; wrapping the isearch functions.
;;;_* Local emacs vars.
-'(
-Local variables:
-eval: (save-excursion
- (if (not (condition-case err (outline-mode t)
- (wrong-number-of-arguments nil)))
- (progn
- (message
- "Allout outline-mode not loaded, not adjusting buffer exposure")
- (sit-for 1))
- (message "Adjusting '%s' exposure" (buffer-name))
- (outline-lead-with-comment-string "\;\;\;_")
- (goto-char 0)
- (outline-new-exposure 0 : -1 -1 0)))
-End:)
-
+;;; The following `allout-layout' local variable setting:
+;;; - closes all topics from the first topic to just before the third-to-last,
+;;; - shows the children of the third to last (config vars)
+;;; - and the second to last (code section),
+;;; - and closes the last topic (this local-variables section).
+;;;Local variables:
+;;;allout-layout: (0 : -1 -1 0)
+;;;End:
+
+;;; arch-tag: cf38fbc3-c044-450f-8bff-afed8ba5681c
+;;; allout.el ends here