skeleton.el 21.7 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 4
;; Copyright (C) 1993, 1994, 1995, 1996, 2002, 2003,
;;   2004, 2005 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5

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

;; 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
23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
26 27 28

;;; Commentary:

Karl Heuer's avatar
Karl Heuer committed
29
;; A very concise language extension for writing structured statement
Richard M. Stallman's avatar
Richard M. Stallman committed
30 31 32 33 34 35 36
;; 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
37
;; page 1:	statement skeleton language definition & interpreter
Richard M. Stallman's avatar
Richard M. Stallman committed
38 39 40 41
;; page 2:	paired insertion
;; page 3:	mirror-mode, an example for setting up paired insertion


42
(defvar skeleton-transformation 'identity
Karl Heuer's avatar
Karl Heuer committed
43
  "*If non-nil, function applied to literal strings before they are inserted.
Richard M. Stallman's avatar
Richard M. Stallman committed
44 45 46 47 48 49 50 51 52
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: ")


53
(defvar skeleton-autowrap t
54
  "Controls wrapping behavior of functions created with `define-skeleton'.
55
When the region is visible (due to `transient-mark-mode' or marking a region
56
with the mouse) and this is non-nil and the function was called without an
57 58 59 60 61 62
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
63

64 65 66 67
(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.")

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


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

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

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

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

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

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

105 106 107 108
(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.")
109

110 111 112 113 114
;; 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
115

116 117 118 119
(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
120
;;;###autoload
Karl Heuer's avatar
Karl Heuer committed
121
(defmacro define-skeleton (command documentation &rest skeleton)
Richard M. Stallman's avatar
Richard M. Stallman committed
122
  "Define a user-configurable COMMAND that enters a statement skeleton.
123 124
DOCUMENTATION is that of the command.
SKELETON is as defined under `skeleton-insert'."
125
  (declare (debug (&define name stringp skeleton-edebug-spec)))
Richard M. Stallman's avatar
Richard M. Stallman committed
126
  (if skeleton-debug
Karl Heuer's avatar
Karl Heuer committed
127
      (set command skeleton))
128
  `(progn
129 130 131
     ;; 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)
132 133
     (defun ,command (&optional str arg)
       ,(concat documentation
134
		(if (string-match "\n\\'" documentation)
135 136 137 138 139 140 141 142
		    "" "\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.
143
A prefix argument of -1 says to wrap around region, even if not highlighted.
144
A prefix argument of zero says to wrap around zero words---that is, nothing.
145
This is a way of overriding the use of a highlighted region.")
146 147
       (interactive "*P\nP")
       (skeleton-proxy-new ',skeleton str arg))))
Karl Heuer's avatar
Karl Heuer committed
148

149 150
;;;###autoload
(defun skeleton-proxy-new (skeleton &optional str arg)
151
  "Insert SKELETON.
152 153 154 155 156
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
157

158
Optional second argument STR may also be a string which will be the value
159 160 161 162 163 164 165 166 167
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))
168 169 170 171 172 173
			  ;; 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)))
174 175 176 177 178
		   (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
179 180

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

184 185 186 187
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
188

189 190 191 192 193 194 195 196
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.
197

Karl Heuer's avatar
Karl Heuer committed
198 199
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
200 201 202 203

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

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

216 217
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
218

Karl Heuer's avatar
Karl Heuer committed
219 220 221 222 223 224
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
225
formatted with `skeleton-subprompt'.  Such an INTERACTOR may also be a list of
226
strings with the subskeleton being repeated once for each string.
Richard M. Stallman's avatar
Richard M. Stallman committed
227

228
Quoted Lisp expressions are evaluated for their side-effects.
229
Other Lisp expressions are evaluated and the value treated as above.
230
Note that expressions may not return t since this implies an
Karl Heuer's avatar
Karl Heuer committed
231 232 233
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
234

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

When done with skeleton, but before going back to `_'-point call
242
`skeleton-end-hook' if that is non-nil."
243 244 245 246
  (let ((skeleton-regions regions))
    (and skeleton-regions
	 (setq skeleton-regions
	       (if (> skeleton-regions 0)
247
		   (list (copy-marker (point) t)
248 249 250 251 252
			 (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))
253
		       (l2 (list (copy-marker (point) t))))
254
		   (while (and l1 (> skeleton-regions 0))
255 256
		     (push (copy-marker (pop l1) t) l2)
		     (setq skeleton-regions (1- skeleton-regions)))
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
		   (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))))))

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

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'.
280 281
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
282 283 284
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
285
is non-nil or a default string."
286 287
  (let ((minibuffer-help-form (or (if (boundp 'help) (symbol-value 'help))
				  (if recursive "\
Richard M. Stallman's avatar
Richard M. Stallman committed
288 289 290 291 292 293 294
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
295
syntactically necessary termination."
296
				    "\
Karl Heuer's avatar
Karl Heuer committed
297
You are inserting a skeleton.  Standard text gets inserted into the buffer
298 299 300 301 302 303
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
304 305 306 307 308 309
	(setq prompt (if (stringp prompt)
			 (read-string (format prompt skeleton-subprompt)
				      (setq initial-input
					    (or initial-input
						(symbol-value 'input))))
		       (eval prompt)))
310 311
      (or eolp
	  (delete-char 1))))
312
  (if (and recursive
313 314 315 316
	   (or (null prompt)
	       (string= prompt "")
	       (equal prompt initial-input)
	       (equal prompt (car-safe initial-input))))
Richard M. Stallman's avatar
Richard M. Stallman committed
317
      (signal 'quit t)
318
    prompt))
Richard M. Stallman's avatar
Richard M. Stallman committed
319

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

354
(defun skeleton-internal-1 (element &optional literal recursive)
355 356 357 358 359 360 361
  (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)))
362
      (insert (if (not literal)
363 364 365 366 367 368 369 370 371 372 373 374 375 376
		  (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.
377
       ((and (null (cdr skeleton)) (not recursive) (eolp))
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
	(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)
400 401 402 403 404 405 406 407 408 409 410 411 412
	       (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)))
413 414 415
   ((and (consp element)
	 (or (stringp (car element)) (listp (car element))))
    ;; Don't forget: `symbolp' is also true for nil.
416
    (if (symbolp (car-safe (car element)))
417 418 419
	(while (and (skeleton-internal-list element nil t)
		    ;; If the interactor is nil, don't infinite loop.
		    (car element)))
420 421 422 423 424
      (setq literal (car element))
      (while literal
	(skeleton-internal-list element (car literal))
	(setq literal (cdr literal)))))
   ((null element))
425
   (t (skeleton-internal-1 (eval element) t recursive))))
426

Karl Heuer's avatar
Karl Heuer committed
427
;; Maybe belongs into simple.el or elsewhere
428 429
;; ;;;###autoload
;; (define-skeleton local-variables-section
430 431 432 433 434 435 436 437
;;  "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)
438
;;	 (error "Not on last page")))
439 440 441 442 443 444 445 446 447 448 449 450 451 452
;;  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:
453
;;  comment-start "End:" comment-end \n)
Richard M. Stallman's avatar
Richard M. Stallman committed
454

455
;; Variables and command for automatically inserting pairs like () or "".
Richard M. Stallman's avatar
Richard M. Stallman committed
456

457
(defvar skeleton-pair nil
Richard M. Stallman's avatar
Richard M. Stallman committed
458
  "*If this is nil pairing is turned off, no matter what else is set.
459 460
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
461 462


463 464
(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
465 466


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


472 473 474 475
(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
476

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

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

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

490 491 492
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
493
word, and if `skeleton-pair-filter' returns nil, pairing is performed.
494 495
Pairing is also prohibited if we are right after a quoting character
such as backslash.
Richard M. Stallman's avatar
Richard M. Stallman committed
496

497
If a match is found in `skeleton-pair-alist', that is inserted, else
Richard M. Stallman's avatar
Richard M. Stallman committed
498 499 500
the defaults are used.  These are (), [], {}, <> and `' for the
symmetrical ones, and the same character twice for the others."
  (interactive "*P")
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
  (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
518 519


520 521
;; A more serious example can be found in sh-script.el
;;; (defun mirror-mode ()
522 523 524 525 526
;;  "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)
527 528 529 530
;;  (make-local-variable 'skeleton-pair)
;;  (make-local-variable 'skeleton-pair-on-word)
;;  (make-local-variable 'skeleton-pair-filter)
;;  (make-local-variable 'skeleton-pair-alist)
531 532
;;  (setq major-mode 'mirror-mode
;;	mode-name "Mirror"
533
;;	skeleton-pair-on-word t
534
;;	;; in the middle column insert one or none if odd window-width
535 536 537 538 539 540 541 542
;;	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))))
543
;;	;; mirror these the other way round as well
544 545 546 547 548 549 550 551
;;	skeleton-pair-alist '((?) _ ?()
;;			      (?] _ ?[)
;;			      (?} _ ?{)
;;			      (?> _ ?<)
;;			      (?/ _ ?\\)
;;			      (?\\ _ ?/)
;;			      (?` ?` _ "''")
;;			      (?' ?' _ "``"))
552
;;	;; in this mode we exceptionally ignore the user, else it's no fun
553 554 555 556 557 558 559
;;	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)
560
;;      (setq i (1+ i))))
Lute Kamstra's avatar
Lute Kamstra committed
561
;;  (run-mode-hooks 'mirror-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
562

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

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