;;; skeleton.el --- Lisp language extension for writing statement skeletons;; Copyright (C) 1993, 1994, 1995 by Free Software Foundation, Inc.;; Author: Daniel.Pfeiffer@Informatik.START.dbp.de, fax (+49 69) 7588-2389;; Maintainer: FSF;; Keywords: extensions, abbrev, languages, tools;; This file is part of XEmacs.;; XEmacs 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.;; XEmacs 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;; along with XEmacs; see the file COPYING. If not, write to the Free;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA;; 02111-1307, USA.;;; Synched up with: FSF 19.34.;;; Commentary:;; A very concise language extension for writing structured statement;; 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:;; page 1: statement skeleton language definition & interpreter;; page 2: paired insertion;; page 3: mirror-mode, an example for setting up paired insertion(defvarskeleton-transformationnil"*If non-nil, function applied to literal strings before they are inserted.It should take strings and characters and return them transformed, or nilwhich 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: ")(defvarskeleton-autowrapt"Controls wrapping behaviour of functions created with `define-skeleton'.When the region is visible (due to `transient-mark-mode' or marking a regionwith the mouse) and this is non-`nil' and the function was called without anexplicit ARG, then the ARG defaults to -1, i.e. wrapping around the visibleregion.We will probably delete this variable in a future Emacs versionunless we get a substantial number of complaints about the auto-wrapfeature.")(defvarskeleton-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.");;;###autoload(defvarskeleton-filter'identity"Function for transforming a skeleton proxy's aliases' variable value.")(defvarskeleton-untabifyt"When non-`nil' untabifies when deleting backwards with element -ARG.")(defvarskeleton-newline-indent-rigidlynil"When non-`nil', indent rigidly under current line for element `\\n'.Else use mode's `indent-line-function'.")(defvarskeleton-further-elements()"A buffer-local varlist (see `let') of mode specific skeleton elements.These variables are bound while interpreting a skeleton. Their value mayin turn be any valid skeleton element if they are themselves to be used asskeleton elements.")(make-variable-buffer-local'skeleton-further-elements)(defvarskeleton-subprompt(substitute-command-keys"RET, \\<minibuffer-local-map>\\[abort-recursive-edit] or \\[help-command]")"*Replacement for %s in prompts of recursive subskeletons.")(defvarskeleton-abbrev-cleanupnil"Variable used to delete the character that led to abbrev expansion.");; XEmacs -- won't byte compile without the wrapper(eval-and-compile(defvarskeleton-debugnil"*If non-nil `define-skeleton' will override previous definition."));; reduce the number of compiler warnings(defvarskeleton)(defvarskeleton-modified)(defvarskeleton-point)(defvarskeleton-regions);;;###autoload(defmacrodefine-skeleton(commanddocumentation&restskeleton)"Define a user-configurable COMMAND that enters a statement skeleton.DOCUMENTATION is that of the command, while the variable of the same name,which contains the skeleton, has a documentation to that effect.INTERACTOR and ELEMENT ... are as defined under `skeleton-insert'."(ifskeleton-debug(setcommandskeleton))`(progn(defun,command(&optionalstrarg),(concatdocumentation(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 wrappedaround 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',skeletonstrarg))));;;###autoload(defunskeleton-proxy-new(skeleton&optionalstrarg)"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 dependingon `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).When called as a function, optional first argument STR may also be a stringwhich will be the value of `str' whereas the skeleton's interactor is thenignored."(interactive"*P\nP")(setqskeleton(funcallskeleton-filterskeleton))(if(notskeleton)(if(memqthis-command'(self-insert-commandskeleton-pair-insert-maybeexpand-abbrev))(setqbuffer-undo-list(primitive-undo1buffer-undo-list)))(skeleton-insertskeleton(if(setqskeleton-abbrev-cleanup(or(eqthis-command'self-insert-command)(eqthis-command'skeleton-pair-insert-maybe)))();; Pretend C-x a e passed its prefix arg to us(if(orargcurrent-prefix-arg)(prefix-numeric-value(orargcurrent-prefix-arg))(andskeleton-autowrap(or(eqlast-command'mouse-drag-region)(and(boundp'transient-mark-mode)(boundp'mark-active)transient-mark-modemark-active))-1)))(if(stringpstr)str))(andskeleton-abbrev-cleanup(setqskeleton-abbrev-cleanup(point))(add-hook'post-command-hook'skeleton-abbrev-cleanupnilt))));; This command isn't meant to be called, only it's aliases with meaningful;; names are.;;;###autoload(defunskeleton-proxy(&optionalstrarg)"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 dependingon `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).When called as a function, optional first argument STR may also be a stringwhich will be the value of `str' whereas the skeleton's interactor is thenignored."(interactive"*P\nP")(let((function(nth1(backtrace-frame1))))(if(eqfunction'nth); uncompiled Lisp function(setqfunction(nth1(backtrace-frame5)))(if(eqfunction'byte-code); tracing byte-compiled function(setqfunction(nth1(backtrace-frame2)))))(if(not(setqfunction(funcallskeleton-filter(symbol-valuefunction))))(if(memqthis-command'(self-insert-commandskeleton-pair-insert-maybeexpand-abbrev))(setqbuffer-undo-list(primitive-undo1buffer-undo-list)))(skeleton-insertfunction(if(setqskeleton-abbrev-cleanup(or(eqthis-command'self-insert-command)(eqthis-command'skeleton-pair-insert-maybe)))();; Pretend C-x a e passed its prefix arg to us(if(orargcurrent-prefix-arg)(prefix-numeric-value(orargcurrent-prefix-arg))(andskeleton-autowrap(or(eqlast-command'mouse-drag-region)(and(boundp'transient-mark-mode)(boundp'mark-active)transient-mark-modemark-active))-1)))(if(stringpstr)str))(andskeleton-abbrev-cleanup(setqskeleton-abbrev-cleanup(point))(add-hook'post-command-hook'skeleton-abbrev-cleanupnilt)))))(defunskeleton-abbrev-cleanup(&restlist)"Value for `post-command-hook' to remove char that expanded abbrev."(if(integerpskeleton-abbrev-cleanup)(progn(delete-regionskeleton-abbrev-cleanup(point))(setqskeleton-abbrev-cleanupnil)(remove-hook'post-command-hook'skeleton-abbrev-cleanupt))));;;###autoload(defunskeleton-insert(skeleton&optionalskeleton-regionsstr)"Insert the complex statement skeleton SKELETON describes very concisely.With optional third REGIONS wrap first interesting point (`_') in skeletonaround 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 betweentwo 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. Butif you marked B A [] C, the interregions are B-A, A-[], []-C.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 validskeleton element.SKELETON is made up as (INTERACTOR ELEMENT ...). INTERACTOR may be nil ifnot needed, a prompt-string or an expression for complex read functions.If ELEMENT is a string or a character it gets inserted (see also`skeleton-transformation'). Other possibilities are: \\n go to next line and indent according to mode _ 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') resume: skipped, continue here if quit is signaled nil skippedFurther elements can be defined via `skeleton-further-elements'. ELEMENT mayitself be a SKELETON with an INTERACTOR. The user is prompted repeatedly fordifferent inputs. The SKELETON is processed as often as the user enters anon-empty string. \\[keyboard-quit] terminates skeleton insertion, butcontinues after `resume:' and positions at `_' if any. If INTERACTOR in sucha subskeleton is a prompt-string which contains a \".. %s ..\" it isformatted with `skeleton-subprompt'. Such an INTERACTOR may also a list ofstrings with the subskeleton being repeated once for each string.Quoted Lisp expressions are evaluated evaluated for their side-effect.Other Lisp expressions are evaluated and the value treated as above.Note that expressions may not return `t' since this implies anendless loop. Modes can define other symbols by locally setting themto any valid skeleton element. The following local variables areavailable: str first time: read a string according to INTERACTOR then: insert previously read string once more help help-form during interaction with the user or `nil' input initial input (string or cons with index) while reading str v1, v2 local variables for memorizing anything you wantWhen done with skeleton, but before going back to `_'-point call`skeleton-end-hook' if that is non-`nil'."(andskeleton-regions(setqskeleton-regions(if(>skeleton-regions0)(list(point-marker)(save-excursion(forward-wordskeleton-regions)(point-marker)))(setqskeleton-regions(-skeleton-regions));; copy skeleton-regions - 1 elements from `mark-ring'(let((l1(cons(mark-marker)mark-ring))(l2(list(point-marker))))(while(andl1(>skeleton-regions0))(setql2(cons(carl1)l2)skeleton-regions(1-skeleton-regions)l1(cdrl1)))(sortl2'<))))(goto-char(carskeleton-regions))(setqskeleton-regions(cdrskeleton-regions)))(let((beg(point))skeleton-modifiedskeleton-pointresume:helpinputv1v2)(unwind-protect(eval`(let,skeleton-further-elements(skeleton-internal-listskeletonstr)))(run-hooks'skeleton-end-hook)(sit-for0)(or(pos-visible-in-window-pbeg)(progn(goto-charbeg)(recenter0)))(ifskeleton-point(goto-charskeleton-point)))))(defunskeleton-read(str&optionalinitial-inputrecursive)"Function for reading a string from the minibuffer within skeletons.PROMPT may contain a `%s' which will be replaced by `skeleton-subprompt'.If non-`nil' second arg INITIAL-INPUT or variable `input' is a string orcons 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 ifuser didn't modify input.While reading, the value of `minibuffer-help-form' is variable `help' if thatis non-`nil' or a default string."(let((minibuffer-help-form(or(if(boundp'help)(symbol-value'help))(ifrecursive"\As long as you provide input you will insert another subskeleton.If you enter the empty string, the loop inserting subskeletons isleft, 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 beenentered. No more of the skeleton will be inserted, except maybe for asyntactically necessary termination.""\You are inserting a skeleton. Standard text gets inserted into the bufferautomatically, and you are prompted to fill in the variable parts.")))(eolp(eolp)));; since Emacs doesn't show main window's cursor, do something noticeable(oreolp(open-line1))(unwind-protect(setqstr(if(stringpstr)(read-string(formatstrskeleton-subprompt)(setqinitial-input(orinitial-input(symbol-value'input))))(evalstr)))(oreolp(delete-char1))))(if(andrecursive(or(nullstr)(string=str"")(equalstrinitial-input)(equalstr(car-safeinitial-input))))(signal'quitt)str))(defunskeleton-internal-list(skeleton&optionalstrrecursive)(let*((start(save-excursion(beginning-of-line)(point)))(column(current-column))(line(buffer-substringstart(save-excursion(end-of-line)(point))))opoint)(orstr(setqstr`(setqstr(skeleton-read',(carskeleton)nil,recursive))))(while(setqskeleton-modified(eqopoint(point))opoint(point)skeleton(cdrskeleton))(condition-casequit(skeleton-internal-1(carskeleton))(quit(if(eq(cdrquit)'recursive)(setqrecursive'quitskeleton(memq'resume:skeleton));; remove the subskeleton as far as it has been shown;; the subskeleton shouldn't have deleted outside current line(end-of-line)(delete-regionstart(point))(insertline)(move-to-columncolumn)(if(cdrquit)(setqskeleton()recursivenil)(signal'quit'recursive)))))));; maybe continue loop or go on to next outer resume: section(if(eqrecursive'quit)(signal'quit'recursive)recursive))(defunskeleton-internal-1(element&optionalliteral)(cond((or(integerpelement)(char-or-string-pelement))(if(and(integerpelement); -num(<element0))(ifskeleton-untabify(backward-delete-char-untabify(-element))(delete-backward-char(-element)))(insert-before-markers(if(andskeleton-transformation(notliteral))(funcallskeleton-transformationelement)element))))((eqelement'\n); actually (eq '\n 'n)(if(andskeleton-regions(eq(nth1skeleton)'_))(progn(or(eolp)(newline))(indent-region(point)(carskeleton-regions)nil))(ifskeleton-newline-indent-rigidly(indent-to(prog1(current-indentation)(newline)))(newline)(indent-according-to-mode))))((eqelement'>)(if(andskeleton-regions(eq(nth1skeleton)'_))(indent-region(point)(carskeleton-regions)nil)(indent-according-to-mode)))((eqelement'_)(ifskeleton-regions(progn(goto-char(carskeleton-regions))(setqskeleton-regions(cdrskeleton-regions))(and(<=(current-column)(current-indentation))(eq(nth1skeleton)'\n)(end-of-line0)))(orskeleton-point(setqskeleton-point(point)))))((eqelement'&)(ifskeleton-modified(setqskeleton(cdrskeleton))))((eqelement'|) (or skeleton-modified (setq skeleton (cdr skeleton)))) ((eq 'quote (car-safe element)) (eval (nth 1 element))) ((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))))) ((null element)) ((skeleton-internal-1 (eval element) t))));; Maybe belongs into simple.el or elsewhere;###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-line0)&-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:comment-start"End:"comment-end\n);; Variables and command for automatically inserting pairs like () or "".(defvarskeleton-pairnil"*If this is nil pairing is turned off, no matter what else is set.Otherwise modes with `skeleton-pair-insert-maybe' on some keyswill attempt to insert pairs of matching characters.")(defvarskeleton-pair-on-wordnil"*If this is nil, paired insertion is inhibited before or inside a word.")(defvarskeleton-pair-filter(lambda())"Attempt paired insertion if this function returns nil, before inserting.This allows for context-sensitive checking whether pairing is appropriate.")(defvarskeleton-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.Elements might be (?` ?` _ \"''\"), (?\\( ? _ \" )\") or (?{ \\n > _ \\n ?} >).");;;###autoload(defunskeleton-pair-insert-maybe(arg)"Insert the character you type ARG times.With no ARG, if `skeleton-pair' is non-nil, pairing can occur. If the regionis 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 aword, and if `skeleton-pair-filter' returns nil, pairing is performed.If a match is found in `skeleton-pair-alist', that is inserted, elsethe defaults are used. These are (), [], {}, <> and `' for thesymmetrical ones, and the same character twice for the others."(interactive"*P")(let((mark(andskeleton-autowrap(or(eqlast-command'mouse-drag-region)(and(boundp'transient-mark-mode)(boundp'mark-active)transient-mark-modemark-active))))(skeleton-end-hook))(if(orarg(notskeleton-pair)(and(notmark)(oroverwrite-mode(if(notskeleton-pair-on-word)(looking-at"\\w"))(funcallskeleton-pair-filter))))(self-insert-command(prefix-numeric-valuearg))(setqlast-command-char(logandlast-command-char255))(orskeleton-abbrev-cleanup(skeleton-insert(consnil(or(assqlast-command-charskeleton-pair-alist)(assqlast-command-char'((?(_?))(?[_?])(?{_?})(?<_?>)(?`_?')))`(,last-command-char_,last-command-char)))(ifmark-1))))));; A more serious example can be found in sh-script.el;;; (defun mirror-mode ();; "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);; (make-local-variable 'skeleton-pair);; (make-local-variable 'skeleton-pair-on-word);; (make-local-variable 'skeleton-pair-filter);; (make-local-variable 'skeleton-pair-alist);; (setq major-mode 'mirror-mode;; mode-name "Mirror";; skeleton-pair-on-word t;; ;; in the middle column insert one or none if odd window-width;; 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))));; ;; mirror these the other way round as well;; skeleton-pair-alist '((?) _ ?();; (?] _ ?[);; (?} _ ?{);; (?> _ ?<);; (?/ _ ?\\);; (?\\ _ ?/);; (?` ?` _ "''");; (?' ?' _ "``"));; ;; in this mode we exceptionally ignore the user, else it's no fun;; 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);; (setq i (1+ i))));; (run-hooks 'mirror-mode-hook))(provide'skeleton);; skeleton.el ends here