Commit | Line | Data |
---|---|---|
1a5ed76f | 1 | ;;; skeleton.el --- Lisp language extension for writing statement skeletons -*- coding: utf-8 -*- |
b578f267 | 2 | |
c90f2757 | 3 | ;; Copyright (C) 1993, 1994, 1995, 1996, 2001, 2002, 2003, |
5df4f04c | 4 | ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. |
ac59aed8 | 5 | |
3e910376 | 6 | ;; Author: Daniel Pfeiffer <occitan@esperanto.org> |
ac59aed8 | 7 | ;; Maintainer: FSF |
f3611c70 | 8 | ;; Keywords: extensions, abbrev, languages, tools |
ac59aed8 RS |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
eb3fa2cf | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
ac59aed8 | 13 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
ac59aed8 RS |
16 | |
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
ac59aed8 RS |
24 | |
25 | ;;; Commentary: | |
26 | ||
f3611c70 | 27 | ;; A very concise language extension for writing structured statement |
ac59aed8 RS |
28 | ;; skeleton insertion commands for programming language modes. This |
29 | ;; originated in shell-script mode and was applied to ada-mode's | |
30 | ;; commands which shrunk to one third. And these commands are now | |
31 | ;; user configurable. | |
32 | ||
33 | ;;; Code: | |
34 | ||
f3611c70 | 35 | ;; page 1: statement skeleton language definition & interpreter |
ac59aed8 RS |
36 | ;; page 2: paired insertion |
37 | ;; page 3: mirror-mode, an example for setting up paired insertion | |
38 | ||
39 | ||
5c741ceb | 40 | (defvar skeleton-transformation-function 'identity |
f3611c70 | 41 | "*If non-nil, function applied to literal strings before they are inserted. |
ac59aed8 RS |
42 | It should take strings and characters and return them transformed, or nil |
43 | which means no transformation. | |
44 | Typical examples might be `upcase' or `capitalize'.") | |
5c741ceb | 45 | (defvaralias 'skeleton-transformation 'skeleton-transformation-function) |
ac59aed8 RS |
46 | |
47 | ; this should be a fourth argument to defvar | |
5c741ceb | 48 | (put 'skeleton-transformation-function 'variable-interactive |
ac59aed8 RS |
49 | "aTransformation function: ") |
50 | ||
51 | ||
017d787a | 52 | (defvar skeleton-autowrap t |
fb607ff1 | 53 | "Controls wrapping behavior of functions created with `define-skeleton'. |
017d787a | 54 | When the region is visible (due to `transient-mark-mode' or marking a region |
4ba4c353 | 55 | with the mouse) and this is non-nil and the function was called without an |
017d787a RS |
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 | 76 | ;;;###autoload |
5c741ceb | 77 | (defvar skeleton-filter-function 'identity |
017d787a | 78 | "Function for transforming a skeleton proxy's aliases' variable value.") |
5c741ceb | 79 | (defvaralias 'skeleton-filter 'skeleton-filter-function) |
f3611c70 | 80 | |
f3611c70 | 81 | (defvar skeleton-untabify t |
4ba4c353 | 82 | "When non-nil untabifies when deleting backwards with element -ARG.") |
f3611c70 | 83 | |
4bfd70e9 | 84 | (defvar skeleton-newline-indent-rigidly nil |
4ba4c353 | 85 | "When non-nil, indent rigidly under current line for element `\\n'. |
4bfd70e9 | 86 | Else use mode's `indent-line-function'.") |
f3611c70 KH |
87 | |
88 | (defvar skeleton-further-elements () | |
89 | "A buffer-local varlist (see `let') of mode specific skeleton elements. | |
90 | These variables are bound while interpreting a skeleton. Their value may | |
91 | in turn be any valid skeleton element if they are themselves to be used as | |
92 | skeleton elements.") | |
93 | (make-variable-buffer-local 'skeleton-further-elements) | |
94 | ||
95 | ||
ac59aed8 RS |
96 | (defvar skeleton-subprompt |
97 | (substitute-command-keys | |
98 | "RET, \\<minibuffer-local-map>\\[abort-recursive-edit] or \\[help-command]") | |
f3611c70 KH |
99 | "*Replacement for %s in prompts of recursive subskeletons.") |
100 | ||
ac59aed8 | 101 | |
ac59aed8 RS |
102 | (defvar skeleton-debug nil |
103 | "*If non-nil `define-skeleton' will override previous definition.") | |
104 | ||
157b7809 RS |
105 | (defvar skeleton-positions nil |
106 | "List of positions marked with @, after skeleton insertion. | |
107 | The list describes the most recent skeleton insertion, and its elements | |
108 | are integer buffer positions in the reverse order of the insertion order.") | |
a6dccb51 | 109 | |
4bfd70e9 KH |
110 | ;; reduce the number of compiler warnings |
111 | (defvar skeleton) | |
112 | (defvar skeleton-modified) | |
113 | (defvar skeleton-point) | |
114 | (defvar skeleton-regions) | |
ac59aed8 | 115 | |
7076c5cd SM |
116 | (def-edebug-spec skeleton-edebug-spec |
117 | ([&or null stringp (stringp &rest stringp) [[¬ atom] def-form]] | |
118 | &rest &or "n" "_" "-" ">" "@" "&" "!" "resume:" | |
119 | ("quote" def-form) skeleton-edebug-spec def-form)) | |
ac59aed8 | 120 | ;;;###autoload |
f3611c70 | 121 | (defmacro define-skeleton (command documentation &rest skeleton) |
ac59aed8 | 122 | "Define a user-configurable COMMAND that enters a statement skeleton. |
8fb7ff73 SM |
123 | DOCUMENTATION is that of the command. |
124 | SKELETON is as defined under `skeleton-insert'." | |
7076c5cd | 125 | (declare (debug (&define name stringp skeleton-edebug-spec))) |
ac59aed8 | 126 | (if skeleton-debug |
f3611c70 | 127 | (set command skeleton)) |
773500ab | 128 | `(progn |
8fb7ff73 SM |
129 | ;; Tell self-insert-command that this function, if called by an |
130 | ;; abbrev, should cause the self-insert to be skipped. | |
131 | (put ',command 'no-self-insert t) | |
28895aea RS |
132 | (defun ,command (&optional str arg) |
133 | ,(concat documentation | |
8fb7ff73 | 134 | (if (string-match "\n\\'" documentation) |
28895aea RS |
135 | "" "\n") |
136 | "\n" | |
137 | "This is a skeleton command (see `skeleton-insert'). | |
138 | Normally the skeleton text is inserted at point, with nothing \"inside\". | |
139 | If there is a highlighted region, the skeleton text is wrapped | |
140 | around the region text. | |
141 | ||
142 | A prefix argument ARG says to wrap the skeleton around the next ARG words. | |
53d393c9 | 143 | A prefix argument of -1 says to wrap around region, even if not highlighted. |
28895aea | 144 | A prefix argument of zero says to wrap around zero words---that is, nothing. |
53d393c9 | 145 | This is a way of overriding the use of a highlighted region.") |
28895aea RS |
146 | (interactive "*P\nP") |
147 | (skeleton-proxy-new ',skeleton str arg)))) | |
f3611c70 | 148 | |
28895aea RS |
149 | ;;;###autoload |
150 | (defun skeleton-proxy-new (skeleton &optional str arg) | |
8fb7ff73 | 151 | "Insert SKELETON. |
28895aea RS |
152 | Prefix ARG allows wrapping around words or regions (see `skeleton-insert'). |
153 | If no ARG was given, but the region is visible, ARG defaults to -1 depending | |
154 | on `skeleton-autowrap'. An ARG of M-0 will prevent this just for once. | |
155 | This command can also be an abbrev expansion (3rd and 4th columns in | |
156 | \\[edit-abbrevs] buffer: \"\" command-name). | |
f3611c70 | 157 | |
afdff50e | 158 | Optional second argument STR may also be a string which will be the value |
8fb7ff73 | 159 | of `str' whereas the skeleton's interactor is then ignored." |
5c741ceb | 160 | (skeleton-insert (funcall skeleton-filter-function skeleton) |
8fb7ff73 SM |
161 | ;; Pretend C-x a e passed its prefix arg to us |
162 | (if (or arg current-prefix-arg) | |
163 | (prefix-numeric-value (or arg | |
164 | current-prefix-arg)) | |
165 | (and skeleton-autowrap | |
166 | (or (eq last-command 'mouse-drag-region) | |
167 | (and transient-mark-mode mark-active)) | |
b532266d SM |
168 | ;; Deactivate the mark, in case one of the |
169 | ;; elements of the skeleton is sensitive | |
170 | ;; to such situations (e.g. it is itself a | |
171 | ;; skeleton). | |
172 | (progn (deactivate-mark) | |
173 | -1))) | |
8fb7ff73 SM |
174 | (if (stringp str) |
175 | str)) | |
176 | ;; Return non-nil to tell expand-abbrev that expansion has happened. | |
177 | ;; Otherwise the no-self-insert is ignored. | |
178 | t) | |
ac59aed8 | 179 | |
ac59aed8 | 180 | ;;;###autoload |
93c36a6d | 181 | (defun skeleton-insert (skeleton &optional regions str) |
f3611c70 | 182 | "Insert the complex statement skeleton SKELETON describes very concisely. |
ac59aed8 | 183 | |
93c36a6d RS |
184 | With optional second argument REGIONS, wrap first interesting point |
185 | \(`_') in skeleton around next REGIONS words, if REGIONS is positive. | |
186 | If REGIONS is negative, wrap REGIONS preceding interregions into first | |
187 | REGIONS interesting positions \(successive `_'s) in skeleton. | |
f3611c70 | 188 | |
93c36a6d RS |
189 | An interregion is the stretch of text between two contiguous marked |
190 | points. If you marked A B C [] (where [] is the cursor) in | |
191 | alphabetical order, the 3 interregions are simply the last 3 regions. | |
192 | But if you marked B A [] C, the interregions are B-A, A-[], []-C. | |
193 | ||
194 | The optional third argument STR, if specified, is the value for the | |
195 | variable `str' within the skeleton. When this is non-nil, the | |
196 | interactor gets ignored, and this should be a valid skeleton element. | |
4bfd70e9 | 197 | |
f3611c70 KH |
198 | SKELETON is made up as (INTERACTOR ELEMENT ...). INTERACTOR may be nil if |
199 | not needed, a prompt-string or an expression for complex read functions. | |
ac59aed8 RS |
200 | |
201 | If ELEMENT is a string or a character it gets inserted (see also | |
5c741ceb | 202 | `skeleton-transformation-function'). Other possibilities are: |
ac59aed8 | 203 | |
4bfd70e9 | 204 | \\n go to next line and indent according to mode |
3bb34a02 | 205 | _ interesting point, interregion here |
b7d05949 JB |
206 | - interesting point, no interregion interaction, overrides |
207 | interesting point set by _ | |
f3611c70 | 208 | > indent line (or interregion if > _) according to major mode |
157b7809 | 209 | @ add position to `skeleton-positions' |
4837b516 GM |
210 | & do next ELEMENT if previous moved point |
211 | | do next ELEMENT if previous didn't move point | |
f3611c70 | 212 | -num delete num preceding characters (see `skeleton-untabify') |
ac59aed8 RS |
213 | resume: skipped, continue here if quit is signaled |
214 | nil skipped | |
215 | ||
b7d05949 JB |
216 | After termination, point will be positioned at the last occurrence of - |
217 | or at the first occurrence of _ or at the end of the inserted text. | |
3bb34a02 | 218 | |
f3611c70 KH |
219 | Further elements can be defined via `skeleton-further-elements'. ELEMENT may |
220 | itself be a SKELETON with an INTERACTOR. The user is prompted repeatedly for | |
221 | different inputs. The SKELETON is processed as often as the user enters a | |
222 | non-empty string. \\[keyboard-quit] terminates skeleton insertion, but | |
223 | continues after `resume:' and positions at `_' if any. If INTERACTOR in such | |
224 | a subskeleton is a prompt-string which contains a \".. %s ..\" it is | |
93c36a6d | 225 | formatted with `skeleton-subprompt'. Such an INTERACTOR may also be a list of |
4bfd70e9 | 226 | strings with the subskeleton being repeated once for each string. |
ac59aed8 | 227 | |
93c36a6d | 228 | Quoted Lisp expressions are evaluated for their side-effects. |
017d787a | 229 | Other Lisp expressions are evaluated and the value treated as above. |
4ba4c353 | 230 | Note that expressions may not return t since this implies an |
f3611c70 KH |
231 | endless loop. Modes can define other symbols by locally setting them |
232 | to any valid skeleton element. The following local variables are | |
233 | available: | |
ac59aed8 | 234 | |
f3611c70 | 235 | str first time: read a string according to INTERACTOR |
ac59aed8 | 236 | then: insert previously read string once more |
4ba4c353 | 237 | help help-form during interaction with the user or nil |
773500ab | 238 | input initial input (string or cons with index) while reading str |
017d787a | 239 | v1, v2 local variables for memorizing anything you want |
4bfd70e9 KH |
240 | |
241 | When done with skeleton, but before going back to `_'-point call | |
4ba4c353 | 242 | `skeleton-end-hook' if that is non-nil." |
93c36a6d RS |
243 | (let ((skeleton-regions regions)) |
244 | (and skeleton-regions | |
245 | (setq skeleton-regions | |
246 | (if (> skeleton-regions 0) | |
25ab24bc | 247 | (list (copy-marker (point) t) |
93c36a6d RS |
248 | (save-excursion (forward-word skeleton-regions) |
249 | (point-marker))) | |
250 | (setq skeleton-regions (- skeleton-regions)) | |
251 | ;; copy skeleton-regions - 1 elements from `mark-ring' | |
252 | (let ((l1 (cons (mark-marker) mark-ring)) | |
25ab24bc | 253 | (l2 (list (copy-marker (point) t)))) |
93c36a6d | 254 | (while (and l1 (> skeleton-regions 0)) |
25ab24bc SM |
255 | (push (copy-marker (pop l1) t) l2) |
256 | (setq skeleton-regions (1- skeleton-regions))) | |
93c36a6d RS |
257 | (sort l2 '<)))) |
258 | (goto-char (car skeleton-regions)) | |
259 | (setq skeleton-regions (cdr skeleton-regions))) | |
260 | (let ((beg (point)) | |
261 | skeleton-modified skeleton-point resume: help input v1 v2) | |
262 | (setq skeleton-positions nil) | |
263 | (unwind-protect | |
264 | (eval `(let ,skeleton-further-elements | |
265 | (skeleton-internal-list skeleton str))) | |
266 | (run-hooks 'skeleton-end-hook) | |
267 | (sit-for 0) | |
268 | (or (pos-visible-in-window-p beg) | |
269 | (progn | |
270 | (goto-char beg) | |
271 | (recenter 0))) | |
272 | (if skeleton-point | |
273 | (goto-char skeleton-point)))))) | |
274 | ||
5b75ef8b | 275 | (defun skeleton-read (prompt &optional initial-input recursive) |
773500ab | 276 | "Function for reading a string from the minibuffer within skeletons. |
f8a5751b RS |
277 | |
278 | PROMPT must be a string or a form that evaluates to a string. | |
279 | It may contain a `%s' which will be replaced by `skeleton-subprompt'. | |
4ba4c353 JB |
280 | If non-nil second arg INITIAL-INPUT or variable `input' is a string or |
281 | cons with index to insert before reading. If third arg RECURSIVE is non-nil | |
773500ab KH |
282 | i.e. we are handling the iterator of a subskeleton, returns empty string if |
283 | user didn't modify input. | |
284 | While reading, the value of `minibuffer-help-form' is variable `help' if that | |
93c36a6d | 285 | is non-nil or a default string." |
da6a884f KH |
286 | (let ((minibuffer-help-form (or (if (boundp 'help) (symbol-value 'help)) |
287 | (if recursive "\ | |
ac59aed8 RS |
288 | As long as you provide input you will insert another subskeleton. |
289 | ||
290 | If you enter the empty string, the loop inserting subskeletons is | |
291 | left, and the current one is removed as far as it has been entered. | |
292 | ||
293 | If you quit, the current subskeleton is removed as far as it has been | |
294 | entered. No more of the skeleton will be inserted, except maybe for a | |
f3611c70 | 295 | syntactically necessary termination." |
93c36a6d | 296 | "\ |
f3611c70 | 297 | You are inserting a skeleton. Standard text gets inserted into the buffer |
da6a884f KH |
298 | automatically, and you are prompted to fill in the variable parts."))) |
299 | (eolp (eolp))) | |
300 | ;; since Emacs doesn't show main window's cursor, do something noticeable | |
301 | (or eolp | |
302 | (open-line 1)) | |
303 | (unwind-protect | |
93c36a6d RS |
304 | (setq prompt (if (stringp prompt) |
305 | (read-string (format prompt skeleton-subprompt) | |
306 | (setq initial-input | |
307 | (or initial-input | |
308 | (symbol-value 'input)))) | |
309 | (eval prompt))) | |
da6a884f KH |
310 | (or eolp |
311 | (delete-char 1)))) | |
773500ab | 312 | (if (and recursive |
93c36a6d RS |
313 | (or (null prompt) |
314 | (string= prompt "") | |
315 | (equal prompt initial-input) | |
316 | (equal prompt (car-safe initial-input)))) | |
ac59aed8 | 317 | (signal 'quit t) |
5b75ef8b | 318 | prompt)) |
ac59aed8 | 319 | |
4bfd70e9 | 320 | (defun skeleton-internal-list (skeleton &optional str recursive) |
f3611c70 KH |
321 | (let* ((start (save-excursion (beginning-of-line) (point))) |
322 | (column (current-column)) | |
25ab24bc | 323 | (line (buffer-substring start (line-end-position))) |
f3611c70 | 324 | opoint) |
4bfd70e9 KH |
325 | (or str |
326 | (setq str `(setq str (skeleton-read ',(car skeleton) nil ,recursive)))) | |
da8249b4 | 327 | (when (and (eq (cadr skeleton) '\n) (not recursive) |
25ab24bc | 328 | (save-excursion (skip-chars-backward " \t") (bolp))) |
5b83f9c0 | 329 | (setq skeleton (cons nil (cons '> (cddr skeleton))))) |
4bfd70e9 | 330 | (while (setq skeleton-modified (eq opoint (point)) |
773500ab KH |
331 | opoint (point) |
332 | skeleton (cdr skeleton)) | |
333 | (condition-case quit | |
8fb7ff73 | 334 | (skeleton-internal-1 (car skeleton) nil recursive) |
773500ab KH |
335 | (quit |
336 | (if (eq (cdr quit) 'recursive) | |
4bfd70e9 KH |
337 | (setq recursive 'quit |
338 | skeleton (memq 'resume: skeleton)) | |
25ab24bc SM |
339 | ;; Remove the subskeleton as far as it has been shown |
340 | ;; the subskeleton shouldn't have deleted outside current line. | |
da6a884f | 341 | (end-of-line) |
773500ab KH |
342 | (delete-region start (point)) |
343 | (insert line) | |
344 | (move-to-column column) | |
345 | (if (cdr quit) | |
346 | (setq skeleton () | |
347 | recursive nil) | |
348 | (signal 'quit 'recursive))))))) | |
349 | ;; maybe continue loop or go on to next outer resume: section | |
350 | (if (eq recursive 'quit) | |
351 | (signal 'quit 'recursive) | |
352 | recursive)) | |
f3611c70 | 353 | |
8fb7ff73 | 354 | (defun skeleton-internal-1 (element &optional literal recursive) |
25ab24bc | 355 | (cond |
db08e41d | 356 | ((or (integerp element) (stringp element)) |
25ab24bc SM |
357 | (if (and (integerp element) ; -num |
358 | (< element 0)) | |
359 | (if skeleton-untabify | |
360 | (backward-delete-char-untabify (- element)) | |
361 | (delete-backward-char (- element))) | |
8fb7ff73 | 362 | (insert (if (not literal) |
5c741ceb | 363 | (funcall skeleton-transformation-function element) |
25ab24bc SM |
364 | element)))) |
365 | ((or (eq element '\n) ; actually (eq '\n 'n) | |
366 | ;; The sequence `> \n' is handled specially so as to indent the first | |
367 | ;; line after inserting the newline (to get the proper indentation). | |
368 | (and (eq element '>) (eq (nth 1 skeleton) '\n) (pop skeleton))) | |
369 | (let ((pos (if (eq element '>) (point)))) | |
370 | (cond | |
371 | ((and skeleton-regions (eq (nth 1 skeleton) '_)) | |
372 | (or (eolp) (newline)) | |
373 | (if pos (save-excursion (goto-char pos) (indent-according-to-mode))) | |
374 | (indent-region (line-beginning-position) | |
375 | (car skeleton-regions) nil)) | |
376 | ;; \n as last element only inserts \n if not at eol. | |
da8249b4 | 377 | ((and (null (cdr skeleton)) (not recursive) (eolp)) |
25ab24bc SM |
378 | (if pos (indent-according-to-mode))) |
379 | (skeleton-newline-indent-rigidly | |
380 | (let ((pt (point))) | |
381 | (newline) | |
382 | (indent-to (save-excursion | |
383 | (goto-char pt) | |
384 | (if pos (indent-according-to-mode)) | |
385 | (current-indentation))))) | |
386 | (t (if pos (reindent-then-newline-and-indent) | |
387 | (newline) | |
388 | (indent-according-to-mode)))))) | |
389 | ((eq element '>) | |
390 | (if (and skeleton-regions (eq (nth 1 skeleton) '_)) | |
391 | (indent-region (line-beginning-position) | |
392 | (car skeleton-regions) nil) | |
393 | (indent-according-to-mode))) | |
394 | ((eq element '_) | |
395 | (if skeleton-regions | |
396 | (progn | |
397 | (goto-char (pop skeleton-regions)) | |
398 | (and (<= (current-column) (current-indentation)) | |
399 | (eq (nth 1 skeleton) '\n) | |
8fb7ff73 SM |
400 | (end-of-line 0))) |
401 | (or skeleton-point | |
402 | (setq skeleton-point (point))))) | |
403 | ((eq element '-) | |
404 | (setq skeleton-point (point))) | |
405 | ((eq element '&) | |
406 | (when skeleton-modified (pop skeleton))) | |
407 | ((eq element '|) | |
408 | (unless skeleton-modified (pop skeleton))) | |
409 | ((eq element '@) | |
410 | (push (point) skeleton-positions)) | |
411 | ((eq 'quote (car-safe element)) | |
412 | (eval (nth 1 element))) | |
c93992b3 SM |
413 | ((and (consp element) |
414 | (or (stringp (car element)) (listp (car element)))) | |
415 | ;; Don't forget: `symbolp' is also true for nil. | |
25ab24bc | 416 | (if (symbolp (car-safe (car element))) |
c93992b3 SM |
417 | (while (and (skeleton-internal-list element nil t) |
418 | ;; If the interactor is nil, don't infinite loop. | |
419 | (car element))) | |
25ab24bc SM |
420 | (setq literal (car element)) |
421 | (while literal | |
422 | (skeleton-internal-list element (car literal)) | |
423 | (setq literal (cdr literal))))) | |
424 | ((null element)) | |
8fb7ff73 | 425 | (t (skeleton-internal-1 (eval element) t recursive)))) |
25ab24bc | 426 | \f |
f3611c70 | 427 | ;; Maybe belongs into simple.el or elsewhere |
25ab24bc SM |
428 | ;; ;;;###autoload |
429 | ;; (define-skeleton local-variables-section | |
ff85d4f3 RS |
430 | ;; "Insert a local variables section. Use current comment syntax if any." |
431 | ;; (completing-read "Mode: " obarray | |
432 | ;; (lambda (symbol) | |
433 | ;; (if (commandp symbol) | |
434 | ;; (string-match "-mode$" (symbol-name symbol)))) | |
435 | ;; t) | |
436 | ;; '(save-excursion | |
437 | ;; (if (re-search-forward page-delimiter nil t) | |
1cd7adc6 | 438 | ;; (error "Not on last page"))) |
ff85d4f3 RS |
439 | ;; comment-start "Local Variables:" comment-end \n |
440 | ;; comment-start "mode: " str | |
441 | ;; & -5 | '(kill-line 0) & -1 | comment-end \n | |
442 | ;; ( (completing-read (format "Variable, %s: " skeleton-subprompt) | |
443 | ;; obarray | |
444 | ;; (lambda (symbol) | |
445 | ;; (or (eq symbol 'eval) | |
446 | ;; (user-variable-p symbol))) | |
447 | ;; t) | |
448 | ;; comment-start str ": " | |
449 | ;; (read-from-minibuffer "Expression: " nil read-expression-map nil | |
450 | ;; 'read-expression-history) | _ | |
451 | ;; comment-end \n) | |
452 | ;; resume: | |
28895aea | 453 | ;; comment-start "End:" comment-end \n) |
ac59aed8 | 454 | \f |
bc35d5b3 | 455 | ;; Variables and command for automatically inserting pairs like () or "". |
ac59aed8 | 456 | |
bc35d5b3 | 457 | (defvar skeleton-pair nil |
ac59aed8 | 458 | "*If this is nil pairing is turned off, no matter what else is set. |
bc35d5b3 RS |
459 | Otherwise modes with `skeleton-pair-insert-maybe' on some keys |
460 | will attempt to insert pairs of matching characters.") | |
ac59aed8 RS |
461 | |
462 | ||
bc35d5b3 RS |
463 | (defvar skeleton-pair-on-word nil |
464 | "*If this is nil, paired insertion is inhibited before or inside a word.") | |
ac59aed8 RS |
465 | |
466 | ||
5c741ceb | 467 | (defvar skeleton-pair-filter-function (lambda () nil) |
bc35d5b3 | 468 | "Attempt paired insertion if this function returns nil, before inserting. |
ac59aed8 RS |
469 | This allows for context-sensitive checking whether pairing is appropriate.") |
470 | ||
471 | ||
bc35d5b3 | 472 | (defvar skeleton-pair-alist () |
8989a920 | 473 | "An override alist of pairing partners matched against `last-command-event'. |
bc35d5b3 RS |
474 | Each alist element, which looks like (ELEMENT ...), is passed to |
475 | `skeleton-insert' with no interactor. Variable `str' does nothing. | |
ac59aed8 | 476 | |
f3611c70 | 477 | Elements might be (?` ?` _ \"''\"), (?\\( ? _ \" )\") or (?{ \\n > _ \\n ?} >).") |
ac59aed8 | 478 | |
c93992b3 SM |
479 | (defvar skeleton-pair-default-alist '((?( _ ?)) (?\)) |
480 | (?[ _ ?]) (?\]) | |
481 | (?{ _ ?}) (?\}) | |
482 | (?< _ ?>) (?\>) | |
1a5ed76f | 483 | (?« _ ?») (?\») |
c93992b3 | 484 | (?` _ ?'))) |
ac59aed8 | 485 | |
ac59aed8 | 486 | ;;;###autoload |
bc35d5b3 | 487 | (defun skeleton-pair-insert-maybe (arg) |
ac59aed8 RS |
488 | "Insert the character you type ARG times. |
489 | ||
ff85d4f3 RS |
490 | With no ARG, if `skeleton-pair' is non-nil, pairing can occur. If the region |
491 | is visible the pair is wrapped around it depending on `skeleton-autowrap'. | |
492 | Else, if `skeleton-pair-on-word' is non-nil or we are not before or inside a | |
5c741ceb | 493 | word, and if `skeleton-pair-filter-function' returns nil, pairing is performed. |
5b83f9c0 SM |
494 | Pairing is also prohibited if we are right after a quoting character |
495 | such as backslash. | |
ac59aed8 | 496 | |
bc35d5b3 | 497 | If a match is found in `skeleton-pair-alist', that is inserted, else |
ac59aed8 RS |
498 | the defaults are used. These are (), [], {}, <> and `' for the |
499 | symmetrical ones, and the same character twice for the others." | |
500 | (interactive "*P") | |
c93992b3 SM |
501 | (if (or arg (not skeleton-pair)) |
502 | (self-insert-command (prefix-numeric-value arg)) | |
503 | (let* ((mark (and skeleton-autowrap | |
504 | (or (eq last-command 'mouse-drag-region) | |
505 | (and transient-mark-mode mark-active)))) | |
506 | (skeleton-end-hook) | |
8989a920 | 507 | (char last-command-event) |
c93992b3 SM |
508 | (skeleton (or (assq char skeleton-pair-alist) |
509 | (assq char skeleton-pair-default-alist) | |
510 | `(,char _ ,char)))) | |
511 | (if (or (memq (char-syntax (preceding-char)) '(?\\ ?/)) | |
512 | (and (not mark) | |
513 | (or overwrite-mode | |
514 | (if (not skeleton-pair-on-word) (looking-at "\\w")) | |
5c741ceb | 515 | (funcall skeleton-pair-filter-function)))) |
c93992b3 SM |
516 | (self-insert-command (prefix-numeric-value arg)) |
517 | (skeleton-insert (cons nil skeleton) (if mark -1)))))) | |
ac59aed8 RS |
518 | |
519 | \f | |
ff85d4f3 | 520 | ;; A more serious example can be found in sh-script.el |
1a5ed76f | 521 | ;; (defun mirror-mode () |
017d787a RS |
522 | ;; "This major mode is an amusing little example of paired insertion. |
523 | ;;All printable characters do a paired self insert, while the other commands | |
524 | ;;work normally." | |
525 | ;; (interactive) | |
526 | ;; (kill-all-local-variables) | |
ff85d4f3 RS |
527 | ;; (make-local-variable 'skeleton-pair) |
528 | ;; (make-local-variable 'skeleton-pair-on-word) | |
5c741ceb | 529 | ;; (make-local-variable 'skeleton-pair-filter-function) |
ff85d4f3 | 530 | ;; (make-local-variable 'skeleton-pair-alist) |
017d787a RS |
531 | ;; (setq major-mode 'mirror-mode |
532 | ;; mode-name "Mirror" | |
ff85d4f3 | 533 | ;; skeleton-pair-on-word t |
017d787a | 534 | ;; ;; in the middle column insert one or none if odd window-width |
5c741ceb | 535 | ;; skeleton-pair-filter-function (lambda () |
ff85d4f3 RS |
536 | ;; (if (>= (current-column) |
537 | ;; (/ (window-width) 2)) | |
538 | ;; ;; insert both on next line | |
539 | ;; (next-line 1) | |
540 | ;; ;; insert one or both? | |
541 | ;; (= (* 2 (1+ (current-column))) | |
542 | ;; (window-width)))) | |
017d787a | 543 | ;; ;; mirror these the other way round as well |
ff85d4f3 RS |
544 | ;; skeleton-pair-alist '((?) _ ?() |
545 | ;; (?] _ ?[) | |
546 | ;; (?} _ ?{) | |
547 | ;; (?> _ ?<) | |
548 | ;; (?/ _ ?\\) | |
549 | ;; (?\\ _ ?/) | |
550 | ;; (?` ?` _ "''") | |
551 | ;; (?' ?' _ "``")) | |
017d787a | 552 | ;; ;; in this mode we exceptionally ignore the user, else it's no fun |
ff85d4f3 RS |
553 | ;; skeleton-pair t) |
554 | ;; (let ((map (make-vector 256 'skeleton-pair-insert-maybe)) | |
555 | ;; (i 0)) | |
556 | ;; (use-local-map `(keymap ,map)) | |
557 | ;; (while (< i ? ) | |
558 | ;; (aset map i nil) | |
559 | ;; (aset map (+ i 128) nil) | |
017d787a | 560 | ;; (setq i (1+ i)))) |
1c4c2dac | 561 | ;; (run-mode-hooks 'mirror-mode-hook)) |
ac59aed8 | 562 | |
2aea64fb RS |
563 | (provide 'skeleton) |
564 | ||
cbee283d | 565 | ;; arch-tag: ccad7bd5-eb5d-40de-9ded-900197215c3e |
1cd7adc6 | 566 | ;;; skeleton.el ends here |