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"
154 (defvar yas-installed-snippets-dir nil)
155 (setq yas-installed-snippets-dir
157 (concat (file-name-directory load-file-name) "snippets")))
159 (defcustom yas-snippet-dirs (remove nil
160 (list "~/.emacs.d/snippets"
161 'yas-installed-snippets-dir))
162 "List of top-level snippet directories.
164 Each element, a string or a symbol whose value is a string,
165 designates a top-level directory where per-mode snippet
166 directories can be found.
168 Elements appearing earlier in the list shadow later elements'
171 The first directory is taken as the default for storing snippet's
172 created with `yas-new-snippet'. "
173 :type '(choice (string :tag "Single directory (string)")
174 (repeat :args (string) :tag "List of directories (strings)"))
177 :set #'(lambda (symbol new)
178 (let ((old (and (boundp symbol)
179 (symbol-value symbol))))
180 (set-default symbol new)
181 (unless (or (not (fboundp 'yas-reload-all))
185 (defun yas-snippet-dirs ()
186 "Return variable `yas-snippet-dirs' as list of strings."
187 (cl-loop for e in (if (listp yas-snippet-dirs)
189 (list yas-snippet-dirs))
191 (cond ((stringp e) e)
194 (stringp (symbol-value e)))
197 (error "[yas] invalid element %s in `yas-snippet-dirs'" e)))))
199 (defvaralias 'yas/root-directory 'yas-snippet-dirs)
201 (defcustom yas-new-snippet-default "\
202 # -*- mode: snippet; require-final-newline: nil -*-
204 # key: ${2:${1:$(yas--key-from-desc yas-text)}}${3:
205 # binding: ${4:direct-keybinding}}
208 "Default snippet to use when creating a new snippet.
209 If nil, don't use any snippet."
213 (defcustom yas-prompt-functions '(yas-x-prompt
215 yas-completing-prompt
218 "Functions to prompt for keys, templates, etc interactively.
220 These functions are called with the following arguments:
222 - PROMPT: A string to prompt the user
224 - CHOICES: a list of strings or objects.
226 - optional DISPLAY-FN : A function that, when applied to each of
227 the objects in CHOICES will return a string.
229 The return value of any function you put here should be one of
230 the objects in CHOICES, properly formatted with DISPLAY-FN (if
233 - To signal that your particular style of prompting is
234 unavailable at the moment, you can also have the function return
237 - To signal that the user quit the prompting process, you can
240 (signal 'quit \"user quit!\")."
241 :type '(repeat function)
244 (defcustom yas-indent-line 'auto
245 "Controls indenting applied to a recent snippet expansion.
247 The following values are possible:
249 - `fixed' Indent the snippet to the current column;
251 - `auto' Indent each line of the snippet with `indent-according-to-mode'
253 Every other value means don't apply any snippet-side indentation
254 after expansion (the manual per-line \"$>\" indentation still
256 :type '(choice (const :tag "Nothing" nothing)
257 (const :tag "Fixed" fixed)
258 (const :tag "Auto" auto))
261 (defcustom yas-also-auto-indent-first-line nil
262 "Non-nil means also auto indent first line according to mode.
264 Naturally this is only valid when `yas-indent-line' is `auto'"
268 (defcustom yas-snippet-revival t
269 "Non-nil means re-activate snippet fields after undo/redo."
273 (defcustom yas-triggers-in-field nil
274 "If non-nil, allow stacked expansions (snippets inside snippets).
276 Otherwise `yas-next-field-or-maybe-expand' just moves on to the
281 (defcustom yas-fallback-behavior 'call-other-command
282 "How to act when `yas-expand' does *not* expand a snippet.
284 - `call-other-command' means try to temporarily disable YASnippet
285 and call the next command bound to whatever key was used to
288 - nil or the symbol `return-nil' mean do nothing. (and
289 `yas-expand' returns nil)
291 - A Lisp form (apply COMMAND . ARGS) means interactively call
292 COMMAND, if ARGS is non-nil, call COMMAND non-interactively
293 with ARGS as arguments."
294 :type '(choice (const :tag "Call previous command" call-other-command)
295 (const :tag "Do nothing" return-nil))
298 (defcustom yas-choose-keys-first nil
299 "If non-nil, prompt for snippet key first, then for template.
301 Otherwise prompts for all possible snippet names.
303 This affects `yas-insert-snippet' and `yas-visit-snippet-file'."
307 (defcustom yas-choose-tables-first nil
308 "If non-nil, and multiple eligible snippet tables, prompts user for tables first.
310 Otherwise, user chooses between the merging together of all
313 This affects `yas-insert-snippet', `yas-visit-snippet-file'"
317 (defcustom yas-use-menu 'abbreviate
318 "Display a YASnippet menu in the menu bar.
320 When non-nil, submenus for each snippet table will be listed
321 under the menu \"Yasnippet\".
323 - If set to `abbreviate', only the current major-mode
324 menu and the modes set in `yas--extra-modes' are listed.
326 - If set to `full', every submenu is listed
328 - If set to `nil', hide the menu.
330 Any other non-nil value, every submenu is listed."
331 :type '(choice (const :tag "Full" full)
332 (const :tag "Abbreviate" abbreviate)
333 (const :tag "No menu" nil))
336 (defcustom yas-trigger-symbol (or (and (eq window-system 'mac)
338 (char-to-string ?\x21E5))) ;; little ->| sign
340 "The text that will be used in menu to represent the trigger."
344 (defcustom yas-wrap-around-region nil
345 "If non-nil, snippet expansion wraps around selected region.
347 The wrapping occurs just before the snippet's exit marker. This
348 can be overridden on a per-snippet basis."
352 (defcustom yas-good-grace t
353 "If non-nil, don't raise errors in inline elisp evaluation.
355 An error string \"[yas] error\" is returned instead."
359 (defcustom yas-visit-from-menu nil
360 "If non-nil visit snippets's files from menu, instead of expanding them.
362 This can only work when snippets are loaded from files."
366 (defcustom yas-expand-only-for-last-commands nil
367 "List of `last-command' values to restrict tab-triggering to, or nil.
369 Leave this set at nil (the default) to be able to trigger an
370 expansion simply by placing the cursor after a valid tab trigger,
371 using whichever commands.
373 Optionally, set this to something like '(self-insert-command) if
374 you to wish restrict expansion to only happen when the last
375 letter of the snippet tab trigger was typed immediately before
376 the trigger key itself."
377 :type '(repeat function)
380 ;; Only two faces, and one of them shouldn't even be used...
382 (defface yas-field-highlight-face
383 '((t (:inherit 'region)))
384 "The face used to highlight the currently active field of a snippet"
387 (defface yas--field-debug-face
389 "The face used for debugging some overlays normally hidden"
393 ;;; User-visible variables
395 (defvar yas-keymap (let ((map (make-sparse-keymap)))
396 (define-key map [(tab)] 'yas-next-field-or-maybe-expand)
397 (define-key map (kbd "TAB") 'yas-next-field-or-maybe-expand)
398 (define-key map [(shift tab)] 'yas-prev-field)
399 (define-key map [backtab] 'yas-prev-field)
400 (define-key map (kbd "C-g") 'yas-abort-snippet)
401 (define-key map (kbd "C-d") 'yas-skip-and-clear-or-delete-char)
403 "The active keymap while a snippet expansion is in progress.")
405 (defvar yas-key-syntaxes (list "w" "w_" "w_." "w_.()"
406 #'yas-try-key-from-whitespace)
407 "Syntaxes and functions to help look for trigger keys before point.
409 Each element in this list specifies how to skip buffer positions
410 backwards and look for the start of a trigger key.
412 Each element can be either a string or a function receiving the
413 original point as an argument. A string element is simply passed
414 to `skip-syntax-backward' whereas a function element is called
415 with no arguments and should also place point before the original
418 The string between the resulting buffer position and the original
419 point is matched against the trigger keys in the active snippet
422 If no expandable snippets are found, the next element is the list
423 is tried, unless a function element returned the symbol `again',
424 in which case it is called again from the previous position and
425 may once more reposition point.
427 For example, if `yas-key-syntaxes'' value is '(\"w\" \"w_\"),
428 trigger keys composed exclusively of \"word\"-syntax characters
429 are looked for first. Failing that, longer keys composed of
430 \"word\" or \"symbol\" syntax are looked for. Therefore,
435 will, according to the \"w\" element first try \"barbaz\". If
436 that isn't a trigger key, \"foo-barbaz\" is tried, respecting the
437 second \"w_\" element. Notice that even if \"baz\" is a trigger
438 key for an active snippet, it won't be expanded, unless a
439 function is added to `yas-key-syntaxes' that eventually places
440 point between \"bar\" and \"baz\".
442 See also Info node `(elisp) Syntax Descriptors'.")
444 (defvar yas-after-exit-snippet-hook
446 "Hooks to run after a snippet exited.
448 The hooks will be run in an environment where some variables bound to
451 `yas-snippet-beg' : The beginning of the region of the snippet.
453 `yas-snippet-end' : Similar to beg.
455 Attention: These hooks are not run when exiting nested/stacked snippet expansion!")
457 (defvar yas-before-expand-snippet-hook
459 "Hooks to run just before expanding a snippet.")
461 (defvar yas-buffer-local-condition
462 '(if (and (or (fourth (syntax-ppss))
463 (fifth (syntax-ppss)))
465 (eq this-command 'yas-expand-from-trigger-key))
466 '(require-snippet-condition . force-in-comment)
468 "Snippet expanding condition.
470 This variable is a Lisp form which is evaluated every time a
471 snippet expansion is attempted:
473 * If it evaluates to nil, no snippets can be expanded.
475 * If it evaluates to the a cons (require-snippet-condition
478 * Snippets bearing no \"# condition:\" directive are not
481 * Snippets bearing conditions that evaluate to nil (or
482 produce an error) won't be considered.
484 * If the snippet has a condition that evaluates to non-nil
487 * If REQUIREMENT is t, the snippet is considered
489 * If REQUIREMENT is `eq' RESULT, the snippet is
492 * Otherwise, the snippet is not considered.
494 * If it evaluates to the symbol 'always, all snippets are
495 considered for expansion, regardless of any conditions.
497 * If it evaluates to t or some other non-nil value
499 * Snippet bearing no conditions, or conditions that
500 evaluate to non-nil, are considered for expansion.
502 * Otherwise, the snippet is not considered.
504 Here's an example preventing snippets from being expanded from
505 inside comments, in `python-mode' only, with the exception of
506 snippets returning the symbol 'force-in-comment in their
509 (add-hook 'python-mode-hook
511 (setq yas-buffer-local-condition
512 '(if (python-in-string/comment)
513 '(require-snippet-condition . force-in-comment)
516 The default value is similar, it filters out potential snippet
517 expansions inside comments and string literals, unless the
518 snippet itself contains a condition that returns the symbol
519 `force-in-comment'.")
522 ;;; Internal variables
524 (defvar yas--version "0.8.0beta")
526 (defvar yas--menu-table (make-hash-table)
527 "A hash table of MAJOR-MODE symbols to menu keymaps.")
529 (defvar yas--known-modes
530 '(ruby-mode rst-mode markdown-mode)
531 "A list of mode which is well known but not part of Emacs.")
533 (defvar yas--escaped-characters
534 '(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
535 "List of characters which *might* need to be escaped.")
537 (defconst yas--field-regexp
538 "${\\([0-9]+:\\)?\\([^}]*\\)}"
539 "A regexp to *almost* recognize a field.")
541 (defconst yas--multi-dollar-lisp-expression-regexp
542 "$+[ \t\n]*\\(([^)]*)\\)"
543 "A regexp to *almost* recognize a \"$(...)\" expression.")
545 (defconst yas--backquote-lisp-expression-regexp
547 "A regexp to recognize a \"`lisp-expression`\" expression." )
549 (defconst yas--transform-mirror-regexp
550 "${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
551 "A regexp to *almost* recognize a mirror with a transform.")
553 (defconst yas--simple-mirror-regexp
555 "A regexp to recognize a simple mirror.")
557 (defvar yas--snippet-id-seed 0
558 "Contains the next id for a snippet.")
560 (defun yas--snippet-next-id ()
561 (let ((id yas--snippet-id-seed))
562 (cl-incf yas--snippet-id-seed)
568 ;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
569 (defvar last-buffer-undo-list nil)
571 (defvar yas--minor-mode-menu nil
572 "Holds the YASnippet menu.")
574 (defvar yas-minor-mode-map
575 (let ((map (make-sparse-keymap)))
576 (define-key map [(tab)] 'yas-expand)
577 (define-key map (kbd "TAB") 'yas-expand)
578 (define-key map "\C-c&\C-s" 'yas-insert-snippet)
579 (define-key map "\C-c&\C-n" 'yas-new-snippet)
580 (define-key map "\C-c&\C-v" 'yas-visit-snippet-file)
582 "The keymap used when `yas-minor-mode' is active.")
584 (easy-menu-define yas--minor-mode-menu
586 "Menu used when `yas-minor-mode' is active."
587 '("YASnippet" :visible yas-use-menu
589 ["Expand trigger" yas-expand
590 :help "Possibly expand tab trigger before point"]
591 ["Insert at point..." yas-insert-snippet
592 :help "Prompt for an expandable snippet and expand it at point"]
593 ["New snippet..." yas-new-snippet
594 :help "Create a new snippet in an appropriate directory"]
595 ["Visit snippet file..." yas-visit-snippet-file
596 :help "Prompt for an expandable snippet and find its file"]
598 ("Snippet menu behaviour"
599 ["Visit snippets" (setq yas-visit-from-menu t)
600 :help "Visit snippets from the menu"
601 :active t :style radio :selected yas-visit-from-menu]
602 ["Expand snippets" (setq yas-visit-from-menu nil)
603 :help "Expand snippets from the menu"
604 :active t :style radio :selected (not yas-visit-from-menu)]
606 ["Show all known modes" (setq yas-use-menu 'full)
607 :help "Show one snippet submenu for each loaded table"
608 :active t :style radio :selected (eq yas-use-menu 'full)]
609 ["Abbreviate according to current mode" (setq yas-use-menu 'abbreviate)
610 :help "Show only snippet submenus for the current active modes"
611 :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
613 ["Auto" (setq yas-indent-line 'auto)
614 :help "Indent each line of the snippet with `indent-according-to-mode'"
615 :active t :style radio :selected (eq yas-indent-line 'auto)]
616 ["Fixed" (setq yas-indent-line 'fixed)
617 :help "Indent the snippet to the current column"
618 :active t :style radio :selected (eq yas-indent-line 'fixed)]
619 ["None" (setq yas-indent-line 'none)
620 :help "Don't apply any particular snippet indentation after expansion"
621 :active t :style radio :selected (not (member yas-indent-line '(fixed auto)))]
623 ["Also auto indent first line" (setq yas-also-auto-indent-first-line
624 (not yas-also-auto-indent-first-line))
625 :help "When auto-indenting also, auto indent the first line menu"
626 :active (eq yas-indent-line 'auto)
627 :style toggle :selected yas-also-auto-indent-first-line]
630 ["System X-widget" (setq yas-prompt-functions
632 (remove 'yas-x-prompt
633 yas-prompt-functions)))
634 :help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
635 :active t :style radio :selected (eq (car yas-prompt-functions)
637 ["Dropdown-list" (setq yas-prompt-functions
638 (cons 'yas-dropdown-prompt
639 (remove 'yas-dropdown-prompt
640 yas-prompt-functions)))
641 :help "Use a special dropdown list"
642 :active t :style radio :selected (eq (car yas-prompt-functions)
643 'yas-dropdown-prompt)]
644 ["Ido" (setq yas-prompt-functions
645 (cons 'yas-ido-prompt
646 (remove 'yas-ido-prompt
647 yas-prompt-functions)))
648 :help "Use an ido-style minibuffer prompt"
649 :active t :style radio :selected (eq (car yas-prompt-functions)
651 ["Completing read" (setq yas-prompt-functions
652 (cons 'yas-completing-prompt
653 (remove 'yas-completing-prompt
654 yas-prompt-functions)))
655 :help "Use a normal minibuffer prompt"
656 :active t :style radio :selected (eq (car yas-prompt-functions)
657 'yas-completing-prompt)]
660 ["Wrap region in exit marker"
661 (setq yas-wrap-around-region
662 (not yas-wrap-around-region))
663 :help "If non-nil automatically wrap the selected text in the $0 snippet exit"
664 :style toggle :selected yas-wrap-around-region]
665 ["Allow stacked expansions "
666 (setq yas-triggers-in-field
667 (not yas-triggers-in-field))
668 :help "If non-nil allow snippets to be triggered inside other snippet fields"
669 :style toggle :selected yas-triggers-in-field]
670 ["Revive snippets on undo "
671 (setq yas-snippet-revival
672 (not yas-snippet-revival))
673 :help "If non-nil allow snippets to become active again after undo"
674 :style toggle :selected yas-snippet-revival]
677 (not yas-good-grace))
678 :help "If non-nil don't raise errors in bad embedded elisp in snippets"
679 :style toggle :selected yas-good-grace]
682 ["Load snippets..." yas-load-directory
683 :help "Load snippets from a specific directory"]
684 ["Reload everything" yas-reload-all
685 :help "Cleanup stuff, reload snippets, rebuild menus"]
687 :help "Display some information about YASnippet"]))
689 (defvar yas--extra-modes nil
690 "An internal list of modes for which to also lookup snippets.
692 This variable probably makes more sense as buffer-local, so
693 ensure your use `make-local-variable' when you set it.")
694 (define-obsolete-variable-alias 'yas-extra-modes 'yas--extra-modes "0.8.1")
696 (defvar yas--tables (make-hash-table)
697 "A hash table of mode symbols to `yas--table' objects.")
699 (defvar yas--parents (make-hash-table)
700 "A hash table of mode symbols do lists of direct parent mode symbols.
702 This list is populated when reading the \".yas-parents\" files
703 found when traversing snippet directories with
704 `yas-load-directory'.
706 There might be additional parenting information stored in the
707 `derived-mode-parent' property of some mode symbols, but that is
710 (defvar yas--direct-keymaps (list)
711 "Keymap alist supporting direct snippet keybindings.
713 This variable is placed in `emulation-mode-map-alists'.
715 Its elements looks like (TABLE-NAME . KEYMAP). They're
716 instantiated on `yas-reload-all' but KEYMAP is added to only when
717 loading snippets. `yas--direct-TABLE-NAME' is then a variable set
718 buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
719 defined direct keybindings to the command
720 `yas-expand-from-keymap' which then which snippet to expand.")
722 (defun yas-direct-keymaps-reload ()
723 "Force reload the direct keybinding for active snippet tables."
725 (setq yas--direct-keymaps nil)
726 (maphash #'(lambda (name table)
727 (push (cons (intern (format "yas--direct-%s" name))
728 (yas--table-direct-keymap table))
729 yas--direct-keymaps))
732 (defun yas--modes-to-activate ()
733 "Compute list of mode symbols that are active for `yas-expand'
736 (setq dfs (lambda (mode &optional explored)
740 in (cl-list* (get mode 'derived-mode-parent)
741 (ignore-errors (symbol-function mode))
742 (gethash mode yas--parents))
744 (not (memq neighbour explored))
746 append (funcall dfs neighbour explored)))))
747 (remove-duplicates (append yas--extra-modes
748 (funcall dfs major-mode)))))
750 (defvar yas-minor-mode-hook nil
751 "Hook run when `yas-minor-mode' is turned on.")
754 (define-minor-mode yas-minor-mode
755 "Toggle YASnippet mode.
757 When YASnippet mode is enabled, `yas-expand', normally bound to
758 the TAB key, expands snippets of code depending on the major
761 With no argument, this command toggles the mode.
762 positive prefix argument turns on the mode.
763 Negative prefix argument turns off the mode.
766 \\{yas-minor-mode-map}"
768 ;; The indicator for the mode line.
771 (cond (yas-minor-mode
772 ;; Install the direct keymaps in `emulation-mode-map-alists'
773 ;; (we use `add-hook' even though it's not technically a hook,
774 ;; but it works). Then define variables named after modes to
775 ;; index `yas--direct-keymaps'.
777 ;; Also install the post-command-hook.
779 (add-hook 'emulation-mode-map-alists 'yas--direct-keymaps)
780 (add-hook 'post-command-hook 'yas--post-command-handler nil t)
781 ;; Set the `yas--direct-%s' vars for direct keymap expansion
783 (dolist (mode (yas--modes-to-activate))
784 (let ((name (intern (format "yas--direct-%s" mode))))
785 (set-default name nil)
786 (set (make-local-variable name) t)))
789 (yas--load-pending-jits))
791 ;; Uninstall the direct keymaps and the post-command hook
793 (remove-hook 'post-command-hook 'yas--post-command-handler t)
794 (remove-hook 'emulation-mode-map-alists 'yas--direct-keymaps))))
796 (defun yas-activate-extra-mode (mode)
797 "Activates the snippets for the given `mode' in the buffer.
799 The function can be called in the hook of a minor mode to
800 activate snippets associated with that mode."
804 (maphash (lambda (k _)
805 (setq modes (cons (list k) modes)))
807 (setq symbol (completing-read
808 "Activate mode: " modes nil t))
810 (when (not (string= "" symbol))
813 (add-to-list (make-local-variable 'yas--extra-modes) mode)
814 (yas--load-pending-jits)))
816 (defun yas-deactivate-extra-mode (mode)
817 "Deactivates the snippets for the given `mode' in the buffer."
821 "Deactivate mode: " (mapcar #'list yas--extra-modes) nil t))))
822 (set (make-local-variable 'yas--extra-modes)
826 (defvar yas-dont-activate '(minibufferp)
827 "If non-nil don't let `yas-global-mode' affect some buffers.
829 If a function of zero arguments, then its result is used.
831 If a list of functions, then all functions must return nil to
832 activate yas for this buffer.
834 In Emacsen <= 23, this variable is buffer-local. Because
835 `yas-minor-mode-on' is called by `yas-global-mode' after
836 executing the buffer's major mode hook, setting this variable
837 there is an effective way to define exceptions to the \"global\"
838 activation behaviour.
840 In Emacsen > 23, only the global value is used. To define
841 per-mode exceptions to the \"global\" activation behaviour, call
842 `yas-minor-mode' with a negative argument directily in the major
844 (unless (> emacs-major-version 23)
846 (make-variable-buffer-local 'yas-dont-activate)))
849 (defun yas-minor-mode-on ()
850 "Turn on YASnippet minor mode.
852 Honour `yas-dont-activate', which see."
854 ;; Check `yas-dont-activate'
855 (unless (cond ((functionp yas-dont-activate)
856 (funcall yas-dont-activate))
857 ((consp yas-dont-activate)
858 (some #'funcall yas-dont-activate))
863 (define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
867 (defun yas--global-mode-reload-with-jit-maybe ()
868 "Run `yas-reload-all' when `yas-global-mode' is on."
869 (when yas-global-mode (yas-reload-all)))
871 (add-hook 'yas-global-mode-hook 'yas--global-mode-reload-with-jit-maybe)
876 (defvar yas--font-lock-keywords
877 (append '(("^#.*$" . font-lock-comment-face))
878 lisp-font-lock-keywords-2
880 (0 font-lock-keyword-face)
881 (1 font-lock-string-face t))
883 (0 font-lock-keyword-face)
884 (1 font-lock-warning-face t))
885 ("${" . font-lock-keyword-face)
886 ("$[0-9]+?" . font-lock-preprocessor-face)
887 ("\\(\\$(\\)" 1 font-lock-preprocessor-face)
889 (0 font-lock-keyword-face)))))
891 (defvar snippet-mode-map
892 (let ((map (make-sparse-keymap)))
893 (easy-menu-define nil
895 "Menu used when snippet-mode is active."
897 (mapcar #'(lambda (ent)
899 (define-key map (third ent) (second ent)))
900 (vector (first ent) (second ent) t))
901 '(("Load this snippet" yas-load-snippet-buffer "\C-c\C-l")
902 ("Load and quit window" yas-load-snippet-buffer-and-close "\C-c\C-c")
903 ("Try out this snippet" yas-tryout-snippet "\C-c\C-t")))))
905 "The keymap used when `snippet-mode' is active.")
908 (define-derived-mode snippet-mode text-mode "Snippet"
909 "A mode for editing yasnippets"
910 (setq font-lock-defaults '(yas--font-lock-keywords))
911 (set (make-local-variable 'require-final-newline) nil)
912 (set (make-local-variable 'comment-start) "#")
913 (set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
917 ;;; Internal structs for template management
919 (defstruct (yas--template (:constructor yas--make-blank-template))
920 "A template for a snippet."
930 group ;; as dictated by the #group: directive or .yas-make-groups
931 perm-group ;; as dictated by `yas-define-menu'
935 (defun yas--populate-template (template &rest args)
936 "Helper function to populate TEMPLATE with properties."
939 (position (intern (substring (symbol-name (car args)) 1))
940 (mapcar #'car (get 'yas--template 'cl-struct-slots)))
942 (setq args (cddr args)))
945 (defstruct (yas--table (:constructor yas--make-snippet-table (name)))
946 "A table to store snippets for a particular mode.
948 Has the following fields:
952 A symbol name normally corresponding to a major mode, but can
953 also be a pseudo major-mode to be used in
954 `yas-activate-extra-mode', for example.
958 A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
959 a string or a vector, where the former is the snippet's trigger
960 and the latter means it's a direct keybinding. NAMEHASH is yet
961 another hash of (NAME . TEMPLATE) where NAME is the snippet's
962 name and TEMPLATE is a `yas--template' object.
964 `yas--table-direct-keymap'
966 A keymap for the snippets in this table that have direct
967 keybindings. This is kept in sync with the keyhash, i.e., all
968 the elements of the keyhash that are vectors appear here as
969 bindings to `yas-expand-from-keymap'.
971 `yas--table-uuidhash'
973 A hash table mapping snippets uuid's to the same `yas--template'
974 objects. A snippet uuid defaults to the snippet's name."
976 (hash (make-hash-table :test 'equal))
977 (uuidhash (make-hash-table :test 'equal))
979 (direct-keymap (make-sparse-keymap)))
981 (defun yas--get-template-by-uuid (mode uuid)
982 "Find the snippet template in MODE by its UUID."
983 (let* ((table (gethash mode yas--tables mode)))
985 (gethash uuid (yas--table-uuidhash table)))))
987 ;; Apropos storing/updating in TABLE, this works in two steps:
989 ;; 1. `yas--remove-template-by-uuid' removes any
990 ;; keyhash-namehash-template mappings from TABLE, grabbing the
991 ;; snippet by its uuid. Also removes mappings from TABLE's
992 ;; `yas--table-direct-keymap' (FIXME: and should probably take care
993 ;; of potentially stale menu bindings right?.)
995 ;; 2. `yas--add-template' adds this all over again.
997 ;; Create a new or add to an existing keyhash-namehash mapping.
999 ;; For reference on understanding this, consider three snippet
1002 ;; A: # name: The Foo
1004 ;; # binding: C-c M-l
1006 ;; B: # name: Mrs Foo
1009 ;; C: # name: The Bar
1010 ;; # binding: C-c M-l
1015 ;; keyhash namehashes(3) yas--template structs(4)
1016 ;; -----------------------------------------------------
1019 ;; "foo" ---> "The Foo" ---> [yas--template A] |
1020 ;; "Mrs Foo" ---> [yas--template B] |
1022 ;; [C-c M-l] ---> "The Foo" -------------------------/
1023 ;; "The Bar" ---> [yas--template C]
1025 ;; "baz" ---> "Baz" ---> [yas--template D]
1027 ;; Additionally, since uuid defaults to the name, we have a
1028 ;; `yas--table-uuidhash' for TABLE
1030 ;; uuidhash yas--template structs
1031 ;; -------------------------------
1032 ;; "The Foo" ---> [yas--template A]
1033 ;; "Mrs Foo" ---> [yas--template B]
1034 ;; "The Bar" ---> [yas--template C]
1035 ;; "Baz" ---> [yas--template D]
1037 ;; FIXME: the more I look at this data-structure the more I think I'm
1038 ;; stupid. There has to be an easier way (but beware lots of code
1039 ;; depends on this).
1041 (defun yas--remove-template-by-uuid (table uuid)
1042 "Remove from TABLE a template identified by UUID."
1043 (let ((template (gethash uuid (yas--table-uuidhash table))))
1045 (let* ((name (yas--template-name template))
1047 ;; Remove the name from each of the targeted namehashes
1049 (maphash #'(lambda (k v)
1050 (let ((template (gethash name v)))
1052 (eq uuid (yas--template-uuid template)))
1054 (when (zerop (hash-table-count v))
1055 (push k empty-keys)))))
1056 (yas--table-hash table))
1057 ;; Remove the namehash themselves if they've become empty
1059 (dolist (key empty-keys)
1061 (define-key (yas--table-direct-keymap table) key nil))
1062 (remhash key (yas--table-hash table)))
1064 ;; Finally, remove the uuid from the uuidhash
1066 (remhash uuid (yas--table-uuidhash table))))))
1068 (defun yas--add-template (table template)
1069 "Store in TABLE the snippet template TEMPLATE.
1071 KEY can be a string (trigger key) of a vector (direct
1073 (let ((name (yas--template-name template))
1074 (key (yas--template-key template))
1075 (keybinding (yas--template-keybinding template))
1076 (_menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
1077 (dolist (k (remove nil (list key keybinding)))
1081 (yas--table-hash table))
1083 (make-hash-table :test 'equal)
1084 (yas--table-hash table))))
1086 (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
1088 ;; Update TABLE's `yas--table-uuidhash'
1089 (puthash (yas--template-uuid template)
1091 (yas--table-uuidhash table))))
1093 (defun yas--update-template (table template)
1094 "Add or update TEMPLATE in TABLE.
1096 Also takes care of adding and updating to the associated menu."
1097 ;; Remove from table by uuid
1099 (yas--remove-template-by-uuid table (yas--template-uuid template))
1100 ;; Add to table again
1102 (yas--add-template table template)
1103 ;; Take care of the menu
1105 (yas--update-template-menu table template))
1107 (defun yas--update-template-menu (table template)
1108 "Update every menu-related for TEMPLATE."
1109 (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
1110 (key (yas--template-key template))
1111 (keybinding (yas--template-keybinding template)))
1112 ;; The snippet might have changed name or keys, so update
1113 ;; user-visible strings
1115 (unless (eq (cdr menu-binding-pair) :none)
1116 ;; the menu item name
1118 (setf (cadar menu-binding-pair) (yas--template-name template))
1119 ;; the :keys information (also visible to the user)
1120 (setf (getf (cdr (car menu-binding-pair)) :keys)
1121 (or (and keybinding (key-description keybinding))
1122 (and key (concat key yas-trigger-symbol))))))
1123 (unless (yas--template-menu-managed-by-yas-define-menu template)
1125 (yas--menu-keymap-get-create (yas--table-mode table)
1126 (mapcar #'yas--table-mode
1127 (yas--table-parents table))))
1128 (group (yas--template-group template)))
1129 ;; Remove from menu keymap
1131 (assert menu-keymap)
1132 (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
1134 ;; Add necessary subgroups as necessary.
1136 (dolist (subgroup group)
1137 (let ((subgroup-keymap (lookup-key menu-keymap (vector (make-symbol subgroup)))))
1138 (unless (and subgroup-keymap
1139 (keymapp subgroup-keymap))
1140 (setq subgroup-keymap (make-sparse-keymap))
1141 (define-key menu-keymap (vector (make-symbol subgroup))
1142 `(menu-item ,subgroup ,subgroup-keymap)))
1143 (setq menu-keymap subgroup-keymap)))
1145 ;; Add this entry to the keymap
1147 (define-key menu-keymap
1148 (vector (make-symbol (yas--template-uuid template)))
1149 (car (yas--template-menu-binding-pair template))))))
1151 (defun yas--namehash-templates-alist (namehash)
1152 "Return NAMEHASH as an alist."
1154 (maphash #'(lambda (k v)
1155 (push (cons k v) alist))
1159 (defun yas--fetch (table key)
1160 "Fetch templates in TABLE by KEY.
1162 Return a list of cons (NAME . TEMPLATE) where NAME is a
1163 string and TEMPLATE is a `yas--template' structure."
1164 (let* ((keyhash (yas--table-hash table))
1165 (namehash (and keyhash (gethash key keyhash))))
1167 (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
1170 ;;; Filtering/condition logic
1172 (defun yas--eval-condition (condition)
1179 (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
1183 (defun yas--filter-templates-by-condition (templates)
1184 "Filter the templates using the applicable condition.
1186 TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
1187 string and TEMPLATE is a `yas--template' structure.
1189 This function implements the rules described in
1190 `yas-buffer-local-condition'. See that variables documentation."
1191 (let ((requirement (yas--require-template-specific-condition-p)))
1192 (if (eq requirement 'always)
1194 (remove-if-not #'(lambda (pair)
1195 (yas--template-can-expand-p
1196 (yas--template-condition (cdr pair)) requirement))
1199 (defun yas--require-template-specific-condition-p ()
1200 "Decide if this buffer requests/requires snippet-specific
1201 conditions to filter out potential expansions."
1202 (if (eq 'always yas-buffer-local-condition)
1204 (let ((local-condition (or (and (consp yas-buffer-local-condition)
1205 (yas--eval-condition yas-buffer-local-condition))
1206 yas-buffer-local-condition)))
1207 (when local-condition
1208 (if (eq local-condition t)
1210 (and (consp local-condition)
1211 (eq 'require-snippet-condition (car local-condition))
1212 (symbolp (cdr local-condition))
1213 (cdr local-condition)))))))
1215 (defun yas--template-can-expand-p (condition requirement)
1216 "Evaluate CONDITION and REQUIREMENT and return a boolean."
1217 (let* ((result (or (null condition)
1218 (yas--eval-condition condition))))
1219 (cond ((eq requirement t)
1222 (eq requirement result)))))
1224 (defun yas--table-templates (table)
1227 (maphash #'(lambda (_key namehash)
1228 (maphash #'(lambda (name template)
1229 (push (cons name template) acc))
1231 (yas--table-hash table))
1232 (yas--filter-templates-by-condition acc))))
1234 (defun yas--templates-for-key-at-point ()
1235 "Find `yas--template' objects for any trigger keys preceding point.
1236 Returns (TEMPLATES START END). This function respects
1237 `yas-key-syntaxes', which see."
1239 (let ((original (point))
1240 (methods yas-key-syntaxes)
1245 (unless (eq method (car methods))
1246 ;; TRICKY: `eq'-ness test means we can only be here if
1247 ;; `method' is a function that returned `again', and hence
1248 ;; don't revert back to original position as per
1249 ;; `yas-key-syntaxes'.
1250 (goto-char original))
1251 (setq method (car methods))
1252 (cond ((stringp method)
1253 (skip-syntax-backward method)
1254 (setq methods (cdr methods)))
1256 (unless (eq (funcall method original)
1258 (setq methods (cdr methods))))
1260 (yas--warning "Warning invalid element %s in `yas-key-syntaxes'" method)))
1261 (let ((possible-key (buffer-substring-no-properties (point) original)))
1263 (goto-char original)
1265 (mapcan #'(lambda (table)
1266 (yas--fetch table possible-key))
1267 (yas--get-snippet-tables))))))
1269 (list templates (point) original)))))
1271 (defun yas--table-all-keys (table)
1272 "Get trigger keys of all active snippets in TABLE."
1274 (maphash #'(lambda (key namehash)
1275 (when (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash))
1277 (yas--table-hash table))
1280 (defun yas--table-mode (table)
1281 (intern (yas--table-name table)))
1284 ;;; Internal functions and macros:
1286 (defun yas--real-mode? (mode)
1287 "Try to find out if MODE is a real mode.
1289 The MODE bound to a function (like `c-mode') is considered real
1290 mode. Other well known mode like `ruby-mode' which is not part of
1291 Emacs might not bound to a function until it is loaded. So
1292 yasnippet keeps a list of modes like this to help the judgment."
1294 (find mode yas--known-modes)))
1296 (defun yas--handle-error (err)
1297 "Handle error depending on value of `yas-good-grace'."
1298 (let ((msg (yas--format "elisp error: %s" (error-message-string err))))
1299 (if yas-good-grace msg
1302 (defun yas--eval-lisp (form)
1303 "Evaluate FORM and convert the result to string."
1304 (let ((retval (catch 'yas--exception
1310 (let ((result (eval form)))
1312 (format "%s" result))))))
1313 (error (yas--handle-error err))))))
1314 (when (and (consp retval)
1315 (eq 'yas--exception (car retval)))
1316 (error (cdr retval)))
1319 (defun yas--eval-lisp-no-saves (form)
1322 (error (message "%s" (yas--handle-error err)))))
1324 (defun yas--read-lisp (string &optional nil-on-error)
1325 "Read STRING as a elisp expression and return it.
1327 In case STRING in an invalid expression and NIL-ON-ERROR is nil,
1328 return an expression that when evaluated will issue an error."
1331 (error (and (not nil-on-error)
1332 `(error (error-message-string ,err))))))
1334 (defun yas--read-keybinding (keybinding)
1335 "Read KEYBINDING as a snippet keybinding, return a vector."
1336 (when (and keybinding
1337 (not (string-match "keybinding" keybinding)))
1339 (let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
1341 (read-kbd-macro keybinding 'need-vector))))
1344 (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
1345 keybinding (error-message-string err))
1348 (defun yas--table-get-create (mode)
1349 "Get or create the snippet table corresponding to MODE."
1350 (let ((table (gethash mode
1353 (setq table (yas--make-snippet-table (symbol-name mode)))
1354 (puthash mode table yas--tables)
1355 (push (cons (intern (format "yas--direct-%s" mode))
1356 (yas--table-direct-keymap table))
1357 yas--direct-keymaps))
1360 (defun yas--get-snippet-tables ()
1361 "Get snippet tables for current buffer.
1363 Return a list of `yas--table' objects. The list of modes to
1364 consider is returned by `yas--modes-to-activate'"
1366 (mapcar #'(lambda (name)
1367 (gethash name yas--tables))
1368 (yas--modes-to-activate))))
1370 (defun yas--menu-keymap-get-create (mode &optional parents)
1371 "Get or create the menu keymap for MODE and its PARENTS.
1373 This may very well create a plethora of menu keymaps and arrange
1374 them all in `yas--menu-table'"
1375 (let* ((menu-keymap (or (gethash mode yas--menu-table)
1376 (puthash mode (make-sparse-keymap) yas--menu-table))))
1377 (mapc #'yas--menu-keymap-get-create parents)
1378 (define-key yas--minor-mode-menu (vector mode)
1379 `(menu-item ,(symbol-name mode) ,menu-keymap
1380 :visible (yas--show-menu-p ',mode)))
1384 (defmacro yas--called-interactively-p (&optional kind)
1385 "A backward-compatible version of `called-interactively-p'.
1387 Optional KIND is as documented at `called-interactively-p'
1388 in GNU Emacs 24.1 or higher."
1389 (if (string< emacs-version "24.1")
1390 '(called-interactively-p)
1391 `(called-interactively-p ,kind)))
1394 ;;; Template-related and snippet loading functions
1396 (defun yas--parse-template (&optional file)
1397 "Parse the template in the current buffer.
1399 Optional FILE is the absolute file name of the file being
1402 Optional GROUP is the group where the template is to go,
1403 otherwise we attempt to calculate it from FILE.
1405 Return a snippet-definition, i.e. a list
1407 (KEY TEMPLATE NAME CONDITION GROUP VARS FILE KEYBINDING UUID)
1409 If the buffer contains a line of \"# --\" then the contents above
1410 this line are ignored. Directives can set most of these with the syntax:
1412 # directive-name : directive-value
1414 Here's a list of currently recognized directives:
1425 (goto-char (point-min))
1426 (let* ((type 'snippet)
1428 (file-name-nondirectory file)))
1434 (yas--calculate-group file)))
1438 (if (re-search-forward "^# --\n" nil t)
1439 (progn (setq template
1440 (buffer-substring-no-properties (point)
1442 (setq bound (point))
1443 (goto-char (point-min))
1444 (while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*\\)$" bound t)
1445 (when (string= "uuid" (match-string-no-properties 1))
1446 (setq uuid (match-string-no-properties 2)))
1447 (when (string= "type" (match-string-no-properties 1))
1448 (setq type (if (string= "command" (match-string-no-properties 2))
1451 (when (string= "key" (match-string-no-properties 1))
1452 (setq key (match-string-no-properties 2)))
1453 (when (string= "name" (match-string-no-properties 1))
1454 (setq name (match-string-no-properties 2)))
1455 (when (string= "condition" (match-string-no-properties 1))
1456 (setq condition (yas--read-lisp (match-string-no-properties 2))))
1457 (when (string= "group" (match-string-no-properties 1))
1458 (setq group (match-string-no-properties 2)))
1459 (when (string= "expand-env" (match-string-no-properties 1))
1460 (setq expand-env (yas--read-lisp (match-string-no-properties 2)
1462 (when (string= "binding" (match-string-no-properties 1))
1463 (setq binding (match-string-no-properties 2)))))
1465 (buffer-substring-no-properties (point-min) (point-max))))
1466 (unless (or key binding)
1467 (setq key (and file (file-name-nondirectory file))))
1468 (when (eq type 'command)
1469 (setq template (yas--read-lisp (concat "(progn" template ")"))))
1471 (setq group (split-string group "\\.")))
1472 (list key template name condition group expand-env file binding uuid)))
1474 (defun yas--calculate-group (file)
1475 "Calculate the group for snippet file path FILE."
1476 (let* ((dominating-dir (locate-dominating-file file
1477 ".yas-make-groups"))
1478 (extra-path (and dominating-dir
1479 (replace-regexp-in-string (concat "^"
1480 (expand-file-name dominating-dir))
1482 (expand-file-name file))))
1483 (extra-dir (and extra-path
1484 (file-name-directory extra-path)))
1485 (group (and extra-dir
1486 (replace-regexp-in-string "/"
1488 (directory-file-name extra-dir)))))
1491 (defun yas--subdirs (directory &optional filep)
1492 "Return subdirs or files of DIRECTORY according to FILEP."
1493 (remove-if (lambda (file)
1494 (or (string-match "^\\."
1495 (file-name-nondirectory file))
1496 (string-match "^#.*#$"
1497 (file-name-nondirectory file))
1499 (file-name-nondirectory file))
1501 (file-directory-p file)
1502 (not (file-directory-p file)))))
1503 (directory-files directory t)))
1505 (defun yas--make-menu-binding (template)
1506 (let ((mode (yas--table-mode (yas--template-table template))))
1507 `(lambda () (interactive) (yas--expand-or-visit-from-menu ',mode ,(yas--template-uuid template)))))
1509 (defun yas--expand-or-visit-from-menu (mode uuid)
1510 (let* ((table (yas--table-get-create mode))
1511 (yas--current-template (and table
1512 (gethash uuid (yas--table-uuidhash table)))))
1513 (when yas--current-template
1514 (if yas-visit-from-menu
1515 (yas--visit-snippet-file-1 yas--current-template)
1516 (let ((where (if (region-active-p)
1517 (cons (region-beginning) (region-end))
1518 (cons (point) (point)))))
1519 (yas-expand-snippet (yas--template-content yas--current-template)
1522 (yas--template-expand-env yas--current-template)))))))
1524 (defun yas--key-from-desc (text)
1525 "Return a yasnippet key from a description string TEXT."
1526 (replace-regexp-in-string "\\(\\w+\\).*" "\\1" text))
1529 ;;; Popping up for keys and templates
1531 (defun yas--prompt-for-template (templates &optional prompt)
1532 "Interactively choose a template from the list TEMPLATES.
1534 TEMPLATES is a list of `yas--template'.
1536 Optional PROMPT sets the prompt to use."
1539 (sort templates #'(lambda (t1 t2)
1540 (< (length (yas--template-name t1))
1541 (length (yas--template-name t2))))))
1542 (some #'(lambda (fn)
1543 (funcall fn (or prompt "Choose a snippet: ")
1545 #'yas--template-name))
1546 yas-prompt-functions)))
1548 (defun yas--prompt-for-keys (keys &optional prompt)
1549 "Interactively choose a template key from the list KEYS.
1551 Optional PROMPT sets the prompt to use."
1553 (some #'(lambda (fn)
1554 (funcall fn (or prompt "Choose a snippet key: ") keys))
1555 yas-prompt-functions)))
1557 (defun yas--prompt-for-table (tables &optional prompt)
1558 "Interactively choose a table from the list TABLES.
1560 Optional PROMPT sets the prompt to use."
1562 (some #'(lambda (fn)
1563 (funcall fn (or prompt "Choose a snippet table: ")
1566 yas-prompt-functions)))
1568 (defun yas-x-prompt (prompt choices &optional display-fn)
1569 "Display choices in a x-window prompt."
1570 (when (and window-system choices)
1573 (if (fboundp 'posn-at-point)
1574 (let ((x-y (posn-x-y (posn-at-point (point)))))
1575 (list (list (+ (car x-y) 10)
1580 ,@(mapcar* (lambda (c d) `(,(concat " " d) . ,c))
1582 (if display-fn (mapcar display-fn choices) choices)))))
1585 (defun yas-ido-prompt (prompt choices &optional display-fn)
1586 (when (and (fboundp 'ido-completing-read)
1587 (or (>= emacs-major-version 24)
1589 (yas-completing-prompt prompt choices display-fn #'ido-completing-read)))
1591 (defun yas-dropdown-prompt (_prompt choices &optional display-fn)
1592 (when (fboundp 'dropdown-list)
1593 (let* ((formatted-choices
1594 (if display-fn (mapcar display-fn choices) choices))
1595 (n (dropdown-list formatted-choices)))
1596 (if n (nth n choices)
1599 (defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
1600 (let* ((formatted-choices
1601 (if display-fn (mapcar display-fn choices) choices))
1602 (chosen (funcall (or completion-fn #'completing-read)
1603 prompt formatted-choices
1604 nil 'require-match nil nil)))
1605 (if (eq choices formatted-choices)
1607 (nth (or (position chosen formatted-choices :test #'string=) 0)
1610 (defun yas-no-prompt (_prompt choices &optional _display-fn)
1614 ;;; Defining snippets
1615 ;; This consists of creating and registering `yas--template' objects in the
1619 (defvar yas--creating-compiled-snippets nil)
1621 (defun yas--define-snippets-1 (snippet snippet-table)
1622 "Helper for `yas-define-snippets'."
1623 ;; X) Calculate some more defaults on the values returned by
1624 ;; `yas--parse-template'.
1626 (let* ((file (seventh snippet))
1628 (name (or (third snippet)
1630 (file-name-directory file))))
1631 (condition (fourth snippet))
1632 (group (fifth snippet))
1633 (keybinding (yas--read-keybinding (eighth snippet)))
1634 (uuid (or (ninth snippet)
1636 (template (or (gethash uuid (yas--table-uuidhash snippet-table))
1637 (yas--make-blank-template))))
1638 ;; X) populate the template object
1640 (yas--populate-template template
1641 :table snippet-table
1643 :content (second snippet)
1646 :condition condition
1647 :expand-env (sixth snippet)
1648 :file (seventh snippet)
1649 :keybinding keybinding
1651 ;; X) Update this template in the appropriate table. This step
1652 ;; also will take care of adding the key indicators in the
1653 ;; templates menu entry, if any
1655 (yas--update-template snippet-table template)
1656 ;; X) Return the template
1661 (defun yas-define-snippets (mode snippets)
1662 "Define SNIPPETS for MODE.
1664 SNIPPETS is a list of snippet definitions, each taking the
1667 (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV FILE KEYBINDING UUID)
1669 Within these, only KEY and TEMPLATE are actually mandatory.
1671 TEMPLATE might be a Lisp form or a string, depending on whether
1672 this is a snippet or a snippet-command.
1674 CONDITION, EXPAND-ENV and KEYBINDING are Lisp forms, they have
1675 been `yas--read-lisp'-ed and will eventually be
1676 `yas--eval-lisp'-ed.
1678 The remaining elements are strings.
1680 FILE is probably of very little use if you're programatically
1683 UUID is the snippet's \"unique-id\". Loading a second snippet
1684 file with the same uuid would replace the previous snippet.
1686 You can use `yas--parse-template' to return such lists based on
1687 the current buffers contents."
1688 (if yas--creating-compiled-snippets
1690 (insert ";;; Snippet definitions:\n;;;\n")
1691 (let ((literal-snippets (list))
1693 (dolist (snippet snippets)
1694 (let ((key (nth 0 snippet))
1695 (template-content (nth 1 snippet))
1696 (name (nth 2 snippet))
1697 (condition (nth 3 snippet))
1698 (group (nth 4 snippet))
1699 (expand-env (nth 5 snippet))
1700 (file nil) ;; omit on purpose
1701 (binding (nth 7 snippet))
1702 (uuid (nth 8 snippet)))
1713 (insert (pp-to-string
1714 `(yas-define-snippets ',mode ',literal-snippets)))
1717 (let ((snippet-table (yas--table-get-create mode))
1719 (dolist (snippet snippets)
1720 (setq template (yas--define-snippets-1 snippet
1725 ;;; Loading snippets from files
1727 (defun yas--load-yas-setup-file (file)
1728 (if (not yas--creating-compiled-snippets)
1730 (load file 'noerror)
1731 (let ((elfile (concat file ".el")))
1732 (when (file-exists-p elfile)
1733 (insert ";;; .yas-setup.el support file if any:\n;;;\n")
1734 (insert-file-contents elfile)
1735 (goto-char (point-max))))))
1737 (defun yas--define-parents (mode parents)
1738 "Add PARENTS to the list of MODE's parents."
1739 (puthash mode (remove-duplicates
1741 (gethash mode yas--parents)))
1744 (defun yas-load-directory (top-level-dir &optional use-jit interactive)
1745 "Load snippets in directory hierarchy TOP-LEVEL-DIR.
1747 Below TOP-LEVEL-DIR each directory should be a mode name.
1749 With prefix argument USE-JIT do jit-loading of snippets."
1751 (list (read-directory-name "Select the root directory: " nil nil t)
1752 current-prefix-arg t))
1753 (unless yas-snippet-dirs
1754 (setq yas-snippet-dirs top-level-dir))
1755 (let ((impatient-buffers))
1756 (dolist (dir (yas--subdirs top-level-dir))
1757 (let* ((major-mode-and-parents (yas--compute-major-mode-and-parents
1758 (concat dir "/dummy")))
1759 (mode-sym (car major-mode-and-parents))
1760 (parents (cdr major-mode-and-parents)))
1761 ;; Attention: The parents and the menus are already defined
1762 ;; here, even if the snippets are later jit-loaded.
1764 ;; * We need to know the parents at this point since entering a
1765 ;; given mode should jit load for its parents
1766 ;; immediately. This could be reviewed, the parents could be
1767 ;; discovered just-in-time-as well
1769 ;; * We need to create the menus here to support the `full'
1770 ;; option to `yas-use-menu' (all known snippet menus are shown to the user)
1772 (yas--define-parents mode-sym parents)
1773 (yas--menu-keymap-get-create mode-sym)
1774 (let ((fun `(lambda () ;; FIXME: Simulating lexical-binding.
1775 (yas--load-directory-1 ',dir ',mode-sym))))
1777 (yas--schedule-jit mode-sym fun)
1779 ;; Look for buffers that are already in `mode-sym', and so
1780 ;; need the new snippets immediately...
1783 (cl-loop for buffer in (buffer-list)
1784 do (with-current-buffer buffer
1785 (when (eq major-mode mode-sym)
1786 (yas--message 3 "Discovered there was already %s in %s" buffer mode-sym)
1787 (push buffer impatient-buffers)))))))
1788 ;; ...after TOP-LEVEL-DIR has been completely loaded, call
1789 ;; `yas--load-pending-jits' in these impatient buffers.
1791 (cl-loop for buffer in impatient-buffers
1792 do (with-current-buffer buffer (yas--load-pending-jits))))
1794 (yas--message 3 "Loaded snippets from %s." top-level-dir)))
1796 (defun yas--load-directory-1 (directory mode-sym)
1797 "Recursively load snippet templates from DIRECTORY."
1798 (if yas--creating-compiled-snippets
1799 (let ((output-file (expand-file-name ".yas-compiled-snippets.el"
1801 (with-temp-file output-file
1802 (insert (format ";;; Compiled snippets and support files for `%s'\n"
1804 (yas--load-directory-2 directory mode-sym)
1805 (insert (format ";;; Do not edit! File generated at %s\n"
1806 (current-time-string)))))
1808 (unless (file-exists-p (concat directory "/" ".yas-skip"))
1809 (if (and (progn (yas--message 2 "Loading compiled snippets from %s" directory) t)
1810 (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3)))
1811 (yas--message 2 "Loading snippet files from %s" directory)
1812 (yas--load-directory-2 directory mode-sym)))))
1814 (defun yas--load-directory-2 (directory mode-sym)
1815 ;; Load .yas-setup.el files wherever we find them
1817 (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
1818 (let* ((default-directory directory)
1820 ;; load the snippet files
1823 (dolist (file (yas--subdirs directory 'no-subdirs-just-files))
1824 (when (file-readable-p file)
1825 (insert-file-contents file nil nil nil t)
1826 (push (yas--parse-template file)
1829 (yas-define-snippets mode-sym
1831 ;; now recurse to a lower level
1833 (dolist (subdir (yas--subdirs directory))
1834 (yas--load-directory-2 subdir
1837 (defun yas--load-snippet-dirs (&optional nojit)
1838 "Reload the directories listed in `yas-snippet-dirs' or
1839 prompt the user to select one."
1841 (if yas-snippet-dirs
1842 (dolist (directory (reverse (yas-snippet-dirs)))
1843 (cond ((file-directory-p directory)
1844 (yas-load-directory directory (not nojit))
1846 (yas--message 3 "Loaded %s" directory)
1847 (yas--message 3 "Prepared just-in-time loading for %s" directory)))
1849 (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors))))
1850 (call-interactively 'yas-load-directory))
1853 (defun yas-reload-all (&optional no-jit interactive)
1854 "Reload all snippets and rebuild the YASnippet menu.
1856 When NO-JIT is non-nil force immediate reload of all known
1857 snippets under `yas-snippet-dirs', otherwise use just-in-time
1860 When called interactively, use just-in-time loading when given a
1862 (interactive (list (not current-prefix-arg) t))
1865 (snippet-editing-buffers
1866 (remove-if-not #'(lambda (buffer)
1867 (with-current-buffer buffer yas--editing-template))
1869 ;; Warn if there are buffers visiting snippets, since reloading will break
1870 ;; any on-line editing of those buffers.
1872 (when snippet-editing-buffers
1874 (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
1875 (mapc #'kill-buffer snippet-editing-buffers)
1876 (yas--message 1 "Aborted reload...")
1878 ;; in a non-interactive use, at least set
1879 ;; `yas--editing-template' to nil, make it guess it next time around
1880 (mapc #'(lambda (buffer)
1881 (with-current-buffer buffer
1882 (kill-local-variable 'yas--editing-template)))
1885 ;; Empty all snippet tables and parenting info
1887 (setq yas--tables (make-hash-table))
1888 (setq yas--parents (make-hash-table))
1890 ;; Before killing `yas--menu-table' use its keys to cleanup the
1891 ;; mode menu parts of `yas--minor-mode-menu' (thus also cleaning
1892 ;; up `yas-minor-mode-map', which points to it)
1894 (maphash #'(lambda (menu-symbol _keymap)
1895 (define-key yas--minor-mode-menu (vector menu-symbol) nil))
1897 ;; Now empty `yas--menu-table' as well
1898 (setq yas--menu-table (make-hash-table))
1900 ;; Cancel all pending 'yas--scheduled-jit-loads'
1902 (setq yas--scheduled-jit-loads (make-hash-table))
1904 ;; Reload the directories listed in `yas-snippet-dirs' or prompt
1905 ;; the user to select one.
1907 (setq errors (yas--load-snippet-dirs no-jit))
1908 ;; Reload the direct keybindings
1910 (yas-direct-keymaps-reload)
1912 (run-hooks 'yas-after-reload-hook)
1913 (yas--message 3 "Reloaded everything%s...%s."
1914 (if no-jit "" " (snippets will load just-in-time)")
1915 (if errors " (some errors, check *Messages*)" "")))))
1917 (defvar yas-after-reload-hook nil
1918 "Hooks run after `yas-reload-all'.")
1920 (defun yas--load-pending-jits ()
1921 (dolist (mode (yas--modes-to-activate))
1922 (let ((funs (reverse (gethash mode yas--scheduled-jit-loads))))
1923 ;; must reverse to maintain coherence with `yas-snippet-dirs'
1925 (yas--message 3 "Loading for `%s', just-in-time: %s!" mode fun)
1927 (remhash mode yas--scheduled-jit-loads))))
1929 ;; (when (<= emacs-major-version 22)
1930 ;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
1932 (defun yas--quote-string (string)
1933 "Escape and quote STRING.
1934 foo\"bar\\! -> \"foo\\\"bar\\\\!\""
1936 (replace-regexp-in-string "[\\\"]"
1942 ;;; Snippet compilation function
1944 (defun yas--initialize ()
1945 "For backward compatibility, enable `yas-minor-mode' globally."
1946 (yas-global-mode 1))
1948 (defun yas-compile-directory (top-level-dir)
1949 "Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
1951 This works by stubbing a few functions, then calling
1952 `yas-load-directory'."
1953 (interactive "DTop level snippet directory?")
1954 (let ((yas--creating-compiled-snippets t))
1955 (yas-load-directory top-level-dir nil)))
1957 (defun yas-recompile-all ()
1958 "Compile every dir in `yas-snippet-dirs'."
1960 (mapc #'yas-compile-directory (yas-snippet-dirs)))
1966 (defvar yas--scheduled-jit-loads (make-hash-table)
1967 "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
1969 (defun yas--schedule-jit (mode fun)
1970 (push fun (gethash mode yas--scheduled-jit-loads)))
1974 ;;; Some user level functions
1978 (message (concat "yasnippet (version "
1980 ") -- pluskid <pluskid@gmail.com>/joaotavora <joaotavora@gmail.com>")))
1983 ;;; Apropos snippet menu:
1985 ;; The snippet menu keymaps are store by mode in hash table called
1986 ;; `yas--menu-table'. They are linked to the main menu in
1987 ;; `yas--menu-keymap-get-create' and are initially created empty,
1988 ;; reflecting the table hierarchy.
1990 ;; They can be populated in two mutually exclusive ways: (1) by
1991 ;; reading `yas--template-group', which in turn is populated by the "#
1992 ;; group:" directives of the snippets or the ".yas-make-groups" file
1993 ;; or (2) by using a separate `yas-define-menu' call, which declares a
1994 ;; menu structure based on snippets uuids.
1996 ;; Both situations are handled in `yas--update-template-menu', which
1997 ;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
1998 ;; that can tell between the two situations.
2002 ;; * if `yas-define-menu' is used it must run before
2003 ;; `yas-define-snippets' and the UUIDS must match, otherwise we get
2004 ;; duplicate entries. The `yas--template' objects are created in
2005 ;; `yas-define-menu', holding nothing but the menu entry,
2006 ;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
2007 ;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
2008 ;; part is then stored in the menu keymap itself which make the item
2009 ;; appear to the user. These limitations could probably be revised.
2011 ;; * The `yas--template-perm-group' slot is only used in
2012 ;; `yas-describe-tables'.
2014 (defun yas--template-menu-binding-pair-get-create (template &optional type)
2015 "Get TEMPLATE's menu binding or assign it a new one.
2017 TYPE may be `:stay', signaling this menu binding should be
2018 static in the menu."
2019 (or (yas--template-menu-binding-pair template)
2020 (let (;; (key (yas--template-key template))
2021 ;; (keybinding (yas--template-keybinding template))
2023 (setf (yas--template-menu-binding-pair template)
2024 (cons `(menu-item ,(or (yas--template-name template)
2025 (yas--template-uuid template))
2026 ,(yas--make-menu-binding template)
2029 (defun yas--template-menu-managed-by-yas-define-menu (template)
2030 "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
2031 (cdr (yas--template-menu-binding-pair template)))
2034 (defun yas--show-menu-p (mode)
2035 (cond ((eq yas-use-menu 'abbreviate)
2037 (mapcar #'(lambda (table)
2038 (yas--table-mode table))
2039 (yas--get-snippet-tables))))
2042 (defun yas--delete-from-keymap (keymap uuid)
2043 "Recursively delete items with UUID from KEYMAP and its submenus."
2045 ;; XXX: This used to skip any submenus named \"parent mode\"
2047 ;; First of all, recursively enter submenus, i.e. the tree is
2048 ;; searched depth first so that stale submenus can be found in the
2051 (mapc #'(lambda (item)
2052 (when (and (listp (cdr item))
2053 (keymapp (third (cdr item))))
2054 (yas--delete-from-keymap (third (cdr item)) uuid)))
2056 ;; Set the uuid entry to nil
2058 (define-key keymap (vector (make-symbol uuid)) nil)
2059 ;; Destructively modify keymap
2061 (setcdr keymap (delete-if #'(lambda (item)
2062 (or (null (cdr item))
2063 (and (keymapp (third (cdr item)))
2064 (null (cdr (third (cdr item)))))))
2067 (defun yas-define-menu (mode menu &optional omit-items)
2068 "Define a snippet menu for MODE according to MENU, omitting OMIT-ITEMS.
2070 MENU is a list, its elements can be:
2072 - (yas-item UUID) : Creates an entry the snippet identified with
2073 UUID. The menu entry for a snippet thus identified is
2074 permanent, i.e. it will never move (be reordered) in the menu.
2076 - (yas-separator) : Creates a separator
2078 - (yas-submenu NAME SUBMENU) : Creates a submenu with NAME,
2079 SUBMENU has the same form as MENU. NAME is also added to the
2080 list of groups of the snippets defined thereafter.
2082 OMIT-ITEMS is a list of snippet uuid's that will always be
2083 omitted from MODE's menu, even if they're manually loaded."
2084 (let* ((table (yas--table-get-create mode))
2085 (hash (yas--table-uuidhash table)))
2086 (yas--define-menu-1 table
2087 (yas--menu-keymap-get-create mode)
2090 (dolist (uuid omit-items)
2091 (let ((template (or (gethash uuid hash)
2092 (yas--populate-template (puthash uuid
2093 (yas--make-blank-template)
2097 (setf (yas--template-menu-binding-pair template) (cons nil :none))))))
2099 (defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
2100 "Helper for `yas-define-menu'."
2101 (dolist (e (reverse menu))
2102 (cond ((eq (first e) 'yas-item)
2103 (let ((template (or (gethash (second e) uuidhash)
2104 (yas--populate-template (puthash (second e)
2105 (yas--make-blank-template)
2108 :perm-group group-list
2109 :uuid (second e)))))
2110 (define-key menu-keymap (vector (gensym))
2111 (car (yas--template-menu-binding-pair-get-create template :stay)))))
2112 ((eq (first e) 'yas-submenu)
2113 (let ((subkeymap (make-sparse-keymap)))
2114 (define-key menu-keymap (vector (gensym))
2115 `(menu-item ,(second e) ,subkeymap))
2116 (yas--define-menu-1 table
2120 (append group-list (list (second e))))))
2121 ((eq (first e) 'yas-separator)
2122 (define-key menu-keymap (vector (gensym))
2123 '(menu-item "----")))
2125 (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
2127 (defun yas--define (mode key template &optional name condition group)
2128 "Define a snippet. Expanding KEY into TEMPLATE.
2130 NAME is a description to this template. Also update the menu if
2131 `yas-use-menu' is t. CONDITION is the condition attached to
2132 this snippet. If you attach a condition to a snippet, then it
2133 will only be expanded when the condition evaluated to non-nil."
2134 (yas-define-snippets mode
2135 (list (list key template name condition group))))
2137 (defun yas-hippie-try-expand (first-time?)
2138 "Integrate with hippie expand.
2140 Just put this function in `hippie-expand-try-functions-list'."
2141 (when yas-minor-mode
2142 (if (not first-time?)
2143 (let ((yas-fallback-behavior 'return-nil))
2149 ;;; Apropos condition-cache:
2154 (defvar yas--condition-cache-timestamp nil)
2155 (defmacro yas-define-condition-cache (func doc &rest body)
2156 "Define a function FUNC with doc DOC and body BODY.
2157 BODY is executed at most once every snippet expansion attempt, to check
2158 expansion conditions.
2160 It doesn't make any sense to call FUNC programatically."
2161 `(defun ,func () ,(if (and doc
2164 "\n\nFor use in snippets' conditions. Within each
2165 snippet-expansion routine like `yas-expand', computes actual
2166 value for the first time then always returns a cached value.")
2167 (setq body (cons doc body))
2169 (let ((timestamp-and-value (get ',func 'yas--condition-cache)))
2170 (if (equal (car timestamp-and-value) yas--condition-cache-timestamp)
2171 (cdr timestamp-and-value)
2172 (let ((new-value (progn
2175 (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
2178 (defalias 'yas-expand 'yas-expand-from-trigger-key)
2179 (defun yas-expand-from-trigger-key (&optional field)
2180 "Expand a snippet before point.
2182 If no snippet expansion is possible, fall back to the behaviour
2183 defined in `yas-fallback-behavior'.
2185 Optional argument FIELD is for non-interactive use and is an
2186 object satisfying `yas--field-p' to restrict the expansion to."
2188 (setq yas--condition-cache-timestamp (current-time))
2189 (let (templates-and-pos)
2190 (unless (and yas-expand-only-for-last-commands
2191 (not (member last-command yas-expand-only-for-last-commands)))
2192 (setq templates-and-pos (if field
2194 (narrow-to-region (yas--field-start field)
2195 (yas--field-end field))
2196 (yas--templates-for-key-at-point))
2197 (yas--templates-for-key-at-point))))
2198 (if templates-and-pos
2199 (yas--expand-or-prompt-for-template (first templates-and-pos)
2200 (second templates-and-pos)
2201 (third templates-and-pos))
2204 (defun yas-expand-from-keymap ()
2205 "Directly expand some snippets, searching `yas--direct-keymaps'.
2207 If expansion fails, execute the previous binding for this key"
2209 (setq yas--condition-cache-timestamp (current-time))
2210 (let* ((vec (subseq (this-command-keys-vector) (if current-prefix-arg
2211 (length (this-command-keys))
2213 (templates (mapcan #'(lambda (table)
2214 (yas--fetch table vec))
2215 (yas--get-snippet-tables))))
2217 (yas--expand-or-prompt-for-template templates)
2218 (let ((yas-fallback-behavior 'call-other-command))
2221 (defun yas--expand-or-prompt-for-template (templates &optional start end)
2222 "Expand one of TEMPLATES from START to END.
2224 Prompt the user if TEMPLATES has more than one element, else
2225 expand immediately. Common gateway for
2226 `yas-expand-from-trigger-key' and `yas-expand-from-keymap'."
2227 (let ((yas--current-template (or (and (rest templates) ;; more than one
2228 (yas--prompt-for-template (mapcar #'cdr templates)))
2230 (when yas--current-template
2231 (yas-expand-snippet (yas--template-content yas--current-template)
2234 (yas--template-expand-env yas--current-template)))))
2236 ;; Apropos the trigger key and the fallback binding:
2238 ;; When `yas-minor-mode-map' binds <tab>, that correctly overrides
2239 ;; org-mode's <tab>, for example and searching for fallbacks correctly
2240 ;; returns `org-cycle'. However, most other modes bind "TAB". TODO,
2241 ;; improve this explanation.
2243 (defun yas--fallback ()
2244 "Fallback after expansion has failed.
2246 Common gateway for `yas-expand-from-trigger-key' and
2247 `yas-expand-from-keymap'."
2248 (cond ((eq yas-fallback-behavior 'return-nil)
2251 ((eq yas-fallback-behavior 'yas--fallback)
2252 (error (concat "yasnippet fallback loop!\n"
2253 "This can happen when you bind `yas-expand' "
2254 "outside of the `yas-minor-mode-map'.")))
2255 ((eq yas-fallback-behavior 'call-other-command)
2256 (let* ((yas-fallback-behavior 'yas--fallback)
2257 ;; Also bind `yas-minor-mode' to prevent fallback
2258 ;; loops when other extensions use mechanisms similar
2259 ;; to `yas--keybinding-beyond-yasnippet'. (github #525
2262 (yas-minor-mode nil)
2263 (beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
2264 (yas--message 4 "Falling back to %s" beyond-yasnippet)
2265 (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
2266 (setq this-original-command beyond-yasnippet)
2267 (when beyond-yasnippet
2268 (call-interactively beyond-yasnippet))))
2269 ((and (listp yas-fallback-behavior)
2270 (cdr yas-fallback-behavior)
2271 (eq 'apply (car yas-fallback-behavior)))
2272 (let ((yas-fallback-behavior 'yas--fallback)
2273 (yas-minor-mode nil))
2274 (if (cddr yas-fallback-behavior)
2275 (apply (cadr yas-fallback-behavior)
2276 (cddr yas-fallback-behavior))
2277 (when (commandp (cadr yas-fallback-behavior))
2278 (setq this-command (cadr yas-fallback-behavior))
2279 (call-interactively (cadr yas-fallback-behavior))))))
2281 ;; also return nil if all the other fallbacks have failed
2284 (defun yas--keybinding-beyond-yasnippet ()
2285 "Get current keys's binding as if YASsnippet didn't exist."
2286 (let* ((yas-minor-mode nil)
2287 (yas--direct-keymaps nil)
2288 (keys (this-single-command-keys)))
2289 (or (key-binding keys t)
2290 (key-binding (yas--fallback-translate-input keys) t))))
2292 (defun yas--fallback-translate-input (keys)
2293 "Emulate `read-key-sequence', at least what I think it does.
2295 Keys should be an untranslated key vector. Returns a translated
2296 vector of keys. FIXME not thoroughly tested."
2299 (while (< i (length keys))
2301 (translated local-function-key-map))
2302 (while (and (< j (length keys))
2304 (keymapp translated))
2305 (setq translated (cdr (assoc (aref keys j) (remove 'keymap translated)))
2307 (setq retval (vconcat retval (cond ((symbolp translated)
2309 ((vectorp translated)
2312 (substring keys i j)))))
2317 ;;; Utils for snippet development:
2319 (defun yas--all-templates (tables)
2320 "Get `yas--template' objects in TABLES, applicable for buffer and point.
2322 Honours `yas-choose-tables-first', `yas-choose-keys-first' and
2323 `yas-buffer-local-condition'"
2324 (when yas-choose-tables-first
2325 (setq tables (list (yas--prompt-for-table tables))))
2327 (if yas-choose-keys-first
2328 (let ((key (yas--prompt-for-keys
2329 (mapcan #'yas--table-all-keys tables))))
2331 (mapcan #'(lambda (table)
2332 (yas--fetch table key))
2334 (remove-duplicates (mapcan #'yas--table-templates tables)
2337 (defun yas-insert-snippet (&optional no-condition)
2338 "Choose a snippet to expand, pop-up a list of choices according
2339 to `yas-prompt-functions'.
2341 With prefix argument NO-CONDITION, bypass filtering of snippets
2344 (setq yas--condition-cache-timestamp (current-time))
2345 (let* ((yas-buffer-local-condition (or (and no-condition
2347 yas-buffer-local-condition))
2348 (templates (yas--all-templates (yas--get-snippet-tables)))
2349 (yas--current-template (and templates
2350 (or (and (rest templates) ;; more than one template for same key
2351 (yas--prompt-for-template templates))
2353 (where (if (region-active-p)
2354 (cons (region-beginning) (region-end))
2355 (cons (point) (point)))))
2356 (if yas--current-template
2357 (yas-expand-snippet (yas--template-content yas--current-template)
2360 (yas--template-expand-env yas--current-template))
2361 (yas--message 3 "No snippets can be inserted here!"))))
2363 (defun yas-visit-snippet-file ()
2364 "Choose a snippet to edit, selection like `yas-insert-snippet'.
2366 Only success if selected snippet was loaded from a file. Put the
2367 visited file in `snippet-mode'."
2369 (let* ((yas-buffer-local-condition 'always)
2370 (templates (yas--all-templates (yas--get-snippet-tables)))
2371 (yas-prompt-functions '(yas-ido-prompt yas-completing-prompt))
2372 (template (and templates
2373 (or (yas--prompt-for-template templates
2374 "Choose a snippet template to edit: ")
2378 (yas--visit-snippet-file-1 template)
2379 (message "No snippets tables active!"))))
2381 (defun yas--visit-snippet-file-1 (template)
2382 "Helper for `yas-visit-snippet-file'."
2383 (let ((file (yas--template-file template)))
2384 (cond ((and file (file-readable-p file))
2385 (find-file-other-window file)
2387 (set (make-local-variable 'yas--editing-template) template))
2389 (message "Original file %s no longer exists!" file))
2391 (switch-to-buffer (format "*%s*"(yas--template-name template)))
2392 (let ((type 'snippet))
2393 (when (listp (yas--template-content template))
2394 (insert (format "# type: command\n"))
2395 (setq type 'command))
2396 (insert (format "# key: %s\n" (yas--template-key template)))
2397 (insert (format "# name: %s\n" (yas--template-name template)))
2398 (when (yas--template-keybinding template)
2399 (insert (format "# binding: %s\n" (yas--template-keybinding template))))
2400 (when (yas--template-expand-env template)
2401 (insert (format "# expand-env: %s\n" (yas--template-expand-env template))))
2402 (when (yas--template-condition template)
2403 (insert (format "# condition: %s\n" (yas--template-condition template))))
2405 (insert (if (eq type 'command)
2406 (pp-to-string (yas--template-content template))
2407 (yas--template-content template))))
2409 (set (make-local-variable 'yas--editing-template) template)))))
2411 (defun yas--guess-snippet-directories-1 (table)
2412 "Guess possible snippet subdirectories for TABLE."
2413 (cons (yas--table-name table)
2414 (mapcan #'(lambda (parent)
2415 (yas--guess-snippet-directories-1
2417 (yas--table-parents table))))
2419 (defun yas--guess-snippet-directories (&optional table)
2420 "Try to guess suitable directories based on the current active
2421 tables (or optional TABLE).
2423 Returns a list of elements (TABLE . DIRS) where TABLE is a
2424 `yas--table' object and DIRS is a list of all possible directories
2425 where snippets of table might exist."
2426 (let ((main-dir (replace-regexp-in-string
2428 (or (first (or (yas-snippet-dirs)
2429 (setq yas-snippet-dirs '("~/.emacs.d/snippets")))))))
2430 (tables (or (and table
2432 (yas--get-snippet-tables))))
2433 ;; HACK! the snippet table created here is actually registered!
2435 (unless (or table (gethash major-mode yas--tables))
2436 (push (yas--table-get-create major-mode)
2439 (mapcar #'(lambda (table)
2441 (mapcar #'(lambda (subdir)
2442 (concat main-dir "/" subdir))
2443 (yas--guess-snippet-directories-1 table))))
2446 (defun yas--make-directory-maybe (table-and-dirs &optional main-table-string)
2447 "Return a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
2448 (or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
2449 (let ((candidate (first (cdr table-and-dirs))))
2450 (unless (file-writable-p (file-name-directory candidate))
2451 (error (yas--format "%s is not writable." candidate)))
2452 (if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
2454 (if (gethash (yas--table-mode (car table-and-dirs))
2458 (or main-table-string
2460 (yas--table-name (car table-and-dirs))))
2462 (make-directory candidate 'also-make-parents)
2463 ;; create the .yas-parents file here...
2466 (defun yas-new-snippet (&optional no-template)
2467 "Pops a new buffer for writing a snippet.
2469 Expands a snippet-writing snippet, unless the optional prefix arg
2470 NO-TEMPLATE is non-nil."
2472 (let ((guessed-directories (yas--guess-snippet-directories)))
2474 (switch-to-buffer "*new snippet*")
2476 (kill-all-local-variables)
2479 (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
2480 (yas--table-mode (car d)))
2481 guessed-directories))
2482 (if (and (not no-template) yas-new-snippet-default)
2483 (yas-expand-snippet yas-new-snippet-default))))
2485 (defun yas--compute-major-mode-and-parents (file)
2486 "Given FILE, find the nearest snippet directory for a given mode.
2488 Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
2489 representing one or more of the mode's parents.
2491 Note that MODE-SYM need not be the symbol of a real major mode,
2492 neither do the elements of PARENTS."
2493 (let* ((file-dir (and file
2494 (directory-file-name (or (some #'(lambda (special)
2495 (locate-dominating-file file special))
2499 (directory-file-name (file-name-directory file))))))
2500 (parents-file-name (concat file-dir "/.yas-parents"))
2501 (major-mode-name (and file-dir
2502 (file-name-nondirectory file-dir)))
2503 (major-mode-sym (or (and major-mode-name
2504 (intern major-mode-name))))
2505 (parents (when (file-readable-p parents-file-name)
2509 (insert-file-contents parents-file-name)
2510 (buffer-substring-no-properties (point-min)
2512 (when major-mode-sym
2513 (cons major-mode-sym (remove major-mode-sym parents)))))
2515 (defvar yas--editing-template nil
2516 "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
2518 (defvar yas--current-template nil
2519 "Holds the current template being expanded into a snippet.")
2521 (defvar yas--guessed-modes nil
2522 "List of guessed modes supporting `yas-load-snippet-buffer'.")
2524 (defun yas--read-table ()
2525 "Ask user for a snippet table, help with some guessing."
2526 (let ((prompt (if (and (featurep 'ido)
2528 'ido-completing-read 'completing-read)))
2529 (unless yas--guessed-modes
2530 (set (make-local-variable 'yas--guessed-modes)
2531 (or (yas--compute-major-mode-and-parents buffer-file-name))))
2533 (funcall prompt (format "Choose or enter a table (yas guesses %s): "
2534 (if yas--guessed-modes
2535 (first yas--guessed-modes)
2537 (mapcar #'symbol-name yas--guessed-modes)
2542 (if (first yas--guessed-modes)
2543 (symbol-name (first yas--guessed-modes)))))))
2545 (defun yas-load-snippet-buffer (table &optional interactive)
2546 "Parse and load current buffer's snippet definition into TABLE.
2548 TABLE is a symbol naming a passed to `yas--table-get-create'.
2550 When called interactively, prompt for the table name."
2551 (interactive (list (yas--read-table) t))
2553 ;; We have `yas--editing-template', this buffer's content comes from a
2554 ;; template which is already loaded and neatly positioned,...
2556 (yas--editing-template
2557 (yas--define-snippets-1 (yas--parse-template (yas--template-file yas--editing-template))
2558 (yas--template-table yas--editing-template)))
2559 ;; Try to use `yas--guessed-modes'. If we don't have that use the
2560 ;; value from `yas--compute-major-mode-and-parents'
2563 (unless yas--guessed-modes
2564 (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
2565 (let* ((table (yas--table-get-create table)))
2566 (set (make-local-variable 'yas--editing-template)
2567 (yas--define-snippets-1 (yas--parse-template buffer-file-name)
2570 (yas--message 3 "Snippet \"%s\" loaded for %s."
2571 (yas--template-name yas--editing-template)
2572 (yas--table-name (yas--template-table yas--editing-template)))))
2574 (defun yas-load-snippet-buffer-and-close (table &optional kill)
2575 "Load the snippet with `yas-load-snippet-buffer', possibly
2576 save, then `quit-window' if saved.
2578 If the snippet is new, ask the user whether (and where) to save
2579 it. If the snippet already has a file, just save it.
2581 The prefix argument KILL is passed to `quit-window'.
2583 Don't use this from a Lisp program, call `yas-load-snippet-buffer'
2584 and `kill-buffer' instead."
2585 (interactive (list (yas--read-table) current-prefix-arg))
2586 (yas-load-snippet-buffer table t)
2588 ;; Only offer to save this if it looks like a library or new
2589 ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
2590 ;; which is not the first, or from an unwritable file)
2592 (not (yas--template-file yas--editing-template))
2593 (not (file-writable-p (yas--template-file yas--editing-template)))
2594 (and (listp yas-snippet-dirs)
2595 (second yas-snippet-dirs)
2596 (not (string-match (expand-file-name (first yas-snippet-dirs))
2597 (yas--template-file yas--editing-template)))))
2598 (y-or-n-p (yas--format "Looks like a library or new snippet. Save to new file? ")))
2599 (let* ((option (first (yas--guess-snippet-directories (yas--template-table yas--editing-template))))
2601 (yas--make-directory-maybe option))))
2603 (let ((default-file-name (or (and (yas--template-file yas--editing-template)
2604 (file-name-nondirectory (yas--template-file yas--editing-template)))
2605 (yas--template-name yas--editing-template))))
2606 (write-file (concat chosen "/"
2607 (read-from-minibuffer (format "File name to create in %s? " chosen)
2608 default-file-name)))
2609 (setf (yas--template-file yas--editing-template) buffer-file-name)))))
2610 (when buffer-file-name
2612 (quit-window kill)))
2614 (defun yas-tryout-snippet (&optional debug)
2615 "Test current buffer's snippet template in other buffer."
2617 (let* ((major-mode-and-parent (yas--compute-major-mode-and-parents buffer-file-name))
2618 (parsed (yas--parse-template))
2619 (test-mode (or (and (car major-mode-and-parent)
2620 (fboundp (car major-mode-and-parent))
2621 (car major-mode-and-parent))
2622 (first yas--guessed-modes)
2623 (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
2624 (yas--current-template
2627 (yas--populate-template (yas--make-blank-template)
2628 :table nil ;; no tables for ephemeral snippets
2630 :content (second parsed)
2631 :name (third parsed)
2632 :expand-env (sixth parsed)))))
2633 (cond (yas--current-template
2634 (let ((buffer-name (format "*testing snippet: %s*" (yas--template-name yas--current-template))))
2635 (kill-buffer (get-buffer-create buffer-name))
2636 (switch-to-buffer (get-buffer-create buffer-name))
2637 (setq buffer-undo-list nil)
2638 (condition-case nil (funcall test-mode) (error nil))
2640 (setq buffer-read-only nil)
2641 (yas-expand-snippet (yas--template-content yas--current-template)
2644 (yas--template-expand-env yas--current-template))
2646 (require 'yasnippet-debug nil t))
2647 (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
2649 (yas--message 3 "Cannot test snippet for unknown major mode")))))
2651 (defun yas-active-keys ()
2652 "Return all active trigger keys for current buffer and point."
2654 (remove-if-not #'stringp (mapcan #'yas--table-all-keys (yas--get-snippet-tables)))
2657 (defun yas--template-fine-group (template)
2658 (car (last (or (yas--template-group template)
2659 (yas--template-perm-group template)))))
2661 (defun yas-describe-tables (&optional choose)
2662 "Display snippets for each table."
2664 (let* ((by-name-hash (and choose
2665 (y-or-n-p "Show by namehash? ")))
2666 (buffer (get-buffer-create "*YASnippet tables*"))
2667 (active-tables (yas--get-snippet-tables))
2668 (remain-tables (let ((all))
2669 (maphash #'(lambda (_k v)
2670 (unless (find v active-tables)
2674 (table-lists (list active-tables remain-tables))
2675 (original-buffer (current-buffer))
2677 (yas--condition-cache-timestamp (current-time)))
2678 (with-current-buffer buffer
2679 (setq buffer-read-only nil)
2681 (cond ((not by-name-hash)
2682 (insert "YASnippet tables: \n")
2683 (while (and table-lists
2685 (dolist (table (car table-lists))
2686 (yas--describe-pretty-table table original-buffer))
2687 (setq table-lists (cdr table-lists))
2689 (yas--create-snippet-xrefs)
2690 (display-buffer buffer)
2691 (setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
2692 (yas--create-snippet-xrefs)
2696 (insert "\n\nYASnippet tables by NAMEHASH: \n")
2697 (dolist (table (append active-tables remain-tables))
2698 (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
2700 (maphash #'(lambda (k _v)
2702 (yas--table-hash table))
2704 (insert (format " key %s maps snippets: %s\n" key
2706 (maphash #'(lambda (k _v)
2708 (gethash key (yas--table-hash table)))
2711 (setq buffer-read-only t))
2712 (display-buffer buffer)))
2714 (defun yas--describe-pretty-table (table &optional original-buffer)
2715 (insert (format "\nSnippet table `%s'"
2716 (yas--table-name table)))
2717 (if (yas--table-parents table)
2718 (insert (format " parents: %s\n"
2719 (mapcar #'yas--table-name
2720 (yas--table-parents table))))
2722 (insert (make-string 100 ?-) "\n")
2723 (insert "group state name key binding\n")
2724 (let ((groups-hash (make-hash-table :test #'equal)))
2725 (maphash #'(lambda (_k v)
2726 (let ((group (or (yas--template-fine-group v)
2728 (when (yas--template-name v)
2730 (cons v (gethash group groups-hash))
2732 (yas--table-uuidhash table))
2734 #'(lambda (group templates)
2735 (setq group (truncate-string-to-width group 25 0 ? "..."))
2736 (insert (make-string 100 ?-) "\n")
2737 (dolist (p templates)
2738 (let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas--template-name p))
2742 (setq group (make-string (length group) ? ))))
2743 (condition-string (let ((condition (yas--template-condition p)))
2746 (with-current-buffer original-buffer
2747 (if (yas--eval-condition condition)
2752 (insert condition-string " ")
2754 (if (string-match "\\.\\.\\.$" name)
2758 (insert (truncate-string-to-width (or (yas--template-key p) "")
2760 (insert (truncate-string-to-width (key-description (yas--template-keybinding p))
2767 ;;; User convenience functions, for using in `yas-key-syntaxes'
2769 (defun yas-try-key-from-whitespace (_start-point)
2770 "As `yas-key-syntaxes' element, look for whitespace delimited key.
2772 A newline will be considered whitespace even if the mode syntax
2773 marks it as something else (typically comment ender)."
2774 (skip-chars-backward "^[:space:]\n"))
2776 (defun yas-shortest-key-until-whitespace (_start-point)
2777 "Like `yas-longest-key-from-whitespace' but take the shortest key."
2778 (when (/= (skip-chars-backward "^[:space:]\n" (1- (point))) 0)
2781 (defun yas-longest-key-from-whitespace (start-point)
2782 "As `yas-key-syntaxes' element, look for longest key between point and whitespace.
2784 A newline will be considered whitespace even if the mode syntax
2785 marks it as something else (typically comment ender)."
2786 (if (= (point) start-point)
2787 (yas-try-key-from-whitespace start-point)
2789 (unless (<= start-point (1+ (point)))
2794 ;;; User convenience functions, for using in snippet definitions
2796 (defvar yas-modified-p nil
2797 "Non-nil if field has been modified by user or transformation.")
2799 (defvar yas-moving-away-p nil
2800 "Non-nil if user is about to exit field.")
2802 (defvar yas-text nil
2803 "Contains current field text.")
2805 (defun yas-substr (str pattern &optional subexp)
2806 "Search PATTERN in STR and return SUBEXPth match.
2808 If found, the content of subexp group SUBEXP (default 0) is
2809 returned, or else the original STR will be returned."
2810 (let ((grp (or subexp 0)))
2812 (if (string-match pattern str)
2813 (match-string-no-properties grp str)
2816 (defun yas-choose-value (&rest possibilities)
2817 "Prompt for a string in POSSIBILITIES and return it.
2819 The last element of POSSIBILITIES may be a list of strings."
2820 (unless (or yas-moving-away-p
2822 (let* ((last-link (last possibilities))
2823 (last-elem (car last-link)))
2824 (when (listp last-elem)
2825 (setcar last-link (car last-elem))
2826 (setcdr last-link (cdr last-elem))))
2827 (some #'(lambda (fn)
2828 (funcall fn "Choose: " possibilities))
2829 yas-prompt-functions)))
2831 (defun yas-key-to-value (alist)
2832 (unless (or yas-moving-away-p
2834 (let ((key (read-key-sequence "")))
2836 (or (cdr (find key alist :key #'car :test #'string=))
2839 (defun yas-throw (text)
2840 "Throw a yas--exception with TEXT as the reason."
2841 (throw 'yas--exception (cons 'yas--exception text)))
2843 (defun yas-verify-value (possibilities)
2844 "Verify that the current field value is in POSSIBILITIES.
2846 Otherwise throw exception."
2847 (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
2848 (yas-throw (yas--format "Field only allows %s" possibilities))))
2850 (defun yas-field-value (number)
2851 "Get the string for field with NUMBER.
2853 Use this in primary and mirror transformations to tget."
2854 (let* ((snippet (car (yas--snippets-at-point)))
2856 (yas--snippet-find-field snippet number))))
2858 (yas--field-text-for-display field))))
2861 "Return `yas-text' if that exists and is non-empty, else nil."
2863 (not (string= "" yas-text)))
2866 (defun yas-selected-text ()
2867 "Return `yas-selected-text' if that exists and is non-empty, else nil."
2868 (if (and yas-selected-text
2869 (not (string= "" yas-selected-text)))
2872 (defun yas--get-field-once (number &optional transform-fn)
2873 (unless yas-modified-p
2875 (funcall transform-fn (yas-field-value number))
2876 (yas-field-value number))))
2878 (defun yas-default-from-field (number)
2879 (unless yas-modified-p
2880 (yas-field-value number)))
2882 (defun yas-inside-string ()
2883 "Return non-nil if the point is inside a string according to font-lock."
2884 (equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
2886 (defun yas-unimplemented (&optional missing-feature)
2887 (if yas--current-template
2888 (if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
2891 (yas--visit-snippet-file-1 yas--current-template))
2892 (message "No implementation. Missing %s" (or missing-feature "something"))))
2895 ;;; Snippet expansion and field management
2897 (defvar yas--active-field-overlay nil
2898 "Overlays the currently active field.")
2900 (defvar yas--field-protection-overlays nil
2901 "Two overlays protect the current active field.")
2903 (defvar yas-selected-text nil
2904 "The selected region deleted on the last snippet expansion.")
2906 (defvar yas--start-column nil
2907 "The column where the snippet expansion started.")
2909 (make-variable-buffer-local 'yas--active-field-overlay)
2910 (make-variable-buffer-local 'yas--field-protection-overlays)
2911 (put 'yas--active-field-overlay 'permanent-local t)
2912 (put 'yas--field-protection-overlays 'permanent-local t)
2914 (defstruct (yas--snippet (:constructor yas--make-snippet ()))
2920 (id (yas--snippet-next-id) :read-only t)
2921 (control-overlay nil)
2923 ;; stacked expansion: the `previous-active-field' slot saves the
2924 ;; active field where the child expansion took place
2925 previous-active-field
2928 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
2931 NUMBER is the field number.
2932 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2933 PARENT-FIELD is a `yas--field' this field is nested under, or nil.
2934 MIRRORS is a list of `yas--mirror's
2935 TRANSFORM is a lisp form.
2936 MODIFIED-P is a boolean set to true once user inputs text.
2937 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'.
2948 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
2951 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2952 TRANSFORM is a lisp form.
2953 PARENT-FIELD is a `yas--field' this mirror is nested under, or nil.
2954 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'
2955 DEPTH is a count of how many nested mirrors can affect this mirror"
2962 (defstruct (yas--exit (:constructor yas--make-exit (marker)))
2966 (defun yas--apply-transform (field-or-mirror field &optional empty-on-nil-p)
2967 "Calculate transformed string for FIELD-OR-MIRROR from FIELD.
2969 If there is no transform for ht field, return nil.
2971 If there is a transform but it returns nil, return the empty
2972 string iff EMPTY-ON-NIL-P is true."
2973 (let* ((yas-text (yas--field-text-for-display field))
2974 (yas-modified-p (yas--field-modified-p field))
2975 (yas-moving-away-p nil)
2976 (transform (if (yas--mirror-p field-or-mirror)
2977 (yas--mirror-transform field-or-mirror)
2978 (yas--field-transform field-or-mirror)))
2979 (start-point (if (yas--mirror-p field-or-mirror)
2980 (yas--mirror-start field-or-mirror)
2981 (yas--field-start field-or-mirror)))
2982 (transformed (and transform
2984 (goto-char start-point)
2985 (let ((ret (yas--eval-lisp transform)))
2986 (or ret (and empty-on-nil-p "")))))))
2989 (defsubst yas--replace-all (from to &optional text)
2990 "Replace all occurrences from FROM to TO.
2992 With optional string TEXT do it in that string."
2994 (replace-regexp-in-string (regexp-quote from) to text t t)
2995 (goto-char (point-min))
2996 (while (search-forward from nil t)
2997 (replace-match to t t text))))
2999 (defun yas--snippet-find-field (snippet number)
3000 (find-if #'(lambda (field)
3001 (eq number (yas--field-number field)))
3002 (yas--snippet-fields snippet)))
3004 (defun yas--snippet-sort-fields (snippet)
3005 "Sort the fields of SNIPPET in navigation order."
3006 (setf (yas--snippet-fields snippet)
3007 (sort (yas--snippet-fields snippet)
3008 #'yas--snippet-field-compare)))
3010 (defun yas--snippet-field-compare (field1 field2)
3011 "Compare FIELD1 and FIELD2.
3013 The field with a number is sorted first. If they both have a
3014 number, compare through the number. If neither have, compare
3015 through the field's start point"
3016 (let ((n1 (yas--field-number field1))
3017 (n2 (yas--field-number field2)))
3020 (or (zerop n2) (and (not (zerop n1))
3025 (< (yas--field-start field1)
3026 (yas--field-start field2))))))
3028 (defun yas--field-probably-deleted-p (snippet field)
3029 "Guess if SNIPPET's FIELD should be skipped."
3031 ;; field must be zero length
3033 (zerop (- (yas--field-start field) (yas--field-end field)))
3036 ;; 1) is a nested field and it's been modified
3038 (and (yas--field-parent-field field)
3039 (yas--field-modified-p field))
3040 ;; 2) ends just before the snippet end
3042 (and (eq field (car (last (yas--snippet-fields snippet))))
3043 (= (yas--field-start field) (overlay-end (yas--snippet-control-overlay snippet)))))
3044 ;; the field numbered 0, just before the exit marker, should
3047 (not (zerop (yas--field-number field)))))
3049 (defun yas--snippets-at-point (&optional all-snippets)
3050 "Return a sorted list of snippets at point.
3052 The most recently-inserted snippets are returned first."
3054 (remove nil (remove-duplicates (mapcar #'(lambda (ov)
3055 (overlay-get ov 'yas--snippet))
3057 (overlays-in (point-min) (point-max))
3058 (nconc (overlays-at (point)) (overlays-at (1- (point))))))))
3060 (<= (yas--snippet-id s2) (yas--snippet-id s1)))))
3062 (defun yas-next-field-or-maybe-expand ()
3063 "Try to expand a snippet at a key before point.
3065 Otherwise delegate to `yas-next-field'."
3067 (if yas-triggers-in-field
3068 (let ((yas-fallback-behavior 'return-nil)
3069 (active-field (overlay-get yas--active-field-overlay 'yas--field)))
3071 (unless (yas-expand-from-trigger-key active-field)
3075 (defun yas-next-field (&optional arg)
3076 "Navigate to the ARGth next field.
3078 If there's none, exit the snippet."
3082 (snippet (first (yas--snippets-at-point)))
3083 (active-field (overlay-get yas--active-field-overlay 'yas--field))
3084 (live-fields (remove-if #'(lambda (field)
3085 (and (not (eq field active-field))
3086 (yas--field-probably-deleted-p snippet field)))
3087 (yas--snippet-fields snippet)))
3088 (active-field-pos (position active-field live-fields))
3089 (target-pos (and active-field-pos (+ arg active-field-pos)))
3090 (target-field (and target-pos (nth target-pos live-fields))))
3091 ;; First check if we're moving out of a field with a transform
3093 (when (and active-field
3094 (yas--field-transform active-field))
3095 (let* ((yas-moving-away-p t)
3096 (yas-text (yas--field-text-for-display active-field))
3097 (yas-modified-p (yas--field-modified-p active-field)))
3098 ;; primary field transform: exit call to field-transform
3099 (yas--eval-lisp (yas--field-transform active-field))))
3100 ;; Now actually move...
3101 (cond ((and target-pos (>= target-pos (length live-fields)))
3102 (yas-exit-snippet snippet))
3104 (yas--move-to-field snippet target-field))
3108 (defun yas--place-overlays (snippet field)
3109 "Correctly place overlays for SNIPPET's FIELD."
3110 (yas--make-move-field-protection-overlays snippet field)
3111 (yas--make-move-active-field-overlay snippet field))
3113 (defun yas--move-to-field (snippet field)
3114 "Update SNIPPET to move to field FIELD.
3116 Also create some protection overlays"
3117 (goto-char (yas--field-start field))
3118 (yas--place-overlays snippet field)
3119 (overlay-put yas--active-field-overlay 'yas--field field)
3120 (let ((number (yas--field-number field)))
3121 ;; check for the special ${0: ...} field
3122 (if (and number (zerop number))
3124 (set-mark (yas--field-end field))
3125 (setf (yas--snippet-force-exit snippet)
3126 (or (yas--field-transform field)
3128 ;; make this field active
3129 (setf (yas--snippet-active-field snippet) field)
3130 ;; primary field transform: first call to snippet transform
3131 (unless (yas--field-modified-p field)
3132 (if (yas--field-update-display field)
3133 (yas--update-mirrors snippet)
3134 (setf (yas--field-modified-p field) nil))))))
3136 (defun yas-prev-field ()
3137 "Navigate to prev field. If there's none, exit the snippet."
3139 (yas-next-field -1))
3141 (defun yas-abort-snippet (&optional snippet)
3143 (let ((snippet (or snippet
3144 (car (yas--snippets-at-point)))))
3146 (setf (yas--snippet-force-exit snippet) t))))
3148 (defun yas-exit-snippet (snippet)
3149 "Goto exit-marker of SNIPPET."
3150 (interactive (list (first (yas--snippets-at-point))))
3152 (setf (yas--snippet-force-exit snippet) t)
3153 (goto-char (if (yas--snippet-exit snippet)
3154 (yas--exit-marker (yas--snippet-exit snippet))
3155 (overlay-end (yas--snippet-control-overlay snippet))))))
3157 (defun yas-exit-all-snippets ()
3158 "Exit all snippets."
3160 (mapc #'(lambda (snippet)
3161 (yas-exit-snippet snippet)
3162 (yas--check-commit-snippet))
3163 (yas--snippets-at-point 'all-snippets)))
3166 ;;; Some low level snippet-routines:
3168 (defvar yas--inhibit-overlay-hooks nil
3169 "Bind this temporarily to non-nil to prevent running `yas--on-*-modification'.")
3171 (defmacro yas--inhibit-overlay-hooks (&rest body)
3172 "Run BODY with `yas--inhibit-overlay-hooks' set to t."
3173 (declare (indent 0))
3174 `(let ((yas--inhibit-overlay-hooks t))
3177 (defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
3178 (defvar yas-snippet-end nil "End position of the last snippet committed.")
3180 (defun yas--commit-snippet (snippet)
3181 "Commit SNIPPET, but leave point as it is.
3183 This renders the snippet as ordinary text."
3185 (let ((control-overlay (yas--snippet-control-overlay snippet)))
3187 ;; Save the end of the moribund snippet in case we need to revive it
3188 ;; its original expansion.
3190 (when (and control-overlay
3191 (overlay-buffer control-overlay))
3192 (setq yas-snippet-beg (overlay-start control-overlay))
3193 (setq yas-snippet-end (overlay-end control-overlay))
3194 (delete-overlay control-overlay))
3196 (yas--inhibit-overlay-hooks
3197 (when yas--active-field-overlay
3198 (delete-overlay yas--active-field-overlay))
3199 (when yas--field-protection-overlays
3200 (mapc #'delete-overlay yas--field-protection-overlays)))
3202 ;; stacked expansion: if the original expansion took place from a
3203 ;; field, make sure we advance it here at least to
3204 ;; `yas-snippet-end'...
3206 (let ((previous-field (yas--snippet-previous-active-field snippet)))
3207 (when (and yas-snippet-end previous-field)
3208 (yas--advance-end-maybe previous-field yas-snippet-end)))
3210 ;; Convert all markers to points,
3212 (yas--markers-to-points snippet)
3214 ;; Take care of snippet revival
3216 (if yas-snippet-revival
3217 (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
3219 ;; Dismember the snippet... this is useful if we get called
3220 ;; again from `yas--take-care-of-redo'....
3221 (setf (yas--snippet-fields snippet) nil)))
3223 (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
3225 (defun yas--safely-run-hooks (hook-var)
3226 (condition-case error
3227 (run-hooks hook-var)
3229 (yas--message 3 "%s error: %s" hook-var (error-message-string error)))))
3232 (defun yas--check-commit-snippet ()
3233 "Check if point exited the currently active field of the snippet.
3235 If so cleans up the whole snippet up."
3236 (let* ((snippets (yas--snippets-at-point 'all-snippets))
3237 (snippets-left snippets)
3238 (snippet-exit-transform))
3239 (dolist (snippet snippets)
3240 (let ((active-field (yas--snippet-active-field snippet)))
3241 (setq snippet-exit-transform (yas--snippet-force-exit snippet))
3242 (cond ((or snippet-exit-transform
3243 (not (and active-field (yas--field-contains-point-p active-field))))
3244 (setq snippets-left (delete snippet snippets-left))
3245 (setf (yas--snippet-force-exit snippet) nil)
3246 (yas--commit-snippet snippet))
3248 (or (not yas--active-field-overlay)
3249 (not (overlay-buffer yas--active-field-overlay))))
3251 ;; stacked expansion: this case is mainly for recent
3252 ;; snippet exits that place us back int the field of
3256 (yas--move-to-field snippet active-field)
3257 (yas--update-mirrors snippet)))
3260 (unless (or (null snippets) snippets-left)
3261 (if snippet-exit-transform
3262 (yas--eval-lisp-no-saves snippet-exit-transform))
3263 (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
3265 ;; Apropos markers-to-points:
3267 ;; This was found useful for performance reasons, so that an
3268 ;; excessive number of live markers aren't kept around in the
3269 ;; `buffer-undo-list'. However, in `markers-to-points', the
3270 ;; set-to-nil markers can't simply be discarded and replaced with
3271 ;; fresh ones in `points-to-markers'. The original marker that was
3272 ;; just set to nil has to be reused.
3274 ;; This shouldn't bring horrible problems with undo/redo, but it
3277 (defun yas--markers-to-points (snippet)
3278 "Convert all markers in SNIPPET to a cons (POINT . MARKER)
3279 where POINT is the original position of the marker and MARKER is
3280 the original marker object with the position set to nil."
3281 (dolist (field (yas--snippet-fields snippet))
3282 (let ((start (marker-position (yas--field-start field)))
3283 (end (marker-position (yas--field-end field))))
3284 (set-marker (yas--field-start field) nil)
3285 (set-marker (yas--field-end field) nil)
3286 (setf (yas--field-start field) (cons start (yas--field-start field)))
3287 (setf (yas--field-end field) (cons end (yas--field-end field))))
3288 (dolist (mirror (yas--field-mirrors field))
3289 (let ((start (marker-position (yas--mirror-start mirror)))
3290 (end (marker-position (yas--mirror-end mirror))))
3291 (set-marker (yas--mirror-start mirror) nil)
3292 (set-marker (yas--mirror-end mirror) nil)
3293 (setf (yas--mirror-start mirror) (cons start (yas--mirror-start mirror)))
3294 (setf (yas--mirror-end mirror) (cons end (yas--mirror-end mirror))))))
3295 (let ((snippet-exit (yas--snippet-exit snippet)))
3297 (let ((exit (marker-position (yas--exit-marker snippet-exit))))
3298 (set-marker (yas--exit-marker snippet-exit) nil)
3299 (setf (yas--exit-marker snippet-exit) (cons exit (yas--exit-marker snippet-exit)))))))
3301 (defun yas--points-to-markers (snippet)
3302 "Convert all cons (POINT . MARKER) in SNIPPET to markers.
3304 This is done by setting MARKER to POINT with `set-marker'."
3305 (dolist (field (yas--snippet-fields snippet))
3306 (setf (yas--field-start field) (set-marker (cdr (yas--field-start field))
3307 (car (yas--field-start field))))
3308 (setf (yas--field-end field) (set-marker (cdr (yas--field-end field))
3309 (car (yas--field-end field))))
3310 (dolist (mirror (yas--field-mirrors field))
3311 (setf (yas--mirror-start mirror) (set-marker (cdr (yas--mirror-start mirror))
3312 (car (yas--mirror-start mirror))))
3313 (setf (yas--mirror-end mirror) (set-marker (cdr (yas--mirror-end mirror))
3314 (car (yas--mirror-end mirror))))))
3315 (let ((snippet-exit (yas--snippet-exit snippet)))
3317 (setf (yas--exit-marker snippet-exit) (set-marker (cdr (yas--exit-marker snippet-exit))
3318 (car (yas--exit-marker snippet-exit)))))))
3320 (defun yas--field-contains-point-p (field &optional point)
3321 (let ((point (or point
3323 (and (>= point (yas--field-start field))
3324 (<= point (yas--field-end field)))))
3326 (defun yas--field-text-for-display (field)
3327 "Return the propertized display text for field FIELD."
3328 (buffer-substring (yas--field-start field) (yas--field-end field)))
3330 (defun yas--undo-in-progress ()
3331 "True if some kind of undo is in progress."
3332 (or undo-in-progress
3333 (eq this-command 'undo)
3334 (eq this-command 'redo)))
3336 (defun yas--make-control-overlay (snippet start end)
3337 "Create the control overlay that surrounds the snippet and
3339 (let ((overlay (make-overlay start
3344 (overlay-put overlay 'keymap yas-keymap)
3345 (overlay-put overlay 'priority 100)
3346 (overlay-put overlay 'yas--snippet snippet)
3349 (defun yas-skip-and-clear-or-delete-char (&optional field)
3350 "Clears unmodified field if at field start, skips to next tab.
3352 Otherwise deletes a character normally by calling `delete-char'."
3354 (let ((field (or field
3355 (and yas--active-field-overlay
3356 (overlay-buffer yas--active-field-overlay)
3357 (overlay-get yas--active-field-overlay 'yas--field)))))
3359 (not (yas--field-modified-p field))
3360 (eq (point) (marker-position (yas--field-start field))))
3361 (yas--skip-and-clear field)
3364 (call-interactively 'delete-char)))))
3366 (defun yas--skip-and-clear (field)
3367 "Deletes the region of FIELD and sets it's modified state to t."
3368 ;; Just before skipping-and-clearing the field, mark its children
3369 ;; fields as modified, too. If the children have mirrors-in-fields
3370 ;; this prevents them from updating erroneously (we're skipping and
3373 (yas--mark-this-and-children-modified field)
3374 (delete-region (yas--field-start field) (yas--field-end field)))
3376 (defun yas--mark-this-and-children-modified (field)
3377 (setf (yas--field-modified-p field) t)
3378 (let ((fom (yas--field-next field)))
3380 (yas--fom-parent-field fom))
3381 (when (and (eq (yas--fom-parent-field fom) field)
3383 (yas--mark-this-and-children-modified fom))
3384 (setq fom (yas--fom-next fom)))))
3386 (defun yas--make-move-active-field-overlay (snippet field)
3387 "Place the active field overlay in SNIPPET's FIELD.
3389 Move the overlay, or create it if it does not exit."
3390 (if (and yas--active-field-overlay
3391 (overlay-buffer yas--active-field-overlay))
3392 (move-overlay yas--active-field-overlay
3393 (yas--field-start field)
3394 (yas--field-end field))
3395 (setq yas--active-field-overlay
3396 (make-overlay (yas--field-start field)
3397 (yas--field-end field)
3399 (overlay-put yas--active-field-overlay 'priority 100)
3400 (overlay-put yas--active-field-overlay 'face 'yas-field-highlight-face)
3401 (overlay-put yas--active-field-overlay 'yas--snippet snippet)
3402 (overlay-put yas--active-field-overlay 'modification-hooks '(yas--on-field-overlay-modification))
3403 (overlay-put yas--active-field-overlay 'insert-in-front-hooks
3404 '(yas--on-field-overlay-modification))
3405 (overlay-put yas--active-field-overlay 'insert-behind-hooks
3406 '(yas--on-field-overlay-modification))))
3408 (defun yas--on-field-overlay-modification (overlay after? _beg _end &optional _length)
3409 "Clears the field and updates mirrors, conditionally.
3411 Only clears the field if it hasn't been modified and it point it
3412 at field start. This hook doesn't do anything if an undo is in
3414 (unless (or yas--inhibit-overlay-hooks
3415 (yas--undo-in-progress))
3416 (let* ((field (overlay-get overlay 'yas--field))
3417 (snippet (overlay-get yas--active-field-overlay 'yas--snippet)))
3419 (yas--advance-end-maybe field (overlay-end overlay))
3421 (yas--field-update-display field))
3422 (yas--update-mirrors snippet))
3424 (when (and (not after?)
3425 (not (yas--field-modified-p field))
3426 (eq (point) (if (markerp (yas--field-start field))
3427 (marker-position (yas--field-start field))
3428 (yas--field-start field))))
3429 (yas--skip-and-clear field))
3430 (setf (yas--field-modified-p field) t))))))
3432 ;;; Apropos protection overlays:
3434 ;; These exist for nasty users who will try to delete parts of the
3435 ;; snippet outside the active field. Actual protection happens in
3436 ;; `yas--on-protection-overlay-modification'.
3438 ;; Currently this signals an error which inhibits the command. For
3439 ;; commands that move point (like `kill-line'), point is restored in
3440 ;; the `yas--post-command-handler' using a global
3441 ;; `yas--protection-violation' variable.
3443 ;; Alternatively, I've experimented with an implementation that
3444 ;; commits the snippet before actually calling `this-command'
3445 ;; interactively, and then signals an error, which is ignored. but
3446 ;; blocks all other million modification hooks. This presented some
3447 ;; problems with stacked expansion.
3449 (defun yas--make-move-field-protection-overlays (snippet field)
3450 "Place protection overlays surrounding SNIPPET's FIELD.
3452 Move the overlays, or create them if they do not exit."
3453 (let ((start (yas--field-start field))
3454 (end (yas--field-end field)))
3455 ;; First check if the (1+ end) is contained in the buffer,
3456 ;; otherwise we'll have to do a bit of cheating and silently
3457 ;; insert a newline. the `(1+ (buffer-size))' should prevent this
3458 ;; when using stacked expansion
3460 (when (< (buffer-size) end)
3462 (yas--inhibit-overlay-hooks
3463 (goto-char (point-max))
3465 ;; go on to normal overlay creation/moving
3467 (cond ((and yas--field-protection-overlays
3468 (every #'overlay-buffer yas--field-protection-overlays))
3469 (move-overlay (first yas--field-protection-overlays) (1- start) start)
3470 (move-overlay (second yas--field-protection-overlays) end (1+ end)))
3472 (setq yas--field-protection-overlays
3473 (list (make-overlay (1- start) start nil t nil)
3474 (make-overlay end (1+ end) nil t nil)))
3475 (dolist (ov yas--field-protection-overlays)
3476 (overlay-put ov 'face 'yas--field-debug-face)
3477 (overlay-put ov 'yas--snippet snippet)
3478 ;; (overlay-put ov 'evaporate t)
3479 (overlay-put ov 'modification-hooks '(yas--on-protection-overlay-modification)))))))
3481 (defvar yas--protection-violation nil
3482 "When non-nil, signals attempts to erroneously exit or modify the snippet.
3484 Functions in the `post-command-hook', for example
3485 `yas--post-command-handler' can check it and reset its value to
3486 nil. The variables value is the point where the violation
3489 (defun yas--on-protection-overlay-modification (_overlay after? _beg _end &optional _length)
3490 "Signals a snippet violation, then issues error.
3492 The error should be ignored in `debug-ignored-errors'"
3493 (unless yas--inhibit-overlay-hooks
3494 (cond ((not (or after?
3495 (yas--undo-in-progress)))
3496 (setq yas--protection-violation (point))
3497 (error "Exit the snippet first!")))))
3499 (add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
3502 ;;; Snippet expansion and "stacked" expansion:
3504 ;; Stacked expansion is when you try to expand a snippet when already
3505 ;; inside a snippet expansion.
3507 ;; The parent snippet does not run its fields modification hooks
3508 ;; (`yas--on-field-overlay-modification' and
3509 ;; `yas--on-protection-overlay-modification') while the child snippet
3510 ;; is active. This means, among other things, that the mirrors of the
3511 ;; parent snippet are not updated, this only happening when one exits
3512 ;; the child snippet.
3514 ;; Unfortunately, this also puts some ugly (and not fully-tested)
3515 ;; bits of code in `yas-expand-snippet' and
3516 ;; `yas--commit-snippet'. I've tried to mark them with "stacked
3519 ;; This was thought to be safer in an undo/redo perspective, but
3520 ;; maybe the correct implementation is to make the globals
3521 ;; `yas--active-field-overlay' and `yas--field-protection-overlays' be
3522 ;; snippet-local and be active even while the child snippet is
3523 ;; running. This would mean a lot of overlay modification hooks
3524 ;; running, but if managed correctly (including overlay priorities)
3525 ;; they should account for all situations...
3527 (defun yas-expand-snippet (content &optional start end expand-env)
3528 "Expand snippet CONTENT at current point.
3530 Text between START and END will be deleted before inserting
3531 template. EXPAND-ENV is are let-style variable to value bindings
3532 considered when expanding the snippet."
3533 (run-hooks 'yas-before-expand-snippet-hook)
3536 (let* ((yas-selected-text (or yas-selected-text
3537 (and (region-active-p)
3538 (buffer-substring-no-properties (region-beginning)
3541 (and (region-active-p)
3545 (and (region-active-p)
3548 (to-delete (and start
3550 (buffer-substring-no-properties start end)))
3553 (setq yas--indent-original-column (current-column))
3554 ;; Delete the region to delete, this *does* get undo-recorded.
3556 (when (and to-delete
3558 (delete-region start end))
3560 (cond ((listp content)
3561 ;; x) This is a snippet-command
3563 (yas--eval-lisp-no-saves content))
3565 ;; x) This is a snippet-snippet :-)
3567 ;; Narrow the region down to the content, shoosh the
3568 ;; `buffer-undo-list', and create the snippet, the new
3569 ;; snippet updates its mirrors once, so we are left with
3570 ;; some plain text. The undo action for deleting this
3571 ;; plain text will get recorded at the end.
3573 ;; stacked expansion: also shoosh the overlay modification hooks
3574 (let ((buffer-undo-list t))
3575 ;; snippet creation might evaluate users elisp, which
3576 ;; might generate errors, so we have to be ready to catch
3577 ;; them mostly to make the undo information
3579 (setq yas--start-column (current-column))
3580 (yas--inhibit-overlay-hooks
3583 (eval `(let* ,expand-env
3585 (yas--snippet-create start (point))))
3587 (yas--snippet-create start (point))))))
3589 ;; stacked-expansion: This checks for stacked expansion, save the
3590 ;; `yas--previous-active-field' and advance its boundary.
3592 (let ((existing-field (and yas--active-field-overlay
3593 (overlay-buffer yas--active-field-overlay)
3594 (overlay-get yas--active-field-overlay 'yas--field))))
3595 (when existing-field
3596 (setf (yas--snippet-previous-active-field snippet) existing-field)
3597 (yas--advance-end-maybe existing-field (overlay-end yas--active-field-overlay))))
3599 ;; Exit the snippet immediately if no fields
3601 (unless (yas--snippet-fields snippet)
3602 (yas-exit-snippet snippet))
3604 ;; Push two undo actions: the deletion of the inserted contents of
3605 ;; the new snippet (without the "key") followed by an apply of
3606 ;; `yas--take-care-of-redo' on the newly inserted snippet boundaries
3608 ;; A small exception, if `yas-also-auto-indent-first-line'
3609 ;; is t and `yas--indent' decides to indent the line to a
3610 ;; point before the actual expansion point, undo would be
3611 ;; messed up. We call the early point "newstart"". case,
3612 ;; and attempt to fix undo.
3614 (let ((newstart (overlay-start (yas--snippet-control-overlay snippet)))
3615 (end (overlay-end (yas--snippet-control-overlay snippet))))
3616 (when (< newstart start)
3617 (push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
3618 (push (cons newstart end) buffer-undo-list)
3619 (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
3621 ;; Now, schedule a move to the first field
3623 (let ((first-field (car (yas--snippet-fields snippet))))
3625 (sit-for 0) ;; fix issue 125
3626 (yas--move-to-field snippet first-field)))
3627 (yas--message 3 "snippet expanded.")
3630 (defun yas--take-care-of-redo (_beg _end snippet)
3631 "Commits SNIPPET, which in turn pushes an undo action for reviving it.
3633 Meant to exit in the `buffer-undo-list'."
3634 ;; slightly optimize: this action is only needed for snippets with
3635 ;; at least one field
3636 (when (yas--snippet-fields snippet)
3637 (yas--commit-snippet snippet)))
3639 (defun yas--snippet-revive (beg end snippet)
3640 "Revives SNIPPET and creates a control overlay from BEG to END.
3642 BEG and END are, we hope, the original snippets boundaries.
3643 All the markers/points exiting existing inside SNIPPET should point
3644 to their correct locations *at the time the snippet is revived*.
3646 After revival, push the `yas--take-care-of-redo' in the
3648 ;; Reconvert all the points to markers
3650 (yas--points-to-markers snippet)
3651 ;; When at least one editable field existed in the zombie snippet,
3652 ;; try to revive the whole thing...
3654 (let ((target-field (or (yas--snippet-active-field snippet)
3655 (car (yas--snippet-fields snippet)))))
3657 (setf (yas--snippet-control-overlay snippet) (yas--make-control-overlay snippet beg end))
3658 (overlay-put (yas--snippet-control-overlay snippet) 'yas--snippet snippet)
3660 (yas--move-to-field snippet target-field)
3662 (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
3663 buffer-undo-list))))
3665 (defun yas--snippet-create (begin end)
3666 "Create a snippet from a template inserted at BEGIN to END.
3668 Returns the newly created snippet."
3670 (narrow-to-region begin end)
3671 (let ((snippet (yas--make-snippet)))
3673 (yas--snippet-parse-create snippet)
3675 ;; Sort and link each field
3676 (yas--snippet-sort-fields snippet)
3678 ;; Create keymap overlay for snippet
3679 (setf (yas--snippet-control-overlay snippet)
3680 (yas--make-control-overlay snippet (point-min) (point-max)))
3683 (goto-char (point-max))
3688 ;;; Apropos adjacencies and "fom's":
3690 ;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
3691 ;; recently expanded snippet, we might actually have many fields,
3692 ;; mirrors (and the snippet exit) in the very same position in the
3693 ;; buffer. Therefore we need to single-link the
3694 ;; fields-or-mirrors-or-exit (which I have abbreviated to "fom")
3695 ;; according to their original positions in the buffer.
3697 ;; Then we have operation `yas--advance-end-maybe' and
3698 ;; `yas--advance-start-maybe', which conditionally push the starts and
3699 ;; ends of these foms down the chain.
3701 ;; This allows for like the printf with the magic ",":
3703 ;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
3704 ;; $2${1:$(if (string-match "%" text) "\);" "")}$0
3706 (defun yas--fom-start (fom)
3707 (cond ((yas--field-p fom)
3708 (yas--field-start fom))
3709 ((yas--mirror-p fom)
3710 (yas--mirror-start fom))
3712 (yas--exit-marker fom))))
3714 (defun yas--fom-end (fom)
3715 (cond ((yas--field-p fom)
3716 (yas--field-end fom))
3717 ((yas--mirror-p fom)
3718 (yas--mirror-end fom))
3720 (yas--exit-marker fom))))
3722 (defun yas--fom-next (fom)
3723 (cond ((yas--field-p fom)
3724 (yas--field-next fom))
3725 ((yas--mirror-p fom)
3726 (yas--mirror-next fom))
3728 (yas--exit-next fom))))
3730 (defun yas--fom-parent-field (fom)
3731 (cond ((yas--field-p fom)
3732 (yas--field-parent-field fom))
3733 ((yas--mirror-p fom)
3734 (yas--mirror-parent-field fom))
3738 (defun yas--calculate-adjacencies (snippet)
3739 "Calculate adjacencies for fields or mirrors of SNIPPET.
3741 This is according to their relative positions in the buffer, and
3742 has to be called before the $-constructs are deleted."
3743 (let* ((fom-set-next-fom
3744 (lambda (fom nextfom)
3745 (cond ((yas--field-p fom)
3746 (setf (yas--field-next fom) nextfom))
3747 ((yas--mirror-p fom)
3748 (setf (yas--mirror-next fom) nextfom))
3750 (setf (yas--exit-next fom) nextfom)))))
3753 (if (= (yas--fom-start fom2) (yas--fom-start fom1))
3754 (yas--mirror-p fom2)
3755 (>= (yas--fom-start fom2) (yas--fom-start fom1)))))
3756 (link-foms fom-set-next-fom))
3757 ;; make some yas--field, yas--mirror and yas--exit soup
3759 (when (yas--snippet-exit snippet)
3760 (push (yas--snippet-exit snippet) soup))
3761 (dolist (field (yas--snippet-fields snippet))
3763 (dolist (mirror (yas--field-mirrors field))
3764 (push mirror soup)))
3766 (sort soup compare-fom-begs))
3768 (reduce link-foms soup)))))
3770 (defun yas--calculate-mirrors-in-fields (snippet mirror)
3771 "Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
3773 Use the tightest containing field if more than one field contains
3774 the mirror. Intended to be called *before* the dollar-regions are
3776 (let ((min (point-min))
3778 (dolist (field (yas--snippet-fields snippet))
3779 (when (and (<= (yas--field-start field) (yas--mirror-start mirror))
3780 (<= (yas--mirror-end mirror) (yas--field-end field))
3781 (< min (yas--field-start field))
3782 (< (yas--field-end field) max))
3783 (setq min (yas--field-start field)
3784 max (yas--field-end field))
3785 (setf (yas--mirror-parent-field mirror) field)))))
3787 (defun yas--advance-end-maybe (fom newend)
3788 "Maybe advance FOM's end to NEWEND if it needs it.
3792 * call `yas--advance-start-maybe' on FOM's next fom.
3794 * in case FOM is field call `yas--advance-end-maybe' on its parent
3797 Also, if FOM is an exit-marker, always call
3798 `yas--advance-start-maybe' on its next fom. This is because
3799 exit-marker have identical start and end markers."
3800 (cond ((and fom (< (yas--fom-end fom) newend))
3801 (set-marker (yas--fom-end fom) newend)
3802 (yas--advance-start-maybe (yas--fom-next fom) newend)
3803 (yas--advance-end-of-parents-maybe (yas--fom-parent-field fom) newend))
3805 (yas--advance-start-maybe (yas--fom-next fom) newend))))
3807 (defun yas--advance-start-maybe (fom newstart)
3808 "Maybe advance FOM's start to NEWSTART if it needs it.
3810 If it does, also call `yas--advance-end-maybe' on FOM."
3811 (when (and fom (< (yas--fom-start fom) newstart))
3812 (set-marker (yas--fom-start fom) newstart)
3813 (yas--advance-end-maybe fom newstart)))
3815 (defun yas--advance-end-of-parents-maybe (field newend)
3816 "Like `yas--advance-end-maybe' but for parent fields.
3818 Only works for fields and doesn't care about the start of the
3819 next FOM. Works its way up recursively for parents of parents."
3821 (< (yas--field-end field) newend))
3822 (set-marker (yas--field-end field) newend)
3823 (yas--advance-end-of-parents-maybe (yas--field-parent-field field) newend)))
3825 (defvar yas--dollar-regions nil
3826 "When expanding the snippet the \"parse-create\" functions add
3827 cons cells to this var.")
3829 (defvar yas--backquote-markers-and-strings nil
3830 "List of (MARKER . STRING) marking where the values from
3831 backquoted Lisp expressions should be inserted at the end of
3834 (defun yas--snippet-parse-create (snippet)
3835 "Parse a recently inserted snippet template, creating all
3836 necessary fields, mirrors and exit points.
3838 Meant to be called in a narrowed buffer, does various passes"
3839 (let ((parse-start (point)))
3840 ;; Reset the yas--dollar-regions
3842 (setq yas--dollar-regions nil)
3843 ;; protect just the backquotes
3845 (yas--protect-escapes nil '(?`))
3846 ;; replace all backquoted expressions
3848 (goto-char parse-start)
3849 (yas--save-backquotes)
3850 ;; protect escaped characters
3852 (yas--protect-escapes)
3853 ;; parse fields with {}
3855 (goto-char parse-start)
3856 (yas--field-parse-create snippet)
3857 ;; parse simple mirrors and fields
3859 (goto-char parse-start)
3860 (yas--simple-mirror-parse-create snippet)
3861 ;; parse mirror transforms
3863 (goto-char parse-start)
3864 (yas--transform-mirror-parse-create snippet)
3865 ;; calculate adjacencies of fields and mirrors
3867 (yas--calculate-adjacencies snippet)
3868 ;; Delete $-constructs
3870 (save-restriction (widen) (yas--delete-regions yas--dollar-regions))
3871 ;; restore backquoted expression values
3873 (yas--restore-backquotes)
3876 (goto-char parse-start)
3877 (yas--restore-escapes)
3878 ;; update mirrors for the first time
3880 (yas--update-mirrors snippet)
3881 ;; indent the best we can
3883 (goto-char parse-start)
3884 (yas--indent snippet)))
3886 (defun yas--indent-according-to-mode (snippet-markers)
3887 "Indent current line according to mode, preserving SNIPPET-MARKERS."
3888 ;;; Apropos indenting problems....
3890 ;; `indent-according-to-mode' uses whatever `indent-line-function'
3891 ;; is available. Some implementations of these functions delete text
3892 ;; before they insert. If there happens to be a marker just after
3893 ;; the text being deleted, the insertion actually happens after the
3894 ;; marker, which misplaces it.
3896 ;; This would also happen if we had used overlays with the
3897 ;; `front-advance' property set to nil.
3899 ;; This is why I have these `trouble-markers', they are the ones at
3900 ;; they are the ones at the first non-whitespace char at the line
3901 ;; (i.e. at `yas--real-line-beginning'. After indentation takes place
3902 ;; we should be at the correct to restore them to. All other
3903 ;; non-trouble-markers have been *pushed* and don't need special
3906 (goto-char (yas--real-line-beginning))
3907 (let ((trouble-markers (remove-if-not #'(lambda (marker)
3913 (indent-according-to-mode)
3914 (error (yas--message 3 "Warning: `yas--indent-according-to-mode' having problems running %s" indent-line-function)
3916 (mapc #'(lambda (marker)
3917 (set-marker marker (point)))
3920 (defvar yas--indent-original-column nil)
3921 (defun yas--indent (snippet)
3922 (let ((snippet-markers (yas--collect-snippet-markers snippet)))
3923 ;; Look for those $>
3925 (while (re-search-forward "$>" nil t)
3926 (delete-region (match-beginning 0) (match-end 0))
3927 (when (not (eq yas-indent-line 'auto))
3928 (yas--indent-according-to-mode snippet-markers))))
3929 ;; Now do stuff for 'fixed and 'auto
3931 (cond ((eq yas-indent-line 'fixed)
3932 (while (and (zerop (forward-line))
3933 (zerop (current-column)))
3934 (indent-to-column yas--indent-original-column)))
3935 ((eq yas-indent-line 'auto)
3936 (let ((end (set-marker (make-marker) (point-max)))
3937 (indent-first-line-p yas-also-auto-indent-first-line))
3938 (while (and (zerop (if indent-first-line-p
3941 (setq indent-first-line-p nil))
3945 (yas--indent-according-to-mode snippet-markers))))
3949 (defun yas--collect-snippet-markers (snippet)
3950 "Make a list of all the markers used by SNIPPET."
3952 (dolist (field (yas--snippet-fields snippet))
3953 (push (yas--field-start field) markers)
3954 (push (yas--field-end field) markers)
3955 (dolist (mirror (yas--field-mirrors field))
3956 (push (yas--mirror-start mirror) markers)
3957 (push (yas--mirror-end mirror) markers)))
3958 (let ((snippet-exit (yas--snippet-exit snippet)))
3959 (when (and snippet-exit
3960 (marker-buffer (yas--exit-marker snippet-exit)))
3961 (push (yas--exit-marker snippet-exit) markers)))
3964 (defun yas--real-line-beginning ()
3965 (let ((c (char-after (line-beginning-position)))
3966 (n (line-beginning-position)))
3967 (while (or (eql c ?\ )
3970 (setq c (char-after n)))
3973 (defun yas--escape-string (escaped)
3974 (concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
3976 (defun yas--protect-escapes (&optional text escaped)
3977 "Protect all escaped characters with their numeric ASCII value.
3979 With optional string TEXT do it in string instead of buffer."
3980 (let ((changed-text text)
3981 (text-provided-p text))
3982 (mapc #'(lambda (escaped)
3984 (yas--replace-all (concat "\\" (char-to-string escaped))
3985 (yas--escape-string escaped)
3986 (when text-provided-p changed-text))))
3987 (or escaped yas--escaped-characters))
3990 (defun yas--restore-escapes (&optional text escaped)
3991 "Restore all escaped characters from their numeric ASCII value.
3993 With optional string TEXT do it in string instead of the buffer."
3994 (let ((changed-text text)
3995 (text-provided-p text))
3996 (mapc #'(lambda (escaped)
3998 (yas--replace-all (yas--escape-string escaped)
3999 (char-to-string escaped)
4000 (when text-provided-p changed-text))))
4001 (or escaped yas--escaped-characters))
4004 (defun yas--save-backquotes ()
4005 "Save all the \"`(lisp-expression)`\"-style expressions
4006 with their evaluated value into `yas--backquote-markers-and-strings'."
4007 (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
4008 (let ((current-string (match-string-no-properties 1)) transformed)
4009 (save-restriction (widen)
4010 (delete-region (match-beginning 0) (match-end 0)))
4011 (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
4012 (goto-char (match-beginning 0))
4014 (let ((marker (make-marker)))
4017 (insert "Y") ;; quite horrendous, I love it :)
4018 (set-marker marker (point))
4020 (push (cons marker transformed) yas--backquote-markers-and-strings))))))
4022 (defun yas--restore-backquotes ()
4023 "Replace markers in `yas--backquote-markers-and-strings' with their values."
4024 (while yas--backquote-markers-and-strings
4025 (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
4026 (marker (car marker-and-string))
4027 (string (cdr marker-and-string)))
4035 (set-marker marker nil)))))
4037 (defun yas--scan-sexps (from count)
4039 (with-syntax-table (standard-syntax-table)
4040 (scan-sexps from count))
4044 (defun yas--make-marker (pos)
4045 "Create a marker at POS with nil `marker-insertion-type'."
4046 (let ((marker (set-marker (make-marker) pos)))
4047 (set-marker-insertion-type marker nil)
4050 (defun yas--field-parse-create (snippet &optional parent-field)
4051 "Parse most field expressions in SNIPPET, except for the simple one \"$n\".
4053 The following count as a field:
4055 * \"${n: text}\", for a numbered field with default text, as long as N is not 0;
4057 * \"${n: text$(expression)}, the same with a Lisp expression;
4058 this is caught with the curiously named `yas--multi-dollar-lisp-expression-regexp'
4060 * the same as above but unnumbered, (no N:) and number is calculated automatically.
4062 When multiple expressions are found, only the last one counts."
4065 (while (re-search-forward yas--field-regexp nil t)
4066 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4067 (number (and (match-string-no-properties 1)
4068 (string-to-number (match-string-no-properties 1))))
4069 (brand-new-field (and real-match-end-0
4070 ;; break if on "$(" immediately
4071 ;; after the ":", this will be
4072 ;; caught as a mirror with
4074 (not (save-match-data
4075 (eq (string-match "$[ \t\n]*("
4076 (match-string-no-properties 2)) 0)))
4077 ;; allow ${0: some exit text}
4078 ;; (not (and number (zerop number)))
4079 (yas--make-field number
4080 (yas--make-marker (match-beginning 2))
4081 (yas--make-marker (1- real-match-end-0))
4083 (when brand-new-field
4084 (goto-char real-match-end-0)
4085 (push (cons (1- real-match-end-0) real-match-end-0)
4086 yas--dollar-regions)
4087 (push (cons (match-beginning 0) (match-beginning 2))
4088 yas--dollar-regions)
4089 (push brand-new-field (yas--snippet-fields snippet))
4092 (narrow-to-region (yas--field-start brand-new-field) (yas--field-end brand-new-field))
4093 (goto-char (point-min))
4094 (yas--field-parse-create snippet brand-new-field)))))))
4095 ;; if we entered from a parent field, now search for the
4096 ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
4097 ;; primary field transformations
4101 (while (re-search-forward yas--multi-dollar-lisp-expression-regexp nil t)
4102 (let* ((real-match-end-1 (yas--scan-sexps (match-beginning 1) 1)))
4103 ;; commit the primary field transformation if:
4105 ;; 1. we don't find it in yas--dollar-regions (a subnested
4106 ;; field) might have already caught it.
4108 ;; 2. we really make sure we have either two '$' or some
4109 ;; text and a '$' after the colon ':'. This is a FIXME: work
4110 ;; my regular expressions and end these ugly hacks.
4112 (when (and real-match-end-1
4113 (not (member (cons (match-beginning 0)
4115 yas--dollar-regions))
4117 (char-before (1- (match-beginning 1))))))
4118 (let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
4120 (setf (yas--field-transform parent-field)
4121 (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
4122 (push (cons (match-beginning 0) real-match-end-1)
4123 yas--dollar-regions)))))))
4125 (defun yas--transform-mirror-parse-create (snippet)
4126 "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
4127 (while (re-search-forward yas--transform-mirror-regexp nil t)
4128 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4129 (number (string-to-number (match-string-no-properties 1)))
4131 (not (zerop number))
4132 (yas--snippet-find-field snippet number)))
4134 (and real-match-end-0
4136 (yas--make-mirror (yas--make-marker (match-beginning 0))
4137 (yas--make-marker (match-beginning 0))
4139 (yas--restore-escapes
4140 (buffer-substring-no-properties (match-beginning 2)
4141 (1- real-match-end-0))))))))
4142 (when brand-new-mirror
4143 (push brand-new-mirror
4144 (yas--field-mirrors field))
4145 (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
4146 (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
4148 (defun yas--simple-mirror-parse-create (snippet)
4149 "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
4150 (while (re-search-forward yas--simple-mirror-regexp nil t)
4151 (let ((number (string-to-number (match-string-no-properties 1))))
4152 (cond ((zerop number)
4154 (setf (yas--snippet-exit snippet)
4155 (yas--make-exit (yas--make-marker (match-end 0))))
4157 (goto-char (match-beginning 0))
4158 (when yas-wrap-around-region
4159 (cond (yas-selected-text
4160 (insert yas-selected-text))
4161 ((and (eq yas-wrap-around-region 'cua)
4164 (insert (prog1 (get-register ?0)
4165 (set-register ?0 nil))))))
4166 (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
4167 yas--dollar-regions)))
4169 (let ((field (yas--snippet-find-field snippet number)))
4171 (let ((brand-new-mirror (yas--make-mirror
4172 (yas--make-marker (match-beginning 0))
4173 (yas--make-marker (match-beginning 0))
4175 (push brand-new-mirror
4176 (yas--field-mirrors field))
4177 (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
4178 (push (yas--make-field number
4179 (yas--make-marker (match-beginning 0))
4180 (yas--make-marker (match-beginning 0))
4182 (yas--snippet-fields snippet))))
4183 (push (cons (match-beginning 0) (match-end 0))
4184 yas--dollar-regions))))))
4186 (defun yas--delete-regions (regions)
4187 "Sort disjuct REGIONS by start point, then delete from the back."
4188 (mapc #'(lambda (reg)
4189 (delete-region (car reg) (cdr reg)))
4192 (>= (car r1) (car r2))))))
4194 (defun yas--calculate-mirror-depth (mirror &optional traversed)
4195 (let* ((parent (yas--mirror-parent-field mirror))
4196 (parents-mirrors (and parent
4197 (yas--field-mirrors parent))))
4198 (or (yas--mirror-depth mirror)
4199 (setf (yas--mirror-depth mirror)
4200 (cond ((memq mirror traversed)
4202 ((and parent parents-mirrors)
4204 (mapcar #'(lambda (m)
4205 (yas--calculate-mirror-depth m
4214 (defun yas--update-mirrors (snippet)
4215 "Update all the mirrors of SNIPPET."
4217 (dolist (field-and-mirror (sort
4218 ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
4219 ;; where F is the field that M is mirroring
4221 (mapcan #'(lambda (field)
4222 (mapcar #'(lambda (mirror)
4223 (cons field mirror))
4224 (yas--field-mirrors field)))
4225 (yas--snippet-fields snippet))
4226 ;; then sort this list so that entries with mirrors with parent
4227 ;; fields appear before. This was important for fixing #290, and
4228 ;; luckily also handles the case where a mirror in a field causes
4229 ;; another mirror to need reupdating
4231 #'(lambda (field-and-mirror1 field-and-mirror2)
4232 (> (yas--calculate-mirror-depth (cdr field-and-mirror1))
4233 (yas--calculate-mirror-depth (cdr field-and-mirror2))))))
4234 (let* ((field (car field-and-mirror))
4235 (mirror (cdr field-and-mirror))
4236 (parent-field (yas--mirror-parent-field mirror)))
4237 ;; before updating a mirror with a parent-field, maybe advance
4241 (yas--advance-start-maybe mirror (yas--fom-start parent-field)))
4242 ;; update this mirror
4244 (yas--mirror-update-display mirror field)
4245 ;; `yas--place-overlays' is needed if the active field and
4246 ;; protected overlays have been changed because of insertions
4247 ;; in `yas--mirror-update-display'
4249 (when (eq field (yas--snippet-active-field snippet))
4250 (yas--place-overlays snippet field))))))
4252 (defun yas--mirror-update-display (mirror field)
4253 "Update MIRROR according to FIELD (and mirror transform)."
4255 (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
4256 (reflection (and (not (and mirror-parent-field
4257 (yas--field-modified-p mirror-parent-field)))
4258 (or (yas--apply-transform mirror field 'empty-on-nil)
4259 (yas--field-text-for-display field)))))
4260 (when (and reflection
4261 (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
4262 (yas--mirror-end mirror)))))
4263 (goto-char (yas--mirror-start mirror))
4264 (yas--inhibit-overlay-hooks
4265 (insert reflection))
4266 (if (> (yas--mirror-end mirror) (point))
4267 (delete-region (point) (yas--mirror-end mirror))
4268 (set-marker (yas--mirror-end mirror) (point))
4269 (yas--advance-start-maybe (yas--mirror-next mirror) (point))
4270 ;; super-special advance
4271 (yas--advance-end-of-parents-maybe mirror-parent-field (point))))))
4273 (defun yas--field-update-display (field)
4274 "Much like `yas--mirror-update-display', but for fields."
4275 (when (yas--field-transform field)
4276 (let ((transformed (and (not (eq (yas--field-number field) 0))
4277 (yas--apply-transform field field))))
4278 (when (and transformed
4279 (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
4280 (yas--field-end field)))))
4281 (setf (yas--field-modified-p field) t)
4282 (goto-char (yas--field-start field))
4283 (yas--inhibit-overlay-hooks
4284 (insert transformed)
4285 (if (> (yas--field-end field) (point))
4286 (delete-region (point) (yas--field-end field))
4287 (set-marker (yas--field-end field) (point))
4288 (yas--advance-start-maybe (yas--field-next field) (point)))
4292 ;;; Post-command hook:
4294 (defun yas--post-command-handler ()
4295 "Handles various yasnippet conditions after each command."
4296 (cond (yas--protection-violation
4297 (goto-char yas--protection-violation)
4298 (setq yas--protection-violation nil))
4299 ((eq 'undo this-command)
4301 ;; After undo revival the correct field is sometimes not
4302 ;; restored correctly, this condition handles that
4304 (let* ((snippet (car (yas--snippets-at-point)))
4305 (target-field (and snippet
4306 (find-if-not #'(lambda (field)
4307 (yas--field-probably-deleted-p snippet field))
4309 (cons (yas--snippet-active-field snippet)
4310 (yas--snippet-fields snippet)))))))
4312 (yas--move-to-field snippet target-field))))
4313 ((not (yas--undo-in-progress))
4314 ;; When not in an undo, check if we must commit the snippet
4315 ;; (user exited it).
4316 (yas--check-commit-snippet))))
4320 ;; The docstrings for some functions are generated dynamically
4321 ;; depending on the context.
4323 (put 'yas-expand 'function-documentation
4324 '(yas--expand-from-trigger-key-doc t))
4325 (defun yas--expand-from-trigger-key-doc (context)
4326 "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
4327 (let* ((yas-fallback-behavior (and context yas-fallback-behavior))
4328 (fallback-description
4329 (cond ((eq yas-fallback-behavior 'call-other-command)
4330 (let* ((fallback (yas--keybinding-beyond-yasnippet)))
4332 (format "call command `%s'."
4333 (pp-to-string fallback)))
4334 "do nothing (`yas-expand' doesn't shadow\nanything).")))
4335 ((eq yas-fallback-behavior 'return-nil)
4337 (t "defer to `yas-fallback-behavior' (which see)."))))
4338 (concat "Expand a snippet before point. If no snippet
4339 expansion is possible, "
4340 fallback-description
4341 "\n\nOptional argument FIELD is for non-interactive use and is an
4342 object satisfying `yas--field-p' to restrict the expansion to.")))
4344 (put 'yas-expand-from-keymap 'function-documentation
4345 '(yas--expand-from-keymap-doc t))
4346 (defun yas--expand-from-keymap-doc (context)
4347 "A doc synthesizer for `yas--expand-from-keymap-doc'."
4348 (add-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce)
4349 (concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
4350 (when (and context (eq this-command 'describe-key))
4351 (let* ((vec (this-single-command-keys))
4352 (templates (mapcan #'(lambda (table)
4353 (yas--fetch table vec))
4354 (yas--get-snippet-tables)))
4355 (yas--direct-keymaps nil)
4356 (fallback (key-binding vec)))
4357 (concat "In this case, "
4359 (concat "these snippets are bound to this key:\n"
4360 (yas--template-pretty-list templates)
4361 "\n\nIf none of these expands, "))
4363 (format "fallback `%s' will be called." (pp-to-string fallback)))
4364 "no fallback keybinding is called."))))))
4366 (defun yas--template-pretty-list (templates)
4368 (yas-buffer-local-condition 'always))
4369 (dolist (plate templates)
4370 (setq acc (concat acc "\n*) "
4371 (propertize (concat "\\\\snippet `" (car plate) "'")
4372 'yasnippet (cdr plate)))))
4375 (define-button-type 'help-snippet-def
4376 :supertype 'help-xref
4377 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
4378 'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
4380 (defun yas--snippet-description-finish-runonce ()
4381 "Final adjustments for the help buffer when snippets are concerned."
4382 (yas--create-snippet-xrefs)
4383 (remove-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce))
4385 (defun yas--create-snippet-xrefs ()
4387 (goto-char (point-min))
4388 (while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
4389 (let ((template (get-text-property (match-beginning 1)
4392 (help-xref-button 1 'help-snippet-def template)
4393 (kill-region (match-end 1) (match-end 0))
4394 (kill-region (match-beginning 0) (match-beginning 1)))))))
4398 (defvar yas-verbosity 4
4399 "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
4401 (defun yas--message (level message &rest args)
4402 "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
4403 (when (> yas-verbosity level)
4404 (message "%s" (apply #'yas--format message args))))
4406 (defun yas--warning (format-control &rest format-args)
4407 (let ((msg (apply #'format format-control format-args)))
4408 (display-warning 'yasnippet msg :warning)
4409 (yas--message 1 msg)))
4411 (defun yas--format (format-control &rest format-args)
4412 (apply #'format (concat "[yas] " format-control) format-args))
4419 ;; `locate-dominating-file'
4420 ;; `region-active-p'
4422 ;; added for compatibility in emacsen < 23
4423 (unless (>= emacs-major-version 23)
4424 (unless (fboundp 'region-active-p)
4425 (defun region-active-p () (and transient-mark-mode mark-active)))
4427 (unless (fboundp 'locate-dominating-file)
4428 (defvar locate-dominating-stop-dir-regexp
4429 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
4430 "Regexp of directory names which stop the search in `locate-dominating-file'.
4431 Any directory whose name matches this regexp will be treated like
4432 a kind of root directory by `locate-dominating-file' which will stop its search
4433 when it bumps into it.
4434 The default regexp prevents fruitless and time-consuming attempts to find
4435 special files in directories in which filenames are interpreted as hostnames,
4436 or mount points potentially requiring authentication as a different user.")
4438 (defun locate-dominating-file (file name)
4439 "Look up the directory hierarchy from FILE for a file named NAME.
4440 Stop at the first parent directory containing a file NAME,
4441 and return the directory. Return nil if not found."
4442 ;; We used to use the above locate-dominating-files code, but the
4443 ;; directory-files call is very costly, so we're much better off doing
4444 ;; multiple calls using the code in here.
4446 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
4447 ;; `name' in /home or in /.
4448 (setq file (abbreviate-file-name file))
4451 (while (not (or root
4453 ;; FIXME: Disabled this heuristic because it is sometimes
4455 ;; As a heuristic, we stop looking up the hierarchy of
4456 ;; directories as soon as we find a directory belonging
4457 ;; to another user. This should save us from looking in
4458 ;; things like /net and /afs. This assumes that all the
4459 ;; files inside a project belong to the same user.
4460 ;; (let ((prev-user user))
4461 ;; (setq user (nth 2 (file-attributes file)))
4462 ;; (and prev-user (not (equal user prev-user))))
4463 (string-match locate-dominating-stop-dir-regexp file)))
4464 (setq try (file-exists-p (expand-file-name name file)))
4465 (cond (try (setq root file))
4466 ((equal file (setq file (file-name-directory
4467 (directory-file-name file))))
4472 ;;; Backward compatibility to yasnippet <= 0.7
4474 (defvar yas--backported-syms '(;; `defcustom's
4477 yas-prompt-functions
4479 yas-also-auto-indent-first-line
4481 yas-triggers-in-field
4482 yas-fallback-behavior
4483 yas-choose-keys-first
4484 yas-choose-tables-first
4487 yas-wrap-around-region
4490 yas-expand-only-for-last-commands
4491 yas-field-highlight-face
4493 ;; these vars can be customized as well
4499 yas-after-exit-snippet-hook
4500 yas-before-expand-snippet-hook
4501 yas-buffer-local-condition
4504 ;; prompting functions
4509 yas-completing-prompt
4512 ;; interactive functions
4517 yas-direct-keymaps-reload
4521 yas-compile-directory
4524 yas-expand-from-trigger-key
4525 yas-expand-from-keymap
4527 yas-visit-snippet-file
4529 yas-load-snippet-buffer
4532 yas-next-field-or-maybe-expand
4537 yas-exit-all-snippets
4538 yas-skip-and-clear-or-delete-char
4540 ;; symbols that I "exported" for use
4541 ;; in snippets and hookage
4558 yas-default-from-field
4561 yas-define-condition-cache
4562 yas-hippie-try-expand
4564 ;; debug definitions
4565 ;; yas-debug-snippet-vars
4566 ;; yas-exterminate-package
4569 ;; testing definitions
4570 ;; yas-should-expand
4571 ;; yas-should-not-expand
4573 ;; yas-make-file-or-dirs
4575 ;; yas-saving-variables
4576 ;; yas-call-with-snippet-dirs
4577 ;; yas-with-snippet-dirs
4579 "Backported yasnippet symbols.
4581 They are mapped to \"yas/*\" variants.")
4583 (dolist (sym yas--backported-syms)
4584 (let ((backported (intern (replace-regexp-in-string "^yas-" "yas/" (symbol-name sym)))))
4586 (make-obsolete-variable backported sym "yasnippet 0.8")
4587 (defvaralias backported sym))
4589 (make-obsolete backported sym "yasnippet 0.8")
4590 (defalias backported sym))))
4592 (defvar yas--exported-syms
4594 (mapatoms (lambda (atom)
4595 (if (and (or (and (boundp atom)
4596 (not (get atom 'byte-obsolete-variable)))
4598 (not (get atom 'byte-obsolete-info))))
4599 (string-match-p "^yas-[^-]" (symbol-name atom)))
4600 (push atom exported))))
4602 "Exported yasnippet symbols.
4604 i.e. the ones with \"yas-\" single dash prefix. I will try to
4605 keep them in future yasnippet versions and other elisp libraries
4606 can more or less safely rely upon them.")
4609 (provide 'yasnippet)
4612 ;; indent-tabs-mode: nil
4613 ;; byte-compile-warnings: (not cl-functions)
4615 ;;; yasnippet.el ends here