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