Mercurial > emacs
annotate lisp/skeleton.el @ 15197:a97349b06c2c
Comment changes.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Thu, 09 May 1996 23:21:54 +0000 |
parents | 4a757fa8b402 |
children | 4b82998394ae |
rev | line source |
---|---|
12501 | 1 ;;; skeleton.el --- Lisp language extension for writing statement skeletons |
14169 | 2 |
12501 | 3 ;; Copyright (C) 1993, 1994, 1995 by Free Software Foundation, Inc. |
6463 | 4 |
12501 | 5 ;; Author: Daniel.Pfeiffer@Informatik.START.dbp.de, fax (+49 69) 7588-2389 |
6463 | 6 ;; Maintainer: FSF |
12501 | 7 ;; Keywords: extensions, abbrev, languages, tools |
6463 | 8 |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
14169 | 22 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 ;; Boston, MA 02111-1307, USA. | |
6463 | 25 |
26 ;;; Commentary: | |
27 | |
12501 | 28 ;; A very concise language extension for writing structured statement |
6463 | 29 ;; skeleton insertion commands for programming language modes. This |
30 ;; originated in shell-script mode and was applied to ada-mode's | |
31 ;; commands which shrunk to one third. And these commands are now | |
32 ;; user configurable. | |
33 | |
34 ;;; Code: | |
35 | |
12501 | 36 ;; page 1: statement skeleton language definition & interpreter |
6463 | 37 ;; page 2: paired insertion |
38 ;; page 3: mirror-mode, an example for setting up paired insertion | |
39 | |
40 | |
41 (defvar skeleton-transformation nil | |
12501 | 42 "*If non-nil, function applied to literal strings before they are inserted. |
6463 | 43 It should take strings and characters and return them transformed, or nil |
44 which means no transformation. | |
45 Typical examples might be `upcase' or `capitalize'.") | |
46 | |
47 ; this should be a fourth argument to defvar | |
48 (put 'skeleton-transformation 'variable-interactive | |
49 "aTransformation function: ") | |
50 | |
51 | |
52 | |
13390
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
53 (defvar skeleton-end-hook |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
54 (lambda () |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
55 (or (eolp) (newline-and-indent))) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
56 "Hook called at end of skeleton but before going to point of interest. |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
57 By default this moves out anything following to next line. |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
58 The variables `v1' and `v2' are still set when calling this.") |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
59 |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
60 |
12501 | 61 ;;;###autoload |
62 (defvar skeleton-filter 'identity | |
63 "Function for transforming a skeleton-proxy's aliases' variable value.") | |
64 | |
65 (defvar skeleton-untabify t | |
66 "When non-`nil' untabifies when deleting backwards with element -ARG.") | |
67 | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
68 (defvar skeleton-newline-indent-rigidly nil |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
69 "When non-`nil', indent rigidly under current line for element `\\n'. |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
70 Else use mode's `indent-line-function'.") |
12501 | 71 |
72 (defvar skeleton-further-elements () | |
73 "A buffer-local varlist (see `let') of mode specific skeleton elements. | |
74 These variables are bound while interpreting a skeleton. Their value may | |
75 in turn be any valid skeleton element if they are themselves to be used as | |
76 skeleton elements.") | |
77 (make-variable-buffer-local 'skeleton-further-elements) | |
78 | |
79 | |
6463 | 80 (defvar skeleton-subprompt |
81 (substitute-command-keys | |
82 "RET, \\<minibuffer-local-map>\\[abort-recursive-edit] or \\[help-command]") | |
12501 | 83 "*Replacement for %s in prompts of recursive subskeletons.") |
6463 | 84 |
85 | |
12501 | 86 (defvar skeleton-abbrev-cleanup nil) |
87 | |
6463 | 88 |
89 (defvar skeleton-debug nil | |
90 "*If non-nil `define-skeleton' will override previous definition.") | |
91 | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
92 ;; reduce the number of compiler warnings |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
93 (defvar skeleton) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
94 (defvar skeleton-modified) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
95 (defvar skeleton-point) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
96 (defvar skeleton-regions) |
6463 | 97 |
98 ;;;###autoload | |
12501 | 99 (defmacro define-skeleton (command documentation &rest skeleton) |
6463 | 100 "Define a user-configurable COMMAND that enters a statement skeleton. |
101 DOCUMENTATION is that of the command, while the variable of the same name, | |
12501 | 102 which contains the skeleton, has a documentation to that effect. |
103 INTERACTOR and ELEMENT ... are as defined under `skeleton-insert'." | |
6463 | 104 (if skeleton-debug |
12501 | 105 (set command skeleton)) |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
106 `(progn |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
107 (defvar ,command ',skeleton ,documentation) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
108 (defalias ',command 'skeleton-proxy))) |
6463 | 109 |
110 | |
111 | |
12501 | 112 ;; This command isn't meant to be called, only it's aliases with meaningful |
113 ;; names are. | |
6463 | 114 ;;;###autoload |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
115 (defun skeleton-proxy (&optional str arg) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
116 "Insert skeleton defined by variable of same name (see `skeleton-insert'). |
12501 | 117 Prefix ARG allows wrapping around words or regions (see `skeleton-insert'). |
118 This command can also be an abbrev expansion (3rd and 4th columns in | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
119 \\[edit-abbrevs] buffer: \"\" command-name). |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
120 |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
121 When called as a function, optional first argument STR may also be a string |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
122 which will be the value of `str' whereas the skeleton's interactor is then |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
123 ignored." |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
124 (interactive "*P\nP") |
12501 | 125 (let ((function (nth 1 (backtrace-frame 1)))) |
126 (if (eq function 'nth) ; uncompiled lisp function | |
127 (setq function (nth 1 (backtrace-frame 5))) | |
128 (if (eq function 'byte-code) ; tracing byte-compiled function | |
129 (setq function (nth 1 (backtrace-frame 2))))) | |
130 (if (not (setq function (funcall skeleton-filter (symbol-value function)))) | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
131 (if (memq this-command '(self-insert-command |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
132 skeleton-pair-insert-maybe |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
133 expand-abbrev)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
134 (setq buffer-undo-list (primitive-undo 1 buffer-undo-list))) |
12501 | 135 (skeleton-insert function |
136 (if (setq skeleton-abbrev-cleanup | |
137 (or (eq this-command 'self-insert-command) | |
13390
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
138 (eq this-command |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
139 'skeleton-pair-insert-maybe))) |
12501 | 140 () |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
141 ;; Pretend C-x a e passed its prefix arg to us |
12501 | 142 (if (or arg current-prefix-arg) |
143 (prefix-numeric-value (or arg | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
144 current-prefix-arg)))) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
145 (if (stringp str) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
146 str)) |
12501 | 147 (if skeleton-abbrev-cleanup |
148 (setq deferred-action-list t | |
149 deferred-action-function 'skeleton-abbrev-cleanup | |
150 skeleton-abbrev-cleanup (point)))))) | |
151 | |
152 | |
153 (defun skeleton-abbrev-cleanup (&rest list) | |
154 "Value for `post-command-hook' to remove char that expanded abbrev." | |
155 (if (integerp skeleton-abbrev-cleanup) | |
156 (progn | |
157 (delete-region skeleton-abbrev-cleanup (point)) | |
158 (setq deferred-action-list () | |
159 deferred-action-function nil | |
160 skeleton-abbrev-cleanup nil)))) | |
161 | |
162 | |
163 ;;;###autoload | |
13390
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
164 (defun skeleton-insert (skeleton &optional skeleton-regions str) |
12501 | 165 "Insert the complex statement skeleton SKELETON describes very concisely. |
6463 | 166 |
12501 | 167 With optional third REGIONS wrap first interesting point (`_') in skeleton |
168 around next REGIONS words, if REGIONS is positive. If REGIONS is negative, | |
169 wrap REGIONS preceding interregions into first REGIONS interesting positions | |
170 \(successive `_'s) in skeleton. An interregion is the stretch of text between | |
171 two contiguous marked points. If you marked A B C [] (where [] is the cursor) | |
172 in alphabetical order, the 3 interregions are simply the last 3 regions. But | |
173 if you marked B A [] C, the interregions are B-A, A-[], []-C. | |
174 | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
175 Optional fourth STR is the value for the variable `str' within the skeleton. |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
176 When this is non-`nil' the interactor gets ignored, and this should be a valid |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
177 skeleton element. |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
178 |
12501 | 179 SKELETON is made up as (INTERACTOR ELEMENT ...). INTERACTOR may be nil if |
180 not needed, a prompt-string or an expression for complex read functions. | |
6463 | 181 |
182 If ELEMENT is a string or a character it gets inserted (see also | |
183 `skeleton-transformation'). Other possibilities are: | |
184 | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
185 \\n go to next line and indent according to mode |
12501 | 186 _ interesting point, interregion here, point after termination |
187 > indent line (or interregion if > _) according to major mode | |
188 & do next ELEMENT if previous moved point | |
189 | do next ELEMENT if previous didn't move point | |
190 -num delete num preceding characters (see `skeleton-untabify') | |
6463 | 191 resume: skipped, continue here if quit is signaled |
192 nil skipped | |
193 | |
12501 | 194 Further elements can be defined via `skeleton-further-elements'. ELEMENT may |
195 itself be a SKELETON with an INTERACTOR. The user is prompted repeatedly for | |
196 different inputs. The SKELETON is processed as often as the user enters a | |
197 non-empty string. \\[keyboard-quit] terminates skeleton insertion, but | |
198 continues after `resume:' and positions at `_' if any. If INTERACTOR in such | |
199 a subskeleton is a prompt-string which contains a \".. %s ..\" it is | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
200 formatted with `skeleton-subprompt'. Such an INTERACTOR may also a list of |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
201 strings with the subskeleton being repeated once for each string. |
6463 | 202 |
12501 | 203 Quoted lisp-expressions are evaluated evaluated for their side-effect. |
6463 | 204 Other lisp-expressions are evaluated and the value treated as above. |
14006 | 205 Note that expressions may not return `t' since this implies an |
12501 | 206 endless loop. Modes can define other symbols by locally setting them |
207 to any valid skeleton element. The following local variables are | |
208 available: | |
6463 | 209 |
12501 | 210 str first time: read a string according to INTERACTOR |
6463 | 211 then: insert previously read string once more |
12501 | 212 help help-form during interaction with the user or `nil' |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
213 input initial input (string or cons with index) while reading str |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
214 v1, v2 local variables for memorising anything you want |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
215 |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
216 When done with skeleton, but before going back to `_'-point call |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
217 `skeleton-end-hook' if that is non-`nil'." |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
218 (and skeleton-regions |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
219 (setq skeleton-regions |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
220 (if (> skeleton-regions 0) |
12501 | 221 (list (point-marker) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
222 (save-excursion (forward-word skeleton-regions) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
223 (point-marker))) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
224 (setq skeleton-regions (- skeleton-regions)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
225 ;; copy skeleton-regions - 1 elements from `mark-ring' |
12501 | 226 (let ((l1 (cons (mark-marker) mark-ring)) |
227 (l2 (list (point-marker)))) | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
228 (while (and l1 (> skeleton-regions 0)) |
12501 | 229 (setq l2 (cons (car l1) l2) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
230 skeleton-regions (1- skeleton-regions) |
12501 | 231 l1 (cdr l1))) |
232 (sort l2 '<)))) | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
233 (goto-char (car skeleton-regions)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
234 (setq skeleton-regions (cdr skeleton-regions))) |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
235 (let ((beg (point)) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
236 skeleton-modified skeleton-point resume: help input v1 v2) |
12501 | 237 (unwind-protect |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
238 (eval `(let ,skeleton-further-elements |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
239 (skeleton-internal-list skeleton str))) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
240 (run-hooks 'skeleton-end-hook) |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
241 (sit-for 0) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
242 (or (pos-visible-in-window-p beg) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
243 (progn |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
244 (goto-char beg) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
245 (recenter 0))) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
246 (if skeleton-point |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
247 (goto-char skeleton-point))))) |
6463 | 248 |
12501 | 249 (defun skeleton-read (str &optional initial-input recursive) |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
250 "Function for reading a string from the minibuffer within skeletons. |
12501 | 251 PROMPT may contain a `%s' which will be replaced by `skeleton-subprompt'. |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
252 If non-`nil' second arg INITIAL-INPUT or variable `input' is a string or |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
253 cons with index to insert before reading. If third arg RECURSIVE is non-`nil' |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
254 i.e. we are handling the iterator of a subskeleton, returns empty string if |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
255 user didn't modify input. |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
256 While reading, the value of `minibuffer-help-form' is variable `help' if that |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
257 is non-`nil' or a default string." |
13390
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
258 (let ((minibuffer-help-form (or (if (boundp 'help) (symbol-value 'help)) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
259 (if recursive "\ |
6463 | 260 As long as you provide input you will insert another subskeleton. |
261 | |
262 If you enter the empty string, the loop inserting subskeletons is | |
263 left, and the current one is removed as far as it has been entered. | |
264 | |
265 If you quit, the current subskeleton is removed as far as it has been | |
266 entered. No more of the skeleton will be inserted, except maybe for a | |
12501 | 267 syntactically necessary termination." |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
268 "\ |
12501 | 269 You are inserting a skeleton. Standard text gets inserted into the buffer |
13390
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
270 automatically, and you are prompted to fill in the variable parts."))) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
271 (eolp (eolp))) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
272 ;; since Emacs doesn't show main window's cursor, do something noticeable |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
273 (or eolp |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
274 (open-line 1)) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
275 (unwind-protect |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
276 (setq str (if (stringp str) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
277 (read-string (format str skeleton-subprompt) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
278 (setq initial-input |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
279 (or initial-input |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
280 (symbol-value 'input)))) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
281 (eval str))) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
282 (or eolp |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
283 (delete-char 1)))) |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
284 (if (and recursive |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
285 (or (null str) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
286 (string= str "") |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
287 (equal str initial-input) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
288 (equal str (car-safe initial-input)))) |
6463 | 289 (signal 'quit t) |
290 str)) | |
291 | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
292 (defun skeleton-internal-list (skeleton &optional str recursive) |
12501 | 293 (let* ((start (save-excursion (beginning-of-line) (point))) |
294 (column (current-column)) | |
295 (line (buffer-substring start | |
296 (save-excursion (end-of-line) (point)))) | |
297 opoint) | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
298 (or str |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
299 (setq str `(setq str (skeleton-read ',(car skeleton) nil ,recursive)))) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
300 (while (setq skeleton-modified (eq opoint (point)) |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
301 opoint (point) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
302 skeleton (cdr skeleton)) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
303 (condition-case quit |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
304 (skeleton-internal-1 (car skeleton)) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
305 (quit |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
306 (if (eq (cdr quit) 'recursive) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
307 (setq recursive 'quit |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
308 skeleton (memq 'resume: skeleton)) |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
309 ;; remove the subskeleton as far as it has been shown |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
310 ;; the subskeleton shouldn't have deleted outside current line |
13390
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
311 (end-of-line) |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
312 (delete-region start (point)) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
313 (insert line) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
314 (move-to-column column) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
315 (if (cdr quit) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
316 (setq skeleton () |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
317 recursive nil) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
318 (signal 'quit 'recursive))))))) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
319 ;; maybe continue loop or go on to next outer resume: section |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
320 (if (eq recursive 'quit) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
321 (signal 'quit 'recursive) |
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
322 recursive)) |
6463 | 323 |
324 | |
12501 | 325 (defun skeleton-internal-1 (element &optional literal) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
326 (cond ((char-or-string-p element) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
327 (if (and (integerp element) ; -num |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
328 (< element 0)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
329 (if skeleton-untabify |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
330 (backward-delete-char-untabify (- element)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
331 (delete-backward-char (- element))) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
332 (insert-before-markers (if (and skeleton-transformation |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
333 (not literal)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
334 (funcall skeleton-transformation element) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
335 element)))) |
7393
e4a565cee722
(mirror-mode): Commented out.
Richard M. Stallman <rms@gnu.org>
parents:
6463
diff
changeset
|
336 ((eq element '\n) ; actually (eq '\n 'n) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
337 (if (and skeleton-regions |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
338 (eq (nth 1 skeleton) '_)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
339 (progn |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
340 (or (eolp) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
341 (newline)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
342 (indent-region (point) (car skeleton-regions) nil)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
343 (if skeleton-newline-indent-rigidly |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
344 (indent-to (prog1 (current-indentation) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
345 (newline))) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
346 (newline) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
347 (indent-according-to-mode)))) |
7393
e4a565cee722
(mirror-mode): Commented out.
Richard M. Stallman <rms@gnu.org>
parents:
6463
diff
changeset
|
348 ((eq element '>) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
349 (if (and skeleton-regions |
12501 | 350 (eq (nth 1 skeleton) '_)) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
351 (indent-region (point) (car skeleton-regions) nil) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
352 (indent-according-to-mode))) |
7393
e4a565cee722
(mirror-mode): Commented out.
Richard M. Stallman <rms@gnu.org>
parents:
6463
diff
changeset
|
353 ((eq element '_) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
354 (if skeleton-regions |
12501 | 355 (progn |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
356 (goto-char (car skeleton-regions)) |
13390
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
357 (setq skeleton-regions (cdr skeleton-regions)) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
358 (and (<= (current-column) (current-indentation)) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
359 (eq (nth 1 skeleton) '\n) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
360 (end-of-line 0))) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
361 (or skeleton-point |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
362 (setq skeleton-point (point))))) |
7393
e4a565cee722
(mirror-mode): Commented out.
Richard M. Stallman <rms@gnu.org>
parents:
6463
diff
changeset
|
363 ((eq element '&) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
364 (if skeleton-modified |
12501 | 365 (setq skeleton (cdr skeleton)))) |
7393
e4a565cee722
(mirror-mode): Commented out.
Richard M. Stallman <rms@gnu.org>
parents:
6463
diff
changeset
|
366 ((eq element '|) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
367 (or skeleton-modified |
12501 | 368 (setq skeleton (cdr skeleton)))) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
369 ((eq 'quote (car-safe element)) |
12501 | 370 (eval (nth 1 element))) |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
371 ((or (stringp (car-safe element)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
372 (consp (car-safe element))) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
373 (if (symbolp (car-safe (car element))) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
374 (while (skeleton-internal-list element nil t)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
375 (setq literal (car element)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
376 (while literal |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
377 (skeleton-internal-list element (car literal)) |
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
378 (setq literal (cdr literal))))) |
12501 | 379 ((null element)) |
380 ((skeleton-internal-1 (eval element) t)))) | |
381 | |
12886
4029ded28f9d
(skeleton-newline-indent-rigidly): New variable.
Karl Heuer <kwzh@gnu.org>
parents:
12862
diff
changeset
|
382 |
12501 | 383 ;; Maybe belongs into simple.el or elsewhere |
6463 | 384 |
12501 | 385 (define-skeleton local-variables-section |
386 "Insert a local variables section. Use current comment syntax if any." | |
387 () | |
388 '(save-excursion | |
389 (if (re-search-forward page-delimiter nil t) | |
390 (error "Not on last page."))) | |
391 comment-start "Local Variables:" comment-end \n | |
392 comment-start "mode: " | |
393 (completing-read "Mode: " obarray | |
394 (lambda (symbol) | |
395 (if (commandp symbol) | |
396 (string-match "-mode$" (symbol-name symbol)))) | |
397 t) | |
398 & -5 | '(kill-line 0) & -1 | comment-end \n | |
399 ( (completing-read (format "Variable, %s: " skeleton-subprompt) | |
400 obarray | |
401 (lambda (symbol) | |
402 (or (eq symbol 'eval) | |
403 (user-variable-p symbol))) | |
404 t) | |
405 comment-start str ": " | |
406 (read-from-minibuffer "Expression: " nil read-expression-map nil | |
407 'read-expression-history) | _ | |
408 comment-end \n) | |
409 resume: | |
410 comment-start "End:" comment-end) | |
6463 | 411 |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
412 ;; Variables and command for automatically inserting pairs like () or "". |
6463 | 413 |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
414 (defvar skeleton-pair nil |
6463 | 415 "*If this is nil pairing is turned off, no matter what else is set. |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
416 Otherwise modes with `skeleton-pair-insert-maybe' on some keys |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
417 will attempt to insert pairs of matching characters.") |
6463 | 418 |
419 | |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
420 (defvar skeleton-pair-on-word nil |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
421 "*If this is nil, paired insertion is inhibited before or inside a word.") |
6463 | 422 |
423 | |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
424 (defvar skeleton-pair-filter (lambda ()) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
425 "Attempt paired insertion if this function returns nil, before inserting. |
6463 | 426 This allows for context-sensitive checking whether pairing is appropriate.") |
427 | |
428 | |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
429 (defvar skeleton-pair-alist () |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
430 "An override alist of pairing partners matched against `last-command-char'. |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
431 Each alist element, which looks like (ELEMENT ...), is passed to |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
432 `skeleton-insert' with no interactor. Variable `str' does nothing. |
6463 | 433 |
12501 | 434 Elements might be (?` ?` _ \"''\"), (?\\( ? _ \" )\") or (?{ \\n > _ \\n ?} >).") |
6463 | 435 |
436 | |
437 ;;;###autoload | |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
438 (defun skeleton-pair-insert-maybe (arg) |
6463 | 439 "Insert the character you type ARG times. |
440 | |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
441 With no ARG, if `skeleton-pair' is non-nil, and if |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
442 `skeleton-pair-on-word' is non-nil or we are not before or inside a |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
443 word, and if `skeleton-pair-filter' returns nil, pairing is performed. |
6463 | 444 |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
445 If a match is found in `skeleton-pair-alist', that is inserted, else |
6463 | 446 the defaults are used. These are (), [], {}, <> and `' for the |
447 symmetrical ones, and the same character twice for the others." | |
448 (interactive "*P") | |
449 (if (or arg | |
12862
9d994b0faaa3
(skeleton-pair-insert-maybe): Plain insert in Ovwrt mode
Karl Heuer <kwzh@gnu.org>
parents:
12619
diff
changeset
|
450 overwrite-mode |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
451 (not skeleton-pair) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
452 (if (not skeleton-pair-on-word) (looking-at "\\w")) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
453 (funcall skeleton-pair-filter)) |
6463 | 454 (self-insert-command (prefix-numeric-value arg)) |
12501 | 455 (self-insert-command 1) |
456 (if skeleton-abbrev-cleanup | |
457 () | |
458 ;; (preceding-char) is stripped of any Meta-stuff in last-command-char | |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
459 (if (setq arg (assq (preceding-char) skeleton-pair-alist)) |
13390
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
460 ;; typed char is inserted (car is no real interactor) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
461 (let (skeleton-end-hook) |
333a77bb4ae8
(skeleton-end-hook): Now defvared and responsible for
Karl Heuer <kwzh@gnu.org>
parents:
12886
diff
changeset
|
462 (skeleton-insert arg)) |
12501 | 463 (save-excursion |
464 (insert (or (cdr (assq (preceding-char) | |
465 '((?( . ?)) | |
466 (?[ . ?]) | |
467 (?{ . ?}) | |
468 (?< . ?>) | |
469 (?` . ?')))) | |
470 last-command-char))))))) | |
6463 | 471 |
472 | |
12619
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
473 ;;; ;; A more serious example can be found in sh-script.el |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
474 ;;; ;; The quote before (defun prevents this from being byte-compiled. |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
475 ;;;(defun mirror-mode () |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
476 ;;; "This major mode is an amusing little example of paired insertion. |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
477 ;;;All printable characters do a paired self insert, while the other commands |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
478 ;;;work normally." |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
479 ;;; (interactive) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
480 ;;; (kill-all-local-variables) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
481 ;;; (make-local-variable 'pair) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
482 ;;; (make-local-variable 'pair-on-word) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
483 ;;; (make-local-variable 'pair-filter) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
484 ;;; (make-local-variable 'pair-alist) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
485 ;;; (setq major-mode 'mirror-mode |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
486 ;;; mode-name "Mirror" |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
487 ;;; pair-on-word t |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
488 ;;; ;; in the middle column insert one or none if odd window-width |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
489 ;;; pair-filter (lambda () |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
490 ;;; (if (>= (current-column) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
491 ;;; (/ (window-width) 2)) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
492 ;;; ;; insert both on next line |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
493 ;;; (next-line 1) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
494 ;;; ;; insert one or both? |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
495 ;;; (= (* 2 (1+ (current-column))) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
496 ;;; (window-width)))) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
497 ;;; ;; mirror these the other way round as well |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
498 ;;; pair-alist '((?) _ ?() |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
499 ;;; (?] _ ?[) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
500 ;;; (?} _ ?{) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
501 ;;; (?> _ ?<) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
502 ;;; (?/ _ ?\\) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
503 ;;; (?\\ _ ?/) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
504 ;;; (?` ?` _ "''") |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
505 ;;; (?' ?' _ "``")) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
506 ;;; ;; in this mode we exceptionally ignore the user, else it's no fun |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
507 ;;; pair t) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
508 ;;; (let ((map (make-keymap)) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
509 ;;; (i ? )) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
510 ;;; (use-local-map map) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
511 ;;; (setq map (car (cdr map))) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
512 ;;; (while (< i ?\^?) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
513 ;;; (aset map i 'skeleton-pair-insert-maybe) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
514 ;;; (setq i (1+ i)))) |
9d4a4e914215
(local-variables-section): Delete autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
12501
diff
changeset
|
515 ;;; (run-hooks 'mirror-mode-hook)) |
6463 | 516 |
14724 | 517 (provide 'skeleton) |
518 | |
6463 | 519 ;; skeleton.el ends here |