skeleton.el 21.6 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1
;;; skeleton.el --- Lisp language extension for writing statement skeletons
Erik Naggum's avatar
Erik Naggum committed
2

3
;; Copyright (C) 1993, 1994, 1995, 1996, 2003 by Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

Karl Heuer's avatar
Karl Heuer committed
5
;; Author: Daniel Pfeiffer <occitan@esperanto.org>
Richard M. Stallman's avatar
Richard M. Stallman committed
6
;; Maintainer: FSF
Karl Heuer's avatar
Karl Heuer committed
7
;; Keywords: extensions, abbrev, languages, tools
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
25 26 27

;;; Commentary:

Karl Heuer's avatar
Karl Heuer committed
28
;; A very concise language extension for writing structured statement
Richard M. Stallman's avatar
Richard M. Stallman committed
29 30 31 32 33 34 35
;; skeleton insertion commands for programming language modes.  This
;; originated in shell-script mode and was applied to ada-mode's
;; commands which shrunk to one third.  And these commands are now
;; user configurable.

;;; Code:

Karl Heuer's avatar
Karl Heuer committed
36
;; page 1:	statement skeleton language definition & interpreter
Richard M. Stallman's avatar
Richard M. Stallman committed
37 38 39 40
;; page 2:	paired insertion
;; page 3:	mirror-mode, an example for setting up paired insertion


