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--escaped-characters
530 '(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
531 "List of characters which *might* need to be escaped.")
533 (defconst yas--field-regexp
534 "${\\([0-9]+:\\)?\\([^}]*\\)}"
535 "A regexp to *almost* recognize a field.")
537 (defconst yas--multi-dollar-lisp-expression-regexp
538 "$+[ \t\n]*\\(([^)]*)\\)"
539 "A regexp to *almost* recognize a \"$(...)\" expression.")
541 (defconst yas--backquote-lisp-expression-regexp
543 "A regexp to recognize a \"`lisp-expression`\" expression." )
545 (defconst yas--transform-mirror-regexp
546 "${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
547 "A regexp to *almost* recognize a mirror with a transform.")
549 (defconst yas--simple-mirror-regexp
551 "A regexp to recognize a simple mirror.")
553 (defvar yas--snippet-id-seed 0
554 "Contains the next id for a snippet.")
556 (defun yas--snippet-next-id ()
557 (let ((id yas--snippet-id-seed))
558 (cl-incf yas--snippet-id-seed)
564 ;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
565 (defvar last-buffer-undo-list nil)
567 (defvar yas--minor-mode-menu nil
568 "Holds the YASnippet menu.")
570 (defvar yas-minor-mode-map
571 (let ((map (make-sparse-keymap)))
572 (define-key map [(tab)] 'yas-expand)
573 (define-key map (kbd "TAB") 'yas-expand)
574 (define-key map "\C-c&\C-s" 'yas-insert-snippet)
575 (define-key map "\C-c&\C-n" 'yas-new-snippet)
576 (define-key map "\C-c&\C-v" 'yas-visit-snippet-file)
578 "The keymap used when `yas-minor-mode' is active.")
580 (easy-menu-define yas--minor-mode-menu
582 "Menu used when `yas-minor-mode' is active."
583 '("YASnippet" :visible yas-use-menu
585 ["Expand trigger" yas-expand
586 :help "Possibly expand tab trigger before point"]
587 ["Insert at point..." yas-insert-snippet
588 :help "Prompt for an expandable snippet and expand it at point"]
589 ["New snippet..." yas-new-snippet
590 :help "Create a new snippet in an appropriate directory"]
591 ["Visit snippet file..." yas-visit-snippet-file
592 :help "Prompt for an expandable snippet and find its file"]
594 ("Snippet menu behaviour"
595 ["Visit snippets" (setq yas-visit-from-menu t)
596 :help "Visit snippets from the menu"
597 :active t :style radio :selected yas-visit-from-menu]
598 ["Expand snippets" (setq yas-visit-from-menu nil)
599 :help "Expand snippets from the menu"
600 :active t :style radio :selected (not yas-visit-from-menu)]
602 ["Show all known modes" (setq yas-use-menu 'full)
603 :help "Show one snippet submenu for each loaded table"
604 :active t :style radio :selected (eq yas-use-menu 'full)]
605 ["Abbreviate according to current mode" (setq yas-use-menu 'abbreviate)
606 :help "Show only snippet submenus for the current active modes"
607 :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
609 ["Auto" (setq yas-indent-line 'auto)
610 :help "Indent each line of the snippet with `indent-according-to-mode'"
611 :active t :style radio :selected (eq yas-indent-line 'auto)]
612 ["Fixed" (setq yas-indent-line 'fixed)
613 :help "Indent the snippet to the current column"
614 :active t :style radio :selected (eq yas-indent-line 'fixed)]
615 ["None" (setq yas-indent-line 'none)
616 :help "Don't apply any particular snippet indentation after expansion"
617 :active t :style radio :selected (not (member yas-indent-line '(fixed auto)))]
619 ["Also auto indent first line" (setq yas-also-auto-indent-first-line
620 (not yas-also-auto-indent-first-line))
621 :help "When auto-indenting also, auto indent the first line menu"
622 :active (eq yas-indent-line 'auto)
623 :style toggle :selected yas-also-auto-indent-first-line]
626 ["System X-widget" (setq yas-prompt-functions
628 (remove 'yas-x-prompt
629 yas-prompt-functions)))
630 :help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
631 :active t :style radio :selected (eq (car yas-prompt-functions)
633 ["Dropdown-list" (setq yas-prompt-functions
634 (cons 'yas-dropdown-prompt
635 (remove 'yas-dropdown-prompt
636 yas-prompt-functions)))
637 :help "Use a special dropdown list"
638 :active t :style radio :selected (eq (car yas-prompt-functions)
639 'yas-dropdown-prompt)]
640 ["Ido" (setq yas-prompt-functions
641 (cons 'yas-ido-prompt
642 (remove 'yas-ido-prompt
643 yas-prompt-functions)))
644 :help "Use an ido-style minibuffer prompt"
645 :active t :style radio :selected (eq (car yas-prompt-functions)
647 ["Completing read" (setq yas-prompt-functions
648 (cons 'yas-completing-prompt
649 (remove 'yas-completing-prompt
650 yas-prompt-functions)))
651 :help "Use a normal minibuffer prompt"
652 :active t :style radio :selected (eq (car yas-prompt-functions)
653 'yas-completing-prompt)]
656 ["Wrap region in exit marker"
657 (setq yas-wrap-around-region
658 (not yas-wrap-around-region))
659 :help "If non-nil automatically wrap the selected text in the $0 snippet exit"
660 :style toggle :selected yas-wrap-around-region]
661 ["Allow stacked expansions "
662 (setq yas-triggers-in-field
663 (not yas-triggers-in-field))
664 :help "If non-nil allow snippets to be triggered inside other snippet fields"
665 :style toggle :selected yas-triggers-in-field]
666 ["Revive snippets on undo "
667 (setq yas-snippet-revival
668 (not yas-snippet-revival))
669 :help "If non-nil allow snippets to become active again after undo"
670 :style toggle :selected yas-snippet-revival]
673 (not yas-good-grace))
674 :help "If non-nil don't raise errors in bad embedded elisp in snippets"
675 :style toggle :selected yas-good-grace]
678 ["Load snippets..." yas-load-directory
679 :help "Load snippets from a specific directory"]
680 ["Reload everything" yas-reload-all
681 :help "Cleanup stuff, reload snippets, rebuild menus"]
683 :help "Display some information about YASnippet"]))
685 (defvar yas--extra-modes nil
686 "An internal list of modes for which to also lookup snippets.
688 This variable probably makes more sense as buffer-local, so
689 ensure your use `make-local-variable' when you set it.")
690 (define-obsolete-variable-alias 'yas-extra-modes 'yas--extra-modes "0.8.1")
692 (defvar yas--tables (make-hash-table)
693 "A hash table of mode symbols to `yas--table' objects.")
695 (defvar yas--parents (make-hash-table)
696 "A hash table of mode symbols do lists of direct parent mode symbols.
698 This list is populated when reading the \".yas-parents\" files
699 found when traversing snippet directories with
700 `yas-load-directory'.
702 There might be additional parenting information stored in the
703 `derived-mode-parent' property of some mode symbols, but that is
706 (defvar yas--direct-keymaps (list)
707 "Keymap alist supporting direct snippet keybindings.
709 This variable is placed in `emulation-mode-map-alists'.
711 Its elements looks like (TABLE-NAME . KEYMAP). They're
712 instantiated on `yas-reload-all' but KEYMAP is added to only when
713 loading snippets. `yas--direct-TABLE-NAME' is then a variable set
714 buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
715 defined direct keybindings to the command
716 `yas-expand-from-keymap' which then which snippet to expand.")
718 (defun yas-direct-keymaps-reload ()
719 "Force reload the direct keybinding for active snippet tables."
721 (setq yas--direct-keymaps nil)
722 (maphash #'(lambda (name table)
723 (push (cons (intern (format "yas--direct-%s" name))
724 (yas--table-direct-keymap table))
725 yas--direct-keymaps))
728 (defun yas--modes-to-activate ()
729 "Compute list of mode symbols that are active for `yas-expand'
732 (setq dfs (lambda (mode &optional explored)
736 in (cl-list* (get mode 'derived-mode-parent)
737 (ignore-errors (symbol-function mode))
738 (gethash mode yas--parents))
740 (not (memq neighbour explored))
742 append (funcall dfs neighbour explored)))))
743 (remove-duplicates (append yas--extra-modes
744 (funcall dfs major-mode)))))
746 (defvar yas-minor-mode-hook nil
747 "Hook run when `yas-minor-mode' is turned on.")
750 (define-minor-mode yas-minor-mode
751 "Toggle YASnippet mode.
753 When YASnippet mode is enabled, `yas-expand', normally bound to
754 the TAB key, expands snippets of code depending on the major
757 With no argument, this command toggles the mode.
758 positive prefix argument turns on the mode.
759 Negative prefix argument turns off the mode.
762 \\{yas-minor-mode-map}"
764 ;; The indicator for the mode line.
767 (cond (yas-minor-mode
768 ;; Install the direct keymaps in `emulation-mode-map-alists'
769 ;; (we use `add-hook' even though it's not technically a hook,
770 ;; but it works). Then define variables named after modes to
771 ;; index `yas--direct-keymaps'.
773 ;; Also install the post-command-hook.
775 (add-hook 'emulation-mode-map-alists 'yas--direct-keymaps)
776 (add-hook 'post-command-hook 'yas--post-command-handler nil t)
777 ;; Set the `yas--direct-%s' vars for direct keymap expansion
779 (dolist (mode (yas--modes-to-activate))
780 (let ((name (intern (format "yas--direct-%s" mode))))
781 (set-default name nil)
782 (set (make-local-variable name) t)))
785 (yas--load-pending-jits))
787 ;; Uninstall the direct keymaps and the post-command hook
789 (remove-hook 'post-command-hook 'yas--post-command-handler t)
790 (remove-hook 'emulation-mode-map-alists 'yas--direct-keymaps))))
792 (defun yas-activate-extra-mode (mode)
793 "Activates the snippets for the given `mode' in the buffer.
795 The function can be called in the hook of a minor mode to
796 activate snippets associated with that mode."
800 (maphash (lambda (k _)
801 (setq modes (cons (list k) modes)))
803 (setq symbol (completing-read
804 "Activate mode: " modes nil t))
806 (when (not (string= "" symbol))
809 (add-to-list (make-local-variable 'yas--extra-modes) mode)
810 (yas--load-pending-jits)))
812 (defun yas-deactivate-extra-mode (mode)
813 "Deactivates the snippets for the given `mode' in the buffer."
817 "Deactivate mode: " (mapcar #'list yas--extra-modes) nil t))))
818 (set (make-local-variable 'yas--extra-modes)
822 (defvar yas-dont-activate '(minibufferp)
823 "If non-nil don't let `yas-global-mode' affect some buffers.
825 If a function of zero arguments, then its result is used.
827 If a list of functions, then all functions must return nil to
828 activate yas for this buffer.
830 In Emacsen <= 23, this variable is buffer-local. Because
831 `yas-minor-mode-on' is called by `yas-global-mode' after
832 executing the buffer's major mode hook, setting this variable
833 there is an effective way to define exceptions to the \"global\"
834 activation behaviour.
836 In Emacsen > 23, only the global value is used. To define
837 per-mode exceptions to the \"global\" activation behaviour, call
838 `yas-minor-mode' with a negative argument directily in the major
840 (unless (> emacs-major-version 23)
842 (make-variable-buffer-local 'yas-dont-activate)))
845 (defun yas-minor-mode-on ()
846 "Turn on YASnippet minor mode.
848 Honour `yas-dont-activate', which see."
850 ;; Check `yas-dont-activate'
851 (unless (cond ((functionp yas-dont-activate)
852 (funcall yas-dont-activate))
853 ((consp yas-dont-activate)
854 (some #'funcall yas-dont-activate))
859 (define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
863 (defun yas--global-mode-reload-with-jit-maybe ()
864 "Run `yas-reload-all' when `yas-global-mode' is on."
865 (when yas-global-mode (yas-reload-all)))
867 (add-hook 'yas-global-mode-hook 'yas--global-mode-reload-with-jit-maybe)
872 (defvar yas--font-lock-keywords
873 (append '(("^#.*$" . font-lock-comment-face))
874 lisp-font-lock-keywords-2
876 (0 font-lock-keyword-face)
877 (1 font-lock-string-face t))
879 (0 font-lock-keyword-face)
880 (1 font-lock-warning-face t))
881 ("${" . font-lock-keyword-face)
882 ("$[0-9]+?" . font-lock-preprocessor-face)
883 ("\\(\\$(\\)" 1 font-lock-preprocessor-face)
885 (0 font-lock-keyword-face)))))
887 (defvar snippet-mode-map
888 (let ((map (make-sparse-keymap)))
889 (easy-menu-define nil
891 "Menu used when snippet-mode is active."
893 (mapcar #'(lambda (ent)
895 (define-key map (third ent) (second ent)))
896 (vector (first ent) (second ent) t))
897 '(("Load this snippet" yas-load-snippet-buffer "\C-c\C-l")
898 ("Load and quit window" yas-load-snippet-buffer-and-close "\C-c\C-c")
899 ("Try out this snippet" yas-tryout-snippet "\C-c\C-t")))))
901 "The keymap used when `snippet-mode' is active.")
904 (define-derived-mode snippet-mode text-mode "Snippet"
905 "A mode for editing yasnippets"
906 (setq font-lock-defaults '(yas--font-lock-keywords))
907 (set (make-local-variable 'require-final-newline) nil)
908 (set (make-local-variable 'comment-start) "#")
909 (set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
913 ;;; Internal structs for template management
915 (defstruct (yas--template (:constructor yas--make-blank-template))
916 "A template for a snippet."
926 group ;; as dictated by the #group: directive or .yas-make-groups
927 perm-group ;; as dictated by `yas-define-menu'
931 (defun yas--populate-template (template &rest args)
932 "Helper function to populate TEMPLATE with properties."
935 (position (intern (substring (symbol-name (car args)) 1))
936 (mapcar #'car (get 'yas--template 'cl-struct-slots)))
938 (setq args (cddr args)))
941 (defstruct (yas--table (:constructor yas--make-snippet-table (name)))
942 "A table to store snippets for a particular mode.
944 Has the following fields:
948 A symbol name normally corresponding to a major mode, but can
949 also be a pseudo major-mode to be used in
950 `yas-activate-extra-mode', for example.
954 A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
955 a string or a vector, where the former is the snippet's trigger
956 and the latter means it's a direct keybinding. NAMEHASH is yet
957 another hash of (NAME . TEMPLATE) where NAME is the snippet's
958 name and TEMPLATE is a `yas--template' object.
960 `yas--table-direct-keymap'
962 A keymap for the snippets in this table that have direct
963 keybindings. This is kept in sync with the keyhash, i.e., all
964 the elements of the keyhash that are vectors appear here as
965 bindings to `yas-expand-from-keymap'.
967 `yas--table-uuidhash'
969 A hash table mapping snippets uuid's to the same `yas--template'
970 objects. A snippet uuid defaults to the snippet's name."
972 (hash (make-hash-table :test 'equal))
973 (uuidhash (make-hash-table :test 'equal))
975 (direct-keymap (make-sparse-keymap)))
977 (defun yas--get-template-by-uuid (mode uuid)
978 "Find the snippet template in MODE by its UUID."
979 (let* ((table (gethash mode yas--tables mode)))
981 (gethash uuid (yas--table-uuidhash table)))))
983 ;; Apropos storing/updating in TABLE, this works in two steps:
985 ;; 1. `yas--remove-template-by-uuid' removes any
986 ;; keyhash-namehash-template mappings from TABLE, grabbing the
987 ;; snippet by its uuid. Also removes mappings from TABLE's
988 ;; `yas--table-direct-keymap' (FIXME: and should probably take care
989 ;; of potentially stale menu bindings right?.)
991 ;; 2. `yas--add-template' adds this all over again.
993 ;; Create a new or add to an existing keyhash-namehash mapping.
995 ;; For reference on understanding this, consider three snippet
998 ;; A: # name: The Foo
1000 ;; # binding: C-c M-l
1002 ;; B: # name: Mrs Foo
1005 ;; C: # name: The Bar
1006 ;; # binding: C-c M-l
1011 ;; keyhash namehashes(3) yas--template structs(4)
1012 ;; -----------------------------------------------------
1015 ;; "foo" ---> "The Foo" ---> [yas--template A] |
1016 ;; "Mrs Foo" ---> [yas--template B] |
1018 ;; [C-c M-l] ---> "The Foo" -------------------------/
1019 ;; "The Bar" ---> [yas--template C]
1021 ;; "baz" ---> "Baz" ---> [yas--template D]
1023 ;; Additionally, since uuid defaults to the name, we have a
1024 ;; `yas--table-uuidhash' for TABLE
1026 ;; uuidhash yas--template structs
1027 ;; -------------------------------
1028 ;; "The Foo" ---> [yas--template A]
1029 ;; "Mrs Foo" ---> [yas--template B]
1030 ;; "The Bar" ---> [yas--template C]
1031 ;; "Baz" ---> [yas--template D]
1033 ;; FIXME: the more I look at this data-structure the more I think I'm
1034 ;; stupid. There has to be an easier way (but beware lots of code
1035 ;; depends on this).
1037 (defun yas--remove-template-by-uuid (table uuid)
1038 "Remove from TABLE a template identified by UUID."
1039 (let ((template (gethash uuid (yas--table-uuidhash table))))
1041 (let* ((name (yas--template-name template))
1043 ;; Remove the name from each of the targeted namehashes
1045 (maphash #'(lambda (k v)
1046 (let ((template (gethash name v)))
1048 (eq uuid (yas--template-uuid template)))
1050 (when (zerop (hash-table-count v))
1051 (push k empty-keys)))))
1052 (yas--table-hash table))
1053 ;; Remove the namehash themselves if they've become empty
1055 (dolist (key empty-keys)
1057 (define-key (yas--table-direct-keymap table) key nil))
1058 (remhash key (yas--table-hash table)))
1060 ;; Finally, remove the uuid from the uuidhash
1062 (remhash uuid (yas--table-uuidhash table))))))
1064 (defun yas--add-template (table template)
1065 "Store in TABLE the snippet template TEMPLATE.
1067 KEY can be a string (trigger key) of a vector (direct
1069 (let ((name (yas--template-name template))
1070 (key (yas--template-key template))
1071 (keybinding (yas--template-keybinding template))
1072 (_menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
1073 (dolist (k (remove nil (list key keybinding)))
1077 (yas--table-hash table))
1079 (make-hash-table :test 'equal)
1080 (yas--table-hash table))))
1082 (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
1084 ;; Update TABLE's `yas--table-uuidhash'
1085 (puthash (yas--template-uuid template)
1087 (yas--table-uuidhash table))))
1089 (defun yas--update-template (table template)
1090 "Add or update TEMPLATE in TABLE.
1092 Also takes care of adding and updating to the associated menu."
1093 ;; Remove from table by uuid
1095 (yas--remove-template-by-uuid table (yas--template-uuid template))
1096 ;; Add to table again
1098 (yas--add-template table template)
1099 ;; Take care of the menu
1101 (yas--update-template-menu table template))
1103 (defun yas--update-template-menu (table template)
1104 "Update every menu-related for TEMPLATE."
1105 (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
1106 (key (yas--template-key template))
1107 (keybinding (yas--template-keybinding template)))
1108 ;; The snippet might have changed name or keys, so update
1109 ;; user-visible strings
1111 (unless (eq (cdr menu-binding-pair) :none)
1112 ;; the menu item name
1114 (setf (cadar menu-binding-pair) (yas--template-name template))
1115 ;; the :keys information (also visible to the user)
1116 (setf (getf (cdr (car menu-binding-pair)) :keys)
1117 (or (and keybinding (key-description keybinding))
1118 (and key (concat key yas-trigger-symbol))))))
1119 (unless (yas--template-menu-managed-by-yas-define-menu template)
1121 (yas--menu-keymap-get-create (yas--table-mode table)
1122 (mapcar #'yas--table-mode
1123 (yas--table-parents table))))
1124 (group (yas--template-group template)))
1125 ;; Remove from menu keymap
1127 (assert menu-keymap)
1128 (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
1130 ;; Add necessary subgroups as necessary.
1132 (dolist (subgroup group)
1133 (let ((subgroup-keymap (lookup-key menu-keymap (vector (make-symbol subgroup)))))
1134 (unless (and subgroup-keymap
1135 (keymapp subgroup-keymap))
1136 (setq subgroup-keymap (make-sparse-keymap))
1137 (define-key menu-keymap (vector (make-symbol subgroup))
1138 `(menu-item ,subgroup ,subgroup-keymap)))
1139 (setq menu-keymap subgroup-keymap)))
1141 ;; Add this entry to the keymap
1143 (define-key menu-keymap
1144 (vector (make-symbol (yas--template-uuid template)))
1145 (car (yas--template-menu-binding-pair template))))))
1147 (defun yas--namehash-templates-alist (namehash)
1148 "Return NAMEHASH as an alist."
1150 (maphash #'(lambda (k v)
1151 (push (cons k v) alist))
1155 (defun yas--fetch (table key)
1156 "Fetch templates in TABLE by KEY.
1158 Return a list of cons (NAME . TEMPLATE) where NAME is a
1159 string and TEMPLATE is a `yas--template' structure."
1160 (let* ((keyhash (yas--table-hash table))
1161 (namehash (and keyhash (gethash key keyhash))))
1163 (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
1166 ;;; Filtering/condition logic
1168 (defun yas--eval-condition (condition)
1175 (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
1179 (defun yas--filter-templates-by-condition (templates)
1180 "Filter the templates using the applicable condition.
1182 TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
1183 string and TEMPLATE is a `yas--template' structure.
1185 This function implements the rules described in
1186 `yas-buffer-local-condition'. See that variables documentation."
1187 (let ((requirement (yas--require-template-specific-condition-p)))
1188 (if (eq requirement 'always)
1190 (remove-if-not #'(lambda (pair)
1191 (yas--template-can-expand-p
1192 (yas--template-condition (cdr pair)) requirement))
1195 (defun yas--require-template-specific-condition-p ()
1196 "Decide if this buffer requests/requires snippet-specific
1197 conditions to filter out potential expansions."
1198 (if (eq 'always yas-buffer-local-condition)
1200 (let ((local-condition (or (and (consp yas-buffer-local-condition)
1201 (yas--eval-condition yas-buffer-local-condition))
1202 yas-buffer-local-condition)))
1203 (when local-condition
1204 (if (eq local-condition t)
1206 (and (consp local-condition)
1207 (eq 'require-snippet-condition (car local-condition))
1208 (symbolp (cdr local-condition))
1209 (cdr local-condition)))))))
1211 (defun yas--template-can-expand-p (condition requirement)
1212 "Evaluate CONDITION and REQUIREMENT and return a boolean."
1213 (let* ((result (or (null condition)
1214 (yas--eval-condition condition))))
1215 (cond ((eq requirement t)
1218 (eq requirement result)))))
1220 (defun yas--table-templates (table)
1223 (maphash #'(lambda (_key namehash)
1224 (maphash #'(lambda (name template)
1225 (push (cons name template) acc))
1227 (yas--table-hash table))
1228 (yas--filter-templates-by-condition acc))))
1230 (defun yas--templates-for-key-at-point ()
1231 "Find `yas--template' objects for any trigger keys preceding point.
1232 Returns (TEMPLATES START END). This function respects
1233 `yas-key-syntaxes', which see."
1235 (let ((original (point))
1236 (methods yas-key-syntaxes)
1241 (unless (eq method (car methods))
1242 ;; TRICKY: `eq'-ness test means we can only be here if
1243 ;; `method' is a function that returned `again', and hence
1244 ;; don't revert back to original position as per
1245 ;; `yas-key-syntaxes'.
1246 (goto-char original))
1247 (setq method (car methods))
1248 (cond ((stringp method)
1249 (skip-syntax-backward method)
1250 (setq methods (cdr methods)))
1252 (unless (eq (funcall method original)
1254 (setq methods (cdr methods))))
1256 (yas--warning "Warning invalid element %s in `yas-key-syntaxes'" method)))
1257 (let ((possible-key (buffer-substring-no-properties (point) original)))
1259 (goto-char original)
1261 (mapcan #'(lambda (table)
1262 (yas--fetch table possible-key))
1263 (yas--get-snippet-tables))))))
1265 (list templates (point) original)))))
1267 (defun yas--table-all-keys (table)
1268 "Get trigger keys of all active snippets in TABLE."
1270 (maphash #'(lambda (key namehash)
1271 (when (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash))
1273 (yas--table-hash table))
1276 (defun yas--table-mode (table)
1277 (intern (yas--table-name table)))
1280 ;;; Internal functions and macros:
1282 (defun yas--handle-error (err)
1283 "Handle error depending on value of `yas-good-grace'."
1284 (let ((msg (yas--format "elisp error: %s" (error-message-string err))))
1285 (if yas-good-grace msg
1288 (defun yas--eval-lisp (form)
1289 "Evaluate FORM and convert the result to string."
1290 (let ((retval (catch 'yas--exception
1296 (let ((result (eval form)))
1298 (format "%s" result))))))
1299 (error (yas--handle-error err))))))
1300 (when (and (consp retval)
1301 (eq 'yas--exception (car retval)))
1302 (error (cdr retval)))
1305 (defun yas--eval-lisp-no-saves (form)
1308 (error (message "%s" (yas--handle-error err)))))
1310 (defun yas--read-lisp (string &optional nil-on-error)
1311 "Read STRING as a elisp expression and return it.
1313 In case STRING in an invalid expression and NIL-ON-ERROR is nil,
1314 return an expression that when evaluated will issue an error."
1317 (error (and (not nil-on-error)
1318 `(error (error-message-string ,err))))))
1320 (defun yas--read-keybinding (keybinding)
1321 "Read KEYBINDING as a snippet keybinding, return a vector."
1322 (when (and keybinding
1323 (not (string-match "keybinding" keybinding)))
1325 (let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
1327 (read-kbd-macro keybinding 'need-vector))))
1330 (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
1331 keybinding (error-message-string err))
1334 (defun yas--table-get-create (mode)
1335 "Get or create the snippet table corresponding to MODE."
1336 (let ((table (gethash mode
1339 (setq table (yas--make-snippet-table (symbol-name mode)))
1340 (puthash mode table yas--tables)
1341 (push (cons (intern (format "yas--direct-%s" mode))
1342 (yas--table-direct-keymap table))
1343 yas--direct-keymaps))
1346 (defun yas--get-snippet-tables ()
1347 "Get snippet tables for current buffer.
1349 Return a list of `yas--table' objects. The list of modes to
1350 consider is returned by `yas--modes-to-activate'"
1352 (mapcar #'(lambda (name)
1353 (gethash name yas--tables))
1354 (yas--modes-to-activate))))
1356 (defun yas--menu-keymap-get-create (mode &optional parents)
1357 "Get or create the menu keymap for MODE and its PARENTS.
1359 This may very well create a plethora of menu keymaps and arrange
1360 them all in `yas--menu-table'"
1361 (let* ((menu-keymap (or (gethash mode yas--menu-table)
1362 (puthash mode (make-sparse-keymap) yas--menu-table))))
1363 (mapc #'yas--menu-keymap-get-create parents)
1364 (define-key yas--minor-mode-menu (vector mode)
1365 `(menu-item ,(symbol-name mode) ,menu-keymap
1366 :visible (yas--show-menu-p ',mode)))
1370 (defmacro yas--called-interactively-p (&optional kind)
1371 "A backward-compatible version of `called-interactively-p'.
1373 Optional KIND is as documented at `called-interactively-p'
1374 in GNU Emacs 24.1 or higher."
1375 (if (string< emacs-version "24.1")
1376 '(called-interactively-p)
1377 `(called-interactively-p ,kind)))
1380 ;;; Template-related and snippet loading functions
1382 (defun yas--parse-template (&optional file)
1383 "Parse the template in the current buffer.
1385 Optional FILE is the absolute file name of the file being
1388 Optional GROUP is the group where the template is to go,
1389 otherwise we attempt to calculate it from FILE.
1391 Return a snippet-definition, i.e. a list
1393 (KEY TEMPLATE NAME CONDITION GROUP VARS FILE KEYBINDING UUID)
1395 If the buffer contains a line of \"# --\" then the contents above
1396 this line are ignored. Directives can set most of these with the syntax:
1398 # directive-name : directive-value
1400 Here's a list of currently recognized directives:
1411 (goto-char (point-min))
1412 (let* ((type 'snippet)
1414 (file-name-nondirectory file)))
1420 (yas--calculate-group file)))
1424 (if (re-search-forward "^# --\n" nil t)
1425 (progn (setq template
1426 (buffer-substring-no-properties (point)
1428 (setq bound (point))
1429 (goto-char (point-min))
1430 (while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*\\)$" bound t)
1431 (when (string= "uuid" (match-string-no-properties 1))
1432 (setq uuid (match-string-no-properties 2)))
1433 (when (string= "type" (match-string-no-properties 1))
1434 (setq type (if (string= "command" (match-string-no-properties 2))
1437 (when (string= "key" (match-string-no-properties 1))
1438 (setq key (match-string-no-properties 2)))
1439 (when (string= "name" (match-string-no-properties 1))
1440 (setq name (match-string-no-properties 2)))
1441 (when (string= "condition" (match-string-no-properties 1))
1442 (setq condition (yas--read-lisp (match-string-no-properties 2))))
1443 (when (string= "group" (match-string-no-properties 1))
1444 (setq group (match-string-no-properties 2)))
1445 (when (string= "expand-env" (match-string-no-properties 1))
1446 (setq expand-env (yas--read-lisp (match-string-no-properties 2)
1448 (when (string= "binding" (match-string-no-properties 1))
1449 (setq binding (match-string-no-properties 2)))))
1451 (buffer-substring-no-properties (point-min) (point-max))))
1452 (unless (or key binding)
1453 (setq key (and file (file-name-nondirectory file))))
1454 (when (eq type 'command)
1455 (setq template (yas--read-lisp (concat "(progn" template ")"))))
1457 (setq group (split-string group "\\.")))
1458 (list key template name condition group expand-env file binding uuid)))
1460 (defun yas--calculate-group (file)
1461 "Calculate the group for snippet file path FILE."
1462 (let* ((dominating-dir (locate-dominating-file file
1463 ".yas-make-groups"))
1464 (extra-path (and dominating-dir
1465 (replace-regexp-in-string (concat "^"
1466 (expand-file-name dominating-dir))
1468 (expand-file-name file))))
1469 (extra-dir (and extra-path
1470 (file-name-directory extra-path)))
1471 (group (and extra-dir
1472 (replace-regexp-in-string "/"
1474 (directory-file-name extra-dir)))))
1477 (defun yas--subdirs (directory &optional filep)
1478 "Return subdirs or files of DIRECTORY according to FILEP."
1479 (remove-if (lambda (file)
1480 (or (string-match "^\\."
1481 (file-name-nondirectory file))
1482 (string-match "^#.*#$"
1483 (file-name-nondirectory file))
1485 (file-name-nondirectory file))
1487 (file-directory-p file)
1488 (not (file-directory-p file)))))
1489 (directory-files directory t)))
1491 (defun yas--make-menu-binding (template)
1492 (let ((mode (yas--table-mode (yas--template-table template))))
1493 `(lambda () (interactive) (yas--expand-or-visit-from-menu ',mode ,(yas--template-uuid template)))))
1495 (defun yas--expand-or-visit-from-menu (mode uuid)
1496 (let* ((table (yas--table-get-create mode))
1497 (yas--current-template (and table
1498 (gethash uuid (yas--table-uuidhash table)))))
1499 (when yas--current-template
1500 (if yas-visit-from-menu
1501 (yas--visit-snippet-file-1 yas--current-template)
1502 (let ((where (if (region-active-p)
1503 (cons (region-beginning) (region-end))
1504 (cons (point) (point)))))
1505 (yas-expand-snippet (yas--template-content yas--current-template)
1508 (yas--template-expand-env yas--current-template)))))))
1510 (defun yas--key-from-desc (text)
1511 "Return a yasnippet key from a description string TEXT."
1512 (replace-regexp-in-string "\\(\\w+\\).*" "\\1" text))
1515 ;;; Popping up for keys and templates
1517 (defun yas--prompt-for-template (templates &optional prompt)
1518 "Interactively choose a template from the list TEMPLATES.
1520 TEMPLATES is a list of `yas--template'.
1522 Optional PROMPT sets the prompt to use."
1525 (sort templates #'(lambda (t1 t2)
1526 (< (length (yas--template-name t1))
1527 (length (yas--template-name t2))))))
1528 (some #'(lambda (fn)
1529 (funcall fn (or prompt "Choose a snippet: ")
1531 #'yas--template-name))
1532 yas-prompt-functions)))
1534 (defun yas--prompt-for-keys (keys &optional prompt)
1535 "Interactively choose a template key from the list KEYS.
1537 Optional PROMPT sets the prompt to use."
1539 (some #'(lambda (fn)
1540 (funcall fn (or prompt "Choose a snippet key: ") keys))
1541 yas-prompt-functions)))
1543 (defun yas--prompt-for-table (tables &optional prompt)
1544 "Interactively choose a table from the list TABLES.
1546 Optional PROMPT sets the prompt to use."
1548 (some #'(lambda (fn)
1549 (funcall fn (or prompt "Choose a snippet table: ")
1552 yas-prompt-functions)))
1554 (defun yas-x-prompt (prompt choices &optional display-fn)
1555 "Display choices in a x-window prompt."
1556 (when (and window-system choices)
1559 (if (fboundp 'posn-at-point)
1560 (let ((x-y (posn-x-y (posn-at-point (point)))))
1561 (list (list (+ (car x-y) 10)
1566 ,@(mapcar* (lambda (c d) `(,(concat " " d) . ,c))
1568 (if display-fn (mapcar display-fn choices) choices)))))
1571 (defun yas-ido-prompt (prompt choices &optional display-fn)
1572 (when (and (fboundp 'ido-completing-read)
1573 (or (>= emacs-major-version 24)
1575 (yas-completing-prompt prompt choices display-fn #'ido-completing-read)))
1577 (defun yas-dropdown-prompt (_prompt choices &optional display-fn)
1578 (when (fboundp 'dropdown-list)
1579 (let* ((formatted-choices
1580 (if display-fn (mapcar display-fn choices) choices))
1581 (n (dropdown-list formatted-choices)))
1582 (if n (nth n choices)
1585 (defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
1586 (let* ((formatted-choices
1587 (if display-fn (mapcar display-fn choices) choices))
1588 (chosen (funcall (or completion-fn #'completing-read)
1589 prompt formatted-choices
1590 nil 'require-match nil nil)))
1591 (if (eq choices formatted-choices)
1593 (nth (or (position chosen formatted-choices :test #'string=) 0)
1596 (defun yas-no-prompt (_prompt choices &optional _display-fn)
1600 ;;; Defining snippets
1601 ;; This consists of creating and registering `yas--template' objects in the
1605 (defvar yas--creating-compiled-snippets nil)
1607 (defun yas--define-snippets-1 (snippet snippet-table)
1608 "Helper for `yas-define-snippets'."
1609 ;; X) Calculate some more defaults on the values returned by
1610 ;; `yas--parse-template'.
1612 (let* ((file (seventh snippet))
1614 (name (or (third snippet)
1616 (file-name-directory file))))
1617 (condition (fourth snippet))
1618 (group (fifth snippet))
1619 (keybinding (yas--read-keybinding (eighth snippet)))
1620 (uuid (or (ninth snippet)
1622 (template (or (gethash uuid (yas--table-uuidhash snippet-table))
1623 (yas--make-blank-template))))
1624 ;; X) populate the template object
1626 (yas--populate-template template
1627 :table snippet-table
1629 :content (second snippet)
1632 :condition condition
1633 :expand-env (sixth snippet)
1634 :file (seventh snippet)
1635 :keybinding keybinding
1637 ;; X) Update this template in the appropriate table. This step
1638 ;; also will take care of adding the key indicators in the
1639 ;; templates menu entry, if any
1641 (yas--update-template snippet-table template)
1642 ;; X) Return the template
1647 (defun yas-define-snippets (mode snippets)
1648 "Define SNIPPETS for MODE.
1650 SNIPPETS is a list of snippet definitions, each taking the
1653 (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV FILE KEYBINDING UUID)
1655 Within these, only KEY and TEMPLATE are actually mandatory.
1657 TEMPLATE might be a Lisp form or a string, depending on whether
1658 this is a snippet or a snippet-command.
1660 CONDITION, EXPAND-ENV and KEYBINDING are Lisp forms, they have
1661 been `yas--read-lisp'-ed and will eventually be
1662 `yas--eval-lisp'-ed.
1664 The remaining elements are strings.
1666 FILE is probably of very little use if you're programatically
1669 UUID is the snippet's \"unique-id\". Loading a second snippet
1670 file with the same uuid would replace the previous snippet.
1672 You can use `yas--parse-template' to return such lists based on
1673 the current buffers contents."
1674 (if yas--creating-compiled-snippets
1676 (insert ";;; Snippet definitions:\n;;;\n")
1677 (let ((literal-snippets (list))
1679 (dolist (snippet snippets)
1680 (let ((key (nth 0 snippet))
1681 (template-content (nth 1 snippet))
1682 (name (nth 2 snippet))
1683 (condition (nth 3 snippet))
1684 (group (nth 4 snippet))
1685 (expand-env (nth 5 snippet))
1686 (file nil) ;; omit on purpose
1687 (binding (nth 7 snippet))
1688 (uuid (nth 8 snippet)))
1699 (insert (pp-to-string
1700 `(yas-define-snippets ',mode ',literal-snippets)))
1703 (let ((snippet-table (yas--table-get-create mode))
1705 (dolist (snippet snippets)
1706 (setq template (yas--define-snippets-1 snippet
1711 ;;; Loading snippets from files
1713 (defun yas--load-yas-setup-file (file)
1714 (if (not yas--creating-compiled-snippets)
1716 (load file 'noerror)
1717 (let ((elfile (concat file ".el")))
1718 (when (file-exists-p elfile)
1719 (insert ";;; .yas-setup.el support file if any:\n;;;\n")
1720 (insert-file-contents elfile)
1721 (goto-char (point-max))))))
1723 (defun yas--define-parents (mode parents)
1724 "Add PARENTS to the list of MODE's parents."
1725 (puthash mode (remove-duplicates
1727 (gethash mode yas--parents)))
1730 (defun yas-load-directory (top-level-dir &optional use-jit interactive)
1731 "Load snippets in directory hierarchy TOP-LEVEL-DIR.
1733 Below TOP-LEVEL-DIR each directory should be a mode name.
1735 With prefix argument USE-JIT do jit-loading of snippets."
1737 (list (read-directory-name "Select the root directory: " nil nil t)
1738 current-prefix-arg t))
1739 (unless yas-snippet-dirs
1740 (setq yas-snippet-dirs top-level-dir))
1741 (let ((impatient-buffers))
1742 (dolist (dir (yas--subdirs top-level-dir))
1743 (let* ((major-mode-and-parents (yas--compute-major-mode-and-parents
1744 (concat dir "/dummy")))
1745 (mode-sym (car major-mode-and-parents))
1746 (parents (cdr major-mode-and-parents)))
1747 ;; Attention: The parents and the menus are already defined
1748 ;; here, even if the snippets are later jit-loaded.
1750 ;; * We need to know the parents at this point since entering a
1751 ;; given mode should jit load for its parents
1752 ;; immediately. This could be reviewed, the parents could be
1753 ;; discovered just-in-time-as well
1755 ;; * We need to create the menus here to support the `full'
1756 ;; option to `yas-use-menu' (all known snippet menus are shown to the user)
1758 (yas--define-parents mode-sym parents)
1759 (yas--menu-keymap-get-create mode-sym)
1760 (let ((fun `(lambda () ;; FIXME: Simulating lexical-binding.
1761 (yas--load-directory-1 ',dir ',mode-sym))))
1763 (yas--schedule-jit mode-sym fun)
1765 ;; Look for buffers that are already in `mode-sym', and so
1766 ;; need the new snippets immediately...
1769 (cl-loop for buffer in (buffer-list)
1770 do (with-current-buffer buffer
1771 (when (eq major-mode mode-sym)
1772 (yas--message 3 "Discovered there was already %s in %s" buffer mode-sym)
1773 (push buffer impatient-buffers)))))))
1774 ;; ...after TOP-LEVEL-DIR has been completely loaded, call
1775 ;; `yas--load-pending-jits' in these impatient buffers.
1777 (cl-loop for buffer in impatient-buffers
1778 do (with-current-buffer buffer (yas--load-pending-jits))))
1780 (yas--message 3 "Loaded snippets from %s." top-level-dir)))
1782 (defun yas--load-directory-1 (directory mode-sym)
1783 "Recursively load snippet templates from DIRECTORY."
1784 (if yas--creating-compiled-snippets
1785 (let ((output-file (expand-file-name ".yas-compiled-snippets.el"
1787 (with-temp-file output-file
1788 (insert (format ";;; Compiled snippets and support files for `%s'\n"
1790 (yas--load-directory-2 directory mode-sym)
1791 (insert (format ";;; Do not edit! File generated at %s\n"
1792 (current-time-string)))))
1794 (unless (file-exists-p (concat directory "/" ".yas-skip"))
1795 (if (and (progn (yas--message 2 "Loading compiled snippets from %s" directory) t)
1796 (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3)))
1797 (yas--message 2 "Loading snippet files from %s" directory)
1798 (yas--load-directory-2 directory mode-sym)))))
1800 (defun yas--load-directory-2 (directory mode-sym)
1801 ;; Load .yas-setup.el files wherever we find them
1803 (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
1804 (let* ((default-directory directory)
1806 ;; load the snippet files
1809 (dolist (file (yas--subdirs directory 'no-subdirs-just-files))
1810 (when (file-readable-p file)
1811 (insert-file-contents file nil nil nil t)
1812 (push (yas--parse-template file)
1815 (yas-define-snippets mode-sym
1817 ;; now recurse to a lower level
1819 (dolist (subdir (yas--subdirs directory))
1820 (yas--load-directory-2 subdir
1823 (defun yas--load-snippet-dirs (&optional nojit)
1824 "Reload the directories listed in `yas-snippet-dirs' or
1825 prompt the user to select one."
1827 (if yas-snippet-dirs
1828 (dolist (directory (reverse (yas-snippet-dirs)))
1829 (cond ((file-directory-p directory)
1830 (yas-load-directory directory (not nojit))
1832 (yas--message 3 "Loaded %s" directory)
1833 (yas--message 3 "Prepared just-in-time loading for %s" directory)))
1835 (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors))))
1836 (call-interactively 'yas-load-directory))
1839 (defun yas-reload-all (&optional no-jit interactive)
1840 "Reload all snippets and rebuild the YASnippet menu.
1842 When NO-JIT is non-nil force immediate reload of all known
1843 snippets under `yas-snippet-dirs', otherwise use just-in-time
1846 When called interactively, use just-in-time loading when given a
1848 (interactive (list (not current-prefix-arg) t))
1851 (snippet-editing-buffers
1852 (remove-if-not #'(lambda (buffer)
1853 (with-current-buffer buffer yas--editing-template))
1855 ;; Warn if there are buffers visiting snippets, since reloading will break
1856 ;; any on-line editing of those buffers.
1858 (when snippet-editing-buffers
1860 (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
1861 (mapc #'kill-buffer snippet-editing-buffers)
1862 (yas--message 1 "Aborted reload...")
1864 ;; in a non-interactive use, at least set
1865 ;; `yas--editing-template' to nil, make it guess it next time around
1866 (mapc #'(lambda (buffer)
1867 (with-current-buffer buffer
1868 (kill-local-variable 'yas--editing-template)))
1871 ;; Empty all snippet tables and parenting info
1873 (setq yas--tables (make-hash-table))
1874 (setq yas--parents (make-hash-table))
1876 ;; Before killing `yas--menu-table' use its keys to cleanup the
1877 ;; mode menu parts of `yas--minor-mode-menu' (thus also cleaning
1878 ;; up `yas-minor-mode-map', which points to it)
1880 (maphash #'(lambda (menu-symbol _keymap)
1881 (define-key yas--minor-mode-menu (vector menu-symbol) nil))
1883 ;; Now empty `yas--menu-table' as well
1884 (setq yas--menu-table (make-hash-table))
1886 ;; Cancel all pending 'yas--scheduled-jit-loads'
1888 (setq yas--scheduled-jit-loads (make-hash-table))
1890 ;; Reload the directories listed in `yas-snippet-dirs' or prompt
1891 ;; the user to select one.
1893 (setq errors (yas--load-snippet-dirs no-jit))
1894 ;; Reload the direct keybindings
1896 (yas-direct-keymaps-reload)
1898 (run-hooks 'yas-after-reload-hook)
1899 (yas--message 3 "Reloaded everything%s...%s."
1900 (if no-jit "" " (snippets will load just-in-time)")
1901 (if errors " (some errors, check *Messages*)" "")))))
1903 (defvar yas-after-reload-hook nil
1904 "Hooks run after `yas-reload-all'.")
1906 (defun yas--load-pending-jits ()
1907 (dolist (mode (yas--modes-to-activate))
1908 (let ((funs (reverse (gethash mode yas--scheduled-jit-loads))))
1909 ;; must reverse to maintain coherence with `yas-snippet-dirs'
1911 (yas--message 3 "Loading for `%s', just-in-time: %s!" mode fun)
1913 (remhash mode yas--scheduled-jit-loads))))
1915 ;; (when (<= emacs-major-version 22)
1916 ;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
1918 (defun yas--quote-string (string)
1919 "Escape and quote STRING.
1920 foo\"bar\\! -> \"foo\\\"bar\\\\!\""
1922 (replace-regexp-in-string "[\\\"]"
1928 ;;; Snippet compilation function
1930 (defun yas-compile-directory (top-level-dir)
1931 "Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
1933 This works by stubbing a few functions, then calling
1934 `yas-load-directory'."
1935 (interactive "DTop level snippet directory?")
1936 (let ((yas--creating-compiled-snippets t))
1937 (yas-load-directory top-level-dir nil)))
1939 (defun yas-recompile-all ()
1940 "Compile every dir in `yas-snippet-dirs'."
1942 (mapc #'yas-compile-directory (yas-snippet-dirs)))
1948 (defvar yas--scheduled-jit-loads (make-hash-table)
1949 "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
1951 (defun yas--schedule-jit (mode fun)
1952 (push fun (gethash mode yas--scheduled-jit-loads)))
1956 ;;; Some user level functions
1960 (message (concat "yasnippet (version "
1962 ") -- pluskid <pluskid@gmail.com>/joaotavora <joaotavora@gmail.com>")))
1965 ;;; Apropos snippet menu:
1967 ;; The snippet menu keymaps are store by mode in hash table called
1968 ;; `yas--menu-table'. They are linked to the main menu in
1969 ;; `yas--menu-keymap-get-create' and are initially created empty,
1970 ;; reflecting the table hierarchy.
1972 ;; They can be populated in two mutually exclusive ways: (1) by
1973 ;; reading `yas--template-group', which in turn is populated by the "#
1974 ;; group:" directives of the snippets or the ".yas-make-groups" file
1975 ;; or (2) by using a separate `yas-define-menu' call, which declares a
1976 ;; menu structure based on snippets uuids.
1978 ;; Both situations are handled in `yas--update-template-menu', which
1979 ;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
1980 ;; that can tell between the two situations.
1984 ;; * if `yas-define-menu' is used it must run before
1985 ;; `yas-define-snippets' and the UUIDS must match, otherwise we get
1986 ;; duplicate entries. The `yas--template' objects are created in
1987 ;; `yas-define-menu', holding nothing but the menu entry,
1988 ;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
1989 ;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
1990 ;; part is then stored in the menu keymap itself which make the item
1991 ;; appear to the user. These limitations could probably be revised.
1993 ;; * The `yas--template-perm-group' slot is only used in
1994 ;; `yas-describe-tables'.
1996 (defun yas--template-menu-binding-pair-get-create (template &optional type)
1997 "Get TEMPLATE's menu binding or assign it a new one.
1999 TYPE may be `:stay', signaling this menu binding should be
2000 static in the menu."
2001 (or (yas--template-menu-binding-pair template)
2002 (let (;; (key (yas--template-key template))
2003 ;; (keybinding (yas--template-keybinding template))
2005 (setf (yas--template-menu-binding-pair template)
2006 (cons `(menu-item ,(or (yas--template-name template)
2007 (yas--template-uuid template))
2008 ,(yas--make-menu-binding template)
2011 (defun yas--template-menu-managed-by-yas-define-menu (template)
2012 "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
2013 (cdr (yas--template-menu-binding-pair template)))
2016 (defun yas--show-menu-p (mode)
2017 (cond ((eq yas-use-menu 'abbreviate)
2019 (mapcar #'(lambda (table)
2020 (yas--table-mode table))
2021 (yas--get-snippet-tables))))
2024 (defun yas--delete-from-keymap (keymap uuid)
2025 "Recursively delete items with UUID from KEYMAP and its submenus."
2027 ;; XXX: This used to skip any submenus named \"parent mode\"
2029 ;; First of all, recursively enter submenus, i.e. the tree is
2030 ;; searched depth first so that stale submenus can be found in the
2033 (mapc #'(lambda (item)
2034 (when (and (listp (cdr item))
2035 (keymapp (third (cdr item))))
2036 (yas--delete-from-keymap (third (cdr item)) uuid)))
2038 ;; Set the uuid entry to nil
2040 (define-key keymap (vector (make-symbol uuid)) nil)
2041 ;; Destructively modify keymap
2043 (setcdr keymap (delete-if #'(lambda (item)
2044 (or (null (cdr item))
2045 (and (keymapp (third (cdr item)))
2046 (null (cdr (third (cdr item)))))))
2049 (defun yas-define-menu (mode menu &optional omit-items)
2050 "Define a snippet menu for MODE according to MENU, omitting OMIT-ITEMS.
2052 MENU is a list, its elements can be:
2054 - (yas-item UUID) : Creates an entry the snippet identified with
2055 UUID. The menu entry for a snippet thus identified is
2056 permanent, i.e. it will never move (be reordered) in the menu.
2058 - (yas-separator) : Creates a separator
2060 - (yas-submenu NAME SUBMENU) : Creates a submenu with NAME,
2061 SUBMENU has the same form as MENU. NAME is also added to the
2062 list of groups of the snippets defined thereafter.
2064 OMIT-ITEMS is a list of snippet uuid's that will always be
2065 omitted from MODE's menu, even if they're manually loaded."
2066 (let* ((table (yas--table-get-create mode))
2067 (hash (yas--table-uuidhash table)))
2068 (yas--define-menu-1 table
2069 (yas--menu-keymap-get-create mode)
2072 (dolist (uuid omit-items)
2073 (let ((template (or (gethash uuid hash)
2074 (yas--populate-template (puthash uuid
2075 (yas--make-blank-template)
2079 (setf (yas--template-menu-binding-pair template) (cons nil :none))))))
2081 (defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
2082 "Helper for `yas-define-menu'."
2083 (dolist (e (reverse menu))
2084 (cond ((eq (first e) 'yas-item)
2085 (let ((template (or (gethash (second e) uuidhash)
2086 (yas--populate-template (puthash (second e)
2087 (yas--make-blank-template)
2090 :perm-group group-list
2091 :uuid (second e)))))
2092 (define-key menu-keymap (vector (gensym))
2093 (car (yas--template-menu-binding-pair-get-create template :stay)))))
2094 ((eq (first e) 'yas-submenu)
2095 (let ((subkeymap (make-sparse-keymap)))
2096 (define-key menu-keymap (vector (gensym))
2097 `(menu-item ,(second e) ,subkeymap))
2098 (yas--define-menu-1 table
2102 (append group-list (list (second e))))))
2103 ((eq (first e) 'yas-separator)
2104 (define-key menu-keymap (vector (gensym))
2105 '(menu-item "----")))
2107 (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
2109 (defun yas--define (mode key template &optional name condition group)
2110 "Define a snippet. Expanding KEY into TEMPLATE.
2112 NAME is a description to this template. Also update the menu if
2113 `yas-use-menu' is t. CONDITION is the condition attached to
2114 this snippet. If you attach a condition to a snippet, then it
2115 will only be expanded when the condition evaluated to non-nil."
2116 (yas-define-snippets mode
2117 (list (list key template name condition group))))
2119 (defun yas-hippie-try-expand (first-time?)
2120 "Integrate with hippie expand.
2122 Just put this function in `hippie-expand-try-functions-list'."
2123 (when yas-minor-mode
2124 (if (not first-time?)
2125 (let ((yas-fallback-behavior 'return-nil))
2131 ;;; Apropos condition-cache:
2136 (defvar yas--condition-cache-timestamp nil)
2137 (defmacro yas-define-condition-cache (func doc &rest body)
2138 "Define a function FUNC with doc DOC and body BODY.
2139 BODY is executed at most once every snippet expansion attempt, to check
2140 expansion conditions.
2142 It doesn't make any sense to call FUNC programatically."
2143 `(defun ,func () ,(if (and doc
2146 "\n\nFor use in snippets' conditions. Within each
2147 snippet-expansion routine like `yas-expand', computes actual
2148 value for the first time then always returns a cached value.")
2149 (setq body (cons doc body))
2151 (let ((timestamp-and-value (get ',func 'yas--condition-cache)))
2152 (if (equal (car timestamp-and-value) yas--condition-cache-timestamp)
2153 (cdr timestamp-and-value)
2154 (let ((new-value (progn
2157 (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
2160 (defalias 'yas-expand 'yas-expand-from-trigger-key)
2161 (defun yas-expand-from-trigger-key (&optional field)
2162 "Expand a snippet before point.
2164 If no snippet expansion is possible, fall back to the behaviour
2165 defined in `yas-fallback-behavior'.
2167 Optional argument FIELD is for non-interactive use and is an
2168 object satisfying `yas--field-p' to restrict the expansion to."
2170 (setq yas--condition-cache-timestamp (current-time))
2171 (let (templates-and-pos)
2172 (unless (and yas-expand-only-for-last-commands
2173 (not (member last-command yas-expand-only-for-last-commands)))
2174 (setq templates-and-pos (if field
2176 (narrow-to-region (yas--field-start field)
2177 (yas--field-end field))
2178 (yas--templates-for-key-at-point))
2179 (yas--templates-for-key-at-point))))
2180 (if templates-and-pos
2181 (yas--expand-or-prompt-for-template (first templates-and-pos)
2182 (second templates-and-pos)
2183 (third templates-and-pos))
2186 (defun yas-expand-from-keymap ()
2187 "Directly expand some snippets, searching `yas--direct-keymaps'.
2189 If expansion fails, execute the previous binding for this key"
2191 (setq yas--condition-cache-timestamp (current-time))
2192 (let* ((vec (subseq (this-command-keys-vector) (if current-prefix-arg
2193 (length (this-command-keys))
2195 (templates (mapcan #'(lambda (table)
2196 (yas--fetch table vec))
2197 (yas--get-snippet-tables))))
2199 (yas--expand-or-prompt-for-template templates)
2200 (let ((yas-fallback-behavior 'call-other-command))
2203 (defun yas--expand-or-prompt-for-template (templates &optional start end)
2204 "Expand one of TEMPLATES from START to END.
2206 Prompt the user if TEMPLATES has more than one element, else
2207 expand immediately. Common gateway for
2208 `yas-expand-from-trigger-key' and `yas-expand-from-keymap'."
2209 (let ((yas--current-template (or (and (rest templates) ;; more than one
2210 (yas--prompt-for-template (mapcar #'cdr templates)))
2212 (when yas--current-template
2213 (yas-expand-snippet (yas--template-content yas--current-template)
2216 (yas--template-expand-env yas--current-template)))))
2218 ;; Apropos the trigger key and the fallback binding:
2220 ;; When `yas-minor-mode-map' binds <tab>, that correctly overrides
2221 ;; org-mode's <tab>, for example and searching for fallbacks correctly
2222 ;; returns `org-cycle'. However, most other modes bind "TAB". TODO,
2223 ;; improve this explanation.
2225 (defun yas--fallback ()
2226 "Fallback after expansion has failed.
2228 Common gateway for `yas-expand-from-trigger-key' and
2229 `yas-expand-from-keymap'."
2230 (cond ((eq yas-fallback-behavior 'return-nil)
2233 ((eq yas-fallback-behavior 'yas--fallback)
2234 (error (concat "yasnippet fallback loop!\n"
2235 "This can happen when you bind `yas-expand' "
2236 "outside of the `yas-minor-mode-map'.")))
2237 ((eq yas-fallback-behavior 'call-other-command)
2238 (let* ((yas-fallback-behavior 'yas--fallback)
2239 ;; Also bind `yas-minor-mode' to prevent fallback
2240 ;; loops when other extensions use mechanisms similar
2241 ;; to `yas--keybinding-beyond-yasnippet'. (github #525
2244 (yas-minor-mode nil)
2245 (beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
2246 (yas--message 4 "Falling back to %s" beyond-yasnippet)
2247 (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
2248 (setq this-original-command beyond-yasnippet)
2249 (when beyond-yasnippet
2250 (call-interactively beyond-yasnippet))))
2251 ((and (listp yas-fallback-behavior)
2252 (cdr yas-fallback-behavior)
2253 (eq 'apply (car yas-fallback-behavior)))
2254 (let ((command-or-fn (cadr yas-fallback-behavior))
2255 (args (cddr yas-fallback-behavior))
2256 (yas-fallback-behavior 'yas--fallback)
2257 (yas-minor-mode nil))
2259 (apply command-or-fn args)
2260 (when (commandp command-or-fn)
2261 (setq this-command command-or-fn)
2262 (call-interactively command-or-fn)))))
2264 ;; also return nil if all the other fallbacks have failed
2267 (defun yas--keybinding-beyond-yasnippet ()
2268 "Get current keys's binding as if YASsnippet didn't exist."
2269 (let* ((yas-minor-mode nil)
2270 (yas--direct-keymaps nil)
2271 (keys (this-single-command-keys)))
2272 (or (key-binding keys t)
2273 (key-binding (yas--fallback-translate-input keys) t))))
2275 (defun yas--fallback-translate-input (keys)
2276 "Emulate `read-key-sequence', at least what I think it does.
2278 Keys should be an untranslated key vector. Returns a translated
2279 vector of keys. FIXME not thoroughly tested."
2282 (while (< i (length keys))
2284 (translated local-function-key-map))
2285 (while (and (< j (length keys))
2287 (keymapp translated))
2288 (setq translated (cdr (assoc (aref keys j) (remove 'keymap translated)))
2290 (setq retval (vconcat retval (cond ((symbolp translated)
2292 ((vectorp translated)
2295 (substring keys i j)))))
2300 ;;; Utils for snippet development:
2302 (defun yas--all-templates (tables)
2303 "Get `yas--template' objects in TABLES, applicable for buffer and point.
2305 Honours `yas-choose-tables-first', `yas-choose-keys-first' and
2306 `yas-buffer-local-condition'"
2307 (when yas-choose-tables-first
2308 (setq tables (list (yas--prompt-for-table tables))))
2310 (if yas-choose-keys-first
2311 (let ((key (yas--prompt-for-keys
2312 (mapcan #'yas--table-all-keys tables))))
2314 (mapcan #'(lambda (table)
2315 (yas--fetch table key))
2317 (remove-duplicates (mapcan #'yas--table-templates tables)
2320 (defun yas-insert-snippet (&optional no-condition)
2321 "Choose a snippet to expand, pop-up a list of choices according
2322 to `yas-prompt-functions'.
2324 With prefix argument NO-CONDITION, bypass filtering of snippets
2327 (setq yas--condition-cache-timestamp (current-time))
2328 (let* ((yas-buffer-local-condition (or (and no-condition
2330 yas-buffer-local-condition))
2331 (templates (yas--all-templates (yas--get-snippet-tables)))
2332 (yas--current-template (and templates
2333 (or (and (rest templates) ;; more than one template for same key
2334 (yas--prompt-for-template templates))
2336 (where (if (region-active-p)
2337 (cons (region-beginning) (region-end))
2338 (cons (point) (point)))))
2339 (if yas--current-template
2340 (yas-expand-snippet (yas--template-content yas--current-template)
2343 (yas--template-expand-env yas--current-template))
2344 (yas--message 3 "No snippets can be inserted here!"))))
2346 (defun yas-visit-snippet-file ()
2347 "Choose a snippet to edit, selection like `yas-insert-snippet'.
2349 Only success if selected snippet was loaded from a file. Put the
2350 visited file in `snippet-mode'."
2352 (let* ((yas-buffer-local-condition 'always)
2353 (templates (yas--all-templates (yas--get-snippet-tables)))
2354 (yas-prompt-functions '(yas-ido-prompt yas-completing-prompt))
2355 (template (and templates
2356 (or (yas--prompt-for-template templates
2357 "Choose a snippet template to edit: ")
2361 (yas--visit-snippet-file-1 template)
2362 (message "No snippets tables active!"))))
2364 (defun yas--visit-snippet-file-1 (template)
2365 "Helper for `yas-visit-snippet-file'."
2366 (let ((file (yas--template-file template)))
2367 (cond ((and file (file-readable-p file))
2368 (find-file-other-window file)
2370 (set (make-local-variable 'yas--editing-template) template))
2372 (message "Original file %s no longer exists!" file))
2374 (switch-to-buffer (format "*%s*"(yas--template-name template)))
2375 (let ((type 'snippet))
2376 (when (listp (yas--template-content template))
2377 (insert (format "# type: command\n"))
2378 (setq type 'command))
2379 (insert (format "# key: %s\n" (yas--template-key template)))
2380 (insert (format "# name: %s\n" (yas--template-name template)))
2381 (when (yas--template-keybinding template)
2382 (insert (format "# binding: %s\n" (yas--template-keybinding template))))
2383 (when (yas--template-expand-env template)
2384 (insert (format "# expand-env: %s\n" (yas--template-expand-env template))))
2385 (when (yas--template-condition template)
2386 (insert (format "# condition: %s\n" (yas--template-condition template))))
2388 (insert (if (eq type 'command)
2389 (pp-to-string (yas--template-content template))
2390 (yas--template-content template))))
2392 (set (make-local-variable 'yas--editing-template) template)))))
2394 (defun yas--guess-snippet-directories-1 (table)
2395 "Guess possible snippet subdirectories for TABLE."
2396 (cons (yas--table-name table)
2397 (mapcan #'(lambda (parent)
2398 (yas--guess-snippet-directories-1
2400 (yas--table-parents table))))
2402 (defun yas--guess-snippet-directories (&optional table)
2403 "Try to guess suitable directories based on the current active
2404 tables (or optional TABLE).
2406 Returns a list of elements (TABLE . DIRS) where TABLE is a
2407 `yas--table' object and DIRS is a list of all possible directories
2408 where snippets of table might exist."
2409 (let ((main-dir (replace-regexp-in-string
2411 (or (first (or (yas-snippet-dirs)
2412 (setq yas-snippet-dirs '("~/.emacs.d/snippets")))))))
2413 (tables (or (and table
2415 (yas--get-snippet-tables))))
2416 ;; HACK! the snippet table created here is actually registered!
2418 (unless (or table (gethash major-mode yas--tables))
2419 (push (yas--table-get-create major-mode)
2422 (mapcar #'(lambda (table)
2424 (mapcar #'(lambda (subdir)
2425 (concat main-dir "/" subdir))
2426 (yas--guess-snippet-directories-1 table))))
2429 (defun yas--make-directory-maybe (table-and-dirs &optional main-table-string)
2430 "Return a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
2431 (or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
2432 (let ((candidate (first (cdr table-and-dirs))))
2433 (unless (file-writable-p (file-name-directory candidate))
2434 (error (yas--format "%s is not writable." candidate)))
2435 (if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
2437 (if (gethash (yas--table-mode (car table-and-dirs))
2441 (or main-table-string
2443 (yas--table-name (car table-and-dirs))))
2445 (make-directory candidate 'also-make-parents)
2446 ;; create the .yas-parents file here...
2449 (defun yas-new-snippet (&optional no-template)
2450 "Pops a new buffer for writing a snippet.
2452 Expands a snippet-writing snippet, unless the optional prefix arg
2453 NO-TEMPLATE is non-nil."
2455 (let ((guessed-directories (yas--guess-snippet-directories)))
2457 (switch-to-buffer "*new snippet*")
2459 (kill-all-local-variables)
2462 (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
2463 (yas--table-mode (car d)))
2464 guessed-directories))
2465 (if (and (not no-template) yas-new-snippet-default)
2466 (yas-expand-snippet yas-new-snippet-default))))
2468 (defun yas--compute-major-mode-and-parents (file)
2469 "Given FILE, find the nearest snippet directory for a given mode.
2471 Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
2472 representing one or more of the mode's parents.
2474 Note that MODE-SYM need not be the symbol of a real major mode,
2475 neither do the elements of PARENTS."
2476 (let* ((file-dir (and file
2477 (directory-file-name (or (some #'(lambda (special)
2478 (locate-dominating-file file special))
2482 (directory-file-name (file-name-directory file))))))
2483 (parents-file-name (concat file-dir "/.yas-parents"))
2484 (major-mode-name (and file-dir
2485 (file-name-nondirectory file-dir)))
2486 (major-mode-sym (or (and major-mode-name
2487 (intern major-mode-name))))
2488 (parents (when (file-readable-p parents-file-name)
2492 (insert-file-contents parents-file-name)
2493 (buffer-substring-no-properties (point-min)
2495 (when major-mode-sym
2496 (cons major-mode-sym (remove major-mode-sym parents)))))
2498 (defvar yas--editing-template nil
2499 "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
2501 (defvar yas--current-template nil
2502 "Holds the current template being expanded into a snippet.")
2504 (defvar yas--guessed-modes nil
2505 "List of guessed modes supporting `yas-load-snippet-buffer'.")
2507 (defun yas--read-table ()
2508 "Ask user for a snippet table, help with some guessing."
2509 (let ((prompt (if (and (featurep 'ido)
2511 'ido-completing-read 'completing-read)))
2512 (unless yas--guessed-modes
2513 (set (make-local-variable 'yas--guessed-modes)
2514 (or (yas--compute-major-mode-and-parents buffer-file-name))))
2516 (funcall prompt (format "Choose or enter a table (yas guesses %s): "
2517 (if yas--guessed-modes
2518 (first yas--guessed-modes)
2520 (mapcar #'symbol-name yas--guessed-modes)
2525 (if (first yas--guessed-modes)
2526 (symbol-name (first yas--guessed-modes)))))))
2528 (defun yas-load-snippet-buffer (table &optional interactive)
2529 "Parse and load current buffer's snippet definition into TABLE.
2531 TABLE is a symbol naming a passed to `yas--table-get-create'.
2533 When called interactively, prompt for the table name."
2534 (interactive (list (yas--read-table) t))
2536 ;; We have `yas--editing-template', this buffer's content comes from a
2537 ;; template which is already loaded and neatly positioned,...
2539 (yas--editing-template
2540 (yas--define-snippets-1 (yas--parse-template (yas--template-file yas--editing-template))
2541 (yas--template-table yas--editing-template)))
2542 ;; Try to use `yas--guessed-modes'. If we don't have that use the
2543 ;; value from `yas--compute-major-mode-and-parents'
2546 (unless yas--guessed-modes
2547 (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
2548 (let* ((table (yas--table-get-create table)))
2549 (set (make-local-variable 'yas--editing-template)
2550 (yas--define-snippets-1 (yas--parse-template buffer-file-name)
2553 (yas--message 3 "Snippet \"%s\" loaded for %s."
2554 (yas--template-name yas--editing-template)
2555 (yas--table-name (yas--template-table yas--editing-template)))))
2557 (defun yas-load-snippet-buffer-and-close (table &optional kill)
2558 "Load the snippet with `yas-load-snippet-buffer', possibly
2559 save, then `quit-window' if saved.
2561 If the snippet is new, ask the user whether (and where) to save
2562 it. If the snippet already has a file, just save it.
2564 The prefix argument KILL is passed to `quit-window'.
2566 Don't use this from a Lisp program, call `yas-load-snippet-buffer'
2567 and `kill-buffer' instead."
2568 (interactive (list (yas--read-table) current-prefix-arg))
2569 (yas-load-snippet-buffer table t)
2571 ;; Only offer to save this if it looks like a library or new
2572 ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
2573 ;; which is not the first, or from an unwritable file)
2575 (not (yas--template-file yas--editing-template))
2576 (not (file-writable-p (yas--template-file yas--editing-template)))
2577 (and (listp yas-snippet-dirs)
2578 (second yas-snippet-dirs)
2579 (not (string-match (expand-file-name (first yas-snippet-dirs))
2580 (yas--template-file yas--editing-template)))))
2581 (y-or-n-p (yas--format "Looks like a library or new snippet. Save to new file? ")))
2582 (let* ((option (first (yas--guess-snippet-directories (yas--template-table yas--editing-template))))
2584 (yas--make-directory-maybe option))))
2586 (let ((default-file-name (or (and (yas--template-file yas--editing-template)
2587 (file-name-nondirectory (yas--template-file yas--editing-template)))
2588 (yas--template-name yas--editing-template))))
2589 (write-file (concat chosen "/"
2590 (read-from-minibuffer (format "File name to create in %s? " chosen)
2591 default-file-name)))
2592 (setf (yas--template-file yas--editing-template) buffer-file-name)))))
2593 (when buffer-file-name
2595 (quit-window kill)))
2597 (defun yas-tryout-snippet (&optional debug)
2598 "Test current buffer's snippet template in other buffer."
2600 (let* ((major-mode-and-parent (yas--compute-major-mode-and-parents buffer-file-name))
2601 (parsed (yas--parse-template))
2602 (test-mode (or (and (car major-mode-and-parent)
2603 (fboundp (car major-mode-and-parent))
2604 (car major-mode-and-parent))
2605 (first yas--guessed-modes)
2606 (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
2607 (yas--current-template
2610 (yas--populate-template (yas--make-blank-template)
2611 :table nil ;; no tables for ephemeral snippets
2613 :content (second parsed)
2614 :name (third parsed)
2615 :expand-env (sixth parsed)))))
2616 (cond (yas--current-template
2617 (let ((buffer-name (format "*testing snippet: %s*" (yas--template-name yas--current-template))))
2618 (kill-buffer (get-buffer-create buffer-name))
2619 (switch-to-buffer (get-buffer-create buffer-name))
2620 (setq buffer-undo-list nil)
2621 (condition-case nil (funcall test-mode) (error nil))
2623 (setq buffer-read-only nil)
2624 (yas-expand-snippet (yas--template-content yas--current-template)
2627 (yas--template-expand-env yas--current-template))
2629 (require 'yasnippet-debug nil t))
2630 (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
2632 (yas--message 3 "Cannot test snippet for unknown major mode")))))
2634 (defun yas-active-keys ()
2635 "Return all active trigger keys for current buffer and point."
2637 (remove-if-not #'stringp (mapcan #'yas--table-all-keys (yas--get-snippet-tables)))
2640 (defun yas--template-fine-group (template)
2641 (car (last (or (yas--template-group template)
2642 (yas--template-perm-group template)))))
2644 (defun yas-describe-tables (&optional choose)
2645 "Display snippets for each table."
2647 (let* ((by-name-hash (and choose
2648 (y-or-n-p "Show by namehash? ")))
2649 (buffer (get-buffer-create "*YASnippet tables*"))
2650 (active-tables (yas--get-snippet-tables))
2651 (remain-tables (let ((all))
2652 (maphash #'(lambda (_k v)
2653 (unless (find v active-tables)
2657 (table-lists (list active-tables remain-tables))
2658 (original-buffer (current-buffer))
2660 (yas--condition-cache-timestamp (current-time)))
2661 (with-current-buffer buffer
2662 (setq buffer-read-only nil)
2664 (cond ((not by-name-hash)
2665 (insert "YASnippet tables: \n")
2666 (while (and table-lists
2668 (dolist (table (car table-lists))
2669 (yas--describe-pretty-table table original-buffer))
2670 (setq table-lists (cdr table-lists))
2672 (yas--create-snippet-xrefs)
2673 (display-buffer buffer)
2674 (setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
2675 (yas--create-snippet-xrefs)
2679 (insert "\n\nYASnippet tables by NAMEHASH: \n")
2680 (dolist (table (append active-tables remain-tables))
2681 (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
2683 (maphash #'(lambda (k _v)
2685 (yas--table-hash table))
2687 (insert (format " key %s maps snippets: %s\n" key
2689 (maphash #'(lambda (k _v)
2691 (gethash key (yas--table-hash table)))
2694 (setq buffer-read-only t))
2695 (display-buffer buffer)))
2697 (defun yas--describe-pretty-table (table &optional original-buffer)
2698 (insert (format "\nSnippet table `%s'"
2699 (yas--table-name table)))
2700 (if (yas--table-parents table)
2701 (insert (format " parents: %s\n"
2702 (mapcar #'yas--table-name
2703 (yas--table-parents table))))
2705 (insert (make-string 100 ?-) "\n")
2706 (insert "group state name key binding\n")
2707 (let ((groups-hash (make-hash-table :test #'equal)))
2708 (maphash #'(lambda (_k v)
2709 (let ((group (or (yas--template-fine-group v)
2711 (when (yas--template-name v)
2713 (cons v (gethash group groups-hash))
2715 (yas--table-uuidhash table))
2717 #'(lambda (group templates)
2718 (setq group (truncate-string-to-width group 25 0 ? "..."))
2719 (insert (make-string 100 ?-) "\n")
2720 (dolist (p templates)
2721 (let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas--template-name p))
2725 (setq group (make-string (length group) ? ))))
2726 (condition-string (let ((condition (yas--template-condition p)))
2729 (with-current-buffer original-buffer
2730 (if (yas--eval-condition condition)
2735 (insert condition-string " ")
2737 (if (string-match "\\.\\.\\.$" name)
2741 (insert (truncate-string-to-width (or (yas--template-key p) "")
2743 (insert (truncate-string-to-width (key-description (yas--template-keybinding p))
2750 ;;; User convenience functions, for using in `yas-key-syntaxes'
2752 (defun yas-try-key-from-whitespace (_start-point)
2753 "As `yas-key-syntaxes' element, look for whitespace delimited key.
2755 A newline will be considered whitespace even if the mode syntax
2756 marks it as something else (typically comment ender)."
2757 (skip-chars-backward "^[:space:]\n"))
2759 (defun yas-shortest-key-until-whitespace (_start-point)
2760 "Like `yas-longest-key-from-whitespace' but take the shortest key."
2761 (when (/= (skip-chars-backward "^[:space:]\n" (1- (point))) 0)
2764 (defun yas-longest-key-from-whitespace (start-point)
2765 "As `yas-key-syntaxes' element, look for longest key between point and whitespace.
2767 A newline will be considered whitespace even if the mode syntax
2768 marks it as something else (typically comment ender)."
2769 (if (= (point) start-point)
2770 (yas-try-key-from-whitespace start-point)
2772 (unless (<= start-point (1+ (point)))
2777 ;;; User convenience functions, for using in snippet definitions
2779 (defvar yas-modified-p nil
2780 "Non-nil if field has been modified by user or transformation.")
2782 (defvar yas-moving-away-p nil
2783 "Non-nil if user is about to exit field.")
2785 (defvar yas-text nil
2786 "Contains current field text.")
2788 (defun yas-substr (str pattern &optional subexp)
2789 "Search PATTERN in STR and return SUBEXPth match.
2791 If found, the content of subexp group SUBEXP (default 0) is
2792 returned, or else the original STR will be returned."
2793 (let ((grp (or subexp 0)))
2795 (if (string-match pattern str)
2796 (match-string-no-properties grp str)
2799 (defun yas-choose-value (&rest possibilities)
2800 "Prompt for a string in POSSIBILITIES and return it.
2802 The last element of POSSIBILITIES may be a list of strings."
2803 (unless (or yas-moving-away-p
2805 (let* ((last-link (last possibilities))
2806 (last-elem (car last-link)))
2807 (when (listp last-elem)
2808 (setcar last-link (car last-elem))
2809 (setcdr last-link (cdr last-elem))))
2810 (some #'(lambda (fn)
2811 (funcall fn "Choose: " possibilities))
2812 yas-prompt-functions)))
2814 (defun yas-key-to-value (alist)
2815 (unless (or yas-moving-away-p
2817 (let ((key (read-key-sequence "")))
2819 (or (cdr (find key alist :key #'car :test #'string=))
2822 (defun yas-throw (text)
2823 "Throw a yas--exception with TEXT as the reason."
2824 (throw 'yas--exception (cons 'yas--exception text)))
2826 (defun yas-verify-value (possibilities)
2827 "Verify that the current field value is in POSSIBILITIES.
2829 Otherwise throw exception."
2830 (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
2831 (yas-throw (yas--format "Field only allows %s" possibilities))))
2833 (defun yas-field-value (number)
2834 "Get the string for field with NUMBER.
2836 Use this in primary and mirror transformations to tget."
2837 (let* ((snippet (car (yas--snippets-at-point)))
2839 (yas--snippet-find-field snippet number))))
2841 (yas--field-text-for-display field))))
2844 "Return `yas-text' if that exists and is non-empty, else nil."
2846 (not (string= "" yas-text)))
2849 (defun yas-selected-text ()
2850 "Return `yas-selected-text' if that exists and is non-empty, else nil."
2851 (if (and yas-selected-text
2852 (not (string= "" yas-selected-text)))
2855 (defun yas--get-field-once (number &optional transform-fn)
2856 (unless yas-modified-p
2858 (funcall transform-fn (yas-field-value number))
2859 (yas-field-value number))))
2861 (defun yas-default-from-field (number)
2862 (unless yas-modified-p
2863 (yas-field-value number)))
2865 (defun yas-inside-string ()
2866 "Return non-nil if the point is inside a string according to font-lock."
2867 (equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
2869 (defun yas-unimplemented (&optional missing-feature)
2870 (if yas--current-template
2871 (if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
2874 (yas--visit-snippet-file-1 yas--current-template))
2875 (message "No implementation. Missing %s" (or missing-feature "something"))))
2878 ;;; Snippet expansion and field management
2880 (defvar yas--active-field-overlay nil
2881 "Overlays the currently active field.")
2883 (defvar yas--field-protection-overlays nil
2884 "Two overlays protect the current active field.")
2886 (defvar yas-selected-text nil
2887 "The selected region deleted on the last snippet expansion.")
2889 (defvar yas--start-column nil
2890 "The column where the snippet expansion started.")
2892 (make-variable-buffer-local 'yas--active-field-overlay)
2893 (make-variable-buffer-local 'yas--field-protection-overlays)
2894 (put 'yas--active-field-overlay 'permanent-local t)
2895 (put 'yas--field-protection-overlays 'permanent-local t)
2897 (defstruct (yas--snippet (:constructor yas--make-snippet ()))
2903 (id (yas--snippet-next-id) :read-only t)
2904 (control-overlay nil)
2906 ;; stacked expansion: the `previous-active-field' slot saves the
2907 ;; active field where the child expansion took place
2908 previous-active-field
2911 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
2914 NUMBER is the field number.
2915 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2916 PARENT-FIELD is a `yas--field' this field is nested under, or nil.
2917 MIRRORS is a list of `yas--mirror's
2918 TRANSFORM is a lisp form.
2919 MODIFIED-P is a boolean set to true once user inputs text.
2920 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'.
2931 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
2934 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2935 TRANSFORM is a lisp form.
2936 PARENT-FIELD is a `yas--field' this mirror is nested under, or nil.
2937 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'
2938 DEPTH is a count of how many nested mirrors can affect this mirror"
2945 (defstruct (yas--exit (:constructor yas--make-exit (marker)))
2949 (defun yas--apply-transform (field-or-mirror field &optional empty-on-nil-p)
2950 "Calculate transformed string for FIELD-OR-MIRROR from FIELD.
2952 If there is no transform for ht field, return nil.
2954 If there is a transform but it returns nil, return the empty
2955 string iff EMPTY-ON-NIL-P is true."
2956 (let* ((yas-text (yas--field-text-for-display field))
2957 (yas-modified-p (yas--field-modified-p field))
2958 (yas-moving-away-p nil)
2959 (transform (if (yas--mirror-p field-or-mirror)
2960 (yas--mirror-transform field-or-mirror)
2961 (yas--field-transform field-or-mirror)))
2962 (start-point (if (yas--mirror-p field-or-mirror)
2963 (yas--mirror-start field-or-mirror)
2964 (yas--field-start field-or-mirror)))
2965 (transformed (and transform
2967 (goto-char start-point)
2968 (let ((ret (yas--eval-lisp transform)))
2969 (or ret (and empty-on-nil-p "")))))))
2972 (defsubst yas--replace-all (from to &optional text)
2973 "Replace all occurrences from FROM to TO.
2975 With optional string TEXT do it in that string."
2977 (replace-regexp-in-string (regexp-quote from) to text t t)
2978 (goto-char (point-min))
2979 (while (search-forward from nil t)
2980 (replace-match to t t text))))
2982 (defun yas--snippet-find-field (snippet number)
2983 (find-if #'(lambda (field)
2984 (eq number (yas--field-number field)))
2985 (yas--snippet-fields snippet)))
2987 (defun yas--snippet-sort-fields (snippet)
2988 "Sort the fields of SNIPPET in navigation order."
2989 (setf (yas--snippet-fields snippet)
2990 (sort (yas--snippet-fields snippet)
2991 #'yas--snippet-field-compare)))
2993 (defun yas--snippet-field-compare (field1 field2)
2994 "Compare FIELD1 and FIELD2.
2996 The field with a number is sorted first. If they both have a
2997 number, compare through the number. If neither have, compare
2998 through the field's start point"
2999 (let ((n1 (yas--field-number field1))
3000 (n2 (yas--field-number field2)))
3003 (or (zerop n2) (and (not (zerop n1))
3008 (< (yas--field-start field1)
3009 (yas--field-start field2))))))
3011 (defun yas--field-probably-deleted-p (snippet field)
3012 "Guess if SNIPPET's FIELD should be skipped."
3014 ;; field must be zero length
3016 (zerop (- (yas--field-start field) (yas--field-end field)))
3017 ;; field must have been modified
3019 (yas--field-modified-p field)
3022 ;; 1) it's a nested field
3024 (yas--field-parent-field field)
3025 ;; 2) ends just before the snippet end
3027 (and (eq field (car (last (yas--snippet-fields snippet))))
3028 (= (yas--field-start field) (overlay-end (yas--snippet-control-overlay snippet)))))
3029 ;; the field numbered 0, just before the exit marker, should
3032 (not (zerop (yas--field-number field)))))
3034 (defun yas--snippets-at-point (&optional all-snippets)
3035 "Return a sorted list of snippets at point.
3037 The most recently-inserted snippets are returned first."
3039 (remove nil (remove-duplicates (mapcar #'(lambda (ov)
3040 (overlay-get ov 'yas--snippet))
3042 (overlays-in (point-min) (point-max))
3043 (nconc (overlays-at (point)) (overlays-at (1- (point))))))))
3045 (<= (yas--snippet-id s2) (yas--snippet-id s1)))))
3047 (defun yas-next-field-or-maybe-expand ()
3048 "Try to expand a snippet at a key before point.
3050 Otherwise delegate to `yas-next-field'."
3052 (if yas-triggers-in-field
3053 (let ((yas-fallback-behavior 'return-nil)
3054 (active-field (overlay-get yas--active-field-overlay 'yas--field)))
3056 (unless (yas-expand-from-trigger-key active-field)
3060 (defun yas-next-field (&optional arg)
3061 "Navigate to the ARGth next field.
3063 If there's none, exit the snippet."
3067 (snippet (first (yas--snippets-at-point)))
3068 (active-field (overlay-get yas--active-field-overlay 'yas--field))
3069 (live-fields (remove-if #'(lambda (field)
3070 (and (not (eq field active-field))
3071 (yas--field-probably-deleted-p snippet field)))
3072 (yas--snippet-fields snippet)))
3073 (active-field-pos (position active-field live-fields))
3074 (target-pos (and active-field-pos (+ arg active-field-pos)))
3075 (target-field (and target-pos (nth target-pos live-fields))))
3076 ;; First check if we're moving out of a field with a transform
3078 (when (and active-field
3079 (yas--field-transform active-field))
3080 (let* ((yas-moving-away-p t)
3081 (yas-text (yas--field-text-for-display active-field))
3082 (yas-modified-p (yas--field-modified-p active-field)))
3083 ;; primary field transform: exit call to field-transform
3084 (yas--eval-lisp (yas--field-transform active-field))))
3085 ;; Now actually move...
3086 (cond ((and target-pos (>= target-pos (length live-fields)))
3087 (yas-exit-snippet snippet))
3089 (yas--move-to-field snippet target-field))
3093 (defun yas--place-overlays (snippet field)
3094 "Correctly place overlays for SNIPPET's FIELD."
3095 (yas--make-move-field-protection-overlays snippet field)
3096 (yas--make-move-active-field-overlay snippet field))
3098 (defun yas--move-to-field (snippet field)
3099 "Update SNIPPET to move to field FIELD.
3101 Also create some protection overlays"
3102 (goto-char (yas--field-start field))
3103 (yas--place-overlays snippet field)
3104 (overlay-put yas--active-field-overlay 'yas--field field)
3105 (let ((number (yas--field-number field)))
3106 ;; check for the special ${0: ...} field
3107 (if (and number (zerop number))
3109 (set-mark (yas--field-end field))
3110 (setf (yas--snippet-force-exit snippet)
3111 (or (yas--field-transform field)
3113 ;; make this field active
3114 (setf (yas--snippet-active-field snippet) field)
3115 ;; primary field transform: first call to snippet transform
3116 (unless (yas--field-modified-p field)
3117 (if (yas--field-update-display field)
3118 (yas--update-mirrors snippet)
3119 (setf (yas--field-modified-p field) nil))))))
3121 (defun yas-prev-field ()
3122 "Navigate to prev field. If there's none, exit the snippet."
3124 (yas-next-field -1))
3126 (defun yas-abort-snippet (&optional snippet)
3128 (let ((snippet (or snippet
3129 (car (yas--snippets-at-point)))))
3131 (setf (yas--snippet-force-exit snippet) t))))
3133 (defun yas-exit-snippet (snippet)
3134 "Goto exit-marker of SNIPPET."
3135 (interactive (list (first (yas--snippets-at-point))))
3137 (setf (yas--snippet-force-exit snippet) t)
3138 (goto-char (if (yas--snippet-exit snippet)
3139 (yas--exit-marker (yas--snippet-exit snippet))
3140 (overlay-end (yas--snippet-control-overlay snippet))))))
3142 (defun yas-exit-all-snippets ()
3143 "Exit all snippets."
3145 (mapc #'(lambda (snippet)
3146 (yas-exit-snippet snippet)
3147 (yas--check-commit-snippet))
3148 (yas--snippets-at-point 'all-snippets)))
3151 ;;; Some low level snippet-routines:
3153 (defvar yas--inhibit-overlay-hooks nil
3154 "Bind this temporarily to non-nil to prevent running `yas--on-*-modification'.")
3156 (defmacro yas--inhibit-overlay-hooks (&rest body)
3157 "Run BODY with `yas--inhibit-overlay-hooks' set to t."
3158 (declare (indent 0))
3159 `(let ((yas--inhibit-overlay-hooks t))
3162 (defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
3163 (defvar yas-snippet-end nil "End position of the last snippet committed.")
3165 (defun yas--commit-snippet (snippet)
3166 "Commit SNIPPET, but leave point as it is.
3168 This renders the snippet as ordinary text."
3170 (let ((control-overlay (yas--snippet-control-overlay snippet)))
3172 ;; Save the end of the moribund snippet in case we need to revive it
3173 ;; its original expansion.
3175 (when (and control-overlay
3176 (overlay-buffer control-overlay))
3177 (setq yas-snippet-beg (overlay-start control-overlay))
3178 (setq yas-snippet-end (overlay-end control-overlay))
3179 (delete-overlay control-overlay))
3181 (yas--inhibit-overlay-hooks
3182 (when yas--active-field-overlay
3183 (delete-overlay yas--active-field-overlay))
3184 (when yas--field-protection-overlays
3185 (mapc #'delete-overlay yas--field-protection-overlays)))
3187 ;; stacked expansion: if the original expansion took place from a
3188 ;; field, make sure we advance it here at least to
3189 ;; `yas-snippet-end'...
3191 (let ((previous-field (yas--snippet-previous-active-field snippet)))
3192 (when (and yas-snippet-end previous-field)
3193 (yas--advance-end-maybe previous-field yas-snippet-end)))
3195 ;; Convert all markers to points,
3197 (yas--markers-to-points snippet)
3199 ;; Take care of snippet revival
3201 (if yas-snippet-revival
3202 (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
3204 ;; Dismember the snippet... this is useful if we get called
3205 ;; again from `yas--take-care-of-redo'....
3206 (setf (yas--snippet-fields snippet) nil)))
3208 (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
3210 (defun yas--safely-run-hooks (hook-var)
3211 (condition-case error
3212 (run-hooks hook-var)
3214 (yas--message 3 "%s error: %s" hook-var (error-message-string error)))))
3217 (defun yas--check-commit-snippet ()
3218 "Check if point exited the currently active field of the snippet.
3220 If so cleans up the whole snippet up."
3221 (let* ((snippets (yas--snippets-at-point 'all-snippets))
3222 (snippets-left snippets)
3223 (snippet-exit-transform))
3224 (dolist (snippet snippets)
3225 (let ((active-field (yas--snippet-active-field snippet)))
3226 (setq snippet-exit-transform (yas--snippet-force-exit snippet))
3227 (cond ((or snippet-exit-transform
3228 (not (and active-field (yas--field-contains-point-p active-field))))
3229 (setq snippets-left (delete snippet snippets-left))
3230 (setf (yas--snippet-force-exit snippet) nil)
3231 (yas--commit-snippet snippet))
3233 (or (not yas--active-field-overlay)
3234 (not (overlay-buffer yas--active-field-overlay))))
3236 ;; stacked expansion: this case is mainly for recent
3237 ;; snippet exits that place us back int the field of
3241 (yas--move-to-field snippet active-field)
3242 (yas--update-mirrors snippet)))
3245 (unless (or (null snippets) snippets-left)
3246 (if snippet-exit-transform
3247 (yas--eval-lisp-no-saves snippet-exit-transform))
3248 (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
3250 ;; Apropos markers-to-points:
3252 ;; This was found useful for performance reasons, so that an
3253 ;; excessive number of live markers aren't kept around in the
3254 ;; `buffer-undo-list'. However, in `markers-to-points', the
3255 ;; set-to-nil markers can't simply be discarded and replaced with
3256 ;; fresh ones in `points-to-markers'. The original marker that was
3257 ;; just set to nil has to be reused.
3259 ;; This shouldn't bring horrible problems with undo/redo, but it
3262 (defun yas--markers-to-points (snippet)
3263 "Convert all markers in SNIPPET to a cons (POINT . MARKER)
3264 where POINT is the original position of the marker and MARKER is
3265 the original marker object with the position set to nil."
3266 (dolist (field (yas--snippet-fields snippet))
3267 (let ((start (marker-position (yas--field-start field)))
3268 (end (marker-position (yas--field-end field))))
3269 (set-marker (yas--field-start field) nil)
3270 (set-marker (yas--field-end field) nil)
3271 (setf (yas--field-start field) (cons start (yas--field-start field)))
3272 (setf (yas--field-end field) (cons end (yas--field-end field))))
3273 (dolist (mirror (yas--field-mirrors field))
3274 (let ((start (marker-position (yas--mirror-start mirror)))
3275 (end (marker-position (yas--mirror-end mirror))))
3276 (set-marker (yas--mirror-start mirror) nil)
3277 (set-marker (yas--mirror-end mirror) nil)
3278 (setf (yas--mirror-start mirror) (cons start (yas--mirror-start mirror)))
3279 (setf (yas--mirror-end mirror) (cons end (yas--mirror-end mirror))))))
3280 (let ((snippet-exit (yas--snippet-exit snippet)))
3282 (let ((exit (marker-position (yas--exit-marker snippet-exit))))
3283 (set-marker (yas--exit-marker snippet-exit) nil)
3284 (setf (yas--exit-marker snippet-exit) (cons exit (yas--exit-marker snippet-exit)))))))
3286 (defun yas--points-to-markers (snippet)
3287 "Convert all cons (POINT . MARKER) in SNIPPET to markers.
3289 This is done by setting MARKER to POINT with `set-marker'."
3290 (dolist (field (yas--snippet-fields snippet))
3291 (setf (yas--field-start field) (set-marker (cdr (yas--field-start field))
3292 (car (yas--field-start field))))
3293 (setf (yas--field-end field) (set-marker (cdr (yas--field-end field))
3294 (car (yas--field-end field))))
3295 (dolist (mirror (yas--field-mirrors field))
3296 (setf (yas--mirror-start mirror) (set-marker (cdr (yas--mirror-start mirror))
3297 (car (yas--mirror-start mirror))))
3298 (setf (yas--mirror-end mirror) (set-marker (cdr (yas--mirror-end mirror))
3299 (car (yas--mirror-end mirror))))))
3300 (let ((snippet-exit (yas--snippet-exit snippet)))
3302 (setf (yas--exit-marker snippet-exit) (set-marker (cdr (yas--exit-marker snippet-exit))
3303 (car (yas--exit-marker snippet-exit)))))))
3305 (defun yas--field-contains-point-p (field &optional point)
3306 (let ((point (or point
3308 (and (>= point (yas--field-start field))
3309 (<= point (yas--field-end field)))))
3311 (defun yas--field-text-for-display (field)
3312 "Return the propertized display text for field FIELD."
3313 (buffer-substring (yas--field-start field) (yas--field-end field)))
3315 (defun yas--undo-in-progress ()
3316 "True if some kind of undo is in progress."
3317 (or undo-in-progress
3318 (eq this-command 'undo)
3319 (eq this-command 'redo)))
3321 (defun yas--make-control-overlay (snippet start end)
3322 "Create the control overlay that surrounds the snippet and
3324 (let ((overlay (make-overlay start
3329 (overlay-put overlay 'keymap yas-keymap)
3330 (overlay-put overlay 'priority 100)
3331 (overlay-put overlay 'yas--snippet snippet)
3334 (defun yas-skip-and-clear-or-delete-char (&optional field)
3335 "Clears unmodified field if at field start, skips to next tab.
3337 Otherwise deletes a character normally by calling `delete-char'."
3339 (let ((field (or field
3340 (and yas--active-field-overlay
3341 (overlay-buffer yas--active-field-overlay)
3342 (overlay-get yas--active-field-overlay 'yas--field)))))
3344 (not (yas--field-modified-p field))
3345 (eq (point) (marker-position (yas--field-start field))))
3346 (yas--skip-and-clear field)
3349 (call-interactively 'delete-char)))))
3351 (defun yas--skip-and-clear (field)
3352 "Deletes the region of FIELD and sets it's modified state to t."
3353 ;; Just before skipping-and-clearing the field, mark its children
3354 ;; fields as modified, too. If the children have mirrors-in-fields
3355 ;; this prevents them from updating erroneously (we're skipping and
3358 (yas--mark-this-and-children-modified field)
3359 (delete-region (yas--field-start field) (yas--field-end field)))
3361 (defun yas--mark-this-and-children-modified (field)
3362 (setf (yas--field-modified-p field) t)
3363 (let ((fom (yas--field-next field)))
3365 (yas--fom-parent-field fom))
3366 (when (and (eq (yas--fom-parent-field fom) field)
3368 (yas--mark-this-and-children-modified fom))
3369 (setq fom (yas--fom-next fom)))))
3371 (defun yas--make-move-active-field-overlay (snippet field)
3372 "Place the active field overlay in SNIPPET's FIELD.
3374 Move the overlay, or create it if it does not exit."
3375 (if (and yas--active-field-overlay
3376 (overlay-buffer yas--active-field-overlay))
3377 (move-overlay yas--active-field-overlay
3378 (yas--field-start field)
3379 (yas--field-end field))
3380 (setq yas--active-field-overlay
3381 (make-overlay (yas--field-start field)
3382 (yas--field-end field)
3384 (overlay-put yas--active-field-overlay 'priority 100)
3385 (overlay-put yas--active-field-overlay 'face 'yas-field-highlight-face)
3386 (overlay-put yas--active-field-overlay 'yas--snippet snippet)
3387 (overlay-put yas--active-field-overlay 'modification-hooks '(yas--on-field-overlay-modification))
3388 (overlay-put yas--active-field-overlay 'insert-in-front-hooks
3389 '(yas--on-field-overlay-modification))
3390 (overlay-put yas--active-field-overlay 'insert-behind-hooks
3391 '(yas--on-field-overlay-modification))))
3393 (defun yas--on-field-overlay-modification (overlay after? _beg _end &optional _length)
3394 "Clears the field and updates mirrors, conditionally.
3396 Only clears the field if it hasn't been modified and it point it
3397 at field start. This hook doesn't do anything if an undo is in
3399 (unless (or yas--inhibit-overlay-hooks
3400 (yas--undo-in-progress))
3401 (let* ((field (overlay-get overlay 'yas--field))
3402 (snippet (overlay-get yas--active-field-overlay 'yas--snippet)))
3404 (yas--advance-end-maybe field (overlay-end overlay))
3406 (yas--field-update-display field))
3407 (yas--update-mirrors snippet))
3409 (when (and (not after?)
3410 (not (yas--field-modified-p field))
3411 (eq (point) (if (markerp (yas--field-start field))
3412 (marker-position (yas--field-start field))
3413 (yas--field-start field))))
3414 (yas--skip-and-clear field))
3415 (setf (yas--field-modified-p field) t))))))
3417 ;;; Apropos protection overlays:
3419 ;; These exist for nasty users who will try to delete parts of the
3420 ;; snippet outside the active field. Actual protection happens in
3421 ;; `yas--on-protection-overlay-modification'.
3423 ;; As of github #537 this no longer inhibits the command by issuing an
3424 ;; error: all the snippets at point, including nested snippets, are
3425 ;; automatically commited and the current command can proceed.
3427 (defun yas--make-move-field-protection-overlays (snippet field)
3428 "Place protection overlays surrounding SNIPPET's FIELD.
3430 Move the overlays, or create them if they do not exit."
3431 (let ((start (yas--field-start field))
3432 (end (yas--field-end field)))
3433 ;; First check if the (1+ end) is contained in the buffer,
3434 ;; otherwise we'll have to do a bit of cheating and silently
3435 ;; insert a newline. the `(1+ (buffer-size))' should prevent this
3436 ;; when using stacked expansion
3438 (when (< (buffer-size) end)
3440 (yas--inhibit-overlay-hooks
3441 (goto-char (point-max))
3443 ;; go on to normal overlay creation/moving
3445 (cond ((and yas--field-protection-overlays
3446 (every #'overlay-buffer yas--field-protection-overlays))
3447 (move-overlay (first yas--field-protection-overlays) (1- start) start)
3448 (move-overlay (second yas--field-protection-overlays) end (1+ end)))
3450 (setq yas--field-protection-overlays
3451 (list (make-overlay (1- start) start nil t nil)
3452 (make-overlay end (1+ end) nil t nil)))
3453 (dolist (ov yas--field-protection-overlays)
3454 (overlay-put ov 'face 'yas--field-debug-face)
3455 (overlay-put ov 'yas--snippet snippet)
3456 ;; (overlay-put ov 'evaporate t)
3457 (overlay-put ov 'modification-hooks '(yas--on-protection-overlay-modification)))))))
3459 (defun yas--on-protection-overlay-modification (_overlay after? _beg _end &optional _length)
3460 "Signals a snippet violation, then issues error.
3462 The error should be ignored in `debug-ignored-errors'"
3463 (unless (or yas--inhibit-overlay-hooks
3465 (yas--undo-in-progress))
3466 (let ((snippets (yas--snippets-at-point)))
3467 (yas--message 3 "Comitting snippets. Action would destroy a protection overlay.")
3468 (cl-loop for snippet in snippets
3469 do (yas--commit-snippet snippet)))))
3471 (add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
3474 ;;; Snippet expansion and "stacked" expansion:
3476 ;; Stacked expansion is when you try to expand a snippet when already
3477 ;; inside a snippet expansion.
3479 ;; The parent snippet does not run its fields modification hooks
3480 ;; (`yas--on-field-overlay-modification' and
3481 ;; `yas--on-protection-overlay-modification') while the child snippet
3482 ;; is active. This means, among other things, that the mirrors of the
3483 ;; parent snippet are not updated, this only happening when one exits
3484 ;; the child snippet.
3486 ;; Unfortunately, this also puts some ugly (and not fully-tested)
3487 ;; bits of code in `yas-expand-snippet' and
3488 ;; `yas--commit-snippet'. I've tried to mark them with "stacked
3491 ;; This was thought to be safer in an undo/redo perspective, but
3492 ;; maybe the correct implementation is to make the globals
3493 ;; `yas--active-field-overlay' and `yas--field-protection-overlays' be
3494 ;; snippet-local and be active even while the child snippet is
3495 ;; running. This would mean a lot of overlay modification hooks
3496 ;; running, but if managed correctly (including overlay priorities)
3497 ;; they should account for all situations...
3499 (defun yas-expand-snippet (content &optional start end expand-env)
3500 "Expand snippet CONTENT at current point.
3502 Text between START and END will be deleted before inserting
3503 template. EXPAND-ENV is a list of (SYM VALUE) let-style dynamic bindings
3504 considered when expanding the snippet."
3505 (run-hooks 'yas-before-expand-snippet-hook)
3508 (let* ((yas-selected-text (or yas-selected-text
3509 (and (region-active-p)
3510 (buffer-substring-no-properties (region-beginning)
3513 (and (region-active-p)
3517 (and (region-active-p)
3520 (to-delete (and start
3522 (buffer-substring-no-properties start end)))
3525 (setq yas--indent-original-column (current-column))
3526 ;; Delete the region to delete, this *does* get undo-recorded.
3528 (when (and to-delete
3530 (delete-region start end))
3532 (cond ((listp content)
3533 ;; x) This is a snippet-command
3535 (yas--eval-lisp-no-saves content))
3537 ;; x) This is a snippet-snippet :-)
3539 ;; Narrow the region down to the content, shoosh the
3540 ;; `buffer-undo-list', and create the snippet, the new
3541 ;; snippet updates its mirrors once, so we are left with
3542 ;; some plain text. The undo action for deleting this
3543 ;; plain text will get recorded at the end.
3545 ;; stacked expansion: also shoosh the overlay modification hooks
3546 (let ((buffer-undo-list t))
3547 ;; snippet creation might evaluate users elisp, which
3548 ;; might generate errors, so we have to be ready to catch
3549 ;; them mostly to make the undo information
3551 (setq yas--start-column (current-column))
3552 (yas--inhibit-overlay-hooks
3555 (eval `(let* ,expand-env
3557 (yas--snippet-create start (point))))
3559 (yas--snippet-create start (point))))))
3561 ;; stacked-expansion: This checks for stacked expansion, save the
3562 ;; `yas--previous-active-field' and advance its boundary.
3564 (let ((existing-field (and yas--active-field-overlay
3565 (overlay-buffer yas--active-field-overlay)
3566 (overlay-get yas--active-field-overlay 'yas--field))))
3567 (when existing-field
3568 (setf (yas--snippet-previous-active-field snippet) existing-field)
3569 (yas--advance-end-maybe existing-field (overlay-end yas--active-field-overlay))))
3571 ;; Exit the snippet immediately if no fields
3573 (unless (yas--snippet-fields snippet)
3574 (yas-exit-snippet snippet))
3576 ;; Push two undo actions: the deletion of the inserted contents of
3577 ;; the new snippet (without the "key") followed by an apply of
3578 ;; `yas--take-care-of-redo' on the newly inserted snippet boundaries
3580 ;; A small exception, if `yas-also-auto-indent-first-line'
3581 ;; is t and `yas--indent' decides to indent the line to a
3582 ;; point before the actual expansion point, undo would be
3583 ;; messed up. We call the early point "newstart"". case,
3584 ;; and attempt to fix undo.
3586 (let ((newstart (overlay-start (yas--snippet-control-overlay snippet)))
3587 (end (overlay-end (yas--snippet-control-overlay snippet))))
3588 (when (< newstart start)
3589 (push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
3590 (push (cons newstart end) buffer-undo-list)
3591 (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
3593 ;; Now, schedule a move to the first field
3595 (let ((first-field (car (yas--snippet-fields snippet))))
3597 (sit-for 0) ;; fix issue 125
3598 (yas--move-to-field snippet first-field)))
3599 (yas--message 3 "snippet expanded.")
3602 (defun yas--take-care-of-redo (_beg _end snippet)
3603 "Commits SNIPPET, which in turn pushes an undo action for reviving it.
3605 Meant to exit in the `buffer-undo-list'."
3606 ;; slightly optimize: this action is only needed for snippets with
3607 ;; at least one field
3608 (when (yas--snippet-fields snippet)
3609 (yas--commit-snippet snippet)))
3611 (defun yas--snippet-revive (beg end snippet)
3612 "Revives SNIPPET and creates a control overlay from BEG to END.
3614 BEG and END are, we hope, the original snippets boundaries.
3615 All the markers/points exiting existing inside SNIPPET should point
3616 to their correct locations *at the time the snippet is revived*.
3618 After revival, push the `yas--take-care-of-redo' in the
3620 ;; Reconvert all the points to markers
3622 (yas--points-to-markers snippet)
3623 ;; When at least one editable field existed in the zombie snippet,
3624 ;; try to revive the whole thing...
3626 (let ((target-field (or (yas--snippet-active-field snippet)
3627 (car (yas--snippet-fields snippet)))))
3629 (setf (yas--snippet-control-overlay snippet) (yas--make-control-overlay snippet beg end))
3630 (overlay-put (yas--snippet-control-overlay snippet) 'yas--snippet snippet)
3632 (yas--move-to-field snippet target-field)
3634 (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
3635 buffer-undo-list))))
3637 (defun yas--snippet-create (begin end)
3638 "Create a snippet from a template inserted at BEGIN to END.
3640 Returns the newly created snippet."
3642 (narrow-to-region begin end)
3643 (let ((snippet (yas--make-snippet)))
3645 (yas--snippet-parse-create snippet)
3647 ;; Sort and link each field
3648 (yas--snippet-sort-fields snippet)
3650 ;; Create keymap overlay for snippet
3651 (setf (yas--snippet-control-overlay snippet)
3652 (yas--make-control-overlay snippet (point-min) (point-max)))
3655 (goto-char (point-max))
3660 ;;; Apropos adjacencies and "fom's":
3662 ;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
3663 ;; recently expanded snippet, we might actually have many fields,
3664 ;; mirrors (and the snippet exit) in the very same position in the
3665 ;; buffer. Therefore we need to single-link the
3666 ;; fields-or-mirrors-or-exit (which I have abbreviated to "fom")
3667 ;; according to their original positions in the buffer.
3669 ;; Then we have operation `yas--advance-end-maybe' and
3670 ;; `yas--advance-start-maybe', which conditionally push the starts and
3671 ;; ends of these foms down the chain.
3673 ;; This allows for like the printf with the magic ",":
3675 ;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
3676 ;; $2${1:$(if (string-match "%" text) "\);" "")}$0
3678 (defun yas--fom-start (fom)
3679 (cond ((yas--field-p fom)
3680 (yas--field-start fom))
3681 ((yas--mirror-p fom)
3682 (yas--mirror-start fom))
3684 (yas--exit-marker fom))))
3686 (defun yas--fom-end (fom)
3687 (cond ((yas--field-p fom)
3688 (yas--field-end fom))
3689 ((yas--mirror-p fom)
3690 (yas--mirror-end fom))
3692 (yas--exit-marker fom))))
3694 (defun yas--fom-next (fom)
3695 (cond ((yas--field-p fom)
3696 (yas--field-next fom))
3697 ((yas--mirror-p fom)
3698 (yas--mirror-next fom))
3700 (yas--exit-next fom))))
3702 (defun yas--fom-parent-field (fom)
3703 (cond ((yas--field-p fom)
3704 (yas--field-parent-field fom))
3705 ((yas--mirror-p fom)
3706 (yas--mirror-parent-field fom))
3710 (defun yas--calculate-adjacencies (snippet)
3711 "Calculate adjacencies for fields or mirrors of SNIPPET.
3713 This is according to their relative positions in the buffer, and
3714 has to be called before the $-constructs are deleted."
3715 (let* ((fom-set-next-fom
3716 (lambda (fom nextfom)
3717 (cond ((yas--field-p fom)
3718 (setf (yas--field-next fom) nextfom))
3719 ((yas--mirror-p fom)
3720 (setf (yas--mirror-next fom) nextfom))
3722 (setf (yas--exit-next fom) nextfom)))))
3725 (if (= (yas--fom-start fom2) (yas--fom-start fom1))
3726 (yas--mirror-p fom2)
3727 (>= (yas--fom-start fom2) (yas--fom-start fom1)))))
3728 (link-foms fom-set-next-fom))
3729 ;; make some yas--field, yas--mirror and yas--exit soup
3731 (when (yas--snippet-exit snippet)
3732 (push (yas--snippet-exit snippet) soup))
3733 (dolist (field (yas--snippet-fields snippet))
3735 (dolist (mirror (yas--field-mirrors field))
3736 (push mirror soup)))
3738 (sort soup compare-fom-begs))
3740 (reduce link-foms soup)))))
3742 (defun yas--calculate-mirrors-in-fields (snippet mirror)
3743 "Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
3745 Use the tightest containing field if more than one field contains
3746 the mirror. Intended to be called *before* the dollar-regions are
3748 (let ((min (point-min))
3750 (dolist (field (yas--snippet-fields snippet))
3751 (when (and (<= (yas--field-start field) (yas--mirror-start mirror))
3752 (<= (yas--mirror-end mirror) (yas--field-end field))
3753 (< min (yas--field-start field))
3754 (< (yas--field-end field) max))
3755 (setq min (yas--field-start field)
3756 max (yas--field-end field))
3757 (setf (yas--mirror-parent-field mirror) field)))))
3759 (defun yas--advance-end-maybe (fom newend)
3760 "Maybe advance FOM's end to NEWEND if it needs it.
3764 * call `yas--advance-start-maybe' on FOM's next fom.
3766 * in case FOM is field call `yas--advance-end-maybe' on its parent
3769 Also, if FOM is an exit-marker, always call
3770 `yas--advance-start-maybe' on its next fom. This is because
3771 exit-marker have identical start and end markers."
3772 (cond ((and fom (< (yas--fom-end fom) newend))
3773 (set-marker (yas--fom-end fom) newend)
3774 (yas--advance-start-maybe (yas--fom-next fom) newend)
3775 (yas--advance-end-of-parents-maybe (yas--fom-parent-field fom) newend))
3777 (yas--advance-start-maybe (yas--fom-next fom) newend))))
3779 (defun yas--advance-start-maybe (fom newstart)
3780 "Maybe advance FOM's start to NEWSTART if it needs it.
3782 If it does, also call `yas--advance-end-maybe' on FOM."
3783 (when (and fom (< (yas--fom-start fom) newstart))
3784 (set-marker (yas--fom-start fom) newstart)
3785 (yas--advance-end-maybe fom newstart)))
3787 (defun yas--advance-end-of-parents-maybe (field newend)
3788 "Like `yas--advance-end-maybe' but for parent fields.
3790 Only works for fields and doesn't care about the start of the
3791 next FOM. Works its way up recursively for parents of parents."
3793 (< (yas--field-end field) newend))
3794 (set-marker (yas--field-end field) newend)
3795 (yas--advance-end-of-parents-maybe (yas--field-parent-field field) newend)))
3797 (defvar yas--dollar-regions nil
3798 "When expanding the snippet the \"parse-create\" functions add
3799 cons cells to this var.")
3801 (defvar yas--backquote-markers-and-strings nil
3802 "List of (MARKER . STRING) marking where the values from
3803 backquoted Lisp expressions should be inserted at the end of
3806 (defun yas--snippet-parse-create (snippet)
3807 "Parse a recently inserted snippet template, creating all
3808 necessary fields, mirrors and exit points.
3810 Meant to be called in a narrowed buffer, does various passes"
3811 (let ((parse-start (point)))
3812 ;; Reset the yas--dollar-regions
3814 (setq yas--dollar-regions nil)
3815 ;; protect just the backquotes
3817 (yas--protect-escapes nil '(?`))
3818 ;; replace all backquoted expressions
3820 (goto-char parse-start)
3821 (yas--save-backquotes)
3822 ;; protect escaped characters
3824 (yas--protect-escapes)
3825 ;; parse fields with {}
3827 (goto-char parse-start)
3828 (yas--field-parse-create snippet)
3829 ;; parse simple mirrors and fields
3831 (goto-char parse-start)
3832 (yas--simple-mirror-parse-create snippet)
3833 ;; parse mirror transforms
3835 (goto-char parse-start)
3836 (yas--transform-mirror-parse-create snippet)
3837 ;; calculate adjacencies of fields and mirrors
3839 (yas--calculate-adjacencies snippet)
3840 ;; Delete $-constructs
3842 (save-restriction (widen) (yas--delete-regions yas--dollar-regions))
3843 ;; restore backquoted expression values
3845 (yas--restore-backquotes)
3848 (goto-char parse-start)
3849 (yas--restore-escapes)
3850 ;; update mirrors for the first time
3852 (yas--update-mirrors snippet)
3853 ;; indent the best we can
3855 (goto-char parse-start)
3856 (yas--indent snippet)))
3858 (defun yas--indent-according-to-mode (snippet-markers)
3859 "Indent current line according to mode, preserving SNIPPET-MARKERS."
3860 ;;; Apropos indenting problems....
3862 ;; `indent-according-to-mode' uses whatever `indent-line-function'
3863 ;; is available. Some implementations of these functions delete text
3864 ;; before they insert. If there happens to be a marker just after
3865 ;; the text being deleted, the insertion actually happens after the
3866 ;; marker, which misplaces it.
3868 ;; This would also happen if we had used overlays with the
3869 ;; `front-advance' property set to nil.
3871 ;; This is why I have these `trouble-markers', they are the ones at
3872 ;; they are the ones at the first non-whitespace char at the line
3873 ;; (i.e. at `yas--real-line-beginning'. After indentation takes place
3874 ;; we should be at the correct to restore them to. All other
3875 ;; non-trouble-markers have been *pushed* and don't need special
3878 (goto-char (yas--real-line-beginning))
3879 (let ((trouble-markers (remove-if-not #'(lambda (marker)
3885 (indent-according-to-mode)
3886 (error (yas--message 3 "Warning: `yas--indent-according-to-mode' having problems running %s" indent-line-function)
3888 (mapc #'(lambda (marker)
3889 (set-marker marker (point)))
3892 (defvar yas--indent-original-column nil)
3893 (defun yas--indent (snippet)
3894 (let ((snippet-markers (yas--collect-snippet-markers snippet)))
3895 ;; Look for those $>
3897 (while (re-search-forward "$>" nil t)
3898 (delete-region (match-beginning 0) (match-end 0))
3899 (when (not (eq yas-indent-line 'auto))
3900 (yas--indent-according-to-mode snippet-markers))))
3901 ;; Now do stuff for 'fixed and 'auto
3903 (cond ((eq yas-indent-line 'fixed)
3904 (while (and (zerop (forward-line))
3905 (zerop (current-column)))
3906 (indent-to-column yas--indent-original-column)))
3907 ((eq yas-indent-line 'auto)
3908 (let ((end (set-marker (make-marker) (point-max)))
3909 (indent-first-line-p yas-also-auto-indent-first-line))
3910 (while (and (zerop (if indent-first-line-p
3913 (setq indent-first-line-p nil))
3917 (yas--indent-according-to-mode snippet-markers))))
3921 (defun yas--collect-snippet-markers (snippet)
3922 "Make a list of all the markers used by SNIPPET."
3924 (dolist (field (yas--snippet-fields snippet))
3925 (push (yas--field-start field) markers)
3926 (push (yas--field-end field) markers)
3927 (dolist (mirror (yas--field-mirrors field))
3928 (push (yas--mirror-start mirror) markers)
3929 (push (yas--mirror-end mirror) markers)))
3930 (let ((snippet-exit (yas--snippet-exit snippet)))
3931 (when (and snippet-exit
3932 (marker-buffer (yas--exit-marker snippet-exit)))
3933 (push (yas--exit-marker snippet-exit) markers)))
3936 (defun yas--real-line-beginning ()
3937 (let ((c (char-after (line-beginning-position)))
3938 (n (line-beginning-position)))
3939 (while (or (eql c ?\ )
3942 (setq c (char-after n)))
3945 (defun yas--escape-string (escaped)
3946 (concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
3948 (defun yas--protect-escapes (&optional text escaped)
3949 "Protect all escaped characters with their numeric ASCII value.
3951 With optional string TEXT do it in string instead of buffer."
3952 (let ((changed-text text)
3953 (text-provided-p text))
3954 (mapc #'(lambda (escaped)
3956 (yas--replace-all (concat "\\" (char-to-string escaped))
3957 (yas--escape-string escaped)
3958 (when text-provided-p changed-text))))
3959 (or escaped yas--escaped-characters))
3962 (defun yas--restore-escapes (&optional text escaped)
3963 "Restore all escaped characters from their numeric ASCII value.
3965 With optional string TEXT do it in string instead of the buffer."
3966 (let ((changed-text text)
3967 (text-provided-p text))
3968 (mapc #'(lambda (escaped)
3970 (yas--replace-all (yas--escape-string escaped)
3971 (char-to-string escaped)
3972 (when text-provided-p changed-text))))
3973 (or escaped yas--escaped-characters))
3976 (defun yas--save-backquotes ()
3977 "Save all the \"`(lisp-expression)`\"-style expressions
3978 with their evaluated value into `yas--backquote-markers-and-strings'."
3979 (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
3980 (let ((current-string (match-string-no-properties 1)) transformed)
3981 (save-restriction (widen)
3982 (delete-region (match-beginning 0) (match-end 0)))
3983 (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
3984 (goto-char (match-beginning 0))
3986 (let ((marker (make-marker)))
3989 (insert "Y") ;; quite horrendous, I love it :)
3990 (set-marker marker (point))
3992 (push (cons marker transformed) yas--backquote-markers-and-strings))))))
3994 (defun yas--restore-backquotes ()
3995 "Replace markers in `yas--backquote-markers-and-strings' with their values."
3996 (while yas--backquote-markers-and-strings
3997 (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
3998 (marker (car marker-and-string))
3999 (string (cdr marker-and-string)))
4007 (set-marker marker nil)))))
4009 (defun yas--scan-sexps (from count)
4011 (with-syntax-table (standard-syntax-table)
4012 (scan-sexps from count))
4016 (defun yas--make-marker (pos)
4017 "Create a marker at POS with nil `marker-insertion-type'."
4018 (let ((marker (set-marker (make-marker) pos)))
4019 (set-marker-insertion-type marker nil)
4022 (defun yas--field-parse-create (snippet &optional parent-field)
4023 "Parse most field expressions in SNIPPET, except for the simple one \"$n\".
4025 The following count as a field:
4027 * \"${n: text}\", for a numbered field with default text, as long as N is not 0;
4029 * \"${n: text$(expression)}, the same with a Lisp expression;
4030 this is caught with the curiously named `yas--multi-dollar-lisp-expression-regexp'
4032 * the same as above but unnumbered, (no N:) and number is calculated automatically.
4034 When multiple expressions are found, only the last one counts."
4037 (while (re-search-forward yas--field-regexp nil t)
4038 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4039 (number (and (match-string-no-properties 1)
4040 (string-to-number (match-string-no-properties 1))))
4041 (brand-new-field (and real-match-end-0
4042 ;; break if on "$(" immediately
4043 ;; after the ":", this will be
4044 ;; caught as a mirror with
4046 (not (save-match-data
4047 (eq (string-match "$[ \t\n]*("
4048 (match-string-no-properties 2)) 0)))
4049 ;; allow ${0: some exit text}
4050 ;; (not (and number (zerop number)))
4051 (yas--make-field number
4052 (yas--make-marker (match-beginning 2))
4053 (yas--make-marker (1- real-match-end-0))
4055 (when brand-new-field
4056 (goto-char real-match-end-0)
4057 (push (cons (1- real-match-end-0) real-match-end-0)
4058 yas--dollar-regions)
4059 (push (cons (match-beginning 0) (match-beginning 2))
4060 yas--dollar-regions)
4061 (push brand-new-field (yas--snippet-fields snippet))
4064 (narrow-to-region (yas--field-start brand-new-field) (yas--field-end brand-new-field))
4065 (goto-char (point-min))
4066 (yas--field-parse-create snippet brand-new-field)))))))
4067 ;; if we entered from a parent field, now search for the
4068 ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
4069 ;; primary field transformations
4073 (while (re-search-forward yas--multi-dollar-lisp-expression-regexp nil t)
4074 (let* ((real-match-end-1 (yas--scan-sexps (match-beginning 1) 1)))
4075 ;; commit the primary field transformation if:
4077 ;; 1. we don't find it in yas--dollar-regions (a subnested
4078 ;; field) might have already caught it.
4080 ;; 2. we really make sure we have either two '$' or some
4081 ;; text and a '$' after the colon ':'. This is a FIXME: work
4082 ;; my regular expressions and end these ugly hacks.
4084 (when (and real-match-end-1
4085 (not (member (cons (match-beginning 0)
4087 yas--dollar-regions))
4089 (char-before (1- (match-beginning 1))))))
4090 (let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
4092 (setf (yas--field-transform parent-field)
4093 (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
4094 (push (cons (match-beginning 0) real-match-end-1)
4095 yas--dollar-regions)))))))
4097 (defun yas--transform-mirror-parse-create (snippet)
4098 "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
4099 (while (re-search-forward yas--transform-mirror-regexp nil t)
4100 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4101 (number (string-to-number (match-string-no-properties 1)))
4103 (not (zerop number))
4104 (yas--snippet-find-field snippet number)))
4106 (and real-match-end-0
4108 (yas--make-mirror (yas--make-marker (match-beginning 0))
4109 (yas--make-marker (match-beginning 0))
4111 (yas--restore-escapes
4112 (buffer-substring-no-properties (match-beginning 2)
4113 (1- real-match-end-0))))))))
4114 (when brand-new-mirror
4115 (push brand-new-mirror
4116 (yas--field-mirrors field))
4117 (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
4118 (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
4120 (defun yas--simple-mirror-parse-create (snippet)
4121 "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
4122 (while (re-search-forward yas--simple-mirror-regexp nil t)
4123 (let ((number (string-to-number (match-string-no-properties 1))))
4124 (cond ((zerop number)
4126 (setf (yas--snippet-exit snippet)
4127 (yas--make-exit (yas--make-marker (match-end 0))))
4129 (goto-char (match-beginning 0))
4130 (when yas-wrap-around-region
4131 (cond (yas-selected-text
4132 (insert yas-selected-text))
4133 ((and (eq yas-wrap-around-region 'cua)
4136 (insert (prog1 (get-register ?0)
4137 (set-register ?0 nil))))))
4138 (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
4139 yas--dollar-regions)))
4141 (let ((field (yas--snippet-find-field snippet number)))
4143 (let ((brand-new-mirror (yas--make-mirror
4144 (yas--make-marker (match-beginning 0))
4145 (yas--make-marker (match-beginning 0))
4147 (push brand-new-mirror
4148 (yas--field-mirrors field))
4149 (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
4150 (push (yas--make-field number
4151 (yas--make-marker (match-beginning 0))
4152 (yas--make-marker (match-beginning 0))
4154 (yas--snippet-fields snippet))))
4155 (push (cons (match-beginning 0) (match-end 0))
4156 yas--dollar-regions))))))
4158 (defun yas--delete-regions (regions)
4159 "Sort disjuct REGIONS by start point, then delete from the back."
4160 (mapc #'(lambda (reg)
4161 (delete-region (car reg) (cdr reg)))
4164 (>= (car r1) (car r2))))))
4166 (defun yas--calculate-mirror-depth (mirror &optional traversed)
4167 (let* ((parent (yas--mirror-parent-field mirror))
4168 (parents-mirrors (and parent
4169 (yas--field-mirrors parent))))
4170 (or (yas--mirror-depth mirror)
4171 (setf (yas--mirror-depth mirror)
4172 (cond ((memq mirror traversed)
4174 ((and parent parents-mirrors)
4176 (mapcar #'(lambda (m)
4177 (yas--calculate-mirror-depth m
4186 (defun yas--update-mirrors (snippet)
4187 "Update all the mirrors of SNIPPET."
4189 (dolist (field-and-mirror (sort
4190 ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
4191 ;; where F is the field that M is mirroring
4193 (mapcan #'(lambda (field)
4194 (mapcar #'(lambda (mirror)
4195 (cons field mirror))
4196 (yas--field-mirrors field)))
4197 (yas--snippet-fields snippet))
4198 ;; then sort this list so that entries with mirrors with parent
4199 ;; fields appear before. This was important for fixing #290, and
4200 ;; luckily also handles the case where a mirror in a field causes
4201 ;; another mirror to need reupdating
4203 #'(lambda (field-and-mirror1 field-and-mirror2)
4204 (> (yas--calculate-mirror-depth (cdr field-and-mirror1))
4205 (yas--calculate-mirror-depth (cdr field-and-mirror2))))))
4206 (let* ((field (car field-and-mirror))
4207 (mirror (cdr field-and-mirror))
4208 (parent-field (yas--mirror-parent-field mirror)))
4209 ;; before updating a mirror with a parent-field, maybe advance
4213 (yas--advance-start-maybe mirror (yas--fom-start parent-field)))
4214 ;; update this mirror
4216 (yas--mirror-update-display mirror field)
4217 ;; `yas--place-overlays' is needed if the active field and
4218 ;; protected overlays have been changed because of insertions
4219 ;; in `yas--mirror-update-display'
4221 (when (eq field (yas--snippet-active-field snippet))
4222 (yas--place-overlays snippet field))))))
4224 (defun yas--mirror-update-display (mirror field)
4225 "Update MIRROR according to FIELD (and mirror transform)."
4227 (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
4228 (reflection (and (not (and mirror-parent-field
4229 (yas--field-modified-p mirror-parent-field)))
4230 (or (yas--apply-transform mirror field 'empty-on-nil)
4231 (yas--field-text-for-display field)))))
4232 (when (and reflection
4233 (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
4234 (yas--mirror-end mirror)))))
4235 (goto-char (yas--mirror-start mirror))
4236 (yas--inhibit-overlay-hooks
4237 (insert reflection))
4238 (if (> (yas--mirror-end mirror) (point))
4239 (delete-region (point) (yas--mirror-end mirror))
4240 (set-marker (yas--mirror-end mirror) (point))
4241 (yas--advance-start-maybe (yas--mirror-next mirror) (point))
4242 ;; super-special advance
4243 (yas--advance-end-of-parents-maybe mirror-parent-field (point))))))
4245 (defun yas--field-update-display (field)
4246 "Much like `yas--mirror-update-display', but for fields."
4247 (when (yas--field-transform field)
4248 (let ((transformed (and (not (eq (yas--field-number field) 0))
4249 (yas--apply-transform field field))))
4250 (when (and transformed
4251 (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
4252 (yas--field-end field)))))
4253 (setf (yas--field-modified-p field) t)
4254 (goto-char (yas--field-start field))
4255 (yas--inhibit-overlay-hooks
4256 (insert transformed)
4257 (if (> (yas--field-end field) (point))
4258 (delete-region (point) (yas--field-end field))
4259 (set-marker (yas--field-end field) (point))
4260 (yas--advance-start-maybe (yas--field-next field) (point)))
4264 ;;; Post-command hook:
4266 (defun yas--post-command-handler ()
4267 "Handles various yasnippet conditions after each command."
4268 (cond ((eq 'undo this-command)
4270 ;; After undo revival the correct field is sometimes not
4271 ;; restored correctly, this condition handles that
4273 (let* ((snippet (car (yas--snippets-at-point)))
4274 (target-field (and snippet
4275 (find-if-not #'(lambda (field)
4276 (yas--field-probably-deleted-p snippet field))
4278 (cons (yas--snippet-active-field snippet)
4279 (yas--snippet-fields snippet)))))))
4281 (yas--move-to-field snippet target-field))))
4282 ((not (yas--undo-in-progress))
4283 ;; When not in an undo, check if we must commit the snippet
4284 ;; (user exited it).
4285 (yas--check-commit-snippet))))
4289 ;; The docstrings for some functions are generated dynamically
4290 ;; depending on the context.
4292 (put 'yas-expand 'function-documentation
4293 '(yas--expand-from-trigger-key-doc t))
4294 (defun yas--expand-from-trigger-key-doc (context)
4295 "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
4296 (let* ((yas-fallback-behavior (and context yas-fallback-behavior))
4297 (fallback-description
4298 (cond ((eq yas-fallback-behavior 'call-other-command)
4299 (let* ((fallback (yas--keybinding-beyond-yasnippet)))
4301 (format "call command `%s'."
4302 (pp-to-string fallback)))
4303 "do nothing (`yas-expand' doesn't shadow\nanything).")))
4304 ((eq yas-fallback-behavior 'return-nil)
4306 (t "defer to `yas-fallback-behavior' (which see)."))))
4307 (concat "Expand a snippet before point. If no snippet
4308 expansion is possible, "
4309 fallback-description
4310 "\n\nOptional argument FIELD is for non-interactive use and is an
4311 object satisfying `yas--field-p' to restrict the expansion to.")))
4313 (put 'yas-expand-from-keymap 'function-documentation
4314 '(yas--expand-from-keymap-doc t))
4315 (defun yas--expand-from-keymap-doc (context)
4316 "A doc synthesizer for `yas--expand-from-keymap-doc'."
4317 (add-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce)
4318 (concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
4319 (when (and context (eq this-command 'describe-key))
4320 (let* ((vec (this-single-command-keys))
4321 (templates (mapcan #'(lambda (table)
4322 (yas--fetch table vec))
4323 (yas--get-snippet-tables)))
4324 (yas--direct-keymaps nil)
4325 (fallback (key-binding vec)))
4326 (concat "In this case, "
4328 (concat "these snippets are bound to this key:\n"
4329 (yas--template-pretty-list templates)
4330 "\n\nIf none of these expands, "))
4332 (format "fallback `%s' will be called." (pp-to-string fallback)))
4333 "no fallback keybinding is called."))))))
4335 (defun yas--template-pretty-list (templates)
4337 (yas-buffer-local-condition 'always))
4338 (dolist (plate templates)
4339 (setq acc (concat acc "\n*) "
4340 (propertize (concat "\\\\snippet `" (car plate) "'")
4341 'yasnippet (cdr plate)))))
4344 (define-button-type 'help-snippet-def
4345 :supertype 'help-xref
4346 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
4347 'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
4349 (defun yas--snippet-description-finish-runonce ()
4350 "Final adjustments for the help buffer when snippets are concerned."
4351 (yas--create-snippet-xrefs)
4352 (remove-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce))
4354 (defun yas--create-snippet-xrefs ()
4356 (goto-char (point-min))
4357 (while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
4358 (let ((template (get-text-property (match-beginning 1)
4361 (help-xref-button 1 'help-snippet-def template)
4362 (kill-region (match-end 1) (match-end 0))
4363 (kill-region (match-beginning 0) (match-beginning 1)))))))
4367 (defvar yas-verbosity 4
4368 "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
4370 (defun yas--message (level message &rest args)
4371 "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
4372 (when (> yas-verbosity level)
4373 (message "%s" (apply #'yas--format message args))))
4375 (defun yas--warning (format-control &rest format-args)
4376 (let ((msg (apply #'format format-control format-args)))
4377 (display-warning 'yasnippet msg :warning)
4378 (yas--message 1 msg)))
4380 (defun yas--format (format-control &rest format-args)
4381 (apply #'format (concat "[yas] " format-control) format-args))
4388 ;; `locate-dominating-file'
4389 ;; `region-active-p'
4391 ;; added for compatibility in emacsen < 23
4392 (unless (>= emacs-major-version 23)
4393 (unless (fboundp 'region-active-p)
4394 (defun region-active-p () (and transient-mark-mode mark-active)))
4396 (unless (fboundp 'locate-dominating-file)
4397 (defvar locate-dominating-stop-dir-regexp
4398 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
4399 "Regexp of directory names which stop the search in `locate-dominating-file'.
4400 Any directory whose name matches this regexp will be treated like
4401 a kind of root directory by `locate-dominating-file' which will stop its search
4402 when it bumps into it.
4403 The default regexp prevents fruitless and time-consuming attempts to find
4404 special files in directories in which filenames are interpreted as hostnames,
4405 or mount points potentially requiring authentication as a different user.")
4407 (defun locate-dominating-file (file name)
4408 "Look up the directory hierarchy from FILE for a file named NAME.
4409 Stop at the first parent directory containing a file NAME,
4410 and return the directory. Return nil if not found."
4411 ;; We used to use the above locate-dominating-files code, but the
4412 ;; directory-files call is very costly, so we're much better off doing
4413 ;; multiple calls using the code in here.
4415 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
4416 ;; `name' in /home or in /.
4417 (setq file (abbreviate-file-name file))
4420 (while (not (or root
4422 ;; FIXME: Disabled this heuristic because it is sometimes
4424 ;; As a heuristic, we stop looking up the hierarchy of
4425 ;; directories as soon as we find a directory belonging
4426 ;; to another user. This should save us from looking in
4427 ;; things like /net and /afs. This assumes that all the
4428 ;; files inside a project belong to the same user.
4429 ;; (let ((prev-user user))
4430 ;; (setq user (nth 2 (file-attributes file)))
4431 ;; (and prev-user (not (equal user prev-user))))
4432 (string-match locate-dominating-stop-dir-regexp file)))
4433 (setq try (file-exists-p (expand-file-name name file)))
4434 (cond (try (setq root file))
4435 ((equal file (setq file (file-name-directory
4436 (directory-file-name file))))
4441 ;;; Backward compatibility to yasnippet <= 0.7
4443 (defun yas-initialize ()
4444 "For backward compatibility, enable `yas-minor-mode' globally."
4445 (yas-global-mode 1))
4447 (defvar yas--backported-syms '(;; `defcustom's
4450 yas-prompt-functions
4452 yas-also-auto-indent-first-line
4454 yas-triggers-in-field
4455 yas-fallback-behavior
4456 yas-choose-keys-first
4457 yas-choose-tables-first
4460 yas-wrap-around-region
4463 yas-expand-only-for-last-commands
4464 yas-field-highlight-face
4466 ;; these vars can be customized as well
4472 yas-after-exit-snippet-hook
4473 yas-before-expand-snippet-hook
4474 yas-buffer-local-condition
4477 ;; prompting functions
4482 yas-completing-prompt
4485 ;; interactive functions
4490 yas-direct-keymaps-reload
4494 yas-compile-directory
4497 yas-expand-from-trigger-key
4498 yas-expand-from-keymap
4500 yas-visit-snippet-file
4502 yas-load-snippet-buffer
4505 yas-next-field-or-maybe-expand
4510 yas-exit-all-snippets
4511 yas-skip-and-clear-or-delete-char
4514 ;; symbols that I "exported" for use
4515 ;; in snippets and hookage
4532 yas-default-from-field
4535 yas-define-condition-cache
4536 yas-hippie-try-expand
4538 ;; debug definitions
4539 ;; yas-debug-snippet-vars
4540 ;; yas-exterminate-package
4543 ;; testing definitions
4544 ;; yas-should-expand
4545 ;; yas-should-not-expand
4547 ;; yas-make-file-or-dirs
4549 ;; yas-saving-variables
4550 ;; yas-call-with-snippet-dirs
4551 ;; yas-with-snippet-dirs
4553 "Backported yasnippet symbols.
4555 They are mapped to \"yas/*\" variants.")
4557 (dolist (sym yas--backported-syms)
4558 (let ((backported (intern (replace-regexp-in-string "^yas-" "yas/" (symbol-name sym)))))
4560 (make-obsolete-variable backported sym "yasnippet 0.8")
4561 (defvaralias backported sym))
4563 (make-obsolete backported sym "yasnippet 0.8")
4564 (defalias backported sym))))
4566 (defvar yas--exported-syms
4568 (mapatoms (lambda (atom)
4569 (if (and (or (and (boundp atom)
4570 (not (get atom 'byte-obsolete-variable)))
4572 (not (get atom 'byte-obsolete-info))))
4573 (string-match-p "^yas-[^-]" (symbol-name atom)))
4574 (push atom exported))))
4576 "Exported yasnippet symbols.
4578 i.e. the ones with \"yas-\" single dash prefix. I will try to
4579 keep them in future yasnippet versions and other elisp libraries
4580 can more or less safely rely upon them.")
4583 (provide 'yasnippet)
4586 ;; indent-tabs-mode: nil
4587 ;; byte-compile-warnings: (not cl-functions)
4589 ;;; yasnippet.el ends here