skeleton.el 21.8 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 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@Informatik.START.dbp.de, fax (+49 69) 7588-2389
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 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, 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 41
;; page 2:	paired insertion
;; page 3:	mirror-mode, an example for setting up paired insertion


(defvar skeleton-transformation nil
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 53 54 55 56 57 58 59 60 61
(defvar skeleton-autowrap t
  "Controls wrapping behaviour of functions created with `define-skeleton'.
When the region is visible (due to `transient-mark-mode' or marking a region
with the mouse) and this is non-`nil' and the function was called without an
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 67 68 69 70
(defvar skeleton-end-hook
  (lambda ()
    (or (eolp) (newline-and-indent)))
  "Hook called at end of skeleton but before going to point of interest.
By default this moves out anything following to next line.
The variables `v1' and `v2' are still set when calling this.")


Karl Heuer's avatar
Karl Heuer committed
71 72
;;;###autoload
(defvar skeleton-filter 'identity
73
  "Function for transforming a skeleton proxy's aliases' variable value.")
Karl Heuer's avatar
Karl Heuer committed
74 75 76 77

(defvar skeleton-untabify t
  "When non-`nil' untabifies when deleting backwards with element -ARG.")

78 79 80
(defvar skeleton-newline-indent-rigidly nil
  "When non-`nil', indent rigidly under current line for element `\\n'.
Else use mode's `indent-line-function'.")
Karl Heuer's avatar
Karl Heuer committed
81 82 83 84 85 86 87 88 89

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

Richard M. Stallman's avatar
Richard M. Stallman committed
95

96 97
(defvar skeleton-abbrev-cleanup nil
  "Variable used to delete the character that led to abbrev expansion.")
Richard M. Stallman's avatar
Richard M. Stallman committed
98 99 100 101 102


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

103 104 105 106 107
;; 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
108 109

;;;###autoload
Karl Heuer's avatar
Karl Heuer committed
110
(defmacro define-skeleton (command documentation &rest skeleton)
Richard M. Stallman's avatar
Richard M. Stallman committed
111 112
  "Define a user-configurable COMMAND that enters a statement skeleton.
DOCUMENTATION is that of the command, while the variable of the same name,
Karl Heuer's avatar
Karl Heuer committed
113 114
which contains the skeleton, has a documentation to that effect.
INTERACTOR and ELEMENT ... are as defined under `skeleton-insert'."
Richard M. Stallman's avatar
Richard M. Stallman committed
115
  (if skeleton-debug
Karl Heuer's avatar
Karl Heuer committed
116
      (set command skeleton))
117
  `(progn
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
     (defun ,command (&optional str arg)
       ,(concat documentation
		(if (string-match "\n\\>" documentation)
		    "" "\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.
A prefix argument of zero says to wrap around zero words---that is, nothing.
This is a way of overiding the use of a highlighted region.")
       (interactive "*P\nP")
       (skeleton-proxy-new ',skeleton str arg))))
Karl Heuer's avatar
Karl Heuer committed
133

134 135 136 137 138 139 140 141
;;;###autoload
(defun skeleton-proxy-new (skeleton &optional str arg)
  "Insert skeleton defined by variable of same name (see `skeleton-insert').
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
142

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
When called as a function, optional first argument STR may also be a string
which will be the value of `str' whereas the skeleton's interactor is then
ignored."
  (interactive "*P\nP")
  (setq skeleton (funcall skeleton-filter skeleton))
  (if (not skeleton)
      (if (memq this-command '(self-insert-command
			       skeleton-pair-insert-maybe
			       expand-abbrev))
	  (setq buffer-undo-list (primitive-undo 1 buffer-undo-list)))
    (skeleton-insert skeleton
		     (if (setq skeleton-abbrev-cleanup
			       (or (eq this-command 'self-insert-command)
				   (eq this-command
				       'skeleton-pair-insert-maybe)))
			 ()
		       ;; 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))
			      -1)))
		     (if (stringp str)
			 str))
    (and skeleton-abbrev-cleanup
	 (setq skeleton-abbrev-cleanup (point))
	 (add-hook 'post-command-hook 'skeleton-abbrev-cleanup nil t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
172

Richard M. Stallman's avatar
Richard M. Stallman committed
173
;; This command isn't meant to be called, only its aliases with meaningful
Karl Heuer's avatar
Karl Heuer committed
174 175
;; names are.
;;;###autoload
176 177
(defun skeleton-proxy (&optional str arg)
  "Insert skeleton defined by variable of same name (see `skeleton-insert').
Karl Heuer's avatar
Karl Heuer committed
178
Prefix ARG allows wrapping around words or regions (see `skeleton-insert').
179
If no ARG was given, but the region is visible, ARG defaults to -1 depending
180
on `skeleton-autowrap'.  An ARG of  M-0  will prevent this just for once.
Karl Heuer's avatar
Karl Heuer committed
181
This command can also be an abbrev expansion (3rd and 4th columns in
182 183 184 185 186 187
\\[edit-abbrevs]  buffer: \"\"  command-name).

When called as a function, optional first argument STR may also be a string
which will be the value of `str' whereas the skeleton's interactor is then
ignored."
  (interactive "*P\nP")
Karl Heuer's avatar
Karl Heuer committed
188
  (let ((function (nth 1 (backtrace-frame 1))))
189
    (if (eq function 'nth)		; uncompiled Lisp function
Karl Heuer's avatar
Karl Heuer committed
190 191 192 193
	(setq function (nth 1 (backtrace-frame 5)))
      (if (eq function 'byte-code)	; tracing byte-compiled function
	  (setq function (nth 1 (backtrace-frame 2)))))
    (if (not (setq function (funcall skeleton-filter (symbol-value function))))
194 195 196 197
	(if (memq this-command '(self-insert-command
				 skeleton-pair-insert-maybe
				 expand-abbrev))
	    (setq buffer-undo-list (primitive-undo 1 buffer-undo-list)))
Karl Heuer's avatar
Karl Heuer committed
198 199 200
      (skeleton-insert function
		       (if (setq skeleton-abbrev-cleanup
				 (or (eq this-command 'self-insert-command)
201 202
				     (eq this-command
					 'skeleton-pair-insert-maybe)))
Karl Heuer's avatar
Karl Heuer committed
203
			   ()
204
			 ;; Pretend  C-x a e  passed its prefix arg to us
Karl Heuer's avatar
Karl Heuer committed
205 206
			 (if (or arg current-prefix-arg)
			     (prefix-numeric-value (or arg
207 208 209 210
						       current-prefix-arg))
			   (and skeleton-autowrap
				(or (eq last-command 'mouse-drag-region)
				    (and transient-mark-mode mark-active))
211
				-1)))
212 213
		       (if (stringp str)
			   str))
214 215 216
      (and skeleton-abbrev-cleanup
	   (setq skeleton-abbrev-cleanup (point))
	   (add-hook 'post-command-hook 'skeleton-abbrev-cleanup nil t)))))
Karl Heuer's avatar
Karl Heuer committed
217 218 219 220 221 222 223


(defun skeleton-abbrev-cleanup (&rest list)
  "Value for `post-command-hook' to remove char that expanded abbrev."
  (if (integerp skeleton-abbrev-cleanup)
      (progn
	(delete-region skeleton-abbrev-cleanup (point))
224 225
	(setq skeleton-abbrev-cleanup)
	(remove-hook 'post-command-hook 'skeleton-abbrev-cleanup t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
226 227 228


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

Karl Heuer's avatar
Karl Heuer committed
232 233 234 235 236 237 238 239
With optional third 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.  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.

240 241 242 243
Optional fourth STR 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.

Karl Heuer's avatar
Karl Heuer committed
244 245
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
246 247 248 249

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

250
	\\n	go to next line and indent according to mode
Karl Heuer's avatar
Karl Heuer committed
251 252 253 254 255
	_	interesting point, interregion here, point after termination
	>	indent line (or interregion if > _) according to major mode
	&	do next ELEMENT if previous moved point
	|	do next ELEMENT if previous didn't move point
	-num	delete num preceding characters (see `skeleton-untabify')
Richard M. Stallman's avatar
Richard M. Stallman committed
256 257 258
	resume:	skipped, continue here if quit is signaled
	nil	skipped

Karl Heuer's avatar
Karl Heuer committed
259 260 261 262 263 264
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
265 266
formatted with `skeleton-subprompt'.  Such an INTERACTOR may also a list of
strings with the subskeleton being repeated once for each string.
Richard M. Stallman's avatar
Richard M. Stallman committed
267

268 269
Quoted Lisp expressions are evaluated evaluated for their side-effect.
Other Lisp expressions are evaluated and the value treated as above.
Karl Heuer's avatar
Karl Heuer committed
270
Note that expressions may not return `t' since this implies an
Karl Heuer's avatar
Karl Heuer committed
271 272 273
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
274

Karl Heuer's avatar
Karl Heuer committed
275
	str	first time: read a string according to INTERACTOR
Richard M. Stallman's avatar
Richard M. Stallman committed
276
		then: insert previously read string once more
Karl Heuer's avatar
Karl Heuer committed
277
	help	help-form during interaction with the user or `nil'
278
	input	initial input (string or cons with index) while reading str
279
	v1, v2	local variables for memorizing anything you want
280 281 282 283 284 285

When done with skeleton, but before going back to `_'-point call
`skeleton-end-hook' if that is non-`nil'."
  (and skeleton-regions
       (setq skeleton-regions
	     (if (> skeleton-regions 0)
Karl Heuer's avatar
Karl Heuer committed
286
		 (list (point-marker)
287 288 289 290
		       (save-excursion (forward-word skeleton-regions)
				       (point-marker)))
	       (setq skeleton-regions (- skeleton-regions))
	       ;; copy skeleton-regions - 1 elements from `mark-ring'
Karl Heuer's avatar
Karl Heuer committed
291 292
	       (let ((l1 (cons (mark-marker) mark-ring))
		     (l2 (list (point-marker))))
293
		 (while (and l1 (> skeleton-regions 0))
Karl Heuer's avatar
Karl Heuer committed
294
		   (setq l2 (cons (car l1) l2)
295
			 skeleton-regions (1- skeleton-regions)
Karl Heuer's avatar
Karl Heuer committed
296 297
			 l1 (cdr l1)))
		 (sort l2 '<))))
298 299
       (goto-char (car skeleton-regions))
       (setq skeleton-regions (cdr skeleton-regions)))
300
  (let ((beg (point))
301
	skeleton-modified skeleton-point resume: help input v1 v2)
Karl Heuer's avatar
Karl Heuer committed
302
    (unwind-protect
303
	(eval `(let ,skeleton-further-elements
304 305
		 (skeleton-internal-list skeleton str)))
      (run-hooks 'skeleton-end-hook)
306 307 308 309 310
      (sit-for 0)
      (or (pos-visible-in-window-p beg)
	  (progn
	    (goto-char beg)
	    (recenter 0)))
311 312
      (if skeleton-point
	  (goto-char skeleton-point)))))
Karl Heuer's avatar
Karl Heuer committed
313 314

(defun skeleton-read (str &optional initial-input recursive)
315
  "Function for reading a string from the minibuffer within skeletons.
Karl Heuer's avatar
Karl Heuer committed
316
PROMPT may contain a `%s' which will be replaced by `skeleton-subprompt'.
317 318 319 320 321 322
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'
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
is non-`nil' or a default string."
323 324
  (let ((minibuffer-help-form (or (if (boundp 'help) (symbol-value 'help))
				  (if recursive "\
Richard M. Stallman's avatar
Richard M. Stallman committed
325 326 327 328 329 330 331
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
332
syntactically necessary termination."
333
					 "\
Karl Heuer's avatar
Karl Heuer committed
334
You are inserting a skeleton.  Standard text gets inserted into the buffer
335 336 337 338 339 340 341 342 343 344 345 346 347 348
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
	(setq str (if (stringp str)
		      (read-string (format str skeleton-subprompt)
				   (setq initial-input
					 (or initial-input
					     (symbol-value 'input))))
		    (eval str)))
      (or eolp
	  (delete-char 1))))
349 350 351 352 353
  (if (and recursive
	   (or (null str)
	       (string= str "")
	       (equal str initial-input)
	       (equal str (car-safe initial-input))))
Richard M. Stallman's avatar
Richard M. Stallman committed
354 355 356
      (signal 'quit t)
    str))

357
(defun skeleton-internal-list (skeleton &optional str recursive)
Karl Heuer's avatar
Karl Heuer committed
358 359 360 361 362
  (let* ((start (save-excursion (beginning-of-line) (point)))
	 (column (current-column))
	 (line (buffer-substring start
				 (save-excursion (end-of-line) (point))))
	 opoint)
363 364 365
    (or str
	(setq str `(setq str (skeleton-read ',(car skeleton) nil ,recursive))))
    (while (setq skeleton-modified (eq opoint (point))
366 367 368 369 370 371
		 opoint (point)
		 skeleton (cdr skeleton))
      (condition-case quit
	  (skeleton-internal-1 (car skeleton))
	(quit
	 (if (eq (cdr quit) 'recursive)
372 373
	     (setq recursive 'quit
		   skeleton (memq 'resume: skeleton))
374 375
	   ;; remove the subskeleton as far as it has been shown
	   ;; the subskeleton shouldn't have deleted outside current line
376
	   (end-of-line)
377 378 379 380 381 382 383 384 385 386 387
	   (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
388 389 390


(defun skeleton-internal-1 (element &optional literal)
391 392 393 394 395 396 397 398 399 400
  (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)))
	   (insert-before-markers (if (and skeleton-transformation
					   (not literal))
				      (funcall skeleton-transformation element)
				    element))))
401
	((eq element '\n)		; actually (eq '\n 'n)
402 403 404 405 406 407 408 409 410 411 412
	 (if (and skeleton-regions
		  (eq (nth 1 skeleton) '_))
	     (progn
	       (or (eolp)
		   (newline))
	       (indent-region (point) (car skeleton-regions) nil))
	   (if skeleton-newline-indent-rigidly
	       (indent-to (prog1 (current-indentation)
			    (newline)))
	     (newline)
	     (indent-according-to-mode))))
413
	((eq element '>)
414
	 (if (and skeleton-regions
Karl Heuer's avatar
Karl Heuer committed
415
		  (eq (nth 1 skeleton) '_))
416 417
	     (indent-region (point) (car skeleton-regions) nil)
	   (indent-according-to-mode)))
418
	((eq element '_)
419
	 (if skeleton-regions
Karl Heuer's avatar
Karl Heuer committed
420
	     (progn
421
	       (goto-char (car skeleton-regions))
422 423 424 425
	       (setq skeleton-regions (cdr skeleton-regions))
	       (and (<= (current-column) (current-indentation))
		    (eq (nth 1 skeleton) '\n)
		    (end-of-line 0)))
426 427
	   (or skeleton-point
	       (setq skeleton-point (point)))))
428
	((eq element '&)
429
	 (if skeleton-modified
Karl Heuer's avatar
Karl Heuer committed
430
	     (setq skeleton (cdr skeleton))))
431
	((eq element '|)
432
	 (or skeleton-modified
Karl Heuer's avatar
Karl Heuer committed
433
	     (setq skeleton (cdr skeleton))))
434
	((eq 'quote (car-safe element))
Karl Heuer's avatar
Karl Heuer committed
435
	 (eval (nth 1 element)))
436 437 438 439 440 441 442 443
	((or (stringp (car-safe element))
	     (consp (car-safe element)))
	 (if (symbolp (car-safe (car element)))
	     (while (skeleton-internal-list element nil t))
	   (setq literal (car element))
	   (while literal
	     (skeleton-internal-list element (car literal))
	     (setq literal (cdr literal)))))
Karl Heuer's avatar
Karl Heuer committed
444 445
	((null element))
	((skeleton-internal-1 (eval element) t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
446

447

Karl Heuer's avatar
Karl Heuer committed
448
;; Maybe belongs into simple.el or elsewhere
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
;; ;###autoload
;;; (define-skeleton local-variables-section
;;  "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)
;;	 (error "Not on last page.")))
;;  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:
474
;;  comment-start "End:" comment-end \n)
Richard M. Stallman's avatar
Richard M. Stallman committed
475

476
;; Variables and command for automatically inserting pairs like () or "".
Richard M. Stallman's avatar
Richard M. Stallman committed
477

478
(defvar skeleton-pair nil
Richard M. Stallman's avatar
Richard M. Stallman committed
479
  "*If this is nil pairing is turned off, no matter what else is set.
480 481
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
482 483


484 485
(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
486 487


488 489
(defvar skeleton-pair-filter (lambda ())
  "Attempt paired insertion if this function returns nil, before inserting.
Richard M. Stallman's avatar
Richard M. Stallman committed
490 491 492
This allows for context-sensitive checking whether pairing is appropriate.")


493 494 495 496
(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
497

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


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

505 506 507
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
508
word, and if `skeleton-pair-filter' returns nil, pairing is performed.
Richard M. Stallman's avatar
Richard M. Stallman committed
509

510
If a match is found in `skeleton-pair-alist', that is inserted, else
Richard M. Stallman's avatar
Richard M. Stallman committed
511 512 513
the defaults are used.  These are (), [], {}, <> and `' for the
symmetrical ones, and the same character twice for the others."
  (interactive "*P")
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
  (let ((mark (and skeleton-autowrap
		   (or (eq last-command 'mouse-drag-region)
		       (and transient-mark-mode mark-active))))
	(skeleton-end-hook))
    (if (or arg
	    (not skeleton-pair)
	    (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))
      (setq last-command-char (logand last-command-char 255))
      (or skeleton-abbrev-cleanup
	  (skeleton-insert
	   (cons nil (or (assq last-command-char skeleton-pair-alist)
			 (assq last-command-char '((?( _ ?))
						   (?[ _ ?])
						   (?{ _ ?})
						   (?< _ ?>)
						   (?` _ ?')))
			 `(,last-command-char _ ,last-command-char)))
	   (if mark -1))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
536 537


538 539
;; A more serious example can be found in sh-script.el
;;; (defun mirror-mode ()
540 541 542 543 544
;;  "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)
545 546 547 548
;;  (make-local-variable 'skeleton-pair)
;;  (make-local-variable 'skeleton-pair-on-word)
;;  (make-local-variable 'skeleton-pair-filter)
;;  (make-local-variable 'skeleton-pair-alist)
549 550
;;  (setq major-mode 'mirror-mode
;;	mode-name "Mirror"
551
;;	skeleton-pair-on-word t
552
;;	;; in the middle column insert one or none if odd window-width
553 554 555 556 557 558 559 560
;;	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))))
561
;;	;; mirror these the other way round as well
562 563 564 565 566 567 568 569
;;	skeleton-pair-alist '((?) _ ?()
;;			      (?] _ ?[)
;;			      (?} _ ?{)
;;			      (?> _ ?<)
;;			      (?/ _ ?\\)
;;			      (?\\ _ ?/)
;;			      (?` ?` _ "''")
;;			      (?' ?' _ "``"))
570
;;	;; in this mode we exceptionally ignore the user, else it's no fun
571 572 573 574 575 576 577
;;	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)
578 579
;;      (setq i (1+ i))))
;;  (run-hooks 'mirror-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
580

Richard M. Stallman's avatar
Richard M. Stallman committed
581 582
(provide 'skeleton)

Richard M. Stallman's avatar
Richard M. Stallman committed
583
;; skeleton.el ends here