12501
|
1 ;;; skeleton.el --- Lisp language extension for writing statement skeletons
|
14169
|
2
|
51153
|
3 ;; Copyright (C) 1993, 1994, 1995, 1996, 2003 by Free Software Foundation, Inc.
|
6463
|
4
|
23869
|
5 ;; Author: Daniel Pfeiffer <occitan@esperanto.org>
|
6463
|
6 ;; Maintainer: FSF
|
12501
|
7 ;; Keywords: extensions, abbrev, languages, tools
|
6463
|
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
|
14169
|
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.
|
6463
|
25
|
|
26 ;;; Commentary:
|
|
27
|
12501
|
28 ;; A very concise language extension for writing structured statement
|
6463
|
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
|
12501
|
36 ;; page 1: statement skeleton language definition & interpreter
|
6463
|
37 ;; page 2: paired insertion
|
|
38 ;; page 3: mirror-mode, an example for setting up paired insertion
|
|
39
|
|
40
|
45288
|
41 (defvar skeleton-transformation 'identity
|
12501
|
42 "*If non-nil, function applied to literal strings before they are inserted.
|
6463
|
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
|
15489
|
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
|
50869
7d308602f619
(skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
55 with the mouse) and this is non-nil and the function was called without an
|
15489
|
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.")
|
6463
|
62
|
34838
10b89a04d05d
(skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
63 (defvar skeleton-end-newline t
|
10b89a04d05d
(skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
64 "If non-nil, make sure that the skeleton inserted ends with a newline.
|
10b89a04d05d
(skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
65 This just influences the way the default `skeleton-end-hook' behaves.")
|
10b89a04d05d
(skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
66
|
13390
|
67 (defvar skeleton-end-hook
|
|
68 (lambda ()
|
34838
10b89a04d05d
(skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
69 (or (eolp) (not skeleton-end-newline) (newline-and-indent)))
|
13390
|
70 "Hook called at end of skeleton but before going to point of interest.
|
34838
10b89a04d05d
(skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
71 By default this moves out anything following to next line,
|
10b89a04d05d
(skeleton-internal-1): Really make sure the first line of
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
72 unless `skeleton-end-newline' is set to nil.
|
13390
|
73 The variables `v1' and `v2' are still set when calling this.")
|
|
74
|
|
75
|
12501
|
76 ;;;###autoload
|
|
77 (defvar skeleton-filter 'identity
|
15489
|
78 "Function for transforming a skeleton proxy's aliases' variable value.")
|
12501
|
79
|
|
80 (defvar skeleton-untabify t
|
50869
7d308602f619
(skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
81 "When non-nil untabifies when deleting backwards with element -ARG.")
|
12501
|
82
|
12886
|
83 (defvar skeleton-newline-indent-rigidly nil
|
50869
7d308602f619
(skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
84 "When non-nil, indent rigidly under current line for element `\\n'.
|
12886
|
85 Else use mode's `indent-line-function'.")
|
12501
|
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
|
6463
|
95 (defvar skeleton-subprompt
|
|
96 (substitute-command-keys
|
|
97 "RET, \\<minibuffer-local-map>\\[abort-recursive-edit] or \\[help-command]")
|
12501
|
98 "*Replacement for %s in prompts of recursive subskeletons.")
|
6463
|
99
|
|
100
|
|
101 (defvar skeleton-debug nil
|
|
102 "*If non-nil `define-skeleton' will override previous definition.")
|
|
103
|
16768
|
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.")
|
16767
|
108
|
12886
|
109 ;; reduce the number of compiler warnings
|
|
110 (defvar skeleton)
|
|
111 (defvar skeleton-modified)
|
|
112 (defvar skeleton-point)
|
|
113 (defvar skeleton-regions)
|
6463
|
114
|
51303
|
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))
|
6463
|
119 ;;;###autoload
|
12501
|
120 (defmacro define-skeleton (command documentation &rest skeleton)
|
6463
|
121 "Define a user-configurable COMMAND that enters a statement skeleton.
|
51153
|
122 DOCUMENTATION is that of the command.
|
|
123 SKELETON is as defined under `skeleton-insert'."
|
51303
|
124 (declare (debug (&define name stringp skeleton-edebug-spec)))
|
6463
|
125 (if skeleton-debug
|
12501
|
126 (set command skeleton))
|
12862
|
127 `(progn
|
51153
|
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)
|
15544
|
131 (defun ,command (&optional str arg)
|
|
132 ,(concat documentation
|
51153
|
133 (if (string-match "\n\\'" documentation)
|
15544
|
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.
|
17544
|
142 A prefix argument of -1 says to wrap around region, even if not highlighted.
|
15544
|
143 A prefix argument of zero says to wrap around zero words---that is, nothing.
|
17544
|
144 This is a way of overriding the use of a highlighted region.")
|
15544
|
145 (interactive "*P\nP")
|
|
146 (skeleton-proxy-new ',skeleton str arg))))
|
|
147
|
|
148 ;;;###autoload
|
|
149 (defun skeleton-proxy-new (skeleton &optional str arg)
|
51153
|
150 "Insert SKELETON.
|
15544
|
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).
|
6463
|
156
|
51153
|
157 Optional first argument STR may also be a string which will be the value
|
|
158 of `str' whereas the skeleton's interactor is then ignored."
|
|
159 (skeleton-insert (funcall skeleton-filter skeleton)
|
|
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))
|
51526
|
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)))
|
51153
|
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)
|
6463
|
178
|
12501
|
179 ;;;###autoload
|
17490
|
180 (defun skeleton-insert (skeleton &optional regions str)
|
12501
|
181 "Insert the complex statement skeleton SKELETON describes very concisely.
|
6463
|
182
|
17490
|
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.
|
12501
|
187
|
17490
|
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.
|
12886
|
196
|
12501
|
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.
|
6463
|
199
|
|
200 If ELEMENT is a string or a character it gets inserted (see also
|
|
201 `skeleton-transformation'). Other possibilities are:
|
|
202
|
12886
|
203 \\n go to next line and indent according to mode
|
35879
|
204 _ interesting point, interregion here
|
51087
49b8ab00fab0
(skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
205 - interesting point, no interregion interaction, overrides
|
49b8ab00fab0
(skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
206 interesting point set by _
|
12501
|
207 > indent line (or interregion if > _) according to major mode
|
16768
|
208 @ add position to `skeleton-positions'
|
36967
|
209 & do next ELEMENT iff previous moved point
|
|
210 | do next ELEMENT iff previous didn't move point
|
12501
|
211 -num delete num preceding characters (see `skeleton-untabify')
|
6463
|
212 resume: skipped, continue here if quit is signaled
|
|
213 nil skipped
|
|
214
|
51087
49b8ab00fab0
(skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
215 After termination, point will be positioned at the last occurrence of -
|
49b8ab00fab0
(skeleton-internal-1): Allow - as alternate interesting point marker and revert
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
216 or at the first occurrence of _ or at the end of the inserted text.
|
35879
|
217
|
12501
|
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
|
17490
|
224 formatted with `skeleton-subprompt'. Such an INTERACTOR may also be a list of
|
12886
|
225 strings with the subskeleton being repeated once for each string.
|
6463
|
226
|
17490
|
227 Quoted Lisp expressions are evaluated for their side-effects.
|
15489
|
228 Other Lisp expressions are evaluated and the value treated as above.
|
50869
7d308602f619
(skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
229 Note that expressions may not return t since this implies an
|
12501
|
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:
|
6463
|
233
|
12501
|
234 str first time: read a string according to INTERACTOR
|
6463
|
235 then: insert previously read string once more
|
50869
7d308602f619
(skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
236 help help-form during interaction with the user or nil
|
12862
|
237 input initial input (string or cons with index) while reading str
|
15489
|
238 v1, v2 local variables for memorizing anything you want
|
12886
|
239
|
|
240 When done with skeleton, but before going back to `_'-point call
|
50869
7d308602f619
(skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
241 `skeleton-end-hook' if that is non-nil."
|
17490
|
242 (let ((skeleton-regions regions))
|
|
243 (and skeleton-regions
|
|
244 (setq skeleton-regions
|
|
245 (if (> skeleton-regions 0)
|
45288
|
246 (list (copy-marker (point) t)
|
17490
|
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))
|
45288
|
252 (l2 (list (copy-marker (point) t))))
|
17490
|
253 (while (and l1 (> skeleton-regions 0))
|
45288
|
254 (push (copy-marker (pop l1) t) l2)
|
|
255 (setq skeleton-regions (1- skeleton-regions)))
|
17490
|
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))))))
|
6463
|
273
|
17515
|
274 (defun skeleton-read (prompt &optional initial-input recursive)
|
12862
|
275 "Function for reading a string from the minibuffer within skeletons.
|
17552
|
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'.
|
50869
7d308602f619
(skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
279 If non-nil second arg INITIAL-INPUT or variable `input' is a string or
|
7d308602f619
(skeleton-autowrap, skeleton-untabify, skeleton-newline-indent-rigidly)
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
280 cons with index to insert before reading. If third arg RECURSIVE is non-nil
|
12862
|
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
|
17490
|
284 is non-nil or a default string."
|
13390
|
285 (let ((minibuffer-help-form (or (if (boundp 'help) (symbol-value 'help))
|
|
286 (if recursive "\
|
6463
|
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
|
12501
|
294 syntactically necessary termination."
|
17490
|
295 "\
|
12501
|
296 You are inserting a skeleton. Standard text gets inserted into the buffer
|
13390
|
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
|
|
301 (open-line 1))
|
|
302 (unwind-protect
|
17490
|
303 (setq prompt (if (stringp prompt)
|
|
304 (read-string (format prompt skeleton-subprompt)
|
|
305 (setq initial-input
|
|
306 (or initial-input
|
|
307 (symbol-value 'input))))
|
|
308 (eval prompt)))
|
13390
|
309 (or eolp
|
|
310 (delete-char 1))))
|
12862
|
311 (if (and recursive
|
17490
|
312 (or (null prompt)
|
|
313 (string= prompt "")
|
|
314 (equal prompt initial-input)
|
|
315 (equal prompt (car-safe initial-input))))
|
6463
|
316 (signal 'quit t)
|
17515
|
317 prompt))
|
6463
|
318
|
12886
|
319 (defun skeleton-internal-list (skeleton &optional str recursive)
|
12501
|
320 (let* ((start (save-excursion (beginning-of-line) (point)))
|
|
321 (column (current-column))
|
45288
|
322 (line (buffer-substring start (line-end-position)))
|
12501
|
323 opoint)
|
12886
|
324 (or str
|
|
325 (setq str `(setq str (skeleton-read ',(car skeleton) nil ,recursive))))
|
49299
|
326 (when (and (eq (cadr skeleton) '\n) (not recursive)
|
45288
|
327 (save-excursion (skip-chars-backward " \t") (bolp)))
|
36967
|
328 (setq skeleton (cons nil (cons '> (cddr skeleton)))))
|
12886
|
329 (while (setq skeleton-modified (eq opoint (point))
|
12862
|
330 opoint (point)
|
|
331 skeleton (cdr skeleton))
|
|
332 (condition-case quit
|
51153
|
333 (skeleton-internal-1 (car skeleton) nil recursive)
|
12862
|
334 (quit
|
|
335 (if (eq (cdr quit) 'recursive)
|
12886
|
336 (setq recursive 'quit
|
|
337 skeleton (memq 'resume: skeleton))
|
45288
|
338 ;; Remove the subskeleton as far as it has been shown
|
|
339 ;; the subskeleton shouldn't have deleted outside current line.
|
13390
|
340 (end-of-line)
|
12862
|
341 (delete-region start (point))
|
|
342 (insert line)
|
|
343 (move-to-column column)
|
|
344 (if (cdr quit)
|
|
345 (setq skeleton ()
|
|
346 recursive nil)
|
|
347 (signal 'quit 'recursive)))))))
|
|
348 ;; maybe continue loop or go on to next outer resume: section
|
|
349 (if (eq recursive 'quit)
|
|
350 (signal 'quit 'recursive)
|
|
351 recursive))
|
6463
|
352
|
51153
|
353 (defun skeleton-internal-1 (element &optional literal recursive)
|
45288
|
354 (cond
|
|
355 ((char-or-string-p element)
|
|
356 (if (and (integerp element) ; -num
|
|
357 (< element 0))
|
|
358 (if skeleton-untabify
|
|
359 (backward-delete-char-untabify (- element))
|
|
360 (delete-backward-char (- element)))
|
51153
|
361 (insert (if (not literal)
|
45288
|
362 (funcall skeleton-transformation element)
|
|
363 element))))
|
|
364 ((or (eq element '\n) ; actually (eq '\n 'n)
|
|
365 ;; The sequence `> \n' is handled specially so as to indent the first
|
|
366 ;; line after inserting the newline (to get the proper indentation).
|
|
367 (and (eq element '>) (eq (nth 1 skeleton) '\n) (pop skeleton)))
|
|
368 (let ((pos (if (eq element '>) (point))))
|
|
369 (cond
|
|
370 ((and skeleton-regions (eq (nth 1 skeleton) '_))
|
|
371 (or (eolp) (newline))
|
|
372 (if pos (save-excursion (goto-char pos) (indent-according-to-mode)))
|
|
373 (indent-region (line-beginning-position)
|
|
374 (car skeleton-regions) nil))
|
|
375 ;; \n as last element only inserts \n if not at eol.
|
49299
|
376 ((and (null (cdr skeleton)) (not recursive) (eolp))
|
45288
|
377 (if pos (indent-according-to-mode)))
|
|
378 (skeleton-newline-indent-rigidly
|
|
379 (let ((pt (point)))
|
|
380 (newline)
|
|
381 (indent-to (save-excursion
|
|
382 (goto-char pt)
|
|
383 (if pos (indent-according-to-mode))
|
|
384 (current-indentation)))))
|
|
385 (t (if pos (reindent-then-newline-and-indent)
|
|
386 (newline)
|
|
387 (indent-according-to-mode))))))
|
|
388 ((eq element '>)
|
|
389 (if (and skeleton-regions (eq (nth 1 skeleton) '_))
|
|
390 (indent-region (line-beginning-position)
|
|
391 (car skeleton-regions) nil)
|
|
392 (indent-according-to-mode)))
|
|
393 ((eq element '_)
|
|
394 (if skeleton-regions
|
|
395 (progn
|
|
396 (goto-char (pop skeleton-regions))
|
|
397 (and (<= (current-column) (current-indentation))
|
|
398 (eq (nth 1 skeleton) '\n)
|
51153
|
399 (end-of-line 0)))
|
|
400 (or skeleton-point
|
|
401 (setq skeleton-point (point)))))
|
|
402 ((eq element '-)
|
|
403 (setq skeleton-point (point)))
|
|
404 ((eq element '&)
|
|
405 (when skeleton-modified (pop skeleton)))
|
|
406 ((eq element '|)
|
|
407 (unless skeleton-modified (pop skeleton)))
|
|
408 ((eq element '@)
|
|
409 (push (point) skeleton-positions))
|
|
410 ((eq 'quote (car-safe element))
|
|
411 (eval (nth 1 element)))
|
51244
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
412 ((and (consp element)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
413 (or (stringp (car element)) (listp (car element))))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
414 ;; Don't forget: `symbolp' is also true for nil.
|
45288
|
415 (if (symbolp (car-safe (car element)))
|
51244
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
416 (while (and (skeleton-internal-list element nil t)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
417 ;; If the interactor is nil, don't infinite loop.
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
418 (car element)))
|
45288
|
419 (setq literal (car element))
|
|
420 (while literal
|
|
421 (skeleton-internal-list element (car literal))
|
|
422 (setq literal (cdr literal)))))
|
|
423 ((null element))
|
51153
|
424 (t (skeleton-internal-1 (eval element) t recursive))))
|
45288
|
425
|
12501
|
426 ;; Maybe belongs into simple.el or elsewhere
|
45288
|
427 ;; ;;;###autoload
|
|
428 ;; (define-skeleton local-variables-section
|
15506
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
429 ;; "Insert a local variables section. Use current comment syntax if any."
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
430 ;; (completing-read "Mode: " obarray
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
431 ;; (lambda (symbol)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
432 ;; (if (commandp symbol)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
433 ;; (string-match "-mode$" (symbol-name symbol))))
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
434 ;; t)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
435 ;; '(save-excursion
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
436 ;; (if (re-search-forward page-delimiter nil t)
|
38409
|
437 ;; (error "Not on last page")))
|
15506
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
438 ;; comment-start "Local Variables:" comment-end \n
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
439 ;; comment-start "mode: " str
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
440 ;; & -5 | '(kill-line 0) & -1 | comment-end \n
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
441 ;; ( (completing-read (format "Variable, %s: " skeleton-subprompt)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
442 ;; obarray
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
443 ;; (lambda (symbol)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
444 ;; (or (eq symbol 'eval)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
445 ;; (user-variable-p symbol)))
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
446 ;; t)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
447 ;; comment-start str ": "
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
448 ;; (read-from-minibuffer "Expression: " nil read-expression-map nil
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
449 ;; 'read-expression-history) | _
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
450 ;; comment-end \n)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
451 ;; resume:
|
15544
|
452 ;; comment-start "End:" comment-end \n)
|
6463
|
453
|
12619
|
454 ;; Variables and command for automatically inserting pairs like () or "".
|
6463
|
455
|
12619
|
456 (defvar skeleton-pair nil
|
6463
|
457 "*If this is nil pairing is turned off, no matter what else is set.
|
12619
|
458 Otherwise modes with `skeleton-pair-insert-maybe' on some keys
|
|
459 will attempt to insert pairs of matching characters.")
|
6463
|
460
|
|
461
|
12619
|
462 (defvar skeleton-pair-on-word nil
|
|
463 "*If this is nil, paired insertion is inhibited before or inside a word.")
|
6463
|
464
|
|
465
|
36967
|
466 (defvar skeleton-pair-filter (lambda () nil)
|
12619
|
467 "Attempt paired insertion if this function returns nil, before inserting.
|
6463
|
468 This allows for context-sensitive checking whether pairing is appropriate.")
|
|
469
|
|
470
|
12619
|
471 (defvar skeleton-pair-alist ()
|
|
472 "An override alist of pairing partners matched against `last-command-char'.
|
|
473 Each alist element, which looks like (ELEMENT ...), is passed to
|
|
474 `skeleton-insert' with no interactor. Variable `str' does nothing.
|
6463
|
475
|
12501
|
476 Elements might be (?` ?` _ \"''\"), (?\\( ? _ \" )\") or (?{ \\n > _ \\n ?} >).")
|
6463
|
477
|
51244
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
478 (defvar skeleton-pair-default-alist '((?( _ ?)) (?\))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
479 (?[ _ ?]) (?\])
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
480 (?{ _ ?}) (?\})
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
481 (?< _ ?>) (?\>)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
482 (?� _ ?�) (?\�)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
483 (?` _ ?')))
|
6463
|
484
|
|
485 ;;;###autoload
|
12619
|
486 (defun skeleton-pair-insert-maybe (arg)
|
6463
|
487 "Insert the character you type ARG times.
|
|
488
|
15506
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
489 With no ARG, if `skeleton-pair' is non-nil, pairing can occur. If the region
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
490 is visible the pair is wrapped around it depending on `skeleton-autowrap'.
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
491 Else, if `skeleton-pair-on-word' is non-nil or we are not before or inside a
|
12619
|
492 word, and if `skeleton-pair-filter' returns nil, pairing is performed.
|
36967
|
493 Pairing is also prohibited if we are right after a quoting character
|
|
494 such as backslash.
|
6463
|
495
|
12619
|
496 If a match is found in `skeleton-pair-alist', that is inserted, else
|
6463
|
497 the defaults are used. These are (), [], {}, <> and `' for the
|
|
498 symmetrical ones, and the same character twice for the others."
|
|
499 (interactive "*P")
|
51244
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
500 (if (or arg (not skeleton-pair))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
501 (self-insert-command (prefix-numeric-value arg))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
502 (let* ((mark (and skeleton-autowrap
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
503 (or (eq last-command 'mouse-drag-region)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
504 (and transient-mark-mode mark-active))))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
505 (skeleton-end-hook)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
506 (char last-command-char)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
507 (skeleton (or (assq char skeleton-pair-alist)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
508 (assq char skeleton-pair-default-alist)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
509 `(,char _ ,char))))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
510 (if (or (memq (char-syntax (preceding-char)) '(?\\ ?/))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
511 (and (not mark)
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
512 (or overwrite-mode
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
513 (if (not skeleton-pair-on-word) (looking-at "\\w"))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
514 (funcall skeleton-pair-filter))))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
515 (self-insert-command (prefix-numeric-value arg))
|
18df58e3c486
(skeleton-internal-1): Don't loop if interactor of subskeleton is nil.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
516 (skeleton-insert (cons nil skeleton) (if mark -1))))))
|
6463
|
517
|
|
518
|
15506
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
519 ;; A more serious example can be found in sh-script.el
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
520 ;;; (defun mirror-mode ()
|
15489
|
521 ;; "This major mode is an amusing little example of paired insertion.
|
|
522 ;;All printable characters do a paired self insert, while the other commands
|
|
523 ;;work normally."
|
|
524 ;; (interactive)
|
|
525 ;; (kill-all-local-variables)
|
15506
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
526 ;; (make-local-variable 'skeleton-pair)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
527 ;; (make-local-variable 'skeleton-pair-on-word)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
528 ;; (make-local-variable 'skeleton-pair-filter)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
529 ;; (make-local-variable 'skeleton-pair-alist)
|
15489
|
530 ;; (setq major-mode 'mirror-mode
|
|
531 ;; mode-name "Mirror"
|
15506
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
532 ;; skeleton-pair-on-word t
|
15489
|
533 ;; ;; in the middle column insert one or none if odd window-width
|
15506
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
534 ;; skeleton-pair-filter (lambda ()
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
535 ;; (if (>= (current-column)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
536 ;; (/ (window-width) 2))
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
537 ;; ;; insert both on next line
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
538 ;; (next-line 1)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
539 ;; ;; insert one or both?
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
540 ;; (= (* 2 (1+ (current-column)))
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
541 ;; (window-width))))
|
15489
|
542 ;; ;; mirror these the other way round as well
|
15506
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
543 ;; skeleton-pair-alist '((?) _ ?()
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
544 ;; (?] _ ?[)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
545 ;; (?} _ ?{)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
546 ;; (?> _ ?<)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
547 ;; (?/ _ ?\\)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
548 ;; (?\\ _ ?/)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
549 ;; (?` ?` _ "''")
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
550 ;; (?' ?' _ "``"))
|
15489
|
551 ;; ;; in this mode we exceptionally ignore the user, else it's no fun
|
15506
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
552 ;; skeleton-pair t)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
553 ;; (let ((map (make-vector 256 'skeleton-pair-insert-maybe))
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
554 ;; (i 0))
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
555 ;; (use-local-map `(keymap ,map))
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
556 ;; (while (< i ? )
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
557 ;; (aset map i nil)
|
1a66dbb1a470
(local-variables-section): Adapted comment to outline minor mode.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
558 ;; (aset map (+ i 128) nil)
|
15489
|
559 ;; (setq i (1+ i))))
|
|
560 ;; (run-hooks 'mirror-mode-hook))
|
6463
|
561
|
14724
|
562 (provide 'skeleton)
|
|
563
|
52401
|
564 ;;; arch-tag: ccad7bd5-eb5d-40de-9ded-900197215c3e
|
38409
|
565 ;;; skeleton.el ends here
|