41
(defvar skeleton-transformation 'identity
Karl Heuer's avatar
Karl Heuer committed
42
  "*If non-nil, function applied to literal strings before they are inserted.
Richard M. Stallman's avatar
Richard M. Stallman committed
43 44 45 46 47 48 49 50 51
It should take strings and characters and return them transformed, or nil
which means no transformation.
Typical examples might be `upcase' or `capitalize'.")

; this should be a fourth argument to defvar
(put 'skeleton-transformation 'variable-interactive
     "aTransformation function: ")


52
(defvar skeleton-autowrap t
53
  "Controls wrapping behavior of functions created with `define-skeleton'.
54
When the region is visible (due to `transient-mark-mode' or marking a region
55
with the mouse) and this is non-nil and the function was called without an
56 57 58 59 60 61
explicit ARG, then the ARG defaults to -1, i.e. wrapping around the visible
region.

We will probably delete this variable in a future Emacs version
unless we get a substantial number of complaints about the auto-wrap
feature.")
Richard M. Stallman's avatar
Richard M. Stallman committed
62

63 64 65 66
(defvar skeleton-end-newline t
  "If non-nil, make sure that the skeleton inserted ends with a newline.
This just influences the way the default `skeleton-end-hook' behaves.")

67 68
(defvar skeleton-end-hook
  (lambda ()
69
    (or (eolp) (not skeleton-end-newline) (newline-and-indent)))
70
  "Hook called at end of skeleton but before going to point of interest.
71 72
By default this moves out anything following to next line,
  unless `skeleton-end-newline' is set to nil.
73 74 75
The variables `v1' and `v2' are still set when calling this.")


Karl Heuer's avatar
Karl Heuer committed
76 77
;;;###autoload
(defvar skeleton-filter 'identity
78
  "Function for transforming a skeleton proxy's aliases' variable value.")
Karl Heuer's avatar
Karl Heuer committed
79 80

(defvar skeleton-untabify t
81
  "When non-nil untabifies when deleting backwards with element -ARG.")
Karl Heuer's avatar
Karl Heuer committed
82

83
(defvar skeleton-newline-indent-rigidly nil
84
  "When non-nil, indent rigidly under current line for element `\\n'.
85
Else use mode's `indent-line-function'.")
Karl Heuer's avatar
Karl Heuer committed
86 87 88 89 90 91 92 93 94

(defvar skeleton-further-elements ()
  "A buffer-local varlist (see `let') of mode specific skeleton elements.
These variables are bound while interpreting a skeleton.  Their value may
in turn be any valid skeleton element if they are themselves to be used as
skeleton elements.")
(make-variable-buffer-local 'skeleton-further-elements)


Richard M. Stallman's avatar
Richard M. Stallman committed
95 96 97
(defvar skeleton-subprompt
  (substitute-command-keys
   "RET, \\<minibuffer-local-map>\\[abort-recursive-edit] or \\[help-command]")
Karl Heuer's avatar
Karl Heuer committed
98 99
  "*Replacement for %s in prompts of recursive subskeletons.")

Richard M. Stallman's avatar
Richard M. Stallman committed
100 101 102 103

(defvar skeleton-debug nil
  "*If non-nil `define-skeleton' will override previous definition.")

104 105 106 107
(defvar skeleton-positions nil
  "List of positions marked with @, after skeleton insertion.
The list describes the most recent skeleton insertion, and its elements
are integer buffer positions in the reverse order of the insertion order.")
108

109 110 111 112 113
;; reduce the number of compiler warnings
(defvar skeleton)
(defvar skeleton-modified)
(defvar skeleton-point)
(defvar skeleton-regions)
Richard M. Stallman's avatar
Richard M. Stallman committed
114

115 116 117 118
(def-edebug-spec skeleton-edebug-spec
  ([&or null stringp (stringp &rest stringp) [[&not atom] def-form]]
   &rest &or "n" "_" "-" ">" "@" "&" "!" "resume:"
   ("quote" def-form) skeleton-edebug-spec def-form))
Richard M. Stallman's avatar
Richard M. Stallman committed
119
;;;###autoload
Karl Heuer's avatar
Karl Heuer committed
120
(defmacro define-skeleton (command documentation &rest skeleton)
Richard M. Stallman's avatar
Richard M. Stallman committed
121
  "Define a user-configurable COMMAND that enters a statement skeleton.
122 123
DOCUMENTATION is that of the command.
SKELETON is as defined under `skeleton-insert'."
124
  (declare (debug (&define name stringp skeleton-edebug-spec)))
Richard M. Stallman's avatar
Richard M. Stallman committed
125
  (if skeleton-debug
Karl Heuer's avatar
Karl Heuer committed
126
      (set command skeleton))
127
  `(progn
128 129 130
     ;; Tell self-insert-command that this function, if called by an
     ;; abbrev, should cause the self-insert to be skipped.
     (put ',command 'no-self-insert t)
131 132
     (defun ,command (&optional str arg)
       ,(concat documentation
133
		(if (string-match "\n\\'" documentation)
134 135 136 137 138 139 140 141
		    "" "\n")
		"\n"
  "This is a skeleton command (see `skeleton-insert').
Normally the skeleton text is inserted at point, with nothing \"inside\".
If there is a highlighted region, the skeleton text is wrapped
around the region text.

A prefix argument ARG says to wrap the skeleton around the next ARG words.
142
A prefix argument of -1 says to wrap around region, even if not highlighted.
143
A prefix argument of zero says to wrap around zero words---that is, nothing.
144
This is a way of overriding the use of a highlighted region.")
145 146
       (interactive "*P\nP")
       (skeleton-proxy-new ',skeleton str arg))))
Karl Heuer's avatar
Karl Heuer committed
147

148 149
;;;###autoload
(defun skeleton-proxy-new (skeleton &optional str arg)
150
  "Insert SKELETON.
151 152 153 154 155
Prefix ARG allows wrapping around words or regions (see `skeleton-insert').
If no ARG was given, but the region is visible, ARG defaults to -1 depending
on `skeleton-autowrap'.  An ARG of  M-0  will prevent this just for once.
This command can also be an abbrev expansion (3rd and 4th columns in
\\[edit-abbrevs]  buffer: \"\"  command-name).
Karl Heuer's avatar
Karl Heuer committed
156

157 158 159 160 161 162 163 164 165 166
Optional first argument STR may also be a string which will be the value
of `str' whereas the skeleton's interactor is then ignored."
  (skeleton-insert (funcall skeleton-filter skeleton)
		   ;; Pretend  C-x a e  passed its prefix arg to us
		   (if (or arg current-prefix-arg)
		       (prefix-numeric-value (or arg
						 current-prefix-arg))
		     (and skeleton-autowrap
			  (or (eq last-command 'mouse-drag-region)
			      (and transient-mark-mode mark-active))
167 168 169 170 171 172
			  ;; Deactivate the mark, in case one of the
			  ;; elements of the skeleton is sensitive
			  ;; to such situations (e.g. it is itself a
			  ;; skeleton).
			  (progn (deactivate-mark)
				 -1)))
173 174 175 176 177
		   (if (stringp str)
		       str))
  ;; Return non-nil to tell expand-abbrev that expansion has happened.
  ;; Otherwise the no-self-insert is ignored.
  t)
Richard M. Stallman's avatar
Richard M. Stallman committed
178 179

;;;###autoload
180
(defun skeleton-insert (skeleton &optional regions str)
Karl Heuer's avatar
Karl Heuer committed
181
  "Insert the complex statement skeleton SKELETON describes very concisely.
Richard M. Stallman's avatar
Richard M. Stallman committed
182

183 184 185 186
With optional second argument REGIONS, wrap first interesting point
\(`_') in skeleton around next REGIONS words, if REGIONS is positive.
If REGIONS is negative, wrap REGIONS preceding interregions into first
REGIONS interesting positions \(successive `_'s) in skeleton.
Karl Heuer's avatar
Karl Heuer committed
187

188 189 190 191 192 193 194 195
An interregion is the stretch of text between two contiguous marked
points.  If you marked A B C [] (where [] is the cursor) in
alphabetical order, the 3 interregions are simply the last 3 regions.
But if you marked B A [] C, the interregions are B-A, A-[], []-C.

The optional third argument STR, if specified, is the value for the
variable `str' within the skeleton.  When this is non-nil, the
interactor gets ignored, and this should be a valid skeleton element.
196

Karl Heuer's avatar
Karl Heuer committed
197 198
SKELETON is made up as (INTERACTOR ELEMENT ...).  INTERACTOR may be nil if
not needed, a prompt-string or an expression for complex read functions.
Richard M. Stallman's avatar
Richard M. Stallman committed
199 200 201 202

If ELEMENT is a string or a character it gets inserted (see also
`skeleton-transformation').  Other possibilities are:

203
	\\n	go to next line and indent according to mode
Stefan Monnier's avatar
Stefan Monnier committed
204
	_	interesting point, interregion here
205 206
	-	interesting point, no interregion interaction, overrides
		interesting point set by _
Karl Heuer's avatar
Karl Heuer committed
207
	>	indent line (or interregion if > _) according to major mode
208
	@	add position to `skeleton-positions'
209 210
	&	do next ELEMENT iff previous moved point
	|	do next ELEMENT iff previous didn't move point
Karl Heuer's avatar
Karl Heuer committed
211
	-num	delete num preceding characters (see `skeleton-untabify')
Richard M. Stallman's avatar
Richard M. Stallman committed
212 213 214
	resume:	skipped, continue here if quit is signaled
	nil	skipped

215 216
After termination, point will be positioned at the last occurrence of -
or at the first occurrence of _ or at the end of the inserted text.
Stefan Monnier's avatar
Stefan Monnier committed
217

Karl Heuer's avatar
Karl Heuer committed
218 219 220 221 222 223
Further elements can be defined via `skeleton-further-elements'.  ELEMENT may
itself be a SKELETON with an INTERACTOR.  The user is prompted repeatedly for
different inputs.  The SKELETON is processed as often as the user enters a
non-empty string.  \\[keyboard-quit] terminates skeleton insertion, but
continues after `resume:' and positions at `_' if any.  If INTERACTOR in such
a subskeleton is a prompt-string which contains a \".. %s ..\" it is
224
formatted with `skeleton-subprompt'.  Such an INTERACTOR may also be a list of
225
strings with the subskeleton being repeated once for each string.
Richard M. Stallman's avatar
Richard M. Stallman committed
226

227
Quoted Lisp expressions are evaluated for their side-effects.
228
Other Lisp expressions are evaluated and the value treated as above.
229
Note that expressions may not return t since this implies an
Karl Heuer's avatar
Karl Heuer committed
230 231 232
endless loop.  Modes can define other symbols by locally setting them
to any valid skeleton element.  The following local variables are
available:
Richard M. Stallman's avatar
Richard M. Stallman committed
233

Karl Heuer's avatar
Karl Heuer committed
234
	str	first time: read a string according to INTERACTOR
Richard M. Stallman's avatar
Richard M. Stallman committed
235
		then: insert previously read string once more
236
	help	help-form during interaction with the user or nil
237
	input	initial input (string or cons with index) while reading str
238
	v1, v2	local variables for memorizing anything you want
239 240

When done with skeleton, but before going back to `_'-point call
241
`skeleton-end-hook' if that is non-nil."
242 243 244 245
  (let ((skeleton-regions regions))
    (and skeleton-regions
	 (setq skeleton-regions
	       (if (> skeleton-regions 0)
246
		   (list (copy-marker (point) t)
247 248 249 250 251
			 (save-excursion (forward-word skeleton-regions)
					 (point-marker)))
		 (setq skeleton-regions (- skeleton-regions))
		 ;; copy skeleton-regions - 1 elements from `mark-ring'
		 (let ((l1 (cons (mark-marker) mark-ring))
252
		       (l2 (list (copy-marker (point) t))))
253
		   (while (and l1 (> skeleton-regions 0))
254 255
		     (push (copy-marker (pop l1) t) l2)
		     (setq skeleton-regions (1- skeleton-regions)))
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
		   (sort l2 '<))))
	 (goto-char (car skeleton-regions))
	 (setq skeleton-regions (cdr skeleton-regions)))
    (let ((beg (point))
	  skeleton-modified skeleton-point resume: help input v1 v2)
      (setq skeleton-positions nil)
      (unwind-protect
	  (eval `(let ,skeleton-further-elements
		   (skeleton-internal-list skeleton str)))
	(run-hooks 'skeleton-end-hook)
	(sit-for 0)
	(or (pos-visible-in-window-p beg)
	    (progn
	      (goto-char beg)
	      (recenter 0)))
	(if skeleton-point
	    (goto-char skeleton-point))))))

274
(defun skeleton-read (prompt &optional initial-input recursive)
275
  "Function for reading a string from the minibuffer within skeletons.
276 277 278

PROMPT must be a string or a form that evaluates to a string.
It may contain a `%s' which will be replaced by `skeleton-subprompt'.
279 280
If non-nil second arg INITIAL-INPUT or variable `input' is a string or
cons with index to insert before reading.  If third arg RECURSIVE is non-nil
281 282 283
i.e. we are handling the iterator of a subskeleton, returns empty string if
user didn't modify input.
While reading, the value of `minibuffer-help-form' is variable `help' if that
284
is non-nil or a default string."
285 286
  (let ((minibuffer-help-form (or (if (boundp 'help) (symbol-value 'help))
				  (if recursive "\
Richard M. Stallman's avatar
Richard M. Stallman committed
287 288 289 290 291 292 293
As long as you provide input you will insert another subskeleton.

If you enter the empty string, the loop inserting subskeletons is
left, and the current one is removed as far as it has been entered.

If you quit, the current subskeleton is removed as far as it has been
entered.  No more of the skeleton will be inserted, except maybe for a
Karl Heuer's avatar
Karl Heuer committed
294
syntactically necessary termination."
295
				    "\
Karl Heuer's avatar
Karl Heuer committed
296
You are inserting a skeleton.  Standard text gets inserted into the buffer
297 298 299 300 301 302
automatically, and you are prompted to fill in the variable parts.")))
	(eolp (eolp)))
    ;; since Emacs doesn't show main window's cursor, do something noticeable
    (or eolp
	(open-line 1))
    (unwind-protect
303 304 305 306 307 308
	(setq prompt (if (stringp prompt)
			 (read-string (format prompt skeleton-subprompt)
				      (setq initial-input
					    (or initial-input
						(symbol-value 'input))))
		       (eval prompt)))
309 310
      (or eolp
	  (delete-char 1))))
311
  (if (and recursive
312 313 314 315
	   (or (null prompt)
	       (string= prompt "")
	       (equal prompt initial-input)
	       (equal prompt (car-safe initial-input))))
Richard M. Stallman's avatar
Richard M. Stallman committed
316
      (signal 'quit t)
317
    prompt))
Richard M. Stallman's avatar
Richard M. Stallman committed
318

319
(defun skeleton-internal-list (skeleton &optional str recursive)
Karl Heuer's avatar
Karl Heuer committed
320 321
  (let* ((start (save-excursion (beginning-of-line) (point)))
	 (column (current-column))
322
	 (line (buffer-substring start (line-end-position)))
Karl Heuer's avatar
Karl Heuer committed
323
	 opoint)
324 325
    (or str
	(setq str `(setq str (skeleton-read ',(car skeleton) nil ,recursive))))
326
    (when (and (eq (cadr skeleton) '\n) (not recursive)
327
	       (save-excursion (skip-chars-backward " \t") (bolp)))
328
      (setq skeleton (cons nil (cons '> (cddr skeleton)))))
329
    (while (setq skeleton-modified (eq opoint (point))
330 331 332
		 opoint (point)
		 skeleton (cdr skeleton))
      (condition-case quit
333
	  (skeleton-internal-1 (car skeleton) nil recursive)
334 335
	(quit
	 (if (eq (cdr quit) 'recursive)
336 337
	     (setq recursive 'quit
		   skeleton (memq 'resume: skeleton))
338 339
	   ;; Remove the subskeleton as far as it has been shown
	   ;; the subskeleton shouldn't have deleted outside current line.
340
	   (end-of-line)
341 342 343 344 345 346 347 348 349 350 351
	   (delete-region start (point))
	   (insert line)
	   (move-to-column column)
	   (if (cdr quit)
	       (setq skeleton ()
		     recursive nil)
	     (signal 'quit 'recursive)))))))
  ;; maybe continue loop or go on to next outer resume: section
  (if (eq recursive 'quit)
      (signal 'quit 'recursive)
    recursive))
Karl Heuer's avatar
Karl Heuer committed
352

353
(defun skeleton-internal-1 (element &optional literal recursive)
354 355 356 357 358 359 360
  (cond
   ((char-or-string-p element)
    (if (and (integerp element)		; -num
	     (< element 0))
	(if skeleton-untabify
	    (backward-delete-char-untabify (- element))
	  (delete-backward-char (- element)))
361
      (insert (if (not literal)
362 363 364 365 366 367 368 369 370 371 372 373 374 375
		  (funcall skeleton-transformation element)
		element))))
   ((or (eq element '\n)			; actually (eq '\n 'n)
	;; The sequence `> \n' is handled specially so as to indent the first
	;; line after inserting the newline (to get the proper indentation).
	(and (eq element '>) (eq (nth 1 skeleton) '\n) (pop skeleton)))
    (let ((pos (if (eq element '>) (point))))
      (cond
       ((and skeleton-regions (eq (nth 1 skeleton) '_))
	(or (eolp) (newline))
	(if pos (save-excursion (goto-char pos) (indent-according-to-mode)))
	(indent-region (line-beginning-position)
		       (car skeleton-regions) nil))
       ;; \n as last element only inserts \n if not at eol.
376
       ((and (null (cdr skeleton)) (not recursive) (eolp))
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
	(if pos (indent-according-to-mode)))
       (skeleton-newline-indent-rigidly
	(let ((pt (point)))
	  (newline)
	  (indent-to (save-excursion
		       (goto-char pt)
		       (if pos (indent-according-to-mode))
		       (current-indentation)))))
       (t (if pos (reindent-then-newline-and-indent)
	    (newline)
	    (indent-according-to-mode))))))
   ((eq element '>)
    (if (and skeleton-regions (eq (nth 1 skeleton) '_))
	(indent-region (line-beginning-position)
		       (car skeleton-regions) nil)
      (indent-according-to-mode)))
   ((eq element '_)
    (if skeleton-regions
	(progn
	  (goto-char (pop skeleton-regions))
	  (and (<= (current-column) (current-indentation))
	       (eq (nth 1 skeleton) '\n)
399 400 401 402 403 404 405 406 407 408 409 410 411
	       (end-of-line 0)))
      (or skeleton-point
	  (setq skeleton-point (point)))))
   ((eq element '-)
    (setq skeleton-point (point)))
   ((eq element '&)
    (when skeleton-modified (pop skeleton)))
   ((eq element '|)
    (unless skeleton-modified (pop skeleton)))
   ((eq element '@)
    (push (point) skeleton-positions))
   ((eq 'quote (car-safe element))
    (eval (nth 1 element)))
412 413 414
   ((and (consp element)
	 (or (stringp (car element)) (listp (car element))))
    ;; Don't forget: `symbolp' is also true for nil.
415
    (if (symbolp (car-safe (car element)))
416 417 418
	(while (and (skeleton-internal-list element nil t)
		    ;; If the interactor is nil, don't infinite loop.
		    (car element)))
419 420 421 422 423
      (setq literal (car element))
      (while literal
	(skeleton-internal-list element (car literal))
	(setq literal (cdr literal)))))
   ((null element))
424
   (t (skeleton-internal-1 (eval element) t recursive))))
425

Karl Heuer's avatar
Karl Heuer committed
426
;; Maybe belongs into simple.el or elsewhere
427 428
;; ;;;###autoload
;; (define-skeleton local-variables-section
429 430 431 432 433 434 435 436
;;  "Insert a local variables section.  Use current comment syntax if any."
;;  (completing-read "Mode: " obarray
;;		   (lambda (symbol)
;;		     (if (commandp symbol)
;;			 (string-match "-mode$" (symbol-name symbol))))
;;		   t)
;;  '(save-excursion
;;     (if (re-search-forward page-delimiter nil t)
437
;;	 (error "Not on last page")))
438 439 440 441 442 443 444 445 446 447 448 449 450 451
;;  comment-start "Local Variables:" comment-end \n
;;  comment-start "mode: " str
;;  & -5 | '(kill-line 0) & -1 | comment-end \n
;;  ( (completing-read (format "Variable, %s: " skeleton-subprompt)
;;		     obarray
;;		     (lambda (symbol)
;;		       (or (eq symbol 'eval)
;;			   (user-variable-p symbol)))
;;		     t)
;;    comment-start str ": "
;;    (read-from-minibuffer "Expression: " nil read-expression-map nil
;;			  'read-expression-history) | _
;;    comment-end \n)
;;  resume:
452
;;  comment-start "End:" comment-end \n)
Richard M. Stallman's avatar
Richard M. Stallman committed
453

454
;; Variables and command for automatically inserting pairs like () or "".
Richard M. Stallman's avatar
Richard M. Stallman committed
455

456
(defvar skeleton-pair nil
Richard M. Stallman's avatar
Richard M. Stallman committed
457
  "*If this is nil pairing is turned off, no matter what else is set.
458 459
Otherwise modes with `skeleton-pair-insert-maybe' on some keys
will attempt to insert pairs of matching characters.")
Richard M. Stallman's avatar
Richard M. Stallman committed
460 461


462 463
(defvar skeleton-pair-on-word nil
  "*If this is nil, paired insertion is inhibited before or inside a word.")
Richard M. Stallman's avatar
Richard M. Stallman committed
464 465


466
(defvar skeleton-pair-filter (lambda () nil)
467
  "Attempt paired insertion if this function returns nil, before inserting.
Richard M. Stallman's avatar
Richard M. Stallman committed
468 469 470
This allows for context-sensitive checking whether pairing is appropriate.")


471 472 473 474
(defvar skeleton-pair-alist ()
  "An override alist of pairing partners matched against `last-command-char'.
Each alist element, which looks like (ELEMENT ...), is passed to
`skeleton-insert' with no interactor.  Variable `str' does nothing.
Richard M. Stallman's avatar
Richard M. Stallman committed
475

Karl Heuer's avatar
Karl Heuer committed
476
Elements might be (?` ?` _ \"''\"), (?\\( ?  _ \" )\") or (?{ \\n > _ \\n ?} >).")
Richard M. Stallman's avatar
Richard M. Stallman committed
477

478 479 480 481 482 483
(defvar skeleton-pair-default-alist '((?( _ ?)) (?\))
				      (?[ _ ?]) (?\])
				      (?{ _ ?}) (?\})
				      (?< _ ?>) (?\>)
				      (?« _ ?») (?\»)
				      (?` _ ?')))
Richard M. Stallman's avatar
Richard M. Stallman committed
484 485

;;;###autoload
486
(defun skeleton-pair-insert-maybe (arg)
Richard M. Stallman's avatar
Richard M. Stallman committed
487 488
  "Insert the character you type ARG times.

489 490 491
With no ARG, if `skeleton-pair' is non-nil, pairing can occur.  If the region
is visible the pair is wrapped around it depending on `skeleton-autowrap'.
Else, if `skeleton-pair-on-word' is non-nil or we are not before or inside a
492
word, and if `skeleton-pair-filter' returns nil, pairing is performed.
493 494
Pairing is also prohibited if we are right after a quoting character
such as backslash.
Richard M. Stallman's avatar
Richard M. Stallman committed
495

496
If a match is found in `skeleton-pair-alist', that is inserted, else
Richard M. Stallman's avatar
Richard M. Stallman committed
497 498 499
the defaults are used.  These are (), [], {}, <> and `' for the
symmetrical ones, and the same character twice for the others."
  (interactive "*P")
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
  (if (or arg (not skeleton-pair))
      (self-insert-command (prefix-numeric-value arg))
    (let* ((mark (and skeleton-autowrap
		      (or (eq last-command 'mouse-drag-region)
			  (and transient-mark-mode mark-active))))
	   (skeleton-end-hook)
	   (char last-command-char)
	   (skeleton (or (assq char skeleton-pair-alist)
			 (assq char skeleton-pair-default-alist)
			 `(,char _ ,char))))
      (if (or (memq (char-syntax (preceding-char)) '(?\\ ?/))
	      (and (not mark)
		   (or overwrite-mode
		       (if (not skeleton-pair-on-word) (looking-at "\\w"))
		       (funcall skeleton-pair-filter))))
	  (self-insert-command (prefix-numeric-value arg))
	(skeleton-insert (cons nil skeleton) (if mark -1))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
517 518


519 520
;; A more serious example can be found in sh-script.el
;;; (defun mirror-mode ()
521 522 523 524 525
;;  "This major mode is an amusing little example of paired insertion.
;;All printable characters do a paired self insert, while the other commands
;;work normally."
;;  (interactive)
;;  (kill-all-local-variables)
526 527 528 529
;;  (make-local-variable 'skeleton-pair)
;;  (make-local-variable 'skeleton-pair-on-word)
;;  (make-local-variable 'skeleton-pair-filter)
;;  (make-local-variable 'skeleton-pair-alist)
530 531
;;  (setq major-mode 'mirror-mode
;;	mode-name "Mirror"
532
;;	skeleton-pair-on-word t
533
;;	;; in the middle column insert one or none if odd window-width
534 535 536 537 538 539 540 541
;;	skeleton-pair-filter (lambda ()
;;			       (if (>= (current-column)
;;				       (/ (window-width) 2))
;;				   ;; insert both on next line
;;				   (next-line 1)
;;				 ;; insert one or both?
;;				 (= (* 2 (1+ (current-column)))
;;				    (window-width))))
542
;;	;; mirror these the other way round as well
543 544 545 546 547 548 549 550
;;	skeleton-pair-alist '((?) _ ?()
;;			      (?] _ ?[)
;;			      (?} _ ?{)
;;			      (?> _ ?<)
;;			      (?/ _ ?\\)
;;			      (?\\ _ ?/)
;;			      (?` ?` _ "''")
;;			      (?' ?' _ "``"))
551
;;	;; in this mode we exceptionally ignore the user, else it's no fun
552 553 554 555 556 557 558
;;	skeleton-pair t)
;;  (let ((map (make-vector 256 'skeleton-pair-insert-maybe))
;;	(i 0))
;;    (use-local-map `(keymap ,map))
;;    (while (< i ? )
;;      (aset map i nil)
;;      (aset map (+ i 128) nil)
559
;;      (setq i (1+ i))))
Lute Kamstra's avatar
Lute Kamstra committed
560
;;  (run-mode-hooks 'mirror-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
561

Richard M. Stallman's avatar
Richard M. Stallman committed
562 563
(provide 'skeleton)

Miles Bader's avatar
Miles Bader committed
564
;;; arch-tag: ccad7bd5-eb5d-40de-9ded-900197215c3e
565
;;; skeleton.el ends here