1 ;;; yasnippet.el --- Yet another snippet extension for Emacs.
3 ;; Copyright (C) 2008-2012 Free Software Foundation, Inc.
4 ;; Authors: pluskid <pluskid@gmail.com>, João Távora <joaotavora@gmail.com>
6 ;; Package-version: 0.8.0
7 ;; X-URL: http://github.com/capitaomorte/yasnippet
8 ;; Keywords: convenience, emulation
9 ;; URL: http://github.com/capitaomorte/yasnippet
10 ;; EmacsWiki: YaSnippetMode
12 ;; This program is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; This program is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
27 ;; Basic steps to setup:
29 ;; (add-to-list 'load-path
30 ;; "~/path-to-yasnippet")
31 ;; (require 'yasnippet)
32 ;; (yas-global-mode 1)
35 ;; Interesting variables are:
39 ;; The directory where user-created snippets are to be
40 ;; stored. Can also be a list of directories. In that case,
41 ;; when used for bulk (re)loading of snippets (at startup or
42 ;; via `yas-reload-all'), directories appearing earlier in
43 ;; the list shadow other dir's snippets. Also, the first
44 ;; directory is taken as the default for storing the user's
47 ;; The deprecated `yas/root-directory' aliases this variable
48 ;; for backward-compatibility.
52 ;; A local variable that you can set in a hook to override
53 ;; snippet-lookup based on major mode. It is a symbol (or
54 ;; list of symbols) that correspond to subdirectories of
55 ;; `yas-snippet-dirs' and is used for deciding which
56 ;; snippets to consider for the active buffer.
58 ;; Deprecated `yas/mode-symbol' aliases this variable for
59 ;; backward-compatibility.
61 ;; Major commands are:
65 ;; Try to expand snippets before point. In `yas-minor-mode',
66 ;; this is normally bound to TAB, but you can customize it in
67 ;; `yas-minor-mode-map'.
69 ;; M-x yas-load-directory
71 ;; Prompts you for a directory hierarchy of snippets to load.
73 ;; M-x yas-insert-snippet
75 ;; Prompts you for possible snippet expansion if that is
76 ;; possible according to buffer-local and snippet-local
77 ;; expansion conditions. With prefix argument, ignore these
80 ;; M-x yas-visit-snippet-file
82 ;; Prompts you for possible snippet expansions like
83 ;; `yas-insert-snippet', but instead of expanding it, takes
84 ;; you directly to the snippet definition's file, if it
87 ;; M-x yas-new-snippet
89 ;; Lets you create a new snippet file in the correct
90 ;; subdirectory of `yas-snippet-dirs', according to the
93 ;; M-x yas-load-snippet-buffer
95 ;; When editing a snippet, this loads the snippet. This is
96 ;; bound to "C-c C-c" while in the `snippet-mode' editing
99 ;; M-x yas-tryout-snippet
101 ;; When editing a snippet, this opens a new empty buffer,
102 ;; sets it to the appropriate major mode and inserts the
103 ;; snippet there, so you can see what it looks like. This is
104 ;; bound to "C-c C-t" while in `snippet-mode'.
106 ;; M-x yas-describe-tables
108 ;; Lists known snippets in a separate buffer. User is
109 ;; prompted as to whether only the currently active tables
110 ;; are to be displayed, or all the tables for all major
113 ;; The `dropdown-list.el' extension is bundled with YASnippet, you
114 ;; can optionally use it the preferred "prompting method", putting in
115 ;; your .emacs file, for example:
117 ;; (require 'dropdown-list)
118 ;; (setq yas-prompt-functions '(yas-dropdown-prompt
120 ;; yas-completing-prompt))
122 ;; Also check out the customization group
124 ;; M-x customize-group RET yasnippet RET
126 ;; If you use the customization group to set variables
127 ;; `yas-snippet-dirs' or `yas-global-mode', make sure the path to
128 ;; "yasnippet.el" is present in the `load-path' *before* the
129 ;; `custom-set-variables' is executed in your .emacs file.
131 ;; For more information and detailed usage, refer to the project page:
132 ;; http://github.com/capitaomorte/yasnippet
142 (defvar yas--editing-template)
143 (defvar yas--guessed-modes)
144 (defvar yas--indent-original-column)
145 (defvar yas--scheduled-jit-loads)
147 (defvar yas-selected-text)
148 (defvar yas-verbosity))
152 ;;; User customizable variables
154 (defgroup yasnippet nil
155 "Yet Another Snippet extension"
158 (defvar yas--load-file-name load-file-name
159 "Store the filename that yasnippet.el was originally loaded from.")
161 (defcustom yas-snippet-dirs (remove nil
162 (list "~/.emacs.d/snippets"
163 (when yas--load-file-name
164 (concat (file-name-directory yas--load-file-name) "snippets"))))
165 "Directory or list of snippet dirs for each major mode.
167 The directory where user-created snippets are to be stored. Can
168 also be a list of directories. In that case, when used for
169 bulk (re)loading of snippets (at startup or via
170 `yas-reload-all'), directories appearing earlier in the list
171 shadow other dir's snippets. Also, the first directory is taken
172 as the default for storing the user's new snippets."
173 :type '(choice (string :tag "Single directory (string)")
174 (repeat :args (string) :tag "List of directories (strings)"))
177 :set #'(lambda (symbol new)
178 (let ((old (and (boundp symbol)
179 (symbol-value symbol))))
180 (set-default symbol new)
181 (unless (or (not (fboundp 'yas-reload-all))
185 (defun yas-snippet-dirs ()
186 "Returns `yas-snippet-dirs' (which see) as a list."
187 (if (listp yas-snippet-dirs) yas-snippet-dirs (list yas-snippet-dirs)))
189 (defvaralias 'yas/root-directory 'yas-snippet-dirs)
191 (defcustom yas-prompt-functions '(yas-x-prompt
193 yas-completing-prompt
196 "Functions to prompt for keys, templates, etc interactively.
198 These functions are called with the following arguments:
200 - PROMPT: A string to prompt the user
202 - CHOICES: a list of strings or objects.
204 - optional DISPLAY-FN : A function that, when applied to each of
205 the objects in CHOICES will return a string.
207 The return value of any function you put here should be one of
208 the objects in CHOICES, properly formatted with DISPLAY-FN (if
211 - To signal that your particular style of prompting is
212 unavailable at the moment, you can also have the function return
215 - To signal that the user quit the prompting process, you can
218 (signal 'quit \"user quit!\")."
219 :type '(repeat function)
222 (defcustom yas-indent-line 'auto
223 "Controls indenting applied to a recent snippet expansion.
225 The following values are possible:
227 - `fixed' Indent the snippet to the current column;
229 - `auto' Indent each line of the snippet with `indent-according-to-mode'
231 Every other value means don't apply any snippet-side indentation
232 after expansion (the manual per-line \"$>\" indentation still
234 :type '(choice (const :tag "Nothing" nothing)
235 (const :tag "Fixed" fixed)
236 (const :tag "Auto" auto))
239 (defcustom yas-also-auto-indent-first-line nil
240 "Non-nil means also auto indent first line according to mode.
242 Naturally this is only valid when `yas-indent-line' is `auto'"
246 (defcustom yas-snippet-revival t
247 "Non-nil means re-activate snippet fields after undo/redo."
251 (defcustom yas-triggers-in-field nil
252 "If non-nil, allow stacked expansions (snippets inside snippets).
254 Otherwise `yas-next-field-or-maybe-expand' just moves on to the
259 (defcustom yas-fallback-behavior 'call-other-command
260 "How to act when `yas-expand' does *not* expand a snippet.
262 - `call-other-command' means try to temporarily disable YASnippet
263 and call the next command bound to whatever key was used to
266 - nil or the symbol `return-nil' mean do nothing. (and
267 `yas-expand' returns nil)
269 - A Lisp form (apply COMMAND . ARGS) means interactively call
270 COMMAND, if ARGS is non-nil, call COMMAND non-interactively
271 with ARGS as arguments."
272 :type '(choice (const :tag "Call previous command" call-other-command)
273 (const :tag "Do nothing" return-nil))
276 (defcustom yas-choose-keys-first nil
277 "If non-nil, prompt for snippet key first, then for template.
279 Otherwise prompts for all possible snippet names.
281 This affects `yas-insert-snippet' and `yas-visit-snippet-file'."
285 (defcustom yas-choose-tables-first nil
286 "If non-nil, and multiple eligible snippet tables, prompts user for tables first.
288 Otherwise, user chooses between the merging together of all
291 This affects `yas-insert-snippet', `yas-visit-snippet-file'"
295 (defcustom yas-use-menu 'abbreviate
296 "Display a YASnippet menu in the menu bar.
298 When non-nil, submenus for each snippet table will be listed
299 under the menu \"Yasnippet\".
301 - If set to `abbreviate', only the current major-mode
302 menu and the modes set in `yas-extra-modes' are listed.
304 - If set to `full', every submenu is listed
306 - It set to nil, don't display a menu at all (this requires a
307 `yas-reload-all' call if the menu is already visible).
309 Any other non-nil value, every submenu is listed."
310 :type '(choice (const :tag "Full" full)
311 (const :tag "Abbreviate" abbreviate)
312 (const :tag "No menu" nil))
315 (defcustom yas-trigger-symbol (if (eq window-system 'mac)
316 (char-to-string ?\x21E5) ;; little ->| sign
318 "The text that will be used in menu to represent the trigger."
322 (defcustom yas-wrap-around-region nil
323 "If non-nil, snippet expansion wraps around selected region.
325 The wrapping occurs just before the snippet's exit marker. This
326 can be overridden on a per-snippet basis."
330 (defcustom yas-good-grace t
331 "If non-nil, don't raise errors in inline elisp evaluation.
333 An error string \"[yas] error\" is returned instead."
337 (defcustom yas-visit-from-menu nil
338 "If non-nil visit snippets's files from menu, instead of expanding them.
340 This can only work when snippets are loaded from files."
344 (defcustom yas-expand-only-for-last-commands nil
345 "List of `last-command' values to restrict tab-triggering to, or nil.
347 Leave this set at nil (the default) to be able to trigger an
348 expansion simply by placing the cursor after a valid tab trigger,
349 using whichever commands.
351 Optionally, set this to something like '(self-insert-command) if
352 you to wish restrict expansion to only happen when the last
353 letter of the snippet tab trigger was typed immediately before
354 the trigger key itself."
355 :type '(repeat function)
358 ;; Only two faces, and one of them shouldn't even be used...
360 (defface yas-field-highlight-face
361 '((t (:inherit 'region)))
362 "The face used to highlight the currently active field of a snippet"
365 (defface yas--field-debug-face
367 "The face used for debugging some overlays normally hidden"
371 ;;; User-visible variables
373 (defvar yas-keymap (let ((map (make-sparse-keymap)))
374 (define-key map [(tab)] 'yas-next-field-or-maybe-expand)
375 (define-key map (kbd "TAB") 'yas-next-field-or-maybe-expand)
376 (define-key map [(shift tab)] 'yas-prev-field)
377 (define-key map [backtab] 'yas-prev-field)
378 (define-key map (kbd "C-g") 'yas-abort-snippet)
379 (define-key map (kbd "C-d") 'yas-skip-and-clear-or-delete-char)
381 "The active keymap while a snippet expansion is in progress.")
383 (defvar yas-key-syntaxes (list "w" "w_" "w_." "w_.()" "^ ")
384 "List of character syntaxes used to find a trigger key before point.
385 The list is tried in the order while scanning characters
386 backwards from point. For example, if the list is '(\"w\" \"w_\")
387 first look for trigger keys which are composed exclusively of
388 \"word\"-syntax characters, and then, if that fails, look for
389 keys which are either of \"word\" or \"symbol\"
390 syntax. Triggering after
394 will, according to the \"w\" element first try \"bar\". If that
395 isn't a trigger key, \"foo-bar\" is tried, respecting a second
398 (defvar yas-after-exit-snippet-hook
400 "Hooks to run after a snippet exited.
402 The hooks will be run in an environment where some variables bound to
405 `yas-snippet-beg' : The beginning of the region of the snippet.
407 `yas-snippet-end' : Similar to beg.
409 Attention: These hooks are not run when exiting nested/stacked snippet expansion!")
411 (defvar yas-before-expand-snippet-hook
413 "Hooks to run just before expanding a snippet.")
415 (defvar yas-buffer-local-condition
416 '(if (and (or (fourth (syntax-ppss))
417 (fifth (syntax-ppss)))
418 (eq (symbol-function this-command) 'yas-expand-from-trigger-key))
419 '(require-snippet-condition . force-in-comment)
421 "Snippet expanding condition.
423 This variable is a Lisp form which is evaluated every time a
424 snippet expansion is attempted:
426 * If it evaluates to nil, no snippets can be expanded.
428 * If it evaluates to the a cons (require-snippet-condition
431 * Snippets bearing no \"# condition:\" directive are not
434 * Snippets bearing conditions that evaluate to nil (or
435 produce an error) won't be considered.
437 * If the snippet has a condition that evaluates to non-nil
440 * If REQUIREMENT is t, the snippet is considered
442 * If REQUIREMENT is `eq' RESULT, the snippet is
445 * Otherwise, the snippet is not considered.
447 * If it evaluates to the symbol 'always, all snippets are
448 considered for expansion, regardless of any conditions.
450 * If it evaluates to t or some other non-nil value
452 * Snippet bearing no conditions, or conditions that
453 evaluate to non-nil, are considered for expansion.
455 * Otherwise, the snippet is not considered.
457 Here's an example preventing snippets from being expanded from
458 inside comments, in `python-mode' only, with the exception of
459 snippets returning the symbol 'force-in-comment in their
462 (add-hook 'python-mode-hook
464 (setq yas-buffer-local-condition
465 '(if (python-in-string/comment)
466 '(require-snippet-condition . force-in-comment)
469 The default value is similar, it filters out potential snippet
470 expansions inside comments and string literals, unless the
471 snippet itself contains a condition that returns the symbol
472 `force-in-comment'.")
475 ;;; Internal variables
477 (defvar yas--version "0.8.0 (beta)")
479 (defvar yas--menu-table (make-hash-table)
480 "A hash table of MAJOR-MODE symbols to menu keymaps.")
482 (defvar yas--known-modes
483 '(ruby-mode rst-mode markdown-mode)
484 "A list of mode which is well known but not part of Emacs.")
486 (defvar yas--escaped-characters
487 '(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
488 "List of characters which *might* need to be escaped.")
490 (defconst yas--field-regexp
491 "${\\([0-9]+:\\)?\\([^}]*\\)}"
492 "A regexp to *almost* recognize a field.")
494 (defconst yas--multi-dollar-lisp-expression-regexp
495 "$+[ \t\n]*\\(([^)]*)\\)"
496 "A regexp to *almost* recognize a \"$(...)\" expression.")
498 (defconst yas--backquote-lisp-expression-regexp
500 "A regexp to recognize a \"`lisp-expression`\" expression." )
502 (defconst yas--transform-mirror-regexp
503 "${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
504 "A regexp to *almost* recognize a mirror with a transform.")
506 (defconst yas--simple-mirror-regexp
508 "A regexp to recognize a simple mirror.")
510 (defvar yas--snippet-id-seed 0
511 "Contains the next id for a snippet.")
513 (defun yas--snippet-next-id ()
514 (let ((id yas--snippet-id-seed))
515 (incf yas--snippet-id-seed)
521 ;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
522 (defvar last-buffer-undo-list nil)
524 (defvar yas--minor-mode-menu nil
525 "Holds the YASnippet menu.")
527 (defun yas--init-minor-keymap ()
528 "Set up the `yas-minor-mode' keymap."
529 (let ((map (make-sparse-keymap)))
531 (easy-menu-define yas--minor-mode-menu
533 "Menu used when `yas-minor-mode' is active."
536 ["Expand trigger" yas-expand
537 :help "Possibly expand tab trigger before point"]
538 ["Insert at point..." yas-insert-snippet
539 :help "Prompt for an expandable snippet and expand it at point"]
540 ["New snippet..." yas-new-snippet
541 :help "Create a new snippet in an appropriate directory"]
542 ["Visit snippet file..." yas-visit-snippet-file
543 :help "Prompt for an expandable snippet and find its file"]
545 ("Snippet menu behaviour"
546 ["Visit snippets" (setq yas-visit-from-menu t)
547 :help "Visit snippets from the menu"
548 :active t :style radio :selected yas-visit-from-menu]
549 ["Expand snippets" (setq yas-visit-from-menu nil)
550 :help "Expand snippets from the menu"
551 :active t :style radio :selected (not yas-visit-from-menu)]
553 ["Show all known modes" (setq yas-use-menu 'full)
554 :help "Show one snippet submenu for each loaded table"
555 :active t :style radio :selected (eq yas-use-menu 'full)]
556 ["Abbreviate according to current mode" (setq yas-use-menu 'abbreviate)
557 :help "Show only snippet submenus for the current active modes"
558 :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
560 ["Auto" (setq yas-indent-line 'auto)
561 :help "Indent each line of the snippet with `indent-according-to-mode'"
562 :active t :style radio :selected (eq yas-indent-line 'auto)]
563 ["Fixed" (setq yas-indent-line 'fixed)
564 :help "Indent the snippet to the current column"
565 :active t :style radio :selected (eq yas-indent-line 'fixed)]
566 ["None" (setq yas-indent-line 'none)
567 :help "Don't apply any particular snippet indentation after expansion"
568 :active t :style radio :selected (not (member yas-indent-line '(fixed auto)))]
570 ["Also auto indent first line" (setq yas-also-auto-indent-first-line
571 (not yas-also-auto-indent-first-line))
572 :help "When auto-indenting also, auto indent the first line menu"
573 :active (eq yas-indent-line 'auto)
574 :style toggle :selected yas-also-auto-indent-first-line]
577 ["System X-widget" (setq yas-prompt-functions
579 (remove 'yas-x-prompt
580 yas-prompt-functions)))
581 :help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
582 :active t :style radio :selected (eq (car yas-prompt-functions)
584 ["Dropdown-list" (setq yas-prompt-functions
585 (cons 'yas-dropdown-prompt
586 (remove 'yas-dropdown-prompt
587 yas-prompt-functions)))
588 :help "Use a special dropdown list"
589 :active t :style radio :selected (eq (car yas-prompt-functions)
590 'yas-dropdown-prompt)]
591 ["Ido" (setq yas-prompt-functions
592 (cons 'yas-ido-prompt
593 (remove 'yas-ido-prompt
594 yas-prompt-functions)))
595 :help "Use an ido-style minibuffer prompt"
596 :active t :style radio :selected (eq (car yas-prompt-functions)
598 ["Completing read" (setq yas-prompt-functions
599 (cons 'yas-completing-prompt
600 (remove 'yas-completing-prompt
601 yas-prompt-functions)))
602 :help "Use a normal minibuffer prompt"
603 :active t :style radio :selected (eq (car yas-prompt-functions)
604 'yas-completing-prompt)]
607 ["Wrap region in exit marker"
608 (setq yas-wrap-around-region
609 (not yas-wrap-around-region))
610 :help "If non-nil automatically wrap the selected text in the $0 snippet exit"
611 :style toggle :selected yas-wrap-around-region]
612 ["Allow stacked expansions "
613 (setq yas-triggers-in-field
614 (not yas-triggers-in-field))
615 :help "If non-nil allow snippets to be triggered inside other snippet fields"
616 :style toggle :selected yas-triggers-in-field]
617 ["Revive snippets on undo "
618 (setq yas-snippet-revival
619 (not yas-snippet-revival))
620 :help "If non-nil allow snippets to become active again after undo"
621 :style toggle :selected yas-snippet-revival]
624 (not yas-good-grace))
625 :help "If non-nil don't raise errors in bad embedded elisp in snippets"
626 :style toggle :selected yas-good-grace]
629 ["Load snippets..." yas-load-directory
630 :help "Load snippets from a specific directory"]
631 ["Reload everything" yas-reload-all
632 :help "Cleanup stuff, reload snippets, rebuild menus"]
634 :help "Display some information about YASnippet"])))
636 ;; Now for the stuff that has direct keybindings
638 (define-key map [(tab)] 'yas-expand)
639 (define-key map (kbd "TAB") 'yas-expand)
640 (define-key map "\C-c&\C-s" 'yas-insert-snippet)
641 (define-key map "\C-c&\C-n" 'yas-new-snippet)
642 (define-key map "\C-c&\C-v" 'yas-visit-snippet-file)
645 (defvar yas-minor-mode-map (yas--init-minor-keymap)
646 "The keymap used when `yas-minor-mode' is active.")
648 (defvar yas--tables (make-hash-table)
649 "A hash table of mode symbols to `yas--table' objects.")
651 (defvar yas--parents (make-hash-table)
652 "A hash table of mode symbols do lists of direct parent mode symbols.
654 This list is populated when reading the \".yas-parents\" files
655 found when traversing snippet directories with
656 `yas-load-directory'.
658 There might be additional parenting information stored in the
659 `derived-mode-parent' property of some mode symbols, but that is
662 (defvar yas--direct-keymaps (list)
663 "Keymap alist supporting direct snippet keybindings.
665 This variable is placed in `emulation-mode-map-alists'.
667 Its elements looks like (TABLE-NAME . KEYMAP). They're
668 instantiated on `yas-reload-all' but KEYMAP is added to only when
669 loading snippets. `yas--direct-TABLE-NAME' is then a variable set
670 buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
671 defined direct keybindings to the command
672 `yas-expand-from-keymap' which then which snippet to expand.")
674 (defun yas-direct-keymaps-reload ()
675 "Force reload the direct keybinding for active snippet tables."
677 (setq yas--direct-keymaps nil)
678 (maphash #'(lambda (name table)
679 (push (cons (intern (format "yas--direct-%s" name))
680 (yas--table-direct-keymap table))
681 yas--direct-keymaps))
684 (defun yas--modes-to-activate ()
685 "Compute list of mode symbols that are active for `yas-expand'
687 (let ((modes-to-activate (list major-mode))
689 (while (setq mode (get mode 'derived-mode-parent))
690 (push mode modes-to-activate))
691 (dolist (mode (yas-extra-modes))
692 (push mode modes-to-activate))
694 (append modes-to-activate
695 (mapcan #'(lambda (mode)
696 (yas--all-parents mode))
697 modes-to-activate)))))
699 (defvar yas-minor-mode-hook nil
700 "Hook run when `yas-minor-mode' is turned on.")
703 (define-minor-mode yas-minor-mode
704 "Toggle YASnippet mode.
706 When YASnippet mode is enabled, `yas-expand', normally bound to
707 the TAB key, expands snippets of code depending on the major
710 With no argument, this command toggles the mode.
711 positive prefix argument turns on the mode.
712 Negative prefix argument turns off the mode.
715 \\{yas-minor-mode-map}"
717 ;; The indicator for the mode line.
720 (cond (yas-minor-mode
721 ;; Install the direct keymaps in `emulation-mode-map-alists'
722 ;; (we use `add-hook' even though it's not technically a hook,
723 ;; but it works). Then define variables named after modes to
724 ;; index `yas--direct-keymaps'.
726 ;; Also install the post-command-hook.
728 (add-hook 'emulation-mode-map-alists 'yas--direct-keymaps)
729 (add-hook 'post-command-hook 'yas--post-command-handler nil t)
730 ;; Set the `yas--direct-%s' vars for direct keymap expansion
732 (dolist (mode (yas--modes-to-activate))
733 (let ((name (intern (format "yas--direct-%s" mode))))
734 (set-default name nil)
735 (set (make-local-variable name) t)))
738 (yas--load-pending-jits))
740 ;; Uninstall the direct keymaps and the post-command hook
742 (remove-hook 'post-command-hook 'yas--post-command-handler t)
743 (remove-hook 'emulation-mode-map-alists 'yas--direct-keymaps))))
745 (defvar yas-dont-activate '(minibufferp)
746 "If non-nil don't let `yas-minor-mode-on' activate for this buffer.
748 If a function, then its result is used.
750 If a list of functions, then all functions must return nil to
751 activate yas for this buffer.
753 `yas-minor-mode-on' is usually called by `yas-global-mode' so
754 this effectively lets you define exceptions to the \"global\"
755 behaviour. Can also be a function of zero arguments.")
756 (make-variable-buffer-local 'yas-dont-activate)
758 (defun yas-minor-mode-on ()
759 "Turn on YASnippet minor mode.
761 Honour `yas-dont-activate', which see."
763 ;; Check `yas-dont-activate'
764 (unless (cond ((functionp yas-dont-activate)
765 (funcall yas-dont-activate))
766 ((consp yas-dont-activate)
767 (some #'funcall yas-dont-activate))
772 (define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
776 (defun yas--global-mode-reload-with-jit-maybe ()
777 "Run `yas-reload-all' when `yas-global-mode' is on."
778 (when yas-global-mode (yas-reload-all)))
780 (add-hook 'yas-global-mode-hook 'yas--global-mode-reload-with-jit-maybe)
785 (defvar yas--font-lock-keywords
786 (append '(("^#.*$" . font-lock-comment-face))
787 lisp-font-lock-keywords
788 lisp-font-lock-keywords-1
789 lisp-font-lock-keywords-2
791 (0 font-lock-keyword-face)
792 (1 font-lock-string-face t))
794 (0 font-lock-keyword-face)
795 (1 font-lock-warning-face t))
796 ("${" font-lock-keyword-face)
797 ("$[0-9]+?" font-lock-preprocessor-face)
798 ("\\(\\$(\\)" 1 font-lock-preprocessor-face)
800 (0 font-lock-keyword-face)))))
802 (defun yas--init-major-keymap ()
803 "Setup YASnippet major-mode keymap."
804 (let ((map (make-sparse-keymap)))
805 (easy-menu-define nil
807 "Menu used when snippet-mode is active."
809 (mapcar #'(lambda (ent)
811 (define-key map (third ent) (second ent)))
812 (vector (first ent) (second ent) t))
814 (list "Load this snippet" 'yas-load-snippet-buffer "\C-c\C-c")
815 (list "Try out this snippet" 'yas-tryout-snippet "\C-c\C-t")))))
818 (defvar snippet-mode-map
819 (yas--init-major-keymap)
820 "The keymap used when `snippet-mode' is active.")
823 (define-derived-mode snippet-mode text-mode "Snippet"
824 "A mode for editing yasnippets"
825 (setq font-lock-defaults '(yas--font-lock-keywords))
826 (set (make-local-variable 'require-final-newline) nil)
827 (set (make-local-variable 'comment-start) "#")
828 (set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
832 ;;; Internal structs for template management
834 (defstruct (yas--template (:constructor yas--make-blank-template))
835 "A template for a snippet."
845 group ;; as dictated by the #group: directive or .yas-make-groups
846 perm-group ;; as dictated by `yas-define-menu'
850 (defun yas--populate-template (template &rest args)
851 "Helper function to populate TEMPLATE with properties."
855 (position (intern (substring (symbol-name (car args)) 1))
856 (mapcar #'car (get 'yas--template 'cl-struct-slots)))
858 (setq args (cddr args)))
861 (defstruct (yas--table (:constructor yas--make-snippet-table (name)))
862 "A table to store snippets for a particular mode.
864 Has the following fields:
868 A symbol name normally corresponding to a major mode, but can
869 also be a pseudo major-mode to be referenced in
870 `yas-extra-modes', for example.
874 A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
875 a string or a vector, where the former is the snippet's trigger
876 and the latter means it's a direct keybinding. NAMEHASH is yet
877 another hash of (NAME . TEMPLATE) where NAME is the snippet's
878 name and TEMPLATE is a `yas--template' object.
880 `yas--table-direct-keymap'
882 A keymap for the snippets in this table that have direct
883 keybindings. This is kept in sync with the keyhash, i.e., all
884 the elements of the keyhash that are vectors appear here as
885 bindings to `yas-expand-from-keymap'.
887 `yas--table-uuidhash'
889 A hash table mapping snippets uuid's to the same `yas--template'
890 objects. A snippet uuid defaults to the snippet's name.
893 (hash (make-hash-table :test 'equal))
894 (uuidhash (make-hash-table :test 'equal))
896 (direct-keymap (make-sparse-keymap)))
898 (defun yas--get-template-by-uuid (mode uuid)
899 "Find the snippet template in MODE by its UUID."
900 (let* ((table (gethash mode yas--tables mode)))
902 (gethash uuid (yas--table-uuidhash table)))))
904 ;; Apropos storing/updating in TABLE, this works in two steps:
906 ;; 1. `yas--remove-template-by-uuid' removes any
907 ;; keyhash-namehash-template mappings from TABLE, grabbing the
908 ;; snippet by its uuid. Also removes mappings from TABLE's
909 ;; `yas--table-direct-keymap' (FIXME: and should probably take care
910 ;; of potentially stale menu bindings right?.)
912 ;; 2. `yas--add-template' adds this all over again.
914 ;; Create a new or add to an existing keyhash-namehash mapping.
916 ;; For reference on understanding this, consider three snippet
919 ;; A: # name: The Foo
921 ;; # binding: C-c M-l
923 ;; B: # name: Mrs Foo
926 ;; C: # name: The Bar
927 ;; # binding: C-c M-l
932 ;; keyhash namehashes(3) yas--template structs(4)
933 ;; -----------------------------------------------------
936 ;; "foo" ---> "The Foo" ---> [yas--template A] |
937 ;; "Mrs Foo" ---> [yas--template B] |
939 ;; [C-c M-l] ---> "The Foo" -------------------------/
940 ;; "The Bar" ---> [yas--template C]
942 ;; "baz" ---> "Baz" ---> [yas--template D]
944 ;; Additionally, since uuid defaults to the name, we have a
945 ;; `yas--table-uuidhash' for TABLE
947 ;; uuidhash yas--template structs
948 ;; -------------------------------
949 ;; "The Foo" ---> [yas--template A]
950 ;; "Mrs Foo" ---> [yas--template B]
951 ;; "The Bar" ---> [yas--template C]
952 ;; "Baz" ---> [yas--template D]
954 ;; FIXME: the more I look at this data-structure the more I think I'm
955 ;; stupid. There has to be an easier way (but beware lots of code
958 (defun yas--remove-template-by-uuid (table uuid)
959 "Remove from TABLE a template identified by UUID."
960 (let ((template (gethash uuid (yas--table-uuidhash table))))
962 (let* ((name (yas--template-name template))
964 ;; Remove the name from each of the targeted namehashes
966 (maphash #'(lambda (k v)
967 (let ((template (gethash name v)))
969 (eq uuid (yas--template-uuid template)))
971 (when (zerop (hash-table-count v))
972 (push k empty-keys)))))
973 (yas--table-hash table))
974 ;; Remove the namehash themselves if they've become empty
976 (dolist (key empty-keys)
978 (define-key (yas--table-direct-keymap table) key nil))
979 (remhash key (yas--table-hash table)))
981 ;; Finally, remove the uuid from the uuidhash
983 (remhash uuid (yas--table-uuidhash table))))))
985 (defun yas--add-template (table template)
986 "Store in TABLE the snippet template TEMPLATE.
988 KEY can be a string (trigger key) of a vector (direct
990 (let ((name (yas--template-name template))
991 (key (yas--template-key template))
992 (keybinding (yas--template-keybinding template))
993 (menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
994 (dolist (k (remove nil (list key keybinding)))
998 (yas--table-hash table))
1000 (make-hash-table :test 'equal)
1001 (yas--table-hash table))))
1003 (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
1005 ;; Update TABLE's `yas--table-uuidhash'
1006 (puthash (yas--template-uuid template)
1008 (yas--table-uuidhash table))))
1010 (defun yas--update-template (table template)
1011 "Add or update TEMPLATE in TABLE.
1013 Also takes care of adding and updating to the associated menu."
1014 ;; Remove from table by uuid
1016 (yas--remove-template-by-uuid table (yas--template-uuid template))
1017 ;; Add to table again
1019 (yas--add-template table template)
1020 ;; Take care of the menu
1023 (yas--update-template-menu table template)))
1025 (defun yas--update-template-menu (table template)
1026 "Update every menu-related for TEMPLATE."
1027 (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
1028 (key (yas--template-key template))
1029 (keybinding (yas--template-keybinding template)))
1030 ;; The snippet might have changed name or keys, so update
1031 ;; user-visible strings
1033 (unless (eq (cdr menu-binding-pair) :none)
1034 ;; the menu item name
1036 (setf (cadar menu-binding-pair) (yas--template-name template))
1037 ;; the :keys information (also visible to the user)
1038 (setf (getf (cdr (car menu-binding-pair)) :keys)
1039 (or (and keybinding (key-description keybinding))
1040 (and key (concat key yas-trigger-symbol))))))
1041 (unless (yas--template-menu-managed-by-yas-define-menu template)
1043 (yas--menu-keymap-get-create (yas--table-mode table)
1044 (mapcar #'yas--table-mode
1045 (yas--table-parents table))))
1046 (group (yas--template-group template)))
1047 ;; Remove from menu keymap
1049 (assert menu-keymap)
1050 (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
1052 ;; Add necessary subgroups as necessary.
1054 (dolist (subgroup group)
1055 (let ((subgroup-keymap (lookup-key menu-keymap (vector (make-symbol subgroup)))))
1056 (unless (and subgroup-keymap
1057 (keymapp subgroup-keymap))
1058 (setq subgroup-keymap (make-sparse-keymap))
1059 (define-key menu-keymap (vector (make-symbol subgroup))
1060 `(menu-item ,subgroup ,subgroup-keymap)))
1061 (setq menu-keymap subgroup-keymap)))
1063 ;; Add this entry to the keymap
1065 (define-key menu-keymap
1066 (vector (make-symbol (yas--template-uuid template)))
1067 (car (yas--template-menu-binding-pair template))))))
1069 (defun yas--namehash-templates-alist (namehash)
1070 "Return NAMEHASH as an alist."
1072 (maphash #'(lambda (k v)
1073 (push (cons k v) alist))
1077 (defun yas--fetch (table key)
1078 "Fetch templates in TABLE by KEY.
1080 Return a list of cons (NAME . TEMPLATE) where NAME is a
1081 string and TEMPLATE is a `yas--template' structure."
1082 (let* ((keyhash (yas--table-hash table))
1083 (namehash (and keyhash (gethash key keyhash))))
1085 (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
1088 ;;; Filtering/condition logic
1090 (defun yas--eval-condition (condition)
1097 (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
1101 (defun yas--filter-templates-by-condition (templates)
1102 "Filter the templates using the applicable condition.
1104 TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
1105 string and TEMPLATE is a `yas--template' structure.
1107 This function implements the rules described in
1108 `yas-buffer-local-condition'. See that variables documentation."
1109 (let ((requirement (yas--require-template-specific-condition-p)))
1110 (if (eq requirement 'always)
1112 (remove-if-not #'(lambda (pair)
1113 (yas--template-can-expand-p
1114 (yas--template-condition (cdr pair)) requirement))
1117 (defun yas--require-template-specific-condition-p ()
1118 "Decides if this buffer requests/requires snippet-specific
1119 conditions to filter out potential expansions."
1120 (if (eq 'always yas-buffer-local-condition)
1122 (let ((local-condition (or (and (consp yas-buffer-local-condition)
1123 (yas--eval-condition yas-buffer-local-condition))
1124 yas-buffer-local-condition)))
1125 (when local-condition
1126 (if (eq local-condition t)
1128 (and (consp local-condition)
1129 (eq 'require-snippet-condition (car local-condition))
1130 (symbolp (cdr local-condition))
1131 (cdr local-condition)))))))
1133 (defun yas--template-can-expand-p (condition requirement)
1134 "Evaluates CONDITION and REQUIREMENT and returns a boolean."
1135 (let* ((result (or (null condition)
1136 (yas--eval-condition condition))))
1137 (cond ((eq requirement t)
1140 (eq requirement result)))))
1142 (defun yas--all-parents (mode)
1143 "Returns a list of all parent modes of MODE."
1144 (let ((parents (gethash mode yas--parents)))
1146 (mapcan #'yas--all-parents parents))))
1148 (defun yas--table-templates (table)
1151 (maphash #'(lambda (key namehash)
1152 (maphash #'(lambda (name template)
1153 (push (cons name template) acc))
1155 (yas--table-hash table))
1156 (yas--filter-templates-by-condition acc))))
1158 (defun yas--current-key ()
1159 "Get the key under current position. A key is used to find
1160 the template of a snippet in the current snippet-table."
1161 (let ((start (point))
1163 (syntaxes yas-key-syntaxes)
1167 (while (and (not done) syntaxes)
1168 (setq syntax (car syntaxes))
1169 (setq syntaxes (cdr syntaxes))
1171 (skip-syntax-backward syntax)
1172 (setq start (point)))
1174 (mapcan #'(lambda (table)
1175 (yas--fetch table (buffer-substring-no-properties start end)))
1176 (yas--get-snippet-tables)))
1185 (defun yas--table-all-keys (table)
1186 "Get trigger keys of all active snippets in TABLE."
1188 (maphash #'(lambda (key namehash)
1189 (when (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash))
1191 (yas--table-hash table))
1194 (defun yas--table-mode (table)
1195 (intern (yas--table-name table)))
1198 ;;; Internal functions and macros:
1200 (defun yas--real-mode? (mode)
1201 "Try to find out if MODE is a real mode.
1203 The MODE bound to a function (like `c-mode') is considered real
1204 mode. Other well known mode like `ruby-mode' which is not part of
1205 Emacs might not bound to a function until it is loaded. So
1206 yasnippet keeps a list of modes like this to help the judgment."
1208 (find mode yas--known-modes)))
1210 (defun yas--eval-lisp (form)
1211 "Evaluate FORM and convert the result to string."
1212 (let ((retval (catch 'yas--exception
1218 (let ((result (eval form)))
1220 (format "%s" result))))))
1221 (error (if yas-good-grace
1222 (yas--format "elisp error! %s" (error-message-string err))
1223 (error (yas--format "elisp error: %s"
1224 (error-message-string err)))))))))
1225 (when (and (consp retval)
1226 (eq 'yas--exception (car retval)))
1227 (error (cdr retval)))
1230 (defun yas--eval-lisp-no-saves (form)
1233 (error (if yas-good-grace
1234 (yas--format "elisp error! %s" (error-message-string err))
1235 (error (yas--format "elisp error: %s"
1236 (error-message-string err)))))))
1238 (defun yas--read-lisp (string &optional nil-on-error)
1239 "Read STRING as a elisp expression and return it.
1241 In case STRING in an invalid expression and NIL-ON-ERROR is nil,
1242 return an expression that when evaluated will issue an error."
1245 (error (and (not nil-on-error)
1246 `(error (error-message-string ,err))))))
1248 (defun yas--read-keybinding (keybinding)
1249 "Read KEYBINDING as a snippet keybinding, return a vector."
1250 (when (and keybinding
1251 (not (string-match "keybinding" keybinding)))
1253 (let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
1255 (read-kbd-macro keybinding 'need-vector))))
1258 (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
1259 keybinding (error-message-string err))
1262 (defvar yas-extra-modes nil
1263 "If non-nil, also lookup snippets for this/these modes.
1265 Can be a symbol or a list of symbols.
1267 This variable probably makes more sense as buffer-local, so
1268 ensure your use `make-local-variable' when you set it.")
1269 (defun yas-extra-modes ()
1270 (if (listp yas-extra-modes) yas-extra-modes (list yas-extra-modes)))
1271 (defvaralias 'yas/mode-symbol 'yas-extra-modes)
1273 (defun yas--table-get-create (mode)
1274 "Get or create the snippet table corresponding to MODE."
1275 (let ((table (gethash mode
1278 (setq table (yas--make-snippet-table (symbol-name mode)))
1279 (puthash mode table yas--tables)
1280 (push (cons (intern (format "yas--direct-%s" mode))
1281 (yas--table-direct-keymap table))
1282 yas--direct-keymaps))
1285 (defun yas--get-snippet-tables ()
1286 "Get snippet tables for current buffer.
1288 Return a list of `yas--table' objects. The list of modes to
1289 consider is returned by `yas--modes-to-activate'"
1291 (mapcar #'(lambda (mode-name)
1292 (gethash mode-name yas--tables))
1293 (yas--modes-to-activate))))
1295 (defun yas--menu-keymap-get-create (mode &optional parents)
1296 "Get or create the menu keymap for MODE and its PARENTS.
1298 This may very well create a plethora of menu keymaps and arrange
1299 them all in `yas--menu-table'"
1300 (let* ((menu-keymap (or (gethash mode yas--menu-table)
1301 (puthash mode (make-sparse-keymap) yas--menu-table))))
1302 (mapc #'yas--menu-keymap-get-create parents)
1303 (define-key yas--minor-mode-menu (vector mode)
1304 `(menu-item ,(symbol-name mode) ,menu-keymap
1305 :visible (yas--show-menu-p ',mode)))
1309 (defmacro yas--called-interactively-p (&optional kind)
1310 "A backward-compatible version of `called-interactively-p'.
1312 Optional KIND is as documented at `called-interactively-p'
1313 in GNU Emacs 24.1 or higher."
1314 (if (eq 0 (cdr (subr-arity (symbol-function 'called-interactively-p))))
1315 '(called-interactively-p)
1316 `(called-interactively-p ,kind)))
1319 (defun yas--call-with-temporary-redefinitions (function
1320 &rest function-names-and-overriding-functions)
1321 (let* ((overrides (remove-if-not #'(lambda (fdef)
1322 (fboundp (first fdef)))
1323 function-names-and-overriding-functions))
1324 (definition-names (mapcar #'first overrides))
1325 (overriding-functions (mapcar #'second overrides))
1326 (saved-functions (mapcar #'symbol-function definition-names)))
1327 ;; saving all definitions before overriding anything ensures FDEFINITION
1328 ;; errors don't cause accidental permanent redefinitions.
1330 (labels ((set-fdefinitions (names functions)
1331 (loop for name in names
1333 do (fset name fn))))
1334 (set-fdefinitions definition-names overriding-functions)
1335 (unwind-protect (funcall function)
1336 (set-fdefinitions definition-names saved-functions)))))
1339 (defmacro yas--with-temporary-redefinitions (fdefinitions &rest body)
1340 ;; "Temporarily (but globally) redefine each function in FDEFINITIONS.
1341 ;; E.g.: (yas--with-temporary-redefinitions ((foo (x) ...)
1343 ;; ;; code that eventually calls foo, bar of (setf foo)
1345 `(yas--call-with-temporary-redefinitions
1347 ,@(mapcar #'(lambda (thingy)
1348 `(list ',(first thingy)
1349 (lambda ,@(rest thingy))))
1352 (put 'yas--with-temporary-redefinitions 'lisp-indent-function 1)
1353 (put 'yas--with-temporary-redefinitions 'edebug-form-spec '((&rest (defun*)) cl-declarations body))
1356 ;;; Template-related and snippet loading functions
1358 (defun yas--parse-template (&optional file)
1359 "Parse the template in the current buffer.
1361 Optional FILE is the absolute file name of the file being
1364 Optional GROUP is the group where the template is to go,
1365 otherwise we attempt to calculate it from FILE.
1367 Return a snippet-definition, i.e. a list
1369 (KEY TEMPLATE NAME CONDITION GROUP VARS FILE KEYBINDING UUID)
1371 If the buffer contains a line of \"# --\" then the contents above
1372 this line are ignored. Directives can set most of these with the syntax:
1374 # directive-name : directive-value
1376 Here's a list of currently recognized directives:
1387 (goto-char (point-min))
1388 (let* ((type 'snippet)
1390 (file-name-nondirectory file)))
1396 (yas--calculate-group file)))
1400 (if (re-search-forward "^# --\n" nil t)
1401 (progn (setq template
1402 (buffer-substring-no-properties (point)
1404 (setq bound (point))
1405 (goto-char (point-min))
1406 (while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*\\)$" bound t)
1407 (when (string= "uuid" (match-string-no-properties 1))
1408 (setq uuid (match-string-no-properties 2)))
1409 (when (string= "type" (match-string-no-properties 1))
1410 (setq type (if (string= "command" (match-string-no-properties 2))
1413 (when (string= "key" (match-string-no-properties 1))
1414 (setq key (match-string-no-properties 2)))
1415 (when (string= "name" (match-string-no-properties 1))
1416 (setq name (match-string-no-properties 2)))
1417 (when (string= "condition" (match-string-no-properties 1))
1418 (setq condition (yas--read-lisp (match-string-no-properties 2))))
1419 (when (string= "group" (match-string-no-properties 1))
1420 (setq group (match-string-no-properties 2)))
1421 (when (string= "expand-env" (match-string-no-properties 1))
1422 (setq expand-env (yas--read-lisp (match-string-no-properties 2)
1424 (when (string= "binding" (match-string-no-properties 1))
1425 (setq binding (match-string-no-properties 2)))))
1427 (buffer-substring-no-properties (point-min) (point-max))))
1428 (unless (or key binding)
1429 (setq key (and file (file-name-nondirectory file))))
1430 (when (eq type 'command)
1431 (setq template (yas--read-lisp (concat "(progn" template ")"))))
1433 (setq group (split-string group "\\.")))
1434 (list key template name condition group expand-env file binding uuid)))
1436 (defun yas--calculate-group (file)
1437 "Calculate the group for snippet file path FILE."
1438 (let* ((dominating-dir (locate-dominating-file file
1439 ".yas-make-groups"))
1440 (extra-path (and dominating-dir
1441 (replace-regexp-in-string (concat "^"
1442 (expand-file-name dominating-dir))
1444 (expand-file-name file))))
1445 (extra-dir (and extra-path
1446 (file-name-directory extra-path)))
1447 (group (and extra-dir
1448 (replace-regexp-in-string "/"
1450 (directory-file-name extra-dir)))))
1453 (defun yas--subdirs (directory &optional filep)
1454 "Return subdirs or files of DIRECTORY according to FILEP."
1455 (remove-if (lambda (file)
1456 (or (string-match "^\\."
1457 (file-name-nondirectory file))
1458 (string-match "^#.*#$"
1459 (file-name-nondirectory file))
1461 (file-name-nondirectory file))
1463 (file-directory-p file)
1464 (not (file-directory-p file)))))
1465 (directory-files directory t)))
1467 (defun yas--make-menu-binding (template)
1468 (let ((mode (yas--table-mode (yas--template-table template))))
1469 `(lambda () (interactive) (yas--expand-or-visit-from-menu ',mode ,(yas--template-uuid template)))))
1471 (defun yas--expand-or-visit-from-menu (mode uuid)
1472 (let* ((table (yas--table-get-create mode))
1473 (yas--current-template (and table
1474 (gethash uuid (yas--table-uuidhash table)))))
1475 (when yas--current-template
1476 (if yas-visit-from-menu
1477 (yas--visit-snippet-file-1 yas--current-template)
1478 (let ((where (if (region-active-p)
1479 (cons (region-beginning) (region-end))
1480 (cons (point) (point)))))
1481 (yas-expand-snippet (yas--template-content yas--current-template)
1484 (yas--template-expand-env yas--current-template)))))))
1487 ;;; Popping up for keys and templates
1489 (defvar yas--x-pretty-prompt-templates nil
1490 "If non-nil, attempt to prompt for templates like TextMate.")
1493 (defun yas--prompt-for-template (templates &optional prompt)
1494 "Interactively choose a template from the list TEMPLATES.
1496 TEMPLATES is a list of `yas--template'.
1498 Optional PROMPT sets the prompt to use."
1501 (sort templates #'(lambda (t1 t2)
1502 (< (length (yas--template-name t1))
1503 (length (yas--template-name t2))))))
1504 (if yas--x-pretty-prompt-templates
1505 (yas--x-pretty-prompt-templates "Choose a snippet" templates)
1506 (some #'(lambda (fn)
1507 (funcall fn (or prompt "Choose a snippet: ")
1509 #'yas--template-name))
1510 yas-prompt-functions))))
1512 (defun yas--prompt-for-keys (keys &optional prompt)
1513 "Interactively choose a template key from the list KEYS.
1515 Optional PROMPT sets the prompt to use."
1517 (some #'(lambda (fn)
1518 (funcall fn (or prompt "Choose a snippet key: ") keys))
1519 yas-prompt-functions)))
1521 (defun yas--prompt-for-table (tables &optional prompt)
1522 "Interactively choose a table from the list TABLES.
1524 Optional PROMPT sets the prompt to use."
1526 (some #'(lambda (fn)
1527 (funcall fn (or prompt "Choose a snippet table: ")
1530 yas-prompt-functions)))
1532 (defun yas-x-prompt (prompt choices &optional display-fn)
1533 "Display choices in a x-window prompt."
1534 ;; FIXME: HACK: if we notice that one of the objects in choices is
1535 ;; actually a `yas--template', defer to `yas--x-prompt-pretty-templates'
1537 ;; This would be better implemented by passing CHOICES as a
1538 ;; structured tree rather than a list. Modifications would go as far
1539 ;; up as `yas--all-templates' I think.
1541 (when (and window-system choices)
1543 (let (menu d) ;; d for display
1545 (setq d (or (and display-fn (funcall display-fn c))
1548 (push (cons (concat " " d) c) menu))
1550 (push (car d) menu))))
1551 (setq menu (list prompt (push "title" menu)))
1552 (x-popup-menu (if (fboundp 'posn-at-point)
1553 (let ((x-y (posn-x-y (posn-at-point (point)))))
1554 (list (list (+ (car x-y) 10)
1562 (defun yas--x-pretty-prompt-templates (prompt templates)
1563 "Display TEMPLATES, grouping neatly by table name."
1564 (let ((organized (make-hash-table :test #'equal))
1568 (dolist (tl templates)
1569 (puthash (yas--template-table tl)
1571 (gethash (yas--template-table tl) organized))
1573 (setq more-than-one-table (> (hash-table-count organized) 1))
1574 (setq prefix (if more-than-one-table
1576 (if more-than-one-table
1577 (maphash #'(lambda (table templates)
1578 (push (yas--table-name table) menu)
1579 (dolist (tl templates)
1580 (push (cons (concat prefix (yas--template-name tl)) tl) menu))) organized)
1581 (setq menu (mapcar #'(lambda (tl) (cons (concat prefix (yas--template-name tl)) tl)) templates)))
1583 (setq menu (nreverse menu))
1584 (or (x-popup-menu (if (fboundp 'posn-at-point)
1585 (let ((x-y (posn-x-y (posn-at-point (point)))))
1586 (list (list (+ (car x-y) 10)
1590 (list prompt (push "title" menu)))
1593 (defun yas-ido-prompt (prompt choices &optional display-fn)
1594 (when (and (fboundp 'ido-completing-read)
1595 (or (>= emacs-major-version 24)
1597 (yas-completing-prompt prompt choices display-fn #'ido-completing-read)))
1599 (eval-when-compile (require 'dropdown-list nil t))
1600 (defun yas-dropdown-prompt (prompt choices &optional display-fn)
1601 (when (featurep 'dropdown-list)
1602 (let (formatted-choices
1606 (dolist (choice choices)
1607 (setq d (or (and display-fn (funcall display-fn choice))
1610 (push d formatted-choices)
1611 (push choice filtered-choices)))
1613 (setq n (and formatted-choices (dropdown-list formatted-choices)))
1615 (nth n filtered-choices)
1618 (defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
1619 (let (formatted-choices
1623 (completion-fn (or completion-fn
1624 #'completing-read)))
1625 (dolist (choice choices)
1626 (setq d (or (and display-fn (funcall display-fn choice))
1629 (push d formatted-choices)
1630 (push choice filtered-choices)))
1631 (setq chosen (and formatted-choices
1632 (funcall completion-fn prompt
1638 (let ((position (or (and chosen
1639 (position chosen formatted-choices :test #'string=))
1641 (nth position filtered-choices))))
1643 (defun yas-no-prompt (prompt choices &optional display-fn)
1647 ;;; Defining snippets
1648 ;; This consists of creating and registering `yas--template' objects in the
1652 (defun yas--define-snippets-1 (snippet snippet-table)
1653 "Helper for `yas-define-snippets'."
1654 ;; X) Calculate some more defaults on the values returned by
1655 ;; `yas--parse-template'.
1657 (let* ((file (seventh snippet))
1659 (name (or (third snippet)
1661 (file-name-directory file))))
1662 (condition (fourth snippet))
1663 (group (fifth snippet))
1664 (keybinding (yas--read-keybinding (eighth snippet)))
1665 (uuid (or (ninth snippet)
1667 (template (or (gethash uuid (yas--table-uuidhash snippet-table))
1668 (yas--make-blank-template))))
1669 ;; X) populate the template object
1671 (yas--populate-template template
1672 :table snippet-table
1674 :content (second snippet)
1677 :condition condition
1678 :expand-env (sixth snippet)
1679 :file (seventh snippet)
1680 :keybinding keybinding
1682 ;; X) Update this template in the appropriate table. This step
1683 ;; also will take care of adding the key indicators in the
1684 ;; templates menu entry, if any
1686 (yas--update-template snippet-table template)
1687 ;; X) Return the template
1692 (defun yas-define-snippets (mode snippets)
1693 "Define SNIPPETS for MODE.
1695 SNIPPETS is a list of snippet definitions, each taking the
1698 (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV FILE KEYBINDING UUID)
1700 Within these, only KEY and TEMPLATE are actually mandatory.
1702 TEMPLATE might be a lisp form or a string, depending on whether
1703 this is a snippet or a snippet-command.
1705 CONDITION, EXPAND-ENV and KEYBINDING are lisp forms, they have
1706 been `yas--read-lisp'-ed and will eventually be
1707 `yas--eval-lisp'-ed.
1709 The remaining elements are strings.
1711 FILE is probably of very little use if you're programatically
1714 UUID is the snippets \"unique-id\". Loading a second snippet file
1715 with the same uuid replaced the previous snippet.
1717 You can use `yas--parse-template' to return such lists based on
1718 the current buffers contents."
1719 (let ((snippet-table (yas--table-get-create mode))
1721 (dolist (snippet snippets)
1722 (setq template (yas--define-snippets-1 snippet
1727 ;;; Loading snippets from files
1729 (defun yas--load-yas-setup-file (file)
1730 (load file 'noerror))
1732 (defun yas--define-parents (mode parents)
1733 "Add PARENTS to the list of MODE's parents."
1734 (puthash mode (remove-duplicates
1736 (gethash mode yas--parents)))
1739 (defun yas-load-directory (top-level-dir &optional use-jit)
1740 "Load snippets in directory hierarchy TOP-LEVEL-DIR.
1742 Below TOP-LEVEL-DIR each directory should be a mode name.
1744 Optional USE-JIT use jit-loading of snippets."
1745 (interactive "DSelect the root directory: ")
1746 (unless yas-snippet-dirs
1747 (setq yas-snippet-dirs top-level-dir))
1748 (dolist (dir (yas--subdirs top-level-dir))
1749 (let* ((major-mode-and-parents (yas--compute-major-mode-and-parents
1750 (concat dir "/dummy")))
1751 (mode-sym (car major-mode-and-parents))
1752 (parents (cdr major-mode-and-parents)))
1753 ;; Attention: The parents and the menus are already defined
1754 ;; here, even if the snippets are later jit-loaded.
1756 ;; * We need to know the parents at this point since entering a
1757 ;; given mode should jit load for its parents
1758 ;; immediately. This could be reviewed, the parents could be
1759 ;; discovered just-in-time-as well
1761 ;; * We need to create the menus here to support the `full'
1762 ;; option to `yas-use-menu' (all known snippet menus are shown to the user)
1764 (yas--define-parents mode-sym parents)
1765 (yas--menu-keymap-get-create mode-sym)
1766 (let ((form `(yas--load-directory-1 ,dir
1770 (not (some #'(lambda (buffer)
1771 (with-current-buffer buffer
1772 (when (eq major-mode mode-sym)
1773 (yas--message 3 "Discovered there was already %s in %s" buffer mode-sym)
1776 (yas--schedule-jit mode-sym form)
1778 (when (yas--called-interactively-p 'interactive)
1779 (yas--message 3 "Loaded snippets from %s." top-level-dir)))
1781 (defun yas--load-directory-1 (directory mode-sym parents &optional no-compiled-snippets)
1782 "Recursively load snippet templates from DIRECTORY."
1783 (unless (file-exists-p (concat directory "/" ".yas-skip"))
1784 (if (and (not no-compiled-snippets)
1785 (progn (yas--message 2 "Loading compiled snippets from %s" directory) t)
1786 (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3)))
1787 (yas--message 2 "Loading snippet files from %s" directory)
1788 (yas--load-directory-2 directory mode-sym))))
1790 (defun yas--load-directory-2 (directory mode-sym)
1791 ;; Load .yas-setup.el files wherever we find them
1793 (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
1794 (let* ((default-directory directory)
1796 ;; load the snippet files
1799 (dolist (file (yas--subdirs directory 'no-subdirs-just-files))
1800 (when (file-readable-p file)
1801 (insert-file-contents file nil nil nil t)
1802 (push (yas--parse-template file)
1805 (yas-define-snippets mode-sym
1807 ;; now recurse to a lower level
1809 (dolist (subdir (yas--subdirs directory))
1810 (yas--load-directory-2 subdir
1813 (defun yas--load-snippet-dirs (&optional nojit)
1814 "Reload the directories listed in `yas-snippet-dirs' or
1815 prompt the user to select one."
1817 (if yas-snippet-dirs
1818 (dolist (directory (reverse (yas-snippet-dirs)))
1819 (cond ((file-directory-p directory)
1820 (yas-load-directory directory (not nojit))
1822 (yas--message 3 "Loaded %s" directory)
1823 (yas--message 3 "Prepared just-in-time loading for %s" directory)))
1825 (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors))))
1826 (call-interactively 'yas-load-directory))
1829 (defun yas-reload-all (&optional interactive)
1830 "Reload all snippets and rebuild the YASnippet menu.
1832 When called interactively force immediate reload of all known
1833 snippets under `yas-snippet-dirs', otherwise use just-in-time
1838 (snippet-editing-buffers
1839 (remove-if-not #'(lambda (buffer)
1840 (with-current-buffer buffer yas--editing-template))
1842 ;; Warn if there are buffers visiting snippets, since reloading will break
1843 ;; any on-line editing of those buffers.
1845 (when snippet-editing-buffers
1847 (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
1848 (mapc #'kill-buffer snippet-editing-buffers)
1849 (yas--message 1 "Aborted reload...")
1851 ;; in a non-interactive use, at least set
1852 ;; `yas--editing-template' to nil, make it guess it next time around
1853 (mapc #'(lambda (buffer) (setq yas--editing-template nil)) (buffer-list))))
1855 ;; Empty all snippet tables, parenting info and all menu tables
1857 (setq yas--tables (make-hash-table))
1858 (setq yas--parents (make-hash-table))
1859 (setq yas--menu-table (make-hash-table))
1861 ;; Cancel all pending 'yas--scheduled-jit-loads'
1863 (setq yas--scheduled-jit-loads (make-hash-table))
1865 ;; Init the `yas-minor-mode-map', taking care not to break the
1868 (setcdr yas-minor-mode-map (cdr (yas--init-minor-keymap)))
1870 ;; Reload the directories listed in `yas-snippet-dirs' or prompt
1871 ;; the user to select one.
1873 (setq errors (yas--load-snippet-dirs interactive))
1874 ;; Reload the direct keybindings
1876 (yas-direct-keymaps-reload)
1878 (yas--message 3 "Reloaded everything%s...%s."
1879 (if interactive "" " (snippets will load just-in-time)")
1880 (if errors " (some errors, check *Messages*)" "")))))
1882 (defun yas--load-pending-jits ()
1883 (dolist (mode (yas--modes-to-activate))
1884 (let ((forms (reverse (gethash mode yas--scheduled-jit-loads))))
1885 ;; must reverse to maintain coherence with `yas-snippet-dirs'
1886 (dolist (form forms)
1887 (yas--message 3 "Loading for `%s', just-in-time: %s!" mode form)
1889 (remhash mode yas--scheduled-jit-loads))))
1891 ;; (when (<= emacs-major-version 22)
1892 ;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
1894 (defun yas--quote-string (string)
1895 "Escape and quote STRING.
1896 foo\"bar\\! -> \"foo\\\"bar\\\\!\""
1898 (replace-regexp-in-string "[\\\"]"
1904 ;;; Snippet compilation function
1906 (defun yas--initialize ()
1907 "For backward compatibility, enable `yas-minor-mode' globally."
1908 (yas-global-mode 1))
1910 (defun yas-compile-directory (top-level-dir)
1911 "Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
1913 This works by stubbing a few functions, then calling
1914 `yas-load-directory'."
1915 (interactive "DTop level snippet directory?")
1916 (yas--with-temporary-redefinitions
1917 ((yas--load-yas-setup-file
1919 (let ((elfile (concat file ".el")))
1920 (when (file-exists-p elfile)
1921 (insert ";;; .yas-setup.el support file if any:\n;;;\n")
1922 (insert-file-contents elfile)
1923 (goto-char (point-max))
1925 (yas-define-snippets
1927 (insert ";;; Snippet definitions:\n;;;\n")
1928 (let ((literal-snippets (list))
1930 (dolist (snippet snippets)
1931 (let ((key (first snippet))
1932 (template-content (second snippet))
1933 (name (third snippet))
1934 (condition (fourth snippet))
1935 (group (fifth snippet))
1936 (expand-env (sixth snippet))
1937 (file nil) ;; (seventh snippet)) ;; omit on purpose
1938 (binding (eighth snippet))
1939 (uuid (ninth snippet)))
1950 (insert (pp-to-string `(yas-define-snippets ',mode ',literal-snippets)))
1952 (yas--load-directory-1
1953 (dir mode parents &rest ignore)
1954 (let ((output-file (concat (file-name-as-directory dir) ".yas-compiled-snippets.el")))
1955 (with-temp-file output-file
1956 (insert (format ";;; Compiled snippets and support files for `%s'\n" mode))
1957 (yas--load-directory-2 dir mode)
1958 (insert (format ";;; Do not edit! File generated at %s\n" (current-time-string)))))))
1959 (yas-load-directory top-level-dir nil)))
1961 (defun yas-recompile-all ()
1962 "Compile every dir in `yas-snippet-dirs'."
1964 (mapc #'yas-compile-directory (yas-snippet-dirs)))
1970 (defvar yas--scheduled-jit-loads (make-hash-table)
1971 "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
1973 (defun yas--schedule-jit (mode form)
1976 (gethash mode yas--scheduled-jit-loads))
1977 yas--scheduled-jit-loads))
1981 ;;; Some user level functions
1985 (message (concat "yasnippet (version "
1987 ") -- pluskid <pluskid@gmail.com>/joaotavora <joaotavora@gmail.com>")))
1990 ;;; Apropos snippet menu:
1992 ;; The snippet menu keymaps are store by mode in hash table called
1993 ;; `yas--menu-table'. They are linked to the main menu in
1994 ;; `yas--menu-keymap-get-create' and are initially created empty,
1995 ;; reflecting the table hierarchy.
1997 ;; They can be populated in two mutually exclusive ways: (1) by
1998 ;; reading `yas--template-group', which in turn is populated by the "#
1999 ;; group:" directives of the snippets or the ".yas-make-groups" file
2000 ;; or (2) by using a separate `yas-define-menu' call, which declares a
2001 ;; menu structure based on snippets uuids.
2003 ;; Both situations are handled in `yas--update-template-menu', which
2004 ;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
2005 ;; that can tell between the two situations.
2009 ;; * if `yas-define-menu' is used it must run before
2010 ;; `yas-define-snippets' and the UUIDS must match, otherwise we get
2011 ;; duplicate entries. The `yas--template' objects are created in
2012 ;; `yas-define-menu', holding nothing but the menu entry,
2013 ;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
2014 ;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
2015 ;; part is then stored in the menu keymap itself which make the item
2016 ;; appear to the user. These limitations could probably be revised.
2018 ;; * The `yas--template-perm-group' slot is only used in
2019 ;; `yas-describe-tables'.
2021 (defun yas--template-menu-binding-pair-get-create (template &optional type)
2022 "Get TEMPLATE's menu binding or assign it a new one.
2024 TYPE may be `:stay', signaling this menu binding should be
2025 static in the menu."
2026 (or (yas--template-menu-binding-pair template)
2027 (let ((key (yas--template-key template))
2028 (keybinding (yas--template-keybinding template)))
2029 (setf (yas--template-menu-binding-pair template)
2030 (cons `(menu-item ,(or (yas--template-name template)
2031 (yas--template-uuid template))
2032 ,(yas--make-menu-binding template)
2035 (defun yas--template-menu-managed-by-yas-define-menu (template)
2036 "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
2037 (cdr (yas--template-menu-binding-pair template)))
2040 (defun yas--show-menu-p (mode)
2041 (cond ((eq yas-use-menu 'abbreviate)
2043 (mapcar #'(lambda (table)
2044 (yas--table-mode table))
2045 (yas--get-snippet-tables))))
2046 ((eq yas-use-menu 'full)
2048 ((eq yas-use-menu t)
2051 (defun yas--delete-from-keymap (keymap uuid)
2052 "Recursively delete items with UUID from KEYMAP and its submenus."
2054 ;; XXX: This used to skip any submenus named \"parent mode\"
2056 ;; First of all, recursively enter submenus, i.e. the tree is
2057 ;; searched depth first so that stale submenus can be found in the
2060 (mapc #'(lambda (item)
2061 (when (and (listp (cdr item))
2062 (keymapp (third (cdr item))))
2063 (yas--delete-from-keymap (third (cdr item)) uuid)))
2065 ;; Set the uuid entry to nil
2067 (define-key keymap (vector (make-symbol uuid)) nil)
2068 ;; Destructively modify keymap
2070 (setcdr keymap (delete-if #'(lambda (item)
2071 (or (null (cdr item))
2072 (and (keymapp (third (cdr item)))
2073 (null (cdr (third (cdr item)))))))
2076 (defun yas-define-menu (mode menu &optional omit-items)
2077 "Define a snippet menu for MODE according to MENU, omitting OMIT-ITEMS.
2079 MENU is a list, its elements can be:
2081 - (yas-item UUID) : Creates an entry the snippet identified with
2082 UUID. The menu entry for a snippet thus identified is
2083 permanent, i.e. it will never move (be reordered) in the menu.
2085 - (yas-separator) : Creates a separator
2087 - (yas-submenu NAME SUBMENU) : Creates a submenu with NAME,
2088 SUBMENU has the same form as MENU. NAME is also added to the
2089 list of groups of the snippets defined thereafter.
2091 OMIT-ITEMS is a list of snippet uuid's that will always be
2092 omitted from MODE's menu, even if they're manually loaded.
2094 This function does nothing if `yas-use-menu' is nil."
2096 (let* ((table (yas--table-get-create mode))
2097 (hash (yas--table-uuidhash table)))
2098 (yas--define-menu-1 table
2099 (yas--menu-keymap-get-create mode)
2102 (dolist (uuid omit-items)
2103 (let ((template (or (gethash uuid hash)
2104 (yas--populate-template (puthash uuid
2105 (yas--make-blank-template)
2109 (setf (yas--template-menu-binding-pair template) (cons nil :none)))))))
2111 (defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
2112 "Helper for `yas-define-menu'."
2113 (dolist (e (reverse menu))
2114 (cond ((eq (first e) 'yas-item)
2115 (let ((template (or (gethash (second e) uuidhash)
2116 (yas--populate-template (puthash (second e)
2117 (yas--make-blank-template)
2120 :perm-group group-list
2121 :uuid (second e)))))
2122 (define-key menu-keymap (vector (gensym))
2123 (car (yas--template-menu-binding-pair-get-create template :stay)))))
2124 ((eq (first e) 'yas-submenu)
2125 (let ((subkeymap (make-sparse-keymap)))
2126 (define-key menu-keymap (vector (gensym))
2127 `(menu-item ,(second e) ,subkeymap))
2128 (yas--define-menu-1 table
2132 (append group-list (list (second e))))))
2133 ((eq (first e) 'yas-separator)
2134 (define-key menu-keymap (vector (gensym))
2135 '(menu-item "----")))
2137 (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
2139 (defun yas--define (mode key template &optional name condition group)
2140 "Define a snippet. Expanding KEY into TEMPLATE.
2142 NAME is a description to this template. Also update the menu if
2143 `yas-use-menu' is t. CONDITION is the condition attached to
2144 this snippet. If you attach a condition to a snippet, then it
2145 will only be expanded when the condition evaluated to non-nil."
2146 (yas-define-snippets mode
2147 (list (list key template name condition group))))
2149 (defun yas-hippie-try-expand (first-time?)
2150 "Integrate with hippie expand.
2152 Just put this function in `hippie-expand-try-functions-list'."
2153 (when yas-minor-mode
2154 (if (not first-time?)
2155 (let ((yas-fallback-behavior 'return-nil))
2161 ;;; Apropos condition-cache:
2166 (defvar yas--condition-cache-timestamp nil)
2167 (defmacro yas-define-condition-cache (func doc &rest body)
2168 "Define a function FUNC with doc DOC and body BODY, BODY is
2169 executed at most once every snippet expansion attempt, to check
2170 expansion conditions.
2172 It doesn't make any sense to call FUNC programatically."
2173 `(defun ,func () ,(if (and doc
2176 "\n\nFor use in snippets' conditions. Within each
2177 snippet-expansion routine like `yas-expand', computes actual
2178 value for the first time then always returns a cached value.")
2179 (setq body (cons doc body))
2181 (let ((timestamp-and-value (get ',func 'yas--condition-cache)))
2182 (if (equal (car timestamp-and-value) yas--condition-cache-timestamp)
2183 (cdr timestamp-and-value)
2184 (let ((new-value (progn
2187 (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
2190 (defalias 'yas-expand 'yas-expand-from-trigger-key)
2191 (defun yas-expand-from-trigger-key (&optional field)
2192 "Expand a snippet before point.
2194 If no snippet expansion is possible, fall back to the behaviour
2195 defined in `yas-fallback-behavior'.
2197 Optional argument FIELD is for non-interactive use and is an
2198 object satisfying `yas--field-p' to restrict the expansion to."
2200 (setq yas--condition-cache-timestamp (current-time))
2201 (let (templates-and-pos)
2202 (unless (and yas-expand-only-for-last-commands
2203 (not (member last-command yas-expand-only-for-last-commands)))
2204 (setq templates-and-pos (if field
2206 (narrow-to-region (yas--field-start field)
2207 (yas--field-end field))
2209 (yas--current-key))))
2210 (if (and templates-and-pos
2211 (first templates-and-pos))
2212 (yas--expand-or-prompt-for-template (first templates-and-pos)
2213 (second templates-and-pos)
2214 (third templates-and-pos))
2215 (yas--fallback 'trigger-key))))
2217 (defun yas-expand-from-keymap ()
2218 "Directly expand some snippets, searching `yas--direct-keymaps'.
2220 If expansion fails, execute the previous binding for this key"
2222 (setq yas--condition-cache-timestamp (current-time))
2223 (let* ((yas--prefix current-prefix-arg)
2224 (vec (subseq (this-command-keys-vector) (if current-prefix-arg
2225 universal-argument-num-events
2227 (templates (mapcan #'(lambda (table)
2228 (yas--fetch table vec))
2229 (yas--get-snippet-tables))))
2231 (yas--expand-or-prompt-for-template templates)
2232 (let ((yas-fallback-behavior 'call-other-command))
2235 (defun yas--expand-or-prompt-for-template (templates &optional start end)
2236 "Expand one of TEMPLATES from START to END.
2238 Prompt the user if TEMPLATES has more than one element, else
2239 expand immediately. Common gateway for
2240 `yas-expand-from-trigger-key' and `yas-expand-from-keymap'."
2241 (let ((yas--current-template (or (and (rest templates) ;; more than one
2242 (yas--prompt-for-template (mapcar #'cdr templates)))
2244 (when yas--current-template
2245 (yas-expand-snippet (yas--template-content yas--current-template)
2248 (yas--template-expand-env yas--current-template)))))
2250 ;; Apropos the trigger key and the fallback binding:
2252 ;; When `yas-minor-mode-map' binds <tab>, that correctly overrides
2253 ;; org-mode's <tab>, for example and searching for fallbacks correctly
2254 ;; returns `org-cycle'. However, most other modes bind "TAB". TODO,
2255 ;; improve this explanation.
2257 (defun yas--fallback (&optional from-trigger-key-p)
2258 "Fallback after expansion has failed.
2260 Common gateway for `yas-expand-from-trigger-key' and
2261 `yas-expand-from-keymap'."
2262 (cond ((eq yas-fallback-behavior 'return-nil)
2265 ((eq yas-fallback-behavior 'call-other-command)
2266 (let* ((beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
2267 (yas--message 4 "Falling back to %s" beyond-yasnippet)
2268 (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
2269 (setq this-original-command beyond-yasnippet)
2270 (call-interactively beyond-yasnippet)))
2271 ((and (listp yas-fallback-behavior)
2272 (cdr yas-fallback-behavior)
2273 (eq 'apply (car yas-fallback-behavior)))
2274 (if (cddr yas-fallback-behavior)
2275 (apply (cadr yas-fallback-behavior)
2276 (cddr yas-fallback-behavior))
2277 (when (commandp (cadr yas-fallback-behavior))
2278 (setq this-command (cadr yas-fallback-behavior))
2279 (call-interactively (cadr yas-fallback-behavior)))))
2281 ;; also return nil if all the other fallbacks have failed
2284 (defun yas--keybinding-beyond-yasnippet ()
2286 (let* ((yas-minor-mode nil)
2287 (yas--direct-keymaps nil)
2288 (keys (this-single-command-keys)))
2289 (or (key-binding keys t)
2290 (key-binding (yas--fallback-translate-input keys) t))))
2292 (defun yas--fallback-translate-input (keys)
2293 "Emulate `read-key-sequence', at least what I think it does.
2295 Keys should be an untranslated key vector. Returns a translated
2296 vector of keys. FIXME not thoroughly tested"
2299 (while (< i (length keys))
2301 (translated local-function-key-map))
2302 (while (and (< j (length keys))
2304 (keymapp translated))
2305 (setq translated (aget (remove 'keymap translated) (aref keys j))
2307 (setq retval (vconcat retval (cond ((symbolp translated)
2309 ((vectorp translated)
2312 (substring keys i j)))))
2317 ;;; Utils for snippet development:
2319 (defun yas--all-templates (tables)
2320 "Get `yas--template' objects in TABLES, applicable for buffer and point.
2322 Honours `yas-choose-tables-first', `yas-choose-keys-first' and
2323 `yas-buffer-local-condition'"
2324 (when yas-choose-tables-first
2325 (setq tables (list (yas--prompt-for-table tables))))
2327 (if yas-choose-keys-first
2328 (let ((key (yas--prompt-for-keys
2329 (mapcan #'yas--table-all-keys tables))))
2331 (mapcan #'(lambda (table)
2332 (yas--fetch table key))
2334 (remove-duplicates (mapcan #'yas--table-templates tables)
2337 (defun yas-insert-snippet (&optional no-condition)
2338 "Choose a snippet to expand, pop-up a list of choices according
2339 to `yas--prompt-function'.
2341 With prefix argument NO-CONDITION, bypass filtering of snippets
2344 (setq yas--condition-cache-timestamp (current-time))
2345 (let* ((yas-buffer-local-condition (or (and no-condition
2347 yas-buffer-local-condition))
2348 (templates (yas--all-templates (yas--get-snippet-tables)))
2349 (yas--current-template (and templates
2350 (or (and (rest templates) ;; more than one template for same key
2351 (yas--prompt-for-template templates))
2353 (where (if (region-active-p)
2354 (cons (region-beginning) (region-end))
2355 (cons (point) (point)))))
2356 (if yas--current-template
2357 (yas-expand-snippet (yas--template-content yas--current-template)
2360 (yas--template-expand-env yas--current-template))
2361 (yas--message 3 "No snippets can be inserted here!"))))
2363 (defun yas-visit-snippet-file ()
2364 "Choose a snippet to edit, selection like `yas-insert-snippet'.
2366 Only success if selected snippet was loaded from a file. Put the
2367 visited file in `snippet-mode'."
2369 (let* ((yas-buffer-local-condition 'always)
2370 (templates (yas--all-templates (yas--get-snippet-tables)))
2371 (yas-prompt-functions '(yas-ido-prompt yas-completing-prompt))
2372 (template (and templates
2373 (or (yas--prompt-for-template templates
2374 "Choose a snippet template to edit: ")
2378 (yas--visit-snippet-file-1 template)
2379 (message "No snippets tables active!"))))
2381 (defun yas--visit-snippet-file-1 (template)
2382 "Helper for `yas-visit-snippet-file'."
2383 (let ((file (yas--template-file template)))
2384 (cond ((and file (file-readable-p file))
2385 (find-file-other-window file)
2387 (set (make-local-variable 'yas--editing-template) template))
2389 (message "Original file %s no longer exists!" file))
2391 (switch-to-buffer (format "*%s*"(yas--template-name template)))
2392 (let ((type 'snippet))
2393 (when (listp (yas--template-content template))
2394 (insert (format "# type: command\n"))
2395 (setq type 'command))
2396 (insert (format "# key: %s\n" (yas--template-key template)))
2397 (insert (format "# name: %s\n" (yas--template-name template)))
2398 (when (yas--template-keybinding template)
2399 (insert (format "# binding: %s\n" (yas--template-keybinding template))))
2400 (when (yas--template-expand-env template)
2401 (insert (format "# expand-env: %s\n" (yas--template-expand-env template))))
2402 (when (yas--template-condition template)
2403 (insert (format "# condition: %s\n" (yas--template-condition template))))
2405 (insert (if (eq type 'command)
2406 (pp-to-string (yas--template-content template))
2407 (yas--template-content template))))
2409 (set (make-local-variable 'yas--editing-template) template)))))
2411 (defun yas--guess-snippet-directories-1 (table)
2412 "Guesses possible snippet subdirectories for TABLE."
2413 (cons (yas--table-name table)
2414 (mapcan #'(lambda (parent)
2415 (yas--guess-snippet-directories-1
2417 (yas--table-parents table))))
2419 (defun yas--guess-snippet-directories (&optional table)
2420 "Try to guess suitable directories based on the current active
2421 tables (or optional TABLE).
2423 Returns a list of elements (TABLE . DIRS) where TABLE is a
2424 `yas--table' object and DIRS is a list of all possible directories
2425 where snippets of table might exist."
2426 (let ((main-dir (replace-regexp-in-string
2428 (or (first (or (yas-snippet-dirs)
2429 (setq yas-snippet-dirs '("~/.emacs.d/snippets")))))))
2430 (tables (or (and table
2432 (yas--get-snippet-tables))))
2433 ;; HACK! the snippet table created here is actually registered!
2435 (unless (or table (gethash major-mode yas--tables))
2436 (push (yas--table-get-create major-mode)
2439 (mapcar #'(lambda (table)
2441 (mapcar #'(lambda (subdir)
2442 (concat main-dir "/" subdir))
2443 (yas--guess-snippet-directories-1 table))))
2446 (defun yas--make-directory-maybe (table-and-dirs &optional main-table-string)
2447 "Returns a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
2448 (or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
2449 (let ((candidate (first (cdr table-and-dirs))))
2450 (unless (file-writable-p (file-name-directory candidate))
2451 (error (yas--format "%s is not writable." candidate)))
2452 (if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
2454 (if (gethash (yas--table-mode (car table-and-dirs))
2458 (or main-table-string
2460 (yas--table-name (car table-and-dirs))))
2462 (make-directory candidate 'also-make-parents)
2463 ;; create the .yas-parents file here...
2466 (defun yas-new-snippet (&optional no-template)
2467 "Pops a new buffer for writing a snippet.
2469 Expands a snippet-writing snippet, unless the optional prefix arg
2470 NO-TEMPLATE is non-nil."
2472 (let ((guessed-directories (yas--guess-snippet-directories)))
2474 (switch-to-buffer "*new snippet*")
2476 (kill-all-local-variables)
2479 (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
2480 (yas--table-mode (car d)))
2481 guessed-directories))
2482 (unless no-template (yas-expand-snippet "\
2483 # -*- mode: snippet -*-
2485 # key: ${2:${1:$(replace-regexp-in-string \"\\\\\\\\(\\\\\\\\w+\\\\\\\\).*\" \"\\\\\\\\1\" yas-text)}}${3:
2486 # binding: ${4:direct-keybinding}}${5:
2487 # expand-env: ((${6:some-var} ${7:some-value}))}${8:
2492 (defun yas--compute-major-mode-and-parents (file)
2493 "Given FILE, find the nearest snippet directory for a given mode.
2495 Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
2496 representing one or more of the mode's parents.
2498 Note that MODE-SYM need not be the symbol of a real major mode,
2499 neither do the elements of PARENTS."
2500 (let* ((file-dir (and file
2501 (directory-file-name (or (some #'(lambda (special)
2502 (locate-dominating-file file special))
2506 (directory-file-name (file-name-directory file))))))
2507 (parents-file-name (concat file-dir "/.yas-parents"))
2508 (major-mode-name (and file-dir
2509 (file-name-nondirectory file-dir)))
2510 (major-mode-sym (or (and major-mode-name
2511 (intern major-mode-name))))
2512 (parents (when (file-readable-p parents-file-name)
2516 (insert-file-contents parents-file-name)
2517 (buffer-substring-no-properties (point-min)
2519 (when major-mode-sym
2520 (cons major-mode-sym parents))))
2522 (defvar yas--editing-template nil
2523 "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
2525 (defvar yas--current-template nil
2526 "Holds the current template being expanded into a snippet.")
2528 (defvar yas--guessed-modes nil
2529 "List of guessed modes supporting `yas-load-snippet-buffer'.")
2531 (defun yas--read-table ()
2532 "Ask user for a snippet table, help with some guessing."
2533 (let ((prompt (if (and (featurep 'ido)
2535 'ido-completing-read 'completing-read)))
2536 (unless yas--guessed-modes
2537 (set (make-local-variable 'yas--guessed-modes)
2538 (or (yas--compute-major-mode-and-parents buffer-file-name))))
2540 (funcall prompt (format "Choose or enter a table (yas guesses %s): "
2541 (if yas--guessed-modes
2542 (first yas--guessed-modes)
2544 (mapcar #'symbol-name yas--guessed-modes)
2549 (if (first yas--guessed-modes)
2550 (symbol-name (first yas--guessed-modes)))))))
2552 (defun yas-load-snippet-buffer (table &optional interactive)
2553 "Parse and load current buffer's snippet definition into TABLE.
2555 TABLE is a symbol naming a passed to `yas--table-get-create'.
2557 When called interactively, prompt for the table name and
2558 whether (and where) to save the snippet, then quit the window."
2559 (interactive (list (yas--read-table) t))
2561 ;; We have `yas--editing-template', this buffer's content comes from a
2562 ;; template which is already loaded and neatly positioned,...
2564 (yas--editing-template
2565 (yas--define-snippets-1 (yas--parse-template (yas--template-file yas--editing-template))
2566 (yas--template-table yas--editing-template)))
2567 ;; Try to use `yas--guessed-modes'. If we don't have that use the
2568 ;; value from `yas--compute-major-mode-and-parents'
2571 (unless yas--guessed-modes
2572 (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
2573 (let* ((table (yas--table-get-create table)))
2574 (set (make-local-variable 'yas--editing-template)
2575 (yas--define-snippets-1 (yas--parse-template buffer-file-name)
2578 (when (and interactive
2580 ;; Only offer to save this if it looks like a library or new
2581 ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
2582 ;; which is not the first, or from an unwritable file)
2584 (not (yas--template-file yas--editing-template))
2585 (not (file-writable-p (yas--template-file yas--editing-template)))
2586 (and (listp yas-snippet-dirs)
2587 (second yas-snippet-dirs)
2588 (not (string-match (expand-file-name (first yas-snippet-dirs))
2589 (yas--template-file yas--editing-template)))))
2590 (y-or-n-p (yas--format "Looks like a library or new snippet. Save to new file? ")))
2591 (let* ((option (first (yas--guess-snippet-directories (yas--template-table yas--editing-template))))
2593 (yas--make-directory-maybe option))))
2595 (let ((default-file-name (or (and (yas--template-file yas--editing-template)
2596 (file-name-nondirectory (yas--template-file yas--editing-template)))
2597 (yas--template-name yas--editing-template))))
2598 (write-file (concat chosen "/"
2599 (read-from-minibuffer (format "File name to create in %s? " chosen)
2600 default-file-name)))
2601 (setf (yas--template-file yas--editing-template) buffer-file-name)))))
2603 (yas--message 3 "Snippet \"%s\" loaded for %s."
2604 (yas--template-name yas--editing-template)
2605 (yas--table-name (yas--template-table yas--editing-template)))
2606 (quit-window interactive)))
2608 (defun yas-tryout-snippet (&optional debug)
2609 "Test current buffer's snippet template in other buffer."
2611 (let* ((major-mode-and-parent (yas--compute-major-mode-and-parents buffer-file-name))
2612 (parsed (yas--parse-template))
2613 (test-mode (or (and (car major-mode-and-parent)
2614 (fboundp (car major-mode-and-parent))
2615 (car major-mode-and-parent))
2616 (first yas--guessed-modes)
2617 (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
2618 (yas--current-template
2621 (yas--populate-template (yas--make-blank-template)
2622 :table nil ;; no tables for ephemeral snippets
2624 :content (second parsed)
2625 :name (third parsed)
2626 :expand-env (sixth parsed)))))
2627 (cond (yas--current-template
2628 (let ((buffer-name (format "*testing snippet: %s*" (yas--template-name yas--current-template))))
2629 (kill-buffer (get-buffer-create buffer-name))
2630 (switch-to-buffer (get-buffer-create buffer-name))
2631 (setq buffer-undo-list nil)
2632 (condition-case nil (funcall test-mode) (error nil))
2634 (setq buffer-read-only nil)
2635 (yas-expand-snippet (yas--template-content yas--current-template)
2638 (yas--template-expand-env yas--current-template))
2640 (require 'yasnippet-debug nil t))
2641 (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
2643 (yas--message 3 "Cannot test snippet for unknown major mode")))))
2645 (defun yas-active-keys ()
2646 "Return all active trigger keys for current buffer and point."
2647 (remove-duplicates (mapcan #'yas--table-all-keys (yas--get-snippet-tables))
2650 (defun yas--template-fine-group (template)
2651 (car (last (or (yas--template-group template)
2652 (yas--template-perm-group template)))))
2654 (defun yas-describe-tables (&optional choose)
2655 "Display snippets for each table."
2657 (let* ((by-name-hash (and choose
2658 (y-or-n-p "Show by namehash? ")))
2659 (buffer (get-buffer-create "*YASnippet tables*"))
2660 (active-tables (yas--get-snippet-tables))
2661 (remain-tables (let ((all))
2662 (maphash #'(lambda (k v)
2663 (unless (find v active-tables)
2667 (table-lists (list active-tables remain-tables))
2668 (original-buffer (current-buffer))
2670 (yas--condition-cache-timestamp (current-time)))
2671 (with-current-buffer buffer
2672 (setq buffer-read-only nil)
2674 (cond ((not by-name-hash)
2675 (insert "YASnippet tables: \n")
2676 (while (and table-lists
2678 (dolist (table (car table-lists))
2679 (yas--describe-pretty-table table original-buffer))
2680 (setq table-lists (cdr table-lists))
2682 (yas--create-snippet-xrefs)
2683 (display-buffer buffer)
2684 (setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
2685 (yas--create-snippet-xrefs)
2689 (insert "\n\nYASnippet tables by NAMEHASH: \n")
2690 (dolist (table (append active-tables remain-tables))
2691 (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
2693 (maphash #'(lambda (k v)
2695 (yas--table-hash table))
2697 (insert (format " key %s maps snippets: %s\n" key
2699 (maphash #'(lambda (k v)
2701 (gethash key (yas--table-hash table)))
2704 (setq buffer-read-only t))
2705 (display-buffer buffer)))
2707 (defun yas--describe-pretty-table (table &optional original-buffer)
2708 (insert (format "\nSnippet table `%s'"
2709 (yas--table-name table)))
2710 (if (yas--table-parents table)
2711 (insert (format " parents: %s\n"
2712 (mapcar #'yas--table-name
2713 (yas--table-parents table))))
2715 (insert (make-string 100 ?-) "\n")
2716 (insert "group state name key binding\n")
2717 (let ((groups-hash (make-hash-table :test #'equal)))
2718 (maphash #'(lambda (k v)
2719 (let ((group (or (yas--template-fine-group v)
2721 (when (yas--template-name v)
2723 (cons v (gethash group groups-hash))
2725 (yas--table-uuidhash table))
2727 #'(lambda (group templates)
2728 (setq group (truncate-string-to-width group 25 0 ? "..."))
2729 (insert (make-string 100 ?-) "\n")
2730 (dolist (p templates)
2731 (let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas--template-name p))
2735 (setq group (make-string (length group) ? ))))
2736 (condition-string (let ((condition (yas--template-condition p)))
2739 (with-current-buffer original-buffer
2740 (if (yas--eval-condition condition)
2745 (insert condition-string " ")
2747 (if (string-match "\\.\\.\\.$" name)
2751 (insert (truncate-string-to-width (or (yas--template-key p) "")
2753 (insert (truncate-string-to-width (key-description (yas--template-keybinding p))
2760 ;;; User convenience functions, for using in snippet definitions
2762 (defvar yas-modified-p nil
2763 "Non-nil if field has been modified by user or transformation.")
2765 (defvar yas-moving-away-p nil
2766 "Non-nil if user is about to exit field.")
2768 (defvar yas-text nil
2769 "Contains current field text.")
2771 (defun yas-substr (str pattern &optional subexp)
2772 "Search PATTERN in STR and return SUBEXPth match.
2774 If found, the content of subexp group SUBEXP (default 0) is
2775 returned, or else the original STR will be returned."
2776 (let ((grp (or subexp 0)))
2778 (if (string-match pattern str)
2779 (match-string-no-properties grp str)
2782 (defun yas-choose-value (&rest possibilities)
2783 "Prompt for a string in POSSIBILITIES and return it.
2785 The last element of POSSIBILITIES may be a list of strings."
2786 (unless (or yas-moving-away-p
2788 (setq possibilities (nreverse possibilities))
2789 (setq possibilities (if (listp (car possibilities))
2790 (append (reverse (car possibilities)) (rest possibilities))
2792 (some #'(lambda (fn)
2793 (funcall fn "Choose: " possibilities))
2794 yas-prompt-functions)))
2796 (defun yas-key-to-value (alist)
2797 (unless (or yas-moving-away-p
2799 (let ((key (read-key-sequence "")))
2801 (or (cdr (find key alist :key #'car :test #'string=))
2804 (defun yas-throw (text)
2805 "Throw a yas--exception with TEXT as the reason."
2806 (throw 'yas--exception (cons 'yas--exception text)))
2808 (defun yas-verify-value (possibilities)
2809 "Verify that the current field value is in POSSIBILITIES.
2811 Otherwise throw exception."
2812 (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
2813 (yas-throw (yas--format "Field only allows %s" possibilities))))
2815 (defun yas-field-value (number)
2816 "Get the string for field with NUMBER.
2818 Use this in primary and mirror transformations to tget."
2819 (let* ((snippet (car (yas--snippets-at-point)))
2821 (yas--snippet-find-field snippet number))))
2823 (yas--field-text-for-display field))))
2826 "Return `yas-text' if that exists and is non-empty, else nil."
2828 (not (string= "" yas-text)))
2831 (defun yas-selected-text ()
2832 "Return `yas-selected-text' if that exists and is non-empty, else nil."
2833 (if (and yas-selected-text
2834 (not (string= "" yas-selected-text)))
2837 (defun yas--get-field-once (number &optional transform-fn)
2838 (unless yas-modified-p
2840 (funcall transform-fn (yas-field-value number))
2841 (yas-field-value number))))
2843 (defun yas-default-from-field (number)
2844 (unless yas-modified-p
2845 (yas-field-value number)))
2847 (defun yas-inside-string ()
2848 "Return non-nil if the point is inside a string according to font-lock."
2849 (equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
2851 (defun yas-unimplemented (&optional missing-feature)
2852 (if yas--current-template
2853 (if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
2856 (yas--visit-snippet-file-1 yas--current-template))
2857 (message "No implementation. Missing %s" (or missing-feature "something"))))
2860 ;;; Snippet expansion and field management
2862 (defvar yas--active-field-overlay nil
2863 "Overlays the currently active field.")
2865 (defvar yas--field-protection-overlays nil
2866 "Two overlays protect the current active field.")
2868 (defconst yas--prefix nil
2869 "A prefix argument for expansion direct from keybindings.")
2871 (defvar yas-selected-text nil
2872 "The selected region deleted on the last snippet expansion.")
2874 (defvar yas--start-column nil
2875 "The column where the snippet expansion started.")
2877 (make-variable-buffer-local 'yas--active-field-overlay)
2878 (make-variable-buffer-local 'yas--field-protection-overlays)
2879 (put 'yas--active-field-overlay 'permanent-local t)
2880 (put 'yas--field-protection-overlays 'permanent-local t)
2882 (defstruct (yas--snippet (:constructor yas--make-snippet ()))
2888 (id (yas--snippet-next-id) :read-only t)
2889 (control-overlay nil)
2891 ;; stacked expansion: the `previous-active-field' slot saves the
2892 ;; active field where the child expansion took place
2893 previous-active-field
2896 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
2906 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
2913 (defstruct (yas--exit (:constructor yas--make-exit (marker)))
2917 (defun yas--apply-transform (field-or-mirror field &optional empty-on-nil-p)
2918 "Calculate transformed string for FIELD-OR-MIRROR from FIELD.
2920 If there is no transform for ht field, return nil.
2922 If there is a transform but it returns nil, return the empty
2923 string iff EMPTY-ON-NIL-P is true."
2924 (let* ((yas-text (yas--field-text-for-display field))
2926 (yas-modified-p (yas--field-modified-p field))
2927 (yas-moving-away-p nil)
2928 (transform (if (yas--mirror-p field-or-mirror)
2929 (yas--mirror-transform field-or-mirror)
2930 (yas--field-transform field-or-mirror)))
2931 (start-point (if (yas--mirror-p field-or-mirror)
2932 (yas--mirror-start field-or-mirror)
2933 (yas--field-start field-or-mirror)))
2934 (transformed (and transform
2936 (goto-char start-point)
2937 (let ((ret (yas--eval-lisp transform)))
2938 (or ret (and empty-on-nil-p "")))))))
2941 (defsubst yas--replace-all (from to &optional text)
2942 "Replace all occurrences from FROM to TO.
2944 With optional string TEXT do it in that string."
2946 (replace-regexp-in-string (regexp-quote from) to text t t)
2947 (goto-char (point-min))
2948 (while (search-forward from nil t)
2949 (replace-match to t t text))))
2951 (defun yas--snippet-find-field (snippet number)
2952 (find-if #'(lambda (field)
2953 (eq number (yas--field-number field)))
2954 (yas--snippet-fields snippet)))
2956 (defun yas--snippet-sort-fields (snippet)
2957 "Sort the fields of SNIPPET in navigation order."
2958 (setf (yas--snippet-fields snippet)
2959 (sort (yas--snippet-fields snippet)
2960 #'yas--snippet-field-compare)))
2962 (defun yas--snippet-field-compare (field1 field2)
2963 "Compare FIELD1 and FIELD2.
2965 The field with a number is sorted first. If they both have a
2966 number, compare through the number. If neither have, compare
2967 through the field's start point"
2968 (let ((n1 (yas--field-number field1))
2969 (n2 (yas--field-number field2)))
2972 (or (zerop n2) (and (not (zerop n1))
2977 (< (yas--field-start field1)
2978 (yas--field-start field2))))))
2980 (defun yas--field-probably-deleted-p (snippet field)
2981 "Guess if SNIPPET's FIELD should be skipped."
2983 ;; field must be zero length
2985 (zerop (- (yas--field-start field) (yas--field-end field)))
2988 ;; 1) is a nested field and it's been modified
2990 (and (yas--field-parent-field field)
2991 (yas--field-modified-p field))
2992 ;; 2) ends just before the snippet end
2994 (and (eq field (car (last (yas--snippet-fields snippet))))
2995 (= (yas--field-start field) (overlay-end (yas--snippet-control-overlay snippet)))))
2996 ;; the field numbered 0, just before the exit marker, should
2999 (not (zerop (yas--field-number field)))))
3001 (defun yas--snippets-at-point (&optional all-snippets)
3002 "Return a sorted list of snippets at point.
3004 The most recently-inserted snippets are returned first."
3006 (remove nil (remove-duplicates (mapcar #'(lambda (ov)
3007 (overlay-get ov 'yas--snippet))
3009 (overlays-in (point-min) (point-max))
3010 (nconc (overlays-at (point)) (overlays-at (1- (point))))))))
3012 (<= (yas--snippet-id s2) (yas--snippet-id s1)))))
3014 (defun yas-next-field-or-maybe-expand ()
3015 "Try to expand a snippet at a key before point.
3017 Otherwise delegate to `yas-next-field'."
3019 (if yas-triggers-in-field
3020 (let ((yas-fallback-behavior 'return-nil)
3021 (active-field (overlay-get yas--active-field-overlay 'yas--field)))
3023 (unless (yas-expand-from-trigger-key active-field)
3027 (defun yas-next-field (&optional arg)
3028 "Navigate to the ARGth next field.
3030 If there's none, exit the snippet."
3034 (snippet (first (yas--snippets-at-point)))
3035 (active-field (overlay-get yas--active-field-overlay 'yas--field))
3036 (live-fields (remove-if #'(lambda (field)
3037 (and (not (eq field active-field))
3038 (yas--field-probably-deleted-p snippet field)))
3039 (yas--snippet-fields snippet)))
3040 (active-field-pos (position active-field live-fields))
3041 (target-pos (and active-field-pos (+ arg active-field-pos)))
3042 (target-field (and target-pos (nth target-pos live-fields))))
3043 ;; First check if we're moving out of a field with a transform
3045 (when (and active-field
3046 (yas--field-transform active-field))
3047 (let* ((yas-moving-away-p t)
3048 (yas-text (yas--field-text-for-display active-field))
3050 (yas-modified-p (yas--field-modified-p active-field)))
3051 ;; primary field transform: exit call to field-transform
3052 (yas--eval-lisp (yas--field-transform active-field))))
3053 ;; Now actually move...
3054 (cond ((and target-pos (>= target-pos (length live-fields)))
3055 (yas-exit-snippet snippet))
3057 (yas--move-to-field snippet target-field))
3061 (defun yas--place-overlays (snippet field)
3062 "Correctly place overlays for SNIPPET's FIELD."
3063 (yas--make-move-field-protection-overlays snippet field)
3064 (yas--make-move-active-field-overlay snippet field))
3066 (defun yas--move-to-field (snippet field)
3067 "Update SNIPPET to move to field FIELD.
3069 Also create some protection overlays"
3070 (goto-char (yas--field-start field))
3071 (yas--place-overlays snippet field)
3072 (overlay-put yas--active-field-overlay 'yas--field field)
3073 (let ((number (yas--field-number field)))
3074 ;; check for the special ${0: ...} field
3075 (if (and number (zerop number))
3077 (set-mark (yas--field-end field))
3078 (setf (yas--snippet-force-exit snippet)
3079 (or (yas--field-transform field)
3081 ;; make this field active
3082 (setf (yas--snippet-active-field snippet) field)
3083 ;; primary field transform: first call to snippet transform
3084 (unless (yas--field-modified-p field)
3085 (if (yas--field-update-display field snippet)
3086 (yas--update-mirrors snippet)
3087 (setf (yas--field-modified-p field) nil))))))
3089 (defun yas-prev-field ()
3090 "Navigate to prev field. If there's none, exit the snippet."
3092 (yas-next-field -1))
3094 (defun yas-abort-snippet (&optional snippet)
3096 (let ((snippet (or snippet
3097 (car (yas--snippets-at-point)))))
3099 (setf (yas--snippet-force-exit snippet) t))))
3101 (defun yas-exit-snippet (snippet)
3102 "Goto exit-marker of SNIPPET."
3103 (interactive (list (first (yas--snippets-at-point))))
3105 (setf (yas--snippet-force-exit snippet) t)
3106 (goto-char (if (yas--snippet-exit snippet)
3107 (yas--exit-marker (yas--snippet-exit snippet))
3108 (overlay-end (yas--snippet-control-overlay snippet))))))
3110 (defun yas-exit-all-snippets ()
3111 "Exit all snippets."
3113 (mapc #'(lambda (snippet)
3114 (yas-exit-snippet snippet)
3115 (yas--check-commit-snippet))
3116 (yas--snippets-at-point 'all-snippets)))
3119 ;;; Some low level snippet-routines:
3121 (defmacro yas--inhibit-overlay-hooks (&rest body)
3122 "Run BODY with `yas--inhibit-overlay-hooks' set to t."
3123 (declare (indent 0))
3124 `(let ((yas--inhibit-overlay-hooks t))
3127 (defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
3128 (defvar yas-snippet-end nil "End position of the last snippet committed.")
3130 (defun yas--commit-snippet (snippet)
3131 "Commit SNIPPET, but leave point as it is.
3133 This renders the snippet as ordinary text."
3135 (let ((control-overlay (yas--snippet-control-overlay snippet)))
3137 ;; Save the end of the moribund snippet in case we need to revive it
3138 ;; its original expansion.
3140 (when (and control-overlay
3141 (overlay-buffer control-overlay))
3142 (setq yas-snippet-beg (overlay-start control-overlay))
3143 (setq yas-snippet-end (overlay-end control-overlay))
3144 (delete-overlay control-overlay))
3146 (yas--inhibit-overlay-hooks
3147 (when yas--active-field-overlay
3148 (delete-overlay yas--active-field-overlay))
3149 (when yas--field-protection-overlays
3150 (mapc #'delete-overlay yas--field-protection-overlays)))
3152 ;; stacked expansion: if the original expansion took place from a
3153 ;; field, make sure we advance it here at least to
3154 ;; `yas-snippet-end'...
3156 (let ((previous-field (yas--snippet-previous-active-field snippet)))
3157 (when (and yas-snippet-end previous-field)
3158 (yas--advance-end-maybe previous-field yas-snippet-end)))
3160 ;; Convert all markers to points,
3162 (yas--markers-to-points snippet)
3164 ;; Take care of snippet revival
3166 (if yas-snippet-revival
3167 (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
3169 ;; Dismember the snippet... this is useful if we get called
3170 ;; again from `yas--take-care-of-redo'....
3171 (setf (yas--snippet-fields snippet) nil)))
3173 (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
3175 (defun yas--safely-run-hooks (hook-var)
3176 (condition-case error
3177 (run-hooks hook-var)
3179 (yas--message 3 "%s error: %s" hook-var (error-message-string error)))))
3182 (defun yas--check-commit-snippet ()
3183 "Checks if point exited the currently active field of the snippet.
3185 If so cleans up the whole snippet up."
3186 (let* ((snippets (yas--snippets-at-point 'all-snippets))
3187 (snippets-left snippets)
3188 (snippet-exit-transform))
3189 (dolist (snippet snippets)
3190 (let ((active-field (yas--snippet-active-field snippet)))
3191 (setq snippet-exit-transform (yas--snippet-force-exit snippet))
3192 (cond ((or snippet-exit-transform
3193 (not (and active-field (yas--field-contains-point-p active-field))))
3194 (setq snippets-left (delete snippet snippets-left))
3195 (setf (yas--snippet-force-exit snippet) nil)
3196 (yas--commit-snippet snippet))
3198 (or (not yas--active-field-overlay)
3199 (not (overlay-buffer yas--active-field-overlay))))
3201 ;; stacked expansion: this case is mainly for recent
3202 ;; snippet exits that place us back int the field of
3206 (yas--move-to-field snippet active-field)
3207 (yas--update-mirrors snippet)))
3210 (unless (or (null snippets) snippets-left)
3211 (if snippet-exit-transform
3212 (yas--eval-lisp-no-saves snippet-exit-transform))
3213 (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
3215 ;; Apropos markers-to-points:
3217 ;; This was found useful for performance reasons, so that an
3218 ;; excessive number of live markers aren't kept around in the
3219 ;; `buffer-undo-list'. However, in `markers-to-points', the
3220 ;; set-to-nil markers can't simply be discarded and replaced with
3221 ;; fresh ones in `points-to-markers'. The original marker that was
3222 ;; just set to nil has to be reused.
3224 ;; This shouldn't bring horrible problems with undo/redo, but it
3227 (defun yas--markers-to-points (snippet)
3228 "Convert all markers in SNIPPET to a cons (POINT . MARKER)
3229 where POINT is the original position of the marker and MARKER is
3230 the original marker object with the position set to nil."
3231 (dolist (field (yas--snippet-fields snippet))
3232 (let ((start (marker-position (yas--field-start field)))
3233 (end (marker-position (yas--field-end field))))
3234 (set-marker (yas--field-start field) nil)
3235 (set-marker (yas--field-end field) nil)
3236 (setf (yas--field-start field) (cons start (yas--field-start field)))
3237 (setf (yas--field-end field) (cons end (yas--field-end field))))
3238 (dolist (mirror (yas--field-mirrors field))
3239 (let ((start (marker-position (yas--mirror-start mirror)))
3240 (end (marker-position (yas--mirror-end mirror))))
3241 (set-marker (yas--mirror-start mirror) nil)
3242 (set-marker (yas--mirror-end mirror) nil)
3243 (setf (yas--mirror-start mirror) (cons start (yas--mirror-start mirror)))
3244 (setf (yas--mirror-end mirror) (cons end (yas--mirror-end mirror))))))
3245 (let ((snippet-exit (yas--snippet-exit snippet)))
3247 (let ((exit (marker-position (yas--exit-marker snippet-exit))))
3248 (set-marker (yas--exit-marker snippet-exit) nil)
3249 (setf (yas--exit-marker snippet-exit) (cons exit (yas--exit-marker snippet-exit)))))))
3251 (defun yas--points-to-markers (snippet)
3252 "Convert all cons (POINT . MARKER) in SNIPPET to markers.
3254 This is done by setting MARKER to POINT with `set-marker'."
3255 (dolist (field (yas--snippet-fields snippet))
3256 (setf (yas--field-start field) (set-marker (cdr (yas--field-start field))
3257 (car (yas--field-start field))))
3258 (setf (yas--field-end field) (set-marker (cdr (yas--field-end field))
3259 (car (yas--field-end field))))
3260 (dolist (mirror (yas--field-mirrors field))
3261 (setf (yas--mirror-start mirror) (set-marker (cdr (yas--mirror-start mirror))
3262 (car (yas--mirror-start mirror))))
3263 (setf (yas--mirror-end mirror) (set-marker (cdr (yas--mirror-end mirror))
3264 (car (yas--mirror-end mirror))))))
3265 (let ((snippet-exit (yas--snippet-exit snippet)))
3267 (setf (yas--exit-marker snippet-exit) (set-marker (cdr (yas--exit-marker snippet-exit))
3268 (car (yas--exit-marker snippet-exit)))))))
3270 (defun yas--field-contains-point-p (field &optional point)
3271 (let ((point (or point
3273 (and (>= point (yas--field-start field))
3274 (<= point (yas--field-end field)))))
3276 (defun yas--field-text-for-display (field)
3277 "Return the propertized display text for field FIELD."
3278 (buffer-substring (yas--field-start field) (yas--field-end field)))
3280 (defun yas--undo-in-progress ()
3281 "True if some kind of undo is in progress."
3282 (or undo-in-progress
3283 (eq this-command 'undo)
3284 (eq this-command 'redo)))
3286 (defun yas--make-control-overlay (snippet start end)
3287 "Creates the control overlay that surrounds the snippet and
3289 (let ((overlay (make-overlay start
3294 (overlay-put overlay 'keymap yas-keymap)
3295 (overlay-put overlay 'priority 100)
3296 (overlay-put overlay 'yas--snippet snippet)
3299 (defun yas-skip-and-clear-or-delete-char (&optional field)
3300 "Clears unmodified field if at field start, skips to next tab.
3302 Otherwise deletes a character normally by calling `delete-char'."
3304 (let ((field (or field
3305 (and yas--active-field-overlay
3306 (overlay-buffer yas--active-field-overlay)
3307 (overlay-get yas--active-field-overlay 'yas--field)))))
3309 (not (yas--field-modified-p field))
3310 (eq (point) (marker-position (yas--field-start field))))
3311 (yas--skip-and-clear field)
3314 (call-interactively 'delete-char)))))
3316 (defun yas--skip-and-clear (field)
3317 "Deletes the region of FIELD and sets it's modified state to t."
3318 ;; Just before skipping-and-clearing the field, mark its children
3319 ;; fields as modified, too. If the children have mirrors-in-fields
3320 ;; this prevents them from updating erroneously (we're skipping and
3323 (yas--mark-this-and-children-modified field)
3324 (delete-region (yas--field-start field) (yas--field-end field)))
3326 (defun yas--mark-this-and-children-modified (field)
3327 (setf (yas--field-modified-p field) t)
3328 (let ((fom (yas--field-next field)))
3330 (yas--fom-parent-field fom))
3331 (when (and (eq (yas--fom-parent-field fom) field)
3333 (yas--mark-this-and-children-modified fom))
3334 (setq fom (yas--fom-next fom)))))
3336 (defun yas--make-move-active-field-overlay (snippet field)
3337 "Place the active field overlay in SNIPPET's FIELD.
3339 Move the overlay, or create it if it does not exit."
3340 (if (and yas--active-field-overlay
3341 (overlay-buffer yas--active-field-overlay))
3342 (move-overlay yas--active-field-overlay
3343 (yas--field-start field)
3344 (yas--field-end field))
3345 (setq yas--active-field-overlay
3346 (make-overlay (yas--field-start field)
3347 (yas--field-end field)
3349 (overlay-put yas--active-field-overlay 'priority 100)
3350 (overlay-put yas--active-field-overlay 'face 'yas-field-highlight-face)
3351 (overlay-put yas--active-field-overlay 'yas--snippet snippet)
3352 (overlay-put yas--active-field-overlay 'modification-hooks '(yas--on-field-overlay-modification))
3353 (overlay-put yas--active-field-overlay 'insert-in-front-hooks
3354 '(yas--on-field-overlay-modification))
3355 (overlay-put yas--active-field-overlay 'insert-behind-hooks
3356 '(yas--on-field-overlay-modification))))
3358 (defvar yas--inhibit-overlay-hooks nil
3359 "Bind this temporarily to non-nil to prevent running `yas--on-*-modification'.")
3361 (defun yas--on-field-overlay-modification (overlay after? beg end &optional length)
3362 "Clears the field and updates mirrors, conditionally.
3364 Only clears the field if it hasn't been modified and it point it
3365 at field start. This hook doesn't do anything if an undo is in
3367 (unless (or yas--inhibit-overlay-hooks
3368 (yas--undo-in-progress))
3369 (let* ((field (overlay-get overlay 'yas--field))
3370 (number (and field (yas--field-number field)))
3371 (snippet (overlay-get yas--active-field-overlay 'yas--snippet)))
3373 (yas--advance-end-maybe field (overlay-end overlay))
3375 (yas--field-update-display field snippet))
3376 (yas--update-mirrors snippet))
3378 (when (and (not after?)
3379 (not (yas--field-modified-p field))
3380 (eq (point) (if (markerp (yas--field-start field))
3381 (marker-position (yas--field-start field))
3382 (yas--field-start field))))
3383 (yas--skip-and-clear field))
3384 (setf (yas--field-modified-p field) t))))))
3386 ;;; Apropos protection overlays:
3388 ;; These exist for nasty users who will try to delete parts of the
3389 ;; snippet outside the active field. Actual protection happens in
3390 ;; `yas--on-protection-overlay-modification'.
3392 ;; Currently this signals an error which inhibits the command. For
3393 ;; commands that move point (like `kill-line'), point is restored in
3394 ;; the `yas--post-command-handler' using a global
3395 ;; `yas--protection-violation' variable.
3397 ;; Alternatively, I've experimented with an implementation that
3398 ;; commits the snippet before actually calling `this-command'
3399 ;; interactively, and then signals an error, which is ignored. but
3400 ;; blocks all other million modification hooks. This presented some
3401 ;; problems with stacked expansion.
3403 (defun yas--make-move-field-protection-overlays (snippet field)
3404 "Place protection overlays surrounding SNIPPET's FIELD.
3406 Move the overlays, or create them if they do not exit."
3407 (let ((start (yas--field-start field))
3408 (end (yas--field-end field)))
3409 ;; First check if the (1+ end) is contained in the buffer,
3410 ;; otherwise we'll have to do a bit of cheating and silently
3411 ;; insert a newline. the `(1+ (buffer-size))' should prevent this
3412 ;; when using stacked expansion
3414 (when (< (buffer-size) end)
3416 (yas--inhibit-overlay-hooks
3417 (goto-char (point-max))
3419 ;; go on to normal overlay creation/moving
3421 (cond ((and yas--field-protection-overlays
3422 (every #'overlay-buffer yas--field-protection-overlays))
3423 (move-overlay (first yas--field-protection-overlays) (1- start) start)
3424 (move-overlay (second yas--field-protection-overlays) end (1+ end)))
3426 (setq yas--field-protection-overlays
3427 (list (make-overlay (1- start) start nil t nil)
3428 (make-overlay end (1+ end) nil t nil)))
3429 (dolist (ov yas--field-protection-overlays)
3430 (overlay-put ov 'face 'yas--field-debug-face)
3431 (overlay-put ov 'yas--snippet snippet)
3432 ;; (overlay-put ov 'evaporate t)
3433 (overlay-put ov 'modification-hooks '(yas--on-protection-overlay-modification)))))))
3435 (defvar yas--protection-violation nil
3436 "When non-nil, signals attempts to erroneously exit or modify the snippet.
3438 Functions in the `post-command-hook', for example
3439 `yas--post-command-handler' can check it and reset its value to
3440 nil. The variables value is the point where the violation
3443 (defun yas--on-protection-overlay-modification (overlay after? beg end &optional length)
3444 "Signals a snippet violation, then issues error.
3446 The error should be ignored in `debug-ignored-errors'"
3447 (unless yas--inhibit-overlay-hooks
3448 (cond ((not (or after?
3449 (yas--undo-in-progress)))
3450 (setq yas--protection-violation (point))
3451 (error "Exit the snippet first!")))))
3453 (add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
3456 ;;; Snippet expansion and "stacked" expansion:
3458 ;; Stacked expansion is when you try to expand a snippet when already
3459 ;; inside a snippet expansion.
3461 ;; The parent snippet does not run its fields modification hooks
3462 ;; (`yas--on-field-overlay-modification' and
3463 ;; `yas--on-protection-overlay-modification') while the child snippet
3464 ;; is active. This means, among other things, that the mirrors of the
3465 ;; parent snippet are not updated, this only happening when one exits
3466 ;; the child snippet.
3468 ;; Unfortunately, this also puts some ugly (and not fully-tested)
3469 ;; bits of code in `yas-expand-snippet' and
3470 ;; `yas--commit-snippet'. I've tried to mark them with "stacked
3473 ;; This was thought to be safer in an undo/redo perspective, but
3474 ;; maybe the correct implementation is to make the globals
3475 ;; `yas--active-field-overlay' and `yas--field-protection-overlays' be
3476 ;; snippet-local and be active even while the child snippet is
3477 ;; running. This would mean a lot of overlay modification hooks
3478 ;; running, but if managed correctly (including overlay priorities)
3479 ;; they should account for all situations...
3481 (defun yas-expand-snippet (content &optional start end expand-env)
3482 "Expand snippet CONTENT at current point.
3484 Text between START and END will be deleted before inserting
3485 template. EXPAND-ENV is are let-style variable to value bindings
3486 considered when expanding the snippet."
3487 (run-hooks 'yas-before-expand-snippet-hook)
3490 (let* ((yas-selected-text (or yas-selected-text
3491 (and (region-active-p)
3492 (buffer-substring-no-properties (region-beginning)
3495 (and (region-active-p)
3499 (and (region-active-p)
3502 (to-delete (and start
3504 (buffer-substring-no-properties start end)))
3507 (setq yas--indent-original-column (current-column))
3508 ;; Delete the region to delete, this *does* get undo-recorded.
3510 (when (and to-delete
3512 (delete-region start end))
3514 (cond ((listp content)
3515 ;; x) This is a snippet-command
3517 (yas--eval-lisp-no-saves content))
3519 ;; x) This is a snippet-snippet :-)
3521 ;; Narrow the region down to the content, shoosh the
3522 ;; `buffer-undo-list', and create the snippet, the new
3523 ;; snippet updates its mirrors once, so we are left with
3524 ;; some plain text. The undo action for deleting this
3525 ;; plain text will get recorded at the end.
3527 ;; stacked expansion: also shoosh the overlay modification hooks
3529 (narrow-to-region start start)
3530 (let ((buffer-undo-list t))
3531 ;; snippet creation might evaluate users elisp, which
3532 ;; might generate errors, so we have to be ready to catch
3533 ;; them mostly to make the undo information
3535 (setq yas--start-column (save-restriction (widen) (current-column)))
3536 (yas--inhibit-overlay-hooks
3539 (eval `(let* ,expand-env
3541 (yas--snippet-create (point-min) (point-max))))
3543 (yas--snippet-create (point-min) (point-max)))))))
3545 ;; stacked-expansion: This checks for stacked expansion, save the
3546 ;; `yas--previous-active-field' and advance its boundary.
3548 (let ((existing-field (and yas--active-field-overlay
3549 (overlay-buffer yas--active-field-overlay)
3550 (overlay-get yas--active-field-overlay 'yas--field))))
3551 (when existing-field
3552 (setf (yas--snippet-previous-active-field snippet) existing-field)
3553 (yas--advance-end-maybe existing-field (overlay-end yas--active-field-overlay))))
3555 ;; Exit the snippet immediately if no fields
3557 (unless (yas--snippet-fields snippet)
3558 (yas-exit-snippet snippet))
3560 ;; Push two undo actions: the deletion of the inserted contents of
3561 ;; the new snippet (without the "key") followed by an apply of
3562 ;; `yas--take-care-of-redo' on the newly inserted snippet boundaries
3564 ;; A small exception, if `yas-also-auto-indent-first-line'
3565 ;; is t and `yas--indent' decides to indent the line to a
3566 ;; point before the actual expansion point, undo would be
3567 ;; messed up. We call the early point "newstart"". case,
3568 ;; and attempt to fix undo.
3570 (let ((newstart (overlay-start (yas--snippet-control-overlay snippet)))
3571 (end (overlay-end (yas--snippet-control-overlay snippet))))
3572 (when (< newstart start)
3573 (push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
3574 (push (cons newstart end) buffer-undo-list)
3575 (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
3577 ;; Now, schedule a move to the first field
3579 (let ((first-field (car (yas--snippet-fields snippet))))
3581 (sit-for 0) ;; fix issue 125
3582 (yas--move-to-field snippet first-field)))
3583 (yas--message 3 "snippet expanded.")
3586 (defun yas--take-care-of-redo (beg end snippet)
3587 "Commits SNIPPET, which in turn pushes an undo action for reviving it.
3589 Meant to exit in the `buffer-undo-list'."
3590 ;; slightly optimize: this action is only needed for snippets with
3591 ;; at least one field
3592 (when (yas--snippet-fields snippet)
3593 (yas--commit-snippet snippet)))
3595 (defun yas--snippet-revive (beg end snippet)
3596 "Revives SNIPPET and creates a control overlay from BEG to END.
3598 BEG and END are, we hope, the original snippets boundaries. All
3599 the markers/points exiting existing inside SNIPPET should point
3600 to their correct locations *at the time the snippet is revived*.
3602 After revival, push the `yas--take-care-of-redo' in the
3604 ;; Reconvert all the points to markers
3606 (yas--points-to-markers snippet)
3607 ;; When at least one editable field existed in the zombie snippet,
3608 ;; try to revive the whole thing...
3610 (let ((target-field (or (yas--snippet-active-field snippet)
3611 (car (yas--snippet-fields snippet)))))
3613 (setf (yas--snippet-control-overlay snippet) (yas--make-control-overlay snippet beg end))
3614 (overlay-put (yas--snippet-control-overlay snippet) 'yas--snippet snippet)
3616 (yas--move-to-field snippet target-field)
3618 (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
3619 buffer-undo-list))))
3621 (defun yas--snippet-create (begin end)
3622 "Creates a snippet from an template inserted between BEGIN and END.
3624 Returns the newly created snippet."
3625 (let ((snippet (yas--make-snippet)))
3627 (yas--snippet-parse-create snippet)
3629 ;; Sort and link each field
3630 (yas--snippet-sort-fields snippet)
3632 ;; Create keymap overlay for snippet
3633 (setf (yas--snippet-control-overlay snippet)
3634 (yas--make-control-overlay snippet (point-min) (point-max)))
3637 (goto-char (point-max))
3642 ;;; Apropos adjacencies and "fom's":
3644 ;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
3645 ;; recently expanded snippet, we might actually have many fields,
3646 ;; mirrors (and the snippet exit) in the very same position in the
3647 ;; buffer. Therefore we need to single-link the
3648 ;; fields-or-mirrors-or-exit (which I have abbreviated to "fom")
3649 ;; according to their original positions in the buffer.
3651 ;; Then we have operation `yas--advance-end-maybe' and
3652 ;; `yas--advance-start-maybe', which conditionally push the starts and
3653 ;; ends of these foms down the chain.
3655 ;; This allows for like the printf with the magic ",":
3657 ;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
3658 ;; $2${1:$(if (string-match "%" text) "\);" "")}$0
3660 (defun yas--fom-start (fom)
3661 (cond ((yas--field-p fom)
3662 (yas--field-start fom))
3663 ((yas--mirror-p fom)
3664 (yas--mirror-start fom))
3666 (yas--exit-marker fom))))
3668 (defun yas--fom-end (fom)
3669 (cond ((yas--field-p fom)
3670 (yas--field-end fom))
3671 ((yas--mirror-p fom)
3672 (yas--mirror-end fom))
3674 (yas--exit-marker fom))))
3676 (defun yas--fom-next (fom)
3677 (cond ((yas--field-p fom)
3678 (yas--field-next fom))
3679 ((yas--mirror-p fom)
3680 (yas--mirror-next fom))
3682 (yas--exit-next fom))))
3684 (defun yas--fom-parent-field (fom)
3685 (cond ((yas--field-p fom)
3686 (yas--field-parent-field fom))
3687 ((yas--mirror-p fom)
3688 (yas--mirror-parent-field fom))
3692 (defun yas--calculate-adjacencies (snippet)
3693 "Calculate adjacencies for fields or mirrors of SNIPPET.
3695 This is according to their relative positions in the buffer, and
3696 has to be called before the $-constructs are deleted."
3697 (labels ((yas--fom-set-next-fom (fom nextfom)
3698 (cond ((yas--field-p fom)
3699 (setf (yas--field-next fom) nextfom))
3700 ((yas--mirror-p fom)
3701 (setf (yas--mirror-next fom) nextfom))
3703 (setf (yas--exit-next fom) nextfom))))
3704 (yas--compare-fom-begs (fom1 fom2)
3705 (if (= (yas--fom-start fom2) (yas--fom-start fom1))
3706 (yas--mirror-p fom2)
3707 (>= (yas--fom-start fom2) (yas--fom-start fom1))))
3708 (yas--link-foms (fom1 fom2)
3709 (yas--fom-set-next-fom fom1 fom2)))
3710 ;; make some yas--field, yas--mirror and yas--exit soup
3712 (when (yas--snippet-exit snippet)
3713 (push (yas--snippet-exit snippet) soup))
3714 (dolist (field (yas--snippet-fields snippet))
3716 (dolist (mirror (yas--field-mirrors field))
3717 (push mirror soup)))
3720 #'yas--compare-fom-begs))
3722 (reduce #'yas--link-foms soup)))))
3724 (defun yas--calculate-mirrors-in-fields (snippet mirror)
3725 "Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
3727 Use the tightest containing field if more than one field contains
3728 the mirror. Intended to be called *before* the dollar-regions are
3730 (let ((min (point-min))
3732 (dolist (field (yas--snippet-fields snippet))
3733 (when (and (<= (yas--field-start field) (yas--mirror-start mirror))
3734 (<= (yas--mirror-end mirror) (yas--field-end field))
3735 (< min (yas--field-start field))
3736 (< (yas--field-end field) max))
3737 (setq min (yas--field-start field)
3738 max (yas--field-end field))
3739 (setf (yas--mirror-parent-field mirror) field)))))
3741 (defun yas--advance-end-maybe (fom newend)
3742 "Maybe advance FOM's end to NEWEND if it needs it.
3746 * call `yas--advance-start-maybe' on FOM's next fom.
3748 * in case FOM is field call `yas--advance-end-maybe' on its parent
3751 Also, if FOM is an exit-marker, always call
3752 `yas--advance-start-maybe' on its next fom. This is because
3753 exit-marker have identical start and end markers."
3754 (cond ((and fom (< (yas--fom-end fom) newend))
3755 (set-marker (yas--fom-end fom) newend)
3756 (yas--advance-start-maybe (yas--fom-next fom) newend)
3757 (yas--advance-end-of-parents-maybe (yas--fom-parent-field fom) newend))
3759 (yas--advance-start-maybe (yas--fom-next fom) newend))))
3761 (defun yas--advance-start-maybe (fom newstart)
3762 "Maybe advance FOM's start to NEWSTART if it needs it.
3764 If it does, also call `yas--advance-end-maybe' on FOM."
3765 (when (and fom (< (yas--fom-start fom) newstart))
3766 (set-marker (yas--fom-start fom) newstart)
3767 (yas--advance-end-maybe fom newstart)))
3769 (defun yas--advance-end-of-parents-maybe (field newend)
3770 "Like `yas--advance-end-maybe' but for parent fields.
3772 Only works for fields and doesn't care about the start of the
3773 next FOM. Works its way up recursively for parents of parents."
3775 (< (yas--field-end field) newend))
3776 (set-marker (yas--field-end field) newend)
3777 (yas--advance-end-of-parents-maybe (yas--field-parent-field field) newend)))
3779 (defvar yas--dollar-regions nil
3780 "When expanding the snippet the \"parse-create\" functions add
3781 cons cells to this var.")
3783 (defvar yas--backquote-markers-and-strings nil
3784 "List of (MARKER . STRING) marking where the values from
3785 backquoted lisp expressions should be inserted at the end of
3788 (defun yas--snippet-parse-create (snippet)
3789 "Parse a recently inserted snippet template, creating all
3790 necessary fields, mirrors and exit points.
3792 Meant to be called in a narrowed buffer, does various passes"
3793 (let ((parse-start (point)))
3794 ;; Reset the yas--dollar-regions
3796 (setq yas--dollar-regions nil)
3797 ;; protect just the backquotes
3799 (yas--protect-escapes nil '(?`))
3800 ;; replace all backquoted expressions
3802 (goto-char parse-start)
3803 (yas--save-backquotes)
3804 ;; protect escaped characters
3806 (yas--protect-escapes)
3807 ;; parse fields with {}
3809 (goto-char parse-start)
3810 (yas--field-parse-create snippet)
3811 ;; parse simple mirrors and fields
3813 (goto-char parse-start)
3814 (yas--simple-mirror-parse-create snippet)
3815 ;; parse mirror transforms
3817 (goto-char parse-start)
3818 (yas--transform-mirror-parse-create snippet)
3819 ;; calculate adjacencies of fields and mirrors
3821 (yas--calculate-adjacencies snippet)
3822 ;; Delete $-constructs
3824 (yas--delete-regions yas--dollar-regions)
3825 ;; restore backquoted expression values
3827 (yas--restore-backquotes)
3830 (goto-char parse-start)
3831 (yas--restore-escapes)
3832 ;; update mirrors for the first time
3834 (yas--update-mirrors snippet)
3835 ;; indent the best we can
3837 (goto-char parse-start)
3838 (yas--indent snippet)))
3840 (defun yas--indent-according-to-mode (snippet-markers)
3841 "Indent current line according to mode, preserving SNIPPET-MARKERS."
3842 ;;; Apropos indenting problems....
3844 ;; `indent-according-to-mode' uses whatever `indent-line-function'
3845 ;; is available. Some implementations of these functions delete text
3846 ;; before they insert. If there happens to be a marker just after
3847 ;; the text being deleted, the insertion actually happens after the
3848 ;; marker, which misplaces it.
3850 ;; This would also happen if we had used overlays with the
3851 ;; `front-advance' property set to nil.
3853 ;; This is why I have these `trouble-markers', they are the ones at
3854 ;; they are the ones at the first non-whitespace char at the line
3855 ;; (i.e. at `yas--real-line-beginning'. After indentation takes place
3856 ;; we should be at the correct to restore them to. All other
3857 ;; non-trouble-markers have been *pushed* and don't need special
3860 (goto-char (yas--real-line-beginning))
3861 (let ((trouble-markers (remove-if-not #'(lambda (marker)
3867 (indent-according-to-mode)
3868 (error (yas--message 3 "Warning: `yas--indent-according-to-mode' having problems running %s" indent-line-function)
3870 (mapc #'(lambda (marker)
3871 (set-marker marker (point)))
3874 (defvar yas--indent-original-column nil)
3875 (defun yas--indent (snippet)
3876 (let ((snippet-markers (yas--collect-snippet-markers snippet)))
3877 ;; Look for those $>
3879 (while (re-search-forward "$>" nil t)
3880 (delete-region (match-beginning 0) (match-end 0))
3881 (when (not (eq yas-indent-line 'auto))
3882 (yas--indent-according-to-mode snippet-markers))))
3883 ;; Now do stuff for 'fixed and 'auto
3885 (cond ((eq yas-indent-line 'fixed)
3886 (while (and (zerop (forward-line))
3887 (zerop (current-column)))
3888 (indent-to-column yas--indent-original-column)))
3889 ((eq yas-indent-line 'auto)
3890 (let ((end (set-marker (make-marker) (point-max)))
3891 (indent-first-line-p yas-also-auto-indent-first-line))
3892 (while (and (zerop (if indent-first-line-p
3895 (setq indent-first-line-p nil))
3899 (yas--indent-according-to-mode snippet-markers))))
3903 (defun yas--collect-snippet-markers (snippet)
3904 "Make a list of all the markers used by SNIPPET."
3906 (dolist (field (yas--snippet-fields snippet))
3907 (push (yas--field-start field) markers)
3908 (push (yas--field-end field) markers)
3909 (dolist (mirror (yas--field-mirrors field))
3910 (push (yas--mirror-start mirror) markers)
3911 (push (yas--mirror-end mirror) markers)))
3912 (let ((snippet-exit (yas--snippet-exit snippet)))
3913 (when (and snippet-exit
3914 (marker-buffer (yas--exit-marker snippet-exit)))
3915 (push (yas--exit-marker snippet-exit) markers)))
3918 (defun yas--real-line-beginning ()
3919 (let ((c (char-after (line-beginning-position)))
3920 (n (line-beginning-position)))
3921 (while (or (eql c ?\ )
3924 (setq c (char-after n)))
3927 (defun yas--escape-string (escaped)
3928 (concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
3930 (defun yas--protect-escapes (&optional text escaped)
3931 "Protect all escaped characters with their numeric ASCII value.
3933 With optional string TEXT do it in string instead of buffer."
3934 (let ((changed-text text)
3935 (text-provided-p text))
3936 (mapc #'(lambda (escaped)
3938 (yas--replace-all (concat "\\" (char-to-string escaped))
3939 (yas--escape-string escaped)
3940 (when text-provided-p changed-text))))
3941 (or escaped yas--escaped-characters))
3944 (defun yas--restore-escapes (&optional text escaped)
3945 "Restore all escaped characters from their numeric ASCII value.
3947 With optional string TEXT do it in string instead of the buffer."
3948 (let ((changed-text text)
3949 (text-provided-p text))
3950 (mapc #'(lambda (escaped)
3952 (yas--replace-all (yas--escape-string escaped)
3953 (char-to-string escaped)
3954 (when text-provided-p changed-text))))
3955 (or escaped yas--escaped-characters))
3958 (defun yas--save-backquotes ()
3959 "Save all the \"`(lisp-expression)`\"-style expressions
3960 with their evaluated value into `yas--backquote-markers-and-strings'."
3961 (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
3962 (let ((current-string (match-string-no-properties 1)) transformed)
3963 (delete-region (match-beginning 0) (match-end 0))
3964 (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
3965 (goto-char (match-beginning 0))
3967 (let ((marker (make-marker)))
3968 (insert "Y") ;; quite horrendous, I love it :)
3969 (set-marker marker (point))
3971 (push (cons marker transformed) yas--backquote-markers-and-strings))))))
3973 (defun yas--restore-backquotes ()
3974 "Replace markers in `yas--backquote-markers-and-strings' with their values."
3975 (while yas--backquote-markers-and-strings
3976 (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
3977 (marker (car marker-and-string))
3978 (string (cdr marker-and-string)))
3984 (set-marker marker nil)))))
3986 (defun yas--scan-sexps (from count)
3988 (with-syntax-table (standard-syntax-table)
3989 (scan-sexps from count))
3993 (defun yas--make-marker (pos)
3994 "Create a marker at POS with nil `marker-insertion-type'."
3995 (let ((marker (set-marker (make-marker) pos)))
3996 (set-marker-insertion-type marker nil)
3999 (defun yas--field-parse-create (snippet &optional parent-field)
4000 "Parse most field expressions in SNIPPET, except for the simple one \"$n\".
4002 The following count as a field:
4004 * \"${n: text}\", for a numbered field with default text, as long as N is not 0;
4006 * \"${n: text$(expression)}, the same with a lisp expression;
4007 this is caught with the curiously named `yas--multi-dollar-lisp-expression-regexp'
4009 * the same as above but unnumbered, (no N:) and number is calculated automatically.
4011 When multiple expressions are found, only the last one counts."
4014 (while (re-search-forward yas--field-regexp nil t)
4015 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4016 (number (and (match-string-no-properties 1)
4017 (string-to-number (match-string-no-properties 1))))
4018 (brand-new-field (and real-match-end-0
4019 ;; break if on "$(" immediately
4020 ;; after the ":", this will be
4021 ;; caught as a mirror with
4023 (not (save-match-data
4024 (eq (string-match "$[ \t\n]*("
4025 (match-string-no-properties 2)) 0)))
4026 ;; allow ${0: some exit text}
4027 ;; (not (and number (zerop number)))
4028 (yas--make-field number
4029 (yas--make-marker (match-beginning 2))
4030 (yas--make-marker (1- real-match-end-0))
4032 (when brand-new-field
4033 (goto-char real-match-end-0)
4034 (push (cons (1- real-match-end-0) real-match-end-0)
4035 yas--dollar-regions)
4036 (push (cons (match-beginning 0) (match-beginning 2))
4037 yas--dollar-regions)
4038 (push brand-new-field (yas--snippet-fields snippet))
4041 (narrow-to-region (yas--field-start brand-new-field) (yas--field-end brand-new-field))
4042 (goto-char (point-min))
4043 (yas--field-parse-create snippet brand-new-field)))))))
4044 ;; if we entered from a parent field, now search for the
4045 ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
4046 ;; primary field transformations
4050 (while (re-search-forward yas--multi-dollar-lisp-expression-regexp nil t)
4051 (let* ((real-match-end-1 (yas--scan-sexps (match-beginning 1) 1)))
4052 ;; commit the primary field transformation if:
4054 ;; 1. we don't find it in yas--dollar-regions (a subnested
4055 ;; field) might have already caught it.
4057 ;; 2. we really make sure we have either two '$' or some
4058 ;; text and a '$' after the colon ':'. This is a FIXME: work
4059 ;; my regular expressions and end these ugly hacks.
4061 (when (and real-match-end-1
4062 (not (member (cons (match-beginning 0)
4064 yas--dollar-regions))
4066 (char-before (1- (match-beginning 1))))))
4067 (let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
4069 (setf (yas--field-transform parent-field)
4070 (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
4071 (push (cons (match-beginning 0) real-match-end-1)
4072 yas--dollar-regions)))))))
4074 (defun yas--transform-mirror-parse-create (snippet)
4075 "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
4076 (while (re-search-forward yas--transform-mirror-regexp nil t)
4077 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4078 (number (string-to-number (match-string-no-properties 1)))
4080 (not (zerop number))
4081 (yas--snippet-find-field snippet number)))
4083 (and real-match-end-0
4085 (yas--make-mirror (yas--make-marker (match-beginning 0))
4086 (yas--make-marker (match-beginning 0))
4088 (yas--restore-escapes
4089 (buffer-substring-no-properties (match-beginning 2)
4090 (1- real-match-end-0))))))))
4091 (when brand-new-mirror
4092 (push brand-new-mirror
4093 (yas--field-mirrors field))
4094 (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
4095 (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
4097 (defun yas--simple-mirror-parse-create (snippet)
4098 "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
4099 (while (re-search-forward yas--simple-mirror-regexp nil t)
4100 (let ((number (string-to-number (match-string-no-properties 1))))
4101 (cond ((zerop number)
4103 (setf (yas--snippet-exit snippet)
4104 (yas--make-exit (yas--make-marker (match-end 0))))
4106 (goto-char (match-beginning 0))
4107 (when yas-wrap-around-region
4108 (cond (yas-selected-text
4109 (insert yas-selected-text))
4110 ((and (eq yas-wrap-around-region 'cua)
4113 (insert (prog1 (get-register ?0)
4114 (set-register ?0 nil))))))
4115 (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
4116 yas--dollar-regions)))
4118 (let ((field (yas--snippet-find-field snippet number)))
4120 (let ((brand-new-mirror (yas--make-mirror
4121 (yas--make-marker (match-beginning 0))
4122 (yas--make-marker (match-beginning 0))
4124 (push brand-new-mirror
4125 (yas--field-mirrors field))
4126 (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
4127 (push (yas--make-field number
4128 (yas--make-marker (match-beginning 0))
4129 (yas--make-marker (match-beginning 0))
4131 (yas--snippet-fields snippet))))
4132 (push (cons (match-beginning 0) (match-end 0))
4133 yas--dollar-regions))))))
4135 (defun yas--delete-regions (regions)
4136 "Sort disjuct REGIONS by start point, then delete from the back."
4137 (mapc #'(lambda (reg)
4138 (delete-region (car reg) (cdr reg)))
4141 (>= (car r1) (car r2))))))
4143 (defun yas--update-mirrors (snippet)
4144 "Updates all the mirrors of SNIPPET."
4146 (dolist (field-and-mirror (sort
4147 ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
4148 ;; where F is the field that M is mirroring
4150 (mapcan #'(lambda (field)
4151 (mapcar #'(lambda (mirror)
4152 (cons field mirror))
4153 (yas--field-mirrors field)))
4154 (yas--snippet-fields snippet))
4155 ;; then sort this list so that entries with mirrors with parent
4156 ;; fields appear before. This was important for fixing #290, and
4157 ;; luckily also handles the case where a mirror in a field causes
4158 ;; another mirror to need reupdating
4160 #'(lambda (field-and-mirror1 field-and-mirror2)
4161 (yas--mirror-parent-field (cdr field-and-mirror1)))))
4162 (let* ((field (car field-and-mirror))
4163 (mirror (cdr field-and-mirror))
4164 (parent-field (yas--mirror-parent-field mirror)))
4165 ;; before updating a mirror with a parent-field, maybe advance
4169 (yas--advance-start-maybe mirror (yas--fom-start parent-field)))
4170 ;; update this mirror
4172 (yas--mirror-update-display mirror field)
4173 ;; `yas--place-overlays' is needed if the active field and
4174 ;; protected overlays have been changed because of insertions
4175 ;; in `yas--mirror-update-display'
4177 (when (eq field (yas--snippet-active-field snippet))
4178 (yas--place-overlays snippet field))))))
4180 (defun yas--mirror-update-display (mirror field)
4181 "Update MIRROR according to FIELD (and mirror transform)."
4183 (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
4184 (reflection (and (not (and mirror-parent-field
4185 (yas--field-modified-p mirror-parent-field)))
4186 (or (yas--apply-transform mirror field 'empty-on-nil)
4187 (yas--field-text-for-display field)))))
4188 (when (and reflection
4189 (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
4190 (yas--mirror-end mirror)))))
4191 (goto-char (yas--mirror-start mirror))
4192 (yas--inhibit-overlay-hooks
4193 (insert reflection))
4194 (if (> (yas--mirror-end mirror) (point))
4195 (delete-region (point) (yas--mirror-end mirror))
4196 (set-marker (yas--mirror-end mirror) (point))
4197 (yas--advance-start-maybe (yas--mirror-next mirror) (point))
4198 ;; super-special advance
4199 (yas--advance-end-of-parents-maybe mirror-parent-field (point))))))
4201 (defun yas--field-update-display (field snippet)
4202 "Much like `yas--mirror-update-display', but for fields."
4203 (when (yas--field-transform field)
4204 (let ((transformed (and (not (eq (yas--field-number field) 0))
4205 (yas--apply-transform field field)))
4207 (when (and transformed
4208 (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
4209 (yas--field-end field)))))
4210 (setf (yas--field-modified-p field) t)
4211 (goto-char (yas--field-start field))
4212 (yas--inhibit-overlay-hooks
4213 (insert transformed)
4214 (if (> (yas--field-end field) (point))
4215 (delete-region (point) (yas--field-end field))
4216 (set-marker (yas--field-end field) (point))
4217 (yas--advance-start-maybe (yas--field-next field) (point)))
4221 ;;; Post-command hook:
4223 (defun yas--post-command-handler ()
4224 "Handles various yasnippet conditions after each command."
4225 (cond (yas--protection-violation
4226 (goto-char yas--protection-violation)
4227 (setq yas--protection-violation nil))
4228 ((eq 'undo this-command)
4230 ;; After undo revival the correct field is sometimes not
4231 ;; restored correctly, this condition handles that
4233 (let* ((snippet (car (yas--snippets-at-point)))
4234 (target-field (and snippet
4235 (find-if-not #'(lambda (field)
4236 (yas--field-probably-deleted-p snippet field))
4238 (cons (yas--snippet-active-field snippet)
4239 (yas--snippet-fields snippet)))))))
4241 (yas--move-to-field snippet target-field))))
4242 ((not (yas--undo-in-progress))
4243 ;; When not in an undo, check if we must commit the snippet
4244 ;; (user exited it).
4245 (yas--check-commit-snippet))))
4249 ;; The docstrings for some functions are generated dynamically
4250 ;; depending on the context.
4252 (put 'yas-expand 'function-documentation
4253 '(yas--expand-from-trigger-key-doc))
4254 (defun yas--expand-from-trigger-key-doc ()
4255 "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
4256 (let ((fallback-description
4257 (cond ((eq yas-fallback-behavior 'call-other-command)
4258 (let* ((fallback (yas--keybinding-beyond-yasnippet)))
4260 (format " call command `%s'." (pp-to-string fallback)))
4261 " do nothing (`yas-expand' doesn't shadow\nanything)")))
4262 ((eq yas-fallback-behavior 'return-nil)
4265 ", defer to `yas-fallback-behaviour' (which see)"))))
4266 (concat "Expand a snippet before point. If no snippet
4267 expansion is possible,"
4268 fallback-description
4269 "\n\nOptional argument FIELD is for non-interactive use and is an
4270 object satisfying `yas--field-p' to restrict the expansion to.")))
4272 (put 'yas-expand-from-keymap 'function-documentation '(yas--expand-from-keymap-doc))
4273 (defun yas--expand-from-keymap-doc ()
4274 "A doc synthesizer for `yas--expand-from-keymap-doc'."
4275 (add-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce)
4276 (concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
4277 (when (eq this-command 'describe-key)
4278 (let* ((vec (this-single-command-keys))
4279 (templates (mapcan #'(lambda (table)
4280 (yas--fetch table vec))
4281 (yas--get-snippet-tables)))
4282 (yas--direct-keymaps nil)
4283 (fallback (key-binding vec)))
4284 (concat "In this case, "
4286 (concat "these snippets are bound to this key:\n"
4287 (yas--template-pretty-list templates)
4288 "\n\nIf none of these expands, "))
4290 (format "fallback `%s' will be called." (pp-to-string fallback)))
4291 "no fallback keybinding is called."))))))
4293 (defun yas--template-pretty-list (templates)
4295 (yas-buffer-local-condition 'always))
4296 (dolist (plate templates)
4297 (setq acc (concat acc "\n*) "
4298 (propertize (concat "\\\\snippet `" (car plate) "'")
4299 'yasnippet (cdr plate)))))
4302 (define-button-type 'help-snippet-def
4303 :supertype 'help-xref
4304 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
4305 'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
4307 (defun yas--snippet-description-finish-runonce ()
4308 "Final adjustments for the help buffer when snippets are concerned."
4309 (yas--create-snippet-xrefs)
4310 (remove-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce))
4312 (defun yas--create-snippet-xrefs ()
4314 (goto-char (point-min))
4315 (while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
4316 (let ((template (get-text-property (match-beginning 1)
4319 (help-xref-button 1 'help-snippet-def template)
4320 (kill-region (match-end 1) (match-end 0))
4321 (kill-region (match-beginning 0) (match-beginning 1)))))))
4323 (defun yas--expand-uuid (mode-symbol uuid &optional start end expand-env)
4324 "Expand a snippet registered in MODE-SYMBOL's table with UUID.
4326 Remaining args as in `yas-expand-snippet'."
4327 (let* ((table (gethash mode-symbol yas--tables))
4328 (yas--current-template (and table
4329 (gethash uuid (yas--table-uuidhash table)))))
4330 (when yas--current-template
4331 (yas-expand-snippet (yas--template-content yas--current-template)))))
4335 (defvar yas-verbosity 4
4336 "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
4338 (defun yas--message (level message &rest args)
4339 "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
4340 (when (> yas-verbosity level)
4341 (message (apply #'yas--format message args))))
4343 (defun yas--format (format-control &rest format-args)
4344 (apply #'format (concat "[yas] " format-control) format-args))
4351 ;; `locate-dominating-file'
4352 ;; `region-active-p'
4354 ;; added for compatibility in emacsen < 23
4355 (unless (>= emacs-major-version 23)
4356 (unless (fboundp 'region-active-p)
4357 (defun region-active-p () (and transient-mark-mode mark-active)))
4359 (unless (fboundp 'locate-dominating-file)
4360 (defvar locate-dominating-stop-dir-regexp
4361 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
4362 "Regexp of directory names which stop the search in `locate-dominating-file'.
4363 Any directory whose name matches this regexp will be treated like
4364 a kind of root directory by `locate-dominating-file' which will stop its search
4365 when it bumps into it.
4366 The default regexp prevents fruitless and time-consuming attempts to find
4367 special files in directories in which filenames are interpreted as hostnames,
4368 or mount points potentially requiring authentication as a different user.")
4370 (defun locate-dominating-file (file name)
4371 "Look up the directory hierarchy from FILE for a file named NAME.
4372 Stop at the first parent directory containing a file NAME,
4373 and return the directory. Return nil if not found."
4374 ;; We used to use the above locate-dominating-files code, but the
4375 ;; directory-files call is very costly, so we're much better off doing
4376 ;; multiple calls using the code in here.
4378 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
4379 ;; `name' in /home or in /.
4380 (setq file (abbreviate-file-name file))
4383 ;; `user' is not initialized outside the loop because
4384 ;; `file' may not exist, so we may have to walk up part of the
4385 ;; hierarchy before we find the "initial UUID".
4388 (while (not (or root
4390 ;; FIXME: Disabled this heuristic because it is sometimes
4392 ;; As a heuristic, we stop looking up the hierarchy of
4393 ;; directories as soon as we find a directory belonging
4394 ;; to another user. This should save us from looking in
4395 ;; things like /net and /afs. This assumes that all the
4396 ;; files inside a project belong to the same user.
4397 ;; (let ((prev-user user))
4398 ;; (setq user (nth 2 (file-attributes file)))
4399 ;; (and prev-user (not (equal user prev-user))))
4400 (string-match locate-dominating-stop-dir-regexp file)))
4401 (setq try (file-exists-p (expand-file-name name file)))
4402 (cond (try (setq root file))
4403 ((equal file (setq prev-file file
4404 file (file-name-directory
4405 (directory-file-name file))))
4409 ;; `c-neutralize-syntax-in-CPP` sometimes fires "End of Buffer" error
4410 ;; (when it execute forward-char) and interrupt the after change
4411 ;; hook. Thus prevent the insert-behind hook of yasnippet to be
4412 ;; invoked. Here's a way to reproduce it:
4414 ;; # open a *new* Emacs.
4415 ;; # load yasnippet.
4416 ;; # open a *new* .cpp file.
4417 ;; # input "inc" and press TAB to expand the snippet.
4418 ;; # select the `#include <...>` snippet.
4419 ;; # type inside `<>`
4421 (defadvice c-neutralize-syntax-in-CPP
4422 (around yas--mp/c-neutralize-syntax-in-CPP activate)
4423 "Adviced `c-neutralize-syntax-in-CPP' to properly
4424 handle the end-of-buffer error fired in it by calling
4425 `forward-char' at the end of buffer."
4428 (error (message (error-message-string err)))))
4430 ;; disable c-electric-* serial command in YAS fields
4431 (add-hook 'c-mode-common-hook
4433 (dolist (k '(":" ">" ";" "<" "{" "}"))
4434 (define-key (symbol-value (make-local-variable 'yas-keymap))
4435 k 'self-insert-command))))
4437 ;;; Backward compatibility to yasnippet <= 0.7
4439 (defvar yas--exported-syms '(;; `defcustom's
4442 yas-prompt-functions
4444 yas-also-auto-indent-first-line
4446 yas-triggers-in-field
4447 yas-fallback-behavior
4448 yas-choose-keys-first
4449 yas-choose-tables-first
4452 yas-wrap-around-region
4455 yas-expand-only-for-last-commands
4456 yas-field-highlight-face
4458 ;; these vars can be customized as well
4464 yas-after-exit-snippet-hook
4465 yas-before-expand-snippet-hook
4466 yas-buffer-local-condition
4469 ;; prompting functions
4474 yas-completing-prompt
4477 ;; interactive functions
4482 yas-direct-keymaps-reload
4486 yas-compile-directory
4489 yas-expand-from-trigger-key
4490 yas-expand-from-keymap
4492 yas-visit-snippet-file
4494 yas-load-snippet-buffer
4497 yas-next-field-or-maybe-expand
4502 yas-exit-all-snippets
4503 yas-skip-and-clear-or-delete-char
4505 ;; symbols that I "exported" for use
4506 ;; in snippets and hookage
4524 yas-default-from-field
4527 yas-define-condition-cache
4528 yas-hippie-try-expand
4531 ;; debug definitions
4532 ;; yas-debug-snippet-vars
4533 ;; yas-exterminate-package
4536 ;; testing definitions
4537 ;; yas-should-expand
4538 ;; yas-should-not-expand
4540 ;; yas-make-file-or-dirs
4542 ;; yas-saving-variables
4543 ;; yas-call-with-snippet-dirs
4544 ;; yas-with-snippet-dirs
4546 "Exported yasnippet symbols.
4548 i.e. ones that I will try to keep in future yasnippet versions
4549 and ones that other elisp libraries can more or less safely rely
4552 (defvar yas--dont-backport '(yas-active-keys)
4553 "Exported symbols that don't map back to \"yas/*\" variants.")
4555 (dolist (sym (set-difference yas--exported-syms yas--dont-backport))
4556 (let ((backported (intern (replace-regexp-in-string "^yas-" "yas/" (symbol-name sym)))))
4558 (make-obsolete-variable backported sym "yasnippet 0.8")
4559 (defvaralias backported sym))
4561 (make-obsolete backported sym "yasnippet 0.8")
4562 (defalias backported sym))))
4565 (provide 'yasnippet)
4567 ;;; yasnippet.el ends here
4570 ;; byte-compile-warnings: (not cl-functions)