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