Commit | Line | Data |
---|---|---|
f3611c70 | 1 | ;;; skeleton.el --- Lisp language extension for writing statement skeletons |
b578f267 | 2 | |
017d787a | 3 | ;; Copyright (C) 1993, 1994, 1995, 1996 by Free Software Foundation, Inc. |
ac59aed8 | 4 | |
3e910376 | 5 | ;; Author: Daniel Pfeiffer <occitan@esperanto.org> |
ac59aed8 | 6 | ;; Maintainer: FSF |
f3611c70 | 7 | ;; Keywords: extensions, abbrev, languages, tools |
ac59aed8 RS |
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 | |
b578f267 EN |
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. | |
ac59aed8 RS |
25 | |
26 | ;;; Commentary: | |
27 | ||
f3611c70 | 28 | ;; A very concise language extension for writing structured statement |
ac59aed8 RS |
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 | ||
f3611c70 | 36 | ;; page 1: statement skeleton language definition & interpreter |
ac59aed8 RS |
37 | ;; page 2: paired insertion |
38 | ;; page 3: mirror-mode, an example for setting up paired insertion | |
39 | ||
40 | ||
41 | (defvar skeleton-transformation nil | |
f3611c70 | 42 | "*If non-nil, function applied to literal strings before they are inserted. |
ac59aed8 RS |
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 | ||
017d787a RS |
52 | (defvar skeleton-autowrap t |
53 | "Controls wrapping behaviour of functions created with `define-skeleton'. | |
54 | When the region is visible (due to `transient-mark-mode' or marking a region | |
55 | with the mouse) and this is non-`nil' and the function was called without an | |
56 | explicit ARG, then the ARG defaults to -1, i.e. wrapping around the visible | |
57 | region. | |
58 | ||
59 | We will probably delete this variable in a future Emacs version | |
60 | unless we get a substantial number of complaints about the auto-wrap | |
61 | feature.") | |
ac59aed8 | 62 | |
d21584d6 SM |
63 | (defvar skeleton-end-newline t |
64 | "If non-nil, make sure that the skeleton inserted ends with a newline. | |
65 | This just influences the way the default `skeleton-end-hook' behaves.") | |
66 | ||
da6a884f KH |
67 | (defvar skeleton-end-hook |
68 | (lambda () | |
d21584d6 | 69 | (or (eolp) (not skeleton-end-newline) (newline-and-indent))) |
da6a884f | 70 | "Hook called at end of skeleton but before going to point of interest. |
d21584d6 SM |
71 | By default this moves out anything following to next line, |
72 | unless `skeleton-end-newline' is set to nil. | |
da6a884f KH |
73 | The variables `v1' and `v2' are still set when calling this.") |
74 | ||
75 | ||
f3611c70 KH |
76 | ;;;###autoload |
77 | (defvar skeleton-filter 'identity | |
017d787a | 78 | "Function for transforming a skeleton proxy's aliases' variable value.") |
f3611c70 | 79 | |
f3611c70 KH |
80 | (defvar skeleton-untabify t |
81 | "When non-`nil' untabifies when deleting backwards with element -ARG.") | |
82 | ||
4bfd70e9 KH |
83 | (defvar skeleton-newline-indent-rigidly nil |
84 | "When non-`nil', indent rigidly under current line for element `\\n'. | |
85 | Else use mode's `indent-line-function'.") | |
f3611c70 KH |
86 | |
87 | (defvar skeleton-further-elements () | |
88 | "A buffer-local varlist (see `let') of mode specific skeleton elements. | |
89 | These variables are bound while interpreting a skeleton. Their value may | |
90 | in turn be any valid skeleton element if they are themselves to be used as | |
91 | skeleton elements.") | |
92 | (make-variable-buffer-local 'skeleton-further-elements) | |
93 | ||
94 | ||
ac59aed8 RS |
95 | (defvar skeleton-subprompt |
96 | (substitute-command-keys | |
97 | "RET, \\<minibuffer-local-map>\\[abort-recursive-edit] or \\[help-command]") | |
f3611c70 KH |
98 | "*Replacement for %s in prompts of recursive subskeletons.") |
99 | ||
ac59aed8 | 100 | |
017d787a RS |
101 | (defvar skeleton-abbrev-cleanup nil |
102 | "Variable used to delete the character that led to abbrev expansion.") | |
ac59aed8 RS |
103 | |
104 | ||
105 | (defvar skeleton-debug nil | |
106 | "*If non-nil `define-skeleton' will override previous definition.") | |
107 | ||
157b7809 RS |
108 | (defvar skeleton-positions nil |
109 | "List of positions marked with @, after skeleton insertion. | |
110 | The list describes the most recent skeleton insertion, and its elements | |
111 | are integer buffer positions in the reverse order of the insertion order.") | |
a6dccb51 | 112 | |
4bfd70e9 KH |
113 | ;; reduce the number of compiler warnings |
114 | (defvar skeleton) | |
115 | (defvar skeleton-modified) | |
116 | (defvar skeleton-point) | |
117 | (defvar skeleton-regions) | |
ac59aed8 | 118 | |
ac59aed8 | 119 | ;;;###autoload |
f3611c70 | 120 | (defmacro define-skeleton (command documentation &rest skeleton) |
ac59aed8 RS |
121 | "Define a user-configurable COMMAND that enters a statement skeleton. |
122 | DOCUMENTATION is that of the command, while the variable of the same name, | |
f3611c70 KH |
123 | which contains the skeleton, has a documentation to that effect. |
124 | INTERACTOR and ELEMENT ... are as defined under `skeleton-insert'." | |
ac59aed8 | 125 | (if skeleton-debug |
f3611c70 | 126 | (set command skeleton)) |
773500ab | 127 | `(progn |
28895aea RS |
128 | (defun ,command (&optional str arg) |
129 | ,(concat documentation | |
130 | (if (string-match "\n\\>" documentation) | |
131 | "" "\n") | |
132 | "\n" | |
133 | "This is a skeleton command (see `skeleton-insert'). | |
134 | Normally the skeleton text is inserted at point, with nothing \"inside\". | |
135 | If there is a highlighted region, the skeleton text is wrapped | |
136 | around the region text. | |
137 | ||
138 | A prefix argument ARG says to wrap the skeleton around the next ARG words. | |
53d393c9 | 139 | A prefix argument of -1 says to wrap around region, even if not highlighted. |
28895aea | 140 | A prefix argument of zero says to wrap around zero words---that is, nothing. |
53d393c9 | 141 | This is a way of overriding the use of a highlighted region.") |
28895aea RS |
142 | (interactive "*P\nP") |
143 | (skeleton-proxy-new ',skeleton str arg)))) | |
f3611c70 | 144 | |
28895aea RS |
145 | ;;;###autoload |
146 | (defun skeleton-proxy-new (skeleton &optional str arg) | |
147 | "Insert skeleton defined by variable of same name (see `skeleton-insert'). | |
148 | Prefix ARG allows wrapping around words or regions (see `skeleton-insert'). | |
149 | If no ARG was given, but the region is visible, ARG defaults to -1 depending | |
150 | on `skeleton-autowrap'. An ARG of M-0 will prevent this just for once. | |
151 | This command can also be an abbrev expansion (3rd and 4th columns in | |
152 | \\[edit-abbrevs] buffer: \"\" command-name). | |
f3611c70 | 153 | |
28895aea RS |
154 | When called as a function, optional first argument STR may also be a string |
155 | which will be the value of `str' whereas the skeleton's interactor is then | |
156 | ignored." | |
157 | (interactive "*P\nP") | |
158 | (setq skeleton (funcall skeleton-filter skeleton)) | |
159 | (if (not skeleton) | |
160 | (if (memq this-command '(self-insert-command | |
161 | skeleton-pair-insert-maybe | |
162 | expand-abbrev)) | |
163 | (setq buffer-undo-list (primitive-undo 1 buffer-undo-list))) | |
164 | (skeleton-insert skeleton | |
165 | (if (setq skeleton-abbrev-cleanup | |
166 | (or (eq this-command 'self-insert-command) | |
167 | (eq this-command | |
168 | 'skeleton-pair-insert-maybe))) | |
169 | () | |
170 | ;; Pretend C-x a e passed its prefix arg to us | |
171 | (if (or arg current-prefix-arg) | |
172 | (prefix-numeric-value (or arg | |
173 | current-prefix-arg)) | |
174 | (and skeleton-autowrap | |
175 | (or (eq last-command 'mouse-drag-region) | |
176 | (and transient-mark-mode mark-active)) | |
177 | -1))) | |
178 | (if (stringp str) | |
179 | str)) | |
180 | (and skeleton-abbrev-cleanup | |
181 | (setq skeleton-abbrev-cleanup (point)) | |
182 | (add-hook 'post-command-hook 'skeleton-abbrev-cleanup nil t)))) | |
ac59aed8 | 183 | |
7a8f27db | 184 | ;; This command isn't meant to be called, only its aliases with meaningful |
f3611c70 KH |
185 | ;; names are. |
186 | ;;;###autoload | |
4bfd70e9 KH |
187 | (defun skeleton-proxy (&optional str arg) |
188 | "Insert skeleton defined by variable of same name (see `skeleton-insert'). | |
f3611c70 | 189 | Prefix ARG allows wrapping around words or regions (see `skeleton-insert'). |
ff85d4f3 | 190 | If no ARG was given, but the region is visible, ARG defaults to -1 depending |
017d787a | 191 | on `skeleton-autowrap'. An ARG of M-0 will prevent this just for once. |
f3611c70 | 192 | This command can also be an abbrev expansion (3rd and 4th columns in |
4bfd70e9 KH |
193 | \\[edit-abbrevs] buffer: \"\" command-name). |
194 | ||
195 | When called as a function, optional first argument STR may also be a string | |
196 | which will be the value of `str' whereas the skeleton's interactor is then | |
197 | ignored." | |
198 | (interactive "*P\nP") | |
f3611c70 | 199 | (let ((function (nth 1 (backtrace-frame 1)))) |
017d787a | 200 | (if (eq function 'nth) ; uncompiled Lisp function |
f3611c70 KH |
201 | (setq function (nth 1 (backtrace-frame 5))) |
202 | (if (eq function 'byte-code) ; tracing byte-compiled function | |
203 | (setq function (nth 1 (backtrace-frame 2))))) | |
204 | (if (not (setq function (funcall skeleton-filter (symbol-value function)))) | |
4bfd70e9 KH |
205 | (if (memq this-command '(self-insert-command |
206 | skeleton-pair-insert-maybe | |
207 | expand-abbrev)) | |
208 | (setq buffer-undo-list (primitive-undo 1 buffer-undo-list))) | |
f3611c70 | 209 | (skeleton-insert function |
f3611c70 KH |
210 | (if (setq skeleton-abbrev-cleanup |
211 | (or (eq this-command 'self-insert-command) | |
da6a884f KH |
212 | (eq this-command |
213 | 'skeleton-pair-insert-maybe))) | |
f3611c70 | 214 | () |
4bfd70e9 | 215 | ;; Pretend C-x a e passed its prefix arg to us |
f3611c70 KH |
216 | (if (or arg current-prefix-arg) |
217 | (prefix-numeric-value (or arg | |
017d787a RS |
218 | current-prefix-arg)) |
219 | (and skeleton-autowrap | |
220 | (or (eq last-command 'mouse-drag-region) | |
221 | (and transient-mark-mode mark-active)) | |
ff85d4f3 | 222 | -1))) |
4bfd70e9 KH |
223 | (if (stringp str) |
224 | str)) | |
017d787a RS |
225 | (and skeleton-abbrev-cleanup |
226 | (setq skeleton-abbrev-cleanup (point)) | |
227 | (add-hook 'post-command-hook 'skeleton-abbrev-cleanup nil t))))) | |
f3611c70 KH |
228 | |
229 | ||
230 | (defun skeleton-abbrev-cleanup (&rest list) | |
231 | "Value for `post-command-hook' to remove char that expanded abbrev." | |
232 | (if (integerp skeleton-abbrev-cleanup) | |
233 | (progn | |
234 | (delete-region skeleton-abbrev-cleanup (point)) | |
017d787a RS |
235 | (setq skeleton-abbrev-cleanup) |
236 | (remove-hook 'post-command-hook 'skeleton-abbrev-cleanup t)))) | |
ac59aed8 RS |
237 | |
238 | ||
239 | ;;;###autoload | |
93c36a6d | 240 | (defun skeleton-insert (skeleton &optional regions str) |
f3611c70 | 241 | "Insert the complex statement skeleton SKELETON describes very concisely. |
ac59aed8 | 242 | |
93c36a6d RS |
243 | With optional second argument REGIONS, wrap first interesting point |
244 | \(`_') in skeleton around next REGIONS words, if REGIONS is positive. | |
245 | If REGIONS is negative, wrap REGIONS preceding interregions into first | |
246 | REGIONS interesting positions \(successive `_'s) in skeleton. | |
f3611c70 | 247 | |
93c36a6d RS |
248 | An interregion is the stretch of text between two contiguous marked |
249 | points. If you marked A B C [] (where [] is the cursor) in | |
250 | alphabetical order, the 3 interregions are simply the last 3 regions. | |
251 | But if you marked B A [] C, the interregions are B-A, A-[], []-C. | |
252 | ||
253 | The optional third argument STR, if specified, is the value for the | |
254 | variable `str' within the skeleton. When this is non-nil, the | |
255 | interactor gets ignored, and this should be a valid skeleton element. | |
4bfd70e9 | 256 | |
f3611c70 KH |
257 | SKELETON is made up as (INTERACTOR ELEMENT ...). INTERACTOR may be nil if |
258 | not needed, a prompt-string or an expression for complex read functions. | |
ac59aed8 RS |
259 | |
260 | If ELEMENT is a string or a character it gets inserted (see also | |
261 | `skeleton-transformation'). Other possibilities are: | |
262 | ||
4bfd70e9 | 263 | \\n go to next line and indent according to mode |
3bb34a02 | 264 | _ interesting point, interregion here |
f3611c70 | 265 | > indent line (or interregion if > _) according to major mode |
157b7809 | 266 | @ add position to `skeleton-positions' |
f3611c70 KH |
267 | & do next ELEMENT if previous moved point |
268 | | do next ELEMENT if previous didn't move point | |
269 | -num delete num preceding characters (see `skeleton-untabify') | |
ac59aed8 RS |
270 | resume: skipped, continue here if quit is signaled |
271 | nil skipped | |
272 | ||
3bb34a02 SM |
273 | After termination, point will be positioned at the first occurrence |
274 | of _ or @ or at the end of the inserted text. | |
275 | ||
f3611c70 KH |
276 | Further elements can be defined via `skeleton-further-elements'. ELEMENT may |
277 | itself be a SKELETON with an INTERACTOR. The user is prompted repeatedly for | |
278 | different inputs. The SKELETON is processed as often as the user enters a | |
279 | non-empty string. \\[keyboard-quit] terminates skeleton insertion, but | |
280 | continues after `resume:' and positions at `_' if any. If INTERACTOR in such | |
281 | a subskeleton is a prompt-string which contains a \".. %s ..\" it is | |
93c36a6d | 282 | formatted with `skeleton-subprompt'. Such an INTERACTOR may also be a list of |
4bfd70e9 | 283 | strings with the subskeleton being repeated once for each string. |
ac59aed8 | 284 | |
93c36a6d | 285 | Quoted Lisp expressions are evaluated for their side-effects. |
017d787a | 286 | Other Lisp expressions are evaluated and the value treated as above. |
49168e73 | 287 | Note that expressions may not return `t' since this implies an |
f3611c70 KH |
288 | endless loop. Modes can define other symbols by locally setting them |
289 | to any valid skeleton element. The following local variables are | |
290 | available: | |
ac59aed8 | 291 | |
f3611c70 | 292 | str first time: read a string according to INTERACTOR |
ac59aed8 | 293 | then: insert previously read string once more |
f3611c70 | 294 | help help-form during interaction with the user or `nil' |
773500ab | 295 | input initial input (string or cons with index) while reading str |
017d787a | 296 | v1, v2 local variables for memorizing anything you want |
4bfd70e9 KH |
297 | |
298 | When done with skeleton, but before going back to `_'-point call | |
299 | `skeleton-end-hook' if that is non-`nil'." | |
93c36a6d RS |
300 | (let ((skeleton-regions regions)) |
301 | (and skeleton-regions | |
302 | (setq skeleton-regions | |
303 | (if (> skeleton-regions 0) | |
304 | (list (point-marker) | |
305 | (save-excursion (forward-word skeleton-regions) | |
306 | (point-marker))) | |
307 | (setq skeleton-regions (- skeleton-regions)) | |
308 | ;; copy skeleton-regions - 1 elements from `mark-ring' | |
309 | (let ((l1 (cons (mark-marker) mark-ring)) | |
310 | (l2 (list (point-marker)))) | |
311 | (while (and l1 (> skeleton-regions 0)) | |
312 | (setq l2 (cons (car l1) l2) | |
313 | skeleton-regions (1- skeleton-regions) | |
314 | l1 (cdr l1))) | |
315 | (sort l2 '<)))) | |
316 | (goto-char (car skeleton-regions)) | |
317 | (setq skeleton-regions (cdr skeleton-regions))) | |
318 | (let ((beg (point)) | |
319 | skeleton-modified skeleton-point resume: help input v1 v2) | |
320 | (setq skeleton-positions nil) | |
321 | (unwind-protect | |
322 | (eval `(let ,skeleton-further-elements | |
323 | (skeleton-internal-list skeleton str))) | |
324 | (run-hooks 'skeleton-end-hook) | |
325 | (sit-for 0) | |
326 | (or (pos-visible-in-window-p beg) | |
327 | (progn | |
328 | (goto-char beg) | |
329 | (recenter 0))) | |
330 | (if skeleton-point | |
331 | (goto-char skeleton-point)))))) | |
332 | ||
5b75ef8b | 333 | (defun skeleton-read (prompt &optional initial-input recursive) |
773500ab | 334 | "Function for reading a string from the minibuffer within skeletons. |
f8a5751b RS |
335 | |
336 | PROMPT must be a string or a form that evaluates to a string. | |
337 | It may contain a `%s' which will be replaced by `skeleton-subprompt'. | |
773500ab KH |
338 | If non-`nil' second arg INITIAL-INPUT or variable `input' is a string or |
339 | cons with index to insert before reading. If third arg RECURSIVE is non-`nil' | |
340 | i.e. we are handling the iterator of a subskeleton, returns empty string if | |
341 | user didn't modify input. | |
342 | While reading, the value of `minibuffer-help-form' is variable `help' if that | |
93c36a6d | 343 | is non-nil or a default string." |
da6a884f KH |
344 | (let ((minibuffer-help-form (or (if (boundp 'help) (symbol-value 'help)) |
345 | (if recursive "\ | |
ac59aed8 RS |
346 | As long as you provide input you will insert another subskeleton. |
347 | ||
348 | If you enter the empty string, the loop inserting subskeletons is | |
349 | left, and the current one is removed as far as it has been entered. | |
350 | ||
351 | If you quit, the current subskeleton is removed as far as it has been | |
352 | entered. No more of the skeleton will be inserted, except maybe for a | |
f3611c70 | 353 | syntactically necessary termination." |
93c36a6d | 354 | "\ |
f3611c70 | 355 | You are inserting a skeleton. Standard text gets inserted into the buffer |
da6a884f KH |
356 | automatically, and you are prompted to fill in the variable parts."))) |
357 | (eolp (eolp))) | |
358 | ;; since Emacs doesn't show main window's cursor, do something noticeable | |
359 | (or eolp | |
360 | (open-line 1)) | |
361 | (unwind-protect | |
93c36a6d RS |
362 | (setq prompt (if (stringp prompt) |
363 | (read-string (format prompt skeleton-subprompt) | |
364 | (setq initial-input | |
365 | (or initial-input | |
366 | (symbol-value 'input)))) | |
367 | (eval prompt))) | |
da6a884f KH |
368 | (or eolp |
369 | (delete-char 1)))) | |
773500ab | 370 | (if (and recursive |
93c36a6d RS |
371 | (or (null prompt) |
372 | (string= prompt "") | |
373 | (equal prompt initial-input) | |
374 | (equal prompt (car-safe initial-input)))) | |
ac59aed8 | 375 | (signal 'quit t) |
5b75ef8b | 376 | prompt)) |
ac59aed8 | 377 | |
4bfd70e9 | 378 | (defun skeleton-internal-list (skeleton &optional str recursive) |
f3611c70 KH |
379 | (let* ((start (save-excursion (beginning-of-line) (point))) |
380 | (column (current-column)) | |
381 | (line (buffer-substring start | |
382 | (save-excursion (end-of-line) (point)))) | |
383 | opoint) | |
4bfd70e9 KH |
384 | (or str |
385 | (setq str `(setq str (skeleton-read ',(car skeleton) nil ,recursive)))) | |
d21584d6 SM |
386 | (when (and (eq (car skeleton) '\n) |
387 | (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))) | |
388 | (setq skeleton (cons '> (cdr skeleton)))) | |
4bfd70e9 | 389 | (while (setq skeleton-modified (eq opoint (point)) |
773500ab KH |
390 | opoint (point) |
391 | skeleton (cdr skeleton)) | |
392 | (condition-case quit | |
393 | (skeleton-internal-1 (car skeleton)) | |
394 | (quit | |
395 | (if (eq (cdr quit) 'recursive) | |
4bfd70e9 KH |
396 | (setq recursive 'quit |
397 | skeleton (memq 'resume: skeleton)) | |
773500ab KH |
398 | ;; remove the subskeleton as far as it has been shown |
399 | ;; the subskeleton shouldn't have deleted outside current line | |
da6a884f | 400 | (end-of-line) |
773500ab KH |
401 | (delete-region start (point)) |
402 | (insert line) | |
403 | (move-to-column column) | |
404 | (if (cdr quit) | |
405 | (setq skeleton () | |
406 | recursive nil) | |
407 | (signal 'quit 'recursive))))))) | |
408 | ;; maybe continue loop or go on to next outer resume: section | |
409 | (if (eq recursive 'quit) | |
410 | (signal 'quit 'recursive) | |
411 | recursive)) | |
f3611c70 KH |
412 | |
413 | ||
414 | (defun skeleton-internal-1 (element &optional literal) | |
4bfd70e9 KH |
415 | (cond ((char-or-string-p element) |
416 | (if (and (integerp element) ; -num | |
417 | (< element 0)) | |
418 | (if skeleton-untabify | |
419 | (backward-delete-char-untabify (- element)) | |
420 | (delete-backward-char (- element))) | |
421 | (insert-before-markers (if (and skeleton-transformation | |
422 | (not literal)) | |
423 | (funcall skeleton-transformation element) | |
424 | element)))) | |
c93d212a | 425 | ((eq element '\n) ; actually (eq '\n 'n) |
d21584d6 SM |
426 | (cond |
427 | ((and skeleton-regions (eq (nth 1 skeleton) '_)) | |
428 | (or (eolp) (newline)) | |
429 | (indent-region (line-beginning-position) | |
430 | (car skeleton-regions) nil)) | |
3bb34a02 | 431 | ;; \n as last element only inserts \n if not at eol. |
d21584d6 SM |
432 | ((and (null (cdr skeleton)) (eolp)) nil) |
433 | (skeleton-newline-indent-rigidly | |
434 | (indent-to (prog1 (current-indentation) (newline)))) | |
435 | (t (newline) (indent-according-to-mode)))) | |
c93d212a | 436 | ((eq element '>) |
d21584d6 | 437 | (if (and skeleton-regions (eq (nth 1 skeleton) '_)) |
26736ce3 SM |
438 | (indent-region (line-beginning-position) |
439 | (car skeleton-regions) nil) | |
4bfd70e9 | 440 | (indent-according-to-mode))) |
c93d212a | 441 | ((eq element '_) |
4bfd70e9 | 442 | (if skeleton-regions |
f3611c70 | 443 | (progn |
4bfd70e9 | 444 | (goto-char (car skeleton-regions)) |
da6a884f KH |
445 | (setq skeleton-regions (cdr skeleton-regions)) |
446 | (and (<= (current-column) (current-indentation)) | |
447 | (eq (nth 1 skeleton) '\n) | |
448 | (end-of-line 0))) | |
4bfd70e9 KH |
449 | (or skeleton-point |
450 | (setq skeleton-point (point))))) | |
c93d212a | 451 | ((eq element '&) |
3bb34a02 | 452 | (when skeleton-modified (pop skeleton))) |
c93d212a | 453 | ((eq element '|) |
3bb34a02 | 454 | (unless skeleton-modified (pop skeleton))) |
a6dccb51 | 455 | ((eq element '@) |
02399da7 SM |
456 | (push (point) skeleton-positions) |
457 | (unless skeleton-point (setq skeleton-point (point)))) | |
4bfd70e9 | 458 | ((eq 'quote (car-safe element)) |
f3611c70 | 459 | (eval (nth 1 element))) |
4bfd70e9 KH |
460 | ((or (stringp (car-safe element)) |
461 | (consp (car-safe element))) | |
462 | (if (symbolp (car-safe (car element))) | |
463 | (while (skeleton-internal-list element nil t)) | |
464 | (setq literal (car element)) | |
465 | (while literal | |
466 | (skeleton-internal-list element (car literal)) | |
467 | (setq literal (cdr literal))))) | |
f3611c70 KH |
468 | ((null element)) |
469 | ((skeleton-internal-1 (eval element) t)))) | |
ac59aed8 | 470 | |
4bfd70e9 | 471 | |
f3611c70 | 472 | ;; Maybe belongs into simple.el or elsewhere |
ff85d4f3 RS |
473 | ;; ;###autoload |
474 | ;;; (define-skeleton local-variables-section | |
475 | ;; "Insert a local variables section. Use current comment syntax if any." | |
476 | ;; (completing-read "Mode: " obarray | |
477 | ;; (lambda (symbol) | |
478 | ;; (if (commandp symbol) | |
479 | ;; (string-match "-mode$" (symbol-name symbol)))) | |
480 | ;; t) | |
481 | ;; '(save-excursion | |
482 | ;; (if (re-search-forward page-delimiter nil t) | |
483 | ;; (error "Not on last page."))) | |
484 | ;; comment-start "Local Variables:" comment-end \n | |
485 | ;; comment-start "mode: " str | |
486 | ;; & -5 | '(kill-line 0) & -1 | comment-end \n | |
487 | ;; ( (completing-read (format "Variable, %s: " skeleton-subprompt) | |
488 | ;; obarray | |
489 | ;; (lambda (symbol) | |
490 | ;; (or (eq symbol 'eval) | |
491 | ;; (user-variable-p symbol))) | |
492 | ;; t) | |
493 | ;; comment-start str ": " | |
494 | ;; (read-from-minibuffer "Expression: " nil read-expression-map nil | |
495 | ;; 'read-expression-history) | _ | |
496 | ;; comment-end \n) | |
497 | ;; resume: | |
28895aea | 498 | ;; comment-start "End:" comment-end \n) |
ac59aed8 | 499 | \f |
bc35d5b3 | 500 | ;; Variables and command for automatically inserting pairs like () or "". |
ac59aed8 | 501 | |
bc35d5b3 | 502 | (defvar skeleton-pair nil |
ac59aed8 | 503 | "*If this is nil pairing is turned off, no matter what else is set. |
bc35d5b3 RS |
504 | Otherwise modes with `skeleton-pair-insert-maybe' on some keys |
505 | will attempt to insert pairs of matching characters.") | |
ac59aed8 RS |
506 | |
507 | ||
bc35d5b3 RS |
508 | (defvar skeleton-pair-on-word nil |
509 | "*If this is nil, paired insertion is inhibited before or inside a word.") | |
ac59aed8 RS |
510 | |
511 | ||
bc35d5b3 RS |
512 | (defvar skeleton-pair-filter (lambda ()) |
513 | "Attempt paired insertion if this function returns nil, before inserting. | |
ac59aed8 RS |
514 | This allows for context-sensitive checking whether pairing is appropriate.") |
515 | ||
516 | ||
bc35d5b3 RS |
517 | (defvar skeleton-pair-alist () |
518 | "An override alist of pairing partners matched against `last-command-char'. | |
519 | Each alist element, which looks like (ELEMENT ...), is passed to | |
520 | `skeleton-insert' with no interactor. Variable `str' does nothing. | |
ac59aed8 | 521 | |
f3611c70 | 522 | Elements might be (?` ?` _ \"''\"), (?\\( ? _ \" )\") or (?{ \\n > _ \\n ?} >).") |
ac59aed8 RS |
523 | |
524 | ||
ac59aed8 | 525 | ;;;###autoload |
bc35d5b3 | 526 | (defun skeleton-pair-insert-maybe (arg) |
ac59aed8 RS |
527 | "Insert the character you type ARG times. |
528 | ||
ff85d4f3 RS |
529 | With no ARG, if `skeleton-pair' is non-nil, pairing can occur. If the region |
530 | is visible the pair is wrapped around it depending on `skeleton-autowrap'. | |
531 | Else, if `skeleton-pair-on-word' is non-nil or we are not before or inside a | |
bc35d5b3 | 532 | word, and if `skeleton-pair-filter' returns nil, pairing is performed. |
ac59aed8 | 533 | |
bc35d5b3 | 534 | If a match is found in `skeleton-pair-alist', that is inserted, else |
ac59aed8 RS |
535 | the defaults are used. These are (), [], {}, <> and `' for the |
536 | symmetrical ones, and the same character twice for the others." | |
537 | (interactive "*P") | |
ff85d4f3 RS |
538 | (let ((mark (and skeleton-autowrap |
539 | (or (eq last-command 'mouse-drag-region) | |
540 | (and transient-mark-mode mark-active)))) | |
541 | (skeleton-end-hook)) | |
542 | (if (or arg | |
543 | (not skeleton-pair) | |
544 | (and (not mark) | |
545 | (or overwrite-mode | |
546 | (if (not skeleton-pair-on-word) (looking-at "\\w")) | |
547 | (funcall skeleton-pair-filter)))) | |
548 | (self-insert-command (prefix-numeric-value arg)) | |
549 | (setq last-command-char (logand last-command-char 255)) | |
550 | (or skeleton-abbrev-cleanup | |
551 | (skeleton-insert | |
552 | (cons nil (or (assq last-command-char skeleton-pair-alist) | |
553 | (assq last-command-char '((?( _ ?)) | |
554 | (?[ _ ?]) | |
555 | (?{ _ ?}) | |
556 | (?< _ ?>) | |
557 | (?` _ ?'))) | |
558 | `(,last-command-char _ ,last-command-char))) | |
559 | (if mark -1)))))) | |
ac59aed8 RS |
560 | |
561 | \f | |
ff85d4f3 RS |
562 | ;; A more serious example can be found in sh-script.el |
563 | ;;; (defun mirror-mode () | |
017d787a RS |
564 | ;; "This major mode is an amusing little example of paired insertion. |
565 | ;;All printable characters do a paired self insert, while the other commands | |
566 | ;;work normally." | |
567 | ;; (interactive) | |
568 | ;; (kill-all-local-variables) | |
ff85d4f3 RS |
569 | ;; (make-local-variable 'skeleton-pair) |
570 | ;; (make-local-variable 'skeleton-pair-on-word) | |
571 | ;; (make-local-variable 'skeleton-pair-filter) | |
572 | ;; (make-local-variable 'skeleton-pair-alist) | |
017d787a RS |
573 | ;; (setq major-mode 'mirror-mode |
574 | ;; mode-name "Mirror" | |
ff85d4f3 | 575 | ;; skeleton-pair-on-word t |
017d787a | 576 | ;; ;; in the middle column insert one or none if odd window-width |
ff85d4f3 RS |
577 | ;; skeleton-pair-filter (lambda () |
578 | ;; (if (>= (current-column) | |
579 | ;; (/ (window-width) 2)) | |
580 | ;; ;; insert both on next line | |
581 | ;; (next-line 1) | |
582 | ;; ;; insert one or both? | |
583 | ;; (= (* 2 (1+ (current-column))) | |
584 | ;; (window-width)))) | |
017d787a | 585 | ;; ;; mirror these the other way round as well |
ff85d4f3 RS |
586 | ;; skeleton-pair-alist '((?) _ ?() |
587 | ;; (?] _ ?[) | |
588 | ;; (?} _ ?{) | |
589 | ;; (?> _ ?<) | |
590 | ;; (?/ _ ?\\) | |
591 | ;; (?\\ _ ?/) | |
592 | ;; (?` ?` _ "''") | |
593 | ;; (?' ?' _ "``")) | |
017d787a | 594 | ;; ;; in this mode we exceptionally ignore the user, else it's no fun |
ff85d4f3 RS |
595 | ;; skeleton-pair t) |
596 | ;; (let ((map (make-vector 256 'skeleton-pair-insert-maybe)) | |
597 | ;; (i 0)) | |
598 | ;; (use-local-map `(keymap ,map)) | |
599 | ;; (while (< i ? ) | |
600 | ;; (aset map i nil) | |
601 | ;; (aset map (+ i 128) nil) | |
017d787a RS |
602 | ;; (setq i (1+ i)))) |
603 | ;; (run-hooks 'mirror-mode-hook)) | |
ac59aed8 | 604 | |
2aea64fb RS |
605 | (provide 'skeleton) |
606 | ||
ac59aed8 | 607 | ;; skeleton.el ends here |