Commit | Line | Data |
---|---|---|
6a05d05f | 1 | ;;; allout.el --- extensive outline mode for use alone and with other modes |
19b84ba3 | 2 | |
12435002 | 3 | ;; Copyright (C) 1992, 1993, 1994, 2001 Free Software Foundation, Inc. |
1977b8f6 | 4 | |
968bc2c9 RS |
5 | ;; Author: Ken Manheimer <klm@python.org> |
6 | ;; Maintainer: Ken Manheimer <klm@python.org> | |
c567ac01 | 7 | ;; Created: Dec 1991 - first release to usenet |
5162c705 | 8 | ;; Version: $Id: allout.el,v 1.31 2001/12/09 13:13:13 pj Exp $|| |
660a1df5 | 9 | ;; Keywords: outlines mode wp languages |
1977b8f6 RS |
10 | |
11 | ;; This file is part of GNU Emacs. | |
12 | ||
59243403 RS |
13 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
14 | ;; it under the terms of the GNU General Public License as published by | |
15 | ;; the Free Software Foundation; either version 2, or (at your option) | |
16 | ;; any later version. | |
17 | ||
1977b8f6 | 18 | ;; GNU Emacs is distributed in the hope that it will be useful, |
59243403 RS |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
25 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
26 | ;; Boston, MA 02111-1307, USA. | |
1977b8f6 | 27 | |
6a05d05f | 28 | ;;; Commentary: |
19b84ba3 RS |
29 | |
30 | ;; Allout outline mode provides extensive outline formatting and | |
9179616f DL |
31 | ;; and manipulation beyond standard emacs outline mode. It provides |
32 | ;; for structured editing of outlines, as well as navigation and | |
33 | ;; exposure. It also provides for syntax-sensitive text like | |
34 | ;; programming languages. (For an example, see the allout code | |
35 | ;; itself, which is organized in ;; an outline framework.) | |
36 | ;; | |
37 | ;; In addition to outline navigation and exposure, allout includes: | |
38 | ;; | |
39 | ;; - topic-oriented repositioning, cut, and paste | |
40 | ;; - integral outline exposure-layout | |
41 | ;; - incremental search with dynamic exposure and reconcealment of hidden text | |
42 | ;; - automatic topic-number maintenance | |
43 | ;; - "Hot-spot" operation, for single-keystroke maneuvering and | |
5162c705 | 44 | ;; exposure control. (See the `outline-mode' docstring.) |
9179616f DL |
45 | ;; |
46 | ;; and many other features. | |
47 | ;; | |
48 | ;; The outline menubar additions provide quick reference to many of | |
49 | ;; the features, and see the docstring of the variable `outline-init' | |
50 | ;; for instructions on priming your emacs session for automatic | |
5162c705 | 51 | ;; activation of `outline-mode'. |
9179616f | 52 | ;; |
19b84ba3 RS |
53 | ;; See the docstring of the variables `outline-layout' and |
54 | ;; `outline-auto-activation' for details on automatic activation of | |
5162c705 | 55 | ;; allout `outline-mode' as a minor mode. (It has changed since allout |
19b84ba3 | 56 | ;; 3.x, for those of you that depend on the old method.) |
c567ac01 | 57 | ;; |
353e2ef2 KH |
58 | ;; Note - the lines beginning with `;;;_' are outline topic headers. |
59 | ;; Just `ESC-x eval-current-buffer' to give it a whirl. | |
19b84ba3 | 60 | |
9179616f | 61 | ;; Ken Manheimer klm@python.org |
c567ac01 | 62 | |
6a05d05f PJ |
63 | ;;; Code: |
64 | ||
19b84ba3 RS |
65 | ;;;_* Provide |
66 | (provide 'outline) | |
67 | (provide 'allout) | |
68 | ||
69 | ;;;_* USER CUSTOMIZATION VARIABLES: | |
4bef9110 SE |
70 | (defgroup allout nil |
71 | "Extensive outline mode for use alone and with other modes." | |
72 | :prefix "outline-" | |
73 | :group 'outlines) | |
19b84ba3 RS |
74 | |
75 | ;;;_ + Layout, Mode, and Topic Header Configuration | |
76 | ||
77 | ;;;_ = outline-auto-activation | |
9179616f | 78 | (defcustom outline-auto-activation nil |
19b84ba3 RS |
79 | "*Regulates auto-activation modality of allout outlines - see `outline-init'. |
80 | ||
81 | Setq-default by `outline-init' to regulate whether or not allout | |
82 | outline mode is automatically activated when the buffer-specific | |
83 | variable `outline-layout' is non-nil, and whether or not the layout | |
84 | dictated by `outline-layout' should be imposed on mode activation. | |
85 | ||
86 | With value `t', auto-mode-activation and auto-layout are enabled. | |
87 | \(This also depends on `outline-find-file-hooks' being installed in | |
88 | `find-file-hooks', which is also done by `outline-init'.) | |
89 | ||
90 | With value `ask', auto-mode-activation is enabled, and endorsement for | |
91 | performing auto-layout is asked of the user each time. | |
92 | ||
9179616f | 93 | With value `activate', only auto-mode-activation is enabled, |
353e2ef2 | 94 | auto-layout is not. |
19b84ba3 RS |
95 | |
96 | With value `nil', neither auto-mode-activation nor auto-layout are | |
97 | enabled. | |
98 | ||
99 | See the docstring for `outline-init' for the proper interface to | |
9179616f DL |
100 | this variable." |
101 | :type '(choice (const :tag "On" t) | |
102 | (const :tag "Ask about layout" "ask") | |
103 | (const :tag "Mode only" "activate") | |
104 | (const :tag "Off" nil)) | |
105 | :group 'allout) | |
19b84ba3 RS |
106 | ;;;_ = outline-layout |
107 | (defvar outline-layout nil | |
108 | "*Layout specification and provisional mode trigger for allout outlines. | |
1977b8f6 | 109 | |
19b84ba3 RS |
110 | Buffer-specific. |
111 | ||
112 | A list value specifies a default layout for the current buffer, to be | |
5162c705 PJ |
113 | applied upon activation of allout `outline-mode'. Any non-nil value will |
114 | automatically trigger allout `outline-mode', provided `outline-init' | |
353e2ef2 | 115 | has been called to enable it. |
19b84ba3 RS |
116 | |
117 | See the docstring for `outline-init' for details on setting up for | |
118 | auto-mode-activation, and for `outline-expose-topic' for the format of | |
119 | the layout specification. | |
120 | ||
121 | You can associate a particular outline layout with a file by setting | |
122 | this var via the file's local variables. For example, the following | |
41e798a9 | 123 | lines at the bottom of an Emacs Lisp file: |
19b84ba3 RS |
124 | |
125 | ;;;Local variables: | |
9179616f | 126 | ;;;outline-layout: \(0 : -1 -1 0) |
19b84ba3 RS |
127 | ;;;End: |
128 | ||
129 | will, modulo the above-mentioned conditions, cause the mode to be | |
130 | activated when the file is visited, followed by the equivalent of | |
9179616f | 131 | `\(outline-expose-topic 0 : -1 -1 0)'. \(This is the layout used for |
19b84ba3 RS |
132 | the allout.el, itself.) |
133 | ||
353e2ef2 KH |
134 | Also, allout's mode-specific provisions will make topic prefixes default |
135 | to the comment-start string, if any, of the language of the file. This | |
136 | is modulo the setting of `outline-use-mode-specific-leader', which see.") | |
19b84ba3 | 137 | (make-variable-buffer-local 'outline-layout) |
9179616f DL |
138 | ;;;_ = outline-show-bodies |
139 | (defcustom outline-show-bodies nil | |
140 | "*If non-nil, show entire body when exposing a topic, rather than | |
141 | just the header." | |
142 | :type 'boolean | |
143 | :group 'allout) | |
144 | (make-variable-buffer-local 'outline-show-bodies) | |
1977b8f6 | 145 | |
c567ac01 | 146 | ;;;_ = outline-header-prefix |
4bef9110 | 147 | (defcustom outline-header-prefix "." |
19b84ba3 RS |
148 | "*Leading string which helps distinguish topic headers. |
149 | ||
150 | Outline topic header lines are identified by a leading topic | |
c567ac01 RS |
151 | header prefix, which mostly have the value of this var at their front. |
152 | \(Level 1 topics are exceptions. They consist of only a single | |
19b84ba3 | 153 | character, which is typically set to the outline-primary-bullet. Many |
4bef9110 SE |
154 | outlines start at level 2 to avoid this discrepancy." |
155 | :type 'string | |
156 | :group 'allout) | |
1977b8f6 | 157 | (make-variable-buffer-local 'outline-header-prefix) |
c567ac01 | 158 | ;;;_ = outline-primary-bullet |
4bef9110 | 159 | (defcustom outline-primary-bullet "*" |
19b84ba3 RS |
160 | "Bullet used for top-level outline topics. |
161 | ||
162 | Outline topic header lines are identified by a leading topic header | |
c567ac01 RS |
163 | prefix, which is concluded by bullets that includes the value of this |
164 | var and the respective outline-*-bullets-string vars. | |
165 | ||
353e2ef2 | 166 | The value of an asterisk (`*') provides for backwards compatibility |
c567ac01 RS |
167 | with the original emacs outline mode. See outline-plain-bullets-string |
168 | and outline-distinctive-bullets-string for the range of available | |
4bef9110 SE |
169 | bullets." |
170 | :type 'string | |
171 | :group 'allout) | |
1977b8f6 | 172 | (make-variable-buffer-local 'outline-primary-bullet) |
c567ac01 | 173 | ;;;_ = outline-plain-bullets-string |
9179616f | 174 | (defcustom outline-plain-bullets-string ".:,;" |
19b84ba3 RS |
175 | "*The bullets normally used in outline topic prefixes. |
176 | ||
353e2ef2 | 177 | See `outline-distinctive-bullets-string' for the other kind of |
c567ac01 | 178 | bullets. |
1977b8f6 | 179 | |
353e2ef2 | 180 | DO NOT include the close-square-bracket, `]', as a bullet. |
1977b8f6 | 181 | |
c567ac01 | 182 | Outline mode has to be reactivated in order for changes to the value |
4bef9110 SE |
183 | of this var to take effect." |
184 | :type 'string | |
185 | :group 'allout) | |
1977b8f6 | 186 | (make-variable-buffer-local 'outline-plain-bullets-string) |
c567ac01 | 187 | ;;;_ = outline-distinctive-bullets-string |
9179616f | 188 | (defcustom outline-distinctive-bullets-string "*+-=>([{}&!?#%\"X@$~_\\" |
19b84ba3 | 189 | "*Persistent outline header bullets used to distinguish special topics. |
1977b8f6 | 190 | |
9179616f DL |
191 | These bullets are used to distinguish topics from the run-of-the-mill |
192 | ones. They are not used in the standard topic headers created by | |
193 | the topic-opening, shifting, and rebulleting \(eg, on topic shift, | |
194 | topic paste, blanket rebulleting) routines, but are offered among the | |
195 | choices for rebulleting. They are not altered by the above automatic | |
196 | rebulleting, so they can be used to characterize topics, eg: | |
197 | ||
198 | `?' question topics | |
199 | `\(' parenthetic comment \(with a matching close paren inside) | |
200 | `[' meta-note \(with a matching close ] inside) | |
201 | `\"' a quote | |
202 | `=' value settings | |
203 | `~' \"more or less\" | |
204 | ||
205 | ... just for example. (`#' typically has a special meaning to the | |
206 | software, according to the value of `outline-numbered-bullet'.) | |
207 | ||
208 | See `outline-plain-bullets-string' for the selection of | |
209 | alternating bullets. | |
1977b8f6 | 210 | |
9179616f DL |
211 | You must run `set-outline-regexp' in order for outline mode to |
212 | reconcile to changes of this value. | |
19b84ba3 | 213 | |
353e2ef2 | 214 | DO NOT include the close-square-bracket, `]', on either of the bullet |
4bef9110 SE |
215 | strings." |
216 | :type 'string | |
217 | :group 'allout) | |
1977b8f6 RS |
218 | (make-variable-buffer-local 'outline-distinctive-bullets-string) |
219 | ||
19b84ba3 | 220 | ;;;_ = outline-use-mode-specific-leader |
4bef9110 | 221 | (defcustom outline-use-mode-specific-leader t |
19b84ba3 RS |
222 | "*When non-nil, use mode-specific topic-header prefixes. |
223 | ||
224 | Allout outline mode will use the mode-specific `outline-mode-leaders' | |
225 | and/or comment-start string, if any, to lead the topic prefix string, | |
353e2ef2 | 226 | so topic headers look like comments in the programming language. |
19b84ba3 RS |
227 | |
228 | String values are used as they stand. | |
229 | ||
230 | Value `t' means to first check for assoc value in `outline-mode-leaders' | |
231 | alist, then use comment-start string, if any, then use default \(`.'). | |
9179616f | 232 | \(See note about use of comment-start strings, below.) |
19b84ba3 RS |
233 | |
234 | Set to the symbol for either of `outline-mode-leaders' or | |
235 | `comment-start' to use only one of them, respectively. | |
236 | ||
9179616f | 237 | Value `nil' means to always use the default \(`.'). |
19b84ba3 RS |
238 | |
239 | comment-start strings that do not end in spaces are tripled, and an | |
353e2ef2 | 240 | `_' underscore is tacked on the end, to distinguish them from regular |
19b84ba3 | 241 | comment strings. comment-start strings that do end in spaces are not |
9179616f | 242 | tripled, but an underscore is substituted for the space. [This |
19b84ba3 RS |
243 | presumes that the space is for appearance, not comment syntax. You |
244 | can use `outline-mode-leaders' to override this behavior, when | |
4bef9110 SE |
245 | incorrect.]" |
246 | :type '(choice (const t) (const nil) string | |
247 | (const outline-mode-leaders) | |
248 | (const comment-start)) | |
249 | :group 'allout) | |
19b84ba3 RS |
250 | ;;;_ = outline-mode-leaders |
251 | (defvar outline-mode-leaders '() | |
252 | "Specific outline-prefix leading strings per major modes. | |
253 | ||
9179616f | 254 | Entries will be used instead or in lieu of mode-specific |
19b84ba3 RS |
255 | comment-start strings. See also `outline-use-mode-specific-leader'. |
256 | ||
257 | If you're constructing a string that will comment-out outline | |
258 | structuring so it can be included in program code, append an extra | |
259 | character, like an \"_\" underscore, to distinguish the lead string | |
260 | from regular comments that start at bol.") | |
261 | ||
c567ac01 | 262 | ;;;_ = outline-old-style-prefixes |
4bef9110 | 263 | (defcustom outline-old-style-prefixes nil |
353e2ef2 | 264 | "*When non-nil, use only old-and-crusty outline-mode `*' topic prefixes. |
19b84ba3 RS |
265 | |
266 | Non-nil restricts the topic creation and modification | |
c567ac01 RS |
267 | functions to asterix-padded prefixes, so they look exactly |
268 | like the original emacs-outline style prefixes. | |
1977b8f6 | 269 | |
c567ac01 | 270 | Whatever the setting of this variable, both old and new style prefixes |
4bef9110 SE |
271 | are always respected by the topic maneuvering functions." |
272 | :type 'boolean | |
273 | :group 'allout) | |
1977b8f6 | 274 | (make-variable-buffer-local 'outline-old-style-prefixes) |
19b84ba3 | 275 | ;;;_ = outline-stylish-prefixes - alternating bullets |
4bef9110 | 276 | (defcustom outline-stylish-prefixes t |
19b84ba3 | 277 | "*Do fancy stuff with topic prefix bullets according to level, etc. |
c567ac01 | 278 | |
19b84ba3 RS |
279 | Non-nil enables topic creation, modification, and repositioning |
280 | functions to vary the topic bullet char (the char that marks the topic | |
281 | depth) just preceding the start of the topic text) according to level. | |
353e2ef2 | 282 | Otherwise, only asterisks (`*') and distinctive bullets are used. |
19b84ba3 RS |
283 | |
284 | This is how an outline can look (but sans indentation) with stylish | |
285 | prefixes: | |
c567ac01 RS |
286 | |
287 | * Top level | |
288 | .* A topic | |
289 | . + One level 3 subtopic | |
290 | . . One level 4 subtopic | |
19b84ba3 | 291 | . . A second 4 subtopic |
c567ac01 | 292 | . + Another level 3 subtopic |
19b84ba3 RS |
293 | . #1 A numbered level 4 subtopic |
294 | . #2 Another | |
295 | . ! Another level 4 subtopic with a different distinctive bullet | |
296 | . #4 And another numbered level 4 subtopic | |
c567ac01 | 297 | |
19b84ba3 RS |
298 | This would be an outline with stylish prefixes inhibited (but the |
299 | numbered and other distinctive bullets retained): | |
c567ac01 RS |
300 | |
301 | * Top level | |
302 | .* A topic | |
19b84ba3 RS |
303 | . * One level 3 subtopic |
304 | . * One level 4 subtopic | |
305 | . * A second 4 subtopic | |
306 | . * Another level 3 subtopic | |
307 | . #1 A numbered level 4 subtopic | |
308 | . #2 Another | |
309 | . ! Another level 4 subtopic with a different distinctive bullet | |
310 | . #4 And another numbered level 4 subtopic | |
c567ac01 RS |
311 | |
312 | Stylish and constant prefixes (as well as old-style prefixes) are | |
313 | always respected by the topic maneuvering functions, regardless of | |
314 | this variable setting. | |
315 | ||
316 | The setting of this var is not relevant when outline-old-style-prefixes | |
4bef9110 SE |
317 | is non-nil." |
318 | :type 'boolean | |
319 | :group 'allout) | |
c567ac01 | 320 | (make-variable-buffer-local 'outline-stylish-prefixes) |
1977b8f6 | 321 | |
c567ac01 | 322 | ;;;_ = outline-numbered-bullet |
4bef9110 | 323 | (defcustom outline-numbered-bullet "#" |
19b84ba3 RS |
324 | "*String designating bullet of topics that have auto-numbering; nil for none. |
325 | ||
a0776d6b | 326 | Topics having this bullet have automatic maintenance of a sibling |
19b84ba3 | 327 | sequence-number tacked on, just after the bullet. Conventionally set |
c567ac01 | 328 | to \"#\", you can set it to a bullet of your choice. A nil value |
4bef9110 SE |
329 | disables numbering maintenance." |
330 | :type '(choice (const nil) string) | |
331 | :group 'allout) | |
c567ac01 | 332 | (make-variable-buffer-local 'outline-numbered-bullet) |
c567ac01 | 333 | ;;;_ = outline-file-xref-bullet |
4bef9110 | 334 | (defcustom outline-file-xref-bullet "@" |
19b84ba3 RS |
335 | "*Bullet signifying file cross-references, for `outline-resolve-xref'. |
336 | ||
9179616f | 337 | Set this var to the bullet you want to use for file cross-references." |
4bef9110 SE |
338 | :type '(choice (const nil) string) |
339 | :group 'allout) | |
c567ac01 | 340 | |
9179616f DL |
341 | ;;;_ = outline-presentation-padding |
342 | (defcustom outline-presentation-padding 2 | |
343 | "*Presentation-format white-space padding factor, for greater indent." | |
344 | :type 'integer | |
345 | :group 'allout) | |
346 | ||
347 | (make-variable-buffer-local 'outline-presentation-padding) | |
348 | ||
349 | ;;;_ = outline-abbreviate-flattened-numbering | |
350 | (defcustom outline-abbreviate-flattened-numbering nil | |
351 | "*If non-nil, `outline-flatten-exposed-to-buffer' abbreviates topic | |
352 | numbers to minimal amount with some context. Otherwise, entire | |
353 | numbers are always used." | |
354 | :type 'boolean | |
355 | :group 'allout) | |
356 | ||
c567ac01 RS |
357 | ;;;_ + LaTeX formatting |
358 | ;;;_ - outline-number-pages | |
4bef9110 SE |
359 | (defcustom outline-number-pages nil |
360 | "*Non-nil turns on page numbering for LaTeX formatting of an outline." | |
361 | :type 'boolean | |
362 | :group 'allout) | |
c567ac01 | 363 | ;;;_ - outline-label-style |
4bef9110 SE |
364 | (defcustom outline-label-style "\\large\\bf" |
365 | "*Font and size of labels for LaTeX formatting of an outline." | |
366 | :type 'string | |
367 | :group 'allout) | |
c567ac01 | 368 | ;;;_ - outline-head-line-style |
4bef9110 SE |
369 | (defcustom outline-head-line-style "\\large\\sl " |
370 | "*Font and size of entries for LaTeX formatting of an outline." | |
371 | :type 'string | |
372 | :group 'allout) | |
c567ac01 | 373 | ;;;_ - outline-body-line-style |
4bef9110 SE |
374 | (defcustom outline-body-line-style " " |
375 | "*Font and size of entries for LaTeX formatting of an outline." | |
376 | :type 'string | |
377 | :group 'allout) | |
c567ac01 | 378 | ;;;_ - outline-title-style |
4bef9110 SE |
379 | (defcustom outline-title-style "\\Large\\bf" |
380 | "*Font and size of titles for LaTeX formatting of an outline." | |
381 | :type 'string | |
382 | :group 'allout) | |
c567ac01 | 383 | ;;;_ - outline-title |
4bef9110 | 384 | (defcustom outline-title '(or buffer-file-name (current-buffer-name)) |
c567ac01 | 385 | "*Expression to be evaluated to determine the title for LaTeX |
4bef9110 SE |
386 | formatted copy." |
387 | :type 'sexp | |
388 | :group 'allout) | |
c567ac01 | 389 | ;;;_ - outline-line-skip |
4bef9110 SE |
390 | (defcustom outline-line-skip ".05cm" |
391 | "*Space between lines for LaTeX formatting of an outline." | |
392 | :type 'string | |
393 | :group 'allout) | |
c567ac01 | 394 | ;;;_ - outline-indent |
4bef9110 SE |
395 | (defcustom outline-indent ".3cm" |
396 | "*LaTeX formatted depth-indent spacing." | |
397 | :type 'string | |
398 | :group 'allout) | |
c567ac01 RS |
399 | |
400 | ;;;_ + Miscellaneous customization | |
401 | ||
9179616f DL |
402 | ;;;_ = outline-command-prefix |
403 | (defcustom outline-command-prefix "\C-c" | |
404 | "*Key sequence to be used as prefix for outline mode command key bindings." | |
405 | :type 'string | |
406 | :group 'allout) | |
407 | ||
c567ac01 | 408 | ;;;_ = outline-keybindings-list |
353e2ef2 | 409 | ;;; You have to reactivate outline-mode - `(outline-mode t)' - to |
c567ac01 RS |
410 | ;;; institute changes to this var. |
411 | (defvar outline-keybindings-list () | |
9179616f | 412 | "*List of outline-mode key / function bindings, for outline-mode-map. |
19b84ba3 | 413 | |
9179616f DL |
414 | String or vector key will be prefaced with outline-command-prefix, |
415 | unless optional third, non-nil element is present.") | |
c567ac01 | 416 | (setq outline-keybindings-list |
1977b8f6 RS |
417 | '( |
418 | ; Motion commands: | |
c567ac01 RS |
419 | ("\C-n" outline-next-visible-heading) |
420 | ("\C-p" outline-previous-visible-heading) | |
421 | ("\C-u" outline-up-current-level) | |
422 | ("\C-f" outline-forward-current-level) | |
423 | ("\C-b" outline-backward-current-level) | |
424 | ("\C-a" outline-beginning-of-current-entry) | |
425 | ("\C-e" outline-end-of-current-entry) | |
1977b8f6 | 426 | ; Exposure commands: |
c567ac01 RS |
427 | ("\C-i" outline-show-children) |
428 | ("\C-s" outline-show-current-subtree) | |
429 | ("\C-h" outline-hide-current-subtree) | |
430 | ("\C-o" outline-show-current-entry) | |
431 | ("!" outline-show-all) | |
1977b8f6 | 432 | ; Alteration commands: |
c567ac01 RS |
433 | (" " outline-open-sibtopic) |
434 | ("." outline-open-subtopic) | |
435 | ("," outline-open-supertopic) | |
436 | ("'" outline-shift-in) | |
437 | (">" outline-shift-in) | |
438 | ("<" outline-shift-out) | |
439 | ("\C-m" outline-rebullet-topic) | |
c98fe76f | 440 | ("*" outline-rebullet-current-heading) |
c567ac01 RS |
441 | ("#" outline-number-siblings) |
442 | ("\C-k" outline-kill-line t) | |
443 | ("\C-y" outline-yank t) | |
444 | ("\M-y" outline-yank-pop t) | |
445 | ("\C-k" outline-kill-topic) | |
1977b8f6 | 446 | ; Miscellaneous commands: |
9179616f | 447 | ;([?\C-\ ] outline-mark-topic) |
c567ac01 | 448 | ("@" outline-resolve-xref) |
9179616f DL |
449 | ("=c" outline-copy-exposed-to-buffer) |
450 | ("=i" outline-indented-exposed-to-buffer) | |
451 | ("=t" outline-latexify-exposed) | |
452 | ("=p" outline-flatten-exposed-to-buffer))) | |
453 | ||
454 | ;;;_ = outline-isearch-dynamic-expose | |
455 | (defcustom outline-isearch-dynamic-expose t | |
456 | "*Non-nil enable dynamic exposure of hidden incremental-search | |
457 | targets as they're encountered." | |
4bef9110 SE |
458 | :type 'boolean |
459 | :group 'allout) | |
9179616f | 460 | (make-variable-buffer-local 'outline-isearch-dynamic-expose) |
c567ac01 RS |
461 | |
462 | ;;;_ = outline-use-hanging-indents | |
4bef9110 | 463 | (defcustom outline-use-hanging-indents t |
19b84ba3 RS |
464 | "*If non-nil, topic body text auto-indent defaults to indent of the header. |
465 | Ie, it is indented to be just past the header prefix. This is | |
466 | relevant mostly for use with indented-text-mode, or other situations | |
467 | where auto-fill occurs. | |
c567ac01 | 468 | |
353e2ef2 | 469 | \[This feature no longer depends in any way on the `filladapt.el' |
4bef9110 SE |
470 | lisp-archive package.\]" |
471 | :type 'boolean | |
472 | :group 'allout) | |
c567ac01 RS |
473 | (make-variable-buffer-local 'outline-use-hanging-indents) |
474 | ||
475 | ;;;_ = outline-reindent-bodies | |
4bef9110 | 476 | (defcustom outline-reindent-bodies (if outline-use-hanging-indents |
8d118843 | 477 | 'text) |
19b84ba3 | 478 | "*Non-nil enables auto-adjust of topic body hanging indent with depth shifts. |
1977b8f6 | 479 | |
8d118843 RS |
480 | When active, topic body lines that are indented even with or beyond |
481 | their topic header are reindented to correspond with depth shifts of | |
482 | the header. | |
483 | ||
484 | A value of `t' enables reindent in non-programming-code buffers, ie | |
485 | those that do not have the variable `comment-start' set. A value of | |
4bef9110 SE |
486 | `force' enables reindent whether or not `comment-start' is set." |
487 | :type '(choice (const nil) (const t) (const text) (const force)) | |
488 | :group 'allout) | |
8d118843 | 489 | |
19b84ba3 | 490 | (make-variable-buffer-local 'outline-reindent-bodies) |
c567ac01 RS |
491 | |
492 | ;;;_ = outline-inhibit-protection | |
4bef9110 | 493 | (defcustom outline-inhibit-protection nil |
19b84ba3 RS |
494 | "*Non-nil disables warnings and confirmation-checks for concealed-text edits. |
495 | ||
496 | Outline mode uses emacs change-triggered functions to detect unruly | |
497 | changes to concealed regions. Set this var non-nil to disable the | |
498 | protection, potentially increasing text-entry responsiveness a bit. | |
c567ac01 | 499 | |
19b84ba3 RS |
500 | This var takes effect at outline-mode activation, so you may have to |
501 | deactivate and then reactivate the mode if you want to toggle the | |
4bef9110 SE |
502 | behavior." |
503 | :type 'boolean | |
504 | :group 'allout) | |
c567ac01 | 505 | |
19b84ba3 | 506 | ;;;_* CODE - no user customizations below. |
c567ac01 | 507 | |
9179616f DL |
508 | ;;;_ #1 Internal Outline Formatting and Configuration |
509 | ;;;_ : Version | |
19b84ba3 RS |
510 | ;;;_ = outline-version |
511 | (defvar outline-version | |
5162c705 | 512 | (let ((rcs-rev "$Revision: 1.31 $")) |
19b84ba3 RS |
513 | (condition-case err |
514 | (save-match-data | |
8d118843 | 515 | (string-match "Revision: \\([0-9]+\\.[0-9]+\\)" rcs-rev) |
19b84ba3 | 516 | (substring rcs-rev (match-beginning 1) (match-end 1))) |
9179616f | 517 | ('error rcs-rev))) |
8d118843 | 518 | "Revision number of currently loaded outline package. \(allout.el)") |
19b84ba3 RS |
519 | ;;;_ > outline-version |
520 | (defun outline-version (&optional here) | |
521 | "Return string describing the loaded outline version." | |
522 | (interactive "P") | |
523 | (let ((msg (concat "Allout Outline Mode v " outline-version))) | |
eac9cf5f | 524 | (if here (insert msg)) |
19b84ba3 RS |
525 | (message "%s" msg) |
526 | msg)) | |
9179616f | 527 | ;;;_ : Topic header format |
c567ac01 | 528 | ;;;_ = outline-regexp |
1977b8f6 | 529 | (defvar outline-regexp "" |
c567ac01 | 530 | "*Regular expression to match the beginning of a heading line. |
19b84ba3 | 531 | |
c567ac01 RS |
532 | Any line whose beginning matches this regexp is considered a |
533 | heading. This var is set according to the user configuration vars | |
534 | by set-outline-regexp.") | |
1977b8f6 | 535 | (make-variable-buffer-local 'outline-regexp) |
c567ac01 | 536 | ;;;_ = outline-bullets-string |
1977b8f6 | 537 | (defvar outline-bullets-string "" |
19b84ba3 RS |
538 | "A string dictating the valid set of outline topic bullets. |
539 | ||
353e2ef2 KH |
540 | This var should *not* be set by the user - it is set by `set-outline-regexp', |
541 | and is produced from the elements of `outline-plain-bullets-string' | |
542 | and `outline-distinctive-bullets-string'.") | |
1977b8f6 | 543 | (make-variable-buffer-local 'outline-bullets-string) |
c567ac01 RS |
544 | ;;;_ = outline-bullets-string-len |
545 | (defvar outline-bullets-string-len 0 | |
546 | "Length of current buffers' outline-plain-bullets-string.") | |
547 | (make-variable-buffer-local 'outline-bullets-string-len) | |
548 | ;;;_ = outline-line-boundary-regexp | |
1977b8f6 | 549 | (defvar outline-line-boundary-regexp () |
19b84ba3 RS |
550 | "Outline-regexp with outline-style beginning-of-line anchor. |
551 | ||
a4e104bf | 552 | \(Ie, C-j, *or* C-m, for prefixes of hidden topics). This is properly |
353e2ef2 | 553 | set when outline-regexp is produced by `set-outline-regexp', so |
c567ac01 | 554 | that (match-beginning 2) and (match-end 2) delimit the prefix.") |
1977b8f6 | 555 | (make-variable-buffer-local 'outline-line-boundary-regexp) |
c567ac01 | 556 | ;;;_ = outline-bob-regexp |
1977b8f6 | 557 | (defvar outline-bob-regexp () |
19b84ba3 | 558 | "Like outline-line-boundary-regexp, for headers at beginning of buffer. |
9179616f | 559 | \(match-beginning 2) and \(match-end 2) delimit the prefix.") |
c567ac01 | 560 | (make-variable-buffer-local 'outline-bob-regexp) |
c567ac01 RS |
561 | ;;;_ = outline-header-subtraction |
562 | (defvar outline-header-subtraction (1- (length outline-header-prefix)) | |
19b84ba3 | 563 | "Outline-header prefix length to subtract when computing topic depth.") |
c567ac01 RS |
564 | (make-variable-buffer-local 'outline-header-subtraction) |
565 | ;;;_ = outline-plain-bullets-string-len | |
566 | (defvar outline-plain-bullets-string-len (length outline-plain-bullets-string) | |
567 | "Length of outline-plain-bullets-string, updated by set-outline-regexp.") | |
568 | (make-variable-buffer-local 'outline-plain-bullets-string-len) | |
569 | ||
570 | ||
8d118843 | 571 | ;;;_ X outline-reset-header-lead (header-lead) |
1977b8f6 | 572 | (defun outline-reset-header-lead (header-lead) |
c567ac01 | 573 | "*Reset the leading string used to identify topic headers." |
1977b8f6 | 574 | (interactive "sNew lead string: ") |
1977b8f6 RS |
575 | (setq outline-header-prefix header-lead) |
576 | (setq outline-header-subtraction (1- (length outline-header-prefix))) | |
c567ac01 | 577 | (set-outline-regexp)) |
8d118843 | 578 | ;;;_ X outline-lead-with-comment-string (header-lead) |
1977b8f6 | 579 | (defun outline-lead-with-comment-string (&optional header-lead) |
19b84ba3 RS |
580 | "*Set the topic-header leading string to specified string. |
581 | ||
582 | Useful when for encapsulating outline structure in programming | |
583 | language comments. Returns the leading string." | |
1977b8f6 RS |
584 | |
585 | (interactive "P") | |
586 | (if (not (stringp header-lead)) | |
587 | (setq header-lead (read-string | |
588 | "String prefix for topic headers: "))) | |
589 | (setq outline-reindent-bodies nil) | |
590 | (outline-reset-header-lead header-lead) | |
591 | header-lead) | |
8d118843 RS |
592 | ;;;_ > outline-infer-header-lead () |
593 | (defun outline-infer-header-lead () | |
19b84ba3 RS |
594 | "Determine appropriate `outline-header-prefix'. |
595 | ||
596 | Works according to settings of: | |
597 | ||
8d118843 | 598 | `comment-start' |
19b84ba3 RS |
599 | `outline-header-prefix' (default) |
600 | `outline-use-mode-specific-leader' | |
601 | and `outline-mode-leaders'. | |
602 | ||
9179616f | 603 | Apply this via \(re)activation of `outline-mode', rather than |
8d118843 | 604 | invoking it directly." |
19b84ba3 RS |
605 | (let* ((use-leader (and (boundp 'outline-use-mode-specific-leader) |
606 | (if (or (stringp outline-use-mode-specific-leader) | |
607 | (memq outline-use-mode-specific-leader | |
608 | '(outline-mode-leaders | |
609 | comment-start | |
610 | t))) | |
611 | outline-use-mode-specific-leader | |
612 | ;; Oops - garbled value, equate with effect of 't: | |
613 | t))) | |
614 | (leader | |
615 | (cond | |
616 | ((not use-leader) nil) | |
617 | ;; Use the explicitly designated leader: | |
618 | ((stringp use-leader) use-leader) | |
619 | (t (or (and (memq use-leader '(t outline-mode-leaders)) | |
620 | ;; Get it from outline mode leaders? | |
621 | (cdr (assq major-mode outline-mode-leaders))) | |
622 | ;; ... didn't get from outline-mode-leaders... | |
623 | (and (memq use-leader '(t comment-start)) | |
624 | comment-start | |
625 | ;; Use comment-start, maybe tripled, and with | |
353e2ef2 | 626 | ;; underscore: |
19b84ba3 RS |
627 | (concat |
628 | (if (string= " " | |
629 | (substring comment-start | |
630 | (1- (length comment-start)))) | |
631 | ;; Use comment-start, sans trailing space: | |
632 | (substring comment-start 0 -1) | |
633 | (concat comment-start comment-start comment-start)) | |
634 | ;; ... and append underscore, whichever: | |
635 | "_"))))))) | |
636 | (if (not leader) | |
637 | nil | |
638 | (if (string= leader outline-header-prefix) | |
639 | nil ; no change, nothing to do. | |
640 | (setq outline-header-prefix leader) | |
19b84ba3 | 641 | outline-header-prefix)))) |
8d118843 RS |
642 | ;;;_ > outline-infer-body-reindent () |
643 | (defun outline-infer-body-reindent () | |
644 | "Determine proper setting for `outline-reindent-bodies'. | |
645 | ||
646 | Depends on default setting of `outline-reindent-bodies' \(which see) | |
647 | and presence of setting for `comment-start', to tell whether the | |
648 | file is programming code." | |
649 | (if (and outline-reindent-bodies | |
650 | comment-start | |
651 | (not (eq 'force outline-reindent-bodies))) | |
652 | (setq outline-reindent-bodies nil))) | |
c567ac01 | 653 | ;;;_ > set-outline-regexp () |
1977b8f6 | 654 | (defun set-outline-regexp () |
19b84ba3 RS |
655 | "Generate proper topic-header regexp form for outline functions. |
656 | ||
657 | Works with respect to `outline-plain-bullets-string' and | |
658 | `outline-distinctive-bullets-string'." | |
1977b8f6 RS |
659 | |
660 | (interactive) | |
661 | ;; Derive outline-bullets-string from user configured components: | |
662 | (setq outline-bullets-string "") | |
663 | (let ((strings (list 'outline-plain-bullets-string | |
9179616f DL |
664 | 'outline-distinctive-bullets-string |
665 | 'outline-primary-bullet)) | |
1977b8f6 RS |
666 | cur-string |
667 | cur-len | |
c567ac01 | 668 | cur-char |
1977b8f6 RS |
669 | cur-char-string |
670 | index | |
671 | new-string) | |
672 | (while strings | |
673 | (setq new-string "") (setq index 0) | |
674 | (setq cur-len (length (setq cur-string (symbol-value (car strings))))) | |
675 | (while (< index cur-len) | |
676 | (setq cur-char (aref cur-string index)) | |
677 | (setq outline-bullets-string | |
678 | (concat outline-bullets-string | |
679 | (cond | |
680 | ; Single dash would denote a | |
681 | ; sequence, repeated denotes | |
682 | ; a dash: | |
683 | ((eq cur-char ?-) "--") | |
684 | ; literal close-square-bracket | |
685 | ; doesn't work right in the | |
686 | ; expr, exclude it: | |
687 | ((eq cur-char ?\]) "") | |
688 | (t (regexp-quote (char-to-string cur-char)))))) | |
689 | (setq index (1+ index))) | |
690 | (setq strings (cdr strings))) | |
691 | ) | |
692 | ;; Derive next for repeated use in outline-pending-bullet: | |
693 | (setq outline-plain-bullets-string-len (length outline-plain-bullets-string)) | |
694 | (setq outline-header-subtraction (1- (length outline-header-prefix))) | |
695 | ;; Produce the new outline-regexp: | |
696 | (setq outline-regexp (concat "\\(\\" | |
697 | outline-header-prefix | |
698 | "[ \t]*[" | |
699 | outline-bullets-string | |
700 | "]\\)\\|\\" | |
701 | outline-primary-bullet | |
702 | "+\\|\^l")) | |
703 | (setq outline-line-boundary-regexp | |
c567ac01 | 704 | (concat "\\([\n\r]\\)\\(" outline-regexp "\\)")) |
1977b8f6 RS |
705 | (setq outline-bob-regexp |
706 | (concat "\\(\\`\\)\\(" outline-regexp "\\)")) | |
707 | ) | |
9179616f | 708 | ;;;_ : Key bindings |
19b84ba3 RS |
709 | ;;;_ = outline-mode-map |
710 | (defvar outline-mode-map nil "Keybindings for (allout) outline minor mode.") | |
711 | ;;;_ > produce-outline-mode-map (keymap-alist &optional base-map) | |
712 | (defun produce-outline-mode-map (keymap-list &optional base-map) | |
713 | "Produce keymap for use as outline-mode-map, from keymap-list. | |
714 | ||
715 | Built on top of optional BASE-MAP, or empty sparse map if none specified. | |
716 | See doc string for outline-keybindings-list for format of binding list." | |
9179616f DL |
717 | (let ((map (or base-map (make-sparse-keymap))) |
718 | (pref (list outline-command-prefix))) | |
719 | (mapcar (function | |
720 | (lambda (cell) | |
721 | (let ((add-pref (null (cdr (cdr cell)))) | |
722 | (key-suff (list (car cell)))) | |
723 | (apply 'define-key | |
724 | (list map | |
725 | (apply 'concat (if add-pref | |
726 | (append pref key-suff) | |
727 | key-suff)) | |
728 | (car (cdr cell))))))) | |
19b84ba3 RS |
729 | keymap-list) |
730 | map)) | |
731 | ;;;_ = outline-prior-bindings - being deprecated. | |
353e2ef2 | 732 | (defvar outline-prior-bindings nil |
c567ac01 RS |
733 | "Variable for use in V18, with outline-added-bindings, for |
734 | resurrecting, on mode deactivation, bindings that existed before | |
19b84ba3 RS |
735 | activation. Being deprecated.") |
736 | ;;;_ = outline-added-bindings - being deprecated | |
353e2ef2 | 737 | (defvar outline-added-bindings nil |
c567ac01 RS |
738 | "Variable for use in V18, with outline-prior-bindings, for |
739 | resurrecting, on mode deactivation, bindings that existed before | |
19b84ba3 | 740 | activation. Being deprecated.") |
9179616f DL |
741 | ;;;_ : Menu bar |
742 | (defun produce-outline-mode-menubar-entries () | |
743 | (require 'easymenu) | |
744 | (easy-menu-define outline-mode-exposure-menu | |
745 | outline-mode-map | |
746 | "Allout outline exposure menu." | |
747 | '("Exposure" | |
748 | ["Show Entry" outline-show-current-entry t] | |
749 | ["Show Children" outline-show-children t] | |
750 | ["Show Subtree" outline-show-current-subtree t] | |
751 | ["Hide Subtree" outline-hide-current-subtree t] | |
752 | ["Hide Leaves" outline-hide-current-leaves t] | |
753 | "----" | |
754 | ["Show All" outline-show-all t])) | |
755 | (easy-menu-define outline-mode-editing-menu | |
756 | outline-mode-map | |
757 | "Allout outline editing menu." | |
758 | '("Headings" | |
759 | ["Open Sibling" outline-open-sibtopic t] | |
760 | ["Open Subtopic" outline-open-subtopic t] | |
761 | ["Open Supertopic" outline-open-supertopic t] | |
762 | "----" | |
763 | ["Shift Topic In" outline-shift-in t] | |
764 | ["Shift Topic Out" outline-shift-out t] | |
765 | ["Rebullet Topic" outline-rebullet-topic t] | |
766 | ["Rebullet Heading" outline-rebullet-current-heading t] | |
767 | ["Number Siblings" outline-number-siblings t])) | |
768 | (easy-menu-define outline-mode-navigation-menu | |
769 | outline-mode-map | |
770 | "Allout outline navigation menu." | |
771 | '("Navigation" | |
772 | ["Next Visible Heading" outline-next-visible-heading t] | |
773 | ["Previous Visible Heading" | |
774 | outline-previous-visible-heading t] | |
775 | "----" | |
776 | ["Up Level" outline-up-current-level t] | |
777 | ["Forward Current Level" outline-forward-current-level t] | |
778 | ["Backward Current Level" | |
779 | outline-backward-current-level t] | |
780 | "----" | |
781 | ["Beginning of Entry" | |
782 | outline-beginning-of-current-entry t] | |
783 | ["End of Entry" outline-end-of-current-entry t] | |
784 | ["End of Subtree" outline-end-of-current-subtree t])) | |
785 | (easy-menu-define outline-mode-misc-menu | |
786 | outline-mode-map | |
787 | "Allout outlines miscellaneous bindings." | |
788 | '("Misc" | |
789 | ["Version" outline-version t] | |
790 | "----" | |
791 | ["Duplicate Exposed" outline-copy-exposed-to-buffer t] | |
792 | ["Duplicate Exposed, numbered" | |
793 | outline-flatten-exposed-to-buffer t] | |
794 | ["Duplicate Exposed, indented" | |
795 | outline-indented-exposed-to-buffer t] | |
796 | "----" | |
797 | ["Set Header Lead" outline-reset-header-lead t] | |
798 | ["Set New Exposure" outline-expose-topic t]))) | |
799 | ;;;_ : Mode-Specific Variable Maintenance Utilities | |
c567ac01 | 800 | ;;;_ = outline-mode-prior-settings |
1977b8f6 | 801 | (defvar outline-mode-prior-settings nil |
19b84ba3 | 802 | "Internal outline mode use; settings to be resumed on mode deactivation.") |
1977b8f6 | 803 | (make-variable-buffer-local 'outline-mode-prior-settings) |
c567ac01 | 804 | ;;;_ > outline-resumptions (name &optional value) |
1977b8f6 RS |
805 | (defun outline-resumptions (name &optional value) |
806 | ||
19b84ba3 RS |
807 | "Registers or resumes settings over outline-mode activation/deactivation. |
808 | ||
809 | First arg is NAME of variable affected. Optional second arg is list | |
810 | containing outline-mode-specific VALUE to be imposed on named | |
811 | variable, and to be registered. (It's a list so you can specify | |
812 | registrations of null values.) If no value is specified, the | |
813 | registered value is returned (encapsulated in the list, so the caller | |
814 | can distinguish nil vs no value), and the registration is popped | |
c567ac01 | 815 | from the list." |
1977b8f6 RS |
816 | |
817 | (let ((on-list (assq name outline-mode-prior-settings)) | |
353e2ef2 | 818 | prior-capsule ; By `capsule' i mean a list |
1977b8f6 RS |
819 | ; containing a value, so we can |
820 | ; distinguish nil from no value. | |
821 | ) | |
822 | ||
823 | (if value | |
824 | ||
825 | ;; Registering: | |
826 | (progn | |
827 | (if on-list | |
828 | nil ; Already preserved prior value - don't mess with it. | |
829 | ;; Register the old value, or nil if previously unbound: | |
830 | (setq outline-mode-prior-settings | |
831 | (cons (list name | |
832 | (if (boundp name) (list (symbol-value name)))) | |
833 | outline-mode-prior-settings))) | |
c567ac01 RS |
834 | ; And impose the new value, locally: |
835 | (progn (make-local-variable name) | |
836 | (set name (car value)))) | |
1977b8f6 RS |
837 | |
838 | ;; Relinquishing: | |
839 | (if (not on-list) | |
840 | ||
841 | ;; Oops, not registered - leave it be: | |
842 | nil | |
843 | ||
844 | ;; Some registration: | |
845 | ; reestablish it: | |
846 | (setq prior-capsule (car (cdr on-list))) | |
847 | (if prior-capsule | |
848 | (set name (car prior-capsule)) ; Some prior value - reestablish it. | |
849 | (makunbound name)) ; Previously unbound - demolish var. | |
850 | ; Remove registration: | |
851 | (let (rebuild) | |
852 | (while outline-mode-prior-settings | |
853 | (if (not (eq (car outline-mode-prior-settings) | |
854 | on-list)) | |
855 | (setq rebuild | |
856 | (cons (car outline-mode-prior-settings) | |
857 | rebuild))) | |
858 | (setq outline-mode-prior-settings | |
859 | (cdr outline-mode-prior-settings))) | |
860 | (setq outline-mode-prior-settings rebuild))))) | |
861 | ) | |
9179616f | 862 | ;;;_ : Mode-specific incidentals |
c567ac01 RS |
863 | ;;;_ = outline-during-write-cue nil |
864 | (defvar outline-during-write-cue nil | |
19b84ba3 | 865 | "Used to inhibit outline change-protection during file write. |
c567ac01 | 866 | |
19b84ba3 RS |
867 | See also `outline-post-command-business', `outline-write-file-hook', |
868 | `outline-before-change-protect', and `outline-post-command-business' | |
869 | functions.") | |
9179616f DL |
870 | ;;;_ = outline-pre-was-isearching nil |
871 | (defvar outline-pre-was-isearching nil | |
872 | "Cue for isearch-dynamic-exposure mechanism, implemented in | |
873 | outline-pre- and -post-command-hooks.") | |
874 | (make-variable-buffer-local 'outline-pre-was-isearching) | |
875 | ;;;_ = outline-isearch-prior-pos nil | |
876 | (defvar outline-isearch-prior-pos nil | |
877 | "Cue for isearch-dynamic-exposure tracking, used by outline-isearch-expose.") | |
878 | (make-variable-buffer-local 'outline-isearch-prior-pos) | |
879 | ;;;_ = outline-isearch-did-quit | |
880 | (defvar outline-isearch-did-quit nil | |
881 | "Distinguishes isearch conclusion and cancellation. | |
882 | ||
883 | Maintained by outline-isearch-abort \(which is wrapped around the real | |
884 | isearch-abort), and monitored by outline-isearch-expose for action.") | |
885 | (make-variable-buffer-local 'outline-isearch-did-quit) | |
c567ac01 RS |
886 | ;;;_ = outline-override-protect nil |
887 | (defvar outline-override-protect nil | |
19b84ba3 RS |
888 | "Used in outline-mode for regulate of concealed-text protection mechanism. |
889 | ||
890 | Allout outline mode regulates alteration of concealed text to protect | |
a0776d6b | 891 | against inadvertent, unnoticed changes. This is for use by specific, |
19b84ba3 RS |
892 | native outline functions to temporarily override that protection. |
893 | It's automatically reset to nil after every buffer modification.") | |
c567ac01 RS |
894 | (make-variable-buffer-local 'outline-override-protect) |
895 | ;;;_ > outline-unprotected (expr) | |
896 | (defmacro outline-unprotected (expr) | |
9179616f DL |
897 | "Evaluate EXPRESSION with `outline-override-protect' let-bound `t'." |
898 | `(let ((outline-override-protect t)) | |
899 | ,expr)) | |
c567ac01 RS |
900 | ;;;_ = outline-undo-aggregation |
901 | (defvar outline-undo-aggregation 30 | |
902 | "Amount of successive self-insert actions to bunch together per undo. | |
19b84ba3 | 903 | |
c567ac01 | 904 | This is purely a kludge variable, regulating the compensation for a bug in |
9179616f | 905 | the way that before-change-functions and undo interact.") |
c567ac01 | 906 | (make-variable-buffer-local 'outline-undo-aggregation) |
19b84ba3 | 907 | ;;;_ = file-var-bug hack |
9179616f | 908 | (defvar outline-v18/19-file-var-hack nil |
c567ac01 RS |
909 | "Horrible hack used to prevent invalid multiple triggering of outline |
910 | mode from prop-line file-var activation. Used by outline-mode function | |
911 | to track repeats.") | |
19b84ba3 RS |
912 | ;;;_ > outline-write-file-hook () |
913 | (defun outline-write-file-hook () | |
914 | "In outline mode, run as a local-write-file-hooks activity. | |
915 | ||
353e2ef2 KH |
916 | Currently just sets `outline-during-write-cue', so outline-change-protection |
917 | knows to keep inactive during file write." | |
19b84ba3 RS |
918 | (setq outline-during-write-cue t) |
919 | nil) | |
920 | ||
921 | ;;;_ #2 Mode activation | |
922 | ;;;_ = outline-mode | |
923 | (defvar outline-mode () "Allout outline mode minor-mode flag.") | |
924 | (make-variable-buffer-local 'outline-mode) | |
925 | ;;;_ > outline-mode-p () | |
926 | (defmacro outline-mode-p () | |
927 | "Return t if outline-mode is active in current buffer." | |
928 | 'outline-mode) | |
929 | ;;;_ = outline-explicitly-deactivated | |
930 | (defvar outline-explicitly-deactivated nil | |
a0776d6b | 931 | "Outline-mode was last deliberately deactivated. |
19b84ba3 RS |
932 | So outline-post-command-business should not reactivate it...") |
933 | (make-variable-buffer-local 'outline-explicitly-deactivated) | |
8d118843 RS |
934 | ;;;_ > outline-init (&optional mode) |
935 | (defun outline-init (&optional mode) | |
19b84ba3 RS |
936 | "Prime outline-mode to enable/disable auto-activation, wrt `outline-layout'. |
937 | ||
8d118843 | 938 | MODE is one of the following symbols: |
19b84ba3 | 939 | |
353e2ef2 KH |
940 | - nil \(or no argument) deactivate auto-activation/layout; |
941 | - `activate', enable auto-activation only; | |
942 | - `ask', enable auto-activation, and enable auto-layout but with | |
a0776d6b | 943 | confirmation for layout operation solicited from user each time; |
353e2ef2 | 944 | - `report', just report and return the current auto-activation state; |
8d118843 RS |
945 | - anything else \(eg, t) for auto-activation and auto-layout, without |
946 | any confirmation check. | |
19b84ba3 RS |
947 | |
948 | Use this function to setup your emacs session for automatic activation | |
949 | of allout outline mode, contingent to the buffer-specific setting of | |
950 | the `outline-layout' variable. (See `outline-layout' and | |
951 | `outline-expose-topic' docstrings for more details on auto layout). | |
952 | ||
953 | `outline-init' works by setting up (or removing) the outline-mode | |
954 | find-file-hook, and giving `outline-auto-activation' a suitable | |
955 | setting. | |
956 | ||
957 | To prime your emacs session for full auto-outline operation, include | |
958 | the following two lines in your emacs init file: | |
959 | ||
960 | \(require 'allout) | |
961 | \(outline-init t)" | |
962 | ||
8d118843 RS |
963 | (interactive) |
964 | (if (interactive-p) | |
19b84ba3 | 965 | (progn |
8d118843 RS |
966 | (setq mode |
967 | (completing-read | |
968 | (concat "Select outline auto setup mode " | |
969 | "(empty for report, ? for options) ") | |
970 | '(("nil")("full")("activate")("deactivate") | |
971 | ("ask") ("report") ("")) | |
972 | nil | |
973 | t)) | |
974 | (if (string= mode "") | |
975 | (setq mode 'report) | |
976 | (setq mode (intern-soft mode))))) | |
977 | (let | |
978 | ;; convenience aliases, for consistent ref to respective vars: | |
979 | ((hook 'outline-find-file-hook) | |
980 | (curr-mode 'outline-auto-activation)) | |
353e2ef2 | 981 | |
8d118843 RS |
982 | (cond ((not mode) |
983 | (setq find-file-hooks (delq hook find-file-hooks)) | |
984 | (if (interactive-p) | |
985 | (message "Allout outline mode auto-activation inhibited."))) | |
986 | ((eq mode 'report) | |
987 | (if (not (memq hook find-file-hooks)) | |
988 | (outline-init nil) | |
989 | ;; Just punt and use the reports from each of the modes: | |
990 | (outline-init (symbol-value curr-mode)))) | |
991 | (t (add-hook 'find-file-hooks hook) | |
353e2ef2 | 992 | (set curr-mode ; `set', not `setq'! |
8d118843 RS |
993 | (cond ((eq mode 'activate) |
994 | (message | |
995 | "Outline mode auto-activation enabled.") | |
996 | 'activate) | |
997 | ((eq mode 'report) | |
998 | ;; Return the current mode setting: | |
999 | (outline-init mode)) | |
1000 | ((eq mode 'ask) | |
1001 | (message | |
1002 | (concat "Outline mode auto-activation and " | |
1003 | "-layout \(upon confirmation) enabled.")) | |
1004 | 'ask) | |
1005 | ((message | |
1006 | "Outline mode auto-activation and -layout enabled.") | |
1007 | 'full))))))) | |
9179616f DL |
1008 | |
1009 | ;;;_ > outline-setup-menubar () | |
1010 | (defun outline-setup-menubar () | |
1011 | "Populate the current buffer's menubar with allout outline-mode stuff." | |
1012 | (let ((menus (list outline-mode-exposure-menu | |
1013 | outline-mode-editing-menu | |
1014 | outline-mode-navigation-menu | |
1015 | outline-mode-misc-menu)) | |
1016 | cur) | |
1017 | (while menus | |
1018 | (setq cur (car menus) | |
1019 | menus (cdr menus)) | |
1020 | (easy-menu-add cur)))) | |
19b84ba3 RS |
1021 | ;;;_ > outline-mode (&optional toggle) |
1022 | ;;;_ : Defun: | |
1977b8f6 | 1023 | (defun outline-mode (&optional toggle) |
c567ac01 | 1024 | ;;;_ . Doc string: |
19b84ba3 RS |
1025 | "Toggle minor mode for controlling exposure and editing of text outlines. |
1026 | ||
9179616f DL |
1027 | Optional arg forces mode to re-initialize iff arg is positive num or |
1028 | symbol. Allout outline mode always runs as a minor mode. | |
19b84ba3 | 1029 | |
9179616f DL |
1030 | Allout outline mode provides extensive outline-oriented formatting and |
1031 | manipulation. It enables structural editing of outlines, as well as | |
1032 | navigation and exposure. It also is specifically aimed at | |
1033 | accommodating syntax-sensitive text like programming languages. \(For | |
1034 | an example, see the allout code itself, which is organized as an allout | |
1035 | outline.) | |
19b84ba3 | 1036 | |
9179616f | 1037 | In addition to outline navigation and exposure, allout includes: |
19b84ba3 | 1038 | |
9179616f DL |
1039 | - topic-oriented repositioning, cut, and paste |
1040 | - integral outline exposure-layout | |
1041 | - incremental search with dynamic exposure and reconcealment of hidden text | |
1042 | - automatic topic-number maintenance | |
1043 | - \"Hot-spot\" operation, for single-keystroke maneuvering and | |
1044 | exposure control. \(See the outline-mode docstring.) | |
1045 | ||
1046 | and many other features. | |
19b84ba3 RS |
1047 | |
1048 | Below is a description of the bindings, and then explanation of | |
9179616f DL |
1049 | special outline-mode features and terminology. See also the outline |
1050 | menubar additions for quick reference to many of the features, and see | |
1051 | the docstring of the variable `outline-init' for instructions on | |
1052 | priming your emacs session for automatic activation of outline-mode. | |
1053 | ||
19b84ba3 | 1054 | |
9179616f DL |
1055 | The bindings are dictated by the `outline-keybindings-list' and |
1056 | `outline-command-prefix' variables. | |
19b84ba3 RS |
1057 | |
1058 | Navigation: Exposure Control: | |
1059 | ---------- ---------------- | |
1060 | C-c C-n outline-next-visible-heading | C-c C-h outline-hide-current-subtree | |
1061 | C-c C-p outline-previous-visible-heading | C-c C-i outline-show-children | |
1062 | C-c C-u outline-up-current-level | C-c C-s outline-show-current-subtree | |
1063 | C-c C-f outline-forward-current-level | C-c C-o outline-show-current-entry | |
1064 | C-c C-b outline-backward-current-level | ^U C-c C-s outline-show-all | |
1065 | C-c C-e outline-end-of-current-entry | outline-hide-current-leaves | |
1066 | C-c C-a outline-beginning-of-current-entry, alternately, goes to hot-spot | |
1067 | ||
1068 | Topic Header Production: | |
1069 | ----------------------- | |
1070 | C-c<SP> outline-open-sibtopic Create a new sibling after current topic. | |
1071 | C-c . outline-open-subtopic ... an offspring of current topic. | |
1072 | C-c , outline-open-supertopic ... a sibling of the current topic's parent. | |
1073 | ||
1074 | Topic Level and Prefix Adjustment: | |
1075 | --------------------------------- | |
1076 | C-c > outline-shift-in Shift current topic and all offspring deeper. | |
1077 | C-c < outline-shift-out ... less deep. | |
353e2ef2 | 1078 | C-c<CR> outline-rebullet-topic Reconcile bullets of topic and its offspring |
19b84ba3 RS |
1079 | - distinctive bullets are not changed, others |
1080 | alternated according to nesting depth. | |
9179616f | 1081 | C-c b outline-rebullet-current-heading Prompt for alternate bullet for |
19b84ba3 | 1082 | current topic. |
1977b8f6 RS |
1083 | C-c # outline-number-siblings Number bullets of topic and siblings - the |
1084 | offspring are not affected. With repeat | |
1085 | count, revoke numbering. | |
1086 | ||
19b84ba3 RS |
1087 | Topic-oriented Killing and Yanking: |
1088 | ---------------------------------- | |
1089 | C-c C-k outline-kill-topic Kill current topic, including offspring. | |
1090 | C-k outline-kill-line Like kill-line, but reconciles numbering, etc. | |
1977b8f6 RS |
1091 | C-y outline-yank Yank, adjusting depth of yanked topic to |
1092 | depth of heading if yanking into bare topic | |
19b84ba3 | 1093 | heading (ie, prefix sans text). |
1977b8f6 RS |
1094 | M-y outline-yank-pop Is to outline-yank as yank-pop is to yank |
1095 | ||
19b84ba3 RS |
1096 | Misc commands: |
1097 | ------------- | |
19b84ba3 RS |
1098 | M-x outlineify-sticky Activate outline mode for current buffer, |
1099 | and establish a default file-var setting | |
1100 | for `outline-layout'. | |
9179616f DL |
1101 | C-c C-SPC outline-mark-topic |
1102 | C-c = c outline-copy-exposed-to-buffer | |
1103 | Duplicate outline, sans concealed text, to | |
1104 | buffer with name derived from derived from | |
1105 | that of current buffer - \"*XXX exposed*\". | |
1106 | C-c = p outline-flatten-exposed-to-buffer | |
1107 | Like above 'copy-exposed', but convert topic | |
1108 | prefixes to section.subsection... numeric | |
1109 | format. | |
19b84ba3 RS |
1110 | ESC ESC (outline-init t) Setup emacs session for outline mode |
1111 | auto-activation. | |
1977b8f6 | 1112 | |
19b84ba3 | 1113 | HOT-SPOT Operation |
c567ac01 | 1114 | |
19b84ba3 RS |
1115 | Hot-spot operation provides a means for easy, single-keystroke outline |
1116 | navigation and exposure control. | |
c567ac01 | 1117 | |
19b84ba3 RS |
1118 | \\<outline-mode-map> |
1119 | When the text cursor is positioned directly on the bullet character of | |
1120 | a topic, regular characters (a to z) invoke the commands of the | |
1121 | corresponding outline-mode keymap control chars. For example, \"f\" | |
1122 | would invoke the command typically bound to \"C-c C-f\" | |
1123 | \(\\[outline-forward-current-level] `outline-forward-current-level'). | |
1124 | ||
1125 | Thus, by positioning the cursor on a topic bullet, you can execute | |
c567ac01 | 1126 | the outline navigation and manipulation commands with a single |
19b84ba3 RS |
1127 | keystroke. Non-literal chars never get this special translation, so |
1128 | you can use them to get away from the hot-spot, and back to normal | |
1129 | operation. | |
c567ac01 | 1130 | |
19b84ba3 | 1131 | Note that the command `outline-beginning-of-current-entry' \(\\[outline-beginning-of-current-entry]\) |
c567ac01 RS |
1132 | will move to the hot-spot when the cursor is already located at the |
1133 | beginning of the current entry, so you can simply hit \\[outline-beginning-of-current-entry] | |
1134 | twice in a row to get to the hot-spot. | |
1977b8f6 | 1135 | |
19b84ba3 | 1136 | Terminology |
1977b8f6 | 1137 | |
c567ac01 RS |
1138 | Topic hierarchy constituents - TOPICS and SUBTOPICS: |
1139 | ||
1140 | TOPIC: A basic, coherent component of an emacs outline. It can | |
1141 | contain other topics, and it can be subsumed by other topics, | |
1142 | CURRENT topic: | |
1143 | The visible topic most immediately containing the cursor. | |
19b84ba3 RS |
1144 | DEPTH: The degree of nesting of a topic; it increases with |
1145 | containment. Also called the: | |
c567ac01 RS |
1146 | LEVEL: The same as DEPTH. |
1147 | ||
1148 | ANCESTORS: | |
1149 | The topics that contain a topic. | |
1150 | PARENT: A topic's immediate ancestor. It has a depth one less than | |
1151 | the topic. | |
1152 | OFFSPRING: | |
19b84ba3 RS |
1153 | The topics contained by a topic; |
1154 | SUBTOPIC: | |
1155 | An immediate offspring of a topic; | |
c567ac01 RS |
1156 | CHILDREN: |
1157 | The immediate offspring of a topic. | |
1158 | SIBLINGS: | |
19b84ba3 | 1159 | Topics having the same parent and depth. |
353e2ef2 | 1160 | |
c567ac01 RS |
1161 | Topic text constituents: |
1162 | ||
1163 | HEADER: The first line of a topic, include the topic PREFIX and header | |
353e2ef2 | 1164 | text. |
c567ac01 RS |
1165 | PREFIX: The leading text of a topic which which distinguishes it from |
1166 | normal text. It has a strict form, which consists of a | |
1167 | prefix-lead string, padding, and a bullet. The bullet may be | |
1168 | followed by a number, indicating the ordinal number of the | |
1169 | topic among its siblings, a space, and then the header text. | |
1170 | ||
1171 | The relative length of the PREFIX determines the nesting depth | |
1172 | of the topic. | |
1173 | PREFIX-LEAD: | |
353e2ef2 | 1174 | The string at the beginning of a topic prefix, normally a `.'. |
c567ac01 | 1175 | It can be customized by changing the setting of |
19b84ba3 | 1176 | `outline-header-prefix' and then reinitializing outline-mode. |
c567ac01 RS |
1177 | |
1178 | By setting the prefix-lead to the comment-string of a | |
1179 | programming language, you can embed outline-structuring in | |
1180 | program code without interfering with the language processing | |
19b84ba3 RS |
1181 | of that code. See `outline-use-mode-specific-leader' |
1182 | docstring for more detail. | |
c567ac01 RS |
1183 | PREFIX-PADDING: |
1184 | Spaces or asterisks which separate the prefix-lead and the | |
1185 | bullet, according to the depth of the topic. | |
1186 | BULLET: A character at the end of the topic prefix, it must be one of | |
353e2ef2 KH |
1187 | the characters listed on `outline-plain-bullets-string' or |
1188 | `outline-distinctive-bullets-string'. (See the documentation | |
c567ac01 RS |
1189 | for these variables for more details.) The default choice of |
1190 | bullet when generating varies in a cycle with the depth of the | |
1191 | topic. | |
1192 | ENTRY: The text contained in a topic before any offspring. | |
1193 | BODY: Same as ENTRY. | |
1194 | ||
1195 | ||
1196 | EXPOSURE: | |
1197 | The state of a topic which determines the on-screen visibility | |
353e2ef2 | 1198 | of its offspring and contained text. |
c567ac01 RS |
1199 | CONCEALED: |
1200 | Topics and entry text whose display is inhibited. Contiguous | |
353e2ef2 KH |
1201 | units of concealed text is represented by `...' ellipses. |
1202 | (Ref the `selective-display' var.) | |
c567ac01 RS |
1203 | |
1204 | Concealed topics are effectively collapsed within an ancestor. | |
1205 | CLOSED: A topic whose immediate offspring and body-text is concealed. | |
353e2ef2 | 1206 | OPEN: A topic that is not closed, though its offspring or body may be." |
c567ac01 | 1207 | ;;;_ . Code |
1977b8f6 RS |
1208 | (interactive "P") |
1209 | ||
c567ac01 | 1210 | (let* ((active (and (not (equal major-mode 'outline)) |
19b84ba3 | 1211 | (outline-mode-p))) |
353e2ef2 | 1212 | ; Massage universal-arg `toggle' val: |
c567ac01 | 1213 | (toggle (and toggle |
19b84ba3 RS |
1214 | (or (and (listp toggle)(car toggle)) |
1215 | toggle))) | |
a0776d6b | 1216 | ; Activation specifically demanded? |
c567ac01 | 1217 | (explicit-activation (or |
19b84ba3 RS |
1218 | ;; |
1219 | (and toggle | |
1220 | (or (symbolp toggle) | |
1221 | (and (natnump toggle) | |
1222 | (not (zerop toggle))))))) | |
c567ac01 | 1223 | ;; outline-mode already called once during this complex command? |
9179616f | 1224 | (same-complex-command (eq outline-v18/19-file-var-hack |
19b84ba3 RS |
1225 | (car command-history))) |
1226 | do-layout | |
1227 | ) | |
c567ac01 | 1228 | |
19b84ba3 | 1229 | ; See comments below re v19.18,.19 bug. |
9179616f | 1230 | (setq outline-v18/19-file-var-hack (car command-history)) |
c567ac01 | 1231 | |
1977b8f6 RS |
1232 | (cond |
1233 | ||
19b84ba3 | 1234 | ;; Provision for v19.18, 19.19 bug - |
c567ac01 RS |
1235 | ;; Emacs v 19.18, 19.19 file-var code invokes prop-line-designated |
1236 | ;; modes twice when file is visited. We have to avoid toggling mode | |
1237 | ;; off on second invocation, so we detect it as best we can, and | |
1238 | ;; skip everything. | |
1239 | ((and same-complex-command ; Still in same complex command | |
19b84ba3 RS |
1240 | ; as last time outline-mode invoked. |
1241 | active ; Already activated. | |
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 | |
1244 | emacs-version)); 19.19. | |
c567ac01 | 1245 | t) |
353e2ef2 | 1246 | |
19b84ba3 | 1247 | ;; Deactivation: |
c567ac01 | 1248 | ((and (not explicit-activation) |
19b84ba3 RS |
1249 | (or active toggle)) |
1250 | ; Activation not explicitly | |
1251 | ; requested, and either in | |
1252 | ; active state or *de*activation | |
1253 | ; specifically requested: | |
1254 | (setq outline-explicitly-deactivated t) | |
c567ac01 | 1255 | (if (string-match "^18\." emacs-version) |
19b84ba3 RS |
1256 | ; Revoke those keys that remain |
1257 | ; as we set them: | |
c567ac01 | 1258 | (let ((curr-loc (current-local-map))) |
9179616f DL |
1259 | (mapcar (function |
1260 | (lambda (cell) | |
19b84ba3 RS |
1261 | (if (eq (lookup-key curr-loc (car cell)) |
1262 | (car (cdr cell))) | |
1263 | (define-key curr-loc (car cell) | |
9179616f | 1264 | (assq (car cell) outline-prior-bindings))))) |
19b84ba3 RS |
1265 | outline-added-bindings) |
1266 | (outline-resumptions 'outline-added-bindings) | |
1267 | (outline-resumptions 'outline-prior-bindings))) | |
c567ac01 RS |
1268 | |
1269 | (if outline-old-style-prefixes | |
1270 | (progn | |
19b84ba3 RS |
1271 | (outline-resumptions 'outline-primary-bullet) |
1272 | (outline-resumptions 'outline-old-style-prefixes))) | |
1977b8f6 | 1273 | (outline-resumptions 'selective-display) |
9179616f DL |
1274 | (if (and (boundp 'before-change-functions) before-change-functions) |
1275 | (outline-resumptions 'before-change-functions)) | |
c567ac01 | 1276 | (setq local-write-file-hooks |
19b84ba3 RS |
1277 | (delq 'outline-write-file-hook |
1278 | local-write-file-hooks)) | |
1977b8f6 RS |
1279 | (outline-resumptions 'paragraph-start) |
1280 | (outline-resumptions 'paragraph-separate) | |
c567ac01 | 1281 | (outline-resumptions (if (string-match "^18" emacs-version) |
19b84ba3 RS |
1282 | 'auto-fill-hook |
1283 | 'auto-fill-function)) | |
c567ac01 | 1284 | (outline-resumptions 'outline-former-auto-filler) |
1977b8f6 RS |
1285 | (setq outline-mode nil)) |
1286 | ||
19b84ba3 | 1287 | ;; Activation: |
1977b8f6 | 1288 | ((not active) |
19b84ba3 | 1289 | (setq outline-explicitly-deactivated nil) |
c567ac01 RS |
1290 | (if outline-old-style-prefixes |
1291 | (progn ; Inhibit all the fancy formatting: | |
19b84ba3 RS |
1292 | (outline-resumptions 'outline-primary-bullet '("*")) |
1293 | (outline-resumptions 'outline-old-style-prefixes '(())))) | |
1294 | ||
1295 | (outline-infer-header-lead) | |
8d118843 | 1296 | (outline-infer-body-reindent) |
19b84ba3 | 1297 | |
1977b8f6 | 1298 | (set-outline-regexp) |
19b84ba3 RS |
1299 | |
1300 | ; Produce map from current version | |
1301 | ; of outline-keybindings-list: | |
c567ac01 RS |
1302 | (if (boundp 'minor-mode-map-alist) |
1303 | ||
1304 | (progn ; V19, and maybe lucid and | |
19b84ba3 RS |
1305 | ; epoch, minor-mode key bindings: |
1306 | (setq outline-mode-map | |
1307 | (produce-outline-mode-map outline-keybindings-list)) | |
9179616f | 1308 | (produce-outline-mode-menubar-entries) |
19b84ba3 RS |
1309 | (fset 'outline-mode-map outline-mode-map) |
1310 | ; Include on minor-mode-map-alist, | |
1311 | ; if not already there: | |
1312 | (if (not (member '(outline-mode . outline-mode-map) | |
1313 | minor-mode-map-alist)) | |
1314 | (setq minor-mode-map-alist | |
1315 | (cons '(outline-mode . outline-mode-map) | |
1316 | minor-mode-map-alist)))) | |
1317 | ||
1318 | ; V18 minor-mode key bindings: | |
1319 | ; Stash record of added bindings | |
1320 | ; for later revocation: | |
c567ac01 | 1321 | (outline-resumptions 'outline-added-bindings |
19b84ba3 | 1322 | (list outline-keybindings-list)) |
c567ac01 | 1323 | (outline-resumptions 'outline-prior-bindings |
19b84ba3 RS |
1324 | (list (current-local-map))) |
1325 | ; and add them: | |
c567ac01 | 1326 | (use-local-map (produce-outline-mode-map outline-keybindings-list |
19b84ba3 | 1327 | (current-local-map))) |
c567ac01 | 1328 | ) |
353e2ef2 | 1329 | |
19b84ba3 RS |
1330 | ; selective-display is the |
1331 | ; emacs conditional exposure | |
1332 | ; mechanism: | |
c567ac01 RS |
1333 | (outline-resumptions 'selective-display '(t)) |
1334 | (if outline-inhibit-protection | |
1335 | t | |
9179616f | 1336 | (outline-resumptions 'before-change-functions |
19b84ba3 | 1337 | '(outline-before-change-protect))) |
9179616f DL |
1338 | (add-hook 'pre-command-hook 'outline-pre-command-business) |
1339 | (add-hook 'post-command-hook 'outline-post-command-business) | |
19b84ba3 RS |
1340 | ; Temporarily set by any outline |
1341 | ; functions that can be trusted to | |
1342 | ; deal properly with concealed text. | |
c567ac01 | 1343 | (add-hook 'local-write-file-hooks 'outline-write-file-hook) |
19b84ba3 RS |
1344 | ; Custom auto-fill func, to support |
1345 | ; respect for topic headline, | |
1346 | ; hanging-indents, etc: | |
c567ac01 | 1347 | (let* ((fill-func-var (if (string-match "^18" emacs-version) |
19b84ba3 RS |
1348 | 'auto-fill-hook |
1349 | 'auto-fill-function)) | |
1350 | (fill-func (symbol-value fill-func-var))) | |
c567ac01 RS |
1351 | ;; Register prevailing fill func for use by outline-auto-fill: |
1352 | (outline-resumptions 'outline-former-auto-filler (list fill-func)) | |
1353 | ;; Register outline-auto-fill to be used if filling is active: | |
1354 | (outline-resumptions fill-func-var '(outline-auto-fill))) | |
1355 | ;; Paragraphs are broken by topic headlines. | |
1977b8f6 RS |
1356 | (make-local-variable 'paragraph-start) |
1357 | (outline-resumptions 'paragraph-start | |
9179616f | 1358 | (list (concat paragraph-start "\\|^\\(" |
19b84ba3 | 1359 | outline-regexp "\\)"))) |
1977b8f6 RS |
1360 | (make-local-variable 'paragraph-separate) |
1361 | (outline-resumptions 'paragraph-separate | |
9179616f | 1362 | (list (concat paragraph-separate "\\|^\\(" |
19b84ba3 | 1363 | outline-regexp "\\)"))) |
c567ac01 RS |
1364 | |
1365 | (or (assq 'outline-mode minor-mode-alist) | |
1366 | (setq minor-mode-alist | |
19b84ba3 RS |
1367 | (cons '(outline-mode " Outl") minor-mode-alist))) |
1368 | ||
9179616f DL |
1369 | (outline-setup-menubar) |
1370 | ||
19b84ba3 RS |
1371 | (if outline-layout |
1372 | (setq do-layout t)) | |
1977b8f6 | 1373 | |
9179616f DL |
1374 | (if (and outline-isearch-dynamic-expose |
1375 | (not (fboundp 'outline-real-isearch-abort))) | |
c567ac01 | 1376 | (outline-enwrap-isearch)) |
19b84ba3 | 1377 | |
1977b8f6 RS |
1378 | (run-hooks 'outline-mode-hook) |
1379 | (setq outline-mode t)) | |
19b84ba3 RS |
1380 | |
1381 | ;; Reactivation: | |
8d118843 RS |
1382 | ((setq do-layout t) |
1383 | (outline-infer-body-reindent)) | |
c567ac01 | 1384 | ) ; cond |
19b84ba3 RS |
1385 | |
1386 | (if (and do-layout | |
1387 | outline-auto-activation | |
1388 | (listp outline-layout) | |
1389 | (and (not (eq outline-auto-activation 'activate)) | |
1390 | (if (eq outline-auto-activation 'ask) | |
1391 | (if (y-or-n-p (format "Expose %s with layout '%s'? " | |
1392 | (buffer-name) | |
1393 | outline-layout)) | |
1394 | t | |
8d118843 | 1395 | (message "Skipped %s layout." (buffer-name)) |
19b84ba3 RS |
1396 | nil) |
1397 | t))) | |
1398 | (save-excursion | |
1399 | (message "Adjusting '%s' exposure..." (buffer-name)) | |
1400 | (goto-char 0) | |
8d118843 RS |
1401 | (outline-this-or-next-heading) |
1402 | (condition-case err | |
353e2ef2 | 1403 | (progn |
8d118843 RS |
1404 | (apply 'outline-expose-topic (list outline-layout)) |
1405 | (message "Adjusting '%s' exposure... done." (buffer-name))) | |
1406 | ;; Problem applying exposure - notify user, but don't | |
1407 | ;; interrupt, eg, file visit: | |
1408 | (error (message "%s" (car (cdr err))) | |
1409 | (sit-for 1))))) | |
c567ac01 RS |
1410 | outline-mode |
1411 | ) ; let* | |
19b84ba3 | 1412 | ) ; defun |
9179616f DL |
1413 | ;;;_ > outline-minor-mode |
1414 | ;;; XXX released verion doesn't do this? | |
1415 | (defalias 'outline-minor-mode 'outline-mode) | |
1977b8f6 | 1416 | |
19b84ba3 RS |
1417 | ;;;_ #3 Internal Position State-Tracking - "outline-recent-*" funcs |
1418 | ;;; All the basic outline functions that directly do string matches to | |
1977b8f6 | 1419 | ;;; evaluate heading prefix location set the variables |
19b84ba3 RS |
1420 | ;;; `outline-recent-prefix-beginning' and `outline-recent-prefix-end' |
1421 | ;;; when successful. Functions starting with `outline-recent-' all | |
1422 | ;;; use this state, providing the means to avoid redundant searches | |
1423 | ;;; for just-established data. This optimization can provide | |
1424 | ;;; significant speed improvement, but it must be employed carefully. | |
c567ac01 | 1425 | ;;;_ = outline-recent-prefix-beginning |
1977b8f6 | 1426 | (defvar outline-recent-prefix-beginning 0 |
c567ac01 | 1427 | "Buffer point of the start of the last topic prefix encountered.") |
1977b8f6 | 1428 | (make-variable-buffer-local 'outline-recent-prefix-beginning) |
c567ac01 | 1429 | ;;;_ = outline-recent-prefix-end |
1977b8f6 | 1430 | (defvar outline-recent-prefix-end 0 |
c567ac01 | 1431 | "Buffer point of the end of the last topic prefix encountered.") |
1977b8f6 | 1432 | (make-variable-buffer-local 'outline-recent-prefix-end) |
19b84ba3 RS |
1433 | ;;;_ = outline-recent-end-of-subtree |
1434 | (defvar outline-recent-end-of-subtree 0 | |
1435 | "Buffer point last returned by outline-end-of-current-subtree.") | |
1436 | (make-variable-buffer-local 'outline-recent-end-of-subtree) | |
c567ac01 RS |
1437 | ;;;_ > outline-prefix-data (beg end) |
1438 | (defmacro outline-prefix-data (beg end) | |
19b84ba3 RS |
1439 | "Register outline-prefix state data - BEGINNING and END of prefix. |
1440 | ||
353e2ef2 | 1441 | For reference by `outline-recent' funcs. Returns BEGINNING." |
9179616f DL |
1442 | `(setq outline-recent-prefix-end ,end |
1443 | outline-recent-prefix-beginning ,beg)) | |
c567ac01 RS |
1444 | ;;;_ > outline-recent-depth () |
1445 | (defmacro outline-recent-depth () | |
19b84ba3 | 1446 | "Return depth of last heading encountered by an outline maneuvering function. |
c567ac01 RS |
1447 | |
1448 | All outline functions which directly do string matches to assess | |
1449 | headings set the variables outline-recent-prefix-beginning and | |
1450 | outline-recent-prefix-end if successful. This function uses those settings | |
1451 | to return the current depth." | |
1452 | ||
1453 | '(max 1 (- outline-recent-prefix-end | |
1454 | outline-recent-prefix-beginning | |
1455 | outline-header-subtraction))) | |
1456 | ;;;_ > outline-recent-prefix () | |
1457 | (defmacro outline-recent-prefix () | |
1458 | "Like outline-recent-depth, but returns text of last encountered prefix. | |
1459 | ||
1460 | All outline functions which directly do string matches to assess | |
1461 | headings set the variables outline-recent-prefix-beginning and | |
1462 | outline-recent-prefix-end if successful. This function uses those settings | |
1463 | to return the current depth." | |
1464 | '(buffer-substring outline-recent-prefix-beginning | |
1465 | outline-recent-prefix-end)) | |
1466 | ;;;_ > outline-recent-bullet () | |
1467 | (defmacro outline-recent-bullet () | |
19b84ba3 | 1468 | "Like outline-recent-prefix, but returns bullet of last encountered prefix. |
c567ac01 RS |
1469 | |
1470 | All outline functions which directly do string matches to assess | |
1471 | headings set the variables outline-recent-prefix-beginning and | |
1472 | outline-recent-prefix-end if successful. This function uses those settings | |
1473 | to return the current depth of the most recently matched topic." | |
1474 | '(buffer-substring (1- outline-recent-prefix-end) | |
1475 | outline-recent-prefix-end)) | |
1476 | ||
19b84ba3 | 1477 | ;;;_ #4 Navigation |
c567ac01 RS |
1478 | |
1479 | ;;;_ - Position Assessment | |
1480 | ;;;_ : Location Predicates | |
1481 | ;;;_ > outline-on-current-heading-p () | |
1977b8f6 | 1482 | (defun outline-on-current-heading-p () |
19b84ba3 RS |
1483 | "Return non-nil if point is on current visible topics' header line. |
1484 | ||
1485 | Actually, returns prefix beginning point." | |
1977b8f6 RS |
1486 | (save-excursion |
1487 | (beginning-of-line) | |
1488 | (and (looking-at outline-regexp) | |
c567ac01 | 1489 | (outline-prefix-data (match-beginning 0) (match-end 0))))) |
9179616f DL |
1490 | ;;;_ > outline-on-heading-p () |
1491 | (defalias 'outline-on-heading-p 'outline-on-current-heading-p) | |
c567ac01 RS |
1492 | ;;;_ > outline-e-o-prefix-p () |
1493 | (defun outline-e-o-prefix-p () | |
19b84ba3 | 1494 | "True if point is located where current topic prefix ends, heading begins." |
c567ac01 RS |
1495 | (and (save-excursion (beginning-of-line) |
1496 | (looking-at outline-regexp)) | |
1497 | (= (point)(save-excursion (outline-end-of-prefix)(point))))) | |
1498 | ;;;_ > outline-hidden-p () | |
1499 | (defmacro outline-hidden-p () | |
1977b8f6 | 1500 | "True if point is in hidden text." |
c567ac01 RS |
1501 | '(save-excursion |
1502 | (and (re-search-backward "[\n\r]" () t) | |
1503 | (= ?\r (following-char))))) | |
1504 | ;;;_ > outline-visible-p () | |
1505 | (defmacro outline-visible-p () | |
1506 | "True if point is not in hidden text." | |
1977b8f6 | 1507 | (interactive) |
c567ac01 RS |
1508 | '(not (outline-hidden-p))) |
1509 | ;;;_ : Location attributes | |
1510 | ;;;_ > outline-depth () | |
9179616f | 1511 | (defsubst outline-depth () |
19b84ba3 | 1512 | "Like outline-current-depth, but respects hidden as well as visible topics." |
9179616f DL |
1513 | (save-excursion |
1514 | (if (outline-goto-prefix) | |
1515 | (outline-recent-depth) | |
1516 | (progn | |
1517 | ;; Oops, no prefix, zero prefix data: | |
1518 | (outline-prefix-data (point)(point)) | |
1519 | ;; ... and return 0: | |
1520 | 0)))) | |
c567ac01 RS |
1521 | ;;;_ > outline-current-depth () |
1522 | (defmacro outline-current-depth () | |
19b84ba3 | 1523 | "Return nesting depth of visible topic most immediately containing point." |
c567ac01 RS |
1524 | '(save-excursion |
1525 | (if (outline-back-to-current-heading) | |
1526 | (max 1 | |
1527 | (- outline-recent-prefix-end | |
1528 | outline-recent-prefix-beginning | |
1529 | outline-header-subtraction)) | |
1530 | 0))) | |
1531 | ;;;_ > outline-get-current-prefix () | |
1977b8f6 | 1532 | (defun outline-get-current-prefix () |
c567ac01 | 1533 | "Topic prefix of the current topic." |
1977b8f6 RS |
1534 | (save-excursion |
1535 | (if (outline-goto-prefix) | |
c567ac01 RS |
1536 | (outline-recent-prefix)))) |
1537 | ;;;_ > outline-get-bullet () | |
1977b8f6 | 1538 | (defun outline-get-bullet () |
c567ac01 | 1539 | "Return bullet of containing topic (visible or not)." |
1977b8f6 RS |
1540 | (save-excursion |
1541 | (and (outline-goto-prefix) | |
c567ac01 RS |
1542 | (outline-recent-bullet)))) |
1543 | ;;;_ > outline-current-bullet () | |
1977b8f6 | 1544 | (defun outline-current-bullet () |
c567ac01 | 1545 | "Return bullet of current (visible) topic heading, or none if none found." |
1977b8f6 RS |
1546 | (condition-case err |
1547 | (save-excursion | |
c567ac01 RS |
1548 | (outline-back-to-current-heading) |
1549 | (buffer-substring (- outline-recent-prefix-end 1) | |
1550 | outline-recent-prefix-end)) | |
1977b8f6 | 1551 | ;; Quick and dirty provision, ostensibly for missing bullet: |
9179616f | 1552 | ('args-out-of-range nil)) |
1977b8f6 | 1553 | ) |
c567ac01 | 1554 | ;;;_ > outline-get-prefix-bullet (prefix) |
1977b8f6 | 1555 | (defun outline-get-prefix-bullet (prefix) |
c567ac01 | 1556 | "Return the bullet of the header prefix string PREFIX." |
1977b8f6 RS |
1557 | ;; Doesn't make sense if we're old-style prefixes, but this just |
1558 | ;; oughtn't be called then, so forget about it... | |
1559 | (if (string-match outline-regexp prefix) | |
1560 | (substring prefix (1- (match-end 0)) (match-end 0)))) | |
9179616f DL |
1561 | ;;;_ > outline-sibling-index (&optional depth) |
1562 | (defun outline-sibling-index (&optional depth) | |
1563 | "Item number of this prospective topic among its siblings. | |
1564 | ||
1565 | If optional arg depth is greater than current depth, then we're | |
1566 | opening a new level, and return 0. | |
1567 | ||
1568 | If less than this depth, ascend to that depth and count..." | |
1569 | ||
1570 | (save-excursion | |
1571 | (cond ((and depth (<= depth 0) 0)) | |
1572 | ((or (not depth) (= depth (outline-depth))) | |
1573 | (let ((index 1)) | |
1574 | (while (outline-previous-sibling (outline-recent-depth) nil) | |
1575 | (setq index (1+ index))) | |
1576 | index)) | |
1577 | ((< depth (outline-recent-depth)) | |
1578 | (outline-ascend-to-depth depth) | |
1579 | (outline-sibling-index)) | |
1580 | (0)))) | |
1581 | ;;;_ > outline-topic-flat-index () | |
1582 | (defun outline-topic-flat-index () | |
1583 | "Return a list indicating point's numeric section.subsect.subsubsect... | |
1584 | Outermost is first." | |
1585 | (let* ((depth (outline-depth)) | |
1586 | (next-index (outline-sibling-index depth)) | |
1587 | (rev-sibls nil)) | |
1588 | (while (> next-index 0) | |
1589 | (setq rev-sibls (cons next-index rev-sibls)) | |
1590 | (setq depth (1- depth)) | |
1591 | (setq next-index (outline-sibling-index depth))) | |
1592 | rev-sibls) | |
1593 | ) | |
1977b8f6 | 1594 | |
c567ac01 RS |
1595 | ;;;_ - Navigation macros |
1596 | ;;;_ > outline-next-heading () | |
9179616f | 1597 | (defsubst outline-next-heading () |
c567ac01 RS |
1598 | "Move to the heading for the topic \(possibly invisible) before this one. |
1599 | ||
1600 | Returns the location of the heading, or nil if none found." | |
1601 | ||
9179616f | 1602 | (if (and (bobp) (not (eobp))) |
c567ac01 RS |
1603 | (forward-char 1)) |
1604 | ||
9179616f DL |
1605 | (if (re-search-forward outline-line-boundary-regexp nil 0) |
1606 | (outline-prefix-data ; Got valid location state - set vars: | |
1607 | (goto-char (or (match-beginning 2) | |
1608 | outline-recent-prefix-beginning)) | |
1609 | (or (match-end 2) outline-recent-prefix-end)))) | |
8d118843 RS |
1610 | ;;;_ : outline-this-or-next-heading |
1611 | (defun outline-this-or-next-heading () | |
1612 | "Position cursor on current or next heading." | |
1613 | ;; A throwaway non-macro that is defined after outline-next-heading | |
1614 | ;; and usable by outline-mode. | |
1615 | (if (not (outline-goto-prefix)) (outline-next-heading))) | |
c567ac01 RS |
1616 | ;;;_ > outline-previous-heading () |
1617 | (defmacro outline-previous-heading () | |
19b84ba3 | 1618 | "Move to the prior \(possibly invisible) heading line. |
c567ac01 RS |
1619 | |
1620 | Return the location of the beginning of the heading, or nil if not found." | |
1621 | ||
1622 | '(if (bobp) | |
1623 | nil | |
1624 | (outline-goto-prefix) | |
1625 | (if | |
1626 | ;; searches are unbounded and return nil if failed: | |
1627 | (or (re-search-backward outline-line-boundary-regexp nil 0) | |
1628 | (looking-at outline-bob-regexp)) | |
19b84ba3 | 1629 | (progn ; Got valid location state - set vars: |
353e2ef2 | 1630 | (outline-prefix-data |
c567ac01 RS |
1631 | (goto-char (or (match-beginning 2) |
1632 | outline-recent-prefix-beginning)) | |
1633 | (or (match-end 2) outline-recent-prefix-end)))))) | |
1634 | ||
1635 | ;;;_ - Subtree Charting | |
1636 | ;;;_ " These routines either produce or assess charts, which are | |
1637 | ;;; nested lists of the locations of topics within a subtree. | |
1638 | ;;; | |
1639 | ;;; Use of charts enables efficient navigation of subtrees, by | |
1640 | ;;; requiring only a single regexp-search based traversal, to scope | |
1641 | ;;; out the subtopic locations. The chart then serves as the basis | |
9179616f DL |
1642 | ;;; for assessment or adjustment of the subtree, without redundant |
1643 | ;;; traversal of the structure. | |
c567ac01 | 1644 | |
19b84ba3 RS |
1645 | ;;;_ > outline-chart-subtree (&optional levels orig-depth prev-depth) |
1646 | (defun outline-chart-subtree (&optional levels orig-depth prev-depth) | |
1647 | "Produce a location \"chart\" of subtopics of the containing topic. | |
1648 | ||
a0776d6b | 1649 | Optional argument LEVELS specifies the depth \(relative to start |
9179616f | 1650 | depth) for the chart. Subsequent optional args are not for public |
19b84ba3 RS |
1651 | use. |
1652 | ||
1653 | Charts are used to capture outline structure, so that outline-altering | |
1654 | routines need assess the structure only once, and then use the chart | |
1655 | for their elaborate manipulations. | |
1656 | ||
1657 | Topics are entered in the chart so the last one is at the car. | |
1658 | The entry for each topic consists of an integer indicating the point | |
1659 | at the beginning of the topic. Charts for offspring consists of a | |
1660 | list containing, recursively, the charts for the respective subtopics. | |
1661 | The chart for a topics' offspring precedes the entry for the topic | |
1662 | itself. | |
1663 | ||
1664 | The other function parameters are for internal recursion, and should | |
1665 | not be specified by external callers. ORIG-DEPTH is depth of topic at | |
1666 | starting point, and PREV-DEPTH is depth of prior topic." | |
1667 | ||
353e2ef2 | 1668 | (let ((original (not orig-depth)) ; `orig-depth' set only in recursion. |
19b84ba3 RS |
1669 | chart curr-depth) |
1670 | ||
1671 | (if original ; Just starting? | |
1672 | ; Register initial settings and | |
1673 | ; position to first offspring: | |
1674 | (progn (setq orig-depth (outline-depth)) | |
1675 | (or prev-depth (setq prev-depth (1+ orig-depth))) | |
c567ac01 | 1676 | (outline-next-heading))) |
c567ac01 | 1677 | |
19b84ba3 RS |
1678 | ;; Loop over the current levels' siblings. Besides being more |
1679 | ;; efficient than tail-recursing over a level, it avoids exceeding | |
1680 | ;; the typically quite constrained emacs max-lisp-eval-depth. | |
9179616f | 1681 | ;; |
19b84ba3 RS |
1682 | ;; Probably would speed things up to implement loop-based stack |
1683 | ;; operation rather than recursing for lower levels. Bah. | |
9179616f | 1684 | |
c567ac01 | 1685 | (while (and (not (eobp)) |
19b84ba3 RS |
1686 | ; Still within original topic? |
1687 | (< orig-depth (setq curr-depth (outline-recent-depth))) | |
1688 | (cond ((= prev-depth curr-depth) | |
1689 | ;; Register this one and move on: | |
1690 | (setq chart (cons (point) chart)) | |
1691 | (if (and levels (<= levels 1)) | |
1692 | ;; At depth limit - skip sublevels: | |
1693 | (or (outline-next-sibling curr-depth) | |
1694 | ;; or no more siblings - proceed to | |
1695 | ;; next heading at lesser depth: | |
e6a9aec7 RS |
1696 | (while (and (<= curr-depth |
1697 | (outline-recent-depth)) | |
1698 | (outline-next-heading)))) | |
19b84ba3 RS |
1699 | (outline-next-heading))) |
1700 | ||
1701 | ((and (< prev-depth curr-depth) | |
1702 | (or (not levels) | |
1703 | (> levels 0))) | |
1704 | ;; Recurse on deeper level of curr topic: | |
1705 | (setq chart | |
1706 | (cons (outline-chart-subtree (and levels | |
1707 | (1- levels)) | |
1708 | orig-depth | |
1709 | curr-depth) | |
1710 | chart)) | |
1711 | ;; ... then continue with this one. | |
1712 | ) | |
1713 | ||
1714 | ;; ... else nil if we've ascended back to prev-depth. | |
1715 | ||
1716 | ))) | |
1717 | ||
1718 | (if original ; We're at the last sibling on | |
1719 | ; the original level. Position | |
1720 | ; to the end of it: | |
c567ac01 | 1721 | (progn (and (not (eobp)) (forward-char -1)) |
9179616f | 1722 | (and (memq (preceding-char) '(?\n ?\r)) |
c567ac01 RS |
1723 | (memq (aref (buffer-substring (max 1 (- (point) 3)) |
1724 | (point)) | |
1725 | 1) | |
9179616f | 1726 | '(?\n ?\r)) |
19b84ba3 RS |
1727 | (forward-char -1)) |
1728 | (setq outline-recent-end-of-subtree (point)))) | |
353e2ef2 | 1729 | |
c567ac01 RS |
1730 | chart ; (nreverse chart) not necessary, |
1731 | ; and maybe not preferable. | |
1732 | )) | |
c567ac01 RS |
1733 | ;;;_ > outline-chart-siblings (&optional start end) |
1734 | (defun outline-chart-siblings (&optional start end) | |
1735 | "Produce a list of locations of this and succeeding sibling topics. | |
353e2ef2 | 1736 | Effectively a top-level chart of siblings. See `outline-chart-subtree' |
c567ac01 RS |
1737 | for an explanation of charts." |
1738 | (save-excursion | |
1739 | (if (outline-goto-prefix) | |
1740 | (let ((chart (list (point)))) | |
1741 | (while (outline-next-sibling) | |
1742 | (setq chart (cons (point) chart))) | |
19b84ba3 | 1743 | (if chart (setq chart (nreverse chart))))))) |
c567ac01 RS |
1744 | ;;;_ > outline-chart-to-reveal (chart depth) |
1745 | (defun outline-chart-to-reveal (chart depth) | |
1746 | ||
19b84ba3 | 1747 | "Return a flat list of hidden points in subtree CHART, up to DEPTH. |
c567ac01 | 1748 | |
19b84ba3 | 1749 | Note that point can be left at any of the points on chart, or at the |
c567ac01 RS |
1750 | start point." |
1751 | ||
1752 | (let (result here) | |
1753 | (while (and (or (eq depth t) (> depth 0)) | |
1754 | chart) | |
1755 | (setq here (car chart)) | |
1756 | (if (listp here) | |
1757 | (let ((further (outline-chart-to-reveal here (or (eq depth t) | |
1758 | (1- depth))))) | |
1759 | ;; We're on the start of a subtree - recurse with it, if there's | |
1760 | ;; more depth to go: | |
1761 | (if further (setq result (append further result))) | |
1762 | (setq chart (cdr chart))) | |
1763 | (goto-char here) | |
1764 | (if (= (preceding-char) ?\r) | |
1765 | (setq result (cons here result))) | |
1766 | (setq chart (cdr chart)))) | |
1767 | result)) | |
19b84ba3 | 1768 | ;;;_ X outline-chart-spec (chart spec &optional exposing) |
c567ac01 | 1769 | (defun outline-chart-spec (chart spec &optional exposing) |
9179616f | 1770 | "Not yet \(if ever) implemented. |
19b84ba3 RS |
1771 | |
1772 | Produce exposure directives given topic/subtree CHART and an exposure SPEC. | |
1773 | ||
1774 | Exposure spec indicates the locations to be exposed and the prescribed | |
1775 | exposure status. Optional arg EXPOSING is an integer, with 0 | |
1776 | indicating pending concealment, anything higher indicating depth to | |
c567ac01 RS |
1777 | which subtopic headers should be exposed, and negative numbers |
1778 | indicating (negative of) the depth to which subtopic headers and | |
1779 | bodies should be exposed. | |
1780 | ||
1781 | The produced list can have two types of entries. Bare numbers | |
1782 | indicate points in the buffer where topic headers that should be | |
1783 | exposed reside. | |
19b84ba3 | 1784 | |
c567ac01 RS |
1785 | - bare negative numbers indicates that the topic starting at the |
1786 | point which is the negative of the number should be opened, | |
1787 | including their entries. | |
1788 | - bare positive values indicate that this topic header should be | |
a0776d6b | 1789 | opened. |
c567ac01 | 1790 | - Lists signify the beginning and end points of regions that should |
353e2ef2 | 1791 | be flagged, and the flag to employ. (For concealment: `\(\?r\)', and |
c567ac01 RS |
1792 | exposure:" |
1793 | (while spec | |
353e2ef2 | 1794 | (cond ((listp spec) |
c567ac01 RS |
1795 | ) |
1796 | ) | |
1797 | (setq spec (cdr spec))) | |
1798 | ) | |
1799 | ||
1800 | ;;;_ - Within Topic | |
1801 | ;;;_ > outline-goto-prefix () | |
1977b8f6 | 1802 | (defun outline-goto-prefix () |
9179616f | 1803 | "Put point at beginning of immediately containing outline topic. |
19b84ba3 | 1804 | |
9179616f | 1805 | Goes to most immediate subsequent topic if none immediately containing. |
19b84ba3 RS |
1806 | |
1807 | Not sensitive to topic visibility. | |
c567ac01 RS |
1808 | |
1809 | Returns a the point at the beginning of the prefix, or nil if none." | |
1810 | ||
19b84ba3 RS |
1811 | (let (done) |
1812 | (while (and (not done) | |
1813 | (re-search-backward "[\n\r]" nil 1)) | |
1814 | (forward-char 1) | |
1815 | (if (looking-at outline-regexp) | |
1816 | (setq done (outline-prefix-data (match-beginning 0) | |
1817 | (match-end 0))) | |
1818 | (forward-char -1))) | |
1819 | (if (bobp) | |
1820 | (cond ((looking-at outline-regexp) | |
1821 | (outline-prefix-data (match-beginning 0)(match-end 0))) | |
9179616f | 1822 | ((outline-next-heading)) |
19b84ba3 RS |
1823 | (done)) |
1824 | done))) | |
c567ac01 RS |
1825 | ;;;_ > outline-end-of-prefix () |
1826 | (defun outline-end-of-prefix (&optional ignore-decorations) | |
19b84ba3 RS |
1827 | "Position cursor at beginning of header text. |
1828 | ||
1829 | If optional IGNORE-DECORATIONS is non-nil, put just after bullet, | |
1830 | otherwise skip white space between bullet and ensuing text." | |
c567ac01 | 1831 | |
1977b8f6 RS |
1832 | (if (not (outline-goto-prefix)) |
1833 | nil | |
1834 | (let ((match-data (match-data))) | |
1835 | (goto-char (match-end 0)) | |
c567ac01 RS |
1836 | (if ignore-decorations |
1837 | t | |
1838 | (while (looking-at "[0-9]") (forward-char 1)) | |
1839 | (if (and (not (eolp)) (looking-at "\\s-")) (forward-char 1))) | |
9179616f | 1840 | (store-match-data match-data)) |
1977b8f6 | 1841 | ;; Reestablish where we are: |
c567ac01 RS |
1842 | (outline-current-depth))) |
1843 | ;;;_ > outline-current-bullet-pos () | |
1844 | (defun outline-current-bullet-pos () | |
1845 | "Return position of current \(visible) topic's bullet." | |
1846 | ||
1847 | (if (not (outline-current-depth)) | |
1848 | nil | |
1849 | (1- (match-end 0)))) | |
1850 | ;;;_ > outline-back-to-current-heading () | |
1977b8f6 | 1851 | (defun outline-back-to-current-heading () |
19b84ba3 RS |
1852 | "Move to heading line of current topic, or beginning if already on the line." |
1853 | ||
1977b8f6 RS |
1854 | (beginning-of-line) |
1855 | (prog1 (or (outline-on-current-heading-p) | |
1856 | (and (re-search-backward (concat "^\\(" outline-regexp "\\)") | |
1857 | nil | |
1858 | 'move) | |
c567ac01 RS |
1859 | (outline-prefix-data (match-beginning 1)(match-end 1)))) |
1860 | (if (interactive-p) (outline-end-of-prefix)))) | |
9179616f DL |
1861 | ;;;_ > outline-back-to-heading () |
1862 | (defalias 'outline-back-to-heading 'outline-back-to-current-heading) | |
c567ac01 | 1863 | ;;;_ > outline-pre-next-preface () |
1977b8f6 RS |
1864 | (defun outline-pre-next-preface () |
1865 | "Skip forward to just before the next heading line. | |
1866 | ||
c567ac01 | 1867 | Returns that character position." |
1977b8f6 RS |
1868 | |
1869 | (if (re-search-forward outline-line-boundary-regexp nil 'move) | |
c567ac01 RS |
1870 | (prog1 (goto-char (match-beginning 0)) |
1871 | (outline-prefix-data (match-beginning 2)(match-end 2))))) | |
1872 | ;;;_ > outline-end-of-current-subtree () | |
1977b8f6 | 1873 | (defun outline-end-of-current-subtree () |
c567ac01 | 1874 | "Put point at the end of the last leaf in the currently visible topic." |
1977b8f6 RS |
1875 | (interactive) |
1876 | (outline-back-to-current-heading) | |
19b84ba3 | 1877 | (let ((level (outline-recent-depth))) |
1977b8f6 RS |
1878 | (outline-next-heading) |
1879 | (while (and (not (eobp)) | |
1880 | (> (outline-recent-depth) level)) | |
1881 | (outline-next-heading)) | |
c567ac01 | 1882 | (and (not (eobp)) (forward-char -1)) |
9179616f | 1883 | (and (memq (preceding-char) '(?\n ?\r)) |
c567ac01 | 1884 | (memq (aref (buffer-substring (max 1 (- (point) 3)) (point)) 1) |
9179616f | 1885 | '(?\n ?\r)) |
c567ac01 | 1886 | (forward-char -1)) |
19b84ba3 | 1887 | (setq outline-recent-end-of-subtree (point)))) |
c567ac01 | 1888 | ;;;_ > outline-beginning-of-current-entry () |
1977b8f6 | 1889 | (defun outline-beginning-of-current-entry () |
19b84ba3 | 1890 | "When not already there, position point at beginning of current topic's body. |
c567ac01 RS |
1891 | |
1892 | If already there, move cursor to bullet for hot-spot operation. | |
1893 | \(See outline-mode doc string for details on hot-spot operation.)" | |
1977b8f6 | 1894 | (interactive) |
c567ac01 RS |
1895 | (let ((start-point (point))) |
1896 | (outline-end-of-prefix) | |
1897 | (if (and (interactive-p) | |
1898 | (= (point) start-point)) | |
1899 | (goto-char (outline-current-bullet-pos))))) | |
1900 | ;;;_ > outline-end-of-current-entry () | |
1977b8f6 | 1901 | (defun outline-end-of-current-entry () |
c567ac01 | 1902 | "Position the point at the end of the current topics' entry." |
1977b8f6 RS |
1903 | (interactive) |
1904 | (outline-show-entry) | |
1905 | (prog1 (outline-pre-next-preface) | |
1906 | (if (and (not (bobp))(looking-at "^$")) | |
19b84ba3 | 1907 | (forward-char -1)))) |
9179616f DL |
1908 | ;;;_ > outline-end-of-current-heading () |
1909 | (defun outline-end-of-current-heading () | |
1910 | (interactive) | |
1911 | (outline-beginning-of-current-entry) | |
1912 | (forward-line -1) | |
1913 | (end-of-line)) | |
1914 | (defalias 'outline-end-of-heading 'outline-end-of-current-heading) | |
1977b8f6 | 1915 | |
c567ac01 RS |
1916 | ;;;_ - Depth-wise |
1917 | ;;;_ > outline-ascend-to-depth (depth) | |
1977b8f6 | 1918 | (defun outline-ascend-to-depth (depth) |
c567ac01 | 1919 | "Ascend to depth DEPTH, returning depth if successful, nil if not." |
1977b8f6 RS |
1920 | (if (and (> depth 0)(<= depth (outline-depth))) |
1921 | (let ((last-good (point))) | |
1922 | (while (and (< depth (outline-depth)) | |
1923 | (setq last-good (point)) | |
1924 | (outline-beginning-of-level) | |
1925 | (outline-previous-heading))) | |
1926 | (if (= (outline-recent-depth) depth) | |
1927 | (progn (goto-char outline-recent-prefix-beginning) | |
1928 | depth) | |
1929 | (goto-char last-good) | |
1930 | nil)) | |
c567ac01 | 1931 | (if (interactive-p) (outline-end-of-prefix)))) |
9179616f DL |
1932 | ;;;_ > outline-ascend () |
1933 | (defun outline-ascend () | |
1934 | "Ascend one level, returning t if successful, nil if not." | |
1935 | (prog1 | |
1936 | (if (outline-beginning-of-level) | |
1937 | (outline-previous-heading)) | |
1938 | (if (interactive-p) (outline-end-of-prefix)))) | |
c567ac01 | 1939 | ;;;_ > outline-descend-to-depth (depth) |
1977b8f6 | 1940 | (defun outline-descend-to-depth (depth) |
19b84ba3 RS |
1941 | "Descend to depth DEPTH within current topic. |
1942 | ||
1943 | Returning depth if successful, nil if not." | |
1977b8f6 RS |
1944 | (let ((start-point (point)) |
1945 | (start-depth (outline-depth))) | |
1946 | (while | |
1947 | (and (> (outline-depth) 0) | |
1948 | (not (= depth (outline-recent-depth))) ; ... not there yet | |
1949 | (outline-next-heading) ; ... go further | |
1950 | (< start-depth (outline-recent-depth)))) ; ... still in topic | |
1951 | (if (and (> (outline-depth) 0) | |
1952 | (= (outline-recent-depth) depth)) | |
1953 | depth | |
1954 | (goto-char start-point) | |
1955 | nil)) | |
1956 | ) | |
c567ac01 | 1957 | ;;;_ > outline-up-current-level (arg &optional dont-complain) |
1977b8f6 | 1958 | (defun outline-up-current-level (arg &optional dont-complain) |
19b84ba3 RS |
1959 | "Move out ARG levels from current visible topic. |
1960 | ||
1961 | Positions on heading line of containing topic. Error if unable to | |
1962 | ascend that far, or nil if unable to ascend but optional arg | |
1963 | DONT-COMPLAIN is non-nil." | |
1977b8f6 RS |
1964 | (interactive "p") |
1965 | (outline-back-to-current-heading) | |
19b84ba3 RS |
1966 | (let ((present-level (outline-recent-depth)) |
1967 | (last-good (point)) | |
1968 | failed | |
1969 | return) | |
1977b8f6 RS |
1970 | ;; Loop for iterating arg: |
1971 | (while (and (> (outline-recent-depth) 1) | |
1972 | (> arg 0) | |
19b84ba3 RS |
1973 | (not (bobp)) |
1974 | (not failed)) | |
1975 | (setq last-good (point)) | |
1977b8f6 RS |
1976 | ;; Loop for going back over current or greater depth: |
1977 | (while (and (not (< (outline-recent-depth) present-level)) | |
19b84ba3 RS |
1978 | (or (outline-previous-visible-heading 1) |
1979 | (not (setq failed present-level))))) | |
1977b8f6 RS |
1980 | (setq present-level (outline-current-depth)) |
1981 | (setq arg (- arg 1))) | |
19b84ba3 RS |
1982 | (if (or failed |
1983 | (> arg 0)) | |
1984 | (progn (goto-char last-good) | |
1985 | (if (interactive-p) (outline-end-of-prefix)) | |
1986 | (if (not dont-complain) | |
6a05d05f | 1987 | (error "Can't ascend past outermost level") |
19b84ba3 RS |
1988 | (if (interactive-p) (outline-end-of-prefix)) |
1989 | nil)) | |
1990 | (if (interactive-p) (outline-end-of-prefix)) | |
1991 | outline-recent-prefix-beginning))) | |
1977b8f6 | 1992 | |
c567ac01 RS |
1993 | ;;;_ - Linear |
1994 | ;;;_ > outline-next-sibling (&optional depth backward) | |
1995 | (defun outline-next-sibling (&optional depth backward) | |
1996 | "Like outline-forward-current-level, but respects invisible topics. | |
1977b8f6 | 1997 | |
c567ac01 | 1998 | Traverse at optional DEPTH, or current depth if none specified. |
1977b8f6 | 1999 | |
c567ac01 | 2000 | Go backward if optional arg BACKWARD is non-nil. |
1977b8f6 | 2001 | |
c567ac01 | 2002 | Return depth if successful, nil otherwise." |
1977b8f6 RS |
2003 | |
2004 | (if (and backward (bobp)) | |
2005 | nil | |
c567ac01 | 2006 | (let ((start-depth (or depth (outline-depth))) |
1977b8f6 | 2007 | (start-point (point)) |
c567ac01 | 2008 | last-depth) |
1977b8f6 RS |
2009 | (while (and (not (if backward (bobp) (eobp))) |
2010 | (if backward (outline-previous-heading) | |
2011 | (outline-next-heading)) | |
c567ac01 | 2012 | (> (setq last-depth (outline-recent-depth)) start-depth))) |
1977b8f6 | 2013 | (if (and (not (eobp)) |
c567ac01 | 2014 | (and (> (or last-depth (outline-depth)) 0) |
1977b8f6 RS |
2015 | (= (outline-recent-depth) start-depth))) |
2016 | outline-recent-prefix-beginning | |
2017 | (goto-char start-point) | |
c567ac01 RS |
2018 | (if depth (outline-depth) start-depth) |
2019 | nil)))) | |
2020 | ;;;_ > outline-previous-sibling (&optional depth backward) | |
2021 | (defun outline-previous-sibling (&optional depth backward) | |
19b84ba3 | 2022 | "Like outline-forward-current-level,but backwards & respect invisible topics. |
1977b8f6 | 2023 | |
c567ac01 | 2024 | Optional DEPTH specifies depth to traverse, default current depth. |
1977b8f6 | 2025 | |
c567ac01 | 2026 | Optional BACKWARD reverses direction. |
1977b8f6 | 2027 | |
c567ac01 RS |
2028 | Return depth if successful, nil otherwise." |
2029 | (outline-next-sibling depth (not backward)) | |
1977b8f6 | 2030 | ) |
c567ac01 RS |
2031 | ;;;_ > outline-snug-back () |
2032 | (defun outline-snug-back () | |
19b84ba3 RS |
2033 | "Position cursor at end of previous topic |
2034 | ||
2035 | Presumes point is at the start of a topic prefix." | |
c567ac01 RS |
2036 | (if (or (bobp) (eobp)) |
2037 | nil | |
2038 | (forward-char -1)) | |
9179616f | 2039 | (if (or (bobp) (not (memq (preceding-char) '(?\n ?\r)))) |
c567ac01 RS |
2040 | nil |
2041 | (forward-char -1) | |
9179616f | 2042 | (if (or (bobp) (not (memq (preceding-char) '(?\n ?\r)))) |
c567ac01 RS |
2043 | (forward-char -1))) |
2044 | (point)) | |
2045 | ;;;_ > outline-beginning-of-level () | |
1977b8f6 | 2046 | (defun outline-beginning-of-level () |
c567ac01 | 2047 | "Go back to the first sibling at this level, visible or not." |
1977b8f6 | 2048 | (outline-end-of-level 'backward)) |
c567ac01 | 2049 | ;;;_ > outline-end-of-level (&optional backward) |
1977b8f6 | 2050 | (defun outline-end-of-level (&optional backward) |
c567ac01 | 2051 | "Go to the last sibling at this level, visible or not." |
1977b8f6 | 2052 | |
c567ac01 RS |
2053 | (let ((depth (outline-depth))) |
2054 | (while (outline-previous-sibling depth nil)) | |
2055 | (prog1 (outline-recent-depth) | |
2056 | (if (interactive-p) (outline-end-of-prefix))))) | |
2057 | ;;;_ > outline-next-visible-heading (arg) | |
2058 | (defun outline-next-visible-heading (arg) | |
19b84ba3 | 2059 | "Move to the next ARG'th visible heading line, backward if arg is negative. |
c567ac01 | 2060 | |
19b84ba3 | 2061 | Move as far as possible in indicated direction \(beginning or end of |
9179616f | 2062 | buffer) if headings are exhausted." |
1977b8f6 | 2063 | |
1977b8f6 | 2064 | (interactive "p") |
c567ac01 RS |
2065 | (let* ((backward (if (< arg 0) (setq arg (* -1 arg)))) |
2066 | (step (if backward -1 1)) | |
19b84ba3 | 2067 | (start-point (point)) |
c567ac01 RS |
2068 | prev got) |
2069 | ||
2070 | (while (> arg 0) ; limit condition | |
2071 | (while (and (not (if backward (bobp)(eobp))) ; boundary condition | |
19b84ba3 RS |
2072 | ;; Move, skipping over all those concealed lines: |
2073 | (< -1 (forward-line step)) | |
2074 | (not (setq got (looking-at outline-regexp))))) | |
c567ac01 RS |
2075 | ;; Register this got, it may be the last: |
2076 | (if got (setq prev got)) | |
2077 | (setq arg (1- arg))) | |
2078 | (cond (got ; Last move was to a prefix: | |
2079 | (outline-prefix-data (match-beginning 0) (match-end 0)) | |
2080 | (outline-end-of-prefix)) | |
2081 | (prev ; Last move wasn't, but prev was: | |
2082 | (outline-prefix-data (match-beginning 0) (match-end 0))) | |
2083 | ((not backward) (end-of-line) nil)))) | |
2084 | ;;;_ > outline-previous-visible-heading (arg) | |
2085 | (defun outline-previous-visible-heading (arg) | |
2086 | "Move to the previous heading line. | |
1977b8f6 | 2087 | |
c567ac01 RS |
2088 | With argument, repeats or can move forward if negative. |
2089 | A heading line is one that starts with a `*' (or that outline-regexp | |
2090 | matches)." | |
1977b8f6 | 2091 | (interactive "p") |
c567ac01 RS |
2092 | (outline-next-visible-heading (- arg))) |
2093 | ;;;_ > outline-forward-current-level (arg) | |
2094 | (defun outline-forward-current-level (arg) | |
19b84ba3 | 2095 | "Position point at the next heading of the same level. |
1977b8f6 | 2096 | |
19b84ba3 | 2097 | Takes optional repeat-count, goes backward if count is negative. |
1977b8f6 | 2098 | |
19b84ba3 | 2099 | Returns resulting position, else nil if none found." |
c567ac01 | 2100 | (interactive "p") |
19b84ba3 RS |
2101 | (let ((start-depth (outline-current-depth)) |
2102 | (start-point (point)) | |
2103 | (start-arg arg) | |
2104 | (backward (> 0 arg)) | |
2105 | last-depth | |
2106 | (last-good (point)) | |
2107 | at-boundary) | |
2108 | (if (= 0 start-depth) | |
2109 | (error "No siblings, not in a topic...")) | |
2110 | (if backward (setq arg (* -1 arg))) | |
2111 | (while (not (or (zerop arg) | |
2112 | at-boundary)) | |
2113 | (while (and (not (if backward (bobp) (eobp))) | |
2114 | (if backward (outline-previous-visible-heading 1) | |
2115 | (outline-next-visible-heading 1)) | |
2116 | (> (setq last-depth (outline-recent-depth)) start-depth))) | |
2117 | (if (and last-depth (= last-depth start-depth) | |
2118 | (not (if backward (bobp) (eobp)))) | |
2119 | (setq last-good (point) | |
2120 | arg (1- arg)) | |
2121 | (setq at-boundary t))) | |
2122 | (if (and (not (eobp)) | |
2123 | (= arg 0) | |
2124 | (and (> (or last-depth (outline-depth)) 0) | |
2125 | (= (outline-recent-depth) start-depth))) | |
2126 | outline-recent-prefix-beginning | |
2127 | (goto-char last-good) | |
2128 | (if (not (interactive-p)) | |
2129 | nil | |
2130 | (outline-end-of-prefix) | |
6a05d05f | 2131 | (error "Hit %s level %d topic, traversed %d of %d requested" |
19b84ba3 RS |
2132 | (if backward "first" "last") |
2133 | (outline-recent-depth) | |
2134 | (- (abs start-arg) arg) | |
2135 | (abs start-arg)))))) | |
c567ac01 RS |
2136 | ;;;_ > outline-backward-current-level (arg) |
2137 | (defun outline-backward-current-level (arg) | |
19b84ba3 | 2138 | "Inverse of `outline-forward-current-level'." |
c567ac01 | 2139 | (interactive "p") |
19b84ba3 RS |
2140 | (if (interactive-p) |
2141 | (let ((current-prefix-arg (* -1 arg))) | |
2142 | (call-interactively 'outline-forward-current-level)) | |
2143 | (outline-forward-current-level (* -1 arg)))) | |
c567ac01 | 2144 | |
19b84ba3 | 2145 | ;;;_ #5 Alteration |
c567ac01 RS |
2146 | |
2147 | ;;;_ - Fundamental | |
2148 | ;;;_ > outline-before-change-protect (beg end) | |
2149 | (defun outline-before-change-protect (beg end) | |
19b84ba3 RS |
2150 | "Outline before-change hook, regulates changes to concealed text. |
2151 | ||
2152 | Reveal concealed text that would be changed by current command, and | |
c567ac01 RS |
2153 | offer user choice to commit or forego the change. Unchanged text is |
2154 | reconcealed. User has option to have changed text reconcealed. | |
2155 | ||
2156 | Undo commands are specially treated - the user is not prompted for | |
2157 | choice, the undoes are always committed (based on presumption that the | |
2158 | things being undone were already subject to this regulation routine), | |
2159 | and undoes always leave the changed stuff exposed. | |
2160 | ||
2161 | Changes to concealed regions are ignored while file is being written. | |
2162 | \(This is for the sake of functions that do change the file during | |
2163 | writes, like crypt and zip modes.) | |
2164 | ||
9179616f DL |
2165 | Locally bound in outline buffers to `before-change-functions', which |
2166 | in emacs 19 is run before any change to the buffer. | |
c567ac01 | 2167 | |
353e2ef2 KH |
2168 | Any functions which set [`this-command' to `undo', or which set] |
2169 | `outline-override-protect' non-nil (as does, eg, outline-flag-chars) | |
c567ac01 RS |
2170 | are exempt from this restriction." |
2171 | (if (and (outline-mode-p) | |
353e2ef2 | 2172 | ; outline-override-protect |
c567ac01 RS |
2173 | ; set by functions that know what |
2174 | ; they're doing, eg outline internals: | |
2175 | (not outline-override-protect) | |
2176 | (not outline-during-write-cue) | |
2177 | (save-match-data ; Preserve operation position state. | |
2178 | ; Both beginning and end chars must | |
2179 | ; be exposed: | |
2180 | (save-excursion (if (memq this-command '(newline open-line)) | |
2181 | ;; Compensate for stupid emacs {new, | |
2182 | ;; open-}line display optimization: | |
2183 | (setq beg (1+ beg) | |
2184 | end (1+ end))) | |
2185 | (goto-char beg) | |
2186 | (or (outline-hidden-p) | |
2187 | (and (not (= beg end)) | |
2188 | (goto-char end) | |
2189 | (outline-hidden-p)))))) | |
2190 | (save-match-data | |
2191 | (if (equal this-command 'undo) | |
2192 | ;; Allow undo without inhibition. | |
2193 | ;; - Undoing new and open-line hits stupid emacs redisplay | |
2194 | ;; optimization (em 19 cmds.c, ~ line 200). | |
2195 | ;; - Presumably, undoing what was properly protected when | |
2196 | ;; done. | |
2197 | ;; - Undo may be users' only recourse in protection faults. | |
2198 | ;; So, expose what getting changed: | |
2199 | (progn (message "Undo! - exposing concealed target...") | |
c567ac01 RS |
2200 | (if (outline-hidden-p) |
2201 | (outline-show-children)) | |
19b84ba3 | 2202 | (message "Undo!")) |
c567ac01 RS |
2203 | (let (response |
2204 | (rehide-completely (save-excursion (outline-goto-prefix) | |
2205 | (outline-hidden-p))) | |
2206 | rehide-place) | |
353e2ef2 | 2207 | |
c567ac01 RS |
2208 | (save-excursion |
2209 | (if (condition-case err | |
2210 | ;; Condition case to catch keyboard quits during reads. | |
2211 | (progn | |
2212 | ; Give them a peek where | |
2213 | (save-excursion | |
2214 | (if (eolp) (setq rehide-place | |
2215 | (outline-goto-prefix))) | |
2216 | (outline-show-entry)) | |
2217 | ; Present the message, but... | |
2218 | ; leave the cursor at the location | |
2219 | ; until they respond: | |
2220 | ; Then interpret the response: | |
2221 | (while | |
353e2ef2 | 2222 | (progn |
c567ac01 RS |
2223 | (message (concat "Change inside concealed" |
2224 | " region - do it? " | |
2225 | "(n or 'y'/'r'eclose)")) | |
2226 | (setq response (read-char)) | |
2227 | (not | |
2228 | (cond ((memq response '(?r ?R)) | |
2229 | (setq response 'reclose)) | |
2230 | ((memq response '(?y ?Y ? )) | |
2231 | (setq response t)) | |
2232 | ((memq response '(?n ?N 127)) | |
2233 | (setq response nil) | |
2234 | t) | |
2235 | ((eq response ??) | |
2236 | (message | |
353e2ef2 | 2237 | "`r' means `yes, then reclose'") |
c567ac01 RS |
2238 | nil) |
2239 | (t (message "Please answer y, n, or r") | |
2240 | (sit-for 1) | |
2241 | nil))))) | |
2242 | response) | |
9179616f | 2243 | ('quit nil)) |
c567ac01 RS |
2244 | ; Continue: |
2245 | (if (eq response 'reclose) | |
2246 | (save-excursion | |
2247 | (if rehide-place (goto-char rehide-place)) | |
2248 | (if rehide-completely | |
2249 | (outline-hide-current-entry-completely) | |
2250 | (outline-hide-current-entry))) | |
2251 | (if (outline-ascend-to-depth (1- (outline-recent-depth))) | |
2252 | (outline-show-children) | |
2253 | (outline-show-to-offshoot))) | |
2254 | ; Prevent: | |
2255 | (if rehide-completely | |
2256 | (save-excursion | |
2257 | (if rehide-place (goto-char rehide-place)) | |
2258 | (outline-hide-current-entry-completely)) | |
2259 | (outline-hide-current-entry)) | |
2260 | (error (concat | |
2261 | "Change within concealed region prevented."))))))) | |
2262 | ) ; if | |
2263 | ) ; defun | |
2264 | ;;;_ = outline-post-goto-bullet | |
2265 | (defvar outline-post-goto-bullet nil | |
19b84ba3 RS |
2266 | "Outline internal var, for `outline-pre-command-business' hot-spot operation. |
2267 | ||
2268 | When set, tells post-processing to reposition on topic bullet, and | |
2269 | then unset it. Set by outline-pre-command-business when implementing | |
2270 | hot-spot operation, where literal characters typed over a topic bullet | |
2271 | are mapped to the command of the corresponding control-key on the | |
2272 | outline-mode-map.") | |
c567ac01 RS |
2273 | (make-variable-buffer-local 'outline-post-goto-bullet) |
2274 | ;;;_ > outline-post-command-business () | |
2275 | (defun outline-post-command-business () | |
19b84ba3 | 2276 | "Outline post-command-hook function. |
c567ac01 | 2277 | |
19b84ba3 | 2278 | - Null outline-override-protect, so it's not left open. |
c567ac01 | 2279 | |
19b84ba3 | 2280 | - Implement (and clear) outline-post-goto-bullet, for hot-spot |
c567ac01 RS |
2281 | outline commands. |
2282 | ||
2283 | - Massages buffer-undo-list so successive, standard character self-inserts are | |
2284 | aggregated. This kludge compensates for lack of undo bunching when | |
9179616f | 2285 | before-change-functions is used." |
c567ac01 RS |
2286 | |
2287 | ; Apply any external change func: | |
19b84ba3 RS |
2288 | (if (not (outline-mode-p)) ; In outline-mode. |
2289 | nil | |
2290 | (setq outline-override-protect nil) | |
9179616f DL |
2291 | (if outline-isearch-dynamic-expose |
2292 | (outline-isearch-rectification)) | |
19b84ba3 RS |
2293 | (if outline-during-write-cue |
2294 | ;; Was used by outline-before-change-protect, done with it now: | |
2295 | (setq outline-during-write-cue nil)) | |
2296 | ;; Undo bunching business: | |
2297 | (if (and (listp buffer-undo-list) ; Undo history being kept. | |
2298 | (equal this-command 'self-insert-command) | |
2299 | (equal last-command 'self-insert-command)) | |
2300 | (let* ((prev-stuff (cdr buffer-undo-list)) | |
2301 | (before-prev-stuff (cdr (cdr prev-stuff))) | |
2302 | cur-cell cur-from cur-to | |
2303 | prev-cell prev-from prev-to) | |
2304 | (if (and before-prev-stuff ; Goes back far enough to bother, | |
2305 | (not (car prev-stuff)) ; and break before current, | |
2306 | (not (car before-prev-stuff)) ; !and break before prev! | |
2307 | (setq prev-cell (car (cdr prev-stuff))) ; contents now, | |
2308 | (setq cur-cell (car buffer-undo-list)) ; contents prev. | |
2309 | ||
2310 | ;; cur contents denote a single char insertion: | |
2311 | (numberp (setq cur-from (car cur-cell))) | |
2312 | (numberp (setq cur-to (cdr cur-cell))) | |
2313 | (= 1 (- cur-to cur-from)) | |
2314 | ||
2315 | ;; prev contents denote fewer than aggregate-limit | |
2316 | ;; insertions: | |
2317 | (numberp (setq prev-from (car prev-cell))) | |
2318 | (numberp (setq prev-to (cdr prev-cell))) | |
c567ac01 | 2319 | ; Below threshold: |
19b84ba3 RS |
2320 | (> outline-undo-aggregation (- prev-to prev-from))) |
2321 | (setq buffer-undo-list | |
2322 | (cons (cons prev-from cur-to) | |
2323 | (cdr (cdr (cdr buffer-undo-list)))))))) | |
2324 | ;; Implement -post-goto-bullet, if set: (must be after undo business) | |
2325 | (if (and outline-post-goto-bullet | |
2326 | (outline-current-bullet-pos)) | |
2327 | (progn (goto-char (outline-current-bullet-pos)) | |
2328 | (setq outline-post-goto-bullet nil))) | |
2329 | )) | |
c567ac01 RS |
2330 | ;;;_ > outline-pre-command-business () |
2331 | (defun outline-pre-command-business () | |
19b84ba3 | 2332 | "Outline pre-command-hook function for outline buffers. |
19b84ba3 | 2333 | Implements special behavior when cursor is on bullet char. |
c567ac01 RS |
2334 | |
2335 | Self-insert characters are reinterpreted control-character references | |
2336 | into the outline-mode-map. The outline-mode post-command hook will | |
2337 | position a cursor that has moved as a result of such reinterpretation, | |
2338 | on the destination topic's bullet, when the cursor wound up in the | |
2339 | ||
9179616f DL |
2340 | The upshot is that you can get easy, single (ie, unmodified) key |
2341 | outline maneuvering operations by positioning the cursor on the bullet | |
2342 | char. You stay in this mode until you use some regular | |
2343 | cursor-positioning command to relocate the cursor off of a bullet | |
2344 | char." | |
c567ac01 | 2345 | |
9179616f DL |
2346 | (if (not (outline-mode-p)) |
2347 | ;; Shouldn't be invoked if not in allout outline-mode, but just in case: | |
2348 | nil | |
2349 | ;; Register isearch status: | |
2350 | (if (and (boundp 'isearch-mode) isearch-mode) | |
2351 | (setq outline-pre-was-isearching t) | |
2352 | (setq outline-pre-was-isearching nil)) | |
2353 | ;; Hot-spot navigation provisions: | |
2354 | (if (and (eq this-command 'self-insert-command) | |
2355 | (eq (point)(outline-current-bullet-pos))) | |
2356 | (let* ((this-key-num (cond | |
2357 | ((numberp last-command-char) | |
2358 | last-command-char) | |
2359 | ;; XXX Only xemacs has characterp. | |
2360 | ((and (fboundp 'characterp) | |
2361 | (characterp last-command-char)) | |
2362 | (char-to-int last-command-char)) | |
2363 | (t 0))) | |
2364 | mapped-binding) | |
2365 | (if (zerop this-key-num) | |
2366 | nil | |
c567ac01 RS |
2367 | ; Map upper-register literals |
2368 | ; to lower register: | |
9179616f DL |
2369 | (if (<= 96 this-key-num) |
2370 | (setq this-key-num (- this-key-num 32))) | |
c567ac01 | 2371 | ; Check if we have a literal: |
9179616f DL |
2372 | (if (and (<= 64 this-key-num) |
2373 | (>= 96 this-key-num)) | |
2374 | (setq mapped-binding | |
2375 | (lookup-key 'outline-mode-map | |
2376 | (concat outline-command-prefix | |
2377 | (char-to-string (- this-key-num | |
2378 | 64)))))) | |
2379 | (if mapped-binding | |
2380 | (setq outline-post-goto-bullet t | |
2381 | this-command mapped-binding))))))) | |
19b84ba3 RS |
2382 | ;;;_ > outline-find-file-hook () |
2383 | (defun outline-find-file-hook () | |
2384 | "Activate outline-mode when `outline-auto-activation' & `outline-layout' are non-nil. | |
2385 | ||
2386 | See `outline-init' for setup instructions." | |
2387 | (if (and outline-auto-activation | |
2388 | (not (outline-mode-p)) | |
2389 | outline-layout) | |
2390 | (outline-mode t))) | |
9179616f DL |
2391 | ;;;_ > outline-isearch-rectification |
2392 | (defun outline-isearch-rectification () | |
2393 | "Rectify outline exposure before, during, or after isearch. | |
2394 | ||
2395 | Called as part of outline-post-command-business." | |
2396 | ||
2397 | (let ((isearching (and (boundp 'isearch-mode) isearch-mode))) | |
2398 | (cond ((and isearching (not outline-pre-was-isearching)) | |
2399 | (outline-isearch-expose 'start)) | |
2400 | ((and isearching outline-pre-was-isearching) | |
2401 | (outline-isearch-expose 'continue)) | |
2402 | ((and (not isearching) outline-pre-was-isearching) | |
2403 | (outline-isearch-expose 'final)) | |
2404 | ;; Not and wasn't isearching: | |
2405 | (t (setq outline-isearch-prior-pos nil) | |
2406 | (setq outline-isearch-did-quit nil))))) | |
2407 | ;;;_ = outline-isearch-was-font-lock | |
2408 | (defvar outline-isearch-was-font-lock | |
2409 | (and (boundp 'font-lock-mode) font-lock-mode)) | |
12435002 GM |
2410 | |
2411 | ;;;_ > outline-flag-region (from to flag) | |
2412 | (defmacro outline-flag-region (from to flag) | |
2413 | "Hide or show lines from FROM to TO, via emacs selective-display FLAG char. | |
2414 | Ie, text following flag C-m \(carriage-return) is hidden until the | |
2415 | next C-j (newline) char. | |
2416 | ||
2417 | Returns the endpoint of the region." | |
2418 | `(let ((buffer-read-only nil) | |
2419 | (outline-override-protect t)) | |
2420 | (subst-char-in-region ,from ,to | |
2421 | (if (= ,flag ?\n) ?\r ?\n) | |
2422 | ,flag t))) | |
2423 | ||
9179616f DL |
2424 | ;;;_ > outline-isearch-expose (mode) |
2425 | (defun outline-isearch-expose (mode) | |
2426 | "Mode is either 'clear, 'start, 'continue, or 'final." | |
2427 | ;; outline-isearch-prior-pos encodes exposure status of prior pos: | |
2428 | ;; (pos was-vis header-pos end-pos) | |
2429 | ;; pos - point of concern | |
2430 | ;; was-vis - t, else 'topic if entire topic was exposed, 'entry otherwise | |
2431 | ;; Do reclosure or prior pos, as necessary: | |
2432 | (if (eq mode 'start) | |
2433 | (setq outline-isearch-was-font-lock (and (boundp 'font-lock-mode) | |
2434 | font-lock-mode) | |
2435 | font-lock-mode nil) | |
2436 | (if (eq mode 'final) | |
2437 | (setq font-lock-mode outline-isearch-was-font-lock)) | |
2438 | (if (and outline-isearch-prior-pos | |
2439 | (listp outline-isearch-prior-pos)) | |
2440 | ;; Conceal prior peek: | |
2441 | (outline-flag-region (car (cdr outline-isearch-prior-pos)) | |
2442 | (car (cdr (cdr outline-isearch-prior-pos))) | |
2443 | ?\r))) | |
2444 | (if (outline-visible-p) | |
2445 | (setq outline-isearch-prior-pos nil) | |
2446 | (if (not (eq mode 'final)) | |
2447 | (setq outline-isearch-prior-pos (cons (point) (outline-show-entry))) | |
2448 | (if outline-isearch-did-quit | |
2449 | nil | |
2450 | (setq outline-isearch-prior-pos nil) | |
2451 | (outline-show-children)))) | |
2452 | (setq outline-isearch-did-quit nil)) | |
2453 | ;;;_ > outline-enwrap-isearch () | |
2454 | (defun outline-enwrap-isearch () | |
2455 | "Impose outline-mode isearch-abort wrapper for dynamic exposure in isearch. | |
2456 | ||
2457 | The function checks to ensure that the rebinding is done only once." | |
2458 | ||
2459 | (add-hook 'isearch-mode-end-hook 'outline-isearch-rectification) | |
2460 | (if (fboundp 'outline-real-isearch-abort) | |
2461 | ;; | |
2462 | nil | |
2463 | ; Ensure load of isearch-mode: | |
2464 | (if (or (and (fboundp 'isearch-mode) | |
2465 | (fboundp 'isearch-abort)) | |
2466 | (condition-case error | |
2467 | (load-library "isearch-mode") | |
2468 | ('file-error (message | |
2469 | "Skipping isearch-mode provisions - %s '%s'" | |
2470 | (car (cdr error)) | |
2471 | (car (cdr (cdr error)))) | |
2472 | (sit-for 1) | |
2473 | ;; Inhibit subsequent tries and return nil: | |
2474 | (setq outline-isearch-dynamic-expose nil)))) | |
2475 | ;; Isearch-mode loaded, encapsulate specific entry points for | |
2476 | ;; outline dynamic-exposure business: | |
2477 | (progn | |
2478 | ;; stash crucial isearch-mode funcs under known, private | |
2479 | ;; names, then register wrapper functions under the old | |
2480 | ;; names, in their stead: | |
2481 | (fset 'outline-real-isearch-abort (symbol-function 'isearch-abort)) | |
2482 | (fset 'isearch-abort 'outline-isearch-abort))))) | |
2483 | ;;;_ > outline-isearch-abort () | |
2484 | (defun outline-isearch-abort () | |
2485 | "Wrapper for outline-real-isearch-abort \(which see), to register | |
2486 | actual quits." | |
2487 | (interactive) | |
2488 | (setq outline-isearch-did-quit nil) | |
2489 | (condition-case what | |
2490 | (outline-real-isearch-abort) | |
2491 | ('quit (setq outline-isearch-did-quit t) | |
2492 | (signal 'quit nil)))) | |
2493 | ||
2494 | ;;; Prevent unnecessary font-lock while isearching! | |
2495 | (defvar isearch-was-font-locking nil) | |
2496 | (defun isearch-inhibit-font-lock () | |
2497 | "Inhibit font-lock while isearching - for use on isearch-mode-hook." | |
2498 | (if (and (outline-mode-p) (boundp 'font-lock-mode) font-lock-mode) | |
2499 | (setq isearch-was-font-locking t | |
2500 | font-lock-mode nil))) | |
2501 | (add-hook 'isearch-mode-hook 'isearch-inhibit-font-lock) | |
2502 | (defun isearch-reenable-font-lock () | |
2503 | "Reenable font-lock after isearching - for use on isearch-mode-end-hook." | |
2504 | (if (and (boundp 'font-lock-mode) font-lock-mode) | |
2505 | (if (and (outline-mode-p) isearch-was-font-locking) | |
2506 | (setq isearch-was-font-locking nil | |
2507 | font-lock-mode t)))) | |
2508 | (add-hook 'isearch-mode-end-hook 'isearch-reenable-font-lock) | |
c567ac01 RS |
2509 | |
2510 | ;;;_ - Topic Format Assessment | |
2511 | ;;;_ > outline-solicit-alternate-bullet (depth &optional current-bullet) | |
1977b8f6 RS |
2512 | (defun outline-solicit-alternate-bullet (depth &optional current-bullet) |
2513 | ||
19b84ba3 RS |
2514 | "Prompt for and return a bullet char as an alternative to the current one. |
2515 | ||
2516 | Offer one suitable for current depth DEPTH as default." | |
1977b8f6 | 2517 | |
9179616f | 2518 | (let* ((default-bullet (or (and (stringp current-bullet) current-bullet) |
1977b8f6 | 2519 | (outline-bullet-for-depth depth))) |
c567ac01 | 2520 | (sans-escapes (regexp-sans-escapes outline-bullets-string)) |
9179616f DL |
2521 | choice) |
2522 | (save-excursion | |
2523 | (goto-char (outline-current-bullet-pos)) | |
2524 | (setq choice (solicit-char-in-string | |
2525 | (format "Select bullet: %s ('%s' default): " | |
2526 | sans-escapes | |
2527 | default-bullet) | |
2528 | sans-escapes | |
2529 | t))) | |
2530 | (message "") | |
1977b8f6 RS |
2531 | (if (string= choice "") default-bullet choice)) |
2532 | ) | |
c567ac01 | 2533 | ;;;_ > outline-distinctive-bullet (bullet) |
1977b8f6 | 2534 | (defun outline-distinctive-bullet (bullet) |
c567ac01 | 2535 | "True if bullet is one of those on outline-distinctive-bullets-string." |
1977b8f6 | 2536 | (string-match (regexp-quote bullet) outline-distinctive-bullets-string)) |
c567ac01 | 2537 | ;;;_ > outline-numbered-type-prefix (&optional prefix) |
1977b8f6 | 2538 | (defun outline-numbered-type-prefix (&optional prefix) |
c567ac01 | 2539 | "True if current header prefix bullet is numbered bullet." |
1977b8f6 RS |
2540 | (and outline-numbered-bullet |
2541 | (string= outline-numbered-bullet | |
2542 | (if prefix | |
2543 | (outline-get-prefix-bullet prefix) | |
2544 | (outline-get-bullet))))) | |
c567ac01 | 2545 | ;;;_ > outline-bullet-for-depth (&optional depth) |
1977b8f6 | 2546 | (defun outline-bullet-for-depth (&optional depth) |
19b84ba3 | 2547 | "Return outline topic bullet suited to optional DEPTH, or current depth." |
1977b8f6 RS |
2548 | ;; Find bullet in plain-bullets-string modulo DEPTH. |
2549 | (if outline-stylish-prefixes | |
2550 | (char-to-string (aref outline-plain-bullets-string | |
2551 | (% (max 0 (- depth 2)) | |
2552 | outline-plain-bullets-string-len))) | |
2553 | outline-primary-bullet) | |
2554 | ) | |
2555 | ||
c567ac01 RS |
2556 | ;;;_ - Topic Production |
2557 | ;;;_ > outline-make-topic-prefix (&optional prior-bullet | |
1977b8f6 RS |
2558 | (defun outline-make-topic-prefix (&optional prior-bullet |
2559 | new | |
2560 | depth | |
2561 | solicit | |
2562 | number-control | |
2563 | index) | |
2564 | ;; Depth null means use current depth, non-null means we're either | |
2565 | ;; opening a new topic after current topic, lower or higher, or we're | |
2566 | ;; changing level of current topic. | |
2567 | ;; Solicit dominates specified bullet-char. | |
c567ac01 | 2568 | ;;;_ . Doc string: |
19b84ba3 | 2569 | "Generate a topic prefix suitable for optional arg DEPTH, or current depth. |
c567ac01 RS |
2570 | |
2571 | All the arguments are optional. | |
2572 | ||
2573 | PRIOR-BULLET indicates the bullet of the prefix being changed, or | |
2574 | nil if none. This bullet may be preserved (other options | |
2575 | notwithstanding) if it is on the outline-distinctive-bullets-string, | |
2576 | for instance. | |
2577 | ||
2578 | Second arg NEW indicates that a new topic is being opened after the | |
2579 | topic at point, if non-nil. Default bullet for new topics, eg, may | |
2580 | be set (contingent to other args) to numbered bullets if previous | |
2581 | sibling is one. The implication otherwise is that the current topic | |
2582 | is being adjusted - shifted or rebulleted - and we don't consider | |
2583 | bullet or previous sibling. | |
2584 | ||
2585 | Third arg DEPTH forces the topic prefix to that depth, regardless of | |
2586 | the current topics' depth. | |
2587 | ||
9179616f DL |
2588 | If SOLICIT is non-nil, then the choice of bullet is solicited from |
2589 | user. If it's a character, then that character is offered as the | |
2590 | default, otherwise the one suited to the context \(according to | |
2591 | distinction or depth) is offered. \(This overrides other options, | |
2592 | including, eg, a distinctive PRIOR-BULLET.) If non-nil, then the | |
2593 | context-specific bullet is used. | |
c567ac01 | 2594 | |
353e2ef2 | 2595 | Fifth arg, NUMBER-CONTROL, matters only if `outline-numbered-bullet' |
c567ac01 RS |
2596 | is non-nil *and* soliciting was not explicitly invoked. Then |
2597 | NUMBER-CONTROL non-nil forces prefix to either numbered or | |
2598 | denumbered format, depending on the value of the sixth arg, INDEX. | |
2599 | ||
2600 | \(Note that NUMBER-CONTROL does *not* apply to level 1 topics. Sorry...) | |
2601 | ||
2602 | If NUMBER-CONTROL is non-nil and sixth arg INDEX is non-nil then | |
2603 | the prefix of the topic is forced to be numbered. Non-nil | |
2604 | NUMBER-CONTROL and nil INDEX forces non-numbered format on the | |
2605 | bullet. Non-nil NUMBER-CONTROL and non-nil, non-number INDEX means | |
2606 | that the index for the numbered prefix will be derived, by counting | |
2607 | siblings back to start of level. If INDEX is a number, then that | |
2608 | number is used as the index for the numbered prefix (allowing, eg, | |
a0776d6b | 2609 | sequential renumbering to not require this function counting back the |
c567ac01 RS |
2610 | index for each successive sibling)." |
2611 | ;;;_ . Code: | |
1977b8f6 RS |
2612 | ;; The options are ordered in likely frequence of use, most common |
2613 | ;; highest, least lowest. Ie, more likely to be doing prefix | |
2614 | ;; adjustments than soliciting, and yet more than numbering. | |
2615 | ;; Current prefix is least dominant, but most likely to be commonly | |
2616 | ;; specified... | |
2617 | ||
2618 | (let* (body | |
2619 | numbering | |
2620 | denumbering | |
2621 | (depth (or depth (outline-depth))) | |
2622 | (header-lead outline-header-prefix) | |
2623 | (bullet-char | |
2624 | ||
2625 | ;; Getting value for bullet char is practically the whole job: | |
2626 | ||
2627 | (cond | |
2628 | ; Simplest situation - level 1: | |
2629 | ((<= depth 1) (setq header-lead "") outline-primary-bullet) | |
2630 | ; Simple, too: all asterisks: | |
2631 | (outline-old-style-prefixes | |
2632 | ;; Cheat - make body the whole thing, null out header-lead and | |
2633 | ;; bullet-char: | |
2634 | (setq body (make-string depth | |
2635 | (string-to-char outline-primary-bullet))) | |
2636 | (setq header-lead "") | |
2637 | "") | |
2638 | ||
2639 | ;; (Neither level 1 nor old-style, so we're space padding. | |
2640 | ;; Sneak it in the condition of the next case, whatever it is.) | |
2641 | ||
2642 | ;; Solicitation overrides numbering and other cases: | |
2643 | ((progn (setq body (make-string (- depth 2) ?\ )) | |
2644 | ;; The actual condition: | |
2645 | solicit) | |
9179616f | 2646 | (let* ((got (outline-solicit-alternate-bullet depth solicit))) |
1977b8f6 RS |
2647 | ;; Gotta check whether we're numbering and got a numbered bullet: |
2648 | (setq numbering (and outline-numbered-bullet | |
2649 | (not (and number-control (not index))) | |
2650 | (string= got outline-numbered-bullet))) | |
2651 | ;; Now return what we got, regardless: | |
2652 | got)) | |
2653 | ||
2654 | ;; Numbering invoked through args: | |
2655 | ((and outline-numbered-bullet number-control) | |
2656 | (if (setq numbering (not (setq denumbering (not index)))) | |
2657 | outline-numbered-bullet | |
19b84ba3 | 2658 | (if (and prior-bullet |
1977b8f6 | 2659 | (not (string= outline-numbered-bullet |
19b84ba3 RS |
2660 | prior-bullet))) |
2661 | prior-bullet | |
1977b8f6 RS |
2662 | (outline-bullet-for-depth depth)))) |
2663 | ||
2664 | ;;; Neither soliciting nor controlled numbering ;;; | |
2665 | ;;; (may be controlled denumbering, tho) ;;; | |
2666 | ||
2667 | ;; Check wrt previous sibling: | |
2668 | ((and new ; only check for new prefixes | |
2669 | (<= depth (outline-depth)) | |
2670 | outline-numbered-bullet ; ... & numbering enabled | |
2671 | (not denumbering) | |
2672 | (let ((sibling-bullet | |
2673 | (save-excursion | |
2674 | ;; Locate correct sibling: | |
2675 | (or (>= depth (outline-depth)) | |
2676 | (outline-ascend-to-depth depth)) | |
2677 | (outline-get-bullet)))) | |
2678 | (if (and sibling-bullet | |
2679 | (string= outline-numbered-bullet sibling-bullet)) | |
2680 | (setq numbering sibling-bullet))))) | |
2681 | ||
2682 | ;; Distinctive prior bullet? | |
2683 | ((and prior-bullet | |
2684 | (outline-distinctive-bullet prior-bullet) | |
2685 | ;; Either non-numbered: | |
2686 | (or (not (and outline-numbered-bullet | |
2687 | (string= prior-bullet outline-numbered-bullet))) | |
2688 | ;; or numbered, and not denumbering: | |
2689 | (setq numbering (not denumbering))) | |
2690 | ;; Here 'tis: | |
2691 | prior-bullet)) | |
2692 | ||
2693 | ;; Else, standard bullet per depth: | |
2694 | ((outline-bullet-for-depth depth))))) | |
2695 | ||
2696 | (concat header-lead | |
2697 | body | |
2698 | bullet-char | |
2699 | (if numbering | |
2700 | (format "%d" (cond ((and index (numberp index)) index) | |
2701 | (new (1+ (outline-sibling-index depth))) | |
2702 | ((outline-sibling-index)))))) | |
2703 | ) | |
2704 | ) | |
9179616f DL |
2705 | ;;;_ > outline-open-topic (relative-depth &optional before use_sib_bullet) |
2706 | (defun outline-open-topic (relative-depth &optional before use_sib_bullet) | |
19b84ba3 RS |
2707 | "Open a new topic at depth DEPTH. |
2708 | ||
2709 | New topic is situated after current one, unless optional flag BEFORE | |
2710 | is non-nil, or unless current line is complete empty (not even | |
2711 | whitespace), in which case open is done on current line. | |
c567ac01 | 2712 | |
9179616f DL |
2713 | If USE_SIB_BULLET is true, use the bullet of the prior sibling. |
2714 | ||
c567ac01 RS |
2715 | Nuances: |
2716 | ||
2717 | - Creation of new topics is with respect to the visible topic | |
2718 | containing the cursor, regardless of intervening concealed ones. | |
2719 | ||
2720 | - New headers are generally created after/before the body of a | |
2721 | topic. However, they are created right at cursor location if the | |
2722 | cursor is on a blank line, even if that breaks the current topic | |
2723 | body. This is intentional, to provide a simple means for | |
2724 | deliberately dividing topic bodies. | |
2725 | ||
2726 | - Double spacing of topic lists is preserved. Also, the first | |
2727 | level two topic is created double-spaced (and so would be | |
2728 | subsequent siblings, if that's left intact). Otherwise, | |
2729 | single-spacing is used. | |
2730 | ||
2731 | - Creation of sibling or nested topics is with respect to the topic | |
2732 | you're starting from, even when creating backwards. This way you | |
2733 | can easily create a sibling in front of the current topic without | |
a0776d6b | 2734 | having to go to its preceding sibling, and then open forward |
c567ac01 | 2735 | from there." |
1977b8f6 RS |
2736 | |
2737 | (let* ((depth (+ (outline-current-depth) relative-depth)) | |
2738 | (opening-on-blank (if (looking-at "^\$") | |
2739 | (not (setq before nil)))) | |
2740 | opening-numbered ; Will get while computing ref-topic, below | |
9179616f DL |
2741 | ref-depth ; Will get while computing ref-topic, below |
2742 | ref-bullet ; Will get while computing ref-topic, next | |
1977b8f6 RS |
2743 | (ref-topic (save-excursion |
2744 | (cond ((< relative-depth 0) | |
2745 | (outline-ascend-to-depth depth)) | |
2746 | ((>= relative-depth 1) nil) | |
2747 | (t (outline-back-to-current-heading))) | |
2748 | (setq ref-depth (outline-recent-depth)) | |
9179616f DL |
2749 | (setq ref-bullet |
2750 | (if (> outline-recent-prefix-end 1) | |
2751 | (outline-recent-bullet) | |
2752 | "")) | |
1977b8f6 RS |
2753 | (setq opening-numbered |
2754 | (save-excursion | |
2755 | (and outline-numbered-bullet | |
2756 | (or (<= relative-depth 0) | |
2757 | (outline-descend-to-depth depth)) | |
2758 | (if (outline-numbered-type-prefix) | |
2759 | outline-numbered-bullet)))) | |
2760 | (point))) | |
2761 | dbl-space | |
c567ac01 | 2762 | doing-beginning) |
1977b8f6 RS |
2763 | |
2764 | (if (not opening-on-blank) | |
2765 | ; Positioning and vertical | |
2766 | ; padding - only if not | |
2767 | ; opening-on-blank: | |
353e2ef2 | 2768 | (progn |
1977b8f6 RS |
2769 | (goto-char ref-topic) |
2770 | (setq dbl-space ; Determine double space action: | |
c567ac01 RS |
2771 | (or (and (<= relative-depth 0) ; not descending; |
2772 | (save-excursion | |
a0776d6b | 2773 | ;; at b-o-b or preceded by a blank line? |
c567ac01 RS |
2774 | (or (> 0 (forward-line -1)) |
2775 | (looking-at "^\\s-*$") | |
2776 | (bobp))) | |
1977b8f6 | 2777 | (save-excursion |
c567ac01 RS |
2778 | ;; succeeded by a blank line? |
2779 | (outline-end-of-current-subtree) | |
2780 | (bolp))) | |
1977b8f6 RS |
2781 | (and (= ref-depth 1) |
2782 | (or before | |
2783 | (= depth 1) | |
2784 | (save-excursion | |
2785 | ;; Don't already have following | |
2786 | ;; vertical padding: | |
2787 | (not (outline-pre-next-preface))))))) | |
2788 | ||
2789 | ; Position to prior heading, | |
c567ac01 RS |
2790 | ; if inserting backwards, and |
2791 | ; not going outwards: | |
2792 | (if (and before (>= relative-depth 0)) | |
2793 | (progn (outline-back-to-current-heading) | |
1977b8f6 | 2794 | (setq doing-beginning (bobp)) |
c567ac01 RS |
2795 | (if (not (bobp)) |
2796 | (outline-previous-heading))) | |
2797 | (if (and before (bobp)) | |
2798 | (outline-unprotected (open-line 1)))) | |
1977b8f6 | 2799 | |
c567ac01 | 2800 | (if (<= relative-depth 0) |
1977b8f6 RS |
2801 | ;; Not going inwards, don't snug up: |
2802 | (if doing-beginning | |
c567ac01 RS |
2803 | (outline-unprotected (open-line (if dbl-space 2 1))) |
2804 | (if before | |
2805 | (progn (end-of-line) | |
2806 | (outline-pre-next-preface) | |
2807 | (while (= ?\r (following-char)) | |
2808 | (forward-char 1)) | |
2809 | (if (not (looking-at "^$")) | |
2810 | (outline-unprotected (open-line 1)))) | |
2811 | (outline-end-of-current-subtree))) | |
1977b8f6 RS |
2812 | ;; Going inwards - double-space if first offspring is, |
2813 | ;; otherwise snug up. | |
2814 | (end-of-line) ; So we skip any concealed progeny. | |
2815 | (outline-pre-next-preface) | |
2816 | (if (bolp) | |
2817 | ;; Blank lines between current header body and next | |
2818 | ;; header - get to last substantive (non-white-space) | |
2819 | ;; line in body: | |
2820 | (re-search-backward "[^ \t\n]" nil t)) | |
2821 | (if (save-excursion | |
2822 | (outline-next-heading) | |
2823 | (if (> (outline-recent-depth) ref-depth) | |
2824 | ;; This is an offspring. | |
2825 | (progn (forward-line -1) | |
2826 | (looking-at "^\\s-*$")))) | |
2827 | (progn (forward-line 1) | |
c567ac01 | 2828 | (outline-unprotected (open-line 1)))) |
1977b8f6 RS |
2829 | (end-of-line)) |
2830 | ;;(if doing-beginning (goto-char doing-beginning)) | |
c567ac01 RS |
2831 | (if (not (bobp)) |
2832 | (progn (if (and (not (> depth ref-depth)) | |
2833 | (not before)) | |
2834 | (outline-unprotected (open-line 1)) | |
2835 | (if (> depth ref-depth) | |
2836 | (outline-unprotected (newline 1)) | |
2837 | (if dbl-space | |
2838 | (outline-unprotected (open-line 1)) | |
2839 | (if (not before) | |
2840 | (outline-unprotected (newline 1)))))) | |
2841 | (if dbl-space | |
2842 | (outline-unprotected (newline 1))) | |
2843 | (if (and (not (eobp)) | |
2844 | (not (bolp))) | |
2845 | (forward-char 1)))) | |
1977b8f6 | 2846 | )) |
eac9cf5f PJ |
2847 | (insert (concat (outline-make-topic-prefix opening-numbered |
2848 | t | |
2849 | depth) | |
2850 | " ")) | |
1977b8f6 RS |
2851 | |
2852 | ;;(if doing-beginning (save-excursion (newline (if dbl-space 2 1)))) | |
2853 | ||
2854 | ||
9179616f DL |
2855 | (outline-rebullet-heading (and use_sib_bullet ref-bullet);;; solicit |
2856 | depth ;;; depth | |
2857 | nil ;;; number-control | |
2858 | nil ;;; index | |
1977b8f6 RS |
2859 | t) (end-of-line) |
2860 | ) | |
2861 | ) | |
c567ac01 RS |
2862 | ;;;_ . open-topic contingencies |
2863 | ;;;_ ; base topic - one from which open was issued | |
2864 | ;;;_ , beginning char | |
a0776d6b | 2865 | ;;;_ , amount of space before will be used, unless opening in place |
c567ac01 RS |
2866 | ;;;_ , end char will be used, unless opening before (and it still may) |
2867 | ;;;_ ; absolute depth of new topic | |
2868 | ;;;_ ! insert in place - overrides most stuff | |
2869 | ;;;_ ; relative depth of new re base | |
2870 | ;;;_ ; before or after base topic | |
2871 | ;;;_ ; spacing around topic, if any, prior to new topic and at same depth | |
2872 | ;;;_ ; buffer boundaries - special provisions for beginning and end ob | |
2873 | ;;;_ ; level 1 topics have special provisions also - double space. | |
2874 | ;;;_ ; location of new topic | |
c567ac01 RS |
2875 | ;;;_ > outline-open-subtopic (arg) |
2876 | (defun outline-open-subtopic (arg) | |
2877 | "Open new topic header at deeper level than the current one. | |
2878 | ||
2879 | Negative universal arg means to open deeper, but place the new topic | |
2880 | prior to the current one." | |
1977b8f6 | 2881 | (interactive "p") |
c567ac01 RS |
2882 | (outline-open-topic 1 (> 0 arg))) |
2883 | ;;;_ > outline-open-sibtopic (arg) | |
2884 | (defun outline-open-sibtopic (arg) | |
19b84ba3 RS |
2885 | "Open new topic header at same level as the current one. |
2886 | ||
9179616f DL |
2887 | Positive universal arg means to use the bullet of the prior sibling. |
2888 | ||
19b84ba3 | 2889 | Negative universal arg means to place the new topic prior to the current |
c567ac01 | 2890 | one." |
1977b8f6 | 2891 | (interactive "p") |
9179616f | 2892 | (outline-open-topic 0 (> 0 arg) (< 1 arg))) |
c567ac01 RS |
2893 | ;;;_ > outline-open-supertopic (arg) |
2894 | (defun outline-open-supertopic (arg) | |
2895 | "Open new topic header at shallower level than the current one. | |
19b84ba3 | 2896 | |
c567ac01 RS |
2897 | Negative universal arg means to open shallower, but place the new |
2898 | topic prior to the current one." | |
1977b8f6 RS |
2899 | |
2900 | (interactive "p") | |
c567ac01 RS |
2901 | (outline-open-topic -1 (> 0 arg))) |
2902 | ||
2903 | ;;;_ - Outline Alteration | |
2904 | ;;;_ : Topic Modification | |
2905 | ;;;_ = outline-former-auto-filler | |
2906 | (defvar outline-former-auto-filler nil | |
2907 | "Name of modal fill function being wrapped by outline-auto-fill.") | |
2908 | ;;;_ > outline-auto-fill () | |
2909 | (defun outline-auto-fill () | |
19b84ba3 RS |
2910 | "Outline-mode autofill function. |
2911 | ||
2912 | Maintains outline hanging topic indentation if | |
2913 | `outline-use-hanging-indents' is set." | |
c567ac01 RS |
2914 | (let ((fill-prefix (if outline-use-hanging-indents |
2915 | ;; Check for topic header indentation: | |
2916 | (save-excursion | |
2917 | (beginning-of-line) | |
2918 | (if (looking-at outline-regexp) | |
2919 | ;; ... construct indentation to account for | |
2920 | ;; length of topic prefix: | |
2921 | (make-string (progn (outline-end-of-prefix) | |
2922 | (current-column)) | |
2923 | ?\ )))))) | |
2924 | (if (or outline-former-auto-filler outline-use-hanging-indents) | |
2925 | (do-auto-fill)))) | |
2926 | ;;;_ > outline-reindent-body (old-depth new-depth &optional number) | |
2927 | (defun outline-reindent-body (old-depth new-depth &optional number) | |
2928 | "Reindent body lines which were indented at old-depth to new-depth. | |
2929 | ||
2930 | Optional arg NUMBER indicates numbering is being added, and it must | |
a0776d6b | 2931 | be accommodated. |
c567ac01 RS |
2932 | |
2933 | Note that refill of indented paragraphs is not done." | |
1977b8f6 RS |
2934 | |
2935 | (save-excursion | |
c567ac01 RS |
2936 | (outline-end-of-prefix) |
2937 | (let* ((new-margin (current-column)) | |
2938 | excess old-indent-begin old-indent-end | |
2939 | curr-ind | |
2940 | ;; We want the column where the header-prefix text started | |
2941 | ;; *before* the prefix was changed, so we infer it relative | |
2942 | ;; to the new margin and the shift in depth: | |
2943 | (old-margin (+ old-depth (- new-margin new-depth)))) | |
353e2ef2 | 2944 | |
c567ac01 RS |
2945 | ;; Process lines up to (but excluding) next topic header: |
2946 | (outline-unprotected | |
2947 | (save-match-data | |
2948 | (while | |
2949 | (and (re-search-forward "[\n\r]\\(\\s-*\\)" | |
2950 | nil | |
2951 | t) | |
2952 | ;; Register the indent data, before we reset the | |
353e2ef2 | 2953 | ;; match data with a subsequent `looking-at': |
c567ac01 RS |
2954 | (setq old-indent-begin (match-beginning 1) |
2955 | old-indent-end (match-end 1)) | |
2956 | (not (looking-at outline-regexp))) | |
2957 | (if (> 0 (setq excess (- (current-column) | |
2958 | old-margin))) | |
2959 | ;; Text starts left of old margin - don't adjust: | |
2960 | nil | |
2961 | ;; Text was hanging at or right of old left margin - | |
2962 | ;; reindent it, preserving its existing indentation | |
2963 | ;; beyond the old margin: | |
2964 | (delete-region old-indent-begin old-indent-end) | |
2965 | (indent-to (+ new-margin excess))))))))) | |
2966 | ;;;_ > outline-rebullet-current-heading (arg) | |
1977b8f6 | 2967 | (defun outline-rebullet-current-heading (arg) |
9179616f DL |
2968 | "Solicit new bullet for current visible heading." |
2969 | (interactive "p") | |
2970 | (let ((initial-col (current-column)) | |
2971 | (on-bullet (eq (point)(outline-current-bullet-pos))) | |
2972 | (backwards (if (< arg 0) | |
2973 | (setq arg (* arg -1))))) | |
2974 | (while (> arg 0) | |
2975 | (save-excursion (outline-back-to-current-heading) | |
2976 | (outline-end-of-prefix) | |
2977 | (outline-rebullet-heading t ;;; solicit | |
2978 | nil ;;; depth | |
2979 | nil ;;; number-control | |
2980 | nil ;;; index | |
2981 | t)) ;;; do-successors | |
2982 | (setq arg (1- arg)) | |
2983 | (if (<= arg 0) | |
2984 | nil | |
2985 | (setq initial-col nil) ; Override positioning back to init col | |
2986 | (if (not backwards) | |
2987 | (outline-next-visible-heading 1) | |
2988 | (outline-goto-prefix) | |
2989 | (outline-next-visible-heading -1)))) | |
2990 | (message "Done.") | |
2991 | (cond (on-bullet (goto-char (outline-current-bullet-pos))) | |
2992 | (initial-col (move-to-column initial-col))))) | |
c567ac01 | 2993 | ;;;_ > outline-rebullet-heading (&optional solicit ...) |
1977b8f6 RS |
2994 | (defun outline-rebullet-heading (&optional solicit |
2995 | new-depth | |
2996 | number-control | |
2997 | index | |
2998 | do-successors) | |
2999 | ||
c567ac01 | 3000 | "Adjust bullet of current topic prefix. |
1977b8f6 | 3001 | |
c567ac01 | 3002 | All args are optional. |
1977b8f6 | 3003 | |
9179616f DL |
3004 | If SOLICIT is non-nil, then the choice of bullet is solicited from |
3005 | user. If it's a character, then that character is offered as the | |
3006 | default, otherwise the one suited to the context \(according to | |
3007 | distinction or depth) is offered. If non-nil, then the | |
3008 | context-specific bullet is just used. | |
1977b8f6 | 3009 | |
c567ac01 | 3010 | Second arg DEPTH forces the topic prefix to that depth, regardless |
9179616f | 3011 | of the topic's current depth. |
1977b8f6 | 3012 | |
c567ac01 | 3013 | Third arg NUMBER-CONTROL can force the prefix to or away from |
353e2ef2 | 3014 | numbered form. It has effect only if `outline-numbered-bullet' is |
c567ac01 RS |
3015 | non-nil and soliciting was not explicitly invoked (via first arg). |
3016 | Its effect, numbering or denumbering, then depends on the setting | |
3017 | of the forth arg, INDEX. | |
1977b8f6 | 3018 | |
c567ac01 RS |
3019 | If NUMBER-CONTROL is non-nil and forth arg INDEX is nil, then the |
3020 | prefix of the topic is forced to be non-numbered. Null index and | |
3021 | non-nil NUMBER-CONTROL forces denumbering. Non-nil INDEX (and | |
3022 | non-nil NUMBER-CONTROL) forces a numbered-prefix form. If non-nil | |
3023 | INDEX is a number, then that number is used for the numbered | |
3024 | prefix. Non-nil and non-number means that the index for the | |
3025 | numbered prefix will be derived by outline-make-topic-prefix. | |
1977b8f6 | 3026 | |
c567ac01 RS |
3027 | Fifth arg DO-SUCCESSORS t means re-resolve count on succeeding |
3028 | siblings. | |
1977b8f6 | 3029 | |
353e2ef2 KH |
3030 | Cf vars `outline-stylish-prefixes', `outline-old-style-prefixes', |
3031 | and `outline-numbered-bullet', which all affect the behavior of | |
c567ac01 | 3032 | this function." |
1977b8f6 RS |
3033 | |
3034 | (let* ((current-depth (outline-depth)) | |
3035 | (new-depth (or new-depth current-depth)) | |
3036 | (mb outline-recent-prefix-beginning) | |
3037 | (me outline-recent-prefix-end) | |
3038 | (current-bullet (buffer-substring (- me 1) me)) | |
3039 | (new-prefix (outline-make-topic-prefix current-bullet | |
3040 | nil | |
3041 | new-depth | |
3042 | solicit | |
3043 | number-control | |
3044 | index))) | |
3045 | ||
c567ac01 | 3046 | ;; Is new one is identical to old? |
1977b8f6 RS |
3047 | (if (and (= current-depth new-depth) |
3048 | (string= current-bullet | |
3049 | (substring new-prefix (1- (length new-prefix))))) | |
c567ac01 | 3050 | ;; Nothing to do: |
1977b8f6 RS |
3051 | t |
3052 | ||
3053 | ;; New prefix probably different from old: | |
c567ac01 RS |
3054 | ; get rid of old one: |
3055 | (outline-unprotected (delete-region mb me)) | |
1977b8f6 | 3056 | (goto-char mb) |
c567ac01 RS |
3057 | ; Dispense with number if |
3058 | ; numbered-bullet prefix: | |
1977b8f6 RS |
3059 | (if (and outline-numbered-bullet |
3060 | (string= outline-numbered-bullet current-bullet) | |
3061 | (looking-at "[0-9]+")) | |
c567ac01 RS |
3062 | (outline-unprotected |
3063 | (delete-region (match-beginning 0)(match-end 0)))) | |
1977b8f6 | 3064 | |
c567ac01 | 3065 | ; Put in new prefix: |
eac9cf5f | 3066 | (outline-unprotected (insert new-prefix)) |
1977b8f6 | 3067 | |
c567ac01 RS |
3068 | ;; Reindent the body if elected and margin changed: |
3069 | (if (and outline-reindent-bodies | |
3070 | (not (= new-depth current-depth))) | |
3071 | (outline-reindent-body current-depth new-depth)) | |
1977b8f6 | 3072 | |
c567ac01 RS |
3073 | ;; Recursively rectify successive siblings of orig topic if |
3074 | ;; caller elected for it: | |
3075 | (if do-successors | |
3076 | (save-excursion | |
3077 | (while (outline-next-sibling new-depth nil) | |
3078 | (setq index | |
3079 | (cond ((numberp index) (1+ index)) | |
3080 | ((not number-control) (outline-sibling-index)))) | |
3081 | (if (outline-numbered-type-prefix) | |
3082 | (outline-rebullet-heading nil ;;; solicit | |
3083 | new-depth ;;; new-depth | |
3084 | number-control;;; number-control | |
3085 | index ;;; index | |
3086 | nil))))) ;;;(dont!)do-successors | |
3087 | ) ; (if (and (= current-depth new-depth)...)) | |
3088 | ) ; let* ((current-depth (outline-depth))...) | |
3089 | ) ; defun | |
3090 | ;;;_ > outline-rebullet-topic (arg) | |
1977b8f6 | 3091 | (defun outline-rebullet-topic (arg) |
c567ac01 | 3092 | "Like outline-rebullet-topic-grunt, but start from topic visible at point. |
19b84ba3 | 3093 | |
c567ac01 | 3094 | Descends into invisible as well as visible topics, however. |
1977b8f6 | 3095 | |
c567ac01 | 3096 | With repeat count, shift topic depth by that amount." |
1977b8f6 RS |
3097 | (interactive "P") |
3098 | (let ((start-col (current-column)) | |
3099 | (was-eol (eolp))) | |
3100 | (save-excursion | |
3101 | ;; Normalize arg: | |
3102 | (cond ((null arg) (setq arg 0)) | |
3103 | ((listp arg) (setq arg (car arg)))) | |
3104 | ;; Fill the user in, in case we're shifting a big topic: | |
3105 | (if (not (zerop arg)) (message "Shifting...")) | |
3106 | (outline-back-to-current-heading) | |
3107 | (if (<= (+ (outline-recent-depth) arg) 0) | |
3108 | (error "Attempt to shift topic below level 1")) | |
3109 | (outline-rebullet-topic-grunt arg) | |
3110 | (if (not (zerop arg)) (message "Shifting... done."))) | |
c567ac01 RS |
3111 | (move-to-column (max 0 (+ start-col arg))))) |
3112 | ;;;_ > outline-rebullet-topic-grunt (&optional relative-depth ...) | |
1977b8f6 RS |
3113 | (defun outline-rebullet-topic-grunt (&optional relative-depth |
3114 | starting-depth | |
3115 | starting-point | |
3116 | index | |
3117 | do-successors) | |
3118 | ||
c567ac01 RS |
3119 | "Rebullet the topic at point, visible or invisible, and all |
3120 | contained subtopics. See outline-rebullet-heading for rebulleting | |
3121 | behavior. | |
1977b8f6 | 3122 | |
c567ac01 | 3123 | All arguments are optional. |
1977b8f6 | 3124 | |
c567ac01 RS |
3125 | First arg RELATIVE-DEPTH means to shift the depth of the entire |
3126 | topic that amount. | |
1977b8f6 | 3127 | |
c567ac01 RS |
3128 | The rest of the args are for internal recursive use by the function |
3129 | itself. The are STARTING-DEPTH, STARTING-POINT, and INDEX." | |
1977b8f6 RS |
3130 | |
3131 | (let* ((relative-depth (or relative-depth 0)) | |
3132 | (new-depth (outline-depth)) | |
3133 | (starting-depth (or starting-depth new-depth)) | |
3134 | (on-starting-call (null starting-point)) | |
3135 | (index (or index | |
3136 | ;; Leave index null on starting call, so rebullet-heading | |
3137 | ;; calculates it at what might be new depth: | |
3138 | (and (or (zerop relative-depth) | |
3139 | (not on-starting-call)) | |
3140 | (outline-sibling-index)))) | |
3141 | (moving-outwards (< 0 relative-depth)) | |
3142 | (starting-point (or starting-point (point)))) | |
3143 | ||
3144 | ;; Sanity check for excessive promotion done only on starting call: | |
3145 | (and on-starting-call | |
3146 | moving-outwards | |
3147 | (> 0 (+ starting-depth relative-depth)) | |
6a05d05f | 3148 | (error "Attempt to shift topic out beyond level 1")) ;;; ====> |
1977b8f6 RS |
3149 | |
3150 | (cond ((= starting-depth new-depth) | |
3151 | ;; We're at depth to work on this one: | |
3152 | (outline-rebullet-heading nil ;;; solicit | |
3153 | (+ starting-depth ;;; starting-depth | |
3154 | relative-depth) | |
3155 | nil ;;; number | |
3156 | index ;;; index | |
3157 | ;; Every contained topic will get hit, | |
3158 | ;; and we have to get to outside ones | |
3159 | ;; deliberately: | |
3160 | nil) ;;; do-successors | |
3161 | ;; ... and work on subsequent ones which are at greater depth: | |
3162 | (setq index 0) | |
3163 | (outline-next-heading) | |
3164 | (while (and (not (eobp)) | |
3165 | (< starting-depth (outline-recent-depth))) | |
3166 | (setq index (1+ index)) | |
3167 | (outline-rebullet-topic-grunt relative-depth ;;; relative-depth | |
3168 | (1+ starting-depth);;;starting-depth | |
3169 | starting-point ;;; starting-point | |
3170 | index))) ;;; index | |
3171 | ||
3172 | ((< starting-depth new-depth) | |
3173 | ;; Rare case - subtopic more than one level deeper than parent. | |
3174 | ;; Treat this one at an even deeper level: | |
3175 | (outline-rebullet-topic-grunt relative-depth ;;; relative-depth | |
3176 | new-depth ;;; starting-depth | |
3177 | starting-point ;;; starting-point | |
3178 | index))) ;;; index | |
3179 | ||
3180 | (if on-starting-call | |
3181 | (progn | |
3182 | ;; Rectify numbering of former siblings of the adjusted topic, | |
3183 | ;; if topic has changed depth | |
3184 | (if (or do-successors | |
3185 | (and (not (zerop relative-depth)) | |
3186 | (or (= (outline-recent-depth) starting-depth) | |
3187 | (= (outline-recent-depth) (+ starting-depth | |
3188 | relative-depth))))) | |
3189 | (outline-rebullet-heading nil nil nil nil t)) | |
3190 | ;; Now rectify numbering of new siblings of the adjusted topic, | |
3191 | ;; if depth has been changed: | |
3192 | (progn (goto-char starting-point) | |
3193 | (if (not (zerop relative-depth)) | |
3194 | (outline-rebullet-heading nil nil nil nil t))))) | |
3195 | ) | |
3196 | ) | |
c567ac01 RS |
3197 | ;;;_ > outline-renumber-to-depth (&optional depth) |
3198 | (defun outline-renumber-to-depth (&optional depth) | |
19b84ba3 RS |
3199 | "Renumber siblings at current depth. |
3200 | ||
3201 | Affects superior topics if optional arg DEPTH is less than current depth. | |
c567ac01 RS |
3202 | |
3203 | Returns final depth." | |
3204 | ||
3205 | ;; Proceed by level, processing subsequent siblings on each, | |
3206 | ;; ascending until we get shallower than the start depth: | |
3207 | ||
9179616f DL |
3208 | (let ((ascender (outline-depth)) |
3209 | was-eobp) | |
c567ac01 RS |
3210 | (while (and (not (eobp)) |
3211 | (outline-depth) | |
3212 | (>= (outline-recent-depth) depth) | |
3213 | (>= ascender depth)) | |
3214 | ; Skip over all topics at | |
3215 | ; lesser depths, which can not | |
3216 | ; have been disturbed: | |
9179616f | 3217 | (while (and (not (setq was-eobp (eobp))) |
c567ac01 RS |
3218 | (> (outline-recent-depth) ascender)) |
3219 | (outline-next-heading)) | |
3220 | ; Prime ascender for ascension: | |
3221 | (setq ascender (1- (outline-recent-depth))) | |
3222 | (if (>= (outline-recent-depth) depth) | |
3223 | (outline-rebullet-heading nil ;;; solicit | |
3224 | nil ;;; depth | |
3225 | nil ;;; number-control | |
3226 | nil ;;; index | |
9179616f DL |
3227 | t)) ;;; do-successors |
3228 | (if was-eobp (goto-char (point-max))))) | |
c567ac01 RS |
3229 | (outline-recent-depth)) |
3230 | ;;;_ > outline-number-siblings (&optional denumber) | |
1977b8f6 | 3231 | (defun outline-number-siblings (&optional denumber) |
c567ac01 | 3232 | "Assign numbered topic prefix to this topic and its siblings. |
1977b8f6 | 3233 | |
c567ac01 RS |
3234 | With universal argument, denumber - assign default bullet to this |
3235 | topic and its siblings. | |
1977b8f6 | 3236 | |
c567ac01 RS |
3237 | With repeated universal argument (`^U^U'), solicit bullet for each |
3238 | rebulleting each topic at this level." | |
1977b8f6 RS |
3239 | |
3240 | (interactive "P") | |
3241 | ||
3242 | (save-excursion | |
3243 | (outline-back-to-current-heading) | |
3244 | (outline-beginning-of-level) | |
c567ac01 RS |
3245 | (let ((depth (outline-recent-depth)) |
3246 | (index (if (not denumber) 1)) | |
1977b8f6 RS |
3247 | (use-bullet (equal '(16) denumber)) |
3248 | (more t)) | |
3249 | (while more | |
3250 | (outline-rebullet-heading use-bullet ;;; solicit | |
c567ac01 | 3251 | depth ;;; depth |
1977b8f6 RS |
3252 | t ;;; number-control |
3253 | index ;;; index | |
3254 | nil) ;;; do-successors | |
3255 | (if index (setq index (1+ index))) | |
c567ac01 RS |
3256 | (setq more (outline-next-sibling depth nil)))))) |
3257 | ;;;_ > outline-shift-in (arg) | |
1977b8f6 | 3258 | (defun outline-shift-in (arg) |
19b84ba3 | 3259 | "Increase depth of current heading and any topics collapsed within it." |
1977b8f6 RS |
3260 | (interactive "p") |
3261 | (outline-rebullet-topic arg)) | |
c567ac01 | 3262 | ;;;_ > outline-shift-out (arg) |
1977b8f6 | 3263 | (defun outline-shift-out (arg) |
19b84ba3 | 3264 | "Decrease depth of current heading and any topics collapsed within it." |
1977b8f6 RS |
3265 | (interactive "p") |
3266 | (outline-rebullet-topic (* arg -1))) | |
c567ac01 RS |
3267 | ;;;_ : Surgery (kill-ring) functions with special provisions for outlines: |
3268 | ;;;_ > outline-kill-line (&optional arg) | |
1977b8f6 | 3269 | (defun outline-kill-line (&optional arg) |
c567ac01 | 3270 | "Kill line, adjusting subsequent lines suitably for outline mode." |
1977b8f6 RS |
3271 | |
3272 | (interactive "*P") | |
c567ac01 RS |
3273 | (if (not (and (outline-mode-p) ; active outline mode, |
3274 | outline-numbered-bullet ; numbers may need adjustment, | |
3275 | (bolp) ; may be clipping topic head, | |
3276 | (looking-at outline-regexp))) ; are clipping topic head. | |
1977b8f6 RS |
3277 | ;; Above conditions do not obtain - just do a regular kill: |
3278 | (kill-line arg) | |
3279 | ;; Ah, have to watch out for adjustments: | |
c567ac01 RS |
3280 | (let* ((depth (outline-depth))) |
3281 | ; Do the kill: | |
1977b8f6 | 3282 | (kill-line arg) |
c567ac01 | 3283 | ; Provide some feedback: |
1977b8f6 RS |
3284 | (sit-for 0) |
3285 | (save-excursion | |
c567ac01 RS |
3286 | ; Start with the topic |
3287 | ; following killed line: | |
1977b8f6 RS |
3288 | (if (not (looking-at outline-regexp)) |
3289 | (outline-next-heading)) | |
c567ac01 RS |
3290 | (outline-renumber-to-depth depth))))) |
3291 | ;;;_ > outline-kill-topic () | |
1977b8f6 | 3292 | (defun outline-kill-topic () |
c567ac01 RS |
3293 | "Kill topic together with subtopics. |
3294 | ||
3295 | Leaves primary topic's trailing vertical whitespace, if any." | |
1977b8f6 RS |
3296 | |
3297 | ;; Some finagling is done to make complex topic kills appear faster | |
3298 | ;; than they actually are. A redisplay is performed immediately | |
3299 | ;; after the region is disposed of, though the renumbering process | |
3300 | ;; has yet to be performed. This means that there may appear to be | |
3301 | ;; a lag *after* the kill has been performed. | |
3302 | ||
3303 | (interactive) | |
c567ac01 | 3304 | (let* ((beg (prog1 (outline-back-to-current-heading)(beginning-of-line))) |
1977b8f6 RS |
3305 | (depth (outline-recent-depth))) |
3306 | (outline-end-of-current-subtree) | |
3307 | (if (not (eobp)) | |
c567ac01 RS |
3308 | (if (or (not (looking-at "^$")) |
3309 | ;; A blank line - cut it with this topic *unless* this | |
3310 | ;; is the last topic at this level, in which case | |
3311 | ;; we'll leave the blank line as part of the | |
3312 | ;; containing topic: | |
3313 | (save-excursion | |
3314 | (and (outline-next-heading) | |
3315 | (>= (outline-recent-depth) depth)))) | |
3316 | (forward-char 1))) | |
353e2ef2 | 3317 | |
1977b8f6 RS |
3318 | (kill-region beg (point)) |
3319 | (sit-for 0) | |
3320 | (save-excursion | |
c567ac01 RS |
3321 | (outline-renumber-to-depth depth)))) |
3322 | ;;;_ > outline-yank-processing () | |
3323 | (defun outline-yank-processing (&optional arg) | |
3324 | ||
3325 | "Incidental outline-specific business to be done just after text yanks. | |
19b84ba3 | 3326 | |
c567ac01 | 3327 | Does depth adjustment of yanked topics, when: |
1977b8f6 | 3328 | |
c567ac01 RS |
3329 | 1 the stuff being yanked starts with a valid outline header prefix, and |
3330 | 2 it is being yanked at the end of a line which consists of only a valid | |
1977b8f6 RS |
3331 | topic prefix. |
3332 | ||
a0776d6b | 3333 | Also, adjusts numbering of subsequent siblings when appropriate. |
1977b8f6 | 3334 | |
c567ac01 RS |
3335 | Depth adjustment alters the depth of all the topics being yanked |
3336 | the amount it takes to make the first topic have the depth of the | |
3337 | header into which it's being yanked. | |
1977b8f6 | 3338 | |
c567ac01 RS |
3339 | The point is left in front of yanked, adjusted topics, rather than |
3340 | at the end (and vice-versa with the mark). Non-adjusted yanks, | |
3341 | however, are left exactly like normal, non-outline-specific yanks." | |
3342 | ||
3343 | (interactive "*P") | |
3344 | ; Get to beginning, leaving | |
3345 | ; region around subject: | |
9179616f | 3346 | (if (< (my-mark-marker t) (point)) |
c567ac01 RS |
3347 | (exchange-point-and-mark)) |
3348 | (let* ((subj-beg (point)) | |
9179616f DL |
3349 | (subj-end (my-mark-marker t)) |
3350 | ;; 'resituate' if yanking an entire topic into topic header: | |
c567ac01 RS |
3351 | (resituate (and (outline-e-o-prefix-p) |
3352 | (looking-at (concat "\\(" outline-regexp "\\)")) | |
3353 | (outline-prefix-data (match-beginning 1) | |
3354 | (match-end 1)))) | |
353e2ef2 | 3355 | ;; `rectify-numbering' if resituating (where several topics may |
c567ac01 RS |
3356 | ;; be resituating) or yanking a topic into a topic slot (bol): |
3357 | (rectify-numbering (or resituate | |
3358 | (and (bolp) (looking-at outline-regexp))))) | |
3359 | (if resituate | |
3360 | ; The yanked stuff is a topic: | |
3361 | (let* ((prefix-len (- (match-end 1) subj-beg)) | |
3362 | (subj-depth (outline-recent-depth)) | |
3363 | (prefix-bullet (outline-recent-bullet)) | |
3364 | (adjust-to-depth | |
3365 | ;; Nil if adjustment unnecessary, otherwise depth to which | |
3366 | ;; adjustment should be made: | |
3367 | (save-excursion | |
3368 | (and (goto-char subj-end) | |
3369 | (eolp) | |
3370 | (goto-char subj-beg) | |
3371 | (and (looking-at outline-regexp) | |
3372 | (progn | |
3373 | (beginning-of-line) | |
3374 | (not (= (point) subj-beg))) | |
3375 | (looking-at outline-regexp) | |
3376 | (outline-prefix-data (match-beginning 0) | |
3377 | (match-end 0))) | |
3378 | (outline-recent-depth)))) | |
3379 | done | |
3380 | (more t)) | |
3381 | (setq rectify-numbering outline-numbered-bullet) | |
3382 | (if adjust-to-depth | |
3383 | ; Do the adjustment: | |
3384 | (progn | |
3385 | (message "... yanking") (sit-for 0) | |
3386 | (save-restriction | |
3387 | (narrow-to-region subj-beg subj-end) | |
3388 | ; Trim off excessive blank | |
3389 | ; line at end, if any: | |
3390 | (goto-char (point-max)) | |
3391 | (if (looking-at "^$") | |
3392 | (outline-unprotected (delete-char -1))) | |
3393 | ; Work backwards, with each | |
3394 | ; shallowest level, | |
3395 | ; successively excluding the | |
3396 | ; last processed topic from | |
3397 | ; the narrow region: | |
3398 | (while more | |
3399 | (outline-back-to-current-heading) | |
3400 | ; go as high as we can in each bunch: | |
3401 | (while (outline-ascend-to-depth (1- (outline-depth)))) | |
3402 | (save-excursion | |
3403 | (outline-rebullet-topic-grunt (- adjust-to-depth | |
3404 | subj-depth)) | |
3405 | (outline-depth)) | |
3406 | (if (setq more (not (bobp))) | |
3407 | (progn (widen) | |
3408 | (forward-char -1) | |
3409 | (narrow-to-region subj-beg (point)))))) | |
3410 | (message "") | |
3411 | ;; Preserve new bullet if it's a distinctive one, otherwise | |
3412 | ;; use old one: | |
3413 | (if (string-match (regexp-quote prefix-bullet) | |
3414 | outline-distinctive-bullets-string) | |
3415 | ; Delete from bullet of old to | |
3416 | ; before bullet of new: | |
3417 | (progn | |
3418 | (beginning-of-line) | |
3419 | (delete-region (point) subj-beg) | |
9179616f | 3420 | (set-marker (my-mark-marker t) subj-end) |
c567ac01 RS |
3421 | (goto-char subj-beg) |
3422 | (outline-end-of-prefix)) | |
3423 | ; Delete base subj prefix, | |
3424 | ; leaving old one: | |
3425 | (delete-region (point) (+ (point) | |
3426 | prefix-len | |
3427 | (- adjust-to-depth subj-depth))) | |
3428 | ; and delete residual subj | |
3429 | ; prefix digits and space: | |
3430 | (while (looking-at "[0-9]") (delete-char 1)) | |
3431 | (if (looking-at " ") (delete-char 1)))) | |
3432 | (exchange-point-and-mark)))) | |
3433 | (if rectify-numbering | |
353e2ef2 | 3434 | (progn |
c567ac01 RS |
3435 | (save-excursion |
3436 | ; Give some preliminary feedback: | |
3437 | (message "... reconciling numbers") (sit-for 0) | |
3438 | ; ... and renumber, in case necessary: | |
3439 | (goto-char subj-beg) | |
3440 | (if (outline-goto-prefix) | |
3441 | (outline-rebullet-heading nil ;;; solicit | |
3442 | (outline-depth) ;;; depth | |
3443 | nil ;;; number-control | |
3444 | nil ;;; index | |
3445 | t)) | |
3446 | (message "")))) | |
3447 | (if (not resituate) | |
3448 | (exchange-point-and-mark)))) | |
3449 | ;;;_ > outline-yank (&optional arg) | |
3450 | (defun outline-yank (&optional arg) | |
19b84ba3 RS |
3451 | "Outline-mode yank, with depth and numbering adjustment of yanked topics. |
3452 | ||
a0776d6b | 3453 | Non-topic yanks work no differently than normal yanks. |
c567ac01 RS |
3454 | |
3455 | If a topic is being yanked into a bare topic prefix, the depth of the | |
3456 | yanked topic is adjusted to the depth of the topic prefix. | |
3457 | ||
3458 | 1 we're yanking in an outline-mode buffer | |
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 | |
3461 | topic prefix. | |
3462 | ||
3463 | If these conditions hold then the depth of the yanked topics are all | |
3464 | adjusted the amount it takes to make the first one at the depth of the | |
3465 | header into which it's being yanked. | |
3466 | ||
3467 | The point is left in front of yanked, adjusted topics, rather than | |
3468 | at the end (and vice-versa with the mark). Non-adjusted yanks, | |
3469 | however, (ones that don't qualify for adjustment) are handled | |
3470 | exactly like normal yanks. | |
3471 | ||
a0776d6b | 3472 | Numbering of yanked topics, and the successive siblings at the depth |
c567ac01 RS |
3473 | into which they're being yanked, is adjusted. |
3474 | ||
3475 | Outline-yank-pop works with outline-yank just like normal yank-pop | |
3476 | works with normal yank in non-outline buffers." | |
1977b8f6 RS |
3477 | |
3478 | (interactive "*P") | |
3479 | (setq this-command 'yank) | |
c567ac01 RS |
3480 | (yank arg) |
3481 | (if (outline-mode-p) | |
3482 | (outline-yank-processing))) | |
3483 | ;;;_ > outline-yank-pop (&optional arg) | |
1977b8f6 | 3484 | (defun outline-yank-pop (&optional arg) |
19b84ba3 RS |
3485 | "Yank-pop like outline-yank when popping to bare outline prefixes. |
3486 | ||
3487 | Adapts level of popped topics to level of fresh prefix. | |
c567ac01 RS |
3488 | |
3489 | Note - prefix changes to distinctive bullets will stick, if followed | |
3490 | by pops to non-distinctive yanks. Bug..." | |
1977b8f6 RS |
3491 | |
3492 | (interactive "*p") | |
1977b8f6 | 3493 | (setq this-command 'yank) |
c567ac01 RS |
3494 | (yank-pop arg) |
3495 | (if (outline-mode-p) | |
3496 | (outline-yank-processing))) | |
1977b8f6 | 3497 | |
c567ac01 RS |
3498 | ;;;_ - Specialty bullet functions |
3499 | ;;;_ : File Cross references | |
3500 | ;;;_ > outline-resolve-xref () | |
1977b8f6 | 3501 | (defun outline-resolve-xref () |
19b84ba3 RS |
3502 | "Pop to file associated with current heading, if it has an xref bullet. |
3503 | ||
3504 | \(Works according to setting of `outline-file-xref-bullet')." | |
1977b8f6 RS |
3505 | (interactive) |
3506 | (if (not outline-file-xref-bullet) | |
3507 | (error | |
353e2ef2 | 3508 | "outline cross references disabled - no `outline-file-xref-bullet'") |
1977b8f6 | 3509 | (if (not (string= (outline-current-bullet) outline-file-xref-bullet)) |
353e2ef2 | 3510 | (error "current heading lacks cross-reference bullet `%s'" |
1977b8f6 RS |
3511 | outline-file-xref-bullet) |
3512 | (let (file-name) | |
3513 | (save-excursion | |
3514 | (let* ((text-start outline-recent-prefix-end) | |
fa29cfef | 3515 | (heading-end (progn (end-of-line) (point)))) |
1977b8f6 RS |
3516 | (goto-char text-start) |
3517 | (setq file-name | |
3518 | (if (re-search-forward "\\s-\\(\\S-*\\)" heading-end t) | |
3519 | (buffer-substring (match-beginning 1) (match-end 1)))))) | |
3520 | (setq file-name | |
3521 | (if (not (= (aref file-name 0) ?:)) | |
3522 | (expand-file-name file-name) | |
353e2ef2 | 3523 | ; A registry-files ref, strip the `:' |
1977b8f6 RS |
3524 | ; and try to follow it: |
3525 | (let ((reg-ref (reference-registered-file | |
3526 | (substring file-name 1) nil t))) | |
3527 | (if reg-ref (car (cdr reg-ref)))))) | |
3528 | (if (or (file-exists-p file-name) | |
3529 | (if (file-writable-p file-name) | |
3530 | (y-or-n-p (format "%s not there, create one? " | |
3531 | file-name)) | |
3532 | (error "%s not found and can't be created" file-name))) | |
3533 | (condition-case failure | |
3534 | (find-file-other-window file-name) | |
9179616f | 3535 | ('error failure)) |
1977b8f6 RS |
3536 | (error "%s not found" file-name)) |
3537 | ) | |
3538 | ) | |
3539 | ) | |
3540 | ) | |
19b84ba3 | 3541 | |
9179616f | 3542 | ;;;_ #6 Exposure Control |
c567ac01 RS |
3543 | |
3544 | ;;;_ - Fundamental | |
c567ac01 RS |
3545 | ;;;_ > outline-flag-current-subtree (flag) |
3546 | (defun outline-flag-current-subtree (flag) | |
19b84ba3 RS |
3547 | "Hide or show subtree of currently-visible topic. |
3548 | ||
3549 | See `outline-flag-region' for more details." | |
3550 | ||
c567ac01 RS |
3551 | (save-excursion |
3552 | (outline-back-to-current-heading) | |
3553 | (outline-flag-region (point) | |
19b84ba3 RS |
3554 | (progn (outline-end-of-current-subtree) (1- (point))) |
3555 | flag))) | |
c567ac01 | 3556 | |
c567ac01 RS |
3557 | ;;;_ - Topic-specific |
3558 | ;;;_ > outline-show-entry () | |
c567ac01 | 3559 | (defun outline-show-entry () |
19b84ba3 | 3560 | "Like `outline-show-current-entry', reveals entries nested in hidden topics. |
c567ac01 RS |
3561 | |
3562 | This is a way to give restricted peek at a concealed locality without the | |
3563 | expense of exposing its context, but can leave the outline with aberrant | |
3564 | exposure. outline-hide-current-entry-completely or outline-show-offshoot | |
3565 | should be used after the peek to rectify the exposure." | |
3566 | ||
3567 | (interactive) | |
3568 | (save-excursion | |
9179616f DL |
3569 | (let ((at (point)) |
3570 | beg end) | |
3571 | (outline-goto-prefix) | |
3572 | (setq beg (if (= (preceding-char) ?\r) (1- (point)) (point))) | |
3573 | (re-search-forward "[\n\r]" nil t) | |
3574 | (setq end (1- (if (< at (point)) | |
3575 | ;; We're on topic head line - show only it: | |
3576 | (point) | |
3577 | ;; or we're in body - include it: | |
3578 | (max beg (or (outline-pre-next-preface) (point)))))) | |
3579 | (outline-flag-region beg end ?\n) | |
3580 | (list beg end)))) | |
c567ac01 RS |
3581 | ;;;_ > outline-show-children (&optional level strict) |
3582 | (defun outline-show-children (&optional level strict) | |
3583 | ||
3584 | "If point is visible, show all direct subheadings of this heading. | |
19b84ba3 | 3585 | |
c567ac01 RS |
3586 | Otherwise, do outline-show-to-offshoot, and then show subheadings. |
3587 | ||
3588 | Optional LEVEL specifies how many levels below the current level | |
3589 | should be shown, or all levels if t. Default is 1. | |
3590 | ||
3591 | Optional STRICT means don't resort to -show-to-offshoot, no matter | |
3592 | what. This is basically so -show-to-offshoot, which is called by | |
3593 | this function, can employ the pure offspring-revealing capabilities of | |
19b84ba3 RS |
3594 | it. |
3595 | ||
3596 | Returns point at end of subtree that was opened, if any. (May get a | |
3597 | point of non-opened subtree?)" | |
c567ac01 RS |
3598 | |
3599 | (interactive "p") | |
19b84ba3 RS |
3600 | (let (max-pos) |
3601 | (if (and (not strict) | |
3602 | (outline-hidden-p)) | |
c567ac01 | 3603 | |
19b84ba3 RS |
3604 | (progn (outline-show-to-offshoot) ; Point's concealed, open to |
3605 | ; expose it. | |
3606 | ;; Then recurse, but with "strict" set so we don't | |
3607 | ;; infinite regress: | |
3608 | (setq max-pos (outline-show-children level t))) | |
c567ac01 | 3609 | |
19b84ba3 RS |
3610 | (save-excursion |
3611 | (save-restriction | |
3612 | (let* ((start-pt (point)) | |
3613 | (chart (outline-chart-subtree (or level 1))) | |
3614 | (to-reveal (outline-chart-to-reveal chart (or level 1)))) | |
3615 | (goto-char start-pt) | |
3616 | (if (and strict (= (preceding-char) ?\r)) | |
3617 | ;; Concealed root would already have been taken care of, | |
3618 | ;; unless strict was set. | |
9179616f DL |
3619 | (progn |
3620 | (outline-flag-region (point) (outline-snug-back) ?\n) | |
3621 | (if outline-show-bodies | |
3622 | (progn (goto-char (car to-reveal)) | |
3623 | (outline-show-current-entry))))) | |
19b84ba3 RS |
3624 | (while to-reveal |
3625 | (goto-char (car to-reveal)) | |
3626 | (outline-flag-region (point) (outline-snug-back) ?\n) | |
9179616f DL |
3627 | (if outline-show-bodies |
3628 | (progn (goto-char (car to-reveal)) | |
3629 | (outline-show-current-entry))) | |
19b84ba3 | 3630 | (setq to-reveal (cdr to-reveal))))))))) |
c567ac01 RS |
3631 | ;;;_ > outline-hide-point-reconcile () |
3632 | (defun outline-hide-reconcile () | |
19b84ba3 | 3633 | "Like `outline-hide-current-entry'; hides completely if within hidden region. |
c567ac01 RS |
3634 | |
3635 | Specifically intended for aberrant exposure states, like entries that were | |
3636 | exposed by outline-show-entry but are within otherwise concealed regions." | |
3637 | (interactive) | |
3638 | (save-excursion | |
3639 | (outline-goto-prefix) | |
3640 | (outline-flag-region (if (not (bobp)) (1- (point)) (point)) | |
3641 | (progn (outline-pre-next-preface) | |
3642 | (if (= ?\r (following-char)) | |
3643 | (point) | |
3644 | (1- (point)))) | |
3645 | ?\r))) | |
3646 | ;;;_ > outline-show-to-offshoot () | |
3647 | (defun outline-show-to-offshoot () | |
9179616f | 3648 | "Like outline-show-entry, but reveals all concealed ancestors, as well. |
c567ac01 | 3649 | |
19b84ba3 RS |
3650 | As with outline-hide-current-entry-completely, useful for rectifying |
3651 | aberrant exposure states produced by outline-show-entry." | |
c567ac01 RS |
3652 | |
3653 | (interactive) | |
3654 | (save-excursion | |
3655 | (let ((orig-pt (point)) | |
3656 | (orig-pref (outline-goto-prefix)) | |
3657 | (last-at (point)) | |
3658 | bag-it) | |
3659 | (while (or bag-it (= (preceding-char) ?\r)) | |
3660 | (beginning-of-line) | |
3661 | (if (= last-at (setq last-at (point))) | |
3662 | ;; Oops, we're not making any progress! Show the current | |
3663 | ;; topic completely, and bag this try. | |
3664 | (progn (beginning-of-line) | |
3665 | (outline-show-current-subtree) | |
3666 | (goto-char orig-pt) | |
3667 | (setq bag-it t) | |
3668 | (beep) | |
3669 | (message "%s: %s" | |
3670 | "outline-show-to-offshoot: " | |
3671 | "Aberrant nesting encountered."))) | |
3672 | (outline-show-children) | |
3673 | (goto-char orig-pref)) | |
19b84ba3 RS |
3674 | (goto-char orig-pt))) |
3675 | (if (outline-hidden-p) | |
3676 | (outline-show-entry))) | |
c567ac01 RS |
3677 | ;;;_ > outline-hide-current-entry () |
3678 | (defun outline-hide-current-entry () | |
3679 | "Hide the body directly following this heading." | |
3680 | (interactive) | |
3681 | (outline-back-to-current-heading) | |
3682 | (save-excursion | |
3683 | (outline-flag-region (point) | |
3684 | (progn (outline-end-of-current-entry) (point)) | |
9179616f | 3685 | ?\r))) |
c567ac01 RS |
3686 | ;;;_ > outline-show-current-entry (&optional arg) |
3687 | (defun outline-show-current-entry (&optional arg) | |
3688 | ||
19b84ba3 | 3689 | "Show body following current heading, or hide the entry if repeat count." |
c567ac01 RS |
3690 | |
3691 | (interactive "P") | |
3692 | (if arg | |
3693 | (outline-hide-current-entry) | |
3694 | (save-excursion | |
3695 | (outline-flag-region (point) | |
19b84ba3 RS |
3696 | (progn (outline-end-of-current-entry) (point)) |
3697 | ?\n)))) | |
c567ac01 RS |
3698 | ;;;_ > outline-hide-current-entry-completely () |
3699 | ; ... outline-hide-current-entry-completely also for isearch dynamic exposure: | |
3700 | (defun outline-hide-current-entry-completely () | |
3701 | "Like outline-hide-current-entry, but conceal topic completely. | |
3702 | ||
3703 | Specifically intended for aberrant exposure states, like entries that were | |
3704 | exposed by outline-show-entry but are within otherwise concealed regions." | |
3705 | (interactive) | |
3706 | (save-excursion | |
3707 | (outline-goto-prefix) | |
3708 | (outline-flag-region (if (not (bobp)) (1- (point)) (point)) | |
3709 | (progn (outline-pre-next-preface) | |
3710 | (if (= ?\r (following-char)) | |
3711 | (point) | |
3712 | (1- (point)))) | |
3713 | ?\r))) | |
19b84ba3 RS |
3714 | ;;;_ > outline-show-current-subtree (&optional arg) |
3715 | (defun outline-show-current-subtree (&optional arg) | |
3716 | "Show everything within the current topic. With a repeat-count, | |
353e2ef2 | 3717 | expose this topic and its siblings." |
19b84ba3 RS |
3718 | (interactive "P") |
3719 | (save-excursion | |
3720 | (if (<= (outline-current-depth) 0) | |
3721 | ;; Outside any topics - try to get to the first: | |
3722 | (if (not (outline-next-heading)) | |
6a05d05f | 3723 | (error "No topics") |
19b84ba3 RS |
3724 | ;; got to first, outermost topic - set to expose it and siblings: |
3725 | (message "Above outermost topic - exposing all.") | |
3726 | (outline-flag-region (point-min)(point-max) ?\n)) | |
3727 | (if (not arg) | |
3728 | (outline-flag-current-subtree ?\n) | |
3729 | (outline-beginning-of-level) | |
3730 | (outline-expose-topic '(* :)))))) | |
c567ac01 RS |
3731 | ;;;_ > outline-hide-current-subtree (&optional just-close) |
3732 | (defun outline-hide-current-subtree (&optional just-close) | |
19b84ba3 | 3733 | "Close the current topic, or containing topic if this one is already closed. |
c567ac01 | 3734 | |
19b84ba3 | 3735 | If this topic is closed and it's a top level topic, close this topic |
353e2ef2 | 3736 | and its siblings. |
19b84ba3 RS |
3737 | |
3738 | If optional arg JUST-CLOSE is non-nil, do not treat the parent or | |
3739 | siblings, even if the target topic is already closed." | |
c567ac01 RS |
3740 | |
3741 | (interactive) | |
19b84ba3 RS |
3742 | (let ((from (point)) |
3743 | (orig-eol (progn (end-of-line) | |
3744 | (if (not (outline-goto-prefix)) | |
6a05d05f | 3745 | (error "No topics found") |
19b84ba3 | 3746 | (end-of-line)(point))))) |
9179616f | 3747 | (outline-flag-current-subtree ?\r) |
19b84ba3 RS |
3748 | (goto-char from) |
3749 | (if (and (= orig-eol (progn (goto-char orig-eol) | |
3750 | (end-of-line) | |
3751 | (point))) | |
3752 | (not just-close) | |
c567ac01 | 3753 | ;; Structure didn't change - try hiding current level: |
19b84ba3 RS |
3754 | (goto-char from) |
3755 | (if (outline-up-current-level 1 t) | |
3756 | t | |
3757 | (goto-char 0) | |
3758 | (let ((msg | |
3759 | "Top-level topic already closed - closing siblings...")) | |
3760 | (message msg) | |
3761 | (outline-expose-topic '(0 :)) | |
3762 | (message (concat msg " Done."))) | |
3763 | nil) | |
3764 | (/= (outline-recent-depth) 0)) | |
3765 | (outline-hide-current-subtree)) | |
3766 | (goto-char from))) | |
c567ac01 RS |
3767 | ;;;_ > outline-show-current-branches () |
3768 | (defun outline-show-current-branches () | |
3769 | "Show all subheadings of this heading, but not their bodies." | |
3770 | (interactive) | |
3771 | (beginning-of-line) | |
3772 | (outline-show-children t)) | |
3773 | ;;;_ > outline-hide-current-leaves () | |
3774 | (defun outline-hide-current-leaves () | |
353e2ef2 | 3775 | "Hide the bodies of the current topic and all its offspring." |
c567ac01 RS |
3776 | (interactive) |
3777 | (outline-back-to-current-heading) | |
3778 | (outline-hide-region-body (point) (progn (outline-end-of-current-subtree) | |
3779 | (point)))) | |
3780 | ||
3781 | ;;;_ - Region and beyond | |
3782 | ;;;_ > outline-show-all () | |
3783 | (defun outline-show-all () | |
3784 | "Show all of the text in the buffer." | |
3785 | (interactive) | |
19b84ba3 RS |
3786 | (message "Exposing entire buffer...") |
3787 | (outline-flag-region (point-min) (point-max) ?\n) | |
3788 | (message "Exposing entire buffer... Done.")) | |
c567ac01 RS |
3789 | ;;;_ > outline-hide-bodies () |
3790 | (defun outline-hide-bodies () | |
3791 | "Hide all of buffer except headings." | |
3792 | (interactive) | |
3793 | (outline-hide-region-body (point-min) (point-max))) | |
3794 | ;;;_ > outline-hide-region-body (start end) | |
3795 | (defun outline-hide-region-body (start end) | |
3796 | "Hide all body lines in the region, but not headings." | |
3797 | (save-excursion | |
3798 | (save-restriction | |
3799 | (narrow-to-region start end) | |
3800 | (goto-char (point-min)) | |
3801 | (while (not (eobp)) | |
3802 | (outline-flag-region (point) | |
9179616f | 3803 | (progn (outline-pre-next-preface) (point)) ?\r) |
c567ac01 RS |
3804 | (if (not (eobp)) |
3805 | (forward-char | |
3806 | (if (looking-at "[\n\r][\n\r]") | |
3807 | 2 1))))))) | |
c567ac01 | 3808 | |
19b84ba3 RS |
3809 | ;;;_ > outline-expose-topic (spec) |
3810 | (defun outline-expose-topic (spec) | |
3811 | "Apply exposure specs to successive outline topic items. | |
c567ac01 | 3812 | |
19b84ba3 RS |
3813 | Use the more convenient frontend, `outline-new-exposure', if you don't |
3814 | need evaluation of the arguments, or even better, the `outline-layout' | |
3815 | variable-keyed mode-activation/auto-exposure feature of allout outline | |
3816 | mode. See the respective documentation strings for more details. | |
c567ac01 RS |
3817 | |
3818 | Cursor is left at start position. | |
3819 | ||
19b84ba3 RS |
3820 | SPEC is either a number or a list. |
3821 | ||
3822 | Successive specs on a list are applied to successive sibling topics. | |
c567ac01 RS |
3823 | |
3824 | A simple spec \(either a number, one of a few symbols, or the null | |
19b84ba3 RS |
3825 | list) dictates the exposure for the corresponding topic. |
3826 | ||
3827 | Non-null lists recursively designate exposure specs for respective | |
3828 | subtopics of the current topic. | |
c567ac01 | 3829 | |
353e2ef2 | 3830 | The `:' repeat spec is used to specify exposure for any number of |
19b84ba3 | 3831 | successive siblings, up to the trailing ones for which there are |
353e2ef2 | 3832 | explicit specs following the `:'. |
c567ac01 RS |
3833 | |
3834 | Simple (numeric and null-list) specs are interpreted as follows: | |
3835 | ||
19b84ba3 RS |
3836 | Numbers indicate the relative depth to open the corresponding topic. |
3837 | - negative numbers force the topic to be closed before opening to the | |
3838 | absolute value of the number, so all siblings are open only to | |
3839 | that level. | |
3840 | - positive numbers open to the relative depth indicated by the | |
3841 | number, but do not force already opened subtopics to be closed. | |
3842 | - 0 means to close topic - hide all offspring. | |
353e2ef2 | 3843 | : - `repeat' |
c567ac01 | 3844 | apply prior element to all siblings at current level, *up to* |
353e2ef2 | 3845 | those siblings that would be covered by specs following the `:' |
c567ac01 RS |
3846 | on the list. Ie, apply to all topics at level but the last |
3847 | ones. \(Only first of multiple colons at same level is | |
3848 | respected - subsequent ones are discarded.) | |
19b84ba3 RS |
3849 | * - completely opens the topic, including bodies. |
3850 | + - shows all the sub headers, but not the bodies | |
3851 | - - exposes the body of the corresponding topic. | |
c567ac01 RS |
3852 | |
3853 | Examples: | |
3854 | \(outline-expose-topic '(-1 : 0)) | |
3855 | Close this and all following topics at current level, exposing | |
3856 | only their immediate children, but close down the last topic | |
3857 | at this current level completely. | |
3858 | \(outline-expose-topic '(-1 () : 1 0)) | |
3859 | Close current topic so only the immediate subtopics are shown; | |
3860 | show the children in the second to last topic, and completely | |
3861 | close the last one. | |
19b84ba3 | 3862 | \(outline-expose-topic '(-2 : -1 *)) |
c567ac01 RS |
3863 | Expose children and grandchildren of all topics at current |
3864 | level except the last two; expose children of the second to | |
3865 | last and completely open the last one." | |
3866 | ||
3867 | (interactive "xExposure spec: ") | |
19b84ba3 RS |
3868 | (if (not (listp spec)) |
3869 | nil | |
3870 | (let ((depth (outline-depth)) | |
3871 | (max-pos 0) | |
3872 | prev-elem curr-elem | |
3873 | stay done | |
3874 | snug-back | |
3875 | ) | |
3876 | (while spec | |
3877 | (setq prev-elem curr-elem | |
3878 | curr-elem (car spec) | |
3879 | spec (cdr spec)) | |
3880 | (cond ; Do current element: | |
3881 | ((null curr-elem) nil) | |
3882 | ((symbolp curr-elem) | |
3883 | (cond ((eq curr-elem '*) (outline-show-current-subtree) | |
3884 | (if (> outline-recent-end-of-subtree max-pos) | |
3885 | (setq max-pos outline-recent-end-of-subtree))) | |
3886 | ((eq curr-elem '+) (outline-show-current-branches) | |
3887 | (if (> outline-recent-end-of-subtree max-pos) | |
3888 | (setq max-pos outline-recent-end-of-subtree))) | |
3889 | ((eq curr-elem '-) (outline-show-current-entry)) | |
3890 | ((eq curr-elem ':) | |
3891 | (setq stay t) | |
353e2ef2 | 3892 | ;; Expand the `repeat' spec to an explicit version, |
19b84ba3 RS |
3893 | ;; w.r.t. remaining siblings: |
3894 | (let ((residue ; = # of sibs not covered by remaining spec | |
3895 | ;; Dang - could be nice to make use of the chart, sigh: | |
3896 | (- (length (outline-chart-siblings)) | |
3897 | (length spec)))) | |
3898 | (if (< 0 residue) | |
3899 | ;; Some residue - cover it with prev-elem: | |
3900 | (setq spec (append (make-list residue prev-elem) | |
3901 | spec))))))) | |
3902 | ((numberp curr-elem) | |
3903 | (if (and (>= 0 curr-elem) (outline-visible-p)) | |
3904 | (save-excursion (outline-hide-current-subtree t) | |
3905 | (if (> 0 curr-elem) | |
3906 | nil | |
3907 | (if (> outline-recent-end-of-subtree max-pos) | |
3908 | (setq max-pos | |
3909 | outline-recent-end-of-subtree))))) | |
3910 | (if (> (abs curr-elem) 0) | |
3911 | (progn (outline-show-children (abs curr-elem)) | |
3912 | (if (> outline-recent-end-of-subtree max-pos) | |
3913 | (setq max-pos outline-recent-end-of-subtree))))) | |
3914 | ((listp curr-elem) | |
3915 | (if (outline-descend-to-depth (1+ depth)) | |
3916 | (let ((got (outline-expose-topic curr-elem))) | |
3917 | (if (and got (> got max-pos)) (setq max-pos got)))))) | |
3918 | (cond (stay (setq stay nil)) | |
3919 | ((listp (car spec)) nil) | |
3920 | ((> max-pos (point)) | |
3921 | ;; Capitalize on max-pos state to get us nearer next sibling: | |
3922 | (progn (goto-char (min (point-max) max-pos)) | |
3923 | (outline-next-heading))) | |
3924 | ((outline-next-sibling depth)))) | |
3925 | max-pos))) | |
c567ac01 RS |
3926 | ;;;_ > outline-old-expose-topic (spec &rest followers) |
3927 | (defun outline-old-expose-topic (spec &rest followers) | |
3928 | ||
19b84ba3 | 3929 | "Deprecated. Use outline-expose-topic \(with different schema |
9179616f | 3930 | format) instead. |
19b84ba3 RS |
3931 | |
3932 | Dictate wholesale exposure scheme for current topic, according to SPEC. | |
c567ac01 RS |
3933 | |
3934 | SPEC is either a number or a list. Optional successive args | |
3935 | dictate exposure for subsequent siblings of current topic. | |
3936 | ||
3937 | A simple spec (either a number, a special symbol, or the null list) | |
3938 | dictates the overall exposure for a topic. Non null lists are | |
3939 | composite specs whose first element dictates the overall exposure for | |
3940 | a topic, with the subsequent elements in the list interpreted as specs | |
3941 | that dictate the exposure for the successive offspring of the topic. | |
3942 | ||
3943 | Simple (numeric and null-list) specs are interpreted as follows: | |
3944 | ||
3945 | - Numbers indicate the relative depth to open the corresponding topic: | |
3946 | - negative numbers force the topic to be close before opening to the | |
3947 | absolute value of the number. | |
3948 | - positive numbers just open to the relative depth indicated by the number. | |
3949 | - 0 just closes | |
353e2ef2 KH |
3950 | - `*' completely opens the topic, including bodies. |
3951 | - `+' shows all the sub headers, but not the bodies | |
3952 | - `-' exposes the body and immediate offspring of the corresponding topic. | |
c567ac01 RS |
3953 | |
3954 | If the spec is a list, the first element must be a number, which | |
3955 | dictates the exposure depth of the topic as a whole. Subsequent | |
3956 | elements of the list are nested SPECs, dictating the specific exposure | |
3957 | for the corresponding offspring of the topic. | |
3958 | ||
3959 | Optional FOLLOWER arguments dictate exposure for succeeding siblings." | |
3960 | ||
3961 | (interactive "xExposure spec: ") | |
3962 | (let ((depth (outline-current-depth)) | |
3963 | done | |
3964 | max-pos) | |
3965 | (cond ((null spec) nil) | |
3966 | ((symbolp spec) | |
3967 | (if (eq spec '*) (outline-show-current-subtree)) | |
3968 | (if (eq spec '+) (outline-show-current-branches)) | |
3969 | (if (eq spec '-) (outline-show-current-entry))) | |
3970 | ((numberp spec) | |
3971 | (if (>= 0 spec) | |
3972 | (save-excursion (outline-hide-current-subtree t) | |
3973 | (end-of-line) | |
3974 | (if (or (not max-pos) | |
3975 | (> (point) max-pos)) | |
3976 | (setq max-pos (point))) | |
3977 | (if (> 0 spec) | |
3978 | (setq spec (* -1 spec))))) | |
3979 | (if (> spec 0) | |
3980 | (outline-show-children spec))) | |
3981 | ((listp spec) | |
3982 | ;(let ((got (outline-old-expose-topic (car spec)))) | |
3983 | ; (if (and got (or (not max-pos) (> got max-pos))) | |
3984 | ; (setq max-pos got))) | |
3985 | (let ((new-depth (+ (outline-current-depth) 1)) | |
3986 | got) | |
3987 | (setq max-pos (outline-old-expose-topic (car spec))) | |
3988 | (setq spec (cdr spec)) | |
3989 | (if (and spec | |
3990 | (outline-descend-to-depth new-depth) | |
3991 | (not (outline-hidden-p))) | |
3992 | (progn (setq got (apply 'outline-old-expose-topic spec)) | |
3993 | (if (and got (or (not max-pos) (> got max-pos))) | |
3994 | (setq max-pos got))))))) | |
3995 | (while (and followers | |
3996 | (progn (if (and max-pos (< (point) max-pos)) | |
3997 | (progn (goto-char max-pos) | |
3998 | (setq max-pos nil))) | |
3999 | (end-of-line) | |
4000 | (outline-next-sibling depth))) | |
4001 | (outline-old-expose-topic (car followers)) | |
4002 | (setq followers (cdr followers))) | |
4003 | max-pos)) | |
4004 | ;;;_ > outline-new-exposure '() | |
4005 | (defmacro outline-new-exposure (&rest spec) | |
4006 | "Literal frontend for `outline-expose-topic', doesn't evaluate arguments. | |
19b84ba3 RS |
4007 | Some arguments that would need to be quoted in outline-expose-topic |
4008 | need not be quoted in outline-new-exposure. | |
c567ac01 RS |
4009 | |
4010 | Cursor is left at start position. | |
4011 | ||
353e2ef2 | 4012 | Use this instead of obsolete `outline-exposure'. |
c567ac01 RS |
4013 | |
4014 | Examples: | |
4015 | \(outline-exposure (-1 () () () 1) 0) | |
4016 | Close current topic at current level so only the immediate | |
4017 | subtopics are shown, except also show the children of the | |
4018 | third subtopic; and close the next topic at the current level. | |
4019 | \(outline-exposure : -1 0) | |
4020 | Close all topics at current level to expose only their | |
4021 | immediate children, except for the last topic at the current | |
353e2ef2 | 4022 | level, in which even its immediate children are hidden. |
c567ac01 RS |
4023 | \(outline-exposure -2 : -1 *) |
4024 | Expose children and grandchildren of first topic at current | |
4025 | level, and expose children of subsequent topics at current | |
4026 | level *except* for the last, which should be opened completely." | |
4027 | (list 'save-excursion | |
4028 | '(if (not (or (outline-goto-prefix) | |
4029 | (outline-next-heading))) | |
6a05d05f | 4030 | (error "outline-new-exposure: Can't find any outline topics")) |
c567ac01 RS |
4031 | (list 'outline-expose-topic (list 'quote spec)))) |
4032 | ;;;_ > outline-exposure '() | |
4033 | (defmacro outline-exposure (&rest spec) | |
353e2ef2 | 4034 | "Being deprecated - use more recent `outline-new-exposure' instead. |
c567ac01 RS |
4035 | |
4036 | Literal frontend for `outline-old-expose-topic', doesn't evaluate arguments | |
4037 | and retains start position." | |
4038 | (list 'save-excursion | |
4039 | '(if (not (or (outline-goto-prefix) | |
4040 | (outline-next-heading))) | |
6a05d05f | 4041 | (error "Can't find any outline topics")) |
c567ac01 | 4042 | (cons 'outline-old-expose-topic |
9179616f | 4043 | (mapcar (function (lambda (x) (list 'quote x))) spec)))) |
c567ac01 | 4044 | |
9179616f | 4045 | ;;;_ #7 Systematic outline presentation - copying, printing, flattening |
19b84ba3 | 4046 | |
9179616f DL |
4047 | ;;;_ - Mapping and processing of topics |
4048 | ;;;_ ( See also Subtree Charting, in Navigation code.) | |
4049 | ;;;_ > outline-stringify-flat-index (flat-index) | |
4050 | (defun outline-stringify-flat-index (flat-index &optional context) | |
4051 | "Convert list representing section/subsection/... to document string. | |
4052 | ||
4053 | Optional arg CONTEXT indicates interior levels to include." | |
4054 | (let ((delim ".") | |
4055 | result | |
4056 | numstr | |
4057 | (context-depth (or (and context 2) 1))) | |
4058 | ;; Take care of the explicit context: | |
4059 | (while (> context-depth 0) | |
4060 | (setq numstr (int-to-string (car flat-index)) | |
4061 | flat-index (cdr flat-index) | |
4062 | result (if flat-index | |
4063 | (cons delim (cons numstr result)) | |
4064 | (cons numstr result)) | |
4065 | context-depth (if flat-index (1- context-depth) 0))) | |
4066 | (setq delim " ") | |
4067 | ;; Take care of the indentation: | |
4068 | (if flat-index | |
4069 | (progn | |
4070 | (while flat-index | |
4071 | (setq result | |
4072 | (cons delim | |
4073 | (cons (make-string | |
4074 | (1+ (truncate (if (zerop (car flat-index)) | |
4075 | 1 | |
4076 | (log10 (car flat-index))))) | |
4077 | ? ) | |
4078 | result))) | |
4079 | (setq flat-index (cdr flat-index))) | |
4080 | ;; Dispose of single extra delim: | |
4081 | (setq result (cdr result)))) | |
4082 | (apply 'concat result))) | |
4083 | ;;;_ > outline-stringify-flat-index-plain (flat-index) | |
4084 | (defun outline-stringify-flat-index-plain (flat-index) | |
4085 | "Convert list representing section/subsection/... to document string." | |
4086 | (let ((delim ".") | |
4087 | result) | |
4088 | (while flat-index | |
4089 | (setq result (cons (int-to-string (car flat-index)) | |
4090 | (if result | |
4091 | (cons delim result)))) | |
4092 | (setq flat-index (cdr flat-index))) | |
4093 | (apply 'concat result))) | |
4094 | ;;;_ > outline-stringify-flat-index-indented (flat-index) | |
4095 | (defun outline-stringify-flat-index-indented (flat-index) | |
4096 | "Convert list representing section/subsection/... to document string." | |
4097 | (let ((delim ".") | |
4098 | result | |
4099 | numstr) | |
4100 | ;; Take care of the explicit context: | |
4101 | (setq numstr (int-to-string (car flat-index)) | |
4102 | flat-index (cdr flat-index) | |
4103 | result (if flat-index | |
4104 | (cons delim (cons numstr result)) | |
4105 | (cons numstr result))) | |
4106 | (setq delim " ") | |
4107 | ;; Take care of the indentation: | |
4108 | (if flat-index | |
4109 | (progn | |
4110 | (while flat-index | |
4111 | (setq result | |
4112 | (cons delim | |
4113 | (cons (make-string | |
4114 | (1+ (truncate (if (zerop (car flat-index)) | |
4115 | 1 | |
4116 | (log10 (car flat-index))))) | |
4117 | ? ) | |
4118 | result))) | |
4119 | (setq flat-index (cdr flat-index))) | |
4120 | ;; Dispose of single extra delim: | |
4121 | (setq result (cdr result)))) | |
4122 | (apply 'concat result))) | |
4123 | ;;;_ > outline-listify-exposed (&optional start end format) | |
4124 | (defun outline-listify-exposed (&optional start end format) | |
19b84ba3 | 4125 | |
9179616f | 4126 | "Produce a list representing exposed topics in current region. |
c567ac01 | 4127 | |
9179616f DL |
4128 | This list can then be used by `outline-process-exposed' to manipulate |
4129 | the subject region. | |
353e2ef2 | 4130 | |
9179616f | 4131 | Optional START and END indicate bounds of region. |
19b84ba3 | 4132 | |
9179616f DL |
4133 | optional arg, FORMAT, designates an alternate presentation form for |
4134 | the prefix: | |
c567ac01 | 4135 | |
9179616f DL |
4136 | list - Present prefix as numeric section.subsection..., starting with |
4137 | section indicated by the list, innermost nesting first. | |
4138 | `indent' \(symbol) - Convert header prefixes to all white space, | |
4139 | except for distinctive bullets. | |
c567ac01 | 4140 | |
9179616f DL |
4141 | The elements of the list produced are lists that represents a topic |
4142 | header and body. The elements of that list are: | |
c567ac01 | 4143 | |
9179616f DL |
4144 | - a number representing the depth of the topic, |
4145 | - a string representing the header-prefix, including trailing whitespace and | |
4146 | bullet. | |
4147 | - a string representing the bullet character, | |
4148 | - and a series of strings, each containing one line of the exposed | |
4149 | portion of the topic entry." | |
c567ac01 | 4150 | |
9179616f DL |
4151 | (interactive "r") |
4152 | (save-excursion | |
4153 | (let* | |
4154 | ;; state vars: | |
4155 | (strings prefix pad result depth new-depth out gone-out bullet beg | |
4156 | next done) | |
c567ac01 | 4157 | |
9179616f DL |
4158 | (goto-char start) |
4159 | (beginning-of-line) | |
4160 | ;; Goto initial topic, and register preceeding stuff, if any: | |
4161 | (if (> (outline-goto-prefix) start) | |
4162 | ;; First topic follows beginning point - register preliminary stuff: | |
4163 | (setq result (list (list 0 "" nil | |
4164 | (buffer-substring start (1- (point))))))) | |
4165 | (while (and (not done) | |
4166 | (not (eobp)) ; Loop until we've covered the region. | |
4167 | (not (> (point) end))) | |
4168 | (setq depth (outline-recent-depth) ; Current topics depth, | |
4169 | bullet (outline-recent-bullet) ; ... bullet, | |
4170 | prefix (outline-recent-prefix) | |
4171 | beg (progn (outline-end-of-prefix t) (point))) ; and beginning. | |
4172 | (setq done ; The boundary for the current topic: | |
4173 | (not (outline-next-visible-heading 1))) | |
4174 | (setq new-depth (outline-recent-depth)) | |
4175 | (setq gone-out out | |
4176 | out (< new-depth depth)) | |
4177 | (beginning-of-line) | |
4178 | (setq next (point)) | |
4179 | (goto-char beg) | |
4180 | (setq strings nil) | |
4181 | (while (> next (point)) ; Get all the exposed text in | |
4182 | (setq strings | |
4183 | (cons (buffer-substring | |
4184 | beg | |
4185 | ;To hidden text or end of line: | |
4186 | (progn | |
4187 | (search-forward "\r" | |
4188 | (save-excursion (end-of-line) | |
4189 | (point)) | |
4190 | 1) | |
4191 | (if (= (preceding-char) ?\r) | |
4192 | (1- (point)) | |
4193 | (point)))) | |
4194 | strings)) | |
4195 | (if (< (point) next) ; Resume from after hid text, if any. | |
4196 | (forward-line 1)) | |
4197 | (setq beg (point))) | |
4198 | ;; Accumulate list for this topic: | |
4199 | (setq strings (nreverse strings)) | |
4200 | (setq result | |
4201 | (cons | |
4202 | (if format | |
4203 | (let ((special (if (string-match | |
4204 | (regexp-quote bullet) | |
4205 | outline-distinctive-bullets-string) | |
4206 | bullet))) | |
4207 | (cond ((listp format) | |
4208 | (list depth | |
4209 | (if outline-abbreviate-flattened-numbering | |
4210 | (outline-stringify-flat-index format | |
4211 | gone-out) | |
4212 | (outline-stringify-flat-index-plain | |
4213 | format)) | |
4214 | strings | |
4215 | special)) | |
4216 | ((eq format 'indent) | |
4217 | (if special | |
4218 | (list depth | |
4219 | (concat (make-string (1+ depth) ? ) | |
4220 | (substring prefix -1)) | |
4221 | strings) | |
4222 | (list depth | |
4223 | (make-string depth ? ) | |
4224 | strings))) | |
4225 | (t (error "outline-listify-exposed: %s %s" | |
4226 | "invalid format" format)))) | |
4227 | (list depth prefix strings)) | |
4228 | result)) | |
4229 | ;; Reasses format, if any: | |
4230 | (if (and format (listp format)) | |
4231 | (cond ((= new-depth depth) | |
4232 | (setq format (cons (1+ (car format)) | |
4233 | (cdr format)))) | |
4234 | ((> new-depth depth) ; descending - assume by 1: | |
4235 | (setq format (cons 1 format))) | |
4236 | (t | |
4237 | ; Pop the residue: | |
4238 | (while (< new-depth depth) | |
4239 | (setq format (cdr format)) | |
4240 | (setq depth (1- depth))) | |
4241 | ; And increment the current one: | |
4242 | (setq format | |
4243 | (cons (1+ (or (car format) | |
4244 | -1)) | |
4245 | (cdr format))))))) | |
4246 | ;; Put the list with first at front, to last at back: | |
4247 | (nreverse result)))) | |
4248 | ;;;_ > outline-process-exposed (&optional func from to frombuf | |
4249 | ;;; tobuf format) | |
4250 | (defun outline-process-exposed (&optional func from to frombuf tobuf | |
4251 | format &optional start-num) | |
4252 | "Map function on exposed parts of current topic; results to another buffer. | |
353e2ef2 | 4253 | |
9179616f | 4254 | All args are options; default values itemized below. |
1977b8f6 | 4255 | |
9179616f DL |
4256 | Apply FUNCTION to exposed portions FROM position TO position in buffer |
4257 | FROMBUF to buffer TOBUF. Sixth optional arg, FORMAT, designates an | |
4258 | alternate presentation form: | |
c567ac01 | 4259 | |
9179616f DL |
4260 | `flat' - Present prefix as numeric section.subsection..., starting with |
4261 | section indicated by the start-num, innermost nesting first. | |
4262 | X`flat-indented' - Prefix is like `flat' for first topic at each | |
4263 | X level, but subsequent topics have only leaf topic | |
4264 | X number, padded with blanks to line up with first. | |
4265 | `indent' \(symbol) - Convert header prefixes to all white space, | |
4266 | except for distinctive bullets. | |
c567ac01 | 4267 | |
9179616f DL |
4268 | Defaults: |
4269 | FUNCTION: `outline-insert-listified' | |
4270 | FROM: region start, if region active, else start of buffer | |
4271 | TO: region end, if region active, else end of buffer | |
4272 | FROMBUF: current buffer | |
4273 | TOBUF: buffer name derived: \"*current-buffer-name exposed*\" | |
4274 | FORMAT: nil" | |
4275 | ||
4276 | ; Resolve arguments, | |
4277 | ; defaulting if necessary: | |
4278 | (if (not func) (setq func 'outline-insert-listified)) | |
4279 | (if (not (and from to)) | |
4280 | (if (my-region-active-p) | |
4281 | (setq from (region-beginning) to (region-end)) | |
4282 | (setq from (point-min) to (point-max)))) | |
4283 | (if frombuf | |
4284 | (if (not (bufferp frombuf)) | |
4285 | ;; Specified but not a buffer - get it: | |
4286 | (let ((got (get-buffer frombuf))) | |
4287 | (if (not got) | |
4288 | (error (concat "outline-process-exposed: source buffer " | |
4289 | frombuf | |
4290 | " not found.")) | |
4291 | (setq frombuf got)))) | |
4292 | ;; not specified - default it: | |
4293 | (setq frombuf (current-buffer))) | |
4294 | (if tobuf | |
4295 | (if (not (bufferp tobuf)) | |
4296 | (setq tobuf (get-buffer-create tobuf))) | |
4297 | ;; not specified - default it: | |
4298 | (setq tobuf (concat "*" (buffer-name frombuf) " exposed*"))) | |
4299 | (if (listp format) | |
4300 | (nreverse format)) | |
4301 | ||
4302 | (let* ((listified | |
4303 | (progn (set-buffer frombuf) | |
4304 | (outline-listify-exposed from to format)))) | |
4305 | (set-buffer tobuf) | |
4306 | (mapcar func listified) | |
4307 | (pop-to-buffer tobuf))) | |
4308 | ||
4309 | ;;;_ - Copy exposed | |
4310 | ;;;_ > outline-insert-listified (listified) | |
4311 | (defun outline-insert-listified (listified) | |
4312 | "Insert contents of listified outline portion in current buffer. | |
4313 | ||
4314 | Listified is a list representing each topic header and body: | |
4315 | ||
4316 | \`(depth prefix text)' | |
4317 | ||
4318 | or \`(depth prefix text bullet-plus)' | |
4319 | ||
4320 | If `bullet-plus' is specified, it is inserted just after the entire prefix." | |
4321 | (setq listified (cdr listified)) | |
4322 | (let ((prefix (prog1 | |
4323 | (car listified) | |
4324 | (setq listified (cdr listified)))) | |
4325 | (text (prog1 | |
4326 | (car listified) | |
4327 | (setq listified (cdr listified)))) | |
4328 | (bullet-plus (car listified))) | |
eac9cf5f PJ |
4329 | (insert prefix) |
4330 | (if bullet-plus (insert (concat " " bullet-plus))) | |
9179616f | 4331 | (while text |
eac9cf5f | 4332 | (insert (car text)) |
9179616f | 4333 | (if (setq text (cdr text)) |
eac9cf5f PJ |
4334 | (insert "\n"))) |
4335 | (insert "\n"))) | |
9179616f DL |
4336 | ;;;_ > outline-copy-exposed-to-buffer (&optional arg tobuf format) |
4337 | (defun outline-copy-exposed-to-buffer (&optional arg tobuf format) | |
4338 | "Duplicate exposed portions of current outline to another buffer. | |
4339 | ||
4340 | Other buffer has current buffers name with \" exposed\" appended to it. | |
4341 | ||
4342 | With repeat count, copy the exposed parts of only the current topic. | |
4343 | ||
4344 | Optional second arg TOBUF is target buffer name. | |
4345 | ||
4346 | Optional third arg FORMAT, if non-nil, symbolically designates an | |
4347 | alternate presentation format for the outline: | |
4348 | ||
4349 | `flat' - Convert topic header prefixes to numeric | |
4350 | section.subsection... identifiers. | |
4351 | `indent' - Convert header prefixes to all white space, except for | |
4352 | distinctive bullets. | |
4353 | `indent-flat' - The best of both - only the first of each level has | |
4354 | the full path, the rest have only the section number | |
4355 | of the leaf, preceded by the right amount of indentation." | |
c567ac01 RS |
4356 | |
4357 | (interactive "P") | |
4358 | (if (not tobuf) | |
4359 | (setq tobuf (get-buffer-create (concat "*" (buffer-name) " exposed*")))) | |
4360 | (let* ((start-pt (point)) | |
9179616f DL |
4361 | (beg (if arg (outline-back-to-current-heading) (point-min))) |
4362 | (end (if arg (outline-end-of-current-subtree) (point-max))) | |
4363 | (buf (current-buffer)) | |
4364 | (start-list ())) | |
4365 | (if (eq format 'flat) | |
4366 | (setq format (if arg (save-excursion | |
4367 | (goto-char beg) | |
4368 | (outline-topic-flat-index)) | |
4369 | '(1)))) | |
c567ac01 RS |
4370 | (save-excursion (set-buffer tobuf)(erase-buffer)) |
4371 | (outline-process-exposed 'outline-insert-listified | |
4372 | beg | |
4373 | end | |
4374 | (current-buffer) | |
9179616f DL |
4375 | tobuf |
4376 | format start-list) | |
c567ac01 RS |
4377 | (goto-char (point-min)) |
4378 | (pop-to-buffer buf) | |
4379 | (goto-char start-pt))) | |
9179616f DL |
4380 | ;;;_ > outline-flatten-exposed-to-buffer (&optional arg tobuf) |
4381 | (defun outline-flatten-exposed-to-buffer (&optional arg tobuf) | |
4382 | "Present numeric outline of outline's exposed portions in another buffer. | |
4383 | ||
4384 | The resulting outline is not compatable with outline mode - use | |
4385 | `outline-copy-exposed-to-buffer' if you want that. | |
4386 | ||
4387 | Use `outline-indented-exposed-to-buffer' for indented presentation. | |
4388 | ||
4389 | With repeat count, copy the exposed portions of only current topic. | |
4390 | ||
4391 | Other buffer has current buffers name with \" exposed\" appended to | |
4392 | it, unless optional second arg TOBUF is specified, in which case it is | |
4393 | used verbatim." | |
4394 | (interactive "P") | |
4395 | (outline-copy-exposed-to-buffer arg tobuf 'flat)) | |
4396 | ;;;_ > outline-indented-exposed-to-buffer (&optional arg tobuf) | |
4397 | (defun outline-indented-exposed-to-buffer (&optional arg tobuf) | |
4398 | "Present indented outline of outline's exposed portions in another buffer. | |
4399 | ||
4400 | The resulting outline is not compatable with outline mode - use | |
4401 | `outline-copy-exposed-to-buffer' if you want that. | |
4402 | ||
4403 | Use `outline-flatten-exposed-to-buffer' for numeric sectional presentation. | |
4404 | ||
4405 | With repeat count, copy the exposed portions of only current topic. | |
4406 | ||
4407 | Other buffer has current buffers name with \" exposed\" appended to | |
4408 | it, unless optional second arg TOBUF is specified, in which case it is | |
4409 | used verbatim." | |
4410 | (interactive "P") | |
4411 | (outline-copy-exposed-to-buffer arg tobuf 'indent)) | |
c567ac01 RS |
4412 | |
4413 | ;;;_ - LaTeX formatting | |
4414 | ;;;_ > outline-latex-verb-quote (str &optional flow) | |
4415 | (defun outline-latex-verb-quote (str &optional flow) | |
19b84ba3 RS |
4416 | "Return copy of STRING for literal reproduction across latex processing. |
4417 | Expresses the original characters \(including carriage returns) of the | |
4418 | string across latex processing." | |
9179616f DL |
4419 | (mapconcat (function |
4420 | (lambda (char) | |
c567ac01 RS |
4421 | (cond ((memq char '(?\\ ?$ ?% ?# ?& ?{ ?} ?_ ?^ ?- ?*)) |
4422 | (concat "\\char" (number-to-string char) "{}")) | |
4423 | ((= char ?\n) "\\\\") | |
9179616f | 4424 | (t (char-to-string char))))) |
c567ac01 RS |
4425 | str |
4426 | "")) | |
4427 | ;;;_ > outline-latex-verbatim-quote-curr-line () | |
4428 | (defun outline-latex-verbatim-quote-curr-line () | |
9179616f | 4429 | "Express line for exact \(literal) representation across latex processing. |
19b84ba3 RS |
4430 | |
4431 | Adjust line contents so it is unaltered \(from the original line) | |
353e2ef2 | 4432 | across latex processing, within the context of a `verbatim' |
c567ac01 RS |
4433 | environment. Leaves point at the end of the line." |
4434 | (beginning-of-line) | |
4435 | (let ((beg (point)) | |
4436 | (end (progn (end-of-line)(point)))) | |
4437 | (goto-char beg) | |
4438 | (while (re-search-forward "\\\\" | |
4439 | ;;"\\\\\\|\\{\\|\\}\\|\\_\\|\\$\\|\\\"\\|\\&\\|\\^\\|\\-\\|\\*\\|#" | |
4440 | end ; bounded by end-of-line | |
4441 | 1) ; no matches, move to end & return nil | |
4442 | (goto-char (match-beginning 0)) | |
eac9cf5f | 4443 | (insert "\\") |
c567ac01 RS |
4444 | (setq end (1+ end)) |
4445 | (goto-char (1+ (match-end 0)))))) | |
4446 | ;;;_ > outline-insert-latex-header (buf) | |
4447 | (defun outline-insert-latex-header (buf) | |
4448 | "Insert initial latex commands at point in BUFFER." | |
4449 | ;; Much of this is being derived from the stuff in appendix of E in | |
4450 | ;; the TeXBook, pg 421. | |
4451 | (set-buffer buf) | |
4452 | (let ((doc-style (format "\n\\documentstyle{%s}\n" | |
4453 | "report")) | |
4454 | (page-numbering (if outline-number-pages | |
4455 | "\\pagestyle{empty}\n" | |
4456 | "")) | |
4457 | (linesdef (concat "\\def\\beginlines{" | |
4458 | "\\par\\begingroup\\nobreak\\medskip" | |
4459 | "\\parindent=0pt\n" | |
4460 | " \\kern1pt\\nobreak \\obeylines \\obeyspaces " | |
4461 | "\\everypar{\\strut}}\n" | |
4462 | "\\def\\endlines{" | |
4463 | "\\kern1pt\\endgroup\\medbreak\\noindent}\n")) | |
4464 | (titlecmd (format "\\newcommand{\\titlecmd}[1]{{%s #1}}\n" | |
4465 | outline-title-style)) | |
4466 | (labelcmd (format "\\newcommand{\\labelcmd}[1]{{%s #1}}\n" | |
4467 | outline-label-style)) | |
4468 | (headlinecmd (format "\\newcommand{\\headlinecmd}[1]{{%s #1}}\n" | |
4469 | outline-head-line-style)) | |
4470 | (bodylinecmd (format "\\newcommand{\\bodylinecmd}[1]{{%s #1}}\n" | |
4471 | outline-body-line-style)) | |
4472 | (setlength (format "%s%s%s%s" | |
4473 | "\\newlength{\\stepsize}\n" | |
4474 | "\\setlength{\\stepsize}{" | |
4475 | outline-indent | |
4476 | "}\n")) | |
4477 | (oneheadline (format "%s%s%s%s%s%s%s" | |
4478 | "\\newcommand{\\OneHeadLine}[3]{%\n" | |
4479 | "\\noindent%\n" | |
4480 | "\\hspace*{#2\\stepsize}%\n" | |
4481 | "\\labelcmd{#1}\\hspace*{.2cm}" | |
4482 | "\\headlinecmd{#3}\\\\[" | |
4483 | outline-line-skip | |
4484 | "]\n}\n")) | |
4485 | (onebodyline (format "%s%s%s%s%s%s" | |
4486 | "\\newcommand{\\OneBodyLine}[2]{%\n" | |
4487 | "\\noindent%\n" | |
4488 | "\\hspace*{#1\\stepsize}%\n" | |
4489 | "\\bodylinecmd{#2}\\\\[" | |
4490 | outline-line-skip | |
4491 | "]\n}\n")) | |
4492 | (begindoc "\\begin{document}\n\\begin{center}\n") | |
4493 | (title (format "%s%s%s%s" | |
4494 | "\\titlecmd{" | |
4495 | (outline-latex-verb-quote (if outline-title | |
4496 | (condition-case err | |
4497 | (eval outline-title) | |
9179616f | 4498 | ('error "<unnamed buffer>")) |
c567ac01 RS |
4499 | "Unnamed Outline")) |
4500 | "}\n" | |
4501 | "\\end{center}\n\n")) | |
4502 | (hsize "\\hsize = 7.5 true in\n") | |
4503 | (hoffset "\\hoffset = -1.5 true in\n") | |
4504 | (vspace "\\vspace{.1cm}\n\n")) | |
4505 | (insert (concat doc-style | |
4506 | page-numbering | |
4507 | titlecmd | |
4508 | labelcmd | |
4509 | headlinecmd | |
4510 | bodylinecmd | |
4511 | setlength | |
4512 | oneheadline | |
4513 | onebodyline | |
4514 | begindoc | |
4515 | title | |
4516 | hsize | |
4517 | hoffset | |
4518 | vspace) | |
4519 | ))) | |
4520 | ;;;_ > outline-insert-latex-trailer (buf) | |
4521 | (defun outline-insert-latex-trailer (buf) | |
4522 | "Insert concluding latex commands at point in BUFFER." | |
4523 | (set-buffer buf) | |
4524 | (insert "\n\\end{document}\n")) | |
4525 | ;;;_ > outline-latexify-one-item (depth prefix bullet text) | |
4526 | (defun outline-latexify-one-item (depth prefix bullet text) | |
19b84ba3 RS |
4527 | "Insert LaTeX commands for formatting one outline item. |
4528 | ||
9179616f | 4529 | Args are the topics numeric DEPTH, the header PREFIX lead string, the |
19b84ba3 | 4530 | BULLET string, and a list of TEXT strings for the body." |
c567ac01 RS |
4531 | (let* ((head-line (if text (car text))) |
4532 | (body-lines (cdr text)) | |
4533 | (curr-line) | |
4534 | body-content bop) | |
4535 | ; Do the head line: | |
eac9cf5f PJ |
4536 | (insert (concat "\\OneHeadLine{\\verb\1 " |
4537 | (outline-latex-verb-quote bullet) | |
4538 | "\1}{" | |
4539 | depth | |
4540 | "}{\\verb\1 " | |
4541 | (if head-line | |
4542 | (outline-latex-verb-quote head-line) | |
4543 | "") | |
4544 | "\1}\n")) | |
c567ac01 RS |
4545 | (if (not body-lines) |
4546 | nil | |
eac9cf5f PJ |
4547 | ;;(insert "\\beginlines\n") |
4548 | (insert "\\begin{verbatim}\n") | |
c567ac01 RS |
4549 | (while body-lines |
4550 | (setq curr-line (car body-lines)) | |
4551 | (if (and (not body-content) | |
4552 | (not (string-match "^\\s-*$" curr-line))) | |
4553 | (setq body-content t)) | |
4554 | ; Mangle any occurrences of | |
4555 | ; "\end{verbatim}" in text, | |
4556 | ; it's special: | |
4557 | (if (and body-content | |
4558 | (setq bop (string-match "\\end{verbatim}" curr-line))) | |
4559 | (setq curr-line (concat (substring curr-line 0 bop) | |
4560 | ">" | |
4561 | (substring curr-line bop)))) | |
eac9cf5f PJ |
4562 | ;;(insert "|" (car body-lines) "|") |
4563 | (insert curr-line) | |
c567ac01 | 4564 | (outline-latex-verbatim-quote-curr-line) |
eac9cf5f | 4565 | (insert "\n") |
c567ac01 RS |
4566 | (setq body-lines (cdr body-lines))) |
4567 | (if body-content | |
4568 | (setq body-content nil) | |
4569 | (forward-char -1) | |
eac9cf5f | 4570 | (insert "\\ ") |
c567ac01 | 4571 | (forward-char 1)) |
eac9cf5f PJ |
4572 | ;;(insert "\\endlines\n") |
4573 | (insert "\\end{verbatim}\n") | |
c567ac01 RS |
4574 | ))) |
4575 | ;;;_ > outline-latexify-exposed (arg &optional tobuf) | |
4576 | (defun outline-latexify-exposed (arg &optional tobuf) | |
9179616f | 4577 | "Format current topics exposed portions to TOBUF for latex processing. |
19b84ba3 RS |
4578 | TOBUF defaults to a buffer named the same as the current buffer, but |
4579 | with \"*\" prepended and \" latex-formed*\" appended. | |
c567ac01 RS |
4580 | |
4581 | With repeat count, copy the exposed portions of entire buffer." | |
4582 | ||
4583 | (interactive "P") | |
4584 | (if (not tobuf) | |
4585 | (setq tobuf | |
4586 | (get-buffer-create (concat "*" (buffer-name) " latexified*")))) | |
4587 | (let* ((start-pt (point)) | |
4588 | (beg (if arg (point-min) (outline-back-to-current-heading))) | |
4589 | (end (if arg (point-max) (outline-end-of-current-subtree))) | |
4590 | (buf (current-buffer))) | |
4591 | (set-buffer tobuf) | |
1977b8f6 | 4592 | (erase-buffer) |
c567ac01 RS |
4593 | (outline-insert-latex-header tobuf) |
4594 | (goto-char (point-max)) | |
4595 | (outline-process-exposed 'outline-latexify-one-item | |
4596 | beg | |
4597 | end | |
4598 | buf | |
4599 | tobuf) | |
4600 | (goto-char (point-max)) | |
4601 | (outline-insert-latex-trailer tobuf) | |
1977b8f6 | 4602 | (goto-char (point-min)) |
c567ac01 RS |
4603 | (pop-to-buffer buf) |
4604 | (goto-char start-pt))) | |
4605 | ||
9179616f | 4606 | ;;;_ #8 miscellaneous |
c567ac01 RS |
4607 | ;;;_ > outline-mark-topic () |
4608 | (defun outline-mark-topic () | |
4609 | "Put the region around topic currently containing point." | |
4610 | (interactive) | |
4611 | (beginning-of-line) | |
4612 | (outline-goto-prefix) | |
4613 | (push-mark (point)) | |
4614 | (outline-end-of-current-subtree) | |
4615 | (exchange-point-and-mark)) | |
4616 | ;;;_ > outlineify-sticky () | |
19b84ba3 RS |
4617 | ;; outlinify-sticky is correct spelling; provide this alias for sticklers: |
4618 | (defalias 'outlinify-sticky 'outlineify-sticky) | |
c567ac01 | 4619 | (defun outlineify-sticky (&optional arg) |
a0776d6b | 4620 | "Activate outline mode and establish file var so it is started subsequently. |
1977b8f6 | 4621 | |
19b84ba3 RS |
4622 | See doc-string for `outline-layout' and `outline-init' for details on |
4623 | setup for auto-startup." | |
4624 | ||
4625 | (interactive "P") | |
4626 | ||
4627 | (outline-mode t) | |
4628 | ||
4629 | (save-excursion | |
4630 | (goto-char (point-min)) | |
4631 | (if (looking-at outline-regexp) | |
4632 | t | |
4633 | (outline-open-topic 2) | |
eac9cf5f PJ |
4634 | (insert (concat "Dummy outline topic header - see" |
4635 | "`outline-mode' docstring: `^Hm'.")) | |
9179616f | 4636 | (forward-line 1) |
1977b8f6 | 4637 | (goto-char (point-max)) |
9179616f | 4638 | (open-line 1) |
19b84ba3 | 4639 | (outline-open-topic 0) |
eac9cf5f | 4640 | (insert "Local emacs vars.\n") |
19b84ba3 | 4641 | (outline-open-topic 1) |
eac9cf5f | 4642 | (insert "(`outline-layout' is for allout.el outline-mode)\n") |
19b84ba3 | 4643 | (outline-open-topic 0) |
eac9cf5f | 4644 | (insert "Local variables:\n") |
19b84ba3 | 4645 | (outline-open-topic 0) |
eac9cf5f | 4646 | (insert (format "outline-layout: %s\n" |
19b84ba3 | 4647 | (or outline-layout |
9179616f | 4648 | '(-1 : 0)))) |
19b84ba3 | 4649 | (outline-open-topic 0) |
eac9cf5f | 4650 | (insert "End:\n")))) |
c567ac01 | 4651 | ;;;_ > solicit-char-in-string (prompt string &optional do-defaulting) |
1977b8f6 | 4652 | (defun solicit-char-in-string (prompt string &optional do-defaulting) |
c567ac01 | 4653 | "Solicit (with first arg PROMPT) choice of a character from string STRING. |
1977b8f6 | 4654 | |
c567ac01 | 4655 | Optional arg DO-DEFAULTING indicates to accept empty input (CR)." |
1977b8f6 RS |
4656 | |
4657 | (let ((new-prompt prompt) | |
4658 | got) | |
4659 | ||
4660 | (while (not got) | |
4661 | (message "%s" new-prompt) | |
4662 | ||
4663 | ;; We do our own reading here, so we can circumvent, eg, special | |
9179616f | 4664 | ;; treatment for `?' character. (Oughta use minibuffer keymap instead.) |
1977b8f6 | 4665 | (setq got |
c567ac01 | 4666 | (char-to-string (let ((cursor-in-echo-area nil)) (read-char)))) |
1977b8f6 | 4667 | |
9179616f DL |
4668 | (setq got |
4669 | (cond ((string-match (regexp-quote got) string) got) | |
4670 | ((and do-defaulting (string= got "\r")) | |
4671 | ;; Return empty string to default: | |
4672 | "") | |
4673 | ((string= got "\C-g") (signal 'quit nil)) | |
4674 | (t | |
4675 | (setq new-prompt (concat prompt | |
4676 | got | |
4677 | " ...pick from: " | |
4678 | string | |
4679 | "")) | |
4680 | nil)))) | |
4681 | ;; got something out of loop - return it: | |
4682 | got) | |
1977b8f6 | 4683 | ) |
c567ac01 RS |
4684 | ;;;_ > regexp-sans-escapes (string) |
4685 | (defun regexp-sans-escapes (regexp &optional successive-backslashes) | |
4686 | "Return a copy of REGEXP with all character escapes stripped out. | |
19b84ba3 | 4687 | |
c567ac01 RS |
4688 | Representations of actual backslashes - '\\\\\\\\' - are left as a |
4689 | single backslash. | |
4690 | ||
4691 | Optional arg SUCCESSIVE-BACKSLASHES is used internally for recursion." | |
4692 | ||
4693 | (if (string= regexp "") | |
4694 | "" | |
4695 | ;; Set successive-backslashes to number if current char is | |
4696 | ;; backslash, or else to nil: | |
4697 | (setq successive-backslashes | |
4698 | (if (= (aref regexp 0) ?\\) | |
4699 | (if successive-backslashes (1+ successive-backslashes) 1) | |
4700 | nil)) | |
4701 | (if (or (not successive-backslashes) (= 2 successive-backslashes)) | |
4702 | ;; Include first char: | |
4703 | (concat (substring regexp 0 1) | |
4704 | (regexp-sans-escapes (substring regexp 1))) | |
4705 | ;; Exclude first char, but maintain count: | |
4706 | (regexp-sans-escapes (substring regexp 1) successive-backslashes)))) | |
9179616f DL |
4707 | ;;;_ > my-region-active-p () |
4708 | (defmacro my-region-active-p () | |
4709 | (if (fboundp 'region-active-p) | |
4710 | '(region-active-p) | |
4711 | 'mark-active)) | |
19b84ba3 | 4712 | ;;;_ - add-hook definition for divergent emacsen |
c567ac01 RS |
4713 | ;;;_ > add-hook (hook function &optional append) |
4714 | (if (not (fboundp 'add-hook)) | |
4715 | (defun add-hook (hook function &optional append) | |
19b84ba3 | 4716 | "Add to the value of HOOK the function FUNCTION unless already present. |
353e2ef2 | 4717 | \(It becomes the first hook on the list unless optional APPEND is non-nil, in |
c567ac01 RS |
4718 | which case it becomes the last). HOOK should be a symbol, and FUNCTION may be |
4719 | any valid function. HOOK's value should be a list of functions, not a single | |
4720 | function. If HOOK is void, it is first set to nil." | |
4721 | (or (boundp hook) (set hook nil)) | |
4722 | (or (if (consp function) | |
4723 | ;; Clever way to tell whether a given lambda-expression | |
4724 | ;; is equal to anything in the hook. | |
4725 | (let ((tail (assoc (cdr function) (symbol-value hook)))) | |
4726 | (equal function tail)) | |
4727 | (memq function (symbol-value hook))) | |
353e2ef2 | 4728 | (set hook |
c567ac01 RS |
4729 | (if append |
4730 | (nconc (symbol-value hook) (list function)) | |
4731 | (cons function (symbol-value hook))))))) | |
9179616f DL |
4732 | ;;;_ : my-mark-marker to accomodate divergent emacsen: |
4733 | (defun my-mark-marker (&optional force buffer) | |
4734 | "Accomodate the different signature for mark-marker across emacsen. | |
4735 | ||
4736 | GNU XEmacs takes two optional args, while mainline GNU Emacs does not, | |
4737 | so pass them along when appropriate." | |
4738 | (if (string-match " XEmacs " emacs-version) | |
4739 | (mark-marker force buffer) | |
4740 | (mark-marker))) | |
c567ac01 | 4741 | |
9179616f | 4742 | ;;;_ #9 Under development |
c567ac01 RS |
4743 | ;;;_ > outline-bullet-isearch (&optional bullet) |
4744 | (defun outline-bullet-isearch (&optional bullet) | |
9179616f | 4745 | "Isearch \(regexp) for topic with bullet BULLET." |
c567ac01 RS |
4746 | (interactive) |
4747 | (if (not bullet) | |
4748 | (setq bullet (solicit-char-in-string | |
4749 | "ISearch for topic with bullet: " | |
4750 | (regexp-sans-escapes outline-bullets-string)))) | |
353e2ef2 | 4751 | |
c567ac01 RS |
4752 | (let ((isearch-regexp t) |
4753 | (isearch-string (concat "^" | |
4754 | outline-header-prefix | |
4755 | "[ \t]*" | |
4756 | bullet))) | |
4757 | (isearch-repeat 'forward) | |
4758 | (isearch-mode t))) | |
19b84ba3 | 4759 | ;;;_ ? Re hooking up with isearch - use isearch-op-fun rather than |
353e2ef2 | 4760 | ;;; wrapping the isearch functions. |
1977b8f6 RS |
4761 | |
4762 | ;;;_* Local emacs vars. | |
19b84ba3 RS |
4763 | ;;; The following `outline-layout' local variable setting: |
4764 | ;;; - closes all topics from the first topic to just before the third-to-last, | |
4765 | ;;; - shows the children of the third to last (config vars) | |
4766 | ;;; - and the second to last (code section), | |
4767 | ;;; - and closes the last topic (this local-variables section). | |
4768 | ;;;Local variables: | |
4769 | ;;;outline-layout: (0 : -1 -1 0) | |
4770 | ;;;End: | |
4771 | ||
6a05d05f | 4772 | ;;; allout.el ends here |