aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarkus Rost2002-12-16 00:26:22 +0000
committerMarkus Rost2002-12-16 00:26:22 +0000
commit2265e0170df99e8bc005e7604781a404b0e4790d (patch)
tree899a633cc8757f777bc17bd02e603321ba78310f
parentfd5359c61ba4bbef9c54239a6eff160e243de02f (diff)
downloademacs-2265e0170df99e8bc005e7604781a404b0e4790d.tar.gz
emacs-2265e0170df99e8bc005e7604781a404b0e4790d.zip
Avoid name conflicts with outline.el. Use 3 installments to keep
diffs understandable. Change 2: Put `quotes' around many function and variable names.
-rw-r--r--lisp/allout.el150
1 files changed, 75 insertions, 75 deletions
diff --git a/lisp/allout.el b/lisp/allout.el
index f77376f871e..17ccac19138 100644
--- a/lisp/allout.el
+++ b/lisp/allout.el
@@ -5,7 +5,7 @@
5;; Author: Ken Manheimer <klm@python.org> 5;; Author: Ken Manheimer <klm@python.org>
6;; Maintainer: Ken Manheimer <klm@python.org> 6;; Maintainer: Ken Manheimer <klm@python.org>
7;; Created: Dec 1991 - first release to usenet 7;; Created: Dec 1991 - first release to usenet
8;; Version: $Id: allout.el,v 1.34 2002/08/30 11:03:28 lektu Exp $|| 8;; Version: $Id: allout.el,v 1.35 2002/12/16 00:20:42 rost Exp $||
9;; Keywords: outlines mode wp languages 9;; Keywords: outlines mode wp languages
10 10
11;; This file is part of GNU Emacs. 11;; This file is part of GNU Emacs.
@@ -150,7 +150,7 @@ just the header."
150Outline topic header lines are identified by a leading topic 150Outline topic header lines are identified by a leading topic
151header prefix, which mostly have the value of this var at their front. 151header prefix, which mostly have the value of this var at their front.
152\(Level 1 topics are exceptions. They consist of only a single 152\(Level 1 topics are exceptions. They consist of only a single
153character, which is typically set to the allout-primary-bullet. Many 153character, which is typically set to the `allout-primary-bullet'. Many
154outlines start at level 2 to avoid this discrepancy." 154outlines start at level 2 to avoid this discrepancy."
155 :type 'string 155 :type 'string
156 :group 'allout) 156 :group 'allout)
@@ -164,8 +164,8 @@ prefix, which is concluded by bullets that includes the value of this
164var and the respective allout-*-bullets-string vars. 164var and the respective allout-*-bullets-string vars.
165 165
166The value of an asterisk (`*') provides for backwards compatibility 166The value of an asterisk (`*') provides for backwards compatibility
167with the original emacs outline mode. See allout-plain-bullets-string 167with the original emacs outline mode. See `allout-plain-bullets-string'
168and allout-distinctive-bullets-string for the range of available 168and `allout-distinctive-bullets-string' for the range of available
169bullets." 169bullets."
170 :type 'string 170 :type 'string
171 :group 'allout) 171 :group 'allout)
@@ -313,7 +313,7 @@ Stylish and constant prefixes (as well as old-style prefixes) are
313always respected by the topic maneuvering functions, regardless of 313always respected by the topic maneuvering functions, regardless of
314this variable setting. 314this variable setting.
315 315
316The setting of this var is not relevant when allout-old-style-prefixes 316The setting of this var is not relevant when `allout-old-style-prefixes'
317is non-nil." 317is non-nil."
318 :type 'boolean 318 :type 'boolean
319 :group 'allout) 319 :group 'allout)
@@ -409,9 +409,9 @@ formatted copy."
409;;; You have to reactivate allout-mode - `(allout-mode t)' - to 409;;; You have to reactivate allout-mode - `(allout-mode t)' - to
410;;; institute changes to this var. 410;;; institute changes to this var.
411(defvar allout-keybindings-list () 411(defvar allout-keybindings-list ()
412 "*List of allout-mode key / function bindings, for allout-mode-map. 412 "*List of `allout-mode' key / function bindings, for `allout-mode-map'.
413 413
414String or vector key will be prefaced with allout-command-prefix, 414String or vector key will be prefaced with `allout-command-prefix',
415unless optional third, non-nil element is present.") 415unless optional third, non-nil element is present.")
416(setq allout-keybindings-list 416(setq allout-keybindings-list
417 '( 417 '(
@@ -497,7 +497,7 @@ Outline mode uses emacs change-triggered functions to detect unruly
497changes to concealed regions. Set this var non-nil to disable the 497changes to concealed regions. Set this var non-nil to disable the
498protection, potentially increasing text-entry responsiveness a bit. 498protection, potentially increasing text-entry responsiveness a bit.
499 499
500This var takes effect at allout-mode activation, so you may have to 500This var takes effect at `allout-mode' activation, so you may have to
501deactivate and then reactivate the mode if you want to toggle the 501deactivate and then reactivate the mode if you want to toggle the
502behavior." 502behavior."
503 :type 'boolean 503 :type 'boolean
@@ -509,7 +509,7 @@ behavior."
509;;;_ : Version 509;;;_ : Version
510;;;_ = allout-version 510;;;_ = allout-version
511(defvar allout-version 511(defvar allout-version
512 (let ((rcs-rev "$Revision: 1.34 $")) 512 (let ((rcs-rev "$Revision: 1.35 $"))
513 (condition-case err 513 (condition-case err
514 (save-match-data 514 (save-match-data
515 (string-match "Revision: \\([0-9]+\\.[0-9]+\\)" rcs-rev) 515 (string-match "Revision: \\([0-9]+\\.[0-9]+\\)" rcs-rev)
@@ -531,7 +531,7 @@ behavior."
531 531
532Any line whose beginning matches this regexp is considered a 532Any line whose beginning matches this regexp is considered a
533heading. This var is set according to the user configuration vars 533heading. This var is set according to the user configuration vars
534by set-allout-regexp.") 534by `set-allout-regexp'.")
535(make-variable-buffer-local 'allout-regexp) 535(make-variable-buffer-local 'allout-regexp)
536;;;_ = allout-bullets-string 536;;;_ = allout-bullets-string
537(defvar allout-bullets-string "" 537(defvar allout-bullets-string ""
@@ -543,19 +543,19 @@ and `allout-distinctive-bullets-string'.")
543(make-variable-buffer-local 'allout-bullets-string) 543(make-variable-buffer-local 'allout-bullets-string)
544;;;_ = allout-bullets-string-len 544;;;_ = allout-bullets-string-len
545(defvar allout-bullets-string-len 0 545(defvar allout-bullets-string-len 0
546 "Length of current buffers' allout-plain-bullets-string.") 546 "Length of current buffers' `allout-plain-bullets-string'.")
547(make-variable-buffer-local 'allout-bullets-string-len) 547(make-variable-buffer-local 'allout-bullets-string-len)
548;;;_ = allout-line-boundary-regexp 548;;;_ = allout-line-boundary-regexp
549(defvar allout-line-boundary-regexp () 549(defvar allout-line-boundary-regexp ()
550 "Allout-regexp with allout-style beginning-of-line anchor. 550 "Allout-regexp with allout-style beginning-of-line anchor.
551 551
552\(Ie, C-j, *or* C-m, for prefixes of hidden topics). This is properly 552\(Ie, C-j, *or* C-m, for prefixes of hidden topics). This is properly
553set when allout-regexp is produced by `set-allout-regexp', so 553set when `allout-regexp' is produced by `set-allout-regexp', so
554that (match-beginning 2) and (match-end 2) delimit the prefix.") 554that (match-beginning 2) and (match-end 2) delimit the prefix.")
555(make-variable-buffer-local 'allout-line-boundary-regexp) 555(make-variable-buffer-local 'allout-line-boundary-regexp)
556;;;_ = allout-bob-regexp 556;;;_ = allout-bob-regexp
557(defvar allout-bob-regexp () 557(defvar allout-bob-regexp ()
558 "Like allout-line-boundary-regexp, for headers at beginning of buffer. 558 "Like `allout-line-boundary-regexp', for headers at beginning of buffer.
559\(match-beginning 2) and \(match-end 2) delimit the prefix.") 559\(match-beginning 2) and \(match-end 2) delimit the prefix.")
560(make-variable-buffer-local 'allout-bob-regexp) 560(make-variable-buffer-local 'allout-bob-regexp)
561;;;_ = allout-header-subtraction 561;;;_ = allout-header-subtraction
@@ -564,7 +564,7 @@ that (match-beginning 2) and (match-end 2) delimit the prefix.")
564(make-variable-buffer-local 'allout-header-subtraction) 564(make-variable-buffer-local 'allout-header-subtraction)
565;;;_ = allout-plain-bullets-string-len 565;;;_ = allout-plain-bullets-string-len
566(defvar allout-plain-bullets-string-len (length allout-plain-bullets-string) 566(defvar allout-plain-bullets-string-len (length allout-plain-bullets-string)
567 "Length of allout-plain-bullets-string, updated by set-allout-regexp.") 567 "Length of `allout-plain-bullets-string', updated by `set-allout-regexp'.")
568(make-variable-buffer-local 'allout-plain-bullets-string-len) 568(make-variable-buffer-local 'allout-plain-bullets-string-len)
569 569
570 570
@@ -730,12 +730,12 @@ See doc string for allout-keybindings-list for format of binding list."
730 map)) 730 map))
731;;;_ = allout-prior-bindings - being deprecated. 731;;;_ = allout-prior-bindings - being deprecated.
732(defvar allout-prior-bindings nil 732(defvar allout-prior-bindings nil
733 "Variable for use in V18, with allout-added-bindings, for 733 "Variable for use in V18, with `allout-added-bindings', for
734resurrecting, on mode deactivation, bindings that existed before 734resurrecting, on mode deactivation, bindings that existed before
735activation. Being deprecated.") 735activation. Being deprecated.")
736;;;_ = allout-added-bindings - being deprecated 736;;;_ = allout-added-bindings - being deprecated
737(defvar allout-added-bindings nil 737(defvar allout-added-bindings nil
738 "Variable for use in V18, with allout-prior-bindings, for 738 "Variable for use in V18, with `allout-prior-bindings', for
739resurrecting, on mode deactivation, bindings that existed before 739resurrecting, on mode deactivation, bindings that existed before
740activation. Being deprecated.") 740activation. Being deprecated.")
741;;;_ : Menu bar 741;;;_ : Menu bar
@@ -804,7 +804,7 @@ activation. Being deprecated.")
804;;;_ > allout-resumptions (name &optional value) 804;;;_ > allout-resumptions (name &optional value)
805(defun allout-resumptions (name &optional value) 805(defun allout-resumptions (name &optional value)
806 806
807 "Registers or resumes settings over allout-mode activation/deactivation. 807 "Registers or resumes settings over `allout-mode' activation/deactivation.
808 808
809First arg is NAME of variable affected. Optional second arg is list 809First arg is NAME of variable affected. Optional second arg is list
810containing allout-mode-specific VALUE to be imposed on named 810containing allout-mode-specific VALUE to be imposed on named
@@ -880,12 +880,12 @@ allout-pre- and -post-command-hooks.")
880(defvar allout-isearch-did-quit nil 880(defvar allout-isearch-did-quit nil
881 "Distinguishes isearch conclusion and cancellation. 881 "Distinguishes isearch conclusion and cancellation.
882 882
883Maintained by allout-isearch-abort \(which is wrapped around the real 883Maintained by `allout-isearch-abort' \(which is wrapped around the real
884isearch-abort), and monitored by allout-isearch-expose for action.") 884isearch-abort), and monitored by `allout-isearch-expose' for action.")
885(make-variable-buffer-local 'allout-isearch-did-quit) 885(make-variable-buffer-local 'allout-isearch-did-quit)
886;;;_ = allout-override-protect nil 886;;;_ = allout-override-protect nil
887(defvar allout-override-protect nil 887(defvar allout-override-protect nil
888 "Used in allout-mode for regulate of concealed-text protection mechanism. 888 "Used in `allout-mode' for regulate of concealed-text protection mechanism.
889 889
890Allout outline mode regulates alteration of concealed text to protect 890Allout outline mode regulates alteration of concealed text to protect
891against inadvertent, unnoticed changes. This is for use by specific, 891against inadvertent, unnoticed changes. This is for use by specific,
@@ -907,11 +907,11 @@ the way that before-change-functions and undo interact.")
907;;;_ = file-var-bug hack 907;;;_ = file-var-bug hack
908(defvar allout-v18/19-file-var-hack nil 908(defvar allout-v18/19-file-var-hack nil
909 "Horrible hack used to prevent invalid multiple triggering of outline 909 "Horrible hack used to prevent invalid multiple triggering of outline
910mode from prop-line file-var activation. Used by allout-mode function 910mode from prop-line file-var activation. Used by `allout-mode' function
911to track repeats.") 911to track repeats.")
912;;;_ > allout-write-file-hook () 912;;;_ > allout-write-file-hook ()
913(defun allout-write-file-hook () 913(defun allout-write-file-hook ()
914 "In outline mode, run as a local-write-file-hooks activity. 914 "In outline mode, run as a `local-write-file-hooks' activity.
915 915
916Currently just sets `allout-during-write-cue', so allout-change-protection 916Currently just sets `allout-during-write-cue', so allout-change-protection
917knows to keep inactive during file write." 917knows to keep inactive during file write."
@@ -924,16 +924,16 @@ knows to keep inactive during file write."
924(make-variable-buffer-local 'allout-mode) 924(make-variable-buffer-local 'allout-mode)
925;;;_ > allout-mode-p () 925;;;_ > allout-mode-p ()
926(defmacro allout-mode-p () 926(defmacro allout-mode-p ()
927 "Return t if allout-mode is active in current buffer." 927 "Return t if `allout-mode' is active in current buffer."
928 'allout-mode) 928 'allout-mode)
929;;;_ = allout-explicitly-deactivated 929;;;_ = allout-explicitly-deactivated
930(defvar allout-explicitly-deactivated nil 930(defvar allout-explicitly-deactivated nil
931 "Allout-mode was last deliberately deactivated. 931 "Allout-mode was last deliberately deactivated.
932So allout-post-command-business should not reactivate it...") 932So `allout-post-command-business' should not reactivate it...")
933(make-variable-buffer-local 'allout-explicitly-deactivated) 933(make-variable-buffer-local 'allout-explicitly-deactivated)
934;;;_ > allout-init (&optional mode) 934;;;_ > allout-init (&optional mode)
935(defun allout-init (&optional mode) 935(defun allout-init (&optional mode)
936 "Prime allout-mode to enable/disable auto-activation, wrt `allout-layout'. 936 "Prime `allout-mode' to enable/disable auto-activation, wrt `allout-layout'.
937 937
938MODE is one of the following symbols: 938MODE is one of the following symbols:
939 939
@@ -1046,10 +1046,10 @@ In addition to outline navigation and exposure, allout includes:
1046and many other features. 1046and many other features.
1047 1047
1048Below is a description of the bindings, and then explanation of 1048Below is a description of the bindings, and then explanation of
1049special allout-mode features and terminology. See also the outline 1049special `allout-mode' features and terminology. See also the outline
1050menubar additions for quick reference to many of the features, and see 1050menubar additions for quick reference to many of the features, and see
1051the docstring of the variable `allout-init' for instructions on 1051the docstring of the variable `allout-init' for instructions on
1052priming your emacs session for automatic activation of allout-mode. 1052priming your emacs session for automatic activation of `allout-mode'.
1053 1053
1054 1054
1055The bindings are dictated by the `allout-keybindings-list' and 1055The bindings are dictated by the `allout-keybindings-list' and
@@ -1173,7 +1173,7 @@ PREFIX: The leading text of a topic which which distinguishes it from
1173PREFIX-LEAD: 1173PREFIX-LEAD:
1174 The string at the beginning of a topic prefix, normally a `.'. 1174 The string at the beginning of a topic prefix, normally a `.'.
1175 It can be customized by changing the setting of 1175 It can be customized by changing the setting of
1176 `allout-header-prefix' and then reinitializing allout-mode. 1176 `allout-header-prefix' and then reinitializing `allout-mode'.
1177 1177
1178 By setting the prefix-lead to the comment-string of a 1178 By setting the prefix-lead to the comment-string of a
1179 programming language, you can embed allout-structuring in 1179 programming language, you can embed allout-structuring in
@@ -1237,7 +1237,7 @@ OPEN: A topic that is not closed, though its offspring or body may be."
1237 ;; off on second invocation, so we detect it as best we can, and 1237 ;; off on second invocation, so we detect it as best we can, and
1238 ;; skip everything. 1238 ;; skip everything.
1239 ((and same-complex-command ; Still in same complex command 1239 ((and same-complex-command ; Still in same complex command
1240 ; as last time allout-mode invoked. 1240 ; as last time `allout-mode' invoked.
1241 active ; Already activated. 1241 active ; Already activated.
1242 (not explicit-activation) ; Prop-line file-vars don't have args. 1242 (not explicit-activation) ; Prop-line file-vars don't have args.
1243 (string-match "^19.1[89]" ; Bug only known to be in v19.18 and 1243 (string-match "^19.1[89]" ; Bug only known to be in v19.18 and
@@ -1432,7 +1432,7 @@ OPEN: A topic that is not closed, though its offspring or body may be."
1432(make-variable-buffer-local 'allout-recent-prefix-end) 1432(make-variable-buffer-local 'allout-recent-prefix-end)
1433;;;_ = allout-recent-end-of-subtree 1433;;;_ = allout-recent-end-of-subtree
1434(defvar allout-recent-end-of-subtree 0 1434(defvar allout-recent-end-of-subtree 0
1435 "Buffer point last returned by allout-end-of-current-subtree.") 1435 "Buffer point last returned by `allout-end-of-current-subtree'.")
1436(make-variable-buffer-local 'allout-recent-end-of-subtree) 1436(make-variable-buffer-local 'allout-recent-end-of-subtree)
1437;;;_ > allout-prefix-data (beg end) 1437;;;_ > allout-prefix-data (beg end)
1438(defmacro allout-prefix-data (beg end) 1438(defmacro allout-prefix-data (beg end)
@@ -1446,8 +1446,8 @@ For reference by `allout-recent' funcs. Returns BEGINNING."
1446 "Return depth of last heading encountered by an outline maneuvering function. 1446 "Return depth of last heading encountered by an outline maneuvering function.
1447 1447
1448All outline functions which directly do string matches to assess 1448All outline functions which directly do string matches to assess
1449headings set the variables allout-recent-prefix-beginning and 1449headings set the variables `allout-recent-prefix-beginning' and
1450allout-recent-prefix-end if successful. This function uses those settings 1450`allout-recent-prefix-end' if successful. This function uses those settings
1451to return the current depth." 1451to return the current depth."
1452 1452
1453 '(max 1 (- allout-recent-prefix-end 1453 '(max 1 (- allout-recent-prefix-end
@@ -1455,11 +1455,11 @@ to return the current depth."
1455 allout-header-subtraction))) 1455 allout-header-subtraction)))
1456;;;_ > allout-recent-prefix () 1456;;;_ > allout-recent-prefix ()
1457(defmacro allout-recent-prefix () 1457(defmacro allout-recent-prefix ()
1458 "Like allout-recent-depth, but returns text of last encountered prefix. 1458 "Like `allout-recent-depth', but returns text of last encountered prefix.
1459 1459
1460All outline functions which directly do string matches to assess 1460All outline functions which directly do string matches to assess
1461headings set the variables allout-recent-prefix-beginning and 1461headings set the variables `allout-recent-prefix-beginning' and
1462allout-recent-prefix-end if successful. This function uses those settings 1462`allout-recent-prefix-end' if successful. This function uses those settings
1463to return the current depth." 1463to return the current depth."
1464 '(buffer-substring allout-recent-prefix-beginning 1464 '(buffer-substring allout-recent-prefix-beginning
1465 allout-recent-prefix-end)) 1465 allout-recent-prefix-end))
@@ -1468,8 +1468,8 @@ to return the current depth."
1468 "Like allout-recent-prefix, but returns bullet of last encountered prefix. 1468 "Like allout-recent-prefix, but returns bullet of last encountered prefix.
1469 1469
1470All outline functions which directly do string matches to assess 1470All outline functions which directly do string matches to assess
1471headings set the variables allout-recent-prefix-beginning and 1471headings set the variables `allout-recent-prefix-beginning' and
1472allout-recent-prefix-end if successful. This function uses those settings 1472`allout-recent-prefix-end' if successful. This function uses those settings
1473to return the current depth of the most recently matched topic." 1473to return the current depth of the most recently matched topic."
1474 '(buffer-substring (1- allout-recent-prefix-end) 1474 '(buffer-substring (1- allout-recent-prefix-end)
1475 allout-recent-prefix-end)) 1475 allout-recent-prefix-end))
@@ -1509,7 +1509,7 @@ Actually, returns prefix beginning point."
1509;;;_ : Location attributes 1509;;;_ : Location attributes
1510;;;_ > allout-depth () 1510;;;_ > allout-depth ()
1511(defsubst allout-depth () 1511(defsubst allout-depth ()
1512 "Like allout-current-depth, but respects hidden as well as visible topics." 1512 "Like `allout-current-depth', but respects hidden as well as visible topics."
1513 (save-excursion 1513 (save-excursion
1514 (if (allout-goto-prefix) 1514 (if (allout-goto-prefix)
1515 (allout-recent-depth) 1515 (allout-recent-depth)
@@ -1890,7 +1890,7 @@ Returns that character position."
1890 "When not already there, position point at beginning of current topic's body. 1890 "When not already there, position point at beginning of current topic's body.
1891 1891
1892If already there, move cursor to bullet for hot-spot operation. 1892If already there, move cursor to bullet for hot-spot operation.
1893\(See allout-mode doc string for details on hot-spot operation.)" 1893\(See `allout-mode' doc string for details on hot-spot operation.)"
1894 (interactive) 1894 (interactive)
1895 (let ((start-point (point))) 1895 (let ((start-point (point)))
1896 (allout-end-of-prefix) 1896 (allout-end-of-prefix)
@@ -1993,7 +1993,7 @@ DONT-COMPLAIN is non-nil."
1993;;;_ - Linear 1993;;;_ - Linear
1994;;;_ > allout-next-sibling (&optional depth backward) 1994;;;_ > allout-next-sibling (&optional depth backward)
1995(defun allout-next-sibling (&optional depth backward) 1995(defun allout-next-sibling (&optional depth backward)
1996 "Like allout-forward-current-level, but respects invisible topics. 1996 "Like `allout-forward-current-level', but respects invisible topics.
1997 1997
1998Traverse at optional DEPTH, or current depth if none specified. 1998Traverse at optional DEPTH, or current depth if none specified.
1999 1999
@@ -2019,7 +2019,7 @@ Return depth if successful, nil otherwise."
2019 nil)))) 2019 nil))))
2020;;;_ > allout-previous-sibling (&optional depth backward) 2020;;;_ > allout-previous-sibling (&optional depth backward)
2021(defun allout-previous-sibling (&optional depth backward) 2021(defun allout-previous-sibling (&optional depth backward)
2022 "Like allout-forward-current-level,but backwards & respect invisible topics. 2022 "Like `allout-forward-current-level',but backwards & respect invisible topics.
2023 2023
2024Optional DEPTH specifies depth to traverse, default current depth. 2024Optional DEPTH specifies depth to traverse, default current depth.
2025 2025
@@ -2086,7 +2086,7 @@ buffer) if headings are exhausted."
2086 "Move to the previous heading line. 2086 "Move to the previous heading line.
2087 2087
2088With argument, repeats or can move forward if negative. 2088With argument, repeats or can move forward if negative.
2089A heading line is one that starts with a `*' (or that allout-regexp 2089A heading line is one that starts with a `*' (or that `allout-regexp'
2090matches)." 2090matches)."
2091 (interactive "p") 2091 (interactive "p")
2092 (allout-next-visible-heading (- arg))) 2092 (allout-next-visible-heading (- arg)))
@@ -2266,23 +2266,23 @@ are exempt from this restriction."
2266 "Outline internal var, for `allout-pre-command-business' hot-spot operation. 2266 "Outline internal var, for `allout-pre-command-business' hot-spot operation.
2267 2267
2268When set, tells post-processing to reposition on topic bullet, and 2268When set, tells post-processing to reposition on topic bullet, and
2269then unset it. Set by allout-pre-command-business when implementing 2269then unset it. Set by `allout-pre-command-business' when implementing
2270hot-spot operation, where literal characters typed over a topic bullet 2270hot-spot operation, where literal characters typed over a topic bullet
2271are mapped to the command of the corresponding control-key on the 2271are mapped to the command of the corresponding control-key on the
2272allout-mode-map.") 2272`allout-mode-map'.")
2273(make-variable-buffer-local 'allout-post-goto-bullet) 2273(make-variable-buffer-local 'allout-post-goto-bullet)
2274;;;_ > allout-post-command-business () 2274;;;_ > allout-post-command-business ()
2275(defun allout-post-command-business () 2275(defun allout-post-command-business ()
2276 "Outline post-command-hook function. 2276 "Outline `post-command-hook' function.
2277 2277
2278- Null allout-override-protect, so it's not left open. 2278- Null `allout-override-protect', so it's not left open.
2279 2279
2280- Implement (and clear) allout-post-goto-bullet, for hot-spot 2280- Implement (and clear) `allout-post-goto-bullet', for hot-spot
2281 outline commands. 2281 outline commands.
2282 2282
2283- Massages buffer-undo-list so successive, standard character self-inserts are 2283- Massages buffer-undo-list so successive, standard character self-inserts are
2284 aggregated. This kludge compensates for lack of undo bunching when 2284 aggregated. This kludge compensates for lack of undo bunching when
2285 before-change-functions is used." 2285 `before-change-functions' is used."
2286 2286
2287 ; Apply any external change func: 2287 ; Apply any external change func:
2288 (if (not (allout-mode-p)) ; In allout-mode. 2288 (if (not (allout-mode-p)) ; In allout-mode.
@@ -2329,11 +2329,11 @@ allout-mode-map.")
2329 )) 2329 ))
2330;;;_ > allout-pre-command-business () 2330;;;_ > allout-pre-command-business ()
2331(defun allout-pre-command-business () 2331(defun allout-pre-command-business ()
2332 "Outline pre-command-hook function for outline buffers. 2332 "Outline `pre-command-hook' function for outline buffers.
2333Implements special behavior when cursor is on bullet char. 2333Implements special behavior when cursor is on bullet char.
2334 2334
2335Self-insert characters are reinterpreted control-character references 2335Self-insert characters are reinterpreted control-character references
2336into the allout-mode-map. The allout-mode post-command hook will 2336into the `allout-mode-map'. The `allout-mode' post-command hook will
2337position a cursor that has moved as a result of such reinterpretation, 2337position a cursor that has moved as a result of such reinterpretation,
2338on the destination topic's bullet, when the cursor wound up in the 2338on the destination topic's bullet, when the cursor wound up in the
2339 2339
@@ -2381,7 +2381,7 @@ char."
2381 this-command mapped-binding))))))) 2381 this-command mapped-binding)))))))
2382;;;_ > allout-find-file-hook () 2382;;;_ > allout-find-file-hook ()
2383(defun allout-find-file-hook () 2383(defun allout-find-file-hook ()
2384 "Activate allout-mode when `allout-auto-activation' & `allout-layout' are non-nil. 2384 "Activate `allout-mode' when `allout-auto-activation' & `allout-layout' are non-nil.
2385 2385
2386See `allout-init' for setup instructions." 2386See `allout-init' for setup instructions."
2387 (if (and allout-auto-activation 2387 (if (and allout-auto-activation
@@ -2392,7 +2392,7 @@ See `allout-init' for setup instructions."
2392(defun allout-isearch-rectification () 2392(defun allout-isearch-rectification ()
2393 "Rectify outline exposure before, during, or after isearch. 2393 "Rectify outline exposure before, during, or after isearch.
2394 2394
2395Called as part of allout-post-command-business." 2395Called as part of `allout-post-command-business'."
2396 2396
2397 (let ((isearching (and (boundp 'isearch-mode) isearch-mode))) 2397 (let ((isearching (and (boundp 'isearch-mode) isearch-mode)))
2398 (cond ((and isearching (not allout-pre-was-isearching)) 2398 (cond ((and isearching (not allout-pre-was-isearching))
@@ -2452,7 +2452,7 @@ Returns the endpoint of the region."
2452 (setq allout-isearch-did-quit nil)) 2452 (setq allout-isearch-did-quit nil))
2453;;;_ > allout-enwrap-isearch () 2453;;;_ > allout-enwrap-isearch ()
2454(defun allout-enwrap-isearch () 2454(defun allout-enwrap-isearch ()
2455 "Impose allout-mode isearch-abort wrapper for dynamic exposure in isearch. 2455 "Impose `allout-mode' isearch-abort wrapper for dynamic exposure in isearch.
2456 2456
2457The function checks to ensure that the rebinding is done only once." 2457The function checks to ensure that the rebinding is done only once."
2458 2458
@@ -2482,7 +2482,7 @@ The function checks to ensure that the rebinding is done only once."
2482 (fset 'isearch-abort 'allout-isearch-abort))))) 2482 (fset 'isearch-abort 'allout-isearch-abort)))))
2483;;;_ > allout-isearch-abort () 2483;;;_ > allout-isearch-abort ()
2484(defun allout-isearch-abort () 2484(defun allout-isearch-abort ()
2485 "Wrapper for allout-real-isearch-abort \(which see), to register 2485 "Wrapper for `allout-real-isearch-abort' \(which see), to register
2486actual quits." 2486actual quits."
2487 (interactive) 2487 (interactive)
2488 (setq allout-isearch-did-quit nil) 2488 (setq allout-isearch-did-quit nil)
@@ -2494,7 +2494,7 @@ actual quits."
2494;;; Prevent unnecessary font-lock while isearching! 2494;;; Prevent unnecessary font-lock while isearching!
2495(defvar isearch-was-font-locking nil) 2495(defvar isearch-was-font-locking nil)
2496(defun isearch-inhibit-font-lock () 2496(defun isearch-inhibit-font-lock ()
2497 "Inhibit font-lock while isearching - for use on isearch-mode-hook." 2497 "Inhibit font-lock while isearching - for use on `isearch-mode-hook'."
2498 (if (and (allout-mode-p) (boundp 'font-lock-mode) font-lock-mode) 2498 (if (and (allout-mode-p) (boundp 'font-lock-mode) font-lock-mode)
2499 (setq isearch-was-font-locking t 2499 (setq isearch-was-font-locking t
2500 font-lock-mode nil))) 2500 font-lock-mode nil)))
@@ -2532,7 +2532,7 @@ Offer one suitable for current depth DEPTH as default."
2532 ) 2532 )
2533;;;_ > allout-distinctive-bullet (bullet) 2533;;;_ > allout-distinctive-bullet (bullet)
2534(defun allout-distinctive-bullet (bullet) 2534(defun allout-distinctive-bullet (bullet)
2535 "True if bullet is one of those on allout-distinctive-bullets-string." 2535 "True if bullet is one of those on `allout-distinctive-bullets-string'."
2536 (string-match (regexp-quote bullet) allout-distinctive-bullets-string)) 2536 (string-match (regexp-quote bullet) allout-distinctive-bullets-string))
2537;;;_ > allout-numbered-type-prefix (&optional prefix) 2537;;;_ > allout-numbered-type-prefix (&optional prefix)
2538(defun allout-numbered-type-prefix (&optional prefix) 2538(defun allout-numbered-type-prefix (&optional prefix)
@@ -2572,7 +2572,7 @@ All the arguments are optional.
2572 2572
2573PRIOR-BULLET indicates the bullet of the prefix being changed, or 2573PRIOR-BULLET indicates the bullet of the prefix being changed, or
2574nil if none. This bullet may be preserved (other options 2574nil if none. This bullet may be preserved (other options
2575notwithstanding) if it is on the allout-distinctive-bullets-string, 2575notwithstanding) if it is on the `allout-distinctive-bullets-string',
2576for instance. 2576for instance.
2577 2577
2578Second arg NEW indicates that a new topic is being opened after the 2578Second arg NEW indicates that a new topic is being opened after the
@@ -2904,7 +2904,7 @@ topic prior to the current one."
2904;;;_ : Topic Modification 2904;;;_ : Topic Modification
2905;;;_ = allout-former-auto-filler 2905;;;_ = allout-former-auto-filler
2906(defvar allout-former-auto-filler nil 2906(defvar allout-former-auto-filler nil
2907 "Name of modal fill function being wrapped by allout-auto-fill.") 2907 "Name of modal fill function being wrapped by `allout-auto-fill'.")
2908;;;_ > allout-auto-fill () 2908;;;_ > allout-auto-fill ()
2909(defun allout-auto-fill () 2909(defun allout-auto-fill ()
2910 "Allout-mode autofill function. 2910 "Allout-mode autofill function.
@@ -3022,7 +3022,7 @@ non-nil NUMBER-CONTROL forces denumbering. Non-nil INDEX (and
3022non-nil NUMBER-CONTROL) forces a numbered-prefix form. If non-nil 3022non-nil NUMBER-CONTROL) forces a numbered-prefix form. If non-nil
3023INDEX is a number, then that number is used for the numbered 3023INDEX is a number, then that number is used for the numbered
3024prefix. Non-nil and non-number means that the index for the 3024prefix. Non-nil and non-number means that the index for the
3025numbered prefix will be derived by allout-make-topic-prefix. 3025numbered prefix will be derived by `allout-make-topic-prefix'.
3026 3026
3027Fifth arg DO-SUCCESSORS t means re-resolve count on succeeding 3027Fifth arg DO-SUCCESSORS t means re-resolve count on succeeding
3028siblings. 3028siblings.
@@ -3089,7 +3089,7 @@ this function."
3089 ) ; defun 3089 ) ; defun
3090;;;_ > allout-rebullet-topic (arg) 3090;;;_ > allout-rebullet-topic (arg)
3091(defun allout-rebullet-topic (arg) 3091(defun allout-rebullet-topic (arg)
3092 "Like allout-rebullet-topic-grunt, but start from topic visible at point. 3092 "Like `allout-rebullet-topic-grunt', but start from topic visible at point.
3093 3093
3094Descends into invisible as well as visible topics, however. 3094Descends into invisible as well as visible topics, however.
3095 3095
@@ -3117,7 +3117,7 @@ With repeat count, shift topic depth by that amount."
3117 do-successors) 3117 do-successors)
3118 3118
3119 "Rebullet the topic at point, visible or invisible, and all 3119 "Rebullet the topic at point, visible or invisible, and all
3120contained subtopics. See allout-rebullet-heading for rebulleting 3120contained subtopics. See `allout-rebullet-heading' for rebulleting
3121behavior. 3121behavior.
3122 3122
3123All arguments are optional. 3123All arguments are optional.
@@ -3455,7 +3455,7 @@ Non-topic yanks work no differently than normal yanks.
3455If a topic is being yanked into a bare topic prefix, the depth of the 3455If a topic is being yanked into a bare topic prefix, the depth of the
3456yanked topic is adjusted to the depth of the topic prefix. 3456yanked topic is adjusted to the depth of the topic prefix.
3457 3457
3458 1 we're yanking in an allout-mode buffer 3458 1 we're yanking in an `allout-mode' buffer
3459 2 the stuff being yanked starts with a valid outline header prefix, and 3459 2 the stuff being yanked starts with a valid outline header prefix, and
3460 3 it is being yanked at the end of a line which consists of only a valid 3460 3 it is being yanked at the end of a line which consists of only a valid
3461 topic prefix. 3461 topic prefix.
@@ -3472,7 +3472,7 @@ exactly like normal yanks.
3472Numbering of yanked topics, and the successive siblings at the depth 3472Numbering of yanked topics, and the successive siblings at the depth
3473into which they're being yanked, is adjusted. 3473into which they're being yanked, is adjusted.
3474 3474
3475Allout-yank-pop works with allout-yank just like normal yank-pop 3475`Allout-yank-pop' works with `allout-yank' just like normal yank-pop
3476works with normal yank in non-outline buffers." 3476works with normal yank in non-outline buffers."
3477 3477
3478 (interactive "*P") 3478 (interactive "*P")
@@ -3482,7 +3482,7 @@ works with normal yank in non-outline buffers."
3482 (allout-yank-processing))) 3482 (allout-yank-processing)))
3483;;;_ > allout-yank-pop (&optional arg) 3483;;;_ > allout-yank-pop (&optional arg)
3484(defun allout-yank-pop (&optional arg) 3484(defun allout-yank-pop (&optional arg)
3485 "Yank-pop like allout-yank when popping to bare outline prefixes. 3485 "Yank-pop like `allout-yank' when popping to bare outline prefixes.
3486 3486
3487Adapts level of popped topics to level of fresh prefix. 3487Adapts level of popped topics to level of fresh prefix.
3488 3488
@@ -3561,7 +3561,7 @@ See `allout-flag-region' for more details."
3561 3561
3562This is a way to give restricted peek at a concealed locality without the 3562This is a way to give restricted peek at a concealed locality without the
3563expense of exposing its context, but can leave the outline with aberrant 3563expense of exposing its context, but can leave the outline with aberrant
3564exposure. allout-hide-current-entry-completely or allout-show-offshoot 3564exposure. `allout-hide-current-entry-completely' or `allout-show-offshoot'
3565should be used after the peek to rectify the exposure." 3565should be used after the peek to rectify the exposure."
3566 3566
3567 (interactive) 3567 (interactive)
@@ -3583,7 +3583,7 @@ should be used after the peek to rectify the exposure."
3583 3583
3584 "If point is visible, show all direct subheadings of this heading. 3584 "If point is visible, show all direct subheadings of this heading.
3585 3585
3586Otherwise, do allout-show-to-offshoot, and then show subheadings. 3586Otherwise, do `allout-show-to-offshoot', and then show subheadings.
3587 3587
3588Optional LEVEL specifies how many levels below the current level 3588Optional LEVEL specifies how many levels below the current level
3589should be shown, or all levels if t. Default is 1. 3589should be shown, or all levels if t. Default is 1.
@@ -3633,7 +3633,7 @@ point of non-opened subtree?)"
3633 "Like `allout-hide-current-entry'; hides completely if within hidden region. 3633 "Like `allout-hide-current-entry'; hides completely if within hidden region.
3634 3634
3635Specifically intended for aberrant exposure states, like entries that were 3635Specifically intended for aberrant exposure states, like entries that were
3636exposed by allout-show-entry but are within otherwise concealed regions." 3636exposed by `allout-show-entry' but are within otherwise concealed regions."
3637 (interactive) 3637 (interactive)
3638 (save-excursion 3638 (save-excursion
3639 (allout-goto-prefix) 3639 (allout-goto-prefix)
@@ -3645,10 +3645,10 @@ exposed by allout-show-entry but are within otherwise concealed regions."
3645 ?\r))) 3645 ?\r)))
3646;;;_ > allout-show-to-offshoot () 3646;;;_ > allout-show-to-offshoot ()
3647(defun allout-show-to-offshoot () 3647(defun allout-show-to-offshoot ()
3648 "Like allout-show-entry, but reveals all concealed ancestors, as well. 3648 "Like `allout-show-entry', but reveals all concealed ancestors, as well.
3649 3649
3650As with allout-hide-current-entry-completely, useful for rectifying 3650As with `allout-hide-current-entry-completely', useful for rectifying
3651aberrant exposure states produced by allout-show-entry." 3651aberrant exposure states produced by `allout-show-entry'."
3652 3652
3653 (interactive) 3653 (interactive)
3654 (save-excursion 3654 (save-excursion
@@ -3698,10 +3698,10 @@ aberrant exposure states produced by allout-show-entry."
3698;;;_ > allout-hide-current-entry-completely () 3698;;;_ > allout-hide-current-entry-completely ()
3699; ... allout-hide-current-entry-completely also for isearch dynamic exposure: 3699; ... allout-hide-current-entry-completely also for isearch dynamic exposure:
3700(defun allout-hide-current-entry-completely () 3700(defun allout-hide-current-entry-completely ()
3701 "Like allout-hide-current-entry, but conceal topic completely. 3701 "Like `allout-hide-current-entry', but conceal topic completely.
3702 3702
3703Specifically intended for aberrant exposure states, like entries that were 3703Specifically intended for aberrant exposure states, like entries that were
3704exposed by allout-show-entry but are within otherwise concealed regions." 3704exposed by `allout-show-entry' but are within otherwise concealed regions."
3705 (interactive) 3705 (interactive)
3706 (save-excursion 3706 (save-excursion
3707 (allout-goto-prefix) 3707 (allout-goto-prefix)
@@ -3926,7 +3926,7 @@ Examples:
3926;;;_ > allout-old-expose-topic (spec &rest followers) 3926;;;_ > allout-old-expose-topic (spec &rest followers)
3927(defun allout-old-expose-topic (spec &rest followers) 3927(defun allout-old-expose-topic (spec &rest followers)
3928 3928
3929 "Deprecated. Use allout-expose-topic \(with different schema 3929 "Deprecated. Use `allout-expose-topic' \(with different schema
3930format) instead. 3930format) instead.
3931 3931
3932Dictate wholesale exposure scheme for current topic, according to SPEC. 3932Dictate wholesale exposure scheme for current topic, according to SPEC.
@@ -4004,8 +4004,8 @@ Optional FOLLOWER arguments dictate exposure for succeeding siblings."
4004;;;_ > allout-new-exposure '() 4004;;;_ > allout-new-exposure '()
4005(defmacro allout-new-exposure (&rest spec) 4005(defmacro allout-new-exposure (&rest spec)
4006 "Literal frontend for `allout-expose-topic', doesn't evaluate arguments. 4006 "Literal frontend for `allout-expose-topic', doesn't evaluate arguments.
4007Some arguments that would need to be quoted in allout-expose-topic 4007Some arguments that would need to be quoted in `allout-expose-topic'
4008need not be quoted in allout-new-exposure. 4008need not be quoted in `allout-new-exposure'.
4009 4009
4010Cursor is left at start position. 4010Cursor is left at start position.
4011 4011