1 ;;; yasnippet.el --- Yet another snippet extension for Emacs.
3 ;; Copyright (C) 2008-2013 Free Software Foundation, Inc.
4 ;; Authors: pluskid <pluskid@gmail.com>, João Távora <joaotavora@gmail.com>
5 ;; Maintainer: João Távora <joaotavora@gmail.com>
7 ;; Package-version: 0.8.0
8 ;; X-URL: http://github.com/capitaomorte/yasnippet
9 ;; Keywords: convenience, emulation
10 ;; URL: http://github.com/capitaomorte/yasnippet
11 ;; EmacsWiki: YaSnippetMode
13 ;; This program is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; This program is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
28 ;; Basic steps to setup:
30 ;; (add-to-list 'load-path
31 ;; "~/path-to-yasnippet")
32 ;; (require 'yasnippet)
33 ;; (yas-global-mode 1)
36 ;; Interesting variables are:
40 ;; The directory where user-created snippets are to be
41 ;; stored. Can also be a list of directories. In that case,
42 ;; when used for bulk (re)loading of snippets (at startup or
43 ;; via `yas-reload-all'), directories appearing earlier in
44 ;; the list shadow other dir's snippets. Also, the first
45 ;; directory is taken as the default for storing the user's
48 ;; The deprecated `yas/root-directory' aliases this variable
49 ;; for backward-compatibility.
52 ;; Major commands are:
56 ;; Try to expand snippets before point. In `yas-minor-mode',
57 ;; this is normally bound to TAB, but you can customize it in
58 ;; `yas-minor-mode-map'.
60 ;; M-x yas-load-directory
62 ;; Prompts you for a directory hierarchy of snippets to load.
64 ;; M-x yas-activate-extra-mode
66 ;; Prompts you for an extra mode to add snippets for in the
69 ;; M-x yas-insert-snippet
71 ;; Prompts you for possible snippet expansion if that is
72 ;; possible according to buffer-local and snippet-local
73 ;; expansion conditions. With prefix argument, ignore these
76 ;; M-x yas-visit-snippet-file
78 ;; Prompts you for possible snippet expansions like
79 ;; `yas-insert-snippet', but instead of expanding it, takes
80 ;; you directly to the snippet definition's file, if it
83 ;; M-x yas-new-snippet
85 ;; Lets you create a new snippet file in the correct
86 ;; subdirectory of `yas-snippet-dirs', according to the
89 ;; M-x yas-load-snippet-buffer
91 ;; When editing a snippet, this loads the snippet. This is
92 ;; bound to "C-c C-c" while in the `snippet-mode' editing
95 ;; M-x yas-tryout-snippet
97 ;; When editing a snippet, this opens a new empty buffer,
98 ;; sets it to the appropriate major mode and inserts the
99 ;; snippet there, so you can see what it looks like. This is
100 ;; bound to "C-c C-t" while in `snippet-mode'.
102 ;; M-x yas-describe-tables
104 ;; Lists known snippets in a separate buffer. User is
105 ;; prompted as to whether only the currently active tables
106 ;; are to be displayed, or all the tables for all major
109 ;; If you have `dropdown-list' installed, you can optionally use it
110 ;; as the preferred "prompting method", putting in your .emacs file,
113 ;; (require 'dropdown-list)
114 ;; (setq yas-prompt-functions '(yas-dropdown-prompt
116 ;; yas-completing-prompt))
118 ;; Also check out the customization group
120 ;; M-x customize-group RET yasnippet RET
122 ;; If you use the customization group to set variables
123 ;; `yas-snippet-dirs' or `yas-global-mode', make sure the path to
124 ;; "yasnippet.el" is present in the `load-path' *before* the
125 ;; `custom-set-variables' is executed in your .emacs file.
127 ;; For more information and detailed usage, refer to the project page:
128 ;; http://github.com/capitaomorte/yasnippet
137 (defvar yas--editing-template)
138 (defvar yas--guessed-modes)
139 (defvar yas--indent-original-column)
140 (defvar yas--scheduled-jit-loads)
142 (defvar yas-selected-text)
143 (defvar yas-verbosity)
144 (defvar yas--current-template)
147 ;;; User customizable variables
149 (defgroup yasnippet nil
150 "Yet Another Snippet extension"
153 (defvar yas-installed-snippets-dir nil)
154 (setq yas-installed-snippets-dir
156 (concat (file-name-directory load-file-name) "snippets")))
158 (defcustom yas-snippet-dirs (remove nil
159 (list "~/.emacs.d/snippets"
160 'yas-installed-snippets-dir))
161 "List of top-level snippet directories.
163 Each element, a string or a symbol whose value is a string,
164 designates a top-level directory where per-mode snippet
165 directories can be found.
167 Elements appearing earlier in the list shadow later elements'
170 The first directory is taken as the default for storing snippet's
171 created with `yas-new-snippet'. "
172 :type '(choice (string :tag "Single directory (string)")
173 (repeat :args (string) :tag "List of directories (strings)"))
176 :set #'(lambda (symbol new)
177 (let ((old (and (boundp symbol)
178 (symbol-value symbol))))
179 (set-default symbol new)
180 (unless (or (not (fboundp 'yas-reload-all))
184 (defun yas-snippet-dirs ()
185 "Return variable `yas-snippet-dirs' as list of strings."
186 (cl-loop for e in (if (listp yas-snippet-dirs)
188 (list yas-snippet-dirs))
190 (cond ((stringp e) e)
193 (stringp (symbol-value e)))
196 (error "[yas] invalid element %s in `yas-snippet-dirs'" e)))))
198 (defvaralias 'yas/root-directory 'yas-snippet-dirs)
200 (defcustom yas-new-snippet-default "\
201 # -*- mode: snippet; require-final-newline: nil -*-
203 # key: ${2:${1:$(yas--key-from-desc yas-text)}}${3:
204 # binding: ${4:direct-keybinding}}
207 "Default snippet to use when creating a new snippet.
208 If nil, don't use any snippet."
212 (defcustom yas-prompt-functions '(yas-x-prompt
214 yas-completing-prompt
217 "Functions to prompt for keys, templates, etc interactively.
219 These functions are called with the following arguments:
221 - PROMPT: A string to prompt the user
223 - CHOICES: a list of strings or objects.
225 - optional DISPLAY-FN : A function that, when applied to each of
226 the objects in CHOICES will return a string.
228 The return value of any function you put here should be one of
229 the objects in CHOICES, properly formatted with DISPLAY-FN (if
232 - To signal that your particular style of prompting is
233 unavailable at the moment, you can also have the function return
236 - To signal that the user quit the prompting process, you can
239 (signal 'quit \"user quit!\")."
240 :type '(repeat function)
243 (defcustom yas-indent-line 'auto
244 "Controls indenting applied to a recent snippet expansion.
246 The following values are possible:
248 - `fixed' Indent the snippet to the current column;
250 - `auto' Indent each line of the snippet with `indent-according-to-mode'
252 Every other value means don't apply any snippet-side indentation
253 after expansion (the manual per-line \"$>\" indentation still
255 :type '(choice (const :tag "Nothing" nothing)
256 (const :tag "Fixed" fixed)
257 (const :tag "Auto" auto))
260 (defcustom yas-also-auto-indent-first-line nil
261 "Non-nil means also auto indent first line according to mode.
263 Naturally this is only valid when `yas-indent-line' is `auto'"
267 (defcustom yas-snippet-revival t
268 "Non-nil means re-activate snippet fields after undo/redo."
272 (defcustom yas-triggers-in-field nil
273 "If non-nil, allow stacked expansions (snippets inside snippets).
275 Otherwise `yas-next-field-or-maybe-expand' just moves on to the
280 (defcustom yas-fallback-behavior 'call-other-command
281 "How to act when `yas-expand' does *not* expand a snippet.
283 - `call-other-command' means try to temporarily disable YASnippet
284 and call the next command bound to whatever key was used to
287 - nil or the symbol `return-nil' mean do nothing. (and
288 `yas-expand' returns nil)
290 - A Lisp form (apply COMMAND . ARGS) means interactively call
291 COMMAND, if ARGS is non-nil, call COMMAND non-interactively
292 with ARGS as arguments."
293 :type '(choice (const :tag "Call previous command" call-other-command)
294 (const :tag "Do nothing" return-nil))
297 (defcustom yas-choose-keys-first nil
298 "If non-nil, prompt for snippet key first, then for template.
300 Otherwise prompts for all possible snippet names.
302 This affects `yas-insert-snippet' and `yas-visit-snippet-file'."
306 (defcustom yas-choose-tables-first nil
307 "If non-nil, and multiple eligible snippet tables, prompts user for tables first.
309 Otherwise, user chooses between the merging together of all
312 This affects `yas-insert-snippet', `yas-visit-snippet-file'"
316 (defcustom yas-use-menu 'abbreviate
317 "Display a YASnippet menu in the menu bar.
319 When non-nil, submenus for each snippet table will be listed
320 under the menu \"Yasnippet\".
322 - If set to `abbreviate', only the current major-mode
323 menu and the modes set in `yas--extra-modes' are listed.
325 - If set to `full', every submenu is listed
327 - If set to `nil', hide the menu.
329 Any other non-nil value, every submenu is listed."
330 :type '(choice (const :tag "Full" full)
331 (const :tag "Abbreviate" abbreviate)
332 (const :tag "No menu" nil))
335 (defcustom yas-trigger-symbol (or (and (eq window-system 'mac)
337 (char-to-string ?\x21E5))) ;; little ->| sign
339 "The text that will be used in menu to represent the trigger."
343 (defcustom yas-wrap-around-region nil
344 "If non-nil, snippet expansion wraps around selected region.
346 The wrapping occurs just before the snippet's exit marker. This
347 can be overridden on a per-snippet basis."
351 (defcustom yas-good-grace t
352 "If non-nil, don't raise errors in inline elisp evaluation.
354 An error string \"[yas] error\" is returned instead."
358 (defcustom yas-visit-from-menu nil
359 "If non-nil visit snippets's files from menu, instead of expanding them.
361 This can only work when snippets are loaded from files."
365 (defcustom yas-expand-only-for-last-commands nil
366 "List of `last-command' values to restrict tab-triggering to, or nil.
368 Leave this set at nil (the default) to be able to trigger an
369 expansion simply by placing the cursor after a valid tab trigger,
370 using whichever commands.
372 Optionally, set this to something like '(self-insert-command) if
373 you to wish restrict expansion to only happen when the last
374 letter of the snippet tab trigger was typed immediately before
375 the trigger key itself."
376 :type '(repeat function)
379 ;; Only two faces, and one of them shouldn't even be used...
381 (defface yas-field-highlight-face
382 '((t (:inherit 'region)))
383 "The face used to highlight the currently active field of a snippet"
386 (defface yas--field-debug-face
388 "The face used for debugging some overlays normally hidden"
392 ;;; User-visible variables
394 (defvar yas-keymap (let ((map (make-sparse-keymap)))
395 (define-key map [(tab)] 'yas-next-field-or-maybe-expand)
396 (define-key map (kbd "TAB") 'yas-next-field-or-maybe-expand)
397 (define-key map [(shift tab)] 'yas-prev-field)
398 (define-key map [backtab] 'yas-prev-field)
399 (define-key map (kbd "C-g") 'yas-abort-snippet)
400 (define-key map (kbd "C-d") 'yas-skip-and-clear-or-delete-char)
402 "The active keymap while a snippet expansion is in progress.")
404 (defvar yas-key-syntaxes (list "w" "w_" "w_." "w_.()"
405 #'yas-try-key-from-whitespace)
406 "Syntaxes and functions to help look for trigger keys before point.
408 Each element in this list specifies how to skip buffer positions
409 backwards and look for the start of a trigger key.
411 Each element can be either a string or a function receiving the
412 original point as an argument. A string element is simply passed
413 to `skip-syntax-backward' whereas a function element is called
414 with no arguments and should also place point before the original
417 The string between the resulting buffer position and the original
418 point is matched against the trigger keys in the active snippet
421 If no expandable snippets are found, the next element is the list
422 is tried, unless a function element returned the symbol `again',
423 in which case it is called again from the previous position and
424 may once more reposition point.
426 For example, if `yas-key-syntaxes'' value is '(\"w\" \"w_\"),
427 trigger keys composed exclusively of \"word\"-syntax characters
428 are looked for first. Failing that, longer keys composed of
429 \"word\" or \"symbol\" syntax are looked for. Therefore,
434 will, according to the \"w\" element first try \"barbaz\". If
435 that isn't a trigger key, \"foo-barbaz\" is tried, respecting the
436 second \"w_\" element. Notice that even if \"baz\" is a trigger
437 key for an active snippet, it won't be expanded, unless a
438 function is added to `yas-key-syntaxes' that eventually places
439 point between \"bar\" and \"baz\".
441 See also Info node `(elisp) Syntax Descriptors'.")
443 (defvar yas-after-exit-snippet-hook
445 "Hooks to run after a snippet exited.
447 The hooks will be run in an environment where some variables bound to
450 `yas-snippet-beg' : The beginning of the region of the snippet.
452 `yas-snippet-end' : Similar to beg.
454 Attention: These hooks are not run when exiting nested/stacked snippet expansion!")
456 (defvar yas-before-expand-snippet-hook
458 "Hooks to run just before expanding a snippet.")
460 (defvar yas-buffer-local-condition
461 '(if (and (or (fourth (syntax-ppss))
462 (fifth (syntax-ppss)))
464 (eq this-command 'yas-expand-from-trigger-key))
465 '(require-snippet-condition . force-in-comment)
467 "Snippet expanding condition.
469 This variable is a Lisp form which is evaluated every time a
470 snippet expansion is attempted:
472 * If it evaluates to nil, no snippets can be expanded.
474 * If it evaluates to the a cons (require-snippet-condition
477 * Snippets bearing no \"# condition:\" directive are not
480 * Snippets bearing conditions that evaluate to nil (or
481 produce an error) won't be considered.
483 * If the snippet has a condition that evaluates to non-nil
486 * If REQUIREMENT is t, the snippet is considered
488 * If REQUIREMENT is `eq' RESULT, the snippet is
491 * Otherwise, the snippet is not considered.
493 * If it evaluates to the symbol 'always, all snippets are
494 considered for expansion, regardless of any conditions.
496 * If it evaluates to t or some other non-nil value
498 * Snippet bearing no conditions, or conditions that
499 evaluate to non-nil, are considered for expansion.
501 * Otherwise, the snippet is not considered.
503 Here's an example preventing snippets from being expanded from
504 inside comments, in `python-mode' only, with the exception of
505 snippets returning the symbol 'force-in-comment in their
508 (add-hook 'python-mode-hook
510 (setq yas-buffer-local-condition
511 '(if (python-in-string/comment)
512 '(require-snippet-condition . force-in-comment)
515 The default value is similar, it filters out potential snippet
516 expansions inside comments and string literals, unless the
517 snippet itself contains a condition that returns the symbol
518 `force-in-comment'.")
521 ;;; Internal variables
523 (defvar yas--version "0.8.0beta")
525 (defvar yas--menu-table (make-hash-table)
526 "A hash table of MAJOR-MODE symbols to menu keymaps.")
528 (defvar yas--known-modes
529 '(ruby-mode rst-mode markdown-mode)
530 "A list of mode which is well known but not part of Emacs.")
532 (defvar yas--escaped-characters
533 '(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
534 "List of characters which *might* need to be escaped.")
536 (defconst yas--field-regexp
537 "${\\([0-9]+:\\)?\\([^}]*\\)}"
538 "A regexp to *almost* recognize a field.")
540 (defconst yas--multi-dollar-lisp-expression-regexp
541 "$+[ \t\n]*\\(([^)]*)\\)"
542 "A regexp to *almost* recognize a \"$(...)\" expression.")
544 (defconst yas--backquote-lisp-expression-regexp
546 "A regexp to recognize a \"`lisp-expression`\" expression." )
548 (defconst yas--transform-mirror-regexp
549 "${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
550 "A regexp to *almost* recognize a mirror with a transform.")
552 (defconst yas--simple-mirror-regexp
554 "A regexp to recognize a simple mirror.")
556 (defvar yas--snippet-id-seed 0
557 "Contains the next id for a snippet.")
559 (defun yas--snippet-next-id ()
560 (let ((id yas--snippet-id-seed))
561 (incf yas--snippet-id-seed)
567 ;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
568 (defvar last-buffer-undo-list nil)
570 (defvar yas--minor-mode-menu nil
571 "Holds the YASnippet menu.")
573 (defvar yas-minor-mode-map
574 (let ((map (make-sparse-keymap)))
575 (define-key map [(tab)] 'yas-expand)
576 (define-key map (kbd "TAB") 'yas-expand)
577 (define-key map "\C-c&\C-s" 'yas-insert-snippet)
578 (define-key map "\C-c&\C-n" 'yas-new-snippet)
579 (define-key map "\C-c&\C-v" 'yas-visit-snippet-file)
581 "The keymap used when `yas-minor-mode' is active.")
583 (easy-menu-define yas--minor-mode-menu
585 "Menu used when `yas-minor-mode' is active."
586 '("YASnippet" :visible yas-use-menu
588 ["Expand trigger" yas-expand
589 :help "Possibly expand tab trigger before point"]
590 ["Insert at point..." yas-insert-snippet
591 :help "Prompt for an expandable snippet and expand it at point"]
592 ["New snippet..." yas-new-snippet
593 :help "Create a new snippet in an appropriate directory"]
594 ["Visit snippet file..." yas-visit-snippet-file
595 :help "Prompt for an expandable snippet and find its file"]
597 ("Snippet menu behaviour"
598 ["Visit snippets" (setq yas-visit-from-menu t)
599 :help "Visit snippets from the menu"
600 :active t :style radio :selected yas-visit-from-menu]
601 ["Expand snippets" (setq yas-visit-from-menu nil)
602 :help "Expand snippets from the menu"
603 :active t :style radio :selected (not yas-visit-from-menu)]
605 ["Show all known modes" (setq yas-use-menu 'full)
606 :help "Show one snippet submenu for each loaded table"
607 :active t :style radio :selected (eq yas-use-menu 'full)]
608 ["Abbreviate according to current mode" (setq yas-use-menu 'abbreviate)
609 :help "Show only snippet submenus for the current active modes"
610 :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
612 ["Auto" (setq yas-indent-line 'auto)
613 :help "Indent each line of the snippet with `indent-according-to-mode'"
614 :active t :style radio :selected (eq yas-indent-line 'auto)]
615 ["Fixed" (setq yas-indent-line 'fixed)
616 :help "Indent the snippet to the current column"
617 :active t :style radio :selected (eq yas-indent-line 'fixed)]
618 ["None" (setq yas-indent-line 'none)
619 :help "Don't apply any particular snippet indentation after expansion"
620 :active t :style radio :selected (not (member yas-indent-line '(fixed auto)))]
622 ["Also auto indent first line" (setq yas-also-auto-indent-first-line
623 (not yas-also-auto-indent-first-line))
624 :help "When auto-indenting also, auto indent the first line menu"
625 :active (eq yas-indent-line 'auto)
626 :style toggle :selected yas-also-auto-indent-first-line]
629 ["System X-widget" (setq yas-prompt-functions
631 (remove 'yas-x-prompt
632 yas-prompt-functions)))
633 :help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
634 :active t :style radio :selected (eq (car yas-prompt-functions)
636 ["Dropdown-list" (setq yas-prompt-functions
637 (cons 'yas-dropdown-prompt
638 (remove 'yas-dropdown-prompt
639 yas-prompt-functions)))
640 :help "Use a special dropdown list"
641 :active t :style radio :selected (eq (car yas-prompt-functions)
642 'yas-dropdown-prompt)]
643 ["Ido" (setq yas-prompt-functions
644 (cons 'yas-ido-prompt
645 (remove 'yas-ido-prompt
646 yas-prompt-functions)))
647 :help "Use an ido-style minibuffer prompt"
648 :active t :style radio :selected (eq (car yas-prompt-functions)
650 ["Completing read" (setq yas-prompt-functions
651 (cons 'yas-completing-prompt
652 (remove 'yas-completing-prompt
653 yas-prompt-functions)))
654 :help "Use a normal minibuffer prompt"
655 :active t :style radio :selected (eq (car yas-prompt-functions)
656 'yas-completing-prompt)]
659 ["Wrap region in exit marker"
660 (setq yas-wrap-around-region
661 (not yas-wrap-around-region))
662 :help "If non-nil automatically wrap the selected text in the $0 snippet exit"
663 :style toggle :selected yas-wrap-around-region]
664 ["Allow stacked expansions "
665 (setq yas-triggers-in-field
666 (not yas-triggers-in-field))
667 :help "If non-nil allow snippets to be triggered inside other snippet fields"
668 :style toggle :selected yas-triggers-in-field]
669 ["Revive snippets on undo "
670 (setq yas-snippet-revival
671 (not yas-snippet-revival))
672 :help "If non-nil allow snippets to become active again after undo"
673 :style toggle :selected yas-snippet-revival]
676 (not yas-good-grace))
677 :help "If non-nil don't raise errors in bad embedded elisp in snippets"
678 :style toggle :selected yas-good-grace]
681 ["Load snippets..." yas-load-directory
682 :help "Load snippets from a specific directory"]
683 ["Reload everything" yas-reload-all
684 :help "Cleanup stuff, reload snippets, rebuild menus"]
686 :help "Display some information about YASnippet"]))
688 (defvar yas--extra-modes nil
689 "An internal list of modes for which to also lookup snippets.
691 This variable probably makes more sense as buffer-local, so
692 ensure your use `make-local-variable' when you set it.")
693 (define-obsolete-variable-alias 'yas-extra-modes 'yas--extra-modes "0.8.1")
695 (defvar yas--tables (make-hash-table)
696 "A hash table of mode symbols to `yas--table' objects.")
698 (defvar yas--parents (make-hash-table)
699 "A hash table of mode symbols do lists of direct parent mode symbols.
701 This list is populated when reading the \".yas-parents\" files
702 found when traversing snippet directories with
703 `yas-load-directory'.
705 There might be additional parenting information stored in the
706 `derived-mode-parent' property of some mode symbols, but that is
709 (defvar yas--direct-keymaps (list)
710 "Keymap alist supporting direct snippet keybindings.
712 This variable is placed in `emulation-mode-map-alists'.
714 Its elements looks like (TABLE-NAME . KEYMAP). They're
715 instantiated on `yas-reload-all' but KEYMAP is added to only when
716 loading snippets. `yas--direct-TABLE-NAME' is then a variable set
717 buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
718 defined direct keybindings to the command
719 `yas-expand-from-keymap' which then which snippet to expand.")
721 (defun yas-direct-keymaps-reload ()
722 "Force reload the direct keybinding for active snippet tables."
724 (setq yas--direct-keymaps nil)
725 (maphash #'(lambda (name table)
726 (push (cons (intern (format "yas--direct-%s" name))
727 (yas--table-direct-keymap table))
728 yas--direct-keymaps))
731 (defun yas--modes-to-activate ()
732 "Compute list of mode symbols that are active for `yas-expand'
735 (setq dfs (lambda (mode &optional explored)
739 in (cl-list* (get mode 'derived-mode-parent)
740 (ignore-errors (symbol-function mode))
741 (gethash mode yas--parents))
743 (not (memq neighbour explored))
745 append (funcall dfs neighbour explored)))))
746 (remove-duplicates (append yas--extra-modes
747 (funcall dfs major-mode)))))
749 (defvar yas-minor-mode-hook nil
750 "Hook run when `yas-minor-mode' is turned on.")
753 (define-minor-mode yas-minor-mode
754 "Toggle YASnippet mode.
756 When YASnippet mode is enabled, `yas-expand', normally bound to
757 the TAB key, expands snippets of code depending on the major
760 With no argument, this command toggles the mode.
761 positive prefix argument turns on the mode.
762 Negative prefix argument turns off the mode.
765 \\{yas-minor-mode-map}"
767 ;; The indicator for the mode line.
770 (cond (yas-minor-mode
771 ;; Install the direct keymaps in `emulation-mode-map-alists'
772 ;; (we use `add-hook' even though it's not technically a hook,
773 ;; but it works). Then define variables named after modes to
774 ;; index `yas--direct-keymaps'.
776 ;; Also install the post-command-hook.
778 (add-hook 'emulation-mode-map-alists 'yas--direct-keymaps)
779 (add-hook 'post-command-hook 'yas--post-command-handler nil t)
780 ;; Set the `yas--direct-%s' vars for direct keymap expansion
782 (dolist (mode (yas--modes-to-activate))
783 (let ((name (intern (format "yas--direct-%s" mode))))
784 (set-default name nil)
785 (set (make-local-variable name) t)))
788 (yas--load-pending-jits))
790 ;; Uninstall the direct keymaps and the post-command hook
792 (remove-hook 'post-command-hook 'yas--post-command-handler t)
793 (remove-hook 'emulation-mode-map-alists 'yas--direct-keymaps))))
795 (defun yas-activate-extra-mode (mode)
796 "Activates the snippets for the given `mode' in the buffer.
798 The function can be called in the hook of a minor mode to
799 activate snippets associated with that mode."
803 (maphash (lambda (k _)
804 (setq modes (cons (list k) modes)))
806 (setq symbol (completing-read
807 "Activate mode: " modes nil t))
809 (when (not (string= "" symbol))
812 (add-to-list (make-local-variable 'yas--extra-modes) mode)
813 (yas--load-pending-jits)))
815 (defun yas-deactivate-extra-mode (mode)
816 "Deactivates the snippets for the given `mode' in the buffer."
820 "Deactivate mode: " (mapcar #'list yas--extra-modes) nil t))))
821 (set (make-local-variable 'yas--extra-modes)
825 (defvar yas-dont-activate '(minibufferp)
826 "If non-nil don't let `yas-global-mode' affect some buffers.
828 If a function of zero arguments, then its result is used.
830 If a list of functions, then all functions must return nil to
831 activate yas for this buffer.
833 In Emacsen <= 23, this variable is buffer-local. Because
834 `yas-minor-mode-on' is called by `yas-global-mode' after
835 executing the buffer's major mode hook, setting this variable
836 there is an effective way to define exceptions to the \"global\"
837 activation behaviour.
839 In Emacsen > 23, only the global value is used. To define
840 per-mode exceptions to the \"global\" activation behaviour, call
841 `yas-minor-mode' with a negative argument directily in the major
843 (unless (> emacs-major-version 23)
845 (make-variable-buffer-local 'yas-dont-activate)))
848 (defun yas-minor-mode-on ()
849 "Turn on YASnippet minor mode.
851 Honour `yas-dont-activate', which see."
853 ;; Check `yas-dont-activate'
854 (unless (cond ((functionp yas-dont-activate)
855 (funcall yas-dont-activate))
856 ((consp yas-dont-activate)
857 (some #'funcall yas-dont-activate))
862 (define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
866 (defun yas--global-mode-reload-with-jit-maybe ()
867 "Run `yas-reload-all' when `yas-global-mode' is on."
868 (when yas-global-mode (yas-reload-all)))
870 (add-hook 'yas-global-mode-hook 'yas--global-mode-reload-with-jit-maybe)
875 (defvar yas--font-lock-keywords
876 (append '(("^#.*$" . font-lock-comment-face))
877 lisp-font-lock-keywords-2
879 (0 font-lock-keyword-face)
880 (1 font-lock-string-face t))
882 (0 font-lock-keyword-face)
883 (1 font-lock-warning-face t))
884 ("${" . font-lock-keyword-face)
885 ("$[0-9]+?" . font-lock-preprocessor-face)
886 ("\\(\\$(\\)" 1 font-lock-preprocessor-face)
888 (0 font-lock-keyword-face)))))
890 (defvar snippet-mode-map
891 (let ((map (make-sparse-keymap)))
892 (easy-menu-define nil
894 "Menu used when snippet-mode is active."
896 (mapcar #'(lambda (ent)
898 (define-key map (third ent) (second ent)))
899 (vector (first ent) (second ent) t))
900 '(("Load this snippet" yas-load-snippet-buffer "\C-c\C-l")
901 ("Load and quit window" yas-load-snippet-buffer-and-close "\C-c\C-c")
902 ("Try out this snippet" yas-tryout-snippet "\C-c\C-t")))))
904 "The keymap used when `snippet-mode' is active.")
907 (define-derived-mode snippet-mode text-mode "Snippet"
908 "A mode for editing yasnippets"
909 (setq font-lock-defaults '(yas--font-lock-keywords))
910 (set (make-local-variable 'require-final-newline) nil)
911 (set (make-local-variable 'comment-start) "#")
912 (set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
916 ;;; Internal structs for template management
918 (defstruct (yas--template (:constructor yas--make-blank-template))
919 "A template for a snippet."
929 group ;; as dictated by the #group: directive or .yas-make-groups
930 perm-group ;; as dictated by `yas-define-menu'
934 (defun yas--populate-template (template &rest args)
935 "Helper function to populate TEMPLATE with properties."
938 (position (intern (substring (symbol-name (car args)) 1))
939 (mapcar #'car (get 'yas--template 'cl-struct-slots)))
941 (setq args (cddr args)))
944 (defstruct (yas--table (:constructor yas--make-snippet-table (name)))
945 "A table to store snippets for a particular mode.
947 Has the following fields:
951 A symbol name normally corresponding to a major mode, but can
952 also be a pseudo major-mode to be used in
953 `yas-activate-extra-mode', for example.
957 A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
958 a string or a vector, where the former is the snippet's trigger
959 and the latter means it's a direct keybinding. NAMEHASH is yet
960 another hash of (NAME . TEMPLATE) where NAME is the snippet's
961 name and TEMPLATE is a `yas--template' object.
963 `yas--table-direct-keymap'
965 A keymap for the snippets in this table that have direct
966 keybindings. This is kept in sync with the keyhash, i.e., all
967 the elements of the keyhash that are vectors appear here as
968 bindings to `yas-expand-from-keymap'.
970 `yas--table-uuidhash'
972 A hash table mapping snippets uuid's to the same `yas--template'
973 objects. A snippet uuid defaults to the snippet's name."
975 (hash (make-hash-table :test 'equal))
976 (uuidhash (make-hash-table :test 'equal))
978 (direct-keymap (make-sparse-keymap)))
980 (defun yas--get-template-by-uuid (mode uuid)
981 "Find the snippet template in MODE by its UUID."
982 (let* ((table (gethash mode yas--tables mode)))
984 (gethash uuid (yas--table-uuidhash table)))))
986 ;; Apropos storing/updating in TABLE, this works in two steps:
988 ;; 1. `yas--remove-template-by-uuid' removes any
989 ;; keyhash-namehash-template mappings from TABLE, grabbing the
990 ;; snippet by its uuid. Also removes mappings from TABLE's
991 ;; `yas--table-direct-keymap' (FIXME: and should probably take care
992 ;; of potentially stale menu bindings right?.)
994 ;; 2. `yas--add-template' adds this all over again.
996 ;; Create a new or add to an existing keyhash-namehash mapping.
998 ;; For reference on understanding this, consider three snippet
1001 ;; A: # name: The Foo
1003 ;; # binding: C-c M-l
1005 ;; B: # name: Mrs Foo
1008 ;; C: # name: The Bar
1009 ;; # binding: C-c M-l
1014 ;; keyhash namehashes(3) yas--template structs(4)
1015 ;; -----------------------------------------------------
1018 ;; "foo" ---> "The Foo" ---> [yas--template A] |
1019 ;; "Mrs Foo" ---> [yas--template B] |
1021 ;; [C-c M-l] ---> "The Foo" -------------------------/
1022 ;; "The Bar" ---> [yas--template C]
1024 ;; "baz" ---> "Baz" ---> [yas--template D]
1026 ;; Additionally, since uuid defaults to the name, we have a
1027 ;; `yas--table-uuidhash' for TABLE
1029 ;; uuidhash yas--template structs
1030 ;; -------------------------------
1031 ;; "The Foo" ---> [yas--template A]
1032 ;; "Mrs Foo" ---> [yas--template B]
1033 ;; "The Bar" ---> [yas--template C]
1034 ;; "Baz" ---> [yas--template D]
1036 ;; FIXME: the more I look at this data-structure the more I think I'm
1037 ;; stupid. There has to be an easier way (but beware lots of code
1038 ;; depends on this).
1040 (defun yas--remove-template-by-uuid (table uuid)
1041 "Remove from TABLE a template identified by UUID."
1042 (let ((template (gethash uuid (yas--table-uuidhash table))))
1044 (let* ((name (yas--template-name template))
1046 ;; Remove the name from each of the targeted namehashes
1048 (maphash #'(lambda (k v)
1049 (let ((template (gethash name v)))
1051 (eq uuid (yas--template-uuid template)))
1053 (when (zerop (hash-table-count v))
1054 (push k empty-keys)))))
1055 (yas--table-hash table))
1056 ;; Remove the namehash themselves if they've become empty
1058 (dolist (key empty-keys)
1060 (define-key (yas--table-direct-keymap table) key nil))
1061 (remhash key (yas--table-hash table)))
1063 ;; Finally, remove the uuid from the uuidhash
1065 (remhash uuid (yas--table-uuidhash table))))))
1067 (defun yas--add-template (table template)
1068 "Store in TABLE the snippet template TEMPLATE.
1070 KEY can be a string (trigger key) of a vector (direct
1072 (let ((name (yas--template-name template))
1073 (key (yas--template-key template))
1074 (keybinding (yas--template-keybinding template))
1075 (_menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
1076 (dolist (k (remove nil (list key keybinding)))
1080 (yas--table-hash table))
1082 (make-hash-table :test 'equal)
1083 (yas--table-hash table))))
1085 (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
1087 ;; Update TABLE's `yas--table-uuidhash'
1088 (puthash (yas--template-uuid template)
1090 (yas--table-uuidhash table))))
1092 (defun yas--update-template (table template)
1093 "Add or update TEMPLATE in TABLE.
1095 Also takes care of adding and updating to the associated menu."
1096 ;; Remove from table by uuid
1098 (yas--remove-template-by-uuid table (yas--template-uuid template))
1099 ;; Add to table again
1101 (yas--add-template table template)
1102 ;; Take care of the menu
1104 (yas--update-template-menu table template))
1106 (defun yas--update-template-menu (table template)
1107 "Update every menu-related for TEMPLATE."
1108 (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
1109 (key (yas--template-key template))
1110 (keybinding (yas--template-keybinding template)))
1111 ;; The snippet might have changed name or keys, so update
1112 ;; user-visible strings
1114 (unless (eq (cdr menu-binding-pair) :none)
1115 ;; the menu item name
1117 (setf (cadar menu-binding-pair) (yas--template-name template))
1118 ;; the :keys information (also visible to the user)
1119 (setf (getf (cdr (car menu-binding-pair)) :keys)
1120 (or (and keybinding (key-description keybinding))
1121 (and key (concat key yas-trigger-symbol))))))
1122 (unless (yas--template-menu-managed-by-yas-define-menu template)
1124 (yas--menu-keymap-get-create (yas--table-mode table)
1125 (mapcar #'yas--table-mode
1126 (yas--table-parents table))))
1127 (group (yas--template-group template)))
1128 ;; Remove from menu keymap
1130 (assert menu-keymap)
1131 (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
1133 ;; Add necessary subgroups as necessary.
1135 (dolist (subgroup group)
1136 (let ((subgroup-keymap (lookup-key menu-keymap (vector (make-symbol subgroup)))))
1137 (unless (and subgroup-keymap
1138 (keymapp subgroup-keymap))
1139 (setq subgroup-keymap (make-sparse-keymap))
1140 (define-key menu-keymap (vector (make-symbol subgroup))
1141 `(menu-item ,subgroup ,subgroup-keymap)))
1142 (setq menu-keymap subgroup-keymap)))
1144 ;; Add this entry to the keymap
1146 (define-key menu-keymap
1147 (vector (make-symbol (yas--template-uuid template)))
1148 (car (yas--template-menu-binding-pair template))))))
1150 (defun yas--namehash-templates-alist (namehash)
1151 "Return NAMEHASH as an alist."
1153 (maphash #'(lambda (k v)
1154 (push (cons k v) alist))
1158 (defun yas--fetch (table key)
1159 "Fetch templates in TABLE by KEY.
1161 Return a list of cons (NAME . TEMPLATE) where NAME is a
1162 string and TEMPLATE is a `yas--template' structure."
1163 (let* ((keyhash (yas--table-hash table))
1164 (namehash (and keyhash (gethash key keyhash))))
1166 (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
1169 ;;; Filtering/condition logic
1171 (defun yas--eval-condition (condition)
1178 (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
1182 (defun yas--filter-templates-by-condition (templates)
1183 "Filter the templates using the applicable condition.
1185 TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
1186 string and TEMPLATE is a `yas--template' structure.
1188 This function implements the rules described in
1189 `yas-buffer-local-condition'. See that variables documentation."
1190 (let ((requirement (yas--require-template-specific-condition-p)))
1191 (if (eq requirement 'always)
1193 (remove-if-not #'(lambda (pair)
1194 (yas--template-can-expand-p
1195 (yas--template-condition (cdr pair)) requirement))
1198 (defun yas--require-template-specific-condition-p ()
1199 "Decide if this buffer requests/requires snippet-specific
1200 conditions to filter out potential expansions."
1201 (if (eq 'always yas-buffer-local-condition)
1203 (let ((local-condition (or (and (consp yas-buffer-local-condition)
1204 (yas--eval-condition yas-buffer-local-condition))
1205 yas-buffer-local-condition)))
1206 (when local-condition
1207 (if (eq local-condition t)
1209 (and (consp local-condition)
1210 (eq 'require-snippet-condition (car local-condition))
1211 (symbolp (cdr local-condition))
1212 (cdr local-condition)))))))
1214 (defun yas--template-can-expand-p (condition requirement)
1215 "Evaluate CONDITION and REQUIREMENT and return a boolean."
1216 (let* ((result (or (null condition)
1217 (yas--eval-condition condition))))
1218 (cond ((eq requirement t)
1221 (eq requirement result)))))
1223 (defun yas--table-templates (table)
1226 (maphash #'(lambda (_key namehash)
1227 (maphash #'(lambda (name template)
1228 (push (cons name template) acc))
1230 (yas--table-hash table))
1231 (yas--filter-templates-by-condition acc))))
1233 (defun yas--templates-for-key-at-point ()
1234 "Find `yas--template' objects for any trigger keys preceding point.
1235 Returns (TEMPLATES START END). This function respects
1236 `yas-key-syntaxes', which see."
1238 (let ((original (point))
1239 (methods yas-key-syntaxes)
1244 (unless (eq method (car methods))
1245 ;; TRICKY: `eq'-ness test means we can only be here if
1246 ;; `method' is a function that returned `again', and hence
1247 ;; don't revert back to original position as per
1248 ;; `yas-key-syntaxes'.
1249 (goto-char original))
1250 (setq method (car methods))
1251 (cond ((stringp method)
1252 (skip-syntax-backward method)
1253 (setq methods (cdr methods)))
1255 (unless (eq (funcall method original)
1257 (setq methods (cdr methods))))
1259 (yas--warning "Warning invalid element %s in `yas-key-syntaxes'" method)))
1260 (let ((possible-key (buffer-substring-no-properties (point) original)))
1262 (goto-char original)
1264 (mapcan #'(lambda (table)
1265 (yas--fetch table possible-key))
1266 (yas--get-snippet-tables))))))
1268 (list templates (point) original)))))
1270 (defun yas--table-all-keys (table)
1271 "Get trigger keys of all active snippets in TABLE."
1273 (maphash #'(lambda (key namehash)
1274 (when (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash))
1276 (yas--table-hash table))
1279 (defun yas--table-mode (table)
1280 (intern (yas--table-name table)))
1283 ;;; Internal functions and macros:
1285 (defun yas--real-mode? (mode)
1286 "Try to find out if MODE is a real mode.
1288 The MODE bound to a function (like `c-mode') is considered real
1289 mode. Other well known mode like `ruby-mode' which is not part of
1290 Emacs might not bound to a function until it is loaded. So
1291 yasnippet keeps a list of modes like this to help the judgment."
1293 (find mode yas--known-modes)))
1295 (defun yas--handle-error (err)
1296 "Handle error depending on value of `yas-good-grace'."
1297 (let ((msg (yas--format "elisp error: %s" (error-message-string err))))
1298 (if yas-good-grace msg
1301 (defun yas--eval-lisp (form)
1302 "Evaluate FORM and convert the result to string."
1303 (let ((retval (catch 'yas--exception
1309 (let ((result (eval form)))
1311 (format "%s" result))))))
1312 (error (yas--handle-error err))))))
1313 (when (and (consp retval)
1314 (eq 'yas--exception (car retval)))
1315 (error (cdr retval)))
1318 (defun yas--eval-lisp-no-saves (form)
1321 (error (message "%s" (yas--handle-error err)))))
1323 (defun yas--read-lisp (string &optional nil-on-error)
1324 "Read STRING as a elisp expression and return it.
1326 In case STRING in an invalid expression and NIL-ON-ERROR is nil,
1327 return an expression that when evaluated will issue an error."
1330 (error (and (not nil-on-error)
1331 `(error (error-message-string ,err))))))
1333 (defun yas--read-keybinding (keybinding)
1334 "Read KEYBINDING as a snippet keybinding, return a vector."
1335 (when (and keybinding
1336 (not (string-match "keybinding" keybinding)))
1338 (let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
1340 (read-kbd-macro keybinding 'need-vector))))
1343 (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
1344 keybinding (error-message-string err))
1347 (defun yas--table-get-create (mode)
1348 "Get or create the snippet table corresponding to MODE."
1349 (let ((table (gethash mode
1352 (setq table (yas--make-snippet-table (symbol-name mode)))
1353 (puthash mode table yas--tables)
1354 (push (cons (intern (format "yas--direct-%s" mode))
1355 (yas--table-direct-keymap table))
1356 yas--direct-keymaps))
1359 (defun yas--get-snippet-tables ()
1360 "Get snippet tables for current buffer.
1362 Return a list of `yas--table' objects. The list of modes to
1363 consider is returned by `yas--modes-to-activate'"
1365 (mapcar #'(lambda (name)
1366 (gethash name yas--tables))
1367 (yas--modes-to-activate))))
1369 (defun yas--menu-keymap-get-create (mode &optional parents)
1370 "Get or create the menu keymap for MODE and its PARENTS.
1372 This may very well create a plethora of menu keymaps and arrange
1373 them all in `yas--menu-table'"
1374 (let* ((menu-keymap (or (gethash mode yas--menu-table)
1375 (puthash mode (make-sparse-keymap) yas--menu-table))))
1376 (mapc #'yas--menu-keymap-get-create parents)
1377 (define-key yas--minor-mode-menu (vector mode)
1378 `(menu-item ,(symbol-name mode) ,menu-keymap
1379 :visible (yas--show-menu-p ',mode)))
1383 (defmacro yas--called-interactively-p (&optional kind)
1384 "A backward-compatible version of `called-interactively-p'.
1386 Optional KIND is as documented at `called-interactively-p'
1387 in GNU Emacs 24.1 or higher."
1388 (if (string< emacs-version "24.1")
1389 '(called-interactively-p)
1390 `(called-interactively-p ,kind)))
1393 ;;; Template-related and snippet loading functions
1395 (defun yas--parse-template (&optional file)
1396 "Parse the template in the current buffer.
1398 Optional FILE is the absolute file name of the file being
1401 Optional GROUP is the group where the template is to go,
1402 otherwise we attempt to calculate it from FILE.
1404 Return a snippet-definition, i.e. a list
1406 (KEY TEMPLATE NAME CONDITION GROUP VARS FILE KEYBINDING UUID)
1408 If the buffer contains a line of \"# --\" then the contents above
1409 this line are ignored. Directives can set most of these with the syntax:
1411 # directive-name : directive-value
1413 Here's a list of currently recognized directives:
1424 (goto-char (point-min))
1425 (let* ((type 'snippet)
1427 (file-name-nondirectory file)))
1433 (yas--calculate-group file)))
1437 (if (re-search-forward "^# --\n" nil t)
1438 (progn (setq template
1439 (buffer-substring-no-properties (point)
1441 (setq bound (point))
1442 (goto-char (point-min))
1443 (while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*\\)$" bound t)
1444 (when (string= "uuid" (match-string-no-properties 1))
1445 (setq uuid (match-string-no-properties 2)))
1446 (when (string= "type" (match-string-no-properties 1))
1447 (setq type (if (string= "command" (match-string-no-properties 2))
1450 (when (string= "key" (match-string-no-properties 1))
1451 (setq key (match-string-no-properties 2)))
1452 (when (string= "name" (match-string-no-properties 1))
1453 (setq name (match-string-no-properties 2)))
1454 (when (string= "condition" (match-string-no-properties 1))
1455 (setq condition (yas--read-lisp (match-string-no-properties 2))))
1456 (when (string= "group" (match-string-no-properties 1))
1457 (setq group (match-string-no-properties 2)))
1458 (when (string= "expand-env" (match-string-no-properties 1))
1459 (setq expand-env (yas--read-lisp (match-string-no-properties 2)
1461 (when (string= "binding" (match-string-no-properties 1))
1462 (setq binding (match-string-no-properties 2)))))
1464 (buffer-substring-no-properties (point-min) (point-max))))
1465 (unless (or key binding)
1466 (setq key (and file (file-name-nondirectory file))))
1467 (when (eq type 'command)
1468 (setq template (yas--read-lisp (concat "(progn" template ")"))))
1470 (setq group (split-string group "\\.")))
1471 (list key template name condition group expand-env file binding uuid)))
1473 (defun yas--calculate-group (file)
1474 "Calculate the group for snippet file path FILE."
1475 (let* ((dominating-dir (locate-dominating-file file
1476 ".yas-make-groups"))
1477 (extra-path (and dominating-dir
1478 (replace-regexp-in-string (concat "^"
1479 (expand-file-name dominating-dir))
1481 (expand-file-name file))))
1482 (extra-dir (and extra-path
1483 (file-name-directory extra-path)))
1484 (group (and extra-dir
1485 (replace-regexp-in-string "/"
1487 (directory-file-name extra-dir)))))
1490 (defun yas--subdirs (directory &optional filep)
1491 "Return subdirs or files of DIRECTORY according to FILEP."
1492 (remove-if (lambda (file)
1493 (or (string-match "^\\."
1494 (file-name-nondirectory file))
1495 (string-match "^#.*#$"
1496 (file-name-nondirectory file))
1498 (file-name-nondirectory file))
1500 (file-directory-p file)
1501 (not (file-directory-p file)))))
1502 (directory-files directory t)))
1504 (defun yas--make-menu-binding (template)
1505 (let ((mode (yas--table-mode (yas--template-table template))))
1506 `(lambda () (interactive) (yas--expand-or-visit-from-menu ',mode ,(yas--template-uuid template)))))
1508 (defun yas--expand-or-visit-from-menu (mode uuid)
1509 (let* ((table (yas--table-get-create mode))
1510 (yas--current-template (and table
1511 (gethash uuid (yas--table-uuidhash table)))))
1512 (when yas--current-template
1513 (if yas-visit-from-menu
1514 (yas--visit-snippet-file-1 yas--current-template)
1515 (let ((where (if (region-active-p)
1516 (cons (region-beginning) (region-end))
1517 (cons (point) (point)))))
1518 (yas-expand-snippet (yas--template-content yas--current-template)
1521 (yas--template-expand-env yas--current-template)))))))
1523 (defun yas--key-from-desc (text)
1524 "Return a yasnippet key from a description string TEXT."
1525 (replace-regexp-in-string "\\(\\w+\\).*" "\\1" text))
1528 ;;; Popping up for keys and templates
1530 (defun yas--prompt-for-template (templates &optional prompt)
1531 "Interactively choose a template from the list TEMPLATES.
1533 TEMPLATES is a list of `yas--template'.
1535 Optional PROMPT sets the prompt to use."
1538 (sort templates #'(lambda (t1 t2)
1539 (< (length (yas--template-name t1))
1540 (length (yas--template-name t2))))))
1541 (some #'(lambda (fn)
1542 (funcall fn (or prompt "Choose a snippet: ")
1544 #'yas--template-name))
1545 yas-prompt-functions)))
1547 (defun yas--prompt-for-keys (keys &optional prompt)
1548 "Interactively choose a template key from the list KEYS.
1550 Optional PROMPT sets the prompt to use."
1552 (some #'(lambda (fn)
1553 (funcall fn (or prompt "Choose a snippet key: ") keys))
1554 yas-prompt-functions)))
1556 (defun yas--prompt-for-table (tables &optional prompt)
1557 "Interactively choose a table from the list TABLES.
1559 Optional PROMPT sets the prompt to use."
1561 (some #'(lambda (fn)
1562 (funcall fn (or prompt "Choose a snippet table: ")
1565 yas-prompt-functions)))
1567 (defun yas-x-prompt (prompt choices &optional display-fn)
1568 "Display choices in a x-window prompt."
1569 (when (and window-system choices)
1572 (if (fboundp 'posn-at-point)
1573 (let ((x-y (posn-x-y (posn-at-point (point)))))
1574 (list (list (+ (car x-y) 10)
1579 ,@(mapcar* (lambda (c d) `(,(concat " " d) . ,c))
1581 (if display-fn (mapcar display-fn choices) choices)))))
1584 (defun yas-ido-prompt (prompt choices &optional display-fn)
1585 (when (and (fboundp 'ido-completing-read)
1586 (or (>= emacs-major-version 24)
1588 (yas-completing-prompt prompt choices display-fn #'ido-completing-read)))
1590 (defun yas-dropdown-prompt (_prompt choices &optional display-fn)
1591 (when (fboundp 'dropdown-list)
1592 (let* ((formatted-choices
1593 (if display-fn (mapcar display-fn choices) choices))
1594 (n (dropdown-list formatted-choices)))
1595 (if n (nth n choices)
1598 (defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
1599 (let* ((formatted-choices
1600 (if display-fn (mapcar display-fn choices) choices))
1601 (chosen (funcall (or completion-fn #'completing-read)
1602 prompt formatted-choices
1603 nil 'require-match nil nil)))
1604 (if (eq choices formatted-choices)
1606 (nth (or (position chosen formatted-choices :test #'string=) 0)
1609 (defun yas-no-prompt (_prompt choices &optional _display-fn)
1613 ;;; Defining snippets
1614 ;; This consists of creating and registering `yas--template' objects in the
1618 (defvar yas--creating-compiled-snippets nil)
1620 (defun yas--define-snippets-1 (snippet snippet-table)
1621 "Helper for `yas-define-snippets'."
1622 ;; X) Calculate some more defaults on the values returned by
1623 ;; `yas--parse-template'.
1625 (let* ((file (seventh snippet))
1627 (name (or (third snippet)
1629 (file-name-directory file))))
1630 (condition (fourth snippet))
1631 (group (fifth snippet))
1632 (keybinding (yas--read-keybinding (eighth snippet)))
1633 (uuid (or (ninth snippet)
1635 (template (or (gethash uuid (yas--table-uuidhash snippet-table))
1636 (yas--make-blank-template))))
1637 ;; X) populate the template object
1639 (yas--populate-template template
1640 :table snippet-table
1642 :content (second snippet)
1645 :condition condition
1646 :expand-env (sixth snippet)
1647 :file (seventh snippet)
1648 :keybinding keybinding
1650 ;; X) Update this template in the appropriate table. This step
1651 ;; also will take care of adding the key indicators in the
1652 ;; templates menu entry, if any
1654 (yas--update-template snippet-table template)
1655 ;; X) Return the template
1660 (defun yas-define-snippets (mode snippets)
1661 "Define SNIPPETS for MODE.
1663 SNIPPETS is a list of snippet definitions, each taking the
1666 (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV FILE KEYBINDING UUID)
1668 Within these, only KEY and TEMPLATE are actually mandatory.
1670 TEMPLATE might be a Lisp form or a string, depending on whether
1671 this is a snippet or a snippet-command.
1673 CONDITION, EXPAND-ENV and KEYBINDING are Lisp forms, they have
1674 been `yas--read-lisp'-ed and will eventually be
1675 `yas--eval-lisp'-ed.
1677 The remaining elements are strings.
1679 FILE is probably of very little use if you're programatically
1682 UUID is the snippet's \"unique-id\". Loading a second snippet
1683 file with the same uuid would replace the previous snippet.
1685 You can use `yas--parse-template' to return such lists based on
1686 the current buffers contents."
1687 (if yas--creating-compiled-snippets
1689 (insert ";;; Snippet definitions:\n;;;\n")
1690 (let ((literal-snippets (list))
1692 (dolist (snippet snippets)
1693 (let ((key (nth 0 snippet))
1694 (template-content (nth 1 snippet))
1695 (name (nth 2 snippet))
1696 (condition (nth 3 snippet))
1697 (group (nth 4 snippet))
1698 (expand-env (nth 5 snippet))
1699 (file nil) ;; omit on purpose
1700 (binding (nth 7 snippet))
1701 (uuid (nth 8 snippet)))
1712 (insert (pp-to-string
1713 `(yas-define-snippets ',mode ',literal-snippets)))
1716 (let ((snippet-table (yas--table-get-create mode))
1718 (dolist (snippet snippets)
1719 (setq template (yas--define-snippets-1 snippet
1724 ;;; Loading snippets from files
1726 (defun yas--load-yas-setup-file (file)
1727 (if (not yas--creating-compiled-snippets)
1729 (load file 'noerror)
1730 (let ((elfile (concat file ".el")))
1731 (when (file-exists-p elfile)
1732 (insert ";;; .yas-setup.el support file if any:\n;;;\n")
1733 (insert-file-contents elfile)
1734 (goto-char (point-max))))))
1736 (defun yas--define-parents (mode parents)
1737 "Add PARENTS to the list of MODE's parents."
1738 (puthash mode (remove-duplicates
1740 (gethash mode yas--parents)))
1743 (defun yas-load-directory (top-level-dir &optional use-jit interactive)
1744 "Load snippets in directory hierarchy TOP-LEVEL-DIR.
1746 Below TOP-LEVEL-DIR each directory should be a mode name.
1748 With prefix argument USE-JIT do jit-loading of snippets."
1750 (list (read-directory-name "Select the root directory: " nil nil t)
1751 current-prefix-arg t))
1752 (unless yas-snippet-dirs
1753 (setq yas-snippet-dirs top-level-dir))
1754 (let ((impatient-buffers))
1755 (dolist (dir (yas--subdirs top-level-dir))
1756 (let* ((major-mode-and-parents (yas--compute-major-mode-and-parents
1757 (concat dir "/dummy")))
1758 (mode-sym (car major-mode-and-parents))
1759 (parents (cdr major-mode-and-parents)))
1760 ;; Attention: The parents and the menus are already defined
1761 ;; here, even if the snippets are later jit-loaded.
1763 ;; * We need to know the parents at this point since entering a
1764 ;; given mode should jit load for its parents
1765 ;; immediately. This could be reviewed, the parents could be
1766 ;; discovered just-in-time-as well
1768 ;; * We need to create the menus here to support the `full'
1769 ;; option to `yas-use-menu' (all known snippet menus are shown to the user)
1771 (yas--define-parents mode-sym parents)
1772 (yas--menu-keymap-get-create mode-sym)
1773 (let ((fun `(lambda () ;; FIXME: Simulating lexical-binding.
1774 (yas--load-directory-1 ',dir ',mode-sym))))
1776 (yas--schedule-jit mode-sym fun)
1778 ;; Look for buffers that are already in `mode-sym', and so
1779 ;; need the new snippets immediately...
1782 (cl-loop for buffer in (buffer-list)
1783 do (with-current-buffer buffer
1784 (when (eq major-mode mode-sym)
1785 (yas--message 3 "Discovered there was already %s in %s" buffer mode-sym)
1786 (push buffer impatient-buffers)))))))
1787 ;; ...after TOP-LEVEL-DIR has been completely loaded, call
1788 ;; `yas--load-pending-jits' in these impatient buffers.
1790 (cl-loop for buffer in impatient-buffers
1791 do (with-current-buffer buffer (yas--load-pending-jits))))
1793 (yas--message 3 "Loaded snippets from %s." top-level-dir)))
1795 (defun yas--load-directory-1 (directory mode-sym)
1796 "Recursively load snippet templates from DIRECTORY."
1797 (if yas--creating-compiled-snippets
1798 (let ((output-file (expand-file-name ".yas-compiled-snippets.el"
1800 (with-temp-file output-file
1801 (insert (format ";;; Compiled snippets and support files for `%s'\n"
1803 (yas--load-directory-2 directory mode-sym)
1804 (insert (format ";;; Do not edit! File generated at %s\n"
1805 (current-time-string)))))
1807 (unless (file-exists-p (concat directory "/" ".yas-skip"))
1808 (if (and (progn (yas--message 2 "Loading compiled snippets from %s" directory) t)
1809 (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3)))
1810 (yas--message 2 "Loading snippet files from %s" directory)
1811 (yas--load-directory-2 directory mode-sym)))))
1813 (defun yas--load-directory-2 (directory mode-sym)
1814 ;; Load .yas-setup.el files wherever we find them
1816 (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
1817 (let* ((default-directory directory)
1819 ;; load the snippet files
1822 (dolist (file (yas--subdirs directory 'no-subdirs-just-files))
1823 (when (file-readable-p file)
1824 (insert-file-contents file nil nil nil t)
1825 (push (yas--parse-template file)
1828 (yas-define-snippets mode-sym
1830 ;; now recurse to a lower level
1832 (dolist (subdir (yas--subdirs directory))
1833 (yas--load-directory-2 subdir
1836 (defun yas--load-snippet-dirs (&optional nojit)
1837 "Reload the directories listed in `yas-snippet-dirs' or
1838 prompt the user to select one."
1840 (if yas-snippet-dirs
1841 (dolist (directory (reverse (yas-snippet-dirs)))
1842 (cond ((file-directory-p directory)
1843 (yas-load-directory directory (not nojit))
1845 (yas--message 3 "Loaded %s" directory)
1846 (yas--message 3 "Prepared just-in-time loading for %s" directory)))
1848 (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors))))
1849 (call-interactively 'yas-load-directory))
1852 (defun yas-reload-all (&optional no-jit interactive)
1853 "Reload all snippets and rebuild the YASnippet menu.
1855 When NO-JIT is non-nil force immediate reload of all known
1856 snippets under `yas-snippet-dirs', otherwise use just-in-time
1859 When called interactively, use just-in-time loading when given a
1861 (interactive (list (not current-prefix-arg) t))
1864 (snippet-editing-buffers
1865 (remove-if-not #'(lambda (buffer)
1866 (with-current-buffer buffer yas--editing-template))
1868 ;; Warn if there are buffers visiting snippets, since reloading will break
1869 ;; any on-line editing of those buffers.
1871 (when snippet-editing-buffers
1873 (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
1874 (mapc #'kill-buffer snippet-editing-buffers)
1875 (yas--message 1 "Aborted reload...")
1877 ;; in a non-interactive use, at least set
1878 ;; `yas--editing-template' to nil, make it guess it next time around
1879 (mapc #'(lambda (buffer)
1880 (with-current-buffer buffer
1881 (kill-local-variable 'yas--editing-template)))
1884 ;; Empty all snippet tables and parenting info
1886 (setq yas--tables (make-hash-table))
1887 (setq yas--parents (make-hash-table))
1889 ;; Before killing `yas--menu-table' use its keys to cleanup the
1890 ;; mode menu parts of `yas--minor-mode-menu' (thus also cleaning
1891 ;; up `yas-minor-mode-map', which points to it)
1893 (maphash #'(lambda (menu-symbol _keymap)
1894 (define-key yas--minor-mode-menu (vector menu-symbol) nil))
1896 ;; Now empty `yas--menu-table' as well
1897 (setq yas--menu-table (make-hash-table))
1899 ;; Cancel all pending 'yas--scheduled-jit-loads'
1901 (setq yas--scheduled-jit-loads (make-hash-table))
1903 ;; Reload the directories listed in `yas-snippet-dirs' or prompt
1904 ;; the user to select one.
1906 (setq errors (yas--load-snippet-dirs no-jit))
1907 ;; Reload the direct keybindings
1909 (yas-direct-keymaps-reload)
1911 (run-hooks 'yas-after-reload-hook)
1912 (yas--message 3 "Reloaded everything%s...%s."
1913 (if no-jit "" " (snippets will load just-in-time)")
1914 (if errors " (some errors, check *Messages*)" "")))))
1916 (defvar yas-after-reload-hook nil
1917 "Hooks run after `yas-reload-all'.")
1919 (defun yas--load-pending-jits ()
1920 (dolist (mode (yas--modes-to-activate))
1921 (let ((funs (reverse (gethash mode yas--scheduled-jit-loads))))
1922 ;; must reverse to maintain coherence with `yas-snippet-dirs'
1924 (yas--message 3 "Loading for `%s', just-in-time: %s!" mode fun)
1926 (remhash mode yas--scheduled-jit-loads))))
1928 ;; (when (<= emacs-major-version 22)
1929 ;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
1931 (defun yas--quote-string (string)
1932 "Escape and quote STRING.
1933 foo\"bar\\! -> \"foo\\\"bar\\\\!\""
1935 (replace-regexp-in-string "[\\\"]"
1941 ;;; Snippet compilation function
1943 (defun yas--initialize ()
1944 "For backward compatibility, enable `yas-minor-mode' globally."
1945 (yas-global-mode 1))
1947 (defun yas-compile-directory (top-level-dir)
1948 "Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
1950 This works by stubbing a few functions, then calling
1951 `yas-load-directory'."
1952 (interactive "DTop level snippet directory?")
1953 (let ((yas--creating-compiled-snippets t))
1954 (yas-load-directory top-level-dir nil)))
1956 (defun yas-recompile-all ()
1957 "Compile every dir in `yas-snippet-dirs'."
1959 (mapc #'yas-compile-directory (yas-snippet-dirs)))
1965 (defvar yas--scheduled-jit-loads (make-hash-table)
1966 "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
1968 (defun yas--schedule-jit (mode fun)
1969 (push fun (gethash mode yas--scheduled-jit-loads)))
1973 ;;; Some user level functions
1977 (message (concat "yasnippet (version "
1979 ") -- pluskid <pluskid@gmail.com>/joaotavora <joaotavora@gmail.com>")))
1982 ;;; Apropos snippet menu:
1984 ;; The snippet menu keymaps are store by mode in hash table called
1985 ;; `yas--menu-table'. They are linked to the main menu in
1986 ;; `yas--menu-keymap-get-create' and are initially created empty,
1987 ;; reflecting the table hierarchy.
1989 ;; They can be populated in two mutually exclusive ways: (1) by
1990 ;; reading `yas--template-group', which in turn is populated by the "#
1991 ;; group:" directives of the snippets or the ".yas-make-groups" file
1992 ;; or (2) by using a separate `yas-define-menu' call, which declares a
1993 ;; menu structure based on snippets uuids.
1995 ;; Both situations are handled in `yas--update-template-menu', which
1996 ;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
1997 ;; that can tell between the two situations.
2001 ;; * if `yas-define-menu' is used it must run before
2002 ;; `yas-define-snippets' and the UUIDS must match, otherwise we get
2003 ;; duplicate entries. The `yas--template' objects are created in
2004 ;; `yas-define-menu', holding nothing but the menu entry,
2005 ;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
2006 ;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
2007 ;; part is then stored in the menu keymap itself which make the item
2008 ;; appear to the user. These limitations could probably be revised.
2010 ;; * The `yas--template-perm-group' slot is only used in
2011 ;; `yas-describe-tables'.
2013 (defun yas--template-menu-binding-pair-get-create (template &optional type)
2014 "Get TEMPLATE's menu binding or assign it a new one.
2016 TYPE may be `:stay', signaling this menu binding should be
2017 static in the menu."
2018 (or (yas--template-menu-binding-pair template)
2019 (let (;; (key (yas--template-key template))
2020 ;; (keybinding (yas--template-keybinding template))
2022 (setf (yas--template-menu-binding-pair template)
2023 (cons `(menu-item ,(or (yas--template-name template)
2024 (yas--template-uuid template))
2025 ,(yas--make-menu-binding template)
2028 (defun yas--template-menu-managed-by-yas-define-menu (template)
2029 "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
2030 (cdr (yas--template-menu-binding-pair template)))
2033 (defun yas--show-menu-p (mode)
2034 (cond ((eq yas-use-menu 'abbreviate)
2036 (mapcar #'(lambda (table)
2037 (yas--table-mode table))
2038 (yas--get-snippet-tables))))
2041 (defun yas--delete-from-keymap (keymap uuid)
2042 "Recursively delete items with UUID from KEYMAP and its submenus."
2044 ;; XXX: This used to skip any submenus named \"parent mode\"
2046 ;; First of all, recursively enter submenus, i.e. the tree is
2047 ;; searched depth first so that stale submenus can be found in the
2050 (mapc #'(lambda (item)
2051 (when (and (listp (cdr item))
2052 (keymapp (third (cdr item))))
2053 (yas--delete-from-keymap (third (cdr item)) uuid)))
2055 ;; Set the uuid entry to nil
2057 (define-key keymap (vector (make-symbol uuid)) nil)
2058 ;; Destructively modify keymap
2060 (setcdr keymap (delete-if #'(lambda (item)
2061 (or (null (cdr item))
2062 (and (keymapp (third (cdr item)))
2063 (null (cdr (third (cdr item)))))))
2066 (defun yas-define-menu (mode menu &optional omit-items)
2067 "Define a snippet menu for MODE according to MENU, omitting OMIT-ITEMS.
2069 MENU is a list, its elements can be:
2071 - (yas-item UUID) : Creates an entry the snippet identified with
2072 UUID. The menu entry for a snippet thus identified is
2073 permanent, i.e. it will never move (be reordered) in the menu.
2075 - (yas-separator) : Creates a separator
2077 - (yas-submenu NAME SUBMENU) : Creates a submenu with NAME,
2078 SUBMENU has the same form as MENU. NAME is also added to the
2079 list of groups of the snippets defined thereafter.
2081 OMIT-ITEMS is a list of snippet uuid's that will always be
2082 omitted from MODE's menu, even if they're manually loaded."
2083 (let* ((table (yas--table-get-create mode))
2084 (hash (yas--table-uuidhash table)))
2085 (yas--define-menu-1 table
2086 (yas--menu-keymap-get-create mode)
2089 (dolist (uuid omit-items)
2090 (let ((template (or (gethash uuid hash)
2091 (yas--populate-template (puthash uuid
2092 (yas--make-blank-template)
2096 (setf (yas--template-menu-binding-pair template) (cons nil :none))))))
2098 (defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
2099 "Helper for `yas-define-menu'."
2100 (dolist (e (reverse menu))
2101 (cond ((eq (first e) 'yas-item)
2102 (let ((template (or (gethash (second e) uuidhash)
2103 (yas--populate-template (puthash (second e)
2104 (yas--make-blank-template)
2107 :perm-group group-list
2108 :uuid (second e)))))
2109 (define-key menu-keymap (vector (gensym))
2110 (car (yas--template-menu-binding-pair-get-create template :stay)))))
2111 ((eq (first e) 'yas-submenu)
2112 (let ((subkeymap (make-sparse-keymap)))
2113 (define-key menu-keymap (vector (gensym))
2114 `(menu-item ,(second e) ,subkeymap))
2115 (yas--define-menu-1 table
2119 (append group-list (list (second e))))))
2120 ((eq (first e) 'yas-separator)
2121 (define-key menu-keymap (vector (gensym))
2122 '(menu-item "----")))
2124 (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
2126 (defun yas--define (mode key template &optional name condition group)
2127 "Define a snippet. Expanding KEY into TEMPLATE.
2129 NAME is a description to this template. Also update the menu if
2130 `yas-use-menu' is t. CONDITION is the condition attached to
2131 this snippet. If you attach a condition to a snippet, then it
2132 will only be expanded when the condition evaluated to non-nil."
2133 (yas-define-snippets mode
2134 (list (list key template name condition group))))
2136 (defun yas-hippie-try-expand (first-time?)
2137 "Integrate with hippie expand.
2139 Just put this function in `hippie-expand-try-functions-list'."
2140 (when yas-minor-mode
2141 (if (not first-time?)
2142 (let ((yas-fallback-behavior 'return-nil))
2148 ;;; Apropos condition-cache:
2153 (defvar yas--condition-cache-timestamp nil)
2154 (defmacro yas-define-condition-cache (func doc &rest body)
2155 "Define a function FUNC with doc DOC and body BODY.
2156 BODY is executed at most once every snippet expansion attempt, to check
2157 expansion conditions.
2159 It doesn't make any sense to call FUNC programatically."
2160 `(defun ,func () ,(if (and doc
2163 "\n\nFor use in snippets' conditions. Within each
2164 snippet-expansion routine like `yas-expand', computes actual
2165 value for the first time then always returns a cached value.")
2166 (setq body (cons doc body))
2168 (let ((timestamp-and-value (get ',func 'yas--condition-cache)))
2169 (if (equal (car timestamp-and-value) yas--condition-cache-timestamp)
2170 (cdr timestamp-and-value)
2171 (let ((new-value (progn
2174 (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
2177 (defalias 'yas-expand 'yas-expand-from-trigger-key)
2178 (defun yas-expand-from-trigger-key (&optional field)
2179 "Expand a snippet before point.
2181 If no snippet expansion is possible, fall back to the behaviour
2182 defined in `yas-fallback-behavior'.
2184 Optional argument FIELD is for non-interactive use and is an
2185 object satisfying `yas--field-p' to restrict the expansion to."
2187 (setq yas--condition-cache-timestamp (current-time))
2188 (let (templates-and-pos)
2189 (unless (and yas-expand-only-for-last-commands
2190 (not (member last-command yas-expand-only-for-last-commands)))
2191 (setq templates-and-pos (if field
2193 (narrow-to-region (yas--field-start field)
2194 (yas--field-end field))
2195 (yas--templates-for-key-at-point))
2196 (yas--templates-for-key-at-point))))
2197 (if templates-and-pos
2198 (yas--expand-or-prompt-for-template (first templates-and-pos)
2199 (second templates-and-pos)
2200 (third templates-and-pos))
2203 (defun yas-expand-from-keymap ()
2204 "Directly expand some snippets, searching `yas--direct-keymaps'.
2206 If expansion fails, execute the previous binding for this key"
2208 (setq yas--condition-cache-timestamp (current-time))
2209 (let* ((vec (subseq (this-command-keys-vector) (if current-prefix-arg
2210 (length (this-command-keys))
2212 (templates (mapcan #'(lambda (table)
2213 (yas--fetch table vec))
2214 (yas--get-snippet-tables))))
2216 (yas--expand-or-prompt-for-template templates)
2217 (let ((yas-fallback-behavior 'call-other-command))
2220 (defun yas--expand-or-prompt-for-template (templates &optional start end)
2221 "Expand one of TEMPLATES from START to END.
2223 Prompt the user if TEMPLATES has more than one element, else
2224 expand immediately. Common gateway for
2225 `yas-expand-from-trigger-key' and `yas-expand-from-keymap'."
2226 (let ((yas--current-template (or (and (rest templates) ;; more than one
2227 (yas--prompt-for-template (mapcar #'cdr templates)))
2229 (when yas--current-template
2230 (yas-expand-snippet (yas--template-content yas--current-template)
2233 (yas--template-expand-env yas--current-template)))))
2235 ;; Apropos the trigger key and the fallback binding:
2237 ;; When `yas-minor-mode-map' binds <tab>, that correctly overrides
2238 ;; org-mode's <tab>, for example and searching for fallbacks correctly
2239 ;; returns `org-cycle'. However, most other modes bind "TAB". TODO,
2240 ;; improve this explanation.
2242 (defun yas--fallback ()
2243 "Fallback after expansion has failed.
2245 Common gateway for `yas-expand-from-trigger-key' and
2246 `yas-expand-from-keymap'."
2247 (cond ((eq yas-fallback-behavior 'return-nil)
2250 ((eq yas-fallback-behavior 'call-other-command)
2251 (let* ((beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
2252 (yas--message 4 "Falling back to %s" beyond-yasnippet)
2253 (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
2254 (setq this-original-command beyond-yasnippet)
2255 (when beyond-yasnippet
2256 (call-interactively beyond-yasnippet))))
2257 ((and (listp yas-fallback-behavior)
2258 (cdr yas-fallback-behavior)
2259 (eq 'apply (car yas-fallback-behavior)))
2260 (if (cddr yas-fallback-behavior)
2261 (apply (cadr yas-fallback-behavior)
2262 (cddr yas-fallback-behavior))
2263 (when (commandp (cadr yas-fallback-behavior))
2264 (setq this-command (cadr yas-fallback-behavior))
2265 (call-interactively (cadr yas-fallback-behavior)))))
2267 ;; also return nil if all the other fallbacks have failed
2270 (defun yas--keybinding-beyond-yasnippet ()
2272 (let* ((yas-minor-mode nil)
2273 (yas--direct-keymaps nil)
2274 (keys (this-single-command-keys)))
2275 (or (key-binding keys t)
2276 (key-binding (yas--fallback-translate-input keys) t))))
2278 (defun yas--fallback-translate-input (keys)
2279 "Emulate `read-key-sequence', at least what I think it does.
2281 Keys should be an untranslated key vector. Returns a translated
2282 vector of keys. FIXME not thoroughly tested."
2285 (while (< i (length keys))
2287 (translated local-function-key-map))
2288 (while (and (< j (length keys))
2290 (keymapp translated))
2291 (setq translated (cdr (assoc (aref keys j) (remove 'keymap translated)))
2293 (setq retval (vconcat retval (cond ((symbolp translated)
2295 ((vectorp translated)
2298 (substring keys i j)))))
2303 ;;; Utils for snippet development:
2305 (defun yas--all-templates (tables)
2306 "Get `yas--template' objects in TABLES, applicable for buffer and point.
2308 Honours `yas-choose-tables-first', `yas-choose-keys-first' and
2309 `yas-buffer-local-condition'"
2310 (when yas-choose-tables-first
2311 (setq tables (list (yas--prompt-for-table tables))))
2313 (if yas-choose-keys-first
2314 (let ((key (yas--prompt-for-keys
2315 (mapcan #'yas--table-all-keys tables))))
2317 (mapcan #'(lambda (table)
2318 (yas--fetch table key))
2320 (remove-duplicates (mapcan #'yas--table-templates tables)
2323 (defun yas-insert-snippet (&optional no-condition)
2324 "Choose a snippet to expand, pop-up a list of choices according
2325 to `yas-prompt-functions'.
2327 With prefix argument NO-CONDITION, bypass filtering of snippets
2330 (setq yas--condition-cache-timestamp (current-time))
2331 (let* ((yas-buffer-local-condition (or (and no-condition
2333 yas-buffer-local-condition))
2334 (templates (yas--all-templates (yas--get-snippet-tables)))
2335 (yas--current-template (and templates
2336 (or (and (rest templates) ;; more than one template for same key
2337 (yas--prompt-for-template templates))
2339 (where (if (region-active-p)
2340 (cons (region-beginning) (region-end))
2341 (cons (point) (point)))))
2342 (if yas--current-template
2343 (yas-expand-snippet (yas--template-content yas--current-template)
2346 (yas--template-expand-env yas--current-template))
2347 (yas--message 3 "No snippets can be inserted here!"))))
2349 (defun yas-visit-snippet-file ()
2350 "Choose a snippet to edit, selection like `yas-insert-snippet'.
2352 Only success if selected snippet was loaded from a file. Put the
2353 visited file in `snippet-mode'."
2355 (let* ((yas-buffer-local-condition 'always)
2356 (templates (yas--all-templates (yas--get-snippet-tables)))
2357 (yas-prompt-functions '(yas-ido-prompt yas-completing-prompt))
2358 (template (and templates
2359 (or (yas--prompt-for-template templates
2360 "Choose a snippet template to edit: ")
2364 (yas--visit-snippet-file-1 template)
2365 (message "No snippets tables active!"))))
2367 (defun yas--visit-snippet-file-1 (template)
2368 "Helper for `yas-visit-snippet-file'."
2369 (let ((file (yas--template-file template)))
2370 (cond ((and file (file-readable-p file))
2371 (find-file-other-window file)
2373 (set (make-local-variable 'yas--editing-template) template))
2375 (message "Original file %s no longer exists!" file))
2377 (switch-to-buffer (format "*%s*"(yas--template-name template)))
2378 (let ((type 'snippet))
2379 (when (listp (yas--template-content template))
2380 (insert (format "# type: command\n"))
2381 (setq type 'command))
2382 (insert (format "# key: %s\n" (yas--template-key template)))
2383 (insert (format "# name: %s\n" (yas--template-name template)))
2384 (when (yas--template-keybinding template)
2385 (insert (format "# binding: %s\n" (yas--template-keybinding template))))
2386 (when (yas--template-expand-env template)
2387 (insert (format "# expand-env: %s\n" (yas--template-expand-env template))))
2388 (when (yas--template-condition template)
2389 (insert (format "# condition: %s\n" (yas--template-condition template))))
2391 (insert (if (eq type 'command)
2392 (pp-to-string (yas--template-content template))
2393 (yas--template-content template))))
2395 (set (make-local-variable 'yas--editing-template) template)))))
2397 (defun yas--guess-snippet-directories-1 (table)
2398 "Guess possible snippet subdirectories for TABLE."
2399 (cons (yas--table-name table)
2400 (mapcan #'(lambda (parent)
2401 (yas--guess-snippet-directories-1
2403 (yas--table-parents table))))
2405 (defun yas--guess-snippet-directories (&optional table)
2406 "Try to guess suitable directories based on the current active
2407 tables (or optional TABLE).
2409 Returns a list of elements (TABLE . DIRS) where TABLE is a
2410 `yas--table' object and DIRS is a list of all possible directories
2411 where snippets of table might exist."
2412 (let ((main-dir (replace-regexp-in-string
2414 (or (first (or (yas-snippet-dirs)
2415 (setq yas-snippet-dirs '("~/.emacs.d/snippets")))))))
2416 (tables (or (and table
2418 (yas--get-snippet-tables))))
2419 ;; HACK! the snippet table created here is actually registered!
2421 (unless (or table (gethash major-mode yas--tables))
2422 (push (yas--table-get-create major-mode)
2425 (mapcar #'(lambda (table)
2427 (mapcar #'(lambda (subdir)
2428 (concat main-dir "/" subdir))
2429 (yas--guess-snippet-directories-1 table))))
2432 (defun yas--make-directory-maybe (table-and-dirs &optional main-table-string)
2433 "Return a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
2434 (or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
2435 (let ((candidate (first (cdr table-and-dirs))))
2436 (unless (file-writable-p (file-name-directory candidate))
2437 (error (yas--format "%s is not writable." candidate)))
2438 (if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
2440 (if (gethash (yas--table-mode (car table-and-dirs))
2444 (or main-table-string
2446 (yas--table-name (car table-and-dirs))))
2448 (make-directory candidate 'also-make-parents)
2449 ;; create the .yas-parents file here...
2452 (defun yas-new-snippet (&optional no-template)
2453 "Pops a new buffer for writing a snippet.
2455 Expands a snippet-writing snippet, unless the optional prefix arg
2456 NO-TEMPLATE is non-nil."
2458 (let ((guessed-directories (yas--guess-snippet-directories)))
2460 (switch-to-buffer "*new snippet*")
2462 (kill-all-local-variables)
2465 (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
2466 (yas--table-mode (car d)))
2467 guessed-directories))
2468 (if (and (not no-template) yas-new-snippet-default)
2469 (yas-expand-snippet yas-new-snippet-default))))
2471 (defun yas--compute-major-mode-and-parents (file)
2472 "Given FILE, find the nearest snippet directory for a given mode.
2474 Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
2475 representing one or more of the mode's parents.
2477 Note that MODE-SYM need not be the symbol of a real major mode,
2478 neither do the elements of PARENTS."
2479 (let* ((file-dir (and file
2480 (directory-file-name (or (some #'(lambda (special)
2481 (locate-dominating-file file special))
2485 (directory-file-name (file-name-directory file))))))
2486 (parents-file-name (concat file-dir "/.yas-parents"))
2487 (major-mode-name (and file-dir
2488 (file-name-nondirectory file-dir)))
2489 (major-mode-sym (or (and major-mode-name
2490 (intern major-mode-name))))
2491 (parents (when (file-readable-p parents-file-name)
2495 (insert-file-contents parents-file-name)
2496 (buffer-substring-no-properties (point-min)
2498 (when major-mode-sym
2499 (cons major-mode-sym (remove major-mode-sym parents)))))
2501 (defvar yas--editing-template nil
2502 "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
2504 (defvar yas--current-template nil
2505 "Holds the current template being expanded into a snippet.")
2507 (defvar yas--guessed-modes nil
2508 "List of guessed modes supporting `yas-load-snippet-buffer'.")
2510 (defun yas--read-table ()
2511 "Ask user for a snippet table, help with some guessing."
2512 (let ((prompt (if (and (featurep 'ido)
2514 'ido-completing-read 'completing-read)))
2515 (unless yas--guessed-modes
2516 (set (make-local-variable 'yas--guessed-modes)
2517 (or (yas--compute-major-mode-and-parents buffer-file-name))))
2519 (funcall prompt (format "Choose or enter a table (yas guesses %s): "
2520 (if yas--guessed-modes
2521 (first yas--guessed-modes)
2523 (mapcar #'symbol-name yas--guessed-modes)
2528 (if (first yas--guessed-modes)
2529 (symbol-name (first yas--guessed-modes)))))))
2531 (defun yas-load-snippet-buffer (table &optional interactive)
2532 "Parse and load current buffer's snippet definition into TABLE.
2534 TABLE is a symbol naming a passed to `yas--table-get-create'.
2536 When called interactively, prompt for the table name."
2537 (interactive (list (yas--read-table) t))
2539 ;; We have `yas--editing-template', this buffer's content comes from a
2540 ;; template which is already loaded and neatly positioned,...
2542 (yas--editing-template
2543 (yas--define-snippets-1 (yas--parse-template (yas--template-file yas--editing-template))
2544 (yas--template-table yas--editing-template)))
2545 ;; Try to use `yas--guessed-modes'. If we don't have that use the
2546 ;; value from `yas--compute-major-mode-and-parents'
2549 (unless yas--guessed-modes
2550 (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
2551 (let* ((table (yas--table-get-create table)))
2552 (set (make-local-variable 'yas--editing-template)
2553 (yas--define-snippets-1 (yas--parse-template buffer-file-name)
2556 (yas--message 3 "Snippet \"%s\" loaded for %s."
2557 (yas--template-name yas--editing-template)
2558 (yas--table-name (yas--template-table yas--editing-template)))))
2560 (defun yas-load-snippet-buffer-and-close (table &optional kill)
2561 "Load the snippet with `yas-load-snippet-buffer', possibly
2562 save, then `quit-window' if saved.
2564 If the snippet is new, ask the user whether (and where) to save
2565 it. If the snippet already has a file, just save it.
2567 The prefix argument KILL is passed to `quit-window'.
2569 Don't use this from a Lisp program, call `yas-load-snippet-buffer'
2570 and `kill-buffer' instead."
2571 (interactive (list (yas--read-table) current-prefix-arg))
2572 (yas-load-snippet-buffer table t)
2574 ;; Only offer to save this if it looks like a library or new
2575 ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
2576 ;; which is not the first, or from an unwritable file)
2578 (not (yas--template-file yas--editing-template))
2579 (not (file-writable-p (yas--template-file yas--editing-template)))
2580 (and (listp yas-snippet-dirs)
2581 (second yas-snippet-dirs)
2582 (not (string-match (expand-file-name (first yas-snippet-dirs))
2583 (yas--template-file yas--editing-template)))))
2584 (y-or-n-p (yas--format "Looks like a library or new snippet. Save to new file? ")))
2585 (let* ((option (first (yas--guess-snippet-directories (yas--template-table yas--editing-template))))
2587 (yas--make-directory-maybe option))))
2589 (let ((default-file-name (or (and (yas--template-file yas--editing-template)
2590 (file-name-nondirectory (yas--template-file yas--editing-template)))
2591 (yas--template-name yas--editing-template))))
2592 (write-file (concat chosen "/"
2593 (read-from-minibuffer (format "File name to create in %s? " chosen)
2594 default-file-name)))
2595 (setf (yas--template-file yas--editing-template) buffer-file-name)))))
2596 (when buffer-file-name
2598 (quit-window kill)))
2600 (defun yas-tryout-snippet (&optional debug)
2601 "Test current buffer's snippet template in other buffer."
2603 (let* ((major-mode-and-parent (yas--compute-major-mode-and-parents buffer-file-name))
2604 (parsed (yas--parse-template))
2605 (test-mode (or (and (car major-mode-and-parent)
2606 (fboundp (car major-mode-and-parent))
2607 (car major-mode-and-parent))
2608 (first yas--guessed-modes)
2609 (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
2610 (yas--current-template
2613 (yas--populate-template (yas--make-blank-template)
2614 :table nil ;; no tables for ephemeral snippets
2616 :content (second parsed)
2617 :name (third parsed)
2618 :expand-env (sixth parsed)))))
2619 (cond (yas--current-template
2620 (let ((buffer-name (format "*testing snippet: %s*" (yas--template-name yas--current-template))))
2621 (kill-buffer (get-buffer-create buffer-name))
2622 (switch-to-buffer (get-buffer-create buffer-name))
2623 (setq buffer-undo-list nil)
2624 (condition-case nil (funcall test-mode) (error nil))
2626 (setq buffer-read-only nil)
2627 (yas-expand-snippet (yas--template-content yas--current-template)
2630 (yas--template-expand-env yas--current-template))
2632 (require 'yasnippet-debug nil t))
2633 (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
2635 (yas--message 3 "Cannot test snippet for unknown major mode")))))
2637 (defun yas-active-keys ()
2638 "Return all active trigger keys for current buffer and point."
2640 (remove-if-not #'stringp (mapcan #'yas--table-all-keys (yas--get-snippet-tables)))
2643 (defun yas--template-fine-group (template)
2644 (car (last (or (yas--template-group template)
2645 (yas--template-perm-group template)))))
2647 (defun yas-describe-tables (&optional choose)
2648 "Display snippets for each table."
2650 (let* ((by-name-hash (and choose
2651 (y-or-n-p "Show by namehash? ")))
2652 (buffer (get-buffer-create "*YASnippet tables*"))
2653 (active-tables (yas--get-snippet-tables))
2654 (remain-tables (let ((all))
2655 (maphash #'(lambda (_k v)
2656 (unless (find v active-tables)
2660 (table-lists (list active-tables remain-tables))
2661 (original-buffer (current-buffer))
2663 (yas--condition-cache-timestamp (current-time)))
2664 (with-current-buffer buffer
2665 (setq buffer-read-only nil)
2667 (cond ((not by-name-hash)
2668 (insert "YASnippet tables: \n")
2669 (while (and table-lists
2671 (dolist (table (car table-lists))
2672 (yas--describe-pretty-table table original-buffer))
2673 (setq table-lists (cdr table-lists))
2675 (yas--create-snippet-xrefs)
2676 (display-buffer buffer)
2677 (setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
2678 (yas--create-snippet-xrefs)
2682 (insert "\n\nYASnippet tables by NAMEHASH: \n")
2683 (dolist (table (append active-tables remain-tables))
2684 (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
2686 (maphash #'(lambda (k _v)
2688 (yas--table-hash table))
2690 (insert (format " key %s maps snippets: %s\n" key
2692 (maphash #'(lambda (k _v)
2694 (gethash key (yas--table-hash table)))
2697 (setq buffer-read-only t))
2698 (display-buffer buffer)))
2700 (defun yas--describe-pretty-table (table &optional original-buffer)
2701 (insert (format "\nSnippet table `%s'"
2702 (yas--table-name table)))
2703 (if (yas--table-parents table)
2704 (insert (format " parents: %s\n"
2705 (mapcar #'yas--table-name
2706 (yas--table-parents table))))
2708 (insert (make-string 100 ?-) "\n")
2709 (insert "group state name key binding\n")
2710 (let ((groups-hash (make-hash-table :test #'equal)))
2711 (maphash #'(lambda (_k v)
2712 (let ((group (or (yas--template-fine-group v)
2714 (when (yas--template-name v)
2716 (cons v (gethash group groups-hash))
2718 (yas--table-uuidhash table))
2720 #'(lambda (group templates)
2721 (setq group (truncate-string-to-width group 25 0 ? "..."))
2722 (insert (make-string 100 ?-) "\n")
2723 (dolist (p templates)
2724 (let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas--template-name p))
2728 (setq group (make-string (length group) ? ))))
2729 (condition-string (let ((condition (yas--template-condition p)))
2732 (with-current-buffer original-buffer
2733 (if (yas--eval-condition condition)
2738 (insert condition-string " ")
2740 (if (string-match "\\.\\.\\.$" name)
2744 (insert (truncate-string-to-width (or (yas--template-key p) "")
2746 (insert (truncate-string-to-width (key-description (yas--template-keybinding p))
2753 ;;; User convenience functions, for using in `yas-key-syntaxes'
2755 (defun yas-try-key-from-whitespace (_start-point)
2756 "As `yas-key-syntaxes' element, look for whitespace delimited key.
2758 A newline will be considered whitespace even if the mode syntax
2759 marks it as something else (typically comment ender)."
2760 (skip-chars-backward "^[:space:]\n"))
2762 (defun yas-shortest-key-until-whitespace (_start-point)
2763 "Like `yas-longest-key-from-whitespace' but take the shortest key."
2764 (when (/= (skip-chars-backward "^[:space:]\n" (1- (point))) 0)
2767 (defun yas-longest-key-from-whitespace (start-point)
2768 "As `yas-key-syntaxes' element, look for longest key between point and whitespace.
2770 A newline will be considered whitespace even if the mode syntax
2771 marks it as something else (typically comment ender)."
2772 (if (= (point) start-point)
2773 (yas-try-key-from-whitespace start-point)
2775 (unless (<= start-point (1+ (point)))
2780 ;;; User convenience functions, for using in snippet definitions
2782 (defvar yas-modified-p nil
2783 "Non-nil if field has been modified by user or transformation.")
2785 (defvar yas-moving-away-p nil
2786 "Non-nil if user is about to exit field.")
2788 (defvar yas-text nil
2789 "Contains current field text.")
2791 (defun yas-substr (str pattern &optional subexp)
2792 "Search PATTERN in STR and return SUBEXPth match.
2794 If found, the content of subexp group SUBEXP (default 0) is
2795 returned, or else the original STR will be returned."
2796 (let ((grp (or subexp 0)))
2798 (if (string-match pattern str)
2799 (match-string-no-properties grp str)
2802 (defun yas-choose-value (&rest possibilities)
2803 "Prompt for a string in POSSIBILITIES and return it.
2805 The last element of POSSIBILITIES may be a list of strings."
2806 (unless (or yas-moving-away-p
2808 (let* ((last-link (last possibilities))
2809 (last-elem (car last-link)))
2810 (when (listp last-elem)
2811 (setcar last-link (car last-elem))
2812 (setcdr last-link (cdr last-elem))))
2813 (some #'(lambda (fn)
2814 (funcall fn "Choose: " possibilities))
2815 yas-prompt-functions)))
2817 (defun yas-key-to-value (alist)
2818 (unless (or yas-moving-away-p
2820 (let ((key (read-key-sequence "")))
2822 (or (cdr (find key alist :key #'car :test #'string=))
2825 (defun yas-throw (text)
2826 "Throw a yas--exception with TEXT as the reason."
2827 (throw 'yas--exception (cons 'yas--exception text)))
2829 (defun yas-verify-value (possibilities)
2830 "Verify that the current field value is in POSSIBILITIES.
2832 Otherwise throw exception."
2833 (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
2834 (yas-throw (yas--format "Field only allows %s" possibilities))))
2836 (defun yas-field-value (number)
2837 "Get the string for field with NUMBER.
2839 Use this in primary and mirror transformations to tget."
2840 (let* ((snippet (car (yas--snippets-at-point)))
2842 (yas--snippet-find-field snippet number))))
2844 (yas--field-text-for-display field))))
2847 "Return `yas-text' if that exists and is non-empty, else nil."
2849 (not (string= "" yas-text)))
2852 (defun yas-selected-text ()
2853 "Return `yas-selected-text' if that exists and is non-empty, else nil."
2854 (if (and yas-selected-text
2855 (not (string= "" yas-selected-text)))
2858 (defun yas--get-field-once (number &optional transform-fn)
2859 (unless yas-modified-p
2861 (funcall transform-fn (yas-field-value number))
2862 (yas-field-value number))))
2864 (defun yas-default-from-field (number)
2865 (unless yas-modified-p
2866 (yas-field-value number)))
2868 (defun yas-inside-string ()
2869 "Return non-nil if the point is inside a string according to font-lock."
2870 (equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
2872 (defun yas-unimplemented (&optional missing-feature)
2873 (if yas--current-template
2874 (if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
2877 (yas--visit-snippet-file-1 yas--current-template))
2878 (message "No implementation. Missing %s" (or missing-feature "something"))))
2881 ;;; Snippet expansion and field management
2883 (defvar yas--active-field-overlay nil
2884 "Overlays the currently active field.")
2886 (defvar yas--field-protection-overlays nil
2887 "Two overlays protect the current active field.")
2889 (defvar yas-selected-text nil
2890 "The selected region deleted on the last snippet expansion.")
2892 (defvar yas--start-column nil
2893 "The column where the snippet expansion started.")
2895 (make-variable-buffer-local 'yas--active-field-overlay)
2896 (make-variable-buffer-local 'yas--field-protection-overlays)
2897 (put 'yas--active-field-overlay 'permanent-local t)
2898 (put 'yas--field-protection-overlays 'permanent-local t)
2900 (defstruct (yas--snippet (:constructor yas--make-snippet ()))
2906 (id (yas--snippet-next-id) :read-only t)
2907 (control-overlay nil)
2909 ;; stacked expansion: the `previous-active-field' slot saves the
2910 ;; active field where the child expansion took place
2911 previous-active-field
2914 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
2917 NUMBER is the field number.
2918 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2919 PARENT-FIELD is a `yas--field' this field is nested under, or nil.
2920 MIRRORS is a list of `yas--mirror's
2921 TRANSFORM is a lisp form.
2922 MODIFIED-P is a boolean set to true once user inputs text.
2923 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'.
2934 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
2937 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2938 TRANSFORM is a lisp form.
2939 PARENT-FIELD is a `yas--field' this mirror is nested under, or nil.
2940 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'
2941 DEPTH is a count of how many nested mirrors can affect this mirror"
2948 (defstruct (yas--exit (:constructor yas--make-exit (marker)))
2952 (defun yas--apply-transform (field-or-mirror field &optional empty-on-nil-p)
2953 "Calculate transformed string for FIELD-OR-MIRROR from FIELD.
2955 If there is no transform for ht field, return nil.
2957 If there is a transform but it returns nil, return the empty
2958 string iff EMPTY-ON-NIL-P is true."
2959 (let* ((yas-text (yas--field-text-for-display field))
2960 (yas-modified-p (yas--field-modified-p field))
2961 (yas-moving-away-p nil)
2962 (transform (if (yas--mirror-p field-or-mirror)
2963 (yas--mirror-transform field-or-mirror)
2964 (yas--field-transform field-or-mirror)))
2965 (start-point (if (yas--mirror-p field-or-mirror)
2966 (yas--mirror-start field-or-mirror)
2967 (yas--field-start field-or-mirror)))
2968 (transformed (and transform
2970 (goto-char start-point)
2971 (let ((ret (yas--eval-lisp transform)))
2972 (or ret (and empty-on-nil-p "")))))))
2975 (defsubst yas--replace-all (from to &optional text)
2976 "Replace all occurrences from FROM to TO.
2978 With optional string TEXT do it in that string."
2980 (replace-regexp-in-string (regexp-quote from) to text t t)
2981 (goto-char (point-min))
2982 (while (search-forward from nil t)
2983 (replace-match to t t text))))
2985 (defun yas--snippet-find-field (snippet number)
2986 (find-if #'(lambda (field)
2987 (eq number (yas--field-number field)))
2988 (yas--snippet-fields snippet)))
2990 (defun yas--snippet-sort-fields (snippet)
2991 "Sort the fields of SNIPPET in navigation order."
2992 (setf (yas--snippet-fields snippet)
2993 (sort (yas--snippet-fields snippet)
2994 #'yas--snippet-field-compare)))
2996 (defun yas--snippet-field-compare (field1 field2)
2997 "Compare FIELD1 and FIELD2.
2999 The field with a number is sorted first. If they both have a
3000 number, compare through the number. If neither have, compare
3001 through the field's start point"
3002 (let ((n1 (yas--field-number field1))
3003 (n2 (yas--field-number field2)))
3006 (or (zerop n2) (and (not (zerop n1))
3011 (< (yas--field-start field1)
3012 (yas--field-start field2))))))
3014 (defun yas--field-probably-deleted-p (snippet field)
3015 "Guess if SNIPPET's FIELD should be skipped."
3017 ;; field must be zero length
3019 (zerop (- (yas--field-start field) (yas--field-end field)))
3022 ;; 1) is a nested field and it's been modified
3024 (and (yas--field-parent-field field)
3025 (yas--field-modified-p field))
3026 ;; 2) ends just before the snippet end
3028 (and (eq field (car (last (yas--snippet-fields snippet))))
3029 (= (yas--field-start field) (overlay-end (yas--snippet-control-overlay snippet)))))
3030 ;; the field numbered 0, just before the exit marker, should
3033 (not (zerop (yas--field-number field)))))
3035 (defun yas--snippets-at-point (&optional all-snippets)
3036 "Return a sorted list of snippets at point.
3038 The most recently-inserted snippets are returned first."
3040 (remove nil (remove-duplicates (mapcar #'(lambda (ov)
3041 (overlay-get ov 'yas--snippet))
3043 (overlays-in (point-min) (point-max))
3044 (nconc (overlays-at (point)) (overlays-at (1- (point))))))))
3046 (<= (yas--snippet-id s2) (yas--snippet-id s1)))))
3048 (defun yas-next-field-or-maybe-expand ()
3049 "Try to expand a snippet at a key before point.
3051 Otherwise delegate to `yas-next-field'."
3053 (if yas-triggers-in-field
3054 (let ((yas-fallback-behavior 'return-nil)
3055 (active-field (overlay-get yas--active-field-overlay 'yas--field)))
3057 (unless (yas-expand-from-trigger-key active-field)
3061 (defun yas-next-field (&optional arg)
3062 "Navigate to the ARGth next field.
3064 If there's none, exit the snippet."
3068 (snippet (first (yas--snippets-at-point)))
3069 (active-field (overlay-get yas--active-field-overlay 'yas--field))
3070 (live-fields (remove-if #'(lambda (field)
3071 (and (not (eq field active-field))
3072 (yas--field-probably-deleted-p snippet field)))
3073 (yas--snippet-fields snippet)))
3074 (active-field-pos (position active-field live-fields))
3075 (target-pos (and active-field-pos (+ arg active-field-pos)))
3076 (target-field (and target-pos (nth target-pos live-fields))))
3077 ;; First check if we're moving out of a field with a transform
3079 (when (and active-field
3080 (yas--field-transform active-field))
3081 (let* ((yas-moving-away-p t)
3082 (yas-text (yas--field-text-for-display active-field))
3083 (yas-modified-p (yas--field-modified-p active-field)))
3084 ;; primary field transform: exit call to field-transform
3085 (yas--eval-lisp (yas--field-transform active-field))))
3086 ;; Now actually move...
3087 (cond ((and target-pos (>= target-pos (length live-fields)))
3088 (yas-exit-snippet snippet))
3090 (yas--move-to-field snippet target-field))
3094 (defun yas--place-overlays (snippet field)
3095 "Correctly place overlays for SNIPPET's FIELD."
3096 (yas--make-move-field-protection-overlays snippet field)
3097 (yas--make-move-active-field-overlay snippet field))
3099 (defun yas--move-to-field (snippet field)
3100 "Update SNIPPET to move to field FIELD.
3102 Also create some protection overlays"
3103 (goto-char (yas--field-start field))
3104 (yas--place-overlays snippet field)
3105 (overlay-put yas--active-field-overlay 'yas--field field)
3106 (let ((number (yas--field-number field)))
3107 ;; check for the special ${0: ...} field
3108 (if (and number (zerop number))
3110 (set-mark (yas--field-end field))
3111 (setf (yas--snippet-force-exit snippet)
3112 (or (yas--field-transform field)
3114 ;; make this field active
3115 (setf (yas--snippet-active-field snippet) field)
3116 ;; primary field transform: first call to snippet transform
3117 (unless (yas--field-modified-p field)
3118 (if (yas--field-update-display field)
3119 (yas--update-mirrors snippet)
3120 (setf (yas--field-modified-p field) nil))))))
3122 (defun yas-prev-field ()
3123 "Navigate to prev field. If there's none, exit the snippet."
3125 (yas-next-field -1))
3127 (defun yas-abort-snippet (&optional snippet)
3129 (let ((snippet (or snippet
3130 (car (yas--snippets-at-point)))))
3132 (setf (yas--snippet-force-exit snippet) t))))
3134 (defun yas-exit-snippet (snippet)
3135 "Goto exit-marker of SNIPPET."
3136 (interactive (list (first (yas--snippets-at-point))))
3138 (setf (yas--snippet-force-exit snippet) t)
3139 (goto-char (if (yas--snippet-exit snippet)
3140 (yas--exit-marker (yas--snippet-exit snippet))
3141 (overlay-end (yas--snippet-control-overlay snippet))))))
3143 (defun yas-exit-all-snippets ()
3144 "Exit all snippets."
3146 (mapc #'(lambda (snippet)
3147 (yas-exit-snippet snippet)
3148 (yas--check-commit-snippet))
3149 (yas--snippets-at-point 'all-snippets)))
3152 ;;; Some low level snippet-routines:
3154 (defvar yas--inhibit-overlay-hooks nil
3155 "Bind this temporarily to non-nil to prevent running `yas--on-*-modification'.")
3157 (defmacro yas--inhibit-overlay-hooks (&rest body)
3158 "Run BODY with `yas--inhibit-overlay-hooks' set to t."
3159 (declare (indent 0))
3160 `(let ((yas--inhibit-overlay-hooks t))
3163 (defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
3164 (defvar yas-snippet-end nil "End position of the last snippet committed.")
3166 (defun yas--commit-snippet (snippet)
3167 "Commit SNIPPET, but leave point as it is.
3169 This renders the snippet as ordinary text."
3171 (let ((control-overlay (yas--snippet-control-overlay snippet)))
3173 ;; Save the end of the moribund snippet in case we need to revive it
3174 ;; its original expansion.
3176 (when (and control-overlay
3177 (overlay-buffer control-overlay))
3178 (setq yas-snippet-beg (overlay-start control-overlay))
3179 (setq yas-snippet-end (overlay-end control-overlay))
3180 (delete-overlay control-overlay))
3182 (yas--inhibit-overlay-hooks
3183 (when yas--active-field-overlay
3184 (delete-overlay yas--active-field-overlay))
3185 (when yas--field-protection-overlays
3186 (mapc #'delete-overlay yas--field-protection-overlays)))
3188 ;; stacked expansion: if the original expansion took place from a
3189 ;; field, make sure we advance it here at least to
3190 ;; `yas-snippet-end'...
3192 (let ((previous-field (yas--snippet-previous-active-field snippet)))
3193 (when (and yas-snippet-end previous-field)
3194 (yas--advance-end-maybe previous-field yas-snippet-end)))
3196 ;; Convert all markers to points,
3198 (yas--markers-to-points snippet)
3200 ;; Take care of snippet revival
3202 (if yas-snippet-revival
3203 (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
3205 ;; Dismember the snippet... this is useful if we get called
3206 ;; again from `yas--take-care-of-redo'....
3207 (setf (yas--snippet-fields snippet) nil)))
3209 (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
3211 (defun yas--safely-run-hooks (hook-var)
3212 (condition-case error
3213 (run-hooks hook-var)
3215 (yas--message 3 "%s error: %s" hook-var (error-message-string error)))))
3218 (defun yas--check-commit-snippet ()
3219 "Check if point exited the currently active field of the snippet.
3221 If so cleans up the whole snippet up."
3222 (let* ((snippets (yas--snippets-at-point 'all-snippets))
3223 (snippets-left snippets)
3224 (snippet-exit-transform))
3225 (dolist (snippet snippets)
3226 (let ((active-field (yas--snippet-active-field snippet)))
3227 (setq snippet-exit-transform (yas--snippet-force-exit snippet))
3228 (cond ((or snippet-exit-transform
3229 (not (and active-field (yas--field-contains-point-p active-field))))
3230 (setq snippets-left (delete snippet snippets-left))
3231 (setf (yas--snippet-force-exit snippet) nil)
3232 (yas--commit-snippet snippet))
3234 (or (not yas--active-field-overlay)
3235 (not (overlay-buffer yas--active-field-overlay))))
3237 ;; stacked expansion: this case is mainly for recent
3238 ;; snippet exits that place us back int the field of
3242 (yas--move-to-field snippet active-field)
3243 (yas--update-mirrors snippet)))
3246 (unless (or (null snippets) snippets-left)
3247 (if snippet-exit-transform
3248 (yas--eval-lisp-no-saves snippet-exit-transform))
3249 (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
3251 ;; Apropos markers-to-points:
3253 ;; This was found useful for performance reasons, so that an
3254 ;; excessive number of live markers aren't kept around in the
3255 ;; `buffer-undo-list'. However, in `markers-to-points', the
3256 ;; set-to-nil markers can't simply be discarded and replaced with
3257 ;; fresh ones in `points-to-markers'. The original marker that was
3258 ;; just set to nil has to be reused.
3260 ;; This shouldn't bring horrible problems with undo/redo, but it
3263 (defun yas--markers-to-points (snippet)
3264 "Convert all markers in SNIPPET to a cons (POINT . MARKER)
3265 where POINT is the original position of the marker and MARKER is
3266 the original marker object with the position set to nil."
3267 (dolist (field (yas--snippet-fields snippet))
3268 (let ((start (marker-position (yas--field-start field)))
3269 (end (marker-position (yas--field-end field))))
3270 (set-marker (yas--field-start field) nil)
3271 (set-marker (yas--field-end field) nil)
3272 (setf (yas--field-start field) (cons start (yas--field-start field)))
3273 (setf (yas--field-end field) (cons end (yas--field-end field))))
3274 (dolist (mirror (yas--field-mirrors field))
3275 (let ((start (marker-position (yas--mirror-start mirror)))
3276 (end (marker-position (yas--mirror-end mirror))))
3277 (set-marker (yas--mirror-start mirror) nil)
3278 (set-marker (yas--mirror-end mirror) nil)
3279 (setf (yas--mirror-start mirror) (cons start (yas--mirror-start mirror)))
3280 (setf (yas--mirror-end mirror) (cons end (yas--mirror-end mirror))))))
3281 (let ((snippet-exit (yas--snippet-exit snippet)))
3283 (let ((exit (marker-position (yas--exit-marker snippet-exit))))
3284 (set-marker (yas--exit-marker snippet-exit) nil)
3285 (setf (yas--exit-marker snippet-exit) (cons exit (yas--exit-marker snippet-exit)))))))
3287 (defun yas--points-to-markers (snippet)
3288 "Convert all cons (POINT . MARKER) in SNIPPET to markers.
3290 This is done by setting MARKER to POINT with `set-marker'."
3291 (dolist (field (yas--snippet-fields snippet))
3292 (setf (yas--field-start field) (set-marker (cdr (yas--field-start field))
3293 (car (yas--field-start field))))
3294 (setf (yas--field-end field) (set-marker (cdr (yas--field-end field))
3295 (car (yas--field-end field))))
3296 (dolist (mirror (yas--field-mirrors field))
3297 (setf (yas--mirror-start mirror) (set-marker (cdr (yas--mirror-start mirror))
3298 (car (yas--mirror-start mirror))))
3299 (setf (yas--mirror-end mirror) (set-marker (cdr (yas--mirror-end mirror))
3300 (car (yas--mirror-end mirror))))))
3301 (let ((snippet-exit (yas--snippet-exit snippet)))
3303 (setf (yas--exit-marker snippet-exit) (set-marker (cdr (yas--exit-marker snippet-exit))
3304 (car (yas--exit-marker snippet-exit)))))))
3306 (defun yas--field-contains-point-p (field &optional point)
3307 (let ((point (or point
3309 (and (>= point (yas--field-start field))
3310 (<= point (yas--field-end field)))))
3312 (defun yas--field-text-for-display (field)
3313 "Return the propertized display text for field FIELD."
3314 (buffer-substring (yas--field-start field) (yas--field-end field)))
3316 (defun yas--undo-in-progress ()
3317 "True if some kind of undo is in progress."
3318 (or undo-in-progress
3319 (eq this-command 'undo)
3320 (eq this-command 'redo)))
3322 (defun yas--make-control-overlay (snippet start end)
3323 "Create the control overlay that surrounds the snippet and
3325 (let ((overlay (make-overlay start
3330 (overlay-put overlay 'keymap yas-keymap)
3331 (overlay-put overlay 'priority 100)
3332 (overlay-put overlay 'yas--snippet snippet)
3335 (defun yas-skip-and-clear-or-delete-char (&optional field)
3336 "Clears unmodified field if at field start, skips to next tab.
3338 Otherwise deletes a character normally by calling `delete-char'."
3340 (let ((field (or field
3341 (and yas--active-field-overlay
3342 (overlay-buffer yas--active-field-overlay)
3343 (overlay-get yas--active-field-overlay 'yas--field)))))
3345 (not (yas--field-modified-p field))
3346 (eq (point) (marker-position (yas--field-start field))))
3347 (yas--skip-and-clear field)
3350 (call-interactively 'delete-char)))))
3352 (defun yas--skip-and-clear (field)
3353 "Deletes the region of FIELD and sets it's modified state to t."
3354 ;; Just before skipping-and-clearing the field, mark its children
3355 ;; fields as modified, too. If the children have mirrors-in-fields
3356 ;; this prevents them from updating erroneously (we're skipping and
3359 (yas--mark-this-and-children-modified field)
3360 (delete-region (yas--field-start field) (yas--field-end field)))
3362 (defun yas--mark-this-and-children-modified (field)
3363 (setf (yas--field-modified-p field) t)
3364 (let ((fom (yas--field-next field)))
3366 (yas--fom-parent-field fom))
3367 (when (and (eq (yas--fom-parent-field fom) field)
3369 (yas--mark-this-and-children-modified fom))
3370 (setq fom (yas--fom-next fom)))))
3372 (defun yas--make-move-active-field-overlay (snippet field)
3373 "Place the active field overlay in SNIPPET's FIELD.
3375 Move the overlay, or create it if it does not exit."
3376 (if (and yas--active-field-overlay
3377 (overlay-buffer yas--active-field-overlay))
3378 (move-overlay yas--active-field-overlay
3379 (yas--field-start field)
3380 (yas--field-end field))
3381 (setq yas--active-field-overlay
3382 (make-overlay (yas--field-start field)
3383 (yas--field-end field)
3385 (overlay-put yas--active-field-overlay 'priority 100)
3386 (overlay-put yas--active-field-overlay 'face 'yas-field-highlight-face)
3387 (overlay-put yas--active-field-overlay 'yas--snippet snippet)
3388 (overlay-put yas--active-field-overlay 'modification-hooks '(yas--on-field-overlay-modification))
3389 (overlay-put yas--active-field-overlay 'insert-in-front-hooks
3390 '(yas--on-field-overlay-modification))
3391 (overlay-put yas--active-field-overlay 'insert-behind-hooks
3392 '(yas--on-field-overlay-modification))))
3394 (defun yas--on-field-overlay-modification (overlay after? _beg _end &optional _length)
3395 "Clears the field and updates mirrors, conditionally.
3397 Only clears the field if it hasn't been modified and it point it
3398 at field start. This hook doesn't do anything if an undo is in
3400 (unless (or yas--inhibit-overlay-hooks
3401 (yas--undo-in-progress))
3402 (let* ((field (overlay-get overlay 'yas--field))
3403 (snippet (overlay-get yas--active-field-overlay 'yas--snippet)))
3405 (yas--advance-end-maybe field (overlay-end overlay))
3407 (yas--field-update-display field))
3408 (yas--update-mirrors snippet))
3410 (when (and (not after?)
3411 (not (yas--field-modified-p field))
3412 (eq (point) (if (markerp (yas--field-start field))
3413 (marker-position (yas--field-start field))
3414 (yas--field-start field))))
3415 (yas--skip-and-clear field))
3416 (setf (yas--field-modified-p field) t))))))
3418 ;;; Apropos protection overlays:
3420 ;; These exist for nasty users who will try to delete parts of the
3421 ;; snippet outside the active field. Actual protection happens in
3422 ;; `yas--on-protection-overlay-modification'.
3424 ;; Currently this signals an error which inhibits the command. For
3425 ;; commands that move point (like `kill-line'), point is restored in
3426 ;; the `yas--post-command-handler' using a global
3427 ;; `yas--protection-violation' variable.
3429 ;; Alternatively, I've experimented with an implementation that
3430 ;; commits the snippet before actually calling `this-command'
3431 ;; interactively, and then signals an error, which is ignored. but
3432 ;; blocks all other million modification hooks. This presented some
3433 ;; problems with stacked expansion.
3435 (defun yas--make-move-field-protection-overlays (snippet field)
3436 "Place protection overlays surrounding SNIPPET's FIELD.
3438 Move the overlays, or create them if they do not exit."
3439 (let ((start (yas--field-start field))
3440 (end (yas--field-end field)))
3441 ;; First check if the (1+ end) is contained in the buffer,
3442 ;; otherwise we'll have to do a bit of cheating and silently
3443 ;; insert a newline. the `(1+ (buffer-size))' should prevent this
3444 ;; when using stacked expansion
3446 (when (< (buffer-size) end)
3448 (yas--inhibit-overlay-hooks
3449 (goto-char (point-max))
3451 ;; go on to normal overlay creation/moving
3453 (cond ((and yas--field-protection-overlays
3454 (every #'overlay-buffer yas--field-protection-overlays))
3455 (move-overlay (first yas--field-protection-overlays) (1- start) start)
3456 (move-overlay (second yas--field-protection-overlays) end (1+ end)))
3458 (setq yas--field-protection-overlays
3459 (list (make-overlay (1- start) start nil t nil)
3460 (make-overlay end (1+ end) nil t nil)))
3461 (dolist (ov yas--field-protection-overlays)
3462 (overlay-put ov 'face 'yas--field-debug-face)
3463 (overlay-put ov 'yas--snippet snippet)
3464 ;; (overlay-put ov 'evaporate t)
3465 (overlay-put ov 'modification-hooks '(yas--on-protection-overlay-modification)))))))
3467 (defvar yas--protection-violation nil
3468 "When non-nil, signals attempts to erroneously exit or modify the snippet.
3470 Functions in the `post-command-hook', for example
3471 `yas--post-command-handler' can check it and reset its value to
3472 nil. The variables value is the point where the violation
3475 (defun yas--on-protection-overlay-modification (_overlay after? _beg _end &optional _length)
3476 "Signals a snippet violation, then issues error.
3478 The error should be ignored in `debug-ignored-errors'"
3479 (unless yas--inhibit-overlay-hooks
3480 (cond ((not (or after?
3481 (yas--undo-in-progress)))
3482 (setq yas--protection-violation (point))
3483 (error "Exit the snippet first!")))))
3485 (add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
3488 ;;; Snippet expansion and "stacked" expansion:
3490 ;; Stacked expansion is when you try to expand a snippet when already
3491 ;; inside a snippet expansion.
3493 ;; The parent snippet does not run its fields modification hooks
3494 ;; (`yas--on-field-overlay-modification' and
3495 ;; `yas--on-protection-overlay-modification') while the child snippet
3496 ;; is active. This means, among other things, that the mirrors of the
3497 ;; parent snippet are not updated, this only happening when one exits
3498 ;; the child snippet.
3500 ;; Unfortunately, this also puts some ugly (and not fully-tested)
3501 ;; bits of code in `yas-expand-snippet' and
3502 ;; `yas--commit-snippet'. I've tried to mark them with "stacked
3505 ;; This was thought to be safer in an undo/redo perspective, but
3506 ;; maybe the correct implementation is to make the globals
3507 ;; `yas--active-field-overlay' and `yas--field-protection-overlays' be
3508 ;; snippet-local and be active even while the child snippet is
3509 ;; running. This would mean a lot of overlay modification hooks
3510 ;; running, but if managed correctly (including overlay priorities)
3511 ;; they should account for all situations...
3513 (defun yas-expand-snippet (content &optional start end expand-env)
3514 "Expand snippet CONTENT at current point.
3516 Text between START and END will be deleted before inserting
3517 template. EXPAND-ENV is are let-style variable to value bindings
3518 considered when expanding the snippet."
3519 (run-hooks 'yas-before-expand-snippet-hook)
3522 (let* ((yas-selected-text (or yas-selected-text
3523 (and (region-active-p)
3524 (buffer-substring-no-properties (region-beginning)
3527 (and (region-active-p)
3531 (and (region-active-p)
3534 (to-delete (and start
3536 (buffer-substring-no-properties start end)))
3539 (setq yas--indent-original-column (current-column))
3540 ;; Delete the region to delete, this *does* get undo-recorded.
3542 (when (and to-delete
3544 (delete-region start end))
3546 (cond ((listp content)
3547 ;; x) This is a snippet-command
3549 (yas--eval-lisp-no-saves content))
3551 ;; x) This is a snippet-snippet :-)
3553 ;; Narrow the region down to the content, shoosh the
3554 ;; `buffer-undo-list', and create the snippet, the new
3555 ;; snippet updates its mirrors once, so we are left with
3556 ;; some plain text. The undo action for deleting this
3557 ;; plain text will get recorded at the end.
3559 ;; stacked expansion: also shoosh the overlay modification hooks
3560 (let ((buffer-undo-list t))
3561 ;; snippet creation might evaluate users elisp, which
3562 ;; might generate errors, so we have to be ready to catch
3563 ;; them mostly to make the undo information
3565 (setq yas--start-column (current-column))
3566 (yas--inhibit-overlay-hooks
3569 (eval `(let* ,expand-env
3571 (yas--snippet-create start (point))))
3573 (yas--snippet-create start (point))))))
3575 ;; stacked-expansion: This checks for stacked expansion, save the
3576 ;; `yas--previous-active-field' and advance its boundary.
3578 (let ((existing-field (and yas--active-field-overlay
3579 (overlay-buffer yas--active-field-overlay)
3580 (overlay-get yas--active-field-overlay 'yas--field))))
3581 (when existing-field
3582 (setf (yas--snippet-previous-active-field snippet) existing-field)
3583 (yas--advance-end-maybe existing-field (overlay-end yas--active-field-overlay))))
3585 ;; Exit the snippet immediately if no fields
3587 (unless (yas--snippet-fields snippet)
3588 (yas-exit-snippet snippet))
3590 ;; Push two undo actions: the deletion of the inserted contents of
3591 ;; the new snippet (without the "key") followed by an apply of
3592 ;; `yas--take-care-of-redo' on the newly inserted snippet boundaries
3594 ;; A small exception, if `yas-also-auto-indent-first-line'
3595 ;; is t and `yas--indent' decides to indent the line to a
3596 ;; point before the actual expansion point, undo would be
3597 ;; messed up. We call the early point "newstart"". case,
3598 ;; and attempt to fix undo.
3600 (let ((newstart (overlay-start (yas--snippet-control-overlay snippet)))
3601 (end (overlay-end (yas--snippet-control-overlay snippet))))
3602 (when (< newstart start)
3603 (push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
3604 (push (cons newstart end) buffer-undo-list)
3605 (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
3607 ;; Now, schedule a move to the first field
3609 (let ((first-field (car (yas--snippet-fields snippet))))
3611 (sit-for 0) ;; fix issue 125
3612 (yas--move-to-field snippet first-field)))
3613 (yas--message 3 "snippet expanded.")
3616 (defun yas--take-care-of-redo (_beg _end snippet)
3617 "Commits SNIPPET, which in turn pushes an undo action for reviving it.
3619 Meant to exit in the `buffer-undo-list'."
3620 ;; slightly optimize: this action is only needed for snippets with
3621 ;; at least one field
3622 (when (yas--snippet-fields snippet)
3623 (yas--commit-snippet snippet)))
3625 (defun yas--snippet-revive (beg end snippet)
3626 "Revives SNIPPET and creates a control overlay from BEG to END.
3628 BEG and END are, we hope, the original snippets boundaries.
3629 All the markers/points exiting existing inside SNIPPET should point
3630 to their correct locations *at the time the snippet is revived*.
3632 After revival, push the `yas--take-care-of-redo' in the
3634 ;; Reconvert all the points to markers
3636 (yas--points-to-markers snippet)
3637 ;; When at least one editable field existed in the zombie snippet,
3638 ;; try to revive the whole thing...
3640 (let ((target-field (or (yas--snippet-active-field snippet)
3641 (car (yas--snippet-fields snippet)))))
3643 (setf (yas--snippet-control-overlay snippet) (yas--make-control-overlay snippet beg end))
3644 (overlay-put (yas--snippet-control-overlay snippet) 'yas--snippet snippet)
3646 (yas--move-to-field snippet target-field)
3648 (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
3649 buffer-undo-list))))
3651 (defun yas--snippet-create (begin end)
3652 "Create a snippet from a template inserted at BEGIN to END.
3654 Returns the newly created snippet."
3656 (narrow-to-region begin end)
3657 (let ((snippet (yas--make-snippet)))
3659 (yas--snippet-parse-create snippet)
3661 ;; Sort and link each field
3662 (yas--snippet-sort-fields snippet)
3664 ;; Create keymap overlay for snippet
3665 (setf (yas--snippet-control-overlay snippet)
3666 (yas--make-control-overlay snippet (point-min) (point-max)))
3669 (goto-char (point-max))
3674 ;;; Apropos adjacencies and "fom's":
3676 ;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
3677 ;; recently expanded snippet, we might actually have many fields,
3678 ;; mirrors (and the snippet exit) in the very same position in the
3679 ;; buffer. Therefore we need to single-link the
3680 ;; fields-or-mirrors-or-exit (which I have abbreviated to "fom")
3681 ;; according to their original positions in the buffer.
3683 ;; Then we have operation `yas--advance-end-maybe' and
3684 ;; `yas--advance-start-maybe', which conditionally push the starts and
3685 ;; ends of these foms down the chain.
3687 ;; This allows for like the printf with the magic ",":
3689 ;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
3690 ;; $2${1:$(if (string-match "%" text) "\);" "")}$0
3692 (defun yas--fom-start (fom)
3693 (cond ((yas--field-p fom)
3694 (yas--field-start fom))
3695 ((yas--mirror-p fom)
3696 (yas--mirror-start fom))
3698 (yas--exit-marker fom))))
3700 (defun yas--fom-end (fom)
3701 (cond ((yas--field-p fom)
3702 (yas--field-end fom))
3703 ((yas--mirror-p fom)
3704 (yas--mirror-end fom))
3706 (yas--exit-marker fom))))
3708 (defun yas--fom-next (fom)
3709 (cond ((yas--field-p fom)
3710 (yas--field-next fom))
3711 ((yas--mirror-p fom)
3712 (yas--mirror-next fom))
3714 (yas--exit-next fom))))
3716 (defun yas--fom-parent-field (fom)
3717 (cond ((yas--field-p fom)
3718 (yas--field-parent-field fom))
3719 ((yas--mirror-p fom)
3720 (yas--mirror-parent-field fom))
3724 (defun yas--calculate-adjacencies (snippet)
3725 "Calculate adjacencies for fields or mirrors of SNIPPET.
3727 This is according to their relative positions in the buffer, and
3728 has to be called before the $-constructs are deleted."
3729 (let* ((fom-set-next-fom
3730 (lambda (fom nextfom)
3731 (cond ((yas--field-p fom)
3732 (setf (yas--field-next fom) nextfom))
3733 ((yas--mirror-p fom)
3734 (setf (yas--mirror-next fom) nextfom))
3736 (setf (yas--exit-next fom) nextfom)))))
3739 (if (= (yas--fom-start fom2) (yas--fom-start fom1))
3740 (yas--mirror-p fom2)
3741 (>= (yas--fom-start fom2) (yas--fom-start fom1)))))
3742 (link-foms fom-set-next-fom))
3743 ;; make some yas--field, yas--mirror and yas--exit soup
3745 (when (yas--snippet-exit snippet)
3746 (push (yas--snippet-exit snippet) soup))
3747 (dolist (field (yas--snippet-fields snippet))
3749 (dolist (mirror (yas--field-mirrors field))
3750 (push mirror soup)))
3752 (sort soup compare-fom-begs))
3754 (reduce link-foms soup)))))
3756 (defun yas--calculate-mirrors-in-fields (snippet mirror)
3757 "Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
3759 Use the tightest containing field if more than one field contains
3760 the mirror. Intended to be called *before* the dollar-regions are
3762 (let ((min (point-min))
3764 (dolist (field (yas--snippet-fields snippet))
3765 (when (and (<= (yas--field-start field) (yas--mirror-start mirror))
3766 (<= (yas--mirror-end mirror) (yas--field-end field))
3767 (< min (yas--field-start field))
3768 (< (yas--field-end field) max))
3769 (setq min (yas--field-start field)
3770 max (yas--field-end field))
3771 (setf (yas--mirror-parent-field mirror) field)))))
3773 (defun yas--advance-end-maybe (fom newend)
3774 "Maybe advance FOM's end to NEWEND if it needs it.
3778 * call `yas--advance-start-maybe' on FOM's next fom.
3780 * in case FOM is field call `yas--advance-end-maybe' on its parent
3783 Also, if FOM is an exit-marker, always call
3784 `yas--advance-start-maybe' on its next fom. This is because
3785 exit-marker have identical start and end markers."
3786 (cond ((and fom (< (yas--fom-end fom) newend))
3787 (set-marker (yas--fom-end fom) newend)
3788 (yas--advance-start-maybe (yas--fom-next fom) newend)
3789 (yas--advance-end-of-parents-maybe (yas--fom-parent-field fom) newend))
3791 (yas--advance-start-maybe (yas--fom-next fom) newend))))
3793 (defun yas--advance-start-maybe (fom newstart)
3794 "Maybe advance FOM's start to NEWSTART if it needs it.
3796 If it does, also call `yas--advance-end-maybe' on FOM."
3797 (when (and fom (< (yas--fom-start fom) newstart))
3798 (set-marker (yas--fom-start fom) newstart)
3799 (yas--advance-end-maybe fom newstart)))
3801 (defun yas--advance-end-of-parents-maybe (field newend)
3802 "Like `yas--advance-end-maybe' but for parent fields.
3804 Only works for fields and doesn't care about the start of the
3805 next FOM. Works its way up recursively for parents of parents."
3807 (< (yas--field-end field) newend))
3808 (set-marker (yas--field-end field) newend)
3809 (yas--advance-end-of-parents-maybe (yas--field-parent-field field) newend)))
3811 (defvar yas--dollar-regions nil
3812 "When expanding the snippet the \"parse-create\" functions add
3813 cons cells to this var.")
3815 (defvar yas--backquote-markers-and-strings nil
3816 "List of (MARKER . STRING) marking where the values from
3817 backquoted Lisp expressions should be inserted at the end of
3820 (defun yas--snippet-parse-create (snippet)
3821 "Parse a recently inserted snippet template, creating all
3822 necessary fields, mirrors and exit points.
3824 Meant to be called in a narrowed buffer, does various passes"
3825 (let ((parse-start (point)))
3826 ;; Reset the yas--dollar-regions
3828 (setq yas--dollar-regions nil)
3829 ;; protect just the backquotes
3831 (yas--protect-escapes nil '(?`))
3832 ;; replace all backquoted expressions
3834 (goto-char parse-start)
3835 (yas--save-backquotes)
3836 ;; protect escaped characters
3838 (yas--protect-escapes)
3839 ;; parse fields with {}
3841 (goto-char parse-start)
3842 (yas--field-parse-create snippet)
3843 ;; parse simple mirrors and fields
3845 (goto-char parse-start)
3846 (yas--simple-mirror-parse-create snippet)
3847 ;; parse mirror transforms
3849 (goto-char parse-start)
3850 (yas--transform-mirror-parse-create snippet)
3851 ;; calculate adjacencies of fields and mirrors
3853 (yas--calculate-adjacencies snippet)
3854 ;; Delete $-constructs
3856 (save-restriction (widen) (yas--delete-regions yas--dollar-regions))
3857 ;; restore backquoted expression values
3859 (yas--restore-backquotes)
3862 (goto-char parse-start)
3863 (yas--restore-escapes)
3864 ;; update mirrors for the first time
3866 (yas--update-mirrors snippet)
3867 ;; indent the best we can
3869 (goto-char parse-start)
3870 (yas--indent snippet)))
3872 (defun yas--indent-according-to-mode (snippet-markers)
3873 "Indent current line according to mode, preserving SNIPPET-MARKERS."
3874 ;;; Apropos indenting problems....
3876 ;; `indent-according-to-mode' uses whatever `indent-line-function'
3877 ;; is available. Some implementations of these functions delete text
3878 ;; before they insert. If there happens to be a marker just after
3879 ;; the text being deleted, the insertion actually happens after the
3880 ;; marker, which misplaces it.
3882 ;; This would also happen if we had used overlays with the
3883 ;; `front-advance' property set to nil.
3885 ;; This is why I have these `trouble-markers', they are the ones at
3886 ;; they are the ones at the first non-whitespace char at the line
3887 ;; (i.e. at `yas--real-line-beginning'. After indentation takes place
3888 ;; we should be at the correct to restore them to. All other
3889 ;; non-trouble-markers have been *pushed* and don't need special
3892 (goto-char (yas--real-line-beginning))
3893 (let ((trouble-markers (remove-if-not #'(lambda (marker)
3899 (indent-according-to-mode)
3900 (error (yas--message 3 "Warning: `yas--indent-according-to-mode' having problems running %s" indent-line-function)
3902 (mapc #'(lambda (marker)
3903 (set-marker marker (point)))
3906 (defvar yas--indent-original-column nil)
3907 (defun yas--indent (snippet)
3908 (let ((snippet-markers (yas--collect-snippet-markers snippet)))
3909 ;; Look for those $>
3911 (while (re-search-forward "$>" nil t)
3912 (delete-region (match-beginning 0) (match-end 0))
3913 (when (not (eq yas-indent-line 'auto))
3914 (yas--indent-according-to-mode snippet-markers))))
3915 ;; Now do stuff for 'fixed and 'auto
3917 (cond ((eq yas-indent-line 'fixed)
3918 (while (and (zerop (forward-line))
3919 (zerop (current-column)))
3920 (indent-to-column yas--indent-original-column)))
3921 ((eq yas-indent-line 'auto)
3922 (let ((end (set-marker (make-marker) (point-max)))
3923 (indent-first-line-p yas-also-auto-indent-first-line))
3924 (while (and (zerop (if indent-first-line-p
3927 (setq indent-first-line-p nil))
3931 (yas--indent-according-to-mode snippet-markers))))
3935 (defun yas--collect-snippet-markers (snippet)
3936 "Make a list of all the markers used by SNIPPET."
3938 (dolist (field (yas--snippet-fields snippet))
3939 (push (yas--field-start field) markers)
3940 (push (yas--field-end field) markers)
3941 (dolist (mirror (yas--field-mirrors field))
3942 (push (yas--mirror-start mirror) markers)
3943 (push (yas--mirror-end mirror) markers)))
3944 (let ((snippet-exit (yas--snippet-exit snippet)))
3945 (when (and snippet-exit
3946 (marker-buffer (yas--exit-marker snippet-exit)))
3947 (push (yas--exit-marker snippet-exit) markers)))
3950 (defun yas--real-line-beginning ()
3951 (let ((c (char-after (line-beginning-position)))
3952 (n (line-beginning-position)))
3953 (while (or (eql c ?\ )
3956 (setq c (char-after n)))
3959 (defun yas--escape-string (escaped)
3960 (concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
3962 (defun yas--protect-escapes (&optional text escaped)
3963 "Protect all escaped characters with their numeric ASCII value.
3965 With optional string TEXT do it in string instead of buffer."
3966 (let ((changed-text text)
3967 (text-provided-p text))
3968 (mapc #'(lambda (escaped)
3970 (yas--replace-all (concat "\\" (char-to-string escaped))
3971 (yas--escape-string escaped)
3972 (when text-provided-p changed-text))))
3973 (or escaped yas--escaped-characters))
3976 (defun yas--restore-escapes (&optional text escaped)
3977 "Restore all escaped characters from their numeric ASCII value.
3979 With optional string TEXT do it in string instead of the buffer."
3980 (let ((changed-text text)
3981 (text-provided-p text))
3982 (mapc #'(lambda (escaped)
3984 (yas--replace-all (yas--escape-string escaped)
3985 (char-to-string escaped)
3986 (when text-provided-p changed-text))))
3987 (or escaped yas--escaped-characters))
3990 (defun yas--save-backquotes ()
3991 "Save all the \"`(lisp-expression)`\"-style expressions
3992 with their evaluated value into `yas--backquote-markers-and-strings'."
3993 (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
3994 (let ((current-string (match-string-no-properties 1)) transformed)
3995 (save-restriction (widen)
3996 (delete-region (match-beginning 0) (match-end 0)))
3997 (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
3998 (goto-char (match-beginning 0))
4000 (let ((marker (make-marker)))
4003 (insert "Y") ;; quite horrendous, I love it :)
4004 (set-marker marker (point))
4006 (push (cons marker transformed) yas--backquote-markers-and-strings))))))
4008 (defun yas--restore-backquotes ()
4009 "Replace markers in `yas--backquote-markers-and-strings' with their values."
4010 (while yas--backquote-markers-and-strings
4011 (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
4012 (marker (car marker-and-string))
4013 (string (cdr marker-and-string)))
4021 (set-marker marker nil)))))
4023 (defun yas--scan-sexps (from count)
4025 (with-syntax-table (standard-syntax-table)
4026 (scan-sexps from count))
4030 (defun yas--make-marker (pos)
4031 "Create a marker at POS with nil `marker-insertion-type'."
4032 (let ((marker (set-marker (make-marker) pos)))
4033 (set-marker-insertion-type marker nil)
4036 (defun yas--field-parse-create (snippet &optional parent-field)
4037 "Parse most field expressions in SNIPPET, except for the simple one \"$n\".
4039 The following count as a field:
4041 * \"${n: text}\", for a numbered field with default text, as long as N is not 0;
4043 * \"${n: text$(expression)}, the same with a Lisp expression;
4044 this is caught with the curiously named `yas--multi-dollar-lisp-expression-regexp'
4046 * the same as above but unnumbered, (no N:) and number is calculated automatically.
4048 When multiple expressions are found, only the last one counts."
4051 (while (re-search-forward yas--field-regexp nil t)
4052 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4053 (number (and (match-string-no-properties 1)
4054 (string-to-number (match-string-no-properties 1))))
4055 (brand-new-field (and real-match-end-0
4056 ;; break if on "$(" immediately
4057 ;; after the ":", this will be
4058 ;; caught as a mirror with
4060 (not (save-match-data
4061 (eq (string-match "$[ \t\n]*("
4062 (match-string-no-properties 2)) 0)))
4063 ;; allow ${0: some exit text}
4064 ;; (not (and number (zerop number)))
4065 (yas--make-field number
4066 (yas--make-marker (match-beginning 2))
4067 (yas--make-marker (1- real-match-end-0))
4069 (when brand-new-field
4070 (goto-char real-match-end-0)
4071 (push (cons (1- real-match-end-0) real-match-end-0)
4072 yas--dollar-regions)
4073 (push (cons (match-beginning 0) (match-beginning 2))
4074 yas--dollar-regions)
4075 (push brand-new-field (yas--snippet-fields snippet))
4078 (narrow-to-region (yas--field-start brand-new-field) (yas--field-end brand-new-field))
4079 (goto-char (point-min))
4080 (yas--field-parse-create snippet brand-new-field)))))))
4081 ;; if we entered from a parent field, now search for the
4082 ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
4083 ;; primary field transformations
4087 (while (re-search-forward yas--multi-dollar-lisp-expression-regexp nil t)
4088 (let* ((real-match-end-1 (yas--scan-sexps (match-beginning 1) 1)))
4089 ;; commit the primary field transformation if:
4091 ;; 1. we don't find it in yas--dollar-regions (a subnested
4092 ;; field) might have already caught it.
4094 ;; 2. we really make sure we have either two '$' or some
4095 ;; text and a '$' after the colon ':'. This is a FIXME: work
4096 ;; my regular expressions and end these ugly hacks.
4098 (when (and real-match-end-1
4099 (not (member (cons (match-beginning 0)
4101 yas--dollar-regions))
4103 (char-before (1- (match-beginning 1))))))
4104 (let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
4106 (setf (yas--field-transform parent-field)
4107 (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
4108 (push (cons (match-beginning 0) real-match-end-1)
4109 yas--dollar-regions)))))))
4111 (defun yas--transform-mirror-parse-create (snippet)
4112 "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
4113 (while (re-search-forward yas--transform-mirror-regexp nil t)
4114 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4115 (number (string-to-number (match-string-no-properties 1)))
4117 (not (zerop number))
4118 (yas--snippet-find-field snippet number)))
4120 (and real-match-end-0
4122 (yas--make-mirror (yas--make-marker (match-beginning 0))
4123 (yas--make-marker (match-beginning 0))
4125 (yas--restore-escapes
4126 (buffer-substring-no-properties (match-beginning 2)
4127 (1- real-match-end-0))))))))
4128 (when brand-new-mirror
4129 (push brand-new-mirror
4130 (yas--field-mirrors field))
4131 (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
4132 (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
4134 (defun yas--simple-mirror-parse-create (snippet)
4135 "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
4136 (while (re-search-forward yas--simple-mirror-regexp nil t)
4137 (let ((number (string-to-number (match-string-no-properties 1))))
4138 (cond ((zerop number)
4140 (setf (yas--snippet-exit snippet)
4141 (yas--make-exit (yas--make-marker (match-end 0))))
4143 (goto-char (match-beginning 0))
4144 (when yas-wrap-around-region
4145 (cond (yas-selected-text
4146 (insert yas-selected-text))
4147 ((and (eq yas-wrap-around-region 'cua)
4150 (insert (prog1 (get-register ?0)
4151 (set-register ?0 nil))))))
4152 (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
4153 yas--dollar-regions)))
4155 (let ((field (yas--snippet-find-field snippet number)))
4157 (let ((brand-new-mirror (yas--make-mirror
4158 (yas--make-marker (match-beginning 0))
4159 (yas--make-marker (match-beginning 0))
4161 (push brand-new-mirror
4162 (yas--field-mirrors field))
4163 (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
4164 (push (yas--make-field number
4165 (yas--make-marker (match-beginning 0))
4166 (yas--make-marker (match-beginning 0))
4168 (yas--snippet-fields snippet))))
4169 (push (cons (match-beginning 0) (match-end 0))
4170 yas--dollar-regions))))))
4172 (defun yas--delete-regions (regions)
4173 "Sort disjuct REGIONS by start point, then delete from the back."
4174 (mapc #'(lambda (reg)
4175 (delete-region (car reg) (cdr reg)))
4178 (>= (car r1) (car r2))))))
4180 (defun yas--calculate-mirror-depth (mirror &optional traversed)
4181 (let* ((parent (yas--mirror-parent-field mirror))
4182 (parents-mirrors (and parent
4183 (yas--field-mirrors parent))))
4184 (or (yas--mirror-depth mirror)
4185 (setf (yas--mirror-depth mirror)
4186 (cond ((memq mirror traversed)
4188 ((and parent parents-mirrors)
4190 (mapcar #'(lambda (m)
4191 (yas--calculate-mirror-depth m
4200 (defun yas--update-mirrors (snippet)
4201 "Update all the mirrors of SNIPPET."
4203 (dolist (field-and-mirror (sort
4204 ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
4205 ;; where F is the field that M is mirroring
4207 (mapcan #'(lambda (field)
4208 (mapcar #'(lambda (mirror)
4209 (cons field mirror))
4210 (yas--field-mirrors field)))
4211 (yas--snippet-fields snippet))
4212 ;; then sort this list so that entries with mirrors with parent
4213 ;; fields appear before. This was important for fixing #290, and
4214 ;; luckily also handles the case where a mirror in a field causes
4215 ;; another mirror to need reupdating
4217 #'(lambda (field-and-mirror1 field-and-mirror2)
4218 (> (yas--calculate-mirror-depth (cdr field-and-mirror1))
4219 (yas--calculate-mirror-depth (cdr field-and-mirror2))))))
4220 (let* ((field (car field-and-mirror))
4221 (mirror (cdr field-and-mirror))
4222 (parent-field (yas--mirror-parent-field mirror)))
4223 ;; before updating a mirror with a parent-field, maybe advance
4227 (yas--advance-start-maybe mirror (yas--fom-start parent-field)))
4228 ;; update this mirror
4230 (yas--mirror-update-display mirror field)
4231 ;; `yas--place-overlays' is needed if the active field and
4232 ;; protected overlays have been changed because of insertions
4233 ;; in `yas--mirror-update-display'
4235 (when (eq field (yas--snippet-active-field snippet))
4236 (yas--place-overlays snippet field))))))
4238 (defun yas--mirror-update-display (mirror field)
4239 "Update MIRROR according to FIELD (and mirror transform)."
4241 (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
4242 (reflection (and (not (and mirror-parent-field
4243 (yas--field-modified-p mirror-parent-field)))
4244 (or (yas--apply-transform mirror field 'empty-on-nil)
4245 (yas--field-text-for-display field)))))
4246 (when (and reflection
4247 (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
4248 (yas--mirror-end mirror)))))
4249 (goto-char (yas--mirror-start mirror))
4250 (yas--inhibit-overlay-hooks
4251 (insert reflection))
4252 (if (> (yas--mirror-end mirror) (point))
4253 (delete-region (point) (yas--mirror-end mirror))
4254 (set-marker (yas--mirror-end mirror) (point))
4255 (yas--advance-start-maybe (yas--mirror-next mirror) (point))
4256 ;; super-special advance
4257 (yas--advance-end-of-parents-maybe mirror-parent-field (point))))))
4259 (defun yas--field-update-display (field)
4260 "Much like `yas--mirror-update-display', but for fields."
4261 (when (yas--field-transform field)
4262 (let ((transformed (and (not (eq (yas--field-number field) 0))
4263 (yas--apply-transform field field))))
4264 (when (and transformed
4265 (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
4266 (yas--field-end field)))))
4267 (setf (yas--field-modified-p field) t)
4268 (goto-char (yas--field-start field))
4269 (yas--inhibit-overlay-hooks
4270 (insert transformed)
4271 (if (> (yas--field-end field) (point))
4272 (delete-region (point) (yas--field-end field))
4273 (set-marker (yas--field-end field) (point))
4274 (yas--advance-start-maybe (yas--field-next field) (point)))
4278 ;;; Post-command hook:
4280 (defun yas--post-command-handler ()
4281 "Handles various yasnippet conditions after each command."
4282 (cond (yas--protection-violation
4283 (goto-char yas--protection-violation)
4284 (setq yas--protection-violation nil))
4285 ((eq 'undo this-command)
4287 ;; After undo revival the correct field is sometimes not
4288 ;; restored correctly, this condition handles that
4290 (let* ((snippet (car (yas--snippets-at-point)))
4291 (target-field (and snippet
4292 (find-if-not #'(lambda (field)
4293 (yas--field-probably-deleted-p snippet field))
4295 (cons (yas--snippet-active-field snippet)
4296 (yas--snippet-fields snippet)))))))
4298 (yas--move-to-field snippet target-field))))
4299 ((not (yas--undo-in-progress))
4300 ;; When not in an undo, check if we must commit the snippet
4301 ;; (user exited it).
4302 (yas--check-commit-snippet))))
4306 ;; The docstrings for some functions are generated dynamically
4307 ;; depending on the context.
4309 (put 'yas-expand 'function-documentation
4310 '(yas--expand-from-trigger-key-doc t))
4311 (defun yas--expand-from-trigger-key-doc (context)
4312 "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
4313 (let* ((yas-fallback-behavior (and context yas-fallback-behavior))
4314 (fallback-description
4315 (cond ((eq yas-fallback-behavior 'call-other-command)
4316 (let* ((fallback (yas--keybinding-beyond-yasnippet)))
4318 (format "call command `%s'."
4319 (pp-to-string fallback)))
4320 "do nothing (`yas-expand' doesn't shadow\nanything).")))
4321 ((eq yas-fallback-behavior 'return-nil)
4323 (t "defer to `yas-fallback-behavior' (which see)."))))
4324 (concat "Expand a snippet before point. If no snippet
4325 expansion is possible, "
4326 fallback-description
4327 "\n\nOptional argument FIELD is for non-interactive use and is an
4328 object satisfying `yas--field-p' to restrict the expansion to.")))
4330 (put 'yas-expand-from-keymap 'function-documentation
4331 '(yas--expand-from-keymap-doc t))
4332 (defun yas--expand-from-keymap-doc (context)
4333 "A doc synthesizer for `yas--expand-from-keymap-doc'."
4334 (add-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce)
4335 (concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
4336 (when (and context (eq this-command 'describe-key))
4337 (let* ((vec (this-single-command-keys))
4338 (templates (mapcan #'(lambda (table)
4339 (yas--fetch table vec))
4340 (yas--get-snippet-tables)))
4341 (yas--direct-keymaps nil)
4342 (fallback (key-binding vec)))
4343 (concat "In this case, "
4345 (concat "these snippets are bound to this key:\n"
4346 (yas--template-pretty-list templates)
4347 "\n\nIf none of these expands, "))
4349 (format "fallback `%s' will be called." (pp-to-string fallback)))
4350 "no fallback keybinding is called."))))))
4352 (defun yas--template-pretty-list (templates)
4354 (yas-buffer-local-condition 'always))
4355 (dolist (plate templates)
4356 (setq acc (concat acc "\n*) "
4357 (propertize (concat "\\\\snippet `" (car plate) "'")
4358 'yasnippet (cdr plate)))))
4361 (define-button-type 'help-snippet-def
4362 :supertype 'help-xref
4363 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
4364 'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
4366 (defun yas--snippet-description-finish-runonce ()
4367 "Final adjustments for the help buffer when snippets are concerned."
4368 (yas--create-snippet-xrefs)
4369 (remove-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce))
4371 (defun yas--create-snippet-xrefs ()
4373 (goto-char (point-min))
4374 (while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
4375 (let ((template (get-text-property (match-beginning 1)
4378 (help-xref-button 1 'help-snippet-def template)
4379 (kill-region (match-end 1) (match-end 0))
4380 (kill-region (match-beginning 0) (match-beginning 1)))))))
4384 (defvar yas-verbosity 4
4385 "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
4387 (defun yas--message (level message &rest args)
4388 "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
4389 (when (> yas-verbosity level)
4390 (message "%s" (apply #'yas--format message args))))
4392 (defun yas--warning (format-control &rest format-args)
4393 (let ((msg (apply #'format format-control format-args)))
4394 (display-warning 'yasnippet msg :warning)
4395 (yas--message 1 msg)))
4397 (defun yas--format (format-control &rest format-args)
4398 (apply #'format (concat "[yas] " format-control) format-args))
4405 ;; `locate-dominating-file'
4406 ;; `region-active-p'
4408 ;; added for compatibility in emacsen < 23
4409 (unless (>= emacs-major-version 23)
4410 (unless (fboundp 'region-active-p)
4411 (defun region-active-p () (and transient-mark-mode mark-active)))
4413 (unless (fboundp 'locate-dominating-file)
4414 (defvar locate-dominating-stop-dir-regexp
4415 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
4416 "Regexp of directory names which stop the search in `locate-dominating-file'.
4417 Any directory whose name matches this regexp will be treated like
4418 a kind of root directory by `locate-dominating-file' which will stop its search
4419 when it bumps into it.
4420 The default regexp prevents fruitless and time-consuming attempts to find
4421 special files in directories in which filenames are interpreted as hostnames,
4422 or mount points potentially requiring authentication as a different user.")
4424 (defun locate-dominating-file (file name)
4425 "Look up the directory hierarchy from FILE for a file named NAME.
4426 Stop at the first parent directory containing a file NAME,
4427 and return the directory. Return nil if not found."
4428 ;; We used to use the above locate-dominating-files code, but the
4429 ;; directory-files call is very costly, so we're much better off doing
4430 ;; multiple calls using the code in here.
4432 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
4433 ;; `name' in /home or in /.
4434 (setq file (abbreviate-file-name file))
4437 (while (not (or root
4439 ;; FIXME: Disabled this heuristic because it is sometimes
4441 ;; As a heuristic, we stop looking up the hierarchy of
4442 ;; directories as soon as we find a directory belonging
4443 ;; to another user. This should save us from looking in
4444 ;; things like /net and /afs. This assumes that all the
4445 ;; files inside a project belong to the same user.
4446 ;; (let ((prev-user user))
4447 ;; (setq user (nth 2 (file-attributes file)))
4448 ;; (and prev-user (not (equal user prev-user))))
4449 (string-match locate-dominating-stop-dir-regexp file)))
4450 (setq try (file-exists-p (expand-file-name name file)))
4451 (cond (try (setq root file))
4452 ((equal file (setq file (file-name-directory
4453 (directory-file-name file))))
4458 ;;; Backward compatibility to yasnippet <= 0.7
4460 (defvar yas--backported-syms '(;; `defcustom's
4463 yas-prompt-functions
4465 yas-also-auto-indent-first-line
4467 yas-triggers-in-field
4468 yas-fallback-behavior
4469 yas-choose-keys-first
4470 yas-choose-tables-first
4473 yas-wrap-around-region
4476 yas-expand-only-for-last-commands
4477 yas-field-highlight-face
4479 ;; these vars can be customized as well
4485 yas-after-exit-snippet-hook
4486 yas-before-expand-snippet-hook
4487 yas-buffer-local-condition
4490 ;; prompting functions
4495 yas-completing-prompt
4498 ;; interactive functions
4503 yas-direct-keymaps-reload
4507 yas-compile-directory
4510 yas-expand-from-trigger-key
4511 yas-expand-from-keymap
4513 yas-visit-snippet-file
4515 yas-load-snippet-buffer
4518 yas-next-field-or-maybe-expand
4523 yas-exit-all-snippets
4524 yas-skip-and-clear-or-delete-char
4526 ;; symbols that I "exported" for use
4527 ;; in snippets and hookage
4544 yas-default-from-field
4547 yas-define-condition-cache
4548 yas-hippie-try-expand
4550 ;; debug definitions
4551 ;; yas-debug-snippet-vars
4552 ;; yas-exterminate-package
4555 ;; testing definitions
4556 ;; yas-should-expand
4557 ;; yas-should-not-expand
4559 ;; yas-make-file-or-dirs
4561 ;; yas-saving-variables
4562 ;; yas-call-with-snippet-dirs
4563 ;; yas-with-snippet-dirs
4565 "Backported yasnippet symbols.
4567 They are mapped to \"yas/*\" variants.")
4569 (dolist (sym yas--backported-syms)
4570 (let ((backported (intern (replace-regexp-in-string "^yas-" "yas/" (symbol-name sym)))))
4572 (make-obsolete-variable backported sym "yasnippet 0.8")
4573 (defvaralias backported sym))
4575 (make-obsolete backported sym "yasnippet 0.8")
4576 (defalias backported sym))))
4578 (defvar yas--exported-syms
4580 (mapatoms (lambda (atom)
4581 (if (and (or (and (boundp atom)
4582 (not (get atom 'byte-obsolete-variable)))
4584 (not (get atom 'byte-obsolete-info))))
4585 (string-match-p "^yas-[^-]" (symbol-name atom)))
4586 (push atom exported))))
4588 "Exported yasnippet symbols.
4590 i.e. the ones with \"yas-\" single dash prefix. I will try to
4591 keep them in future yasnippet versions and other elisp libraries
4592 can more or less safely rely upon them.")
4595 (provide 'yasnippet)
4598 ;; indent-tabs-mode: nil
4599 ;; byte-compile-warnings: (not cl-functions)
4601 ;;; yasnippet.el ends here