skeleton.el 22.9 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 <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 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
(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 81 82

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

83 84 85
(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
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
(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
103 104 105 106 107


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

108 109 110 111
(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.")
112

113 114 115 116 117
;; 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
118 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 122
  "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
123 124
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
125
  (if skeleton-debug
Karl Heuer's avatar
Karl Heuer committed
126
      (set command skeleton))
127
  `(progn
128 129 130 131 132 133 134 135 136 137 138
     (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.
139
A prefix argument of -1 says to wrap around region, even if not highlighted.
140
A prefix argument of zero says to wrap around zero words---that is, nothing.
141
This is a way of overriding the use of a highlighted region.")
142 143
       (interactive "*P\nP")
       (skeleton-proxy-new ',skeleton str arg))))
Karl Heuer's avatar
Karl Heuer committed
144

145 146 147 148 149 150 151 152
;;;###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
153

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
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
183

Richard M. Stallman's avatar
Richard M. Stallman committed
184
;; This command isn't meant to be called, only its aliases with meaningful
Karl Heuer's avatar
Karl Heuer committed
185 186
;; names are.
;;;###autoload
187 188
(defun skeleton-proxy (&optional str arg)
  "Insert skeleton defined by variable of same name (see `skeleton-insert').
Karl Heuer's avatar
Karl Heuer committed
189
Prefix ARG allows wrapping around words or regions (see `skeleton-insert').
190
If no ARG was given, but the region is visible, ARG defaults to -1 depending
191
on `skeleton-autowrap'.  An ARG of  M-0  will prevent this just for once.
Karl Heuer's avatar
Karl Heuer committed
192
This command can also be an abbrev expansion (3rd and 4th columns in
193 194 195 196 197 198
\\[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
199
  (let ((function (nth 1 (backtrace-frame 1))))
200
    (if (eq function 'nth)		; uncompiled Lisp function
Karl Heuer's avatar
Karl Heuer committed
201 202 203 204
	(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))))
205 206 207 208
	(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
209 210 211
      (skeleton-insert function
		       (if (setq skeleton-abbrev-cleanup
				 (or (eq this-command 'self-insert-command)
212 213
				     (eq this-command
					 'skeleton-pair-insert-maybe)))
Karl Heuer's avatar
Karl Heuer committed
214
			   ()
215
			 ;; Pretend  C-x a e  passed its prefix arg to us
Karl Heuer's avatar
Karl Heuer committed
216 217
			 (if (or arg current-prefix-arg)
			     (prefix-numeric-value (or arg
218 219 220 221
						       current-prefix-arg))
			   (and skeleton-autowrap
				(or (eq last-command 'mouse-drag-region)
				    (and transient-mark-mode mark-active))
222
				-1)))
223 224
		       (if (stringp str)
			   str))
225 226 227
      (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
228 229 230 231 232 233 234


(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))
235 236
	(setq skeleton-abbrev-cleanup)
	(remove-hook 'post-command-hook 'skeleton-abbrev-cleanup t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
237 238 239


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

243 244 245 246
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
247

248 249 250 251 252 253 254 255
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.
256

Karl Heuer's avatar
Karl Heuer committed
257 258
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
259 260 261 262

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

263
	\\n	go to next line and indent according to mode
Stefan Monnier's avatar
Stefan Monnier committed
264
	_	interesting point, interregion here
Karl Heuer's avatar
Karl Heuer committed
265
	>	indent line (or interregion if > _) according to major mode
266
	@	add position to `skeleton-positions'
Karl Heuer's avatar
Karl Heuer committed
267 268 269
	&	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
270 271 272
	resume:	skipped, continue here if quit is signaled
	nil	skipped

Stefan Monnier's avatar
Stefan Monnier committed
273 274 275
After termination, point will be positioned at the first occurrence
of _ or @ or at the end of the inserted text.

Karl Heuer's avatar
Karl Heuer committed
276 277 278 279 280 281
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
282
formatted with `skeleton-subprompt'.  Such an INTERACTOR may also be a list of
283
strings with the subskeleton being repeated once for each string.
Richard M. Stallman's avatar
Richard M. Stallman committed
284

285
Quoted Lisp expressions are evaluated for their side-effects.
286
Other Lisp expressions are evaluated and the value treated as above.
Karl Heuer's avatar
Karl Heuer committed
287
Note that expressions may not return `t' since this implies an
Karl Heuer's avatar
Karl Heuer committed
288 289 290
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
291

Karl Heuer's avatar
Karl Heuer committed
292
	str	first time: read a string according to INTERACTOR
Richard M. Stallman's avatar
Richard M. Stallman committed
293
		then: insert previously read string once more
Karl Heuer's avatar
Karl Heuer committed
294
	help	help-form during interaction with the user or `nil'
295
	input	initial input (string or cons with index) while reading str
296
	v1, v2	local variables for memorizing anything you want
297 298 299

When done with skeleton, but before going back to `_'-point call
`skeleton-end-hook' if that is non-`nil'."
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
  (let ((skeleton-regions regions))
    (and skeleton-regions
	 (setq skeleton-regions
	       (if (> skeleton-regions 0)
		   (list (point-marker)
			 (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))
		       (l2 (list (point-marker))))
		   (while (and l1 (> skeleton-regions 0))
		     (setq l2 (cons (car l1) l2)
			   skeleton-regions (1- skeleton-regions)
			   l1 (cdr l1)))
		   (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))))))

333
(defun skeleton-read (prompt &optional initial-input recursive)
334
  "Function for reading a string from the minibuffer within skeletons.
335 336 337

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'.
338 339 340 341 342
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
343
is non-nil or a default string."
344 345
  (let ((minibuffer-help-form (or (if (boundp 'help) (symbol-value 'help))
				  (if recursive "\
Richard M. Stallman's avatar
Richard M. Stallman committed
346 347 348 349 350 351 352
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
353
syntactically necessary termination."
354
				    "\
Karl Heuer's avatar
Karl Heuer committed
355
You are inserting a skeleton.  Standard text gets inserted into the buffer
356 357 358 359 360 361
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
362 363 364 365 366 367
	(setq prompt (if (stringp prompt)
			 (read-string (format prompt skeleton-subprompt)
				      (setq initial-input
					    (or initial-input
						(symbol-value 'input))))
		       (eval prompt)))
368 369
      (or eolp
	  (delete-char 1))))
370
  (if (and recursive
371 372 373 374
	   (or (null prompt)
	       (string= prompt "")
	       (equal prompt initial-input)
	       (equal prompt (car-safe initial-input))))
Richard M. Stallman's avatar
Richard M. Stallman committed
375
      (signal 'quit t)
376
    prompt))
Richard M. Stallman's avatar
Richard M. Stallman committed
377

378
(defun skeleton-internal-list (skeleton &optional str recursive)
Karl Heuer's avatar
Karl Heuer committed
379 380 381 382 383
  (let* ((start (save-excursion (beginning-of-line) (point)))
	 (column (current-column))
	 (line (buffer-substring start
				 (save-excursion (end-of-line) (point))))
	 opoint)
384 385
    (or str
	(setq str `(setq str (skeleton-read ',(car skeleton) nil ,recursive))))
386 387 388
    (when (and (eq (car skeleton) '\n)
	       (save-excursion (beginning-of-line) (looking-at "[ \t]*$")))
      (setq skeleton (cons '> (cdr skeleton))))
389
    (while (setq skeleton-modified (eq opoint (point))
390 391 392 393 394 395
		 opoint (point)
		 skeleton (cdr skeleton))
      (condition-case quit
	  (skeleton-internal-1 (car skeleton))
	(quit
	 (if (eq (cdr quit) 'recursive)
396 397
	     (setq recursive 'quit
		   skeleton (memq 'resume: skeleton))
398 399
	   ;; remove the subskeleton as far as it has been shown
	   ;; the subskeleton shouldn't have deleted outside current line
400
	   (end-of-line)
401 402 403 404 405 406 407 408 409 410 411
	   (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
412 413 414


(defun skeleton-internal-1 (element &optional literal)
415 416 417 418 419 420 421 422 423 424
  (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))))
425
	((eq element '\n)		; actually (eq '\n 'n)
426 427 428 429 430
	 (cond
	  ((and skeleton-regions (eq (nth 1 skeleton) '_))
	   (or (eolp) (newline))
	   (indent-region (line-beginning-position)
			  (car skeleton-regions) nil))
Stefan Monnier's avatar
Stefan Monnier committed
431
	  ;; \n as last element only inserts \n if not at eol.
432 433 434 435
	  ((and (null (cdr skeleton)) (eolp)) nil)
	  (skeleton-newline-indent-rigidly
	   (indent-to (prog1 (current-indentation) (newline))))
	  (t (newline) (indent-according-to-mode))))
436
	((eq element '>)
437
	 (if (and skeleton-regions (eq (nth 1 skeleton) '_))
438 439
	     (indent-region (line-beginning-position)
			    (car skeleton-regions) nil)
440
	   (indent-according-to-mode)))
441
	((eq element '_)
442
	 (if skeleton-regions
Karl Heuer's avatar
Karl Heuer committed
443
	     (progn
444
	       (goto-char (car skeleton-regions))
445 446 447 448
	       (setq skeleton-regions (cdr skeleton-regions))
	       (and (<= (current-column) (current-indentation))
		    (eq (nth 1 skeleton) '\n)
		    (end-of-line 0)))
449 450
	   (or skeleton-point
	       (setq skeleton-point (point)))))
451
	((eq element '&)
Stefan Monnier's avatar
Stefan Monnier committed
452
	 (when skeleton-modified (pop skeleton)))
453
	((eq element '|)
Stefan Monnier's avatar
Stefan Monnier committed
454
	 (unless skeleton-modified (pop skeleton)))
455
	((eq element '@)
456 457
	 (push (point) skeleton-positions)
	 (unless skeleton-point (setq skeleton-point (point))))
458
	((eq 'quote (car-safe element))
Karl Heuer's avatar
Karl Heuer committed
459
	 (eval (nth 1 element)))
460 461 462 463 464 465 466 467
	((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
468 469
	((null element))
	((skeleton-internal-1 (eval element) t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
470

471

Karl Heuer's avatar
Karl Heuer committed
472
;; Maybe belongs into simple.el or elsewhere
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
;; ;###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:
498
;;  comment-start "End:" comment-end \n)
Richard M. Stallman's avatar
Richard M. Stallman committed
499

500
;; Variables and command for automatically inserting pairs like () or "".
Richard M. Stallman's avatar
Richard M. Stallman committed
501

502
(defvar skeleton-pair nil
Richard M. Stallman's avatar
Richard M. Stallman committed
503
  "*If this is nil pairing is turned off, no matter what else is set.
504 505
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
506 507


508 509
(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
510 511


512 513
(defvar skeleton-pair-filter (lambda ())
  "Attempt paired insertion if this function returns nil, before inserting.
Richard M. Stallman's avatar
Richard M. Stallman committed
514 515 516
This allows for context-sensitive checking whether pairing is appropriate.")


517 518 519 520
(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
521

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


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

529 530 531
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
532
word, and if `skeleton-pair-filter' returns nil, pairing is performed.
Richard M. Stallman's avatar
Richard M. Stallman committed
533

534
If a match is found in `skeleton-pair-alist', that is inserted, else
Richard M. Stallman's avatar
Richard M. Stallman committed
535 536 537
the defaults are used.  These are (), [], {}, <> and `' for the
symmetrical ones, and the same character twice for the others."
  (interactive "*P")
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
  (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
560 561


562 563
;; A more serious example can be found in sh-script.el
;;; (defun mirror-mode ()
564 565 566 567 568
;;  "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)
569 570 571 572
;;  (make-local-variable 'skeleton-pair)
;;  (make-local-variable 'skeleton-pair-on-word)
;;  (make-local-variable 'skeleton-pair-filter)
;;  (make-local-variable 'skeleton-pair-alist)
573 574
;;  (setq major-mode 'mirror-mode
;;	mode-name "Mirror"
575
;;	skeleton-pair-on-word t
576
;;	;; in the middle column insert one or none if odd window-width
577 578 579 580 581 582 583 584
;;	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))))
585
;;	;; mirror these the other way round as well
586 587 588 589 590 591 592 593
;;	skeleton-pair-alist '((?) _ ?()
;;			      (?] _ ?[)
;;			      (?} _ ?{)
;;			      (?> _ ?<)
;;			      (?/ _ ?\\)
;;			      (?\\ _ ?/)
;;			      (?` ?` _ "''")
;;			      (?' ?' _ "``"))
594
;;	;; in this mode we exceptionally ignore the user, else it's no fun
595 596 597 598 599 600 601
;;	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)
602 603
;;      (setq i (1+ i))))
;;  (run-hooks 'mirror-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
604

Richard M. Stallman's avatar
Richard M. Stallman committed
605 606
(provide 'skeleton)

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