1 ;;; yasnippet.el --- Yet another snippet extension for Emacs.
3 ;; Copyright (C) 2008-2013 Free Software Foundation, Inc.
4 ;; Authors: pluskid <pluskid@gmail.com>, João Távora <joaotavora@gmail.com>
5 ;; Maintainer: João Távora <joaotavora@gmail.com>
7 ;; Package-version: 0.8.0
8 ;; X-URL: http://github.com/capitaomorte/yasnippet
9 ;; Keywords: convenience, emulation
10 ;; URL: http://github.com/capitaomorte/yasnippet
11 ;; EmacsWiki: YaSnippetMode
13 ;; This program is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; This program is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
28 ;; Basic steps to setup:
30 ;; (add-to-list 'load-path
31 ;; "~/path-to-yasnippet")
32 ;; (require 'yasnippet)
33 ;; (yas-global-mode 1)
36 ;; Interesting variables are:
40 ;; The directory where user-created snippets are to be
41 ;; stored. Can also be a list of directories. In that case,
42 ;; when used for bulk (re)loading of snippets (at startup or
43 ;; via `yas-reload-all'), directories appearing earlier in
44 ;; the list shadow other dir's snippets. Also, the first
45 ;; directory is taken as the default for storing the user's
48 ;; The deprecated `yas/root-directory' aliases this variable
49 ;; for backward-compatibility.
52 ;; Major commands are:
56 ;; Try to expand snippets before point. In `yas-minor-mode',
57 ;; this is normally bound to TAB, but you can customize it in
58 ;; `yas-minor-mode-map'.
60 ;; M-x yas-load-directory
62 ;; Prompts you for a directory hierarchy of snippets to load.
64 ;; M-x yas-activate-extra-mode
66 ;; Prompts you for an extra mode to add snippets for in the
69 ;; M-x yas-insert-snippet
71 ;; Prompts you for possible snippet expansion if that is
72 ;; possible according to buffer-local and snippet-local
73 ;; expansion conditions. With prefix argument, ignore these
76 ;; M-x yas-visit-snippet-file
78 ;; Prompts you for possible snippet expansions like
79 ;; `yas-insert-snippet', but instead of expanding it, takes
80 ;; you directly to the snippet definition's file, if it
83 ;; M-x yas-new-snippet
85 ;; Lets you create a new snippet file in the correct
86 ;; subdirectory of `yas-snippet-dirs', according to the
89 ;; M-x yas-load-snippet-buffer
91 ;; When editing a snippet, this loads the snippet. This is
92 ;; bound to "C-c C-c" while in the `snippet-mode' editing
95 ;; M-x yas-tryout-snippet
97 ;; When editing a snippet, this opens a new empty buffer,
98 ;; sets it to the appropriate major mode and inserts the
99 ;; snippet there, so you can see what it looks like. This is
100 ;; bound to "C-c C-t" while in `snippet-mode'.
102 ;; M-x yas-describe-tables
104 ;; Lists known snippets in a separate buffer. User is
105 ;; prompted as to whether only the currently active tables
106 ;; are to be displayed, or all the tables for all major
109 ;; If you have `dropdown-list' installed, you can optionally use it
110 ;; as the preferred "prompting method", putting in your .emacs file,
113 ;; (require 'dropdown-list)
114 ;; (setq yas-prompt-functions '(yas-dropdown-prompt
116 ;; yas-completing-prompt))
118 ;; Also check out the customization group
120 ;; M-x customize-group RET yasnippet RET
122 ;; If you use the customization group to set variables
123 ;; `yas-snippet-dirs' or `yas-global-mode', make sure the path to
124 ;; "yasnippet.el" is present in the `load-path' *before* the
125 ;; `custom-set-variables' is executed in your .emacs file.
127 ;; For more information and detailed usage, refer to the project page:
128 ;; http://github.com/capitaomorte/yasnippet
137 (defvar yas--editing-template)
138 (defvar yas--guessed-modes)
139 (defvar yas--indent-original-column)
140 (defvar yas--scheduled-jit-loads)
142 (defvar yas-selected-text)
143 (defvar yas-verbosity)
144 (defvar yas--current-template)
147 ;;; User customizable variables
149 (defgroup yasnippet nil
150 "Yet Another Snippet extension"
153 (defvar yas-installed-snippets-dir nil)
154 (setq yas-installed-snippets-dir
156 (concat (file-name-directory load-file-name) "snippets")))
158 (defcustom yas-snippet-dirs (remove nil
159 (list "~/.emacs.d/snippets"
160 'yas-installed-snippets-dir))
161 "List of top-level snippet directories.
163 Each element, a string or a symbol whose value is a string,
164 designates a top-level directory where per-mode snippet
165 directories can be found.
167 Elements appearing earlier in the list shadow later elements'
170 The first directory is taken as the default for storing snippet's
171 created with `yas-new-snippet'. "
172 :type '(choice (string :tag "Single directory (string)")
173 (repeat :args (string) :tag "List of directories (strings)"))
176 :set #'(lambda (symbol new)
177 (let ((old (and (boundp symbol)
178 (symbol-value symbol))))
179 (set-default symbol new)
180 (unless (or (not (fboundp 'yas-reload-all))
184 (defun yas-snippet-dirs ()
185 "Return variable `yas-snippet-dirs' as list of strings."
186 (cl-loop for e in (if (listp yas-snippet-dirs)
188 (list yas-snippet-dirs))
190 (cond ((stringp e) e)
193 (stringp (symbol-value e)))
196 (error "[yas] invalid element %s in `yas-snippet-dirs'" e)))))
198 (defvaralias 'yas/root-directory 'yas-snippet-dirs)
200 (defcustom yas-new-snippet-default "\
201 # -*- mode: snippet; require-final-newline: nil -*-
203 # key: ${2:${1:$(yas--key-from-desc yas-text)}}${3:
204 # binding: ${4:direct-keybinding}}
207 "Default snippet to use when creating a new snippet.
208 If nil, don't use any snippet."
212 (defcustom yas-prompt-functions '(yas-x-prompt
214 yas-completing-prompt
217 "Functions to prompt for keys, templates, etc interactively.
219 These functions are called with the following arguments:
221 - PROMPT: A string to prompt the user
223 - CHOICES: a list of strings or objects.
225 - optional DISPLAY-FN : A function that, when applied to each of
226 the objects in CHOICES will return a string.
228 The return value of any function you put here should be one of
229 the objects in CHOICES, properly formatted with DISPLAY-FN (if
232 - To signal that your particular style of prompting is
233 unavailable at the moment, you can also have the function return
236 - To signal that the user quit the prompting process, you can
239 (signal 'quit \"user quit!\")."
240 :type '(repeat function)
243 (defcustom yas-indent-line 'auto
244 "Controls indenting applied to a recent snippet expansion.
246 The following values are possible:
248 - `fixed' Indent the snippet to the current column;
250 - `auto' Indent each line of the snippet with `indent-according-to-mode'
252 Every other value means don't apply any snippet-side indentation
253 after expansion (the manual per-line \"$>\" indentation still
255 :type '(choice (const :tag "Nothing" nothing)
256 (const :tag "Fixed" fixed)
257 (const :tag "Auto" auto))
260 (defcustom yas-also-auto-indent-first-line nil
261 "Non-nil means also auto indent first line according to mode.
263 Naturally this is only valid when `yas-indent-line' is `auto'"
267 (defcustom yas-snippet-revival t
268 "Non-nil means re-activate snippet fields after undo/redo."
272 (defcustom yas-triggers-in-field nil
273 "If non-nil, allow stacked expansions (snippets inside snippets).
275 Otherwise `yas-next-field-or-maybe-expand' just moves on to the
280 (defcustom yas-fallback-behavior 'call-other-command
281 "How to act when `yas-expand' does *not* expand a snippet.
283 - `call-other-command' means try to temporarily disable YASnippet
284 and call the next command bound to whatever key was used to
287 - nil or the symbol `return-nil' mean do nothing. (and
288 `yas-expand' returns nil)
290 - A Lisp form (apply COMMAND . ARGS) means interactively call
291 COMMAND, if ARGS is non-nil, call COMMAND non-interactively
292 with ARGS as arguments."
293 :type '(choice (const :tag "Call previous command" call-other-command)
294 (const :tag "Do nothing" return-nil))
297 (defcustom yas-choose-keys-first nil
298 "If non-nil, prompt for snippet key first, then for template.
300 Otherwise prompts for all possible snippet names.
302 This affects `yas-insert-snippet' and `yas-visit-snippet-file'."
306 (defcustom yas-choose-tables-first nil
307 "If non-nil, and multiple eligible snippet tables, prompts user for tables first.
309 Otherwise, user chooses between the merging together of all
312 This affects `yas-insert-snippet', `yas-visit-snippet-file'"
316 (defcustom yas-use-menu 'abbreviate
317 "Display a YASnippet menu in the menu bar.
319 When non-nil, submenus for each snippet table will be listed
320 under the menu \"Yasnippet\".
322 - If set to `abbreviate', only the current major-mode
323 menu and the modes set in `yas--extra-modes' are listed.
325 - If set to `full', every submenu is listed
327 - If set to `nil', hide the menu.
329 Any other non-nil value, every submenu is listed."
330 :type '(choice (const :tag "Full" full)
331 (const :tag "Abbreviate" abbreviate)
332 (const :tag "No menu" nil))
335 (defcustom yas-trigger-symbol (or (and (eq window-system 'mac)
337 (char-to-string ?\x21E5))) ;; little ->| sign
339 "The text that will be used in menu to represent the trigger."
343 (defcustom yas-wrap-around-region nil
344 "If non-nil, snippet expansion wraps around selected region.
346 The wrapping occurs just before the snippet's exit marker. This
347 can be overridden on a per-snippet basis."
351 (defcustom yas-good-grace t
352 "If non-nil, don't raise errors in inline elisp evaluation.
354 An error string \"[yas] error\" is returned instead."
358 (defcustom yas-visit-from-menu nil
359 "If non-nil visit snippets's files from menu, instead of expanding them.
361 This can only work when snippets are loaded from files."
365 (defcustom yas-expand-only-for-last-commands nil
366 "List of `last-command' values to restrict tab-triggering to, or nil.
368 Leave this set at nil (the default) to be able to trigger an
369 expansion simply by placing the cursor after a valid tab trigger,
370 using whichever commands.
372 Optionally, set this to something like '(self-insert-command) if
373 you to wish restrict expansion to only happen when the last
374 letter of the snippet tab trigger was typed immediately before
375 the trigger key itself."
376 :type '(repeat function)
379 ;; Only two faces, and one of them shouldn't even be used...
381 (defface yas-field-highlight-face
382 '((t (:inherit 'region)))
383 "The face used to highlight the currently active field of a snippet"
386 (defface yas--field-debug-face
388 "The face used for debugging some overlays normally hidden"
392 ;;; User-visible variables
394 (defvar yas-keymap (let ((map (make-sparse-keymap)))
395 (define-key map [(tab)] 'yas-next-field-or-maybe-expand)
396 (define-key map (kbd "TAB") 'yas-next-field-or-maybe-expand)
397 (define-key map [(shift tab)] 'yas-prev-field)
398 (define-key map [backtab] 'yas-prev-field)
399 (define-key map (kbd "C-g") 'yas-abort-snippet)
400 (define-key map (kbd "C-d") 'yas-skip-and-clear-or-delete-char)
402 "The active keymap while a snippet expansion is in progress.")
404 (defvar yas-key-syntaxes (list "w" "w_" "w_." "w_.()"
405 #'yas-try-key-from-whitespace)
406 "Syntaxes and functions to help look for trigger keys before point.
408 Each element in this list specifies how to skip buffer positions
409 backwards and look for the start of a trigger key.
411 Each element can be either a string or a function receiving the
412 original point as an argument. A string element is simply passed
413 to `skip-syntax-backward' whereas a function element is called
414 with no arguments and should also place point before the original
417 The string between the resulting buffer position and the original
418 point is matched against the trigger keys in the active snippet
421 If no expandable snippets are found, the next element is the list
422 is tried, unless a function element returned the symbol `again',
423 in which case it is called again from the previous position and
424 may once more reposition point.
426 For example, if `yas-key-syntaxes'' value is '(\"w\" \"w_\"),
427 trigger keys composed exclusively of \"word\"-syntax characters
428 are looked for first. Failing that, longer keys composed of
429 \"word\" or \"symbol\" syntax are looked for. Therefore,
434 will, according to the \"w\" element first try \"barbaz\". If
435 that isn't a trigger key, \"foo-barbaz\" is tried, respecting the
436 second \"w_\" element. Notice that even if \"baz\" is a trigger
437 key for an active snippet, it won't be expanded, unless a
438 function is added to `yas-key-syntaxes' that eventually places
439 point between \"bar\" and \"baz\".
441 See also Info node `(elisp) Syntax Descriptors'.")
443 (defvar yas-after-exit-snippet-hook
445 "Hooks to run after a snippet exited.
447 The hooks will be run in an environment where some variables bound to
450 `yas-snippet-beg' : The beginning of the region of the snippet.
452 `yas-snippet-end' : Similar to beg.
454 Attention: These hooks are not run when exiting nested/stacked snippet expansion!")
456 (defvar yas-before-expand-snippet-hook
458 "Hooks to run just before expanding a snippet.")
460 (defvar yas-buffer-local-condition
461 '(if (and (or (fourth (syntax-ppss))
462 (fifth (syntax-ppss)))
464 (eq this-command 'yas-expand-from-trigger-key))
465 '(require-snippet-condition . force-in-comment)
467 "Snippet expanding condition.
469 This variable is a Lisp form which is evaluated every time a
470 snippet expansion is attempted:
472 * If it evaluates to nil, no snippets can be expanded.
474 * If it evaluates to the a cons (require-snippet-condition
477 * Snippets bearing no \"# condition:\" directive are not
480 * Snippets bearing conditions that evaluate to nil (or
481 produce an error) won't be considered.
483 * If the snippet has a condition that evaluates to non-nil
486 * If REQUIREMENT is t, the snippet is considered
488 * If REQUIREMENT is `eq' RESULT, the snippet is
491 * Otherwise, the snippet is not considered.
493 * If it evaluates to the symbol 'always, all snippets are
494 considered for expansion, regardless of any conditions.
496 * If it evaluates to t or some other non-nil value
498 * Snippet bearing no conditions, or conditions that
499 evaluate to non-nil, are considered for expansion.
501 * Otherwise, the snippet is not considered.
503 Here's an example preventing snippets from being expanded from
504 inside comments, in `python-mode' only, with the exception of
505 snippets returning the symbol 'force-in-comment in their
508 (add-hook 'python-mode-hook
510 (setq yas-buffer-local-condition
511 '(if (python-in-string/comment)
512 '(require-snippet-condition . force-in-comment)
515 The default value is similar, it filters out potential snippet
516 expansions inside comments and string literals, unless the
517 snippet itself contains a condition that returns the symbol
518 `force-in-comment'.")
521 ;;; Internal variables
523 (defvar yas--version "0.8.0beta")
525 (defvar yas--menu-table (make-hash-table)
526 "A hash table of MAJOR-MODE symbols to menu keymaps.")
528 (defvar yas--known-modes
529 '(ruby-mode rst-mode markdown-mode)
530 "A list of mode which is well known but not part of Emacs.")
532 (defvar yas--escaped-characters
533 '(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
534 "List of characters which *might* need to be escaped.")
536 (defconst yas--field-regexp
537 "${\\([0-9]+:\\)?\\([^}]*\\)}"
538 "A regexp to *almost* recognize a field.")
540 (defconst yas--multi-dollar-lisp-expression-regexp
541 "$+[ \t\n]*\\(([^)]*)\\)"
542 "A regexp to *almost* recognize a \"$(...)\" expression.")
544 (defconst yas--backquote-lisp-expression-regexp
546 "A regexp to recognize a \"`lisp-expression`\" expression." )
548 (defconst yas--transform-mirror-regexp
549 "${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
550 "A regexp to *almost* recognize a mirror with a transform.")
552 (defconst yas--simple-mirror-regexp
554 "A regexp to recognize a simple mirror.")
556 (defvar yas--snippet-id-seed 0
557 "Contains the next id for a snippet.")
559 (defun yas--snippet-next-id ()
560 (let ((id yas--snippet-id-seed))
561 (incf yas--snippet-id-seed)
567 ;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
568 (defvar last-buffer-undo-list nil)
570 (defvar yas--minor-mode-menu nil
571 "Holds the YASnippet menu.")
573 (defvar yas-minor-mode-map
574 (let ((map (make-sparse-keymap)))
575 (define-key map [(tab)] 'yas-expand)
576 (define-key map (kbd "TAB") 'yas-expand)
577 (define-key map "\C-c&\C-s" 'yas-insert-snippet)
578 (define-key map "\C-c&\C-n" 'yas-new-snippet)
579 (define-key map "\C-c&\C-v" 'yas-visit-snippet-file)
581 "The keymap used when `yas-minor-mode' is active.")
583 (easy-menu-define yas--minor-mode-menu
585 "Menu used when `yas-minor-mode' is active."
586 '("YASnippet" :visible yas-use-menu
588 ["Expand trigger" yas-expand
589 :help "Possibly expand tab trigger before point"]
590 ["Insert at point..." yas-insert-snippet
591 :help "Prompt for an expandable snippet and expand it at point"]
592 ["New snippet..." yas-new-snippet
593 :help "Create a new snippet in an appropriate directory"]
594 ["Visit snippet file..." yas-visit-snippet-file
595 :help "Prompt for an expandable snippet and find its file"]
597 ("Snippet menu behaviour"
598 ["Visit snippets" (setq yas-visit-from-menu t)
599 :help "Visit snippets from the menu"
600 :active t :style radio :selected yas-visit-from-menu]
601 ["Expand snippets" (setq yas-visit-from-menu nil)
602 :help "Expand snippets from the menu"
603 :active t :style radio :selected (not yas-visit-from-menu)]
605 ["Show all known modes" (setq yas-use-menu 'full)
606 :help "Show one snippet submenu for each loaded table"
607 :active t :style radio :selected (eq yas-use-menu 'full)]
608 ["Abbreviate according to current mode" (setq yas-use-menu 'abbreviate)
609 :help "Show only snippet submenus for the current active modes"
610 :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
612 ["Auto" (setq yas-indent-line 'auto)
613 :help "Indent each line of the snippet with `indent-according-to-mode'"
614 :active t :style radio :selected (eq yas-indent-line 'auto)]
615 ["Fixed" (setq yas-indent-line 'fixed)
616 :help "Indent the snippet to the current column"
617 :active t :style radio :selected (eq yas-indent-line 'fixed)]
618 ["None" (setq yas-indent-line 'none)
619 :help "Don't apply any particular snippet indentation after expansion"
620 :active t :style radio :selected (not (member yas-indent-line '(fixed auto)))]
622 ["Also auto indent first line" (setq yas-also-auto-indent-first-line
623 (not yas-also-auto-indent-first-line))
624 :help "When auto-indenting also, auto indent the first line menu"
625 :active (eq yas-indent-line 'auto)
626 :style toggle :selected yas-also-auto-indent-first-line]
629 ["System X-widget" (setq yas-prompt-functions
631 (remove 'yas-x-prompt
632 yas-prompt-functions)))
633 :help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
634 :active t :style radio :selected (eq (car yas-prompt-functions)
636 ["Dropdown-list" (setq yas-prompt-functions
637 (cons 'yas-dropdown-prompt
638 (remove 'yas-dropdown-prompt
639 yas-prompt-functions)))
640 :help "Use a special dropdown list"
641 :active t :style radio :selected (eq (car yas-prompt-functions)
642 'yas-dropdown-prompt)]
643 ["Ido" (setq yas-prompt-functions
644 (cons 'yas-ido-prompt
645 (remove 'yas-ido-prompt
646 yas-prompt-functions)))
647 :help "Use an ido-style minibuffer prompt"
648 :active t :style radio :selected (eq (car yas-prompt-functions)
650 ["Completing read" (setq yas-prompt-functions
651 (cons 'yas-completing-prompt
652 (remove 'yas-completing-prompt
653 yas-prompt-functions)))
654 :help "Use a normal minibuffer prompt"
655 :active t :style radio :selected (eq (car yas-prompt-functions)
656 'yas-completing-prompt)]
659 ["Wrap region in exit marker"
660 (setq yas-wrap-around-region
661 (not yas-wrap-around-region))
662 :help "If non-nil automatically wrap the selected text in the $0 snippet exit"
663 :style toggle :selected yas-wrap-around-region]
664 ["Allow stacked expansions "
665 (setq yas-triggers-in-field
666 (not yas-triggers-in-field))
667 :help "If non-nil allow snippets to be triggered inside other snippet fields"
668 :style toggle :selected yas-triggers-in-field]
669 ["Revive snippets on undo "
670 (setq yas-snippet-revival
671 (not yas-snippet-revival))
672 :help "If non-nil allow snippets to become active again after undo"
673 :style toggle :selected yas-snippet-revival]
676 (not yas-good-grace))
677 :help "If non-nil don't raise errors in bad embedded elisp in snippets"
678 :style toggle :selected yas-good-grace]
681 ["Load snippets..." yas-load-directory
682 :help "Load snippets from a specific directory"]
683 ["Reload everything" yas-reload-all
684 :help "Cleanup stuff, reload snippets, rebuild menus"]
686 :help "Display some information about YASnippet"]))
688 (defvar yas--extra-modes nil
689 "An internal list of modes for which to also lookup snippets.
691 This variable probably makes more sense as buffer-local, so
692 ensure your use `make-local-variable' when you set it.")
693 (define-obsolete-variable-alias 'yas-extra-modes 'yas--extra-modes "0.8.1")
695 (defvar yas--tables (make-hash-table)
696 "A hash table of mode symbols to `yas--table' objects.")
698 (defvar yas--parents (make-hash-table)
699 "A hash table of mode symbols do lists of direct parent mode symbols.
701 This list is populated when reading the \".yas-parents\" files
702 found when traversing snippet directories with
703 `yas-load-directory'.
705 There might be additional parenting information stored in the
706 `derived-mode-parent' property of some mode symbols, but that is
709 (defvar yas--direct-keymaps (list)
710 "Keymap alist supporting direct snippet keybindings.
712 This variable is placed in `emulation-mode-map-alists'.
714 Its elements looks like (TABLE-NAME . KEYMAP). They're
715 instantiated on `yas-reload-all' but KEYMAP is added to only when
716 loading snippets. `yas--direct-TABLE-NAME' is then a variable set
717 buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
718 defined direct keybindings to the command
719 `yas-expand-from-keymap' which then which snippet to expand.")
721 (defun yas-direct-keymaps-reload ()
722 "Force reload the direct keybinding for active snippet tables."
724 (setq yas--direct-keymaps nil)
725 (maphash #'(lambda (name table)
726 (push (cons (intern (format "yas--direct-%s" name))
727 (yas--table-direct-keymap table))
728 yas--direct-keymaps))
731 (defun yas--modes-to-activate ()
732 "Compute list of mode symbols that are active for `yas-expand'
735 (setq dfs (lambda (mode &optional explored)
739 in (cl-list* (get mode 'derived-mode-parent)
740 (ignore-errors (symbol-function mode))
741 (gethash mode yas--parents))
743 (not (memq neighbour explored))
745 append (funcall dfs neighbour explored)))))
746 (remove-duplicates (append yas--extra-modes
747 (funcall dfs major-mode)))))
749 (defvar yas-minor-mode-hook nil
750 "Hook run when `yas-minor-mode' is turned on.")
753 (define-minor-mode yas-minor-mode
754 "Toggle YASnippet mode.
756 When YASnippet mode is enabled, `yas-expand', normally bound to
757 the TAB key, expands snippets of code depending on the major
760 With no argument, this command toggles the mode.
761 positive prefix argument turns on the mode.
762 Negative prefix argument turns off the mode.
765 \\{yas-minor-mode-map}"
767 ;; The indicator for the mode line.
770 (cond (yas-minor-mode
771 ;; Install the direct keymaps in `emulation-mode-map-alists'
772 ;; (we use `add-hook' even though it's not technically a hook,
773 ;; but it works). Then define variables named after modes to
774 ;; index `yas--direct-keymaps'.
776 ;; Also install the post-command-hook.
778 (add-hook 'emulation-mode-map-alists 'yas--direct-keymaps)
779 (add-hook 'post-command-hook 'yas--post-command-handler nil t)
780 ;; Set the `yas--direct-%s' vars for direct keymap expansion
782 (dolist (mode (yas--modes-to-activate))
783 (let ((name (intern (format "yas--direct-%s" mode))))
784 (set-default name nil)
785 (set (make-local-variable name) t)))
788 (yas--load-pending-jits))
790 ;; Uninstall the direct keymaps and the post-command hook
792 (remove-hook 'post-command-hook 'yas--post-command-handler t)
793 (remove-hook 'emulation-mode-map-alists 'yas--direct-keymaps))))
795 (defun yas-activate-extra-mode (mode)
796 "Activates the snippets for the given `mode' in the buffer.
798 The function can be called in the hook of a minor mode to
799 activate snippets associated with that mode."
803 (maphash (lambda (k _)
804 (setq modes (cons (list k) modes)))
806 (setq symbol (completing-read
807 "Activate mode: " modes nil t))
809 (when (not (string= "" symbol))
812 (add-to-list (make-local-variable 'yas--extra-modes) mode)
813 (yas--load-pending-jits)))
815 (defun yas-deactivate-extra-mode (mode)
816 "Deactivates the snippets for the given `mode' in the buffer."
820 "Deactivate mode: " (mapcar #'list yas--extra-modes) nil t))))
821 (set (make-local-variable 'yas--extra-modes)
825 (defvar yas-dont-activate '(minibufferp)
826 "If non-nil don't let `yas-global-mode' affect some buffers.
828 If a function of zero arguments, then its result is used.
830 If a list of functions, then all functions must return nil to
831 activate yas for this buffer.
833 In Emacsen <= 23, this variable is buffer-local. Because
834 `yas-minor-mode-on' is called by `yas-global-mode' after
835 executing the buffer's major mode hook, setting this variable
836 there is an effective way to define exceptions to the \"global\"
837 activation behaviour.
839 In Emacsen > 23, only the global value is used. To define
840 per-mode exceptions to the \"global\" activation behaviour, call
841 `yas-minor-mode' with a negative argument directily in the major
843 (unless (> emacs-major-version 23)
845 (make-variable-buffer-local 'yas-dont-activate)))
848 (defun yas-minor-mode-on ()
849 "Turn on YASnippet minor mode.
851 Honour `yas-dont-activate', which see."
853 ;; Check `yas-dont-activate'
854 (unless (cond ((functionp yas-dont-activate)
855 (funcall yas-dont-activate))
856 ((consp yas-dont-activate)
857 (some #'funcall yas-dont-activate))
862 (define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
866 (defun yas--global-mode-reload-with-jit-maybe ()
867 "Run `yas-reload-all' when `yas-global-mode' is on."
868 (when yas-global-mode (yas-reload-all)))
870 (add-hook 'yas-global-mode-hook 'yas--global-mode-reload-with-jit-maybe)
875 (defvar yas--font-lock-keywords
876 (append '(("^#.*$" . font-lock-comment-face))
877 lisp-font-lock-keywords-2
879 (0 font-lock-keyword-face)
880 (1 font-lock-string-face t))
882 (0 font-lock-keyword-face)
883 (1 font-lock-warning-face t))
884 ("${" . font-lock-keyword-face)
885 ("$[0-9]+?" . font-lock-preprocessor-face)
886 ("\\(\\$(\\)" 1 font-lock-preprocessor-face)
888 (0 font-lock-keyword-face)))))
890 (defvar snippet-mode-map
891 (let ((map (make-sparse-keymap)))
892 (easy-menu-define nil
894 "Menu used when snippet-mode is active."
896 (mapcar #'(lambda (ent)
898 (define-key map (third ent) (second ent)))
899 (vector (first ent) (second ent) t))
900 '(("Load this snippet" yas-load-snippet-buffer "\C-c\C-l")
901 ("Load and quit window" yas-load-snippet-buffer-and-close "\C-c\C-c")
902 ("Try out this snippet" yas-tryout-snippet "\C-c\C-t")))))
904 "The keymap used when `snippet-mode' is active.")
907 (define-derived-mode snippet-mode text-mode "Snippet"
908 "A mode for editing yasnippets"
909 (setq font-lock-defaults '(yas--font-lock-keywords))
910 (set (make-local-variable 'require-final-newline) nil)
911 (set (make-local-variable 'comment-start) "#")
912 (set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
916 ;;; Internal structs for template management
918 (defstruct (yas--template (:constructor yas--make-blank-template))
919 "A template for a snippet."
929 group ;; as dictated by the #group: directive or .yas-make-groups
930 perm-group ;; as dictated by `yas-define-menu'
934 (defun yas--populate-template (template &rest args)
935 "Helper function to populate TEMPLATE with properties."
938 (position (intern (substring (symbol-name (car args)) 1))
939 (mapcar #'car (get 'yas--template 'cl-struct-slots)))
941 (setq args (cddr args)))
944 (defstruct (yas--table (:constructor yas--make-snippet-table (name)))
945 "A table to store snippets for a particular mode.
947 Has the following fields:
951 A symbol name normally corresponding to a major mode, but can
952 also be a pseudo major-mode to be used in
953 `yas-activate-extra-mode', for example.
957 A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
958 a string or a vector, where the former is the snippet's trigger
959 and the latter means it's a direct keybinding. NAMEHASH is yet
960 another hash of (NAME . TEMPLATE) where NAME is the snippet's
961 name and TEMPLATE is a `yas--template' object.
963 `yas--table-direct-keymap'
965 A keymap for the snippets in this table that have direct
966 keybindings. This is kept in sync with the keyhash, i.e., all
967 the elements of the keyhash that are vectors appear here as
968 bindings to `yas-expand-from-keymap'.
970 `yas--table-uuidhash'
972 A hash table mapping snippets uuid's to the same `yas--template'
973 objects. A snippet uuid defaults to the snippet's name."
975 (hash (make-hash-table :test 'equal))
976 (uuidhash (make-hash-table :test 'equal))
978 (direct-keymap (make-sparse-keymap)))
980 (defun yas--get-template-by-uuid (mode uuid)
981 "Find the snippet template in MODE by its UUID."
982 (let* ((table (gethash mode yas--tables mode)))
984 (gethash uuid (yas--table-uuidhash table)))))
986 ;; Apropos storing/updating in TABLE, this works in two steps:
988 ;; 1. `yas--remove-template-by-uuid' removes any
989 ;; keyhash-namehash-template mappings from TABLE, grabbing the
990 ;; snippet by its uuid. Also removes mappings from TABLE's
991 ;; `yas--table-direct-keymap' (FIXME: and should probably take care
992 ;; of potentially stale menu bindings right?.)
994 ;; 2. `yas--add-template' adds this all over again.
996 ;; Create a new or add to an existing keyhash-namehash mapping.
998 ;; For reference on understanding this, consider three snippet
1001 ;; A: # name: The Foo
1003 ;; # binding: C-c M-l
1005 ;; B: # name: Mrs Foo
1008 ;; C: # name: The Bar
1009 ;; # binding: C-c M-l
1014 ;; keyhash namehashes(3) yas--template structs(4)
1015 ;; -----------------------------------------------------
1018 ;; "foo" ---> "The Foo" ---> [yas--template A] |
1019 ;; "Mrs Foo" ---> [yas--template B] |
1021 ;; [C-c M-l] ---> "The Foo" -------------------------/
1022 ;; "The Bar" ---> [yas--template C]
1024 ;; "baz" ---> "Baz" ---> [yas--template D]
1026 ;; Additionally, since uuid defaults to the name, we have a
1027 ;; `yas--table-uuidhash' for TABLE
1029 ;; uuidhash yas--template structs
1030 ;; -------------------------------
1031 ;; "The Foo" ---> [yas--template A]
1032 ;; "Mrs Foo" ---> [yas--template B]
1033 ;; "The Bar" ---> [yas--template C]
1034 ;; "Baz" ---> [yas--template D]
1036 ;; FIXME: the more I look at this data-structure the more I think I'm
1037 ;; stupid. There has to be an easier way (but beware lots of code
1038 ;; depends on this).
1040 (defun yas--remove-template-by-uuid (table uuid)
1041 "Remove from TABLE a template identified by UUID."
1042 (let ((template (gethash uuid (yas--table-uuidhash table))))
1044 (let* ((name (yas--template-name template))
1046 ;; Remove the name from each of the targeted namehashes
1048 (maphash #'(lambda (k v)
1049 (let ((template (gethash name v)))
1051 (eq uuid (yas--template-uuid template)))
1053 (when (zerop (hash-table-count v))
1054 (push k empty-keys)))))
1055 (yas--table-hash table))
1056 ;; Remove the namehash themselves if they've become empty
1058 (dolist (key empty-keys)
1060 (define-key (yas--table-direct-keymap table) key nil))
1061 (remhash key (yas--table-hash table)))
1063 ;; Finally, remove the uuid from the uuidhash
1065 (remhash uuid (yas--table-uuidhash table))))))
1067 (defun yas--add-template (table template)
1068 "Store in TABLE the snippet template TEMPLATE.
1070 KEY can be a string (trigger key) of a vector (direct
1072 (let ((name (yas--template-name template))
1073 (key (yas--template-key template))
1074 (keybinding (yas--template-keybinding template))
1075 (_menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
1076 (dolist (k (remove nil (list key keybinding)))
1080 (yas--table-hash table))
1082 (make-hash-table :test 'equal)
1083 (yas--table-hash table))))
1085 (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
1087 ;; Update TABLE's `yas--table-uuidhash'
1088 (puthash (yas--template-uuid template)
1090 (yas--table-uuidhash table))))
1092 (defun yas--update-template (table template)
1093 "Add or update TEMPLATE in TABLE.
1095 Also takes care of adding and updating to the associated menu."
1096 ;; Remove from table by uuid
1098 (yas--remove-template-by-uuid table (yas--template-uuid template))
1099 ;; Add to table again
1101 (yas--add-template table template)
1102 ;; Take care of the menu
1104 (yas--update-template-menu table template))
1106 (defun yas--update-template-menu (table template)
1107 "Update every menu-related for TEMPLATE."
1108 (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
1109 (key (yas--template-key template))
1110 (keybinding (yas--template-keybinding template)))
1111 ;; The snippet might have changed name or keys, so update
1112 ;; user-visible strings
1114 (unless (eq (cdr menu-binding-pair) :none)
1115 ;; the menu item name
1117 (setf (cadar menu-binding-pair) (yas--template-name template))
1118 ;; the :keys information (also visible to the user)
1119 (setf (getf (cdr (car menu-binding-pair)) :keys)
1120 (or (and keybinding (key-description keybinding))
1121 (and key (concat key yas-trigger-symbol))))))
1122 (unless (yas--template-menu-managed-by-yas-define-menu template)
1124 (yas--menu-keymap-get-create (yas--table-mode table)
1125 (mapcar #'yas--table-mode
1126 (yas--table-parents table))))
1127 (group (yas--template-group template)))
1128 ;; Remove from menu keymap
1130 (assert menu-keymap)
1131 (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
1133 ;; Add necessary subgroups as necessary.
1135 (dolist (subgroup group)
1136 (let ((subgroup-keymap (lookup-key menu-keymap (vector (make-symbol subgroup)))))
1137 (unless (and subgroup-keymap
1138 (keymapp subgroup-keymap))
1139 (setq subgroup-keymap (make-sparse-keymap))
1140 (define-key menu-keymap (vector (make-symbol subgroup))
1141 `(menu-item ,subgroup ,subgroup-keymap)))
1142 (setq menu-keymap subgroup-keymap)))
1144 ;; Add this entry to the keymap
1146 (define-key menu-keymap
1147 (vector (make-symbol (yas--template-uuid template)))
1148 (car (yas--template-menu-binding-pair template))))))
1150 (defun yas--namehash-templates-alist (namehash)
1151 "Return NAMEHASH as an alist."
1153 (maphash #'(lambda (k v)
1154 (push (cons k v) alist))
1158 (defun yas--fetch (table key)
1159 "Fetch templates in TABLE by KEY.
1161 Return a list of cons (NAME . TEMPLATE) where NAME is a
1162 string and TEMPLATE is a `yas--template' structure."
1163 (let* ((keyhash (yas--table-hash table))
1164 (namehash (and keyhash (gethash key keyhash))))
1166 (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
1169 ;;; Filtering/condition logic
1171 (defun yas--eval-condition (condition)
1178 (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
1182 (defun yas--filter-templates-by-condition (templates)
1183 "Filter the templates using the applicable condition.
1185 TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
1186 string and TEMPLATE is a `yas--template' structure.
1188 This function implements the rules described in
1189 `yas-buffer-local-condition'. See that variables documentation."
1190 (let ((requirement (yas--require-template-specific-condition-p)))
1191 (if (eq requirement 'always)
1193 (remove-if-not #'(lambda (pair)
1194 (yas--template-can-expand-p
1195 (yas--template-condition (cdr pair)) requirement))
1198 (defun yas--require-template-specific-condition-p ()
1199 "Decide if this buffer requests/requires snippet-specific
1200 conditions to filter out potential expansions."
1201 (if (eq 'always yas-buffer-local-condition)
1203 (let ((local-condition (or (and (consp yas-buffer-local-condition)
1204 (yas--eval-condition yas-buffer-local-condition))
1205 yas-buffer-local-condition)))
1206 (when local-condition
1207 (if (eq local-condition t)
1209 (and (consp local-condition)
1210 (eq 'require-snippet-condition (car local-condition))
1211 (symbolp (cdr local-condition))
1212 (cdr local-condition)))))))
1214 (defun yas--template-can-expand-p (condition requirement)
1215 "Evaluate CONDITION and REQUIREMENT and return a boolean."
1216 (let* ((result (or (null condition)
1217 (yas--eval-condition condition))))
1218 (cond ((eq requirement t)
1221 (eq requirement result)))))
1223 (defun yas--table-templates (table)
1226 (maphash #'(lambda (_key namehash)
1227 (maphash #'(lambda (name template)
1228 (push (cons name template) acc))
1230 (yas--table-hash table))
1231 (yas--filter-templates-by-condition acc))))
1233 (defun yas--templates-for-key-at-point ()
1234 "Find `yas--template' objects for any trigger keys preceding point.
1235 Returns (TEMPLATES START END). This function respects
1236 `yas-key-syntaxes', which see."
1238 (let ((original (point))
1239 (methods yas-key-syntaxes)
1244 (unless (eq method (car methods))
1245 ;; TRICKY: `eq'-ness test means we can only be here if
1246 ;; `method' is a function that returned `again', and hence
1247 ;; don't revert back to original position as per
1248 ;; `yas-key-syntaxes'.
1249 (goto-char original))
1250 (setq method (car methods))
1251 (cond ((stringp method)
1252 (skip-syntax-backward method)
1253 (setq methods (cdr methods)))
1255 (unless (eq (funcall method original)
1257 (setq methods (cdr methods))))
1259 (yas--warning "Warning invalid element %s in `yas-key-syntaxes'" method)))
1261 (mapcan #'(lambda (table)
1262 (yas--fetch table (buffer-substring-no-properties (point)
1264 (yas--get-snippet-tables))))
1266 (list templates (point) original)))))
1268 (defun yas--table-all-keys (table)
1269 "Get trigger keys of all active snippets in TABLE."
1271 (maphash #'(lambda (key namehash)
1272 (when (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash))
1274 (yas--table-hash table))
1277 (defun yas--table-mode (table)
1278 (intern (yas--table-name table)))
1281 ;;; Internal functions and macros:
1283 (defun yas--real-mode? (mode)
1284 "Try to find out if MODE is a real mode.
1286 The MODE bound to a function (like `c-mode') is considered real
1287 mode. Other well known mode like `ruby-mode' which is not part of
1288 Emacs might not bound to a function until it is loaded. So
1289 yasnippet keeps a list of modes like this to help the judgment."
1291 (find mode yas--known-modes)))
1293 (defun yas--handle-error (err)
1294 "Handle error depending on value of `yas-good-grace'."
1295 (let ((msg (yas--format "elisp error: %s" (error-message-string err))))
1296 (if yas-good-grace msg
1299 (defun yas--eval-lisp (form)
1300 "Evaluate FORM and convert the result to string."
1301 (let ((retval (catch 'yas--exception
1307 (let ((result (eval form)))
1309 (format "%s" result))))))
1310 (error (yas--handle-error err))))))
1311 (when (and (consp retval)
1312 (eq 'yas--exception (car retval)))
1313 (error (cdr retval)))
1316 (defun yas--eval-lisp-no-saves (form)
1319 (error (message "%s" (yas--handle-error err)))))
1321 (defun yas--read-lisp (string &optional nil-on-error)
1322 "Read STRING as a elisp expression and return it.
1324 In case STRING in an invalid expression and NIL-ON-ERROR is nil,
1325 return an expression that when evaluated will issue an error."
1328 (error (and (not nil-on-error)
1329 `(error (error-message-string ,err))))))
1331 (defun yas--read-keybinding (keybinding)
1332 "Read KEYBINDING as a snippet keybinding, return a vector."
1333 (when (and keybinding
1334 (not (string-match "keybinding" keybinding)))
1336 (let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
1338 (read-kbd-macro keybinding 'need-vector))))
1341 (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
1342 keybinding (error-message-string err))
1345 (defun yas--table-get-create (mode)
1346 "Get or create the snippet table corresponding to MODE."
1347 (let ((table (gethash mode
1350 (setq table (yas--make-snippet-table (symbol-name mode)))
1351 (puthash mode table yas--tables)
1352 (push (cons (intern (format "yas--direct-%s" mode))
1353 (yas--table-direct-keymap table))
1354 yas--direct-keymaps))
1357 (defun yas--get-snippet-tables ()
1358 "Get snippet tables for current buffer.
1360 Return a list of `yas--table' objects. The list of modes to
1361 consider is returned by `yas--modes-to-activate'"
1363 (mapcar #'(lambda (name)
1364 (gethash name yas--tables))
1365 (yas--modes-to-activate))))
1367 (defun yas--menu-keymap-get-create (mode &optional parents)
1368 "Get or create the menu keymap for MODE and its PARENTS.
1370 This may very well create a plethora of menu keymaps and arrange
1371 them all in `yas--menu-table'"
1372 (let* ((menu-keymap (or (gethash mode yas--menu-table)
1373 (puthash mode (make-sparse-keymap) yas--menu-table))))
1374 (mapc #'yas--menu-keymap-get-create parents)
1375 (define-key yas--minor-mode-menu (vector mode)
1376 `(menu-item ,(symbol-name mode) ,menu-keymap
1377 :visible (yas--show-menu-p ',mode)))
1381 (defmacro yas--called-interactively-p (&optional kind)
1382 "A backward-compatible version of `called-interactively-p'.
1384 Optional KIND is as documented at `called-interactively-p'
1385 in GNU Emacs 24.1 or higher."
1386 (if (string< emacs-version "24.1")
1387 '(called-interactively-p)
1388 `(called-interactively-p ,kind)))
1391 ;;; Template-related and snippet loading functions
1393 (defun yas--parse-template (&optional file)
1394 "Parse the template in the current buffer.
1396 Optional FILE is the absolute file name of the file being
1399 Optional GROUP is the group where the template is to go,
1400 otherwise we attempt to calculate it from FILE.
1402 Return a snippet-definition, i.e. a list
1404 (KEY TEMPLATE NAME CONDITION GROUP VARS FILE KEYBINDING UUID)
1406 If the buffer contains a line of \"# --\" then the contents above
1407 this line are ignored. Directives can set most of these with the syntax:
1409 # directive-name : directive-value
1411 Here's a list of currently recognized directives:
1422 (goto-char (point-min))
1423 (let* ((type 'snippet)
1425 (file-name-nondirectory file)))
1431 (yas--calculate-group file)))
1435 (if (re-search-forward "^# --\n" nil t)
1436 (progn (setq template
1437 (buffer-substring-no-properties (point)
1439 (setq bound (point))
1440 (goto-char (point-min))
1441 (while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*\\)$" bound t)
1442 (when (string= "uuid" (match-string-no-properties 1))
1443 (setq uuid (match-string-no-properties 2)))
1444 (when (string= "type" (match-string-no-properties 1))
1445 (setq type (if (string= "command" (match-string-no-properties 2))
1448 (when (string= "key" (match-string-no-properties 1))
1449 (setq key (match-string-no-properties 2)))
1450 (when (string= "name" (match-string-no-properties 1))
1451 (setq name (match-string-no-properties 2)))
1452 (when (string= "condition" (match-string-no-properties 1))
1453 (setq condition (yas--read-lisp (match-string-no-properties 2))))
1454 (when (string= "group" (match-string-no-properties 1))
1455 (setq group (match-string-no-properties 2)))
1456 (when (string= "expand-env" (match-string-no-properties 1))
1457 (setq expand-env (yas--read-lisp (match-string-no-properties 2)
1459 (when (string= "binding" (match-string-no-properties 1))
1460 (setq binding (match-string-no-properties 2)))))
1462 (buffer-substring-no-properties (point-min) (point-max))))
1463 (unless (or key binding)
1464 (setq key (and file (file-name-nondirectory file))))
1465 (when (eq type 'command)
1466 (setq template (yas--read-lisp (concat "(progn" template ")"))))
1468 (setq group (split-string group "\\.")))
1469 (list key template name condition group expand-env file binding uuid)))
1471 (defun yas--calculate-group (file)
1472 "Calculate the group for snippet file path FILE."
1473 (let* ((dominating-dir (locate-dominating-file file
1474 ".yas-make-groups"))
1475 (extra-path (and dominating-dir
1476 (replace-regexp-in-string (concat "^"
1477 (expand-file-name dominating-dir))
1479 (expand-file-name file))))
1480 (extra-dir (and extra-path
1481 (file-name-directory extra-path)))
1482 (group (and extra-dir
1483 (replace-regexp-in-string "/"
1485 (directory-file-name extra-dir)))))
1488 (defun yas--subdirs (directory &optional filep)
1489 "Return subdirs or files of DIRECTORY according to FILEP."
1490 (remove-if (lambda (file)
1491 (or (string-match "^\\."
1492 (file-name-nondirectory file))
1493 (string-match "^#.*#$"
1494 (file-name-nondirectory file))
1496 (file-name-nondirectory file))
1498 (file-directory-p file)
1499 (not (file-directory-p file)))))
1500 (directory-files directory t)))
1502 (defun yas--make-menu-binding (template)
1503 (let ((mode (yas--table-mode (yas--template-table template))))
1504 `(lambda () (interactive) (yas--expand-or-visit-from-menu ',mode ,(yas--template-uuid template)))))
1506 (defun yas--expand-or-visit-from-menu (mode uuid)
1507 (let* ((table (yas--table-get-create mode))
1508 (yas--current-template (and table
1509 (gethash uuid (yas--table-uuidhash table)))))
1510 (when yas--current-template
1511 (if yas-visit-from-menu
1512 (yas--visit-snippet-file-1 yas--current-template)
1513 (let ((where (if (region-active-p)
1514 (cons (region-beginning) (region-end))
1515 (cons (point) (point)))))
1516 (yas-expand-snippet (yas--template-content yas--current-template)
1519 (yas--template-expand-env yas--current-template)))))))
1521 (defun yas--key-from-desc (text)
1522 "Return a yasnippet key from a description string TEXT."
1523 (replace-regexp-in-string "\\(\\w+\\).*" "\\1" text))
1526 ;;; Popping up for keys and templates
1528 (defun yas--prompt-for-template (templates &optional prompt)
1529 "Interactively choose a template from the list TEMPLATES.
1531 TEMPLATES is a list of `yas--template'.
1533 Optional PROMPT sets the prompt to use."
1536 (sort templates #'(lambda (t1 t2)
1537 (< (length (yas--template-name t1))
1538 (length (yas--template-name t2))))))
1539 (some #'(lambda (fn)
1540 (funcall fn (or prompt "Choose a snippet: ")
1542 #'yas--template-name))
1543 yas-prompt-functions)))
1545 (defun yas--prompt-for-keys (keys &optional prompt)
1546 "Interactively choose a template key from the list KEYS.
1548 Optional PROMPT sets the prompt to use."
1550 (some #'(lambda (fn)
1551 (funcall fn (or prompt "Choose a snippet key: ") keys))
1552 yas-prompt-functions)))
1554 (defun yas--prompt-for-table (tables &optional prompt)
1555 "Interactively choose a table from the list TABLES.
1557 Optional PROMPT sets the prompt to use."
1559 (some #'(lambda (fn)
1560 (funcall fn (or prompt "Choose a snippet table: ")
1563 yas-prompt-functions)))
1565 (defun yas-x-prompt (prompt choices &optional display-fn)
1566 "Display choices in a x-window prompt."
1567 (when (and window-system choices)
1570 (if (fboundp 'posn-at-point)
1571 (let ((x-y (posn-x-y (posn-at-point (point)))))
1572 (list (list (+ (car x-y) 10)
1577 ,@(mapcar* (lambda (c d) `(,(concat " " d) . ,c))
1579 (if display-fn (mapcar display-fn choices) choices)))))
1582 (defun yas-ido-prompt (prompt choices &optional display-fn)
1583 (when (and (fboundp 'ido-completing-read)
1584 (or (>= emacs-major-version 24)
1586 (yas-completing-prompt prompt choices display-fn #'ido-completing-read)))
1588 (defun yas-dropdown-prompt (_prompt choices &optional display-fn)
1589 (when (fboundp 'dropdown-list)
1590 (let* ((formatted-choices
1591 (if display-fn (mapcar display-fn choices) choices))
1592 (n (dropdown-list formatted-choices)))
1593 (if n (nth n choices)
1596 (defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
1597 (let* ((formatted-choices
1598 (if display-fn (mapcar display-fn choices) choices))
1599 (chosen (funcall (or completion-fn #'completing-read)
1600 prompt formatted-choices
1601 nil 'require-match nil nil)))
1602 (if (eq choices formatted-choices)
1604 (nth (or (position chosen formatted-choices :test #'string=) 0)
1607 (defun yas-no-prompt (_prompt choices &optional _display-fn)
1611 ;;; Defining snippets
1612 ;; This consists of creating and registering `yas--template' objects in the
1616 (defvar yas--creating-compiled-snippets nil)
1618 (defun yas--define-snippets-1 (snippet snippet-table)
1619 "Helper for `yas-define-snippets'."
1620 ;; X) Calculate some more defaults on the values returned by
1621 ;; `yas--parse-template'.
1623 (let* ((file (seventh snippet))
1625 (name (or (third snippet)
1627 (file-name-directory file))))
1628 (condition (fourth snippet))
1629 (group (fifth snippet))
1630 (keybinding (yas--read-keybinding (eighth snippet)))
1631 (uuid (or (ninth snippet)
1633 (template (or (gethash uuid (yas--table-uuidhash snippet-table))
1634 (yas--make-blank-template))))
1635 ;; X) populate the template object
1637 (yas--populate-template template
1638 :table snippet-table
1640 :content (second snippet)
1643 :condition condition
1644 :expand-env (sixth snippet)
1645 :file (seventh snippet)
1646 :keybinding keybinding
1648 ;; X) Update this template in the appropriate table. This step
1649 ;; also will take care of adding the key indicators in the
1650 ;; templates menu entry, if any
1652 (yas--update-template snippet-table template)
1653 ;; X) Return the template
1658 (defun yas-define-snippets (mode snippets)
1659 "Define SNIPPETS for MODE.
1661 SNIPPETS is a list of snippet definitions, each taking the
1664 (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV FILE KEYBINDING UUID)
1666 Within these, only KEY and TEMPLATE are actually mandatory.
1668 TEMPLATE might be a Lisp form or a string, depending on whether
1669 this is a snippet or a snippet-command.
1671 CONDITION, EXPAND-ENV and KEYBINDING are Lisp forms, they have
1672 been `yas--read-lisp'-ed and will eventually be
1673 `yas--eval-lisp'-ed.
1675 The remaining elements are strings.
1677 FILE is probably of very little use if you're programatically
1680 UUID is the snippet's \"unique-id\". Loading a second snippet
1681 file with the same uuid would replace the previous snippet.
1683 You can use `yas--parse-template' to return such lists based on
1684 the current buffers contents."
1685 (if yas--creating-compiled-snippets
1687 (insert ";;; Snippet definitions:\n;;;\n")
1688 (let ((literal-snippets (list))
1690 (dolist (snippet snippets)
1691 (let ((key (nth 0 snippet))
1692 (template-content (nth 1 snippet))
1693 (name (nth 2 snippet))
1694 (condition (nth 3 snippet))
1695 (group (nth 4 snippet))
1696 (expand-env (nth 5 snippet))
1697 (file nil) ;; omit on purpose
1698 (binding (nth 7 snippet))
1699 (uuid (nth 8 snippet)))
1710 (insert (pp-to-string
1711 `(yas-define-snippets ',mode ',literal-snippets)))
1714 (let ((snippet-table (yas--table-get-create mode))
1716 (dolist (snippet snippets)
1717 (setq template (yas--define-snippets-1 snippet
1722 ;;; Loading snippets from files
1724 (defun yas--load-yas-setup-file (file)
1725 (if (not yas--creating-compiled-snippets)
1727 (load file 'noerror)
1728 (let ((elfile (concat file ".el")))
1729 (when (file-exists-p elfile)
1730 (insert ";;; .yas-setup.el support file if any:\n;;;\n")
1731 (insert-file-contents elfile)
1732 (goto-char (point-max))))))
1734 (defun yas--define-parents (mode parents)
1735 "Add PARENTS to the list of MODE's parents."
1736 (puthash mode (remove-duplicates
1738 (gethash mode yas--parents)))
1741 (defun yas-load-directory (top-level-dir &optional use-jit interactive)
1742 "Load snippets in directory hierarchy TOP-LEVEL-DIR.
1744 Below TOP-LEVEL-DIR each directory should be a mode name.
1746 With prefix argument USE-JIT do jit-loading of snippets."
1748 (list (read-directory-name "Select the root directory: " nil nil t)
1749 current-prefix-arg t))
1750 (unless yas-snippet-dirs
1751 (setq yas-snippet-dirs top-level-dir))
1752 (let ((impatient-buffers))
1753 (dolist (dir (yas--subdirs top-level-dir))
1754 (let* ((major-mode-and-parents (yas--compute-major-mode-and-parents
1755 (concat dir "/dummy")))
1756 (mode-sym (car major-mode-and-parents))
1757 (parents (cdr major-mode-and-parents)))
1758 ;; Attention: The parents and the menus are already defined
1759 ;; here, even if the snippets are later jit-loaded.
1761 ;; * We need to know the parents at this point since entering a
1762 ;; given mode should jit load for its parents
1763 ;; immediately. This could be reviewed, the parents could be
1764 ;; discovered just-in-time-as well
1766 ;; * We need to create the menus here to support the `full'
1767 ;; option to `yas-use-menu' (all known snippet menus are shown to the user)
1769 (yas--define-parents mode-sym parents)
1770 (yas--menu-keymap-get-create mode-sym)
1771 (let ((fun `(lambda () ;; FIXME: Simulating lexical-binding.
1772 (yas--load-directory-1 ',dir ',mode-sym))))
1774 (yas--schedule-jit mode-sym fun)
1776 ;; Look for buffers that are already in `mode-sym', and so
1777 ;; need the new snippets immediately...
1780 (cl-loop for buffer in (buffer-list)
1781 do (with-current-buffer buffer
1782 (when (eq major-mode mode-sym)
1783 (yas--message 3 "Discovered there was already %s in %s" buffer mode-sym)
1784 (push buffer impatient-buffers)))))))
1785 ;; ...after TOP-LEVEL-DIR has been completely loaded, call
1786 ;; `yas--load-pending-jits' in these impatient buffers.
1788 (cl-loop for buffer in impatient-buffers
1789 do (with-current-buffer buffer (yas--load-pending-jits))))
1791 (yas--message 3 "Loaded snippets from %s." top-level-dir)))
1793 (defun yas--load-directory-1 (directory mode-sym)
1794 "Recursively load snippet templates from DIRECTORY."
1795 (if yas--creating-compiled-snippets
1796 (let ((output-file (expand-file-name ".yas-compiled-snippets.el"
1798 (with-temp-file output-file
1799 (insert (format ";;; Compiled snippets and support files for `%s'\n"
1801 (yas--load-directory-2 directory mode-sym)
1802 (insert (format ";;; Do not edit! File generated at %s\n"
1803 (current-time-string)))))
1805 (unless (file-exists-p (concat directory "/" ".yas-skip"))
1806 (if (and (progn (yas--message 2 "Loading compiled snippets from %s" directory) t)
1807 (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3)))
1808 (yas--message 2 "Loading snippet files from %s" directory)
1809 (yas--load-directory-2 directory mode-sym)))))
1811 (defun yas--load-directory-2 (directory mode-sym)
1812 ;; Load .yas-setup.el files wherever we find them
1814 (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
1815 (let* ((default-directory directory)
1817 ;; load the snippet files
1820 (dolist (file (yas--subdirs directory 'no-subdirs-just-files))
1821 (when (file-readable-p file)
1822 (insert-file-contents file nil nil nil t)
1823 (push (yas--parse-template file)
1826 (yas-define-snippets mode-sym
1828 ;; now recurse to a lower level
1830 (dolist (subdir (yas--subdirs directory))
1831 (yas--load-directory-2 subdir
1834 (defun yas--load-snippet-dirs (&optional nojit)
1835 "Reload the directories listed in `yas-snippet-dirs' or
1836 prompt the user to select one."
1838 (if yas-snippet-dirs
1839 (dolist (directory (reverse (yas-snippet-dirs)))
1840 (cond ((file-directory-p directory)
1841 (yas-load-directory directory (not nojit))
1843 (yas--message 3 "Loaded %s" directory)
1844 (yas--message 3 "Prepared just-in-time loading for %s" directory)))
1846 (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors))))
1847 (call-interactively 'yas-load-directory))
1850 (defun yas-reload-all (&optional no-jit interactive)
1851 "Reload all snippets and rebuild the YASnippet menu.
1853 When NO-JIT is non-nil force immediate reload of all known
1854 snippets under `yas-snippet-dirs', otherwise use just-in-time
1857 When called interactively, use just-in-time loading when given a
1859 (interactive (list (not current-prefix-arg) t))
1862 (snippet-editing-buffers
1863 (remove-if-not #'(lambda (buffer)
1864 (with-current-buffer buffer yas--editing-template))
1866 ;; Warn if there are buffers visiting snippets, since reloading will break
1867 ;; any on-line editing of those buffers.
1869 (when snippet-editing-buffers
1871 (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
1872 (mapc #'kill-buffer snippet-editing-buffers)
1873 (yas--message 1 "Aborted reload...")
1875 ;; in a non-interactive use, at least set
1876 ;; `yas--editing-template' to nil, make it guess it next time around
1877 (mapc #'(lambda (buffer)
1878 (with-current-buffer buffer
1879 (kill-local-variable 'yas--editing-template)))
1882 ;; Empty all snippet tables and parenting info
1884 (setq yas--tables (make-hash-table))
1885 (setq yas--parents (make-hash-table))
1887 ;; Before killing `yas--menu-table' use its keys to cleanup the
1888 ;; mode menu parts of `yas--minor-mode-menu' (thus also cleaning
1889 ;; up `yas-minor-mode-map', which points to it)
1891 (maphash #'(lambda (menu-symbol _keymap)
1892 (define-key yas--minor-mode-menu (vector menu-symbol) nil))
1894 ;; Now empty `yas--menu-table' as well
1895 (setq yas--menu-table (make-hash-table))
1897 ;; Cancel all pending 'yas--scheduled-jit-loads'
1899 (setq yas--scheduled-jit-loads (make-hash-table))
1901 ;; Reload the directories listed in `yas-snippet-dirs' or prompt
1902 ;; the user to select one.
1904 (setq errors (yas--load-snippet-dirs no-jit))
1905 ;; Reload the direct keybindings
1907 (yas-direct-keymaps-reload)
1909 (run-hooks 'yas-after-reload-hook)
1910 (yas--message 3 "Reloaded everything%s...%s."
1911 (if no-jit "" " (snippets will load just-in-time)")
1912 (if errors " (some errors, check *Messages*)" "")))))
1914 (defvar yas-after-reload-hook nil
1915 "Hooks run after `yas-reload-all'.")
1917 (defun yas--load-pending-jits ()
1918 (dolist (mode (yas--modes-to-activate))
1919 (let ((funs (reverse (gethash mode yas--scheduled-jit-loads))))
1920 ;; must reverse to maintain coherence with `yas-snippet-dirs'
1922 (yas--message 3 "Loading for `%s', just-in-time: %s!" mode fun)
1924 (remhash mode yas--scheduled-jit-loads))))
1926 ;; (when (<= emacs-major-version 22)
1927 ;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
1929 (defun yas--quote-string (string)
1930 "Escape and quote STRING.
1931 foo\"bar\\! -> \"foo\\\"bar\\\\!\""
1933 (replace-regexp-in-string "[\\\"]"
1939 ;;; Snippet compilation function
1941 (defun yas--initialize ()
1942 "For backward compatibility, enable `yas-minor-mode' globally."
1943 (yas-global-mode 1))
1945 (defun yas-compile-directory (top-level-dir)
1946 "Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
1948 This works by stubbing a few functions, then calling
1949 `yas-load-directory'."
1950 (interactive "DTop level snippet directory?")
1951 (let ((yas--creating-compiled-snippets t))
1952 (yas-load-directory top-level-dir nil)))
1954 (defun yas-recompile-all ()
1955 "Compile every dir in `yas-snippet-dirs'."
1957 (mapc #'yas-compile-directory (yas-snippet-dirs)))
1963 (defvar yas--scheduled-jit-loads (make-hash-table)
1964 "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
1966 (defun yas--schedule-jit (mode fun)
1967 (push fun (gethash mode yas--scheduled-jit-loads)))
1971 ;;; Some user level functions
1975 (message (concat "yasnippet (version "
1977 ") -- pluskid <pluskid@gmail.com>/joaotavora <joaotavora@gmail.com>")))
1980 ;;; Apropos snippet menu:
1982 ;; The snippet menu keymaps are store by mode in hash table called
1983 ;; `yas--menu-table'. They are linked to the main menu in
1984 ;; `yas--menu-keymap-get-create' and are initially created empty,
1985 ;; reflecting the table hierarchy.
1987 ;; They can be populated in two mutually exclusive ways: (1) by
1988 ;; reading `yas--template-group', which in turn is populated by the "#
1989 ;; group:" directives of the snippets or the ".yas-make-groups" file
1990 ;; or (2) by using a separate `yas-define-menu' call, which declares a
1991 ;; menu structure based on snippets uuids.
1993 ;; Both situations are handled in `yas--update-template-menu', which
1994 ;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
1995 ;; that can tell between the two situations.
1999 ;; * if `yas-define-menu' is used it must run before
2000 ;; `yas-define-snippets' and the UUIDS must match, otherwise we get
2001 ;; duplicate entries. The `yas--template' objects are created in
2002 ;; `yas-define-menu', holding nothing but the menu entry,
2003 ;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
2004 ;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
2005 ;; part is then stored in the menu keymap itself which make the item
2006 ;; appear to the user. These limitations could probably be revised.
2008 ;; * The `yas--template-perm-group' slot is only used in
2009 ;; `yas-describe-tables'.
2011 (defun yas--template-menu-binding-pair-get-create (template &optional type)
2012 "Get TEMPLATE's menu binding or assign it a new one.
2014 TYPE may be `:stay', signaling this menu binding should be
2015 static in the menu."
2016 (or (yas--template-menu-binding-pair template)
2017 (let (;; (key (yas--template-key template))
2018 ;; (keybinding (yas--template-keybinding template))
2020 (setf (yas--template-menu-binding-pair template)
2021 (cons `(menu-item ,(or (yas--template-name template)
2022 (yas--template-uuid template))
2023 ,(yas--make-menu-binding template)
2026 (defun yas--template-menu-managed-by-yas-define-menu (template)
2027 "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
2028 (cdr (yas--template-menu-binding-pair template)))
2031 (defun yas--show-menu-p (mode)
2032 (cond ((eq yas-use-menu 'abbreviate)
2034 (mapcar #'(lambda (table)
2035 (yas--table-mode table))
2036 (yas--get-snippet-tables))))
2039 (defun yas--delete-from-keymap (keymap uuid)
2040 "Recursively delete items with UUID from KEYMAP and its submenus."
2042 ;; XXX: This used to skip any submenus named \"parent mode\"
2044 ;; First of all, recursively enter submenus, i.e. the tree is
2045 ;; searched depth first so that stale submenus can be found in the
2048 (mapc #'(lambda (item)
2049 (when (and (listp (cdr item))
2050 (keymapp (third (cdr item))))
2051 (yas--delete-from-keymap (third (cdr item)) uuid)))
2053 ;; Set the uuid entry to nil
2055 (define-key keymap (vector (make-symbol uuid)) nil)
2056 ;; Destructively modify keymap
2058 (setcdr keymap (delete-if #'(lambda (item)
2059 (or (null (cdr item))
2060 (and (keymapp (third (cdr item)))
2061 (null (cdr (third (cdr item)))))))
2064 (defun yas-define-menu (mode menu &optional omit-items)
2065 "Define a snippet menu for MODE according to MENU, omitting OMIT-ITEMS.
2067 MENU is a list, its elements can be:
2069 - (yas-item UUID) : Creates an entry the snippet identified with
2070 UUID. The menu entry for a snippet thus identified is
2071 permanent, i.e. it will never move (be reordered) in the menu.
2073 - (yas-separator) : Creates a separator
2075 - (yas-submenu NAME SUBMENU) : Creates a submenu with NAME,
2076 SUBMENU has the same form as MENU. NAME is also added to the
2077 list of groups of the snippets defined thereafter.
2079 OMIT-ITEMS is a list of snippet uuid's that will always be
2080 omitted from MODE's menu, even if they're manually loaded."
2081 (let* ((table (yas--table-get-create mode))
2082 (hash (yas--table-uuidhash table)))
2083 (yas--define-menu-1 table
2084 (yas--menu-keymap-get-create mode)
2087 (dolist (uuid omit-items)
2088 (let ((template (or (gethash uuid hash)
2089 (yas--populate-template (puthash uuid
2090 (yas--make-blank-template)
2094 (setf (yas--template-menu-binding-pair template) (cons nil :none))))))
2096 (defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
2097 "Helper for `yas-define-menu'."
2098 (dolist (e (reverse menu))
2099 (cond ((eq (first e) 'yas-item)
2100 (let ((template (or (gethash (second e) uuidhash)
2101 (yas--populate-template (puthash (second e)
2102 (yas--make-blank-template)
2105 :perm-group group-list
2106 :uuid (second e)))))
2107 (define-key menu-keymap (vector (gensym))
2108 (car (yas--template-menu-binding-pair-get-create template :stay)))))
2109 ((eq (first e) 'yas-submenu)
2110 (let ((subkeymap (make-sparse-keymap)))
2111 (define-key menu-keymap (vector (gensym))
2112 `(menu-item ,(second e) ,subkeymap))
2113 (yas--define-menu-1 table
2117 (append group-list (list (second e))))))
2118 ((eq (first e) 'yas-separator)
2119 (define-key menu-keymap (vector (gensym))
2120 '(menu-item "----")))
2122 (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
2124 (defun yas--define (mode key template &optional name condition group)
2125 "Define a snippet. Expanding KEY into TEMPLATE.
2127 NAME is a description to this template. Also update the menu if
2128 `yas-use-menu' is t. CONDITION is the condition attached to
2129 this snippet. If you attach a condition to a snippet, then it
2130 will only be expanded when the condition evaluated to non-nil."
2131 (yas-define-snippets mode
2132 (list (list key template name condition group))))
2134 (defun yas-hippie-try-expand (first-time?)
2135 "Integrate with hippie expand.
2137 Just put this function in `hippie-expand-try-functions-list'."
2138 (when yas-minor-mode
2139 (if (not first-time?)
2140 (let ((yas-fallback-behavior 'return-nil))
2146 ;;; Apropos condition-cache:
2151 (defvar yas--condition-cache-timestamp nil)
2152 (defmacro yas-define-condition-cache (func doc &rest body)
2153 "Define a function FUNC with doc DOC and body BODY.
2154 BODY is executed at most once every snippet expansion attempt, to check
2155 expansion conditions.
2157 It doesn't make any sense to call FUNC programatically."
2158 `(defun ,func () ,(if (and doc
2161 "\n\nFor use in snippets' conditions. Within each
2162 snippet-expansion routine like `yas-expand', computes actual
2163 value for the first time then always returns a cached value.")
2164 (setq body (cons doc body))
2166 (let ((timestamp-and-value (get ',func 'yas--condition-cache)))
2167 (if (equal (car timestamp-and-value) yas--condition-cache-timestamp)
2168 (cdr timestamp-and-value)
2169 (let ((new-value (progn
2172 (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
2175 (defalias 'yas-expand 'yas-expand-from-trigger-key)
2176 (defun yas-expand-from-trigger-key (&optional field)
2177 "Expand a snippet before point.
2179 If no snippet expansion is possible, fall back to the behaviour
2180 defined in `yas-fallback-behavior'.
2182 Optional argument FIELD is for non-interactive use and is an
2183 object satisfying `yas--field-p' to restrict the expansion to."
2185 (setq yas--condition-cache-timestamp (current-time))
2186 (let (templates-and-pos)
2187 (unless (and yas-expand-only-for-last-commands
2188 (not (member last-command yas-expand-only-for-last-commands)))
2189 (setq templates-and-pos (if field
2191 (narrow-to-region (yas--field-start field)
2192 (yas--field-end field))
2193 (yas--templates-for-key-at-point))
2194 (yas--templates-for-key-at-point))))
2195 (if templates-and-pos
2196 (yas--expand-or-prompt-for-template (first templates-and-pos)
2197 (second templates-and-pos)
2198 (third templates-and-pos))
2201 (defun yas-expand-from-keymap ()
2202 "Directly expand some snippets, searching `yas--direct-keymaps'.
2204 If expansion fails, execute the previous binding for this key"
2206 (setq yas--condition-cache-timestamp (current-time))
2207 (let* ((vec (subseq (this-command-keys-vector) (if current-prefix-arg
2208 (length (this-command-keys))
2210 (templates (mapcan #'(lambda (table)
2211 (yas--fetch table vec))
2212 (yas--get-snippet-tables))))
2214 (yas--expand-or-prompt-for-template templates)
2215 (let ((yas-fallback-behavior 'call-other-command))
2218 (defun yas--expand-or-prompt-for-template (templates &optional start end)
2219 "Expand one of TEMPLATES from START to END.
2221 Prompt the user if TEMPLATES has more than one element, else
2222 expand immediately. Common gateway for
2223 `yas-expand-from-trigger-key' and `yas-expand-from-keymap'."
2224 (let ((yas--current-template (or (and (rest templates) ;; more than one
2225 (yas--prompt-for-template (mapcar #'cdr templates)))
2227 (when yas--current-template
2228 (yas-expand-snippet (yas--template-content yas--current-template)
2231 (yas--template-expand-env yas--current-template)))))
2233 ;; Apropos the trigger key and the fallback binding:
2235 ;; When `yas-minor-mode-map' binds <tab>, that correctly overrides
2236 ;; org-mode's <tab>, for example and searching for fallbacks correctly
2237 ;; returns `org-cycle'. However, most other modes bind "TAB". TODO,
2238 ;; improve this explanation.
2240 (defun yas--fallback ()
2241 "Fallback after expansion has failed.
2243 Common gateway for `yas-expand-from-trigger-key' and
2244 `yas-expand-from-keymap'."
2245 (cond ((eq yas-fallback-behavior 'return-nil)
2248 ((eq yas-fallback-behavior 'call-other-command)
2249 (let* ((beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
2250 (yas--message 4 "Falling back to %s" beyond-yasnippet)
2251 (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
2252 (setq this-original-command beyond-yasnippet)
2253 (when beyond-yasnippet
2254 (call-interactively beyond-yasnippet))))
2255 ((and (listp yas-fallback-behavior)
2256 (cdr yas-fallback-behavior)
2257 (eq 'apply (car yas-fallback-behavior)))
2258 (if (cddr yas-fallback-behavior)
2259 (apply (cadr yas-fallback-behavior)
2260 (cddr yas-fallback-behavior))
2261 (when (commandp (cadr yas-fallback-behavior))
2262 (setq this-command (cadr yas-fallback-behavior))
2263 (call-interactively (cadr yas-fallback-behavior)))))
2265 ;; also return nil if all the other fallbacks have failed
2268 (defun yas--keybinding-beyond-yasnippet ()
2270 (let* ((yas-minor-mode nil)
2271 (yas--direct-keymaps nil)
2272 (keys (this-single-command-keys)))
2273 (or (key-binding keys t)
2274 (key-binding (yas--fallback-translate-input keys) t))))
2276 (defun yas--fallback-translate-input (keys)
2277 "Emulate `read-key-sequence', at least what I think it does.
2279 Keys should be an untranslated key vector. Returns a translated
2280 vector of keys. FIXME not thoroughly tested."
2283 (while (< i (length keys))
2285 (translated local-function-key-map))
2286 (while (and (< j (length keys))
2288 (keymapp translated))
2289 (setq translated (cdr (assoc (aref keys j) (remove 'keymap translated)))
2291 (setq retval (vconcat retval (cond ((symbolp translated)
2293 ((vectorp translated)
2296 (substring keys i j)))))
2301 ;;; Utils for snippet development:
2303 (defun yas--all-templates (tables)
2304 "Get `yas--template' objects in TABLES, applicable for buffer and point.
2306 Honours `yas-choose-tables-first', `yas-choose-keys-first' and
2307 `yas-buffer-local-condition'"
2308 (when yas-choose-tables-first
2309 (setq tables (list (yas--prompt-for-table tables))))
2311 (if yas-choose-keys-first
2312 (let ((key (yas--prompt-for-keys
2313 (mapcan #'yas--table-all-keys tables))))
2315 (mapcan #'(lambda (table)
2316 (yas--fetch table key))
2318 (remove-duplicates (mapcan #'yas--table-templates tables)
2321 (defun yas-insert-snippet (&optional no-condition)
2322 "Choose a snippet to expand, pop-up a list of choices according
2323 to `yas-prompt-functions'.
2325 With prefix argument NO-CONDITION, bypass filtering of snippets
2328 (setq yas--condition-cache-timestamp (current-time))
2329 (let* ((yas-buffer-local-condition (or (and no-condition
2331 yas-buffer-local-condition))
2332 (templates (yas--all-templates (yas--get-snippet-tables)))
2333 (yas--current-template (and templates
2334 (or (and (rest templates) ;; more than one template for same key
2335 (yas--prompt-for-template templates))
2337 (where (if (region-active-p)
2338 (cons (region-beginning) (region-end))
2339 (cons (point) (point)))))
2340 (if yas--current-template
2341 (yas-expand-snippet (yas--template-content yas--current-template)
2344 (yas--template-expand-env yas--current-template))
2345 (yas--message 3 "No snippets can be inserted here!"))))
2347 (defun yas-visit-snippet-file ()
2348 "Choose a snippet to edit, selection like `yas-insert-snippet'.
2350 Only success if selected snippet was loaded from a file. Put the
2351 visited file in `snippet-mode'."
2353 (let* ((yas-buffer-local-condition 'always)
2354 (templates (yas--all-templates (yas--get-snippet-tables)))
2355 (yas-prompt-functions '(yas-ido-prompt yas-completing-prompt))
2356 (template (and templates
2357 (or (yas--prompt-for-template templates
2358 "Choose a snippet template to edit: ")
2362 (yas--visit-snippet-file-1 template)
2363 (message "No snippets tables active!"))))
2365 (defun yas--visit-snippet-file-1 (template)
2366 "Helper for `yas-visit-snippet-file'."
2367 (let ((file (yas--template-file template)))
2368 (cond ((and file (file-readable-p file))
2369 (find-file-other-window file)
2371 (set (make-local-variable 'yas--editing-template) template))
2373 (message "Original file %s no longer exists!" file))
2375 (switch-to-buffer (format "*%s*"(yas--template-name template)))
2376 (let ((type 'snippet))
2377 (when (listp (yas--template-content template))
2378 (insert (format "# type: command\n"))
2379 (setq type 'command))
2380 (insert (format "# key: %s\n" (yas--template-key template)))
2381 (insert (format "# name: %s\n" (yas--template-name template)))
2382 (when (yas--template-keybinding template)
2383 (insert (format "# binding: %s\n" (yas--template-keybinding template))))
2384 (when (yas--template-expand-env template)
2385 (insert (format "# expand-env: %s\n" (yas--template-expand-env template))))
2386 (when (yas--template-condition template)
2387 (insert (format "# condition: %s\n" (yas--template-condition template))))
2389 (insert (if (eq type 'command)
2390 (pp-to-string (yas--template-content template))
2391 (yas--template-content template))))
2393 (set (make-local-variable 'yas--editing-template) template)))))
2395 (defun yas--guess-snippet-directories-1 (table)
2396 "Guess possible snippet subdirectories for TABLE."
2397 (cons (yas--table-name table)
2398 (mapcan #'(lambda (parent)
2399 (yas--guess-snippet-directories-1
2401 (yas--table-parents table))))
2403 (defun yas--guess-snippet-directories (&optional table)
2404 "Try to guess suitable directories based on the current active
2405 tables (or optional TABLE).
2407 Returns a list of elements (TABLE . DIRS) where TABLE is a
2408 `yas--table' object and DIRS is a list of all possible directories
2409 where snippets of table might exist."
2410 (let ((main-dir (replace-regexp-in-string
2412 (or (first (or (yas-snippet-dirs)
2413 (setq yas-snippet-dirs '("~/.emacs.d/snippets")))))))
2414 (tables (or (and table
2416 (yas--get-snippet-tables))))
2417 ;; HACK! the snippet table created here is actually registered!
2419 (unless (or table (gethash major-mode yas--tables))
2420 (push (yas--table-get-create major-mode)
2423 (mapcar #'(lambda (table)
2425 (mapcar #'(lambda (subdir)
2426 (concat main-dir "/" subdir))
2427 (yas--guess-snippet-directories-1 table))))
2430 (defun yas--make-directory-maybe (table-and-dirs &optional main-table-string)
2431 "Return a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
2432 (or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
2433 (let ((candidate (first (cdr table-and-dirs))))
2434 (unless (file-writable-p (file-name-directory candidate))
2435 (error (yas--format "%s is not writable." candidate)))
2436 (if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
2438 (if (gethash (yas--table-mode (car table-and-dirs))
2442 (or main-table-string
2444 (yas--table-name (car table-and-dirs))))
2446 (make-directory candidate 'also-make-parents)
2447 ;; create the .yas-parents file here...
2450 (defun yas-new-snippet (&optional no-template)
2451 "Pops a new buffer for writing a snippet.
2453 Expands a snippet-writing snippet, unless the optional prefix arg
2454 NO-TEMPLATE is non-nil."
2456 (let ((guessed-directories (yas--guess-snippet-directories)))
2458 (switch-to-buffer "*new snippet*")
2460 (kill-all-local-variables)
2463 (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
2464 (yas--table-mode (car d)))
2465 guessed-directories))
2466 (if (and (not no-template) yas-new-snippet-default)
2467 (yas-expand-snippet yas-new-snippet-default))))
2469 (defun yas--compute-major-mode-and-parents (file)
2470 "Given FILE, find the nearest snippet directory for a given mode.
2472 Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
2473 representing one or more of the mode's parents.
2475 Note that MODE-SYM need not be the symbol of a real major mode,
2476 neither do the elements of PARENTS."
2477 (let* ((file-dir (and file
2478 (directory-file-name (or (some #'(lambda (special)
2479 (locate-dominating-file file special))
2483 (directory-file-name (file-name-directory file))))))
2484 (parents-file-name (concat file-dir "/.yas-parents"))
2485 (major-mode-name (and file-dir
2486 (file-name-nondirectory file-dir)))
2487 (major-mode-sym (or (and major-mode-name
2488 (intern major-mode-name))))
2489 (parents (when (file-readable-p parents-file-name)
2493 (insert-file-contents parents-file-name)
2494 (buffer-substring-no-properties (point-min)
2496 (when major-mode-sym
2497 (cons major-mode-sym (remove major-mode-sym parents)))))
2499 (defvar yas--editing-template nil
2500 "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
2502 (defvar yas--current-template nil
2503 "Holds the current template being expanded into a snippet.")
2505 (defvar yas--guessed-modes nil
2506 "List of guessed modes supporting `yas-load-snippet-buffer'.")
2508 (defun yas--read-table ()
2509 "Ask user for a snippet table, help with some guessing."
2510 (let ((prompt (if (and (featurep 'ido)
2512 'ido-completing-read 'completing-read)))
2513 (unless yas--guessed-modes
2514 (set (make-local-variable 'yas--guessed-modes)
2515 (or (yas--compute-major-mode-and-parents buffer-file-name))))
2517 (funcall prompt (format "Choose or enter a table (yas guesses %s): "
2518 (if yas--guessed-modes
2519 (first yas--guessed-modes)
2521 (mapcar #'symbol-name yas--guessed-modes)
2526 (if (first yas--guessed-modes)
2527 (symbol-name (first yas--guessed-modes)))))))
2529 (defun yas-load-snippet-buffer (table &optional interactive)
2530 "Parse and load current buffer's snippet definition into TABLE.
2532 TABLE is a symbol naming a passed to `yas--table-get-create'.
2534 When called interactively, prompt for the table name."
2535 (interactive (list (yas--read-table) t))
2537 ;; We have `yas--editing-template', this buffer's content comes from a
2538 ;; template which is already loaded and neatly positioned,...
2540 (yas--editing-template
2541 (yas--define-snippets-1 (yas--parse-template (yas--template-file yas--editing-template))
2542 (yas--template-table yas--editing-template)))
2543 ;; Try to use `yas--guessed-modes'. If we don't have that use the
2544 ;; value from `yas--compute-major-mode-and-parents'
2547 (unless yas--guessed-modes
2548 (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
2549 (let* ((table (yas--table-get-create table)))
2550 (set (make-local-variable 'yas--editing-template)
2551 (yas--define-snippets-1 (yas--parse-template buffer-file-name)
2554 (yas--message 3 "Snippet \"%s\" loaded for %s."
2555 (yas--template-name yas--editing-template)
2556 (yas--table-name (yas--template-table yas--editing-template)))))
2558 (defun yas-load-snippet-buffer-and-close (table &optional kill)
2559 "Load the snippet with `yas-load-snippet-buffer', possibly
2560 save, then `quit-window' if saved.
2562 If the snippet is new, ask the user whether (and where) to save
2563 it. If the snippet already has a file, just save it.
2565 The prefix argument KILL is passed to `quit-window'.
2567 Don't use this from a Lisp program, call `yas-load-snippet-buffer'
2568 and `kill-buffer' instead."
2569 (interactive (list (yas--read-table) current-prefix-arg))
2570 (yas-load-snippet-buffer table t)
2572 ;; Only offer to save this if it looks like a library or new
2573 ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
2574 ;; which is not the first, or from an unwritable file)
2576 (not (yas--template-file yas--editing-template))
2577 (not (file-writable-p (yas--template-file yas--editing-template)))
2578 (and (listp yas-snippet-dirs)
2579 (second yas-snippet-dirs)
2580 (not (string-match (expand-file-name (first yas-snippet-dirs))
2581 (yas--template-file yas--editing-template)))))
2582 (y-or-n-p (yas--format "Looks like a library or new snippet. Save to new file? ")))
2583 (let* ((option (first (yas--guess-snippet-directories (yas--template-table yas--editing-template))))
2585 (yas--make-directory-maybe option))))
2587 (let ((default-file-name (or (and (yas--template-file yas--editing-template)
2588 (file-name-nondirectory (yas--template-file yas--editing-template)))
2589 (yas--template-name yas--editing-template))))
2590 (write-file (concat chosen "/"
2591 (read-from-minibuffer (format "File name to create in %s? " chosen)
2592 default-file-name)))
2593 (setf (yas--template-file yas--editing-template) buffer-file-name)))))
2594 (when buffer-file-name
2596 (quit-window kill)))
2598 (defun yas-tryout-snippet (&optional debug)
2599 "Test current buffer's snippet template in other buffer."
2601 (let* ((major-mode-and-parent (yas--compute-major-mode-and-parents buffer-file-name))
2602 (parsed (yas--parse-template))
2603 (test-mode (or (and (car major-mode-and-parent)
2604 (fboundp (car major-mode-and-parent))
2605 (car major-mode-and-parent))
2606 (first yas--guessed-modes)
2607 (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
2608 (yas--current-template
2611 (yas--populate-template (yas--make-blank-template)
2612 :table nil ;; no tables for ephemeral snippets
2614 :content (second parsed)
2615 :name (third parsed)
2616 :expand-env (sixth parsed)))))
2617 (cond (yas--current-template
2618 (let ((buffer-name (format "*testing snippet: %s*" (yas--template-name yas--current-template))))
2619 (kill-buffer (get-buffer-create buffer-name))
2620 (switch-to-buffer (get-buffer-create buffer-name))
2621 (setq buffer-undo-list nil)
2622 (condition-case nil (funcall test-mode) (error nil))
2624 (setq buffer-read-only nil)
2625 (yas-expand-snippet (yas--template-content yas--current-template)
2628 (yas--template-expand-env yas--current-template))
2630 (require 'yasnippet-debug nil t))
2631 (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
2633 (yas--message 3 "Cannot test snippet for unknown major mode")))))
2635 (defun yas-active-keys ()
2636 "Return all active trigger keys for current buffer and point."
2638 (remove-if-not #'stringp (mapcan #'yas--table-all-keys (yas--get-snippet-tables)))
2641 (defun yas--template-fine-group (template)
2642 (car (last (or (yas--template-group template)
2643 (yas--template-perm-group template)))))
2645 (defun yas-describe-tables (&optional choose)
2646 "Display snippets for each table."
2648 (let* ((by-name-hash (and choose
2649 (y-or-n-p "Show by namehash? ")))
2650 (buffer (get-buffer-create "*YASnippet tables*"))
2651 (active-tables (yas--get-snippet-tables))
2652 (remain-tables (let ((all))
2653 (maphash #'(lambda (_k v)
2654 (unless (find v active-tables)
2658 (table-lists (list active-tables remain-tables))
2659 (original-buffer (current-buffer))
2661 (yas--condition-cache-timestamp (current-time)))
2662 (with-current-buffer buffer
2663 (setq buffer-read-only nil)
2665 (cond ((not by-name-hash)
2666 (insert "YASnippet tables: \n")
2667 (while (and table-lists
2669 (dolist (table (car table-lists))
2670 (yas--describe-pretty-table table original-buffer))
2671 (setq table-lists (cdr table-lists))
2673 (yas--create-snippet-xrefs)
2674 (display-buffer buffer)
2675 (setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
2676 (yas--create-snippet-xrefs)
2680 (insert "\n\nYASnippet tables by NAMEHASH: \n")
2681 (dolist (table (append active-tables remain-tables))
2682 (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
2684 (maphash #'(lambda (k _v)
2686 (yas--table-hash table))
2688 (insert (format " key %s maps snippets: %s\n" key
2690 (maphash #'(lambda (k _v)
2692 (gethash key (yas--table-hash table)))
2695 (setq buffer-read-only t))
2696 (display-buffer buffer)))
2698 (defun yas--describe-pretty-table (table &optional original-buffer)
2699 (insert (format "\nSnippet table `%s'"
2700 (yas--table-name table)))
2701 (if (yas--table-parents table)
2702 (insert (format " parents: %s\n"
2703 (mapcar #'yas--table-name
2704 (yas--table-parents table))))
2706 (insert (make-string 100 ?-) "\n")
2707 (insert "group state name key binding\n")
2708 (let ((groups-hash (make-hash-table :test #'equal)))
2709 (maphash #'(lambda (_k v)
2710 (let ((group (or (yas--template-fine-group v)
2712 (when (yas--template-name v)
2714 (cons v (gethash group groups-hash))
2716 (yas--table-uuidhash table))
2718 #'(lambda (group templates)
2719 (setq group (truncate-string-to-width group 25 0 ? "..."))
2720 (insert (make-string 100 ?-) "\n")
2721 (dolist (p templates)
2722 (let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas--template-name p))
2726 (setq group (make-string (length group) ? ))))
2727 (condition-string (let ((condition (yas--template-condition p)))
2730 (with-current-buffer original-buffer
2731 (if (yas--eval-condition condition)
2736 (insert condition-string " ")
2738 (if (string-match "\\.\\.\\.$" name)
2742 (insert (truncate-string-to-width (or (yas--template-key p) "")
2744 (insert (truncate-string-to-width (key-description (yas--template-keybinding p))
2751 ;;; User convenience functions, for using in `yas-key-syntaxes'
2753 (defun yas-try-key-from-whitespace (_start-point)
2754 "As `yas-key-syntaxes' element, look for whitespace delimited key.
2756 A newline will be considered whitespace even if the mode syntax
2757 marks it as something else (typically comment ender)."
2758 (skip-chars-backward "^[:space:]\n"))
2760 (defun yas-shortest-key-until-whitespace (_start-point)
2761 "Like `yas-longest-key-from-whitespace' but take the shortest key."
2762 (when (/= (skip-chars-backward "^[:space:]\n" (1- (point))) 0)
2765 (defun yas-longest-key-from-whitespace (start-point)
2766 "As `yas-key-syntaxes' element, look for longest key between point and whitespace.
2768 A newline will be considered whitespace even if the mode syntax
2769 marks it as something else (typically comment ender)."
2770 (if (= (point) start-point)
2771 (yas-try-key-from-whitespace start-point)
2773 (unless (<= start-point (1+ (point)))
2778 ;;; User convenience functions, for using in snippet definitions
2780 (defvar yas-modified-p nil
2781 "Non-nil if field has been modified by user or transformation.")
2783 (defvar yas-moving-away-p nil
2784 "Non-nil if user is about to exit field.")
2786 (defvar yas-text nil
2787 "Contains current field text.")
2789 (defun yas-substr (str pattern &optional subexp)
2790 "Search PATTERN in STR and return SUBEXPth match.
2792 If found, the content of subexp group SUBEXP (default 0) is
2793 returned, or else the original STR will be returned."
2794 (let ((grp (or subexp 0)))
2796 (if (string-match pattern str)
2797 (match-string-no-properties grp str)
2800 (defun yas-choose-value (&rest possibilities)
2801 "Prompt for a string in POSSIBILITIES and return it.
2803 The last element of POSSIBILITIES may be a list of strings."
2804 (unless (or yas-moving-away-p
2806 (let* ((last-link (last possibilities))
2807 (last-elem (car last-link)))
2808 (when (listp last-elem)
2809 (setcar last-link (car last-elem))
2810 (setcdr last-link (cdr last-elem))))
2811 (some #'(lambda (fn)
2812 (funcall fn "Choose: " possibilities))
2813 yas-prompt-functions)))
2815 (defun yas-key-to-value (alist)
2816 (unless (or yas-moving-away-p
2818 (let ((key (read-key-sequence "")))
2820 (or (cdr (find key alist :key #'car :test #'string=))
2823 (defun yas-throw (text)
2824 "Throw a yas--exception with TEXT as the reason."
2825 (throw 'yas--exception (cons 'yas--exception text)))
2827 (defun yas-verify-value (possibilities)
2828 "Verify that the current field value is in POSSIBILITIES.
2830 Otherwise throw exception."
2831 (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
2832 (yas-throw (yas--format "Field only allows %s" possibilities))))
2834 (defun yas-field-value (number)
2835 "Get the string for field with NUMBER.
2837 Use this in primary and mirror transformations to tget."
2838 (let* ((snippet (car (yas--snippets-at-point)))
2840 (yas--snippet-find-field snippet number))))
2842 (yas--field-text-for-display field))))
2845 "Return `yas-text' if that exists and is non-empty, else nil."
2847 (not (string= "" yas-text)))
2850 (defun yas-selected-text ()
2851 "Return `yas-selected-text' if that exists and is non-empty, else nil."
2852 (if (and yas-selected-text
2853 (not (string= "" yas-selected-text)))
2856 (defun yas--get-field-once (number &optional transform-fn)
2857 (unless yas-modified-p
2859 (funcall transform-fn (yas-field-value number))
2860 (yas-field-value number))))
2862 (defun yas-default-from-field (number)
2863 (unless yas-modified-p
2864 (yas-field-value number)))
2866 (defun yas-inside-string ()
2867 "Return non-nil if the point is inside a string according to font-lock."
2868 (equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
2870 (defun yas-unimplemented (&optional missing-feature)
2871 (if yas--current-template
2872 (if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
2875 (yas--visit-snippet-file-1 yas--current-template))
2876 (message "No implementation. Missing %s" (or missing-feature "something"))))
2879 ;;; Snippet expansion and field management
2881 (defvar yas--active-field-overlay nil
2882 "Overlays the currently active field.")
2884 (defvar yas--field-protection-overlays nil
2885 "Two overlays protect the current active field.")
2887 (defvar yas-selected-text nil
2888 "The selected region deleted on the last snippet expansion.")
2890 (defvar yas--start-column nil
2891 "The column where the snippet expansion started.")
2893 (make-variable-buffer-local 'yas--active-field-overlay)
2894 (make-variable-buffer-local 'yas--field-protection-overlays)
2895 (put 'yas--active-field-overlay 'permanent-local t)
2896 (put 'yas--field-protection-overlays 'permanent-local t)
2898 (defstruct (yas--snippet (:constructor yas--make-snippet ()))
2904 (id (yas--snippet-next-id) :read-only t)
2905 (control-overlay nil)
2907 ;; stacked expansion: the `previous-active-field' slot saves the
2908 ;; active field where the child expansion took place
2909 previous-active-field
2912 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
2915 NUMBER is the field number.
2916 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2917 PARENT-FIELD is a `yas--field' this field is nested under, or nil.
2918 MIRRORS is a list of `yas--mirror's
2919 TRANSFORM is a lisp form.
2920 MODIFIED-P is a boolean set to true once user inputs text.
2921 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'.
2932 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
2935 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2936 TRANSFORM is a lisp form.
2937 PARENT-FIELD is a `yas--field' this mirror is nested under, or nil.
2938 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'
2939 DEPTH is a count of how many nested mirrors can affect this mirror"
2946 (defstruct (yas--exit (:constructor yas--make-exit (marker)))
2950 (defun yas--apply-transform (field-or-mirror field &optional empty-on-nil-p)
2951 "Calculate transformed string for FIELD-OR-MIRROR from FIELD.
2953 If there is no transform for ht field, return nil.
2955 If there is a transform but it returns nil, return the empty
2956 string iff EMPTY-ON-NIL-P is true."
2957 (let* ((yas-text (yas--field-text-for-display field))
2958 (yas-modified-p (yas--field-modified-p field))
2959 (yas-moving-away-p nil)
2960 (transform (if (yas--mirror-p field-or-mirror)
2961 (yas--mirror-transform field-or-mirror)
2962 (yas--field-transform field-or-mirror)))
2963 (start-point (if (yas--mirror-p field-or-mirror)
2964 (yas--mirror-start field-or-mirror)
2965 (yas--field-start field-or-mirror)))
2966 (transformed (and transform
2968 (goto-char start-point)
2969 (let ((ret (yas--eval-lisp transform)))
2970 (or ret (and empty-on-nil-p "")))))))
2973 (defsubst yas--replace-all (from to &optional text)
2974 "Replace all occurrences from FROM to TO.
2976 With optional string TEXT do it in that string."
2978 (replace-regexp-in-string (regexp-quote from) to text t t)
2979 (goto-char (point-min))
2980 (while (search-forward from nil t)
2981 (replace-match to t t text))))
2983 (defun yas--snippet-find-field (snippet number)
2984 (find-if #'(lambda (field)
2985 (eq number (yas--field-number field)))
2986 (yas--snippet-fields snippet)))
2988 (defun yas--snippet-sort-fields (snippet)
2989 "Sort the fields of SNIPPET in navigation order."
2990 (setf (yas--snippet-fields snippet)
2991 (sort (yas--snippet-fields snippet)
2992 #'yas--snippet-field-compare)))
2994 (defun yas--snippet-field-compare (field1 field2)
2995 "Compare FIELD1 and FIELD2.
2997 The field with a number is sorted first. If they both have a
2998 number, compare through the number. If neither have, compare
2999 through the field's start point"
3000 (let ((n1 (yas--field-number field1))
3001 (n2 (yas--field-number field2)))
3004 (or (zerop n2) (and (not (zerop n1))
3009 (< (yas--field-start field1)
3010 (yas--field-start field2))))))
3012 (defun yas--field-probably-deleted-p (snippet field)
3013 "Guess if SNIPPET's FIELD should be skipped."
3015 ;; field must be zero length
3017 (zerop (- (yas--field-start field) (yas--field-end field)))
3020 ;; 1) is a nested field and it's been modified
3022 (and (yas--field-parent-field field)
3023 (yas--field-modified-p field))
3024 ;; 2) ends just before the snippet end
3026 (and (eq field (car (last (yas--snippet-fields snippet))))
3027 (= (yas--field-start field) (overlay-end (yas--snippet-control-overlay snippet)))))
3028 ;; the field numbered 0, just before the exit marker, should
3031 (not (zerop (yas--field-number field)))))
3033 (defun yas--snippets-at-point (&optional all-snippets)
3034 "Return a sorted list of snippets at point.
3036 The most recently-inserted snippets are returned first."
3038 (remove nil (remove-duplicates (mapcar #'(lambda (ov)
3039 (overlay-get ov 'yas--snippet))
3041 (overlays-in (point-min) (point-max))
3042 (nconc (overlays-at (point)) (overlays-at (1- (point))))))))
3044 (<= (yas--snippet-id s2) (yas--snippet-id s1)))))
3046 (defun yas-next-field-or-maybe-expand ()
3047 "Try to expand a snippet at a key before point.
3049 Otherwise delegate to `yas-next-field'."
3051 (if yas-triggers-in-field
3052 (let ((yas-fallback-behavior 'return-nil)
3053 (active-field (overlay-get yas--active-field-overlay 'yas--field)))
3055 (unless (yas-expand-from-trigger-key active-field)
3059 (defun yas-next-field (&optional arg)
3060 "Navigate to the ARGth next field.
3062 If there's none, exit the snippet."
3066 (snippet (first (yas--snippets-at-point)))
3067 (active-field (overlay-get yas--active-field-overlay 'yas--field))
3068 (live-fields (remove-if #'(lambda (field)
3069 (and (not (eq field active-field))
3070 (yas--field-probably-deleted-p snippet field)))
3071 (yas--snippet-fields snippet)))
3072 (active-field-pos (position active-field live-fields))
3073 (target-pos (and active-field-pos (+ arg active-field-pos)))
3074 (target-field (and target-pos (nth target-pos live-fields))))
3075 ;; First check if we're moving out of a field with a transform
3077 (when (and active-field
3078 (yas--field-transform active-field))
3079 (let* ((yas-moving-away-p t)
3080 (yas-text (yas--field-text-for-display active-field))
3081 (yas-modified-p (yas--field-modified-p active-field)))
3082 ;; primary field transform: exit call to field-transform
3083 (yas--eval-lisp (yas--field-transform active-field))))
3084 ;; Now actually move...
3085 (cond ((and target-pos (>= target-pos (length live-fields)))
3086 (yas-exit-snippet snippet))
3088 (yas--move-to-field snippet target-field))
3092 (defun yas--place-overlays (snippet field)
3093 "Correctly place overlays for SNIPPET's FIELD."
3094 (yas--make-move-field-protection-overlays snippet field)
3095 (yas--make-move-active-field-overlay snippet field))
3097 (defun yas--move-to-field (snippet field)
3098 "Update SNIPPET to move to field FIELD.
3100 Also create some protection overlays"
3101 (goto-char (yas--field-start field))
3102 (yas--place-overlays snippet field)
3103 (overlay-put yas--active-field-overlay 'yas--field field)
3104 (let ((number (yas--field-number field)))
3105 ;; check for the special ${0: ...} field
3106 (if (and number (zerop number))
3108 (set-mark (yas--field-end field))
3109 (setf (yas--snippet-force-exit snippet)
3110 (or (yas--field-transform field)
3112 ;; make this field active
3113 (setf (yas--snippet-active-field snippet) field)
3114 ;; primary field transform: first call to snippet transform
3115 (unless (yas--field-modified-p field)
3116 (if (yas--field-update-display field)
3117 (yas--update-mirrors snippet)
3118 (setf (yas--field-modified-p field) nil))))))
3120 (defun yas-prev-field ()
3121 "Navigate to prev field. If there's none, exit the snippet."
3123 (yas-next-field -1))
3125 (defun yas-abort-snippet (&optional snippet)
3127 (let ((snippet (or snippet
3128 (car (yas--snippets-at-point)))))
3130 (setf (yas--snippet-force-exit snippet) t))))
3132 (defun yas-exit-snippet (snippet)
3133 "Goto exit-marker of SNIPPET."
3134 (interactive (list (first (yas--snippets-at-point))))
3136 (setf (yas--snippet-force-exit snippet) t)
3137 (goto-char (if (yas--snippet-exit snippet)
3138 (yas--exit-marker (yas--snippet-exit snippet))
3139 (overlay-end (yas--snippet-control-overlay snippet))))))
3141 (defun yas-exit-all-snippets ()
3142 "Exit all snippets."
3144 (mapc #'(lambda (snippet)
3145 (yas-exit-snippet snippet)
3146 (yas--check-commit-snippet))
3147 (yas--snippets-at-point 'all-snippets)))
3150 ;;; Some low level snippet-routines:
3152 (defvar yas--inhibit-overlay-hooks nil
3153 "Bind this temporarily to non-nil to prevent running `yas--on-*-modification'.")
3155 (defmacro yas--inhibit-overlay-hooks (&rest body)
3156 "Run BODY with `yas--inhibit-overlay-hooks' set to t."
3157 (declare (indent 0))
3158 `(let ((yas--inhibit-overlay-hooks t))
3161 (defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
3162 (defvar yas-snippet-end nil "End position of the last snippet committed.")
3164 (defun yas--commit-snippet (snippet)
3165 "Commit SNIPPET, but leave point as it is.
3167 This renders the snippet as ordinary text."
3169 (let ((control-overlay (yas--snippet-control-overlay snippet)))
3171 ;; Save the end of the moribund snippet in case we need to revive it
3172 ;; its original expansion.
3174 (when (and control-overlay
3175 (overlay-buffer control-overlay))
3176 (setq yas-snippet-beg (overlay-start control-overlay))
3177 (setq yas-snippet-end (overlay-end control-overlay))
3178 (delete-overlay control-overlay))
3180 (yas--inhibit-overlay-hooks
3181 (when yas--active-field-overlay
3182 (delete-overlay yas--active-field-overlay))
3183 (when yas--field-protection-overlays
3184 (mapc #'delete-overlay yas--field-protection-overlays)))
3186 ;; stacked expansion: if the original expansion took place from a
3187 ;; field, make sure we advance it here at least to
3188 ;; `yas-snippet-end'...
3190 (let ((previous-field (yas--snippet-previous-active-field snippet)))
3191 (when (and yas-snippet-end previous-field)
3192 (yas--advance-end-maybe previous-field yas-snippet-end)))
3194 ;; Convert all markers to points,
3196 (yas--markers-to-points snippet)
3198 ;; Take care of snippet revival
3200 (if yas-snippet-revival
3201 (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
3203 ;; Dismember the snippet... this is useful if we get called
3204 ;; again from `yas--take-care-of-redo'....
3205 (setf (yas--snippet-fields snippet) nil)))
3207 (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
3209 (defun yas--safely-run-hooks (hook-var)
3210 (condition-case error
3211 (run-hooks hook-var)
3213 (yas--message 3 "%s error: %s" hook-var (error-message-string error)))))
3216 (defun yas--check-commit-snippet ()
3217 "Check if point exited the currently active field of the snippet.
3219 If so cleans up the whole snippet up."
3220 (let* ((snippets (yas--snippets-at-point 'all-snippets))
3221 (snippets-left snippets)
3222 (snippet-exit-transform))
3223 (dolist (snippet snippets)
3224 (let ((active-field (yas--snippet-active-field snippet)))
3225 (setq snippet-exit-transform (yas--snippet-force-exit snippet))
3226 (cond ((or snippet-exit-transform
3227 (not (and active-field (yas--field-contains-point-p active-field))))
3228 (setq snippets-left (delete snippet snippets-left))
3229 (setf (yas--snippet-force-exit snippet) nil)
3230 (yas--commit-snippet snippet))
3232 (or (not yas--active-field-overlay)
3233 (not (overlay-buffer yas--active-field-overlay))))
3235 ;; stacked expansion: this case is mainly for recent
3236 ;; snippet exits that place us back int the field of
3240 (yas--move-to-field snippet active-field)
3241 (yas--update-mirrors snippet)))
3244 (unless (or (null snippets) snippets-left)
3245 (if snippet-exit-transform
3246 (yas--eval-lisp-no-saves snippet-exit-transform))
3247 (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
3249 ;; Apropos markers-to-points:
3251 ;; This was found useful for performance reasons, so that an
3252 ;; excessive number of live markers aren't kept around in the
3253 ;; `buffer-undo-list'. However, in `markers-to-points', the
3254 ;; set-to-nil markers can't simply be discarded and replaced with
3255 ;; fresh ones in `points-to-markers'. The original marker that was
3256 ;; just set to nil has to be reused.
3258 ;; This shouldn't bring horrible problems with undo/redo, but it
3261 (defun yas--markers-to-points (snippet)
3262 "Convert all markers in SNIPPET to a cons (POINT . MARKER)
3263 where POINT is the original position of the marker and MARKER is
3264 the original marker object with the position set to nil."
3265 (dolist (field (yas--snippet-fields snippet))
3266 (let ((start (marker-position (yas--field-start field)))
3267 (end (marker-position (yas--field-end field))))
3268 (set-marker (yas--field-start field) nil)
3269 (set-marker (yas--field-end field) nil)
3270 (setf (yas--field-start field) (cons start (yas--field-start field)))
3271 (setf (yas--field-end field) (cons end (yas--field-end field))))
3272 (dolist (mirror (yas--field-mirrors field))
3273 (let ((start (marker-position (yas--mirror-start mirror)))
3274 (end (marker-position (yas--mirror-end mirror))))
3275 (set-marker (yas--mirror-start mirror) nil)
3276 (set-marker (yas--mirror-end mirror) nil)
3277 (setf (yas--mirror-start mirror) (cons start (yas--mirror-start mirror)))
3278 (setf (yas--mirror-end mirror) (cons end (yas--mirror-end mirror))))))
3279 (let ((snippet-exit (yas--snippet-exit snippet)))
3281 (let ((exit (marker-position (yas--exit-marker snippet-exit))))
3282 (set-marker (yas--exit-marker snippet-exit) nil)
3283 (setf (yas--exit-marker snippet-exit) (cons exit (yas--exit-marker snippet-exit)))))))
3285 (defun yas--points-to-markers (snippet)
3286 "Convert all cons (POINT . MARKER) in SNIPPET to markers.
3288 This is done by setting MARKER to POINT with `set-marker'."
3289 (dolist (field (yas--snippet-fields snippet))
3290 (setf (yas--field-start field) (set-marker (cdr (yas--field-start field))
3291 (car (yas--field-start field))))
3292 (setf (yas--field-end field) (set-marker (cdr (yas--field-end field))
3293 (car (yas--field-end field))))
3294 (dolist (mirror (yas--field-mirrors field))
3295 (setf (yas--mirror-start mirror) (set-marker (cdr (yas--mirror-start mirror))
3296 (car (yas--mirror-start mirror))))
3297 (setf (yas--mirror-end mirror) (set-marker (cdr (yas--mirror-end mirror))
3298 (car (yas--mirror-end mirror))))))
3299 (let ((snippet-exit (yas--snippet-exit snippet)))
3301 (setf (yas--exit-marker snippet-exit) (set-marker (cdr (yas--exit-marker snippet-exit))
3302 (car (yas--exit-marker snippet-exit)))))))
3304 (defun yas--field-contains-point-p (field &optional point)
3305 (let ((point (or point
3307 (and (>= point (yas--field-start field))
3308 (<= point (yas--field-end field)))))
3310 (defun yas--field-text-for-display (field)
3311 "Return the propertized display text for field FIELD."
3312 (buffer-substring (yas--field-start field) (yas--field-end field)))
3314 (defun yas--undo-in-progress ()
3315 "True if some kind of undo is in progress."
3316 (or undo-in-progress
3317 (eq this-command 'undo)
3318 (eq this-command 'redo)))
3320 (defun yas--make-control-overlay (snippet start end)
3321 "Create the control overlay that surrounds the snippet and
3323 (let ((overlay (make-overlay start
3328 (overlay-put overlay 'keymap yas-keymap)
3329 (overlay-put overlay 'priority 100)
3330 (overlay-put overlay 'yas--snippet snippet)
3333 (defun yas-skip-and-clear-or-delete-char (&optional field)
3334 "Clears unmodified field if at field start, skips to next tab.
3336 Otherwise deletes a character normally by calling `delete-char'."
3338 (let ((field (or field
3339 (and yas--active-field-overlay
3340 (overlay-buffer yas--active-field-overlay)
3341 (overlay-get yas--active-field-overlay 'yas--field)))))
3343 (not (yas--field-modified-p field))
3344 (eq (point) (marker-position (yas--field-start field))))
3345 (yas--skip-and-clear field)
3348 (call-interactively 'delete-char)))))
3350 (defun yas--skip-and-clear (field)
3351 "Deletes the region of FIELD and sets it's modified state to t."
3352 ;; Just before skipping-and-clearing the field, mark its children
3353 ;; fields as modified, too. If the children have mirrors-in-fields
3354 ;; this prevents them from updating erroneously (we're skipping and
3357 (yas--mark-this-and-children-modified field)
3358 (delete-region (yas--field-start field) (yas--field-end field)))
3360 (defun yas--mark-this-and-children-modified (field)
3361 (setf (yas--field-modified-p field) t)
3362 (let ((fom (yas--field-next field)))
3364 (yas--fom-parent-field fom))
3365 (when (and (eq (yas--fom-parent-field fom) field)
3367 (yas--mark-this-and-children-modified fom))
3368 (setq fom (yas--fom-next fom)))))
3370 (defun yas--make-move-active-field-overlay (snippet field)
3371 "Place the active field overlay in SNIPPET's FIELD.
3373 Move the overlay, or create it if it does not exit."
3374 (if (and yas--active-field-overlay
3375 (overlay-buffer yas--active-field-overlay))
3376 (move-overlay yas--active-field-overlay
3377 (yas--field-start field)
3378 (yas--field-end field))
3379 (setq yas--active-field-overlay
3380 (make-overlay (yas--field-start field)
3381 (yas--field-end field)
3383 (overlay-put yas--active-field-overlay 'priority 100)
3384 (overlay-put yas--active-field-overlay 'face 'yas-field-highlight-face)
3385 (overlay-put yas--active-field-overlay 'yas--snippet snippet)
3386 (overlay-put yas--active-field-overlay 'modification-hooks '(yas--on-field-overlay-modification))
3387 (overlay-put yas--active-field-overlay 'insert-in-front-hooks
3388 '(yas--on-field-overlay-modification))
3389 (overlay-put yas--active-field-overlay 'insert-behind-hooks
3390 '(yas--on-field-overlay-modification))))
3392 (defun yas--on-field-overlay-modification (overlay after? _beg _end &optional _length)
3393 "Clears the field and updates mirrors, conditionally.
3395 Only clears the field if it hasn't been modified and it point it
3396 at field start. This hook doesn't do anything if an undo is in
3398 (unless (or yas--inhibit-overlay-hooks
3399 (yas--undo-in-progress))
3400 (let* ((field (overlay-get overlay 'yas--field))
3401 (snippet (overlay-get yas--active-field-overlay 'yas--snippet)))
3403 (yas--advance-end-maybe field (overlay-end overlay))
3405 (yas--field-update-display field))
3406 (yas--update-mirrors snippet))
3408 (when (and (not after?)
3409 (not (yas--field-modified-p field))
3410 (eq (point) (if (markerp (yas--field-start field))
3411 (marker-position (yas--field-start field))
3412 (yas--field-start field))))
3413 (yas--skip-and-clear field))
3414 (setf (yas--field-modified-p field) t))))))
3416 ;;; Apropos protection overlays:
3418 ;; These exist for nasty users who will try to delete parts of the
3419 ;; snippet outside the active field. Actual protection happens in
3420 ;; `yas--on-protection-overlay-modification'.
3422 ;; Currently this signals an error which inhibits the command. For
3423 ;; commands that move point (like `kill-line'), point is restored in
3424 ;; the `yas--post-command-handler' using a global
3425 ;; `yas--protection-violation' variable.
3427 ;; Alternatively, I've experimented with an implementation that
3428 ;; commits the snippet before actually calling `this-command'
3429 ;; interactively, and then signals an error, which is ignored. but
3430 ;; blocks all other million modification hooks. This presented some
3431 ;; problems with stacked expansion.
3433 (defun yas--make-move-field-protection-overlays (snippet field)
3434 "Place protection overlays surrounding SNIPPET's FIELD.
3436 Move the overlays, or create them if they do not exit."
3437 (let ((start (yas--field-start field))
3438 (end (yas--field-end field)))
3439 ;; First check if the (1+ end) is contained in the buffer,
3440 ;; otherwise we'll have to do a bit of cheating and silently
3441 ;; insert a newline. the `(1+ (buffer-size))' should prevent this
3442 ;; when using stacked expansion
3444 (when (< (buffer-size) end)
3446 (yas--inhibit-overlay-hooks
3447 (goto-char (point-max))
3449 ;; go on to normal overlay creation/moving
3451 (cond ((and yas--field-protection-overlays
3452 (every #'overlay-buffer yas--field-protection-overlays))
3453 (move-overlay (first yas--field-protection-overlays) (1- start) start)
3454 (move-overlay (second yas--field-protection-overlays) end (1+ end)))
3456 (setq yas--field-protection-overlays
3457 (list (make-overlay (1- start) start nil t nil)
3458 (make-overlay end (1+ end) nil t nil)))
3459 (dolist (ov yas--field-protection-overlays)
3460 (overlay-put ov 'face 'yas--field-debug-face)
3461 (overlay-put ov 'yas--snippet snippet)
3462 ;; (overlay-put ov 'evaporate t)
3463 (overlay-put ov 'modification-hooks '(yas--on-protection-overlay-modification)))))))
3465 (defvar yas--protection-violation nil
3466 "When non-nil, signals attempts to erroneously exit or modify the snippet.
3468 Functions in the `post-command-hook', for example
3469 `yas--post-command-handler' can check it and reset its value to
3470 nil. The variables value is the point where the violation
3473 (defun yas--on-protection-overlay-modification (_overlay after? _beg _end &optional _length)
3474 "Signals a snippet violation, then issues error.
3476 The error should be ignored in `debug-ignored-errors'"
3477 (unless yas--inhibit-overlay-hooks
3478 (cond ((not (or after?
3479 (yas--undo-in-progress)))
3480 (setq yas--protection-violation (point))
3481 (error "Exit the snippet first!")))))
3483 (add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
3486 ;;; Snippet expansion and "stacked" expansion:
3488 ;; Stacked expansion is when you try to expand a snippet when already
3489 ;; inside a snippet expansion.
3491 ;; The parent snippet does not run its fields modification hooks
3492 ;; (`yas--on-field-overlay-modification' and
3493 ;; `yas--on-protection-overlay-modification') while the child snippet
3494 ;; is active. This means, among other things, that the mirrors of the
3495 ;; parent snippet are not updated, this only happening when one exits
3496 ;; the child snippet.
3498 ;; Unfortunately, this also puts some ugly (and not fully-tested)
3499 ;; bits of code in `yas-expand-snippet' and
3500 ;; `yas--commit-snippet'. I've tried to mark them with "stacked
3503 ;; This was thought to be safer in an undo/redo perspective, but
3504 ;; maybe the correct implementation is to make the globals
3505 ;; `yas--active-field-overlay' and `yas--field-protection-overlays' be
3506 ;; snippet-local and be active even while the child snippet is
3507 ;; running. This would mean a lot of overlay modification hooks
3508 ;; running, but if managed correctly (including overlay priorities)
3509 ;; they should account for all situations...
3511 (defun yas-expand-snippet (content &optional start end expand-env)
3512 "Expand snippet CONTENT at current point.
3514 Text between START and END will be deleted before inserting
3515 template. EXPAND-ENV is are let-style variable to value bindings
3516 considered when expanding the snippet."
3517 (run-hooks 'yas-before-expand-snippet-hook)
3520 (let* ((yas-selected-text (or yas-selected-text
3521 (and (region-active-p)
3522 (buffer-substring-no-properties (region-beginning)
3525 (and (region-active-p)
3529 (and (region-active-p)
3532 (to-delete (and start
3534 (buffer-substring-no-properties start end)))
3537 (setq yas--indent-original-column (current-column))
3538 ;; Delete the region to delete, this *does* get undo-recorded.
3540 (when (and to-delete
3542 (delete-region start end))
3544 (cond ((listp content)
3545 ;; x) This is a snippet-command
3547 (yas--eval-lisp-no-saves content))
3549 ;; x) This is a snippet-snippet :-)
3551 ;; Narrow the region down to the content, shoosh the
3552 ;; `buffer-undo-list', and create the snippet, the new
3553 ;; snippet updates its mirrors once, so we are left with
3554 ;; some plain text. The undo action for deleting this
3555 ;; plain text will get recorded at the end.
3557 ;; stacked expansion: also shoosh the overlay modification hooks
3558 (let ((buffer-undo-list t))
3559 ;; snippet creation might evaluate users elisp, which
3560 ;; might generate errors, so we have to be ready to catch
3561 ;; them mostly to make the undo information
3563 (setq yas--start-column (current-column))
3564 (yas--inhibit-overlay-hooks
3567 (eval `(let* ,expand-env
3569 (yas--snippet-create start (point))))
3571 (yas--snippet-create start (point))))))
3573 ;; stacked-expansion: This checks for stacked expansion, save the
3574 ;; `yas--previous-active-field' and advance its boundary.
3576 (let ((existing-field (and yas--active-field-overlay
3577 (overlay-buffer yas--active-field-overlay)
3578 (overlay-get yas--active-field-overlay 'yas--field))))
3579 (when existing-field
3580 (setf (yas--snippet-previous-active-field snippet) existing-field)
3581 (yas--advance-end-maybe existing-field (overlay-end yas--active-field-overlay))))
3583 ;; Exit the snippet immediately if no fields
3585 (unless (yas--snippet-fields snippet)
3586 (yas-exit-snippet snippet))
3588 ;; Push two undo actions: the deletion of the inserted contents of
3589 ;; the new snippet (without the "key") followed by an apply of
3590 ;; `yas--take-care-of-redo' on the newly inserted snippet boundaries
3592 ;; A small exception, if `yas-also-auto-indent-first-line'
3593 ;; is t and `yas--indent' decides to indent the line to a
3594 ;; point before the actual expansion point, undo would be
3595 ;; messed up. We call the early point "newstart"". case,
3596 ;; and attempt to fix undo.
3598 (let ((newstart (overlay-start (yas--snippet-control-overlay snippet)))
3599 (end (overlay-end (yas--snippet-control-overlay snippet))))
3600 (when (< newstart start)
3601 (push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
3602 (push (cons newstart end) buffer-undo-list)
3603 (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
3605 ;; Now, schedule a move to the first field
3607 (let ((first-field (car (yas--snippet-fields snippet))))
3609 (sit-for 0) ;; fix issue 125
3610 (yas--move-to-field snippet first-field)))
3611 (yas--message 3 "snippet expanded.")
3614 (defun yas--take-care-of-redo (_beg _end snippet)
3615 "Commits SNIPPET, which in turn pushes an undo action for reviving it.
3617 Meant to exit in the `buffer-undo-list'."
3618 ;; slightly optimize: this action is only needed for snippets with
3619 ;; at least one field
3620 (when (yas--snippet-fields snippet)
3621 (yas--commit-snippet snippet)))
3623 (defun yas--snippet-revive (beg end snippet)
3624 "Revives SNIPPET and creates a control overlay from BEG to END.
3626 BEG and END are, we hope, the original snippets boundaries.
3627 All the markers/points exiting existing inside SNIPPET should point
3628 to their correct locations *at the time the snippet is revived*.
3630 After revival, push the `yas--take-care-of-redo' in the
3632 ;; Reconvert all the points to markers
3634 (yas--points-to-markers snippet)
3635 ;; When at least one editable field existed in the zombie snippet,
3636 ;; try to revive the whole thing...
3638 (let ((target-field (or (yas--snippet-active-field snippet)
3639 (car (yas--snippet-fields snippet)))))
3641 (setf (yas--snippet-control-overlay snippet) (yas--make-control-overlay snippet beg end))
3642 (overlay-put (yas--snippet-control-overlay snippet) 'yas--snippet snippet)
3644 (yas--move-to-field snippet target-field)
3646 (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
3647 buffer-undo-list))))
3649 (defun yas--snippet-create (begin end)
3650 "Create a snippet from a template inserted at BEGIN to END.
3652 Returns the newly created snippet."
3654 (narrow-to-region begin end)
3655 (let ((snippet (yas--make-snippet)))
3657 (yas--snippet-parse-create snippet)
3659 ;; Sort and link each field
3660 (yas--snippet-sort-fields snippet)
3662 ;; Create keymap overlay for snippet
3663 (setf (yas--snippet-control-overlay snippet)
3664 (yas--make-control-overlay snippet (point-min) (point-max)))
3667 (goto-char (point-max))
3672 ;;; Apropos adjacencies and "fom's":
3674 ;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
3675 ;; recently expanded snippet, we might actually have many fields,
3676 ;; mirrors (and the snippet exit) in the very same position in the
3677 ;; buffer. Therefore we need to single-link the
3678 ;; fields-or-mirrors-or-exit (which I have abbreviated to "fom")
3679 ;; according to their original positions in the buffer.
3681 ;; Then we have operation `yas--advance-end-maybe' and
3682 ;; `yas--advance-start-maybe', which conditionally push the starts and
3683 ;; ends of these foms down the chain.
3685 ;; This allows for like the printf with the magic ",":
3687 ;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
3688 ;; $2${1:$(if (string-match "%" text) "\);" "")}$0
3690 (defun yas--fom-start (fom)
3691 (cond ((yas--field-p fom)
3692 (yas--field-start fom))
3693 ((yas--mirror-p fom)
3694 (yas--mirror-start fom))
3696 (yas--exit-marker fom))))
3698 (defun yas--fom-end (fom)
3699 (cond ((yas--field-p fom)
3700 (yas--field-end fom))
3701 ((yas--mirror-p fom)
3702 (yas--mirror-end fom))
3704 (yas--exit-marker fom))))
3706 (defun yas--fom-next (fom)
3707 (cond ((yas--field-p fom)
3708 (yas--field-next fom))
3709 ((yas--mirror-p fom)
3710 (yas--mirror-next fom))
3712 (yas--exit-next fom))))
3714 (defun yas--fom-parent-field (fom)
3715 (cond ((yas--field-p fom)
3716 (yas--field-parent-field fom))
3717 ((yas--mirror-p fom)
3718 (yas--mirror-parent-field fom))
3722 (defun yas--calculate-adjacencies (snippet)
3723 "Calculate adjacencies for fields or mirrors of SNIPPET.
3725 This is according to their relative positions in the buffer, and
3726 has to be called before the $-constructs are deleted."
3727 (let* ((fom-set-next-fom
3728 (lambda (fom nextfom)
3729 (cond ((yas--field-p fom)
3730 (setf (yas--field-next fom) nextfom))
3731 ((yas--mirror-p fom)
3732 (setf (yas--mirror-next fom) nextfom))
3734 (setf (yas--exit-next fom) nextfom)))))
3737 (if (= (yas--fom-start fom2) (yas--fom-start fom1))
3738 (yas--mirror-p fom2)
3739 (>= (yas--fom-start fom2) (yas--fom-start fom1)))))
3740 (link-foms fom-set-next-fom))
3741 ;; make some yas--field, yas--mirror and yas--exit soup
3743 (when (yas--snippet-exit snippet)
3744 (push (yas--snippet-exit snippet) soup))
3745 (dolist (field (yas--snippet-fields snippet))
3747 (dolist (mirror (yas--field-mirrors field))
3748 (push mirror soup)))
3750 (sort soup compare-fom-begs))
3752 (reduce link-foms soup)))))
3754 (defun yas--calculate-mirrors-in-fields (snippet mirror)
3755 "Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
3757 Use the tightest containing field if more than one field contains
3758 the mirror. Intended to be called *before* the dollar-regions are
3760 (let ((min (point-min))
3762 (dolist (field (yas--snippet-fields snippet))
3763 (when (and (<= (yas--field-start field) (yas--mirror-start mirror))
3764 (<= (yas--mirror-end mirror) (yas--field-end field))
3765 (< min (yas--field-start field))
3766 (< (yas--field-end field) max))
3767 (setq min (yas--field-start field)
3768 max (yas--field-end field))
3769 (setf (yas--mirror-parent-field mirror) field)))))
3771 (defun yas--advance-end-maybe (fom newend)
3772 "Maybe advance FOM's end to NEWEND if it needs it.
3776 * call `yas--advance-start-maybe' on FOM's next fom.
3778 * in case FOM is field call `yas--advance-end-maybe' on its parent
3781 Also, if FOM is an exit-marker, always call
3782 `yas--advance-start-maybe' on its next fom. This is because
3783 exit-marker have identical start and end markers."
3784 (cond ((and fom (< (yas--fom-end fom) newend))
3785 (set-marker (yas--fom-end fom) newend)
3786 (yas--advance-start-maybe (yas--fom-next fom) newend)
3787 (yas--advance-end-of-parents-maybe (yas--fom-parent-field fom) newend))
3789 (yas--advance-start-maybe (yas--fom-next fom) newend))))
3791 (defun yas--advance-start-maybe (fom newstart)
3792 "Maybe advance FOM's start to NEWSTART if it needs it.
3794 If it does, also call `yas--advance-end-maybe' on FOM."
3795 (when (and fom (< (yas--fom-start fom) newstart))
3796 (set-marker (yas--fom-start fom) newstart)
3797 (yas--advance-end-maybe fom newstart)))
3799 (defun yas--advance-end-of-parents-maybe (field newend)
3800 "Like `yas--advance-end-maybe' but for parent fields.
3802 Only works for fields and doesn't care about the start of the
3803 next FOM. Works its way up recursively for parents of parents."
3805 (< (yas--field-end field) newend))
3806 (set-marker (yas--field-end field) newend)
3807 (yas--advance-end-of-parents-maybe (yas--field-parent-field field) newend)))
3809 (defvar yas--dollar-regions nil
3810 "When expanding the snippet the \"parse-create\" functions add
3811 cons cells to this var.")
3813 (defvar yas--backquote-markers-and-strings nil
3814 "List of (MARKER . STRING) marking where the values from
3815 backquoted Lisp expressions should be inserted at the end of
3818 (defun yas--snippet-parse-create (snippet)
3819 "Parse a recently inserted snippet template, creating all
3820 necessary fields, mirrors and exit points.
3822 Meant to be called in a narrowed buffer, does various passes"
3823 (let ((parse-start (point)))
3824 ;; Reset the yas--dollar-regions
3826 (setq yas--dollar-regions nil)
3827 ;; protect just the backquotes
3829 (yas--protect-escapes nil '(?`))
3830 ;; replace all backquoted expressions
3832 (goto-char parse-start)
3833 (yas--save-backquotes)
3834 ;; protect escaped characters
3836 (yas--protect-escapes)
3837 ;; parse fields with {}
3839 (goto-char parse-start)
3840 (yas--field-parse-create snippet)
3841 ;; parse simple mirrors and fields
3843 (goto-char parse-start)
3844 (yas--simple-mirror-parse-create snippet)
3845 ;; parse mirror transforms
3847 (goto-char parse-start)
3848 (yas--transform-mirror-parse-create snippet)
3849 ;; calculate adjacencies of fields and mirrors
3851 (yas--calculate-adjacencies snippet)
3852 ;; Delete $-constructs
3854 (save-restriction (widen) (yas--delete-regions yas--dollar-regions))
3855 ;; restore backquoted expression values
3857 (yas--restore-backquotes)
3860 (goto-char parse-start)
3861 (yas--restore-escapes)
3862 ;; update mirrors for the first time
3864 (yas--update-mirrors snippet)
3865 ;; indent the best we can
3867 (goto-char parse-start)
3868 (yas--indent snippet)))
3870 (defun yas--indent-according-to-mode (snippet-markers)
3871 "Indent current line according to mode, preserving SNIPPET-MARKERS."
3872 ;;; Apropos indenting problems....
3874 ;; `indent-according-to-mode' uses whatever `indent-line-function'
3875 ;; is available. Some implementations of these functions delete text
3876 ;; before they insert. If there happens to be a marker just after
3877 ;; the text being deleted, the insertion actually happens after the
3878 ;; marker, which misplaces it.
3880 ;; This would also happen if we had used overlays with the
3881 ;; `front-advance' property set to nil.
3883 ;; This is why I have these `trouble-markers', they are the ones at
3884 ;; they are the ones at the first non-whitespace char at the line
3885 ;; (i.e. at `yas--real-line-beginning'. After indentation takes place
3886 ;; we should be at the correct to restore them to. All other
3887 ;; non-trouble-markers have been *pushed* and don't need special
3890 (goto-char (yas--real-line-beginning))
3891 (let ((trouble-markers (remove-if-not #'(lambda (marker)
3897 (indent-according-to-mode)
3898 (error (yas--message 3 "Warning: `yas--indent-according-to-mode' having problems running %s" indent-line-function)
3900 (mapc #'(lambda (marker)
3901 (set-marker marker (point)))
3904 (defvar yas--indent-original-column nil)
3905 (defun yas--indent (snippet)
3906 (let ((snippet-markers (yas--collect-snippet-markers snippet)))
3907 ;; Look for those $>
3909 (while (re-search-forward "$>" nil t)
3910 (delete-region (match-beginning 0) (match-end 0))
3911 (when (not (eq yas-indent-line 'auto))
3912 (yas--indent-according-to-mode snippet-markers))))
3913 ;; Now do stuff for 'fixed and 'auto
3915 (cond ((eq yas-indent-line 'fixed)
3916 (while (and (zerop (forward-line))
3917 (zerop (current-column)))
3918 (indent-to-column yas--indent-original-column)))
3919 ((eq yas-indent-line 'auto)
3920 (let ((end (set-marker (make-marker) (point-max)))
3921 (indent-first-line-p yas-also-auto-indent-first-line))
3922 (while (and (zerop (if indent-first-line-p
3925 (setq indent-first-line-p nil))
3929 (yas--indent-according-to-mode snippet-markers))))
3933 (defun yas--collect-snippet-markers (snippet)
3934 "Make a list of all the markers used by SNIPPET."
3936 (dolist (field (yas--snippet-fields snippet))
3937 (push (yas--field-start field) markers)
3938 (push (yas--field-end field) markers)
3939 (dolist (mirror (yas--field-mirrors field))
3940 (push (yas--mirror-start mirror) markers)
3941 (push (yas--mirror-end mirror) markers)))
3942 (let ((snippet-exit (yas--snippet-exit snippet)))
3943 (when (and snippet-exit
3944 (marker-buffer (yas--exit-marker snippet-exit)))
3945 (push (yas--exit-marker snippet-exit) markers)))
3948 (defun yas--real-line-beginning ()
3949 (let ((c (char-after (line-beginning-position)))
3950 (n (line-beginning-position)))
3951 (while (or (eql c ?\ )
3954 (setq c (char-after n)))
3957 (defun yas--escape-string (escaped)
3958 (concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
3960 (defun yas--protect-escapes (&optional text escaped)
3961 "Protect all escaped characters with their numeric ASCII value.
3963 With optional string TEXT do it in string instead of buffer."
3964 (let ((changed-text text)
3965 (text-provided-p text))
3966 (mapc #'(lambda (escaped)
3968 (yas--replace-all (concat "\\" (char-to-string escaped))
3969 (yas--escape-string escaped)
3970 (when text-provided-p changed-text))))
3971 (or escaped yas--escaped-characters))
3974 (defun yas--restore-escapes (&optional text escaped)
3975 "Restore all escaped characters from their numeric ASCII value.
3977 With optional string TEXT do it in string instead of the buffer."
3978 (let ((changed-text text)
3979 (text-provided-p text))
3980 (mapc #'(lambda (escaped)
3982 (yas--replace-all (yas--escape-string escaped)
3983 (char-to-string escaped)
3984 (when text-provided-p changed-text))))
3985 (or escaped yas--escaped-characters))
3988 (defun yas--save-backquotes ()
3989 "Save all the \"`(lisp-expression)`\"-style expressions
3990 with their evaluated value into `yas--backquote-markers-and-strings'."
3991 (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
3992 (let ((current-string (match-string-no-properties 1)) transformed)
3993 (save-restriction (widen)
3994 (delete-region (match-beginning 0) (match-end 0)))
3995 (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
3996 (goto-char (match-beginning 0))
3998 (let ((marker (make-marker)))
4001 (insert "Y") ;; quite horrendous, I love it :)
4002 (set-marker marker (point))
4004 (push (cons marker transformed) yas--backquote-markers-and-strings))))))
4006 (defun yas--restore-backquotes ()
4007 "Replace markers in `yas--backquote-markers-and-strings' with their values."
4008 (while yas--backquote-markers-and-strings
4009 (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
4010 (marker (car marker-and-string))
4011 (string (cdr marker-and-string)))
4019 (set-marker marker nil)))))
4021 (defun yas--scan-sexps (from count)
4023 (with-syntax-table (standard-syntax-table)
4024 (scan-sexps from count))
4028 (defun yas--make-marker (pos)
4029 "Create a marker at POS with nil `marker-insertion-type'."
4030 (let ((marker (set-marker (make-marker) pos)))
4031 (set-marker-insertion-type marker nil)
4034 (defun yas--field-parse-create (snippet &optional parent-field)
4035 "Parse most field expressions in SNIPPET, except for the simple one \"$n\".
4037 The following count as a field:
4039 * \"${n: text}\", for a numbered field with default text, as long as N is not 0;
4041 * \"${n: text$(expression)}, the same with a Lisp expression;
4042 this is caught with the curiously named `yas--multi-dollar-lisp-expression-regexp'
4044 * the same as above but unnumbered, (no N:) and number is calculated automatically.
4046 When multiple expressions are found, only the last one counts."
4049 (while (re-search-forward yas--field-regexp nil t)
4050 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4051 (number (and (match-string-no-properties 1)
4052 (string-to-number (match-string-no-properties 1))))
4053 (brand-new-field (and real-match-end-0
4054 ;; break if on "$(" immediately
4055 ;; after the ":", this will be
4056 ;; caught as a mirror with
4058 (not (save-match-data
4059 (eq (string-match "$[ \t\n]*("
4060 (match-string-no-properties 2)) 0)))
4061 ;; allow ${0: some exit text}
4062 ;; (not (and number (zerop number)))
4063 (yas--make-field number
4064 (yas--make-marker (match-beginning 2))
4065 (yas--make-marker (1- real-match-end-0))
4067 (when brand-new-field
4068 (goto-char real-match-end-0)
4069 (push (cons (1- real-match-end-0) real-match-end-0)
4070 yas--dollar-regions)
4071 (push (cons (match-beginning 0) (match-beginning 2))
4072 yas--dollar-regions)
4073 (push brand-new-field (yas--snippet-fields snippet))
4076 (narrow-to-region (yas--field-start brand-new-field) (yas--field-end brand-new-field))
4077 (goto-char (point-min))
4078 (yas--field-parse-create snippet brand-new-field)))))))
4079 ;; if we entered from a parent field, now search for the
4080 ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
4081 ;; primary field transformations
4085 (while (re-search-forward yas--multi-dollar-lisp-expression-regexp nil t)
4086 (let* ((real-match-end-1 (yas--scan-sexps (match-beginning 1) 1)))
4087 ;; commit the primary field transformation if:
4089 ;; 1. we don't find it in yas--dollar-regions (a subnested
4090 ;; field) might have already caught it.
4092 ;; 2. we really make sure we have either two '$' or some
4093 ;; text and a '$' after the colon ':'. This is a FIXME: work
4094 ;; my regular expressions and end these ugly hacks.
4096 (when (and real-match-end-1
4097 (not (member (cons (match-beginning 0)
4099 yas--dollar-regions))
4101 (char-before (1- (match-beginning 1))))))
4102 (let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
4104 (setf (yas--field-transform parent-field)
4105 (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
4106 (push (cons (match-beginning 0) real-match-end-1)
4107 yas--dollar-regions)))))))
4109 (defun yas--transform-mirror-parse-create (snippet)
4110 "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
4111 (while (re-search-forward yas--transform-mirror-regexp nil t)
4112 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4113 (number (string-to-number (match-string-no-properties 1)))
4115 (not (zerop number))
4116 (yas--snippet-find-field snippet number)))
4118 (and real-match-end-0
4120 (yas--make-mirror (yas--make-marker (match-beginning 0))
4121 (yas--make-marker (match-beginning 0))
4123 (yas--restore-escapes
4124 (buffer-substring-no-properties (match-beginning 2)
4125 (1- real-match-end-0))))))))
4126 (when brand-new-mirror
4127 (push brand-new-mirror
4128 (yas--field-mirrors field))
4129 (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
4130 (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
4132 (defun yas--simple-mirror-parse-create (snippet)
4133 "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
4134 (while (re-search-forward yas--simple-mirror-regexp nil t)
4135 (let ((number (string-to-number (match-string-no-properties 1))))
4136 (cond ((zerop number)
4138 (setf (yas--snippet-exit snippet)
4139 (yas--make-exit (yas--make-marker (match-end 0))))
4141 (goto-char (match-beginning 0))
4142 (when yas-wrap-around-region
4143 (cond (yas-selected-text
4144 (insert yas-selected-text))
4145 ((and (eq yas-wrap-around-region 'cua)
4148 (insert (prog1 (get-register ?0)
4149 (set-register ?0 nil))))))
4150 (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
4151 yas--dollar-regions)))
4153 (let ((field (yas--snippet-find-field snippet number)))
4155 (let ((brand-new-mirror (yas--make-mirror
4156 (yas--make-marker (match-beginning 0))
4157 (yas--make-marker (match-beginning 0))
4159 (push brand-new-mirror
4160 (yas--field-mirrors field))
4161 (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
4162 (push (yas--make-field number
4163 (yas--make-marker (match-beginning 0))
4164 (yas--make-marker (match-beginning 0))
4166 (yas--snippet-fields snippet))))
4167 (push (cons (match-beginning 0) (match-end 0))
4168 yas--dollar-regions))))))
4170 (defun yas--delete-regions (regions)
4171 "Sort disjuct REGIONS by start point, then delete from the back."
4172 (mapc #'(lambda (reg)
4173 (delete-region (car reg) (cdr reg)))
4176 (>= (car r1) (car r2))))))
4178 (defun yas--calculate-mirror-depth (mirror &optional traversed)
4179 (let* ((parent (yas--mirror-parent-field mirror))
4180 (parents-mirrors (and parent
4181 (yas--field-mirrors parent))))
4182 (or (yas--mirror-depth mirror)
4183 (setf (yas--mirror-depth mirror)
4184 (cond ((memq mirror traversed)
4186 ((and parent parents-mirrors)
4188 (mapcar #'(lambda (m)
4189 (yas--calculate-mirror-depth m
4198 (defun yas--update-mirrors (snippet)
4199 "Update all the mirrors of SNIPPET."
4201 (dolist (field-and-mirror (sort
4202 ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
4203 ;; where F is the field that M is mirroring
4205 (mapcan #'(lambda (field)
4206 (mapcar #'(lambda (mirror)
4207 (cons field mirror))
4208 (yas--field-mirrors field)))
4209 (yas--snippet-fields snippet))
4210 ;; then sort this list so that entries with mirrors with parent
4211 ;; fields appear before. This was important for fixing #290, and
4212 ;; luckily also handles the case where a mirror in a field causes
4213 ;; another mirror to need reupdating
4215 #'(lambda (field-and-mirror1 field-and-mirror2)
4216 (> (yas--calculate-mirror-depth (cdr field-and-mirror1))
4217 (yas--calculate-mirror-depth (cdr field-and-mirror2))))))
4218 (let* ((field (car field-and-mirror))
4219 (mirror (cdr field-and-mirror))
4220 (parent-field (yas--mirror-parent-field mirror)))
4221 ;; before updating a mirror with a parent-field, maybe advance
4225 (yas--advance-start-maybe mirror (yas--fom-start parent-field)))
4226 ;; update this mirror
4228 (yas--mirror-update-display mirror field)
4229 ;; `yas--place-overlays' is needed if the active field and
4230 ;; protected overlays have been changed because of insertions
4231 ;; in `yas--mirror-update-display'
4233 (when (eq field (yas--snippet-active-field snippet))
4234 (yas--place-overlays snippet field))))))
4236 (defun yas--mirror-update-display (mirror field)
4237 "Update MIRROR according to FIELD (and mirror transform)."
4239 (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
4240 (reflection (and (not (and mirror-parent-field
4241 (yas--field-modified-p mirror-parent-field)))
4242 (or (yas--apply-transform mirror field 'empty-on-nil)
4243 (yas--field-text-for-display field)))))
4244 (when (and reflection
4245 (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
4246 (yas--mirror-end mirror)))))
4247 (goto-char (yas--mirror-start mirror))
4248 (yas--inhibit-overlay-hooks
4249 (insert reflection))
4250 (if (> (yas--mirror-end mirror) (point))
4251 (delete-region (point) (yas--mirror-end mirror))
4252 (set-marker (yas--mirror-end mirror) (point))
4253 (yas--advance-start-maybe (yas--mirror-next mirror) (point))
4254 ;; super-special advance
4255 (yas--advance-end-of-parents-maybe mirror-parent-field (point))))))
4257 (defun yas--field-update-display (field)
4258 "Much like `yas--mirror-update-display', but for fields."
4259 (when (yas--field-transform field)
4260 (let ((transformed (and (not (eq (yas--field-number field) 0))
4261 (yas--apply-transform field field))))
4262 (when (and transformed
4263 (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
4264 (yas--field-end field)))))
4265 (setf (yas--field-modified-p field) t)
4266 (goto-char (yas--field-start field))
4267 (yas--inhibit-overlay-hooks
4268 (insert transformed)
4269 (if (> (yas--field-end field) (point))
4270 (delete-region (point) (yas--field-end field))
4271 (set-marker (yas--field-end field) (point))
4272 (yas--advance-start-maybe (yas--field-next field) (point)))
4276 ;;; Post-command hook:
4278 (defun yas--post-command-handler ()
4279 "Handles various yasnippet conditions after each command."
4280 (cond (yas--protection-violation
4281 (goto-char yas--protection-violation)
4282 (setq yas--protection-violation nil))
4283 ((eq 'undo this-command)
4285 ;; After undo revival the correct field is sometimes not
4286 ;; restored correctly, this condition handles that
4288 (let* ((snippet (car (yas--snippets-at-point)))
4289 (target-field (and snippet
4290 (find-if-not #'(lambda (field)
4291 (yas--field-probably-deleted-p snippet field))
4293 (cons (yas--snippet-active-field snippet)
4294 (yas--snippet-fields snippet)))))))
4296 (yas--move-to-field snippet target-field))))
4297 ((not (yas--undo-in-progress))
4298 ;; When not in an undo, check if we must commit the snippet
4299 ;; (user exited it).
4300 (yas--check-commit-snippet))))
4304 ;; The docstrings for some functions are generated dynamically
4305 ;; depending on the context.
4307 (put 'yas-expand 'function-documentation
4308 '(yas--expand-from-trigger-key-doc t))
4309 (defun yas--expand-from-trigger-key-doc (context)
4310 "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
4311 (let* ((yas-fallback-behavior (and context yas-fallback-behavior))
4312 (fallback-description
4313 (cond ((eq yas-fallback-behavior 'call-other-command)
4314 (let* ((fallback (yas--keybinding-beyond-yasnippet)))
4316 (format "call command `%s'."
4317 (pp-to-string fallback)))
4318 "do nothing (`yas-expand' doesn't shadow\nanything).")))
4319 ((eq yas-fallback-behavior 'return-nil)
4321 (t "defer to `yas-fallback-behavior' (which see)."))))
4322 (concat "Expand a snippet before point. If no snippet
4323 expansion is possible, "
4324 fallback-description
4325 "\n\nOptional argument FIELD is for non-interactive use and is an
4326 object satisfying `yas--field-p' to restrict the expansion to.")))
4328 (put 'yas-expand-from-keymap 'function-documentation
4329 '(yas--expand-from-keymap-doc t))
4330 (defun yas--expand-from-keymap-doc (context)
4331 "A doc synthesizer for `yas--expand-from-keymap-doc'."
4332 (add-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce)
4333 (concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
4334 (when (and context (eq this-command 'describe-key))
4335 (let* ((vec (this-single-command-keys))
4336 (templates (mapcan #'(lambda (table)
4337 (yas--fetch table vec))
4338 (yas--get-snippet-tables)))
4339 (yas--direct-keymaps nil)
4340 (fallback (key-binding vec)))
4341 (concat "In this case, "
4343 (concat "these snippets are bound to this key:\n"
4344 (yas--template-pretty-list templates)
4345 "\n\nIf none of these expands, "))
4347 (format "fallback `%s' will be called." (pp-to-string fallback)))
4348 "no fallback keybinding is called."))))))
4350 (defun yas--template-pretty-list (templates)
4352 (yas-buffer-local-condition 'always))
4353 (dolist (plate templates)
4354 (setq acc (concat acc "\n*) "
4355 (propertize (concat "\\\\snippet `" (car plate) "'")
4356 'yasnippet (cdr plate)))))
4359 (define-button-type 'help-snippet-def
4360 :supertype 'help-xref
4361 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
4362 'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
4364 (defun yas--snippet-description-finish-runonce ()
4365 "Final adjustments for the help buffer when snippets are concerned."
4366 (yas--create-snippet-xrefs)
4367 (remove-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce))
4369 (defun yas--create-snippet-xrefs ()
4371 (goto-char (point-min))
4372 (while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
4373 (let ((template (get-text-property (match-beginning 1)
4376 (help-xref-button 1 'help-snippet-def template)
4377 (kill-region (match-end 1) (match-end 0))
4378 (kill-region (match-beginning 0) (match-beginning 1)))))))
4382 (defvar yas-verbosity 4
4383 "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
4385 (defun yas--message (level message &rest args)
4386 "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
4387 (when (> yas-verbosity level)
4388 (message "%s" (apply #'yas--format message args))))
4390 (defun yas--warning (format-control &rest format-args)
4391 (let ((msg (apply #'format format-control format-args)))
4392 (display-warning 'yasnippet msg :warning)
4393 (yas--message 1 msg)))
4395 (defun yas--format (format-control &rest format-args)
4396 (apply #'format (concat "[yas] " format-control) format-args))
4403 ;; `locate-dominating-file'
4404 ;; `region-active-p'
4406 ;; added for compatibility in emacsen < 23
4407 (unless (>= emacs-major-version 23)
4408 (unless (fboundp 'region-active-p)
4409 (defun region-active-p () (and transient-mark-mode mark-active)))
4411 (unless (fboundp 'locate-dominating-file)
4412 (defvar locate-dominating-stop-dir-regexp
4413 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
4414 "Regexp of directory names which stop the search in `locate-dominating-file'.
4415 Any directory whose name matches this regexp will be treated like
4416 a kind of root directory by `locate-dominating-file' which will stop its search
4417 when it bumps into it.
4418 The default regexp prevents fruitless and time-consuming attempts to find
4419 special files in directories in which filenames are interpreted as hostnames,
4420 or mount points potentially requiring authentication as a different user.")
4422 (defun locate-dominating-file (file name)
4423 "Look up the directory hierarchy from FILE for a file named NAME.
4424 Stop at the first parent directory containing a file NAME,
4425 and return the directory. Return nil if not found."
4426 ;; We used to use the above locate-dominating-files code, but the
4427 ;; directory-files call is very costly, so we're much better off doing
4428 ;; multiple calls using the code in here.
4430 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
4431 ;; `name' in /home or in /.
4432 (setq file (abbreviate-file-name file))
4435 (while (not (or root
4437 ;; FIXME: Disabled this heuristic because it is sometimes
4439 ;; As a heuristic, we stop looking up the hierarchy of
4440 ;; directories as soon as we find a directory belonging
4441 ;; to another user. This should save us from looking in
4442 ;; things like /net and /afs. This assumes that all the
4443 ;; files inside a project belong to the same user.
4444 ;; (let ((prev-user user))
4445 ;; (setq user (nth 2 (file-attributes file)))
4446 ;; (and prev-user (not (equal user prev-user))))
4447 (string-match locate-dominating-stop-dir-regexp file)))
4448 (setq try (file-exists-p (expand-file-name name file)))
4449 (cond (try (setq root file))
4450 ((equal file (setq file (file-name-directory
4451 (directory-file-name file))))
4456 ;;; Backward compatibility to yasnippet <= 0.7
4458 (defvar yas--backported-syms '(;; `defcustom's
4461 yas-prompt-functions
4463 yas-also-auto-indent-first-line
4465 yas-triggers-in-field
4466 yas-fallback-behavior
4467 yas-choose-keys-first
4468 yas-choose-tables-first
4471 yas-wrap-around-region
4474 yas-expand-only-for-last-commands
4475 yas-field-highlight-face
4477 ;; these vars can be customized as well
4483 yas-after-exit-snippet-hook
4484 yas-before-expand-snippet-hook
4485 yas-buffer-local-condition
4488 ;; prompting functions
4493 yas-completing-prompt
4496 ;; interactive functions
4501 yas-direct-keymaps-reload
4505 yas-compile-directory
4508 yas-expand-from-trigger-key
4509 yas-expand-from-keymap
4511 yas-visit-snippet-file
4513 yas-load-snippet-buffer
4516 yas-next-field-or-maybe-expand
4521 yas-exit-all-snippets
4522 yas-skip-and-clear-or-delete-char
4524 ;; symbols that I "exported" for use
4525 ;; in snippets and hookage
4542 yas-default-from-field
4545 yas-define-condition-cache
4546 yas-hippie-try-expand
4548 ;; debug definitions
4549 ;; yas-debug-snippet-vars
4550 ;; yas-exterminate-package
4553 ;; testing definitions
4554 ;; yas-should-expand
4555 ;; yas-should-not-expand
4557 ;; yas-make-file-or-dirs
4559 ;; yas-saving-variables
4560 ;; yas-call-with-snippet-dirs
4561 ;; yas-with-snippet-dirs
4563 "Backported yasnippet symbols.
4565 They are mapped to \"yas/*\" variants.")
4567 (dolist (sym yas--backported-syms)
4568 (let ((backported (intern (replace-regexp-in-string "^yas-" "yas/" (symbol-name sym)))))
4570 (make-obsolete-variable backported sym "yasnippet 0.8")
4571 (defvaralias backported sym))
4573 (make-obsolete backported sym "yasnippet 0.8")
4574 (defalias backported sym))))
4576 (defvar yas--exported-syms
4578 (mapatoms (lambda (atom)
4579 (if (and (or (and (boundp atom)
4580 (not (get atom 'byte-obsolete-variable)))
4582 (not (get atom 'byte-obsolete-info))))
4583 (string-match-p "^yas-[^-]" (symbol-name atom)))
4584 (push atom exported))))
4586 "Exported yasnippet symbols.
4588 i.e. the ones with \"yas-\" single dash prefix. I will try to
4589 keep them in future yasnippet versions and other elisp libraries
4590 can more or less safely rely upon them.")
4593 (provide 'yasnippet)
4595 ;;; yasnippet.el ends here
4598 ;; byte-compile-warnings: (not cl-functions)