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