1 ;;; yasnippet.el --- Yet another snippet extension for Emacs.
3 ;; Copyright (C) 2008-2016 Free Software Foundation, Inc.
4 ;; Authors: pluskid <pluskid@gmail.com>,
5 ;; João Távora <joaotavora@gmail.com>,
6 ;; Noam Postavsky <npostavs@gmail.com>
7 ;; Maintainer: Noam Postavsky <npostavs@gmail.com>
9 ;; X-URL: http://github.com/capitaomorte/yasnippet
10 ;; Keywords: convenience, emulation
11 ;; URL: http://github.com/capitaomorte/yasnippet
12 ;; Package-Requires: ((cl-lib "0.5"))
13 ;; EmacsWiki: YaSnippetMode
15 ;; This program is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; This program is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
30 ;; Basic steps to setup:
32 ;; (add-to-list 'load-path
33 ;; "~/path-to-yasnippet")
34 ;; (require 'yasnippet)
35 ;; (yas-global-mode 1)
38 ;; Interesting variables are:
42 ;; The directory where user-created snippets are to be
43 ;; stored. Can also be a list of directories. In that case,
44 ;; when used for bulk (re)loading of snippets (at startup or
45 ;; via `yas-reload-all'), directories appearing earlier in
46 ;; the list override other dir's snippets. Also, the first
47 ;; directory is taken as the default for storing the user's
50 ;; The deprecated `yas/root-directory' aliases this variable
51 ;; for backward-compatibility.
54 ;; Major commands are:
58 ;; Try to expand snippets before point. In `yas-minor-mode',
59 ;; this is normally bound to TAB, but you can customize it in
60 ;; `yas-minor-mode-map'.
62 ;; M-x yas-load-directory
64 ;; Prompts you for a directory hierarchy of snippets to load.
66 ;; M-x yas-activate-extra-mode
68 ;; Prompts you for an extra mode to add snippets for in the
71 ;; M-x yas-insert-snippet
73 ;; Prompts you for possible snippet expansion if that is
74 ;; possible according to buffer-local and snippet-local
75 ;; expansion conditions. With prefix argument, ignore these
78 ;; M-x yas-visit-snippet-file
80 ;; Prompts you for possible snippet expansions like
81 ;; `yas-insert-snippet', but instead of expanding it, takes
82 ;; you directly to the snippet definition's file, if it
85 ;; M-x yas-new-snippet
87 ;; Lets you create a new snippet file in the correct
88 ;; subdirectory of `yas-snippet-dirs', according to the
91 ;; M-x yas-load-snippet-buffer
93 ;; When editing a snippet, this loads the snippet. This is
94 ;; bound to "C-c C-c" while in the `snippet-mode' editing
97 ;; M-x yas-tryout-snippet
99 ;; When editing a snippet, this opens a new empty buffer,
100 ;; sets it to the appropriate major mode and inserts the
101 ;; snippet there, so you can see what it looks like. This is
102 ;; bound to "C-c C-t" while in `snippet-mode'.
104 ;; M-x yas-describe-tables
106 ;; Lists known snippets in a separate buffer. User is
107 ;; prompted as to whether only the currently active tables
108 ;; are to be displayed, or all the tables for all major
111 ;; If you have `dropdown-list' installed, you can optionally use it
112 ;; as the preferred "prompting method", putting in your .emacs file,
115 ;; (require 'dropdown-list)
116 ;; (setq yas-prompt-functions '(yas-dropdown-prompt
118 ;; yas-completing-prompt))
120 ;; Also check out the customization group
122 ;; M-x customize-group RET yasnippet RET
124 ;; If you use the customization group to set variables
125 ;; `yas-snippet-dirs' or `yas-global-mode', make sure the path to
126 ;; "yasnippet.el" is present in the `load-path' *before* the
127 ;; `custom-set-variables' is executed in your .emacs file.
129 ;; For more information and detailed usage, refer to the project page:
130 ;; http://github.com/capitaomorte/yasnippet
139 (defvar yas--editing-template)
140 (defvar yas--guessed-modes)
141 (defvar yas--indent-original-column)
142 (defvar yas--scheduled-jit-loads)
144 (defvar yas-selected-text)
145 (defvar yas-verbosity)
146 (defvar yas--current-template)
149 ;;; User customizable variables
151 (defgroup yasnippet nil
152 "Yet Another Snippet extension"
156 (defvar yas-installed-snippets-dir nil)
157 (setq yas-installed-snippets-dir
159 (expand-file-name "snippets" (file-name-directory load-file-name))))
161 (defconst yas--default-user-snippets-dir
162 (expand-file-name "snippets" user-emacs-directory))
164 (defcustom yas-snippet-dirs (remove nil
165 (list yas--default-user-snippets-dir
166 'yas-installed-snippets-dir))
167 "List of top-level snippet directories.
169 Each element, a string or a symbol whose value is a string,
170 designates a top-level directory where per-mode snippet
171 directories can be found.
173 Elements appearing earlier in the list override later elements'
176 The first directory is taken as the default for storing snippet's
177 created with `yas-new-snippet'. "
178 :type '(choice (directory :tag "Single directory")
179 (repeat :tag "List of directories"
180 (choice (directory) (variable))))
183 :set #'(lambda (symbol new)
184 (let ((old (and (boundp symbol)
185 (symbol-value symbol))))
186 (set-default symbol new)
187 (unless (or (not (fboundp 'yas-reload-all))
191 (defun yas-snippet-dirs ()
192 "Return variable `yas-snippet-dirs' as list of strings."
193 (cl-loop for e in (if (listp yas-snippet-dirs)
195 (list yas-snippet-dirs))
197 (cond ((stringp e) e)
200 (stringp (symbol-value e)))
203 (error "[yas] invalid element %s in `yas-snippet-dirs'" e)))))
205 (defvaralias 'yas/root-directory 'yas-snippet-dirs)
207 (defcustom yas-new-snippet-default "\
208 # -*- mode: snippet -*-
210 # key: ${2:${1:$(yas--key-from-desc yas-text)}}
213 "Default snippet to use when creating a new snippet.
214 If nil, don't use any snippet."
218 (defcustom yas-prompt-functions '(yas-dropdown-prompt
219 yas-completing-prompt
222 "Functions to prompt for keys, templates, etc interactively.
224 These functions are called with the following arguments:
226 - PROMPT: A string to prompt the user
228 - CHOICES: a list of strings or objects.
230 - optional DISPLAY-FN : A function that, when applied to each of
231 the objects in CHOICES will return a string.
233 The return value of any function you put here should be one of
234 the objects in CHOICES, properly formatted with DISPLAY-FN (if
237 - To signal that your particular style of prompting is
238 unavailable at the moment, you can also have the function return
241 - To signal that the user quit the prompting process, you can
244 (signal 'quit \"user quit!\")."
245 :type '(repeat function)
248 (defcustom yas-indent-line 'auto
249 "Controls indenting applied to a recent snippet expansion.
251 The following values are possible:
253 - `fixed' Indent the snippet to the current column;
255 - `auto' Indent each line of the snippet with `indent-according-to-mode'
257 Every other value means don't apply any snippet-side indentation
258 after expansion (the manual per-line \"$>\" indentation still
260 :type '(choice (const :tag "Nothing" nothing)
261 (const :tag "Fixed" fixed)
262 (const :tag "Auto" auto))
265 (defcustom yas-also-auto-indent-first-line nil
266 "Non-nil means also auto indent first line according to mode.
268 Naturally this is only valid when `yas-indent-line' is `auto'"
272 (defcustom yas-snippet-revival t
273 "Non-nil means re-activate snippet fields after undo/redo."
277 (defcustom yas-triggers-in-field nil
278 "If non-nil, allow stacked expansions (snippets inside snippets).
280 Otherwise `yas-next-field-or-maybe-expand' just moves on to the
285 (defcustom yas-fallback-behavior 'call-other-command
286 "How to act when `yas-expand' does *not* expand a snippet.
288 - `call-other-command' means try to temporarily disable YASnippet
289 and call the next command bound to whatever key was used to
292 - nil or the symbol `return-nil' mean do nothing. (and
293 `yas-expand' returns nil)
295 - A Lisp form (apply COMMAND . ARGS) means interactively call
296 COMMAND. If ARGS is non-nil, call COMMAND non-interactively
297 with ARGS as arguments."
298 :type '(choice (const :tag "Call previous command" call-other-command)
299 (const :tag "Do nothing" return-nil))
302 (defcustom yas-choose-keys-first nil
303 "If non-nil, prompt for snippet key first, then for template.
305 Otherwise prompts for all possible snippet names.
307 This affects `yas-insert-snippet' and `yas-visit-snippet-file'."
311 (defcustom yas-choose-tables-first nil
312 "If non-nil, and multiple eligible snippet tables, prompts user for tables first.
314 Otherwise, user chooses between the merging together of all
317 This affects `yas-insert-snippet', `yas-visit-snippet-file'"
321 (defcustom yas-use-menu 'abbreviate
322 "Display a YASnippet menu in the menu bar.
324 When non-nil, submenus for each snippet table will be listed
325 under the menu \"Yasnippet\".
327 - If set to `abbreviate', only the current major-mode
328 menu and the modes set in `yas--extra-modes' are listed.
330 - If set to `full', every submenu is listed
332 - If set to `nil', hide the menu.
334 Any other non-nil value, every submenu is listed."
335 :type '(choice (const :tag "Full" full)
336 (const :tag "Abbreviate" abbreviate)
337 (const :tag "No menu" nil))
340 (defcustom yas-trigger-symbol (or (and (eq window-system 'mac)
342 (char-to-string ?\x21E5))) ;; little ->| sign
344 "The text that will be used in menu to represent the trigger."
348 (defcustom yas-wrap-around-region nil
349 "What to insert for snippet's $0 field.
351 If set to a character, insert contents of corresponding register.
352 If non-nil insert region contents."
353 :type '(choice (character :tag "Insert from register")
354 (const t :tag "Insert region contents")
355 (const nil :tag "Don't insert anything")
356 (const cua)) ; backwards compat
359 (defcustom yas-good-grace t
360 "If non-nil, don't raise errors in inline elisp evaluation.
362 An error string \"[yas] error\" is returned instead."
366 (defcustom yas-visit-from-menu nil
367 "If non-nil visit snippets's files from menu, instead of expanding them.
369 This can only work when snippets are loaded from files."
373 (defcustom yas-expand-only-for-last-commands nil
374 "List of `last-command' values to restrict tab-triggering to, or nil.
376 Leave this set at nil (the default) to be able to trigger an
377 expansion simply by placing the cursor after a valid tab trigger,
378 using whichever commands.
380 Optionally, set this to something like '(self-insert-command) if
381 you to wish restrict expansion to only happen when the last
382 letter of the snippet tab trigger was typed immediately before
383 the trigger key itself."
384 :type '(repeat function)
387 ;; Only two faces, and one of them shouldn't even be used...
389 (defface yas-field-highlight-face
390 '((t (:inherit 'region)))
391 "The face used to highlight the currently active field of a snippet"
394 (defface yas--field-debug-face
396 "The face used for debugging some overlays normally hidden"
400 ;;; User-visible variables
402 (defvar yas-keymap (let ((map (make-sparse-keymap)))
403 (define-key map [(tab)] 'yas-next-field-or-maybe-expand)
404 (define-key map (kbd "TAB") 'yas-next-field-or-maybe-expand)
405 (define-key map [(shift tab)] 'yas-prev-field)
406 (define-key map [backtab] 'yas-prev-field)
407 (define-key map (kbd "C-g") 'yas-abort-snippet)
408 (define-key map (kbd "C-d") 'yas-skip-and-clear-or-delete-char)
410 "The active keymap while a snippet expansion is in progress.")
412 (defvar yas-key-syntaxes (list "w" "w_" "w_." "w_.()"
413 #'yas-try-key-from-whitespace)
414 "Syntaxes and functions to help look for trigger keys before point.
416 Each element in this list specifies how to skip buffer positions
417 backwards and look for the start of a trigger key.
419 Each element can be either a string or a function receiving the
420 original point as an argument. A string element is simply passed
421 to `skip-syntax-backward' whereas a function element is called
422 with no arguments and should also place point before the original
425 The string between the resulting buffer position and the original
426 point is matched against the trigger keys in the active snippet
429 If no expandable snippets are found, the next element is the list
430 is tried, unless a function element returned the symbol `again',
431 in which case it is called again from the previous position and
432 may once more reposition point.
434 For example, if `yas-key-syntaxes'' value is '(\"w\" \"w_\"),
435 trigger keys composed exclusively of \"word\"-syntax characters
436 are looked for first. Failing that, longer keys composed of
437 \"word\" or \"symbol\" syntax are looked for. Therefore,
442 will, according to the \"w\" element first try \"barbaz\". If
443 that isn't a trigger key, \"foo-barbaz\" is tried, respecting the
444 second \"w_\" element. Notice that even if \"baz\" is a trigger
445 key for an active snippet, it won't be expanded, unless a
446 function is added to `yas-key-syntaxes' that eventually places
447 point between \"bar\" and \"baz\".
449 See also Info node `(elisp) Syntax Descriptors'.")
451 (defvar yas-after-exit-snippet-hook
453 "Hooks to run after a snippet exited.
455 The hooks will be run in an environment where some variables bound to
458 `yas-snippet-beg' : The beginning of the region of the snippet.
460 `yas-snippet-end' : Similar to beg.
462 Attention: These hooks are not run when exiting nested/stacked snippet expansion!")
464 (defvar yas-before-expand-snippet-hook
466 "Hooks to run just before expanding a snippet.")
468 (defvar yas-buffer-local-condition
469 '(if (and (let ((ppss (syntax-ppss)))
470 (or (nth 3 ppss) (nth 4 ppss)))
471 (memq this-command '(yas-expand yas-expand-from-trigger-key
472 yas-expand-from-keymap)))
473 '(require-snippet-condition . force-in-comment)
475 "Snippet expanding condition.
477 This variable is a Lisp form which is evaluated every time a
478 snippet expansion is attempted:
480 * If it evaluates to nil, no snippets can be expanded.
482 * If it evaluates to the a cons (require-snippet-condition
485 * Snippets bearing no \"# condition:\" directive are not
488 * Snippets bearing conditions that evaluate to nil (or
489 produce an error) won't be considered.
491 * If the snippet has a condition that evaluates to non-nil
494 * If REQUIREMENT is t, the snippet is considered
496 * If REQUIREMENT is `eq' RESULT, the snippet is
499 * Otherwise, the snippet is not considered.
501 * If it evaluates to the symbol 'always, all snippets are
502 considered for expansion, regardless of any conditions.
504 * If it evaluates to t or some other non-nil value
506 * Snippet bearing no conditions, or conditions that
507 evaluate to non-nil, are considered for expansion.
509 * Otherwise, the snippet is not considered.
511 Here's an example preventing snippets from being expanded from
512 inside comments, in `python-mode' only, with the exception of
513 snippets returning the symbol 'force-in-comment in their
516 (add-hook 'python-mode-hook
518 (setq yas-buffer-local-condition
519 '(if (python-in-string/comment)
520 '(require-snippet-condition . force-in-comment)
523 The default value is similar, it filters out potential snippet
524 expansions inside comments and string literals, unless the
525 snippet itself contains a condition that returns the symbol
526 `force-in-comment'.")
529 ;;; Internal variables
531 (defvar yas--version "0.9.1")
533 (defvar yas--menu-table (make-hash-table)
534 "A hash table of MAJOR-MODE symbols to menu keymaps.")
536 (defvar yas--escaped-characters
537 '(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
538 "List of characters which *might* need to be escaped.")
540 (defconst yas--field-regexp
541 "${\\([0-9]+:\\)?\\([^}]*\\)}"
542 "A regexp to *almost* recognize a field.")
544 (defconst yas--multi-dollar-lisp-expression-regexp
545 "$+[ \t\n]*\\(([^)]*)\\)"
546 "A regexp to *almost* recognize a \"$(...)\" expression.")
548 (defconst yas--backquote-lisp-expression-regexp
550 "A regexp to recognize a \"`lisp-expression`\" expression." )
552 (defconst yas--transform-mirror-regexp
553 "${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
554 "A regexp to *almost* recognize a mirror with a transform.")
556 (defconst yas--simple-mirror-regexp
558 "A regexp to recognize a simple mirror.")
560 (defvar yas--snippet-id-seed 0
561 "Contains the next id for a snippet.")
563 (defun yas--snippet-next-id ()
564 (let ((id yas--snippet-id-seed))
565 (cl-incf yas--snippet-id-seed)
571 ;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
572 (defvar last-buffer-undo-list nil)
574 (defvar yas--minor-mode-menu nil
575 "Holds the YASnippet menu.")
577 (defvar yas-minor-mode-map
578 (let ((map (make-sparse-keymap)))
579 (define-key map [(tab)] 'yas-expand)
580 (define-key map (kbd "TAB") 'yas-expand)
581 (define-key map "\C-c&\C-s" 'yas-insert-snippet)
582 (define-key map "\C-c&\C-n" 'yas-new-snippet)
583 (define-key map "\C-c&\C-v" 'yas-visit-snippet-file)
585 "The keymap used when `yas-minor-mode' is active.")
587 (easy-menu-define yas--minor-mode-menu
589 "Menu used when `yas-minor-mode' is active."
590 '("YASnippet" :visible yas-use-menu
592 ["Expand trigger" yas-expand
593 :help "Possibly expand tab trigger before point"]
594 ["Insert at point..." yas-insert-snippet
595 :help "Prompt for an expandable snippet and expand it at point"]
596 ["New snippet..." yas-new-snippet
597 :help "Create a new snippet in an appropriate directory"]
598 ["Visit snippet file..." yas-visit-snippet-file
599 :help "Prompt for an expandable snippet and find its file"]
601 ("Snippet menu behaviour"
602 ["Visit snippets" (setq yas-visit-from-menu t)
603 :help "Visit snippets from the menu"
604 :active t :style radio :selected yas-visit-from-menu]
605 ["Expand snippets" (setq yas-visit-from-menu nil)
606 :help "Expand snippets from the menu"
607 :active t :style radio :selected (not yas-visit-from-menu)]
609 ["Show all known modes" (setq yas-use-menu 'full)
610 :help "Show one snippet submenu for each loaded table"
611 :active t :style radio :selected (eq yas-use-menu 'full)]
612 ["Abbreviate according to current mode" (setq yas-use-menu 'abbreviate)
613 :help "Show only snippet submenus for the current active modes"
614 :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
616 ["Auto" (setq yas-indent-line 'auto)
617 :help "Indent each line of the snippet with `indent-according-to-mode'"
618 :active t :style radio :selected (eq yas-indent-line 'auto)]
619 ["Fixed" (setq yas-indent-line 'fixed)
620 :help "Indent the snippet to the current column"
621 :active t :style radio :selected (eq yas-indent-line 'fixed)]
622 ["None" (setq yas-indent-line 'none)
623 :help "Don't apply any particular snippet indentation after expansion"
624 :active t :style radio :selected (not (member yas-indent-line '(fixed auto)))]
626 ["Also auto indent first line" (setq yas-also-auto-indent-first-line
627 (not yas-also-auto-indent-first-line))
628 :help "When auto-indenting also, auto indent the first line menu"
629 :active (eq yas-indent-line 'auto)
630 :style toggle :selected yas-also-auto-indent-first-line]
633 ["System X-widget" (setq yas-prompt-functions
635 (remove 'yas-x-prompt
636 yas-prompt-functions)))
637 :help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
638 :active t :style radio :selected (eq (car yas-prompt-functions)
640 ["Dropdown-list" (setq yas-prompt-functions
641 (cons 'yas-dropdown-prompt
642 (remove 'yas-dropdown-prompt
643 yas-prompt-functions)))
644 :help "Use a special dropdown list"
645 :active t :style radio :selected (eq (car yas-prompt-functions)
646 'yas-dropdown-prompt)]
647 ["Ido" (setq yas-prompt-functions
648 (cons 'yas-ido-prompt
649 (remove 'yas-ido-prompt
650 yas-prompt-functions)))
651 :help "Use an ido-style minibuffer prompt"
652 :active t :style radio :selected (eq (car yas-prompt-functions)
654 ["Completing read" (setq yas-prompt-functions
655 (cons 'yas-completing-prompt
656 (remove 'yas-completing-prompt
657 yas-prompt-functions)))
658 :help "Use a normal minibuffer prompt"
659 :active t :style radio :selected (eq (car yas-prompt-functions)
660 'yas-completing-prompt)]
663 ["Wrap region in exit marker"
664 (setq yas-wrap-around-region
665 (not yas-wrap-around-region))
666 :help "If non-nil automatically wrap the selected text in the $0 snippet exit"
667 :style toggle :selected yas-wrap-around-region]
668 ["Allow stacked expansions "
669 (setq yas-triggers-in-field
670 (not yas-triggers-in-field))
671 :help "If non-nil allow snippets to be triggered inside other snippet fields"
672 :style toggle :selected yas-triggers-in-field]
673 ["Revive snippets on undo "
674 (setq yas-snippet-revival
675 (not yas-snippet-revival))
676 :help "If non-nil allow snippets to become active again after undo"
677 :style toggle :selected yas-snippet-revival]
680 (not yas-good-grace))
681 :help "If non-nil don't raise errors in bad embedded elisp in snippets"
682 :style toggle :selected yas-good-grace]
685 ["Load snippets..." yas-load-directory
686 :help "Load snippets from a specific directory"]
687 ["Reload everything" yas-reload-all
688 :help "Cleanup stuff, reload snippets, rebuild menus"]
690 :help "Display some information about YASnippet"]))
692 (defvar yas--extra-modes nil
693 "An internal list of modes for which to also lookup snippets.
695 This variable probably makes more sense as buffer-local, so
696 ensure your use `make-local-variable' when you set it.")
697 (define-obsolete-variable-alias 'yas-extra-modes 'yas--extra-modes "0.9.1")
699 (defvar yas--tables (make-hash-table)
700 "A hash table of mode symbols to `yas--table' objects.")
702 (defvar yas--parents (make-hash-table)
703 "A hash table of mode symbols do lists of direct parent mode symbols.
705 This list is populated when reading the \".yas-parents\" files
706 found when traversing snippet directories with
707 `yas-load-directory'.
709 There might be additional parenting information stored in the
710 `derived-mode-parent' property of some mode symbols, but that is
713 (defvar yas--direct-keymaps (list)
714 "Keymap alist supporting direct snippet keybindings.
716 This variable is placed in `emulation-mode-map-alists'.
718 Its elements looks like (TABLE-NAME . KEYMAP). They're
719 instantiated on `yas-reload-all' but KEYMAP is added to only when
720 loading snippets. `yas--direct-TABLE-NAME' is then a variable set
721 buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
722 defined direct keybindings to the command
723 `yas-expand-from-keymap' which then which snippet to expand.")
725 (defun yas-direct-keymaps-reload ()
726 "Force reload the direct keybinding for active snippet tables."
728 (setq yas--direct-keymaps nil)
729 (maphash #'(lambda (name table)
730 (push (cons (intern (format "yas--direct-%s" name))
731 (yas--table-direct-keymap table))
732 yas--direct-keymaps))
735 (defun yas--modes-to-activate (&optional mode)
736 "Compute list of mode symbols that are active for `yas-expand' and friends."
737 (defvar yas--dfs) ;We rely on dynbind. We could use `letrec' instead!
738 (let* ((explored (if mode (list mode) ; Building up list in reverse.
739 (cons major-mode (reverse yas--extra-modes))))
742 (cl-loop for neighbour
743 in (cl-list* (get mode 'derived-mode-parent)
744 ;; NOTE: `fboundp' check is redundant
746 (and (fboundp mode) (symbol-function mode))
747 (gethash mode yas--parents))
749 (not (memq neighbour explored))
751 do (push neighbour explored)
752 (funcall yas--dfs neighbour)))))
753 (mapc yas--dfs explored)
754 (nreverse explored)))
756 (defvar yas-minor-mode-hook nil
757 "Hook run when `yas-minor-mode' is turned on.")
760 (define-minor-mode yas-minor-mode
761 "Toggle YASnippet mode.
763 When YASnippet mode is enabled, `yas-expand', normally bound to
764 the TAB key, expands snippets of code depending on the major
767 With no argument, this command toggles the mode.
768 positive prefix argument turns on the mode.
769 Negative prefix argument turns off the mode.
772 \\{yas-minor-mode-map}"
774 ;; The indicator for the mode line.
777 (cond (yas-minor-mode
778 ;; Install the direct keymaps in `emulation-mode-map-alists'
779 ;; (we use `add-hook' even though it's not technically a hook,
780 ;; but it works). Then define variables named after modes to
781 ;; index `yas--direct-keymaps'.
783 ;; Also install the post-command-hook.
785 (cl-pushnew 'yas--direct-keymaps emulation-mode-map-alists)
786 (add-hook 'post-command-hook #'yas--post-command-handler nil t)
787 ;; Set the `yas--direct-%s' vars for direct keymap expansion
789 (dolist (mode (yas--modes-to-activate))
790 (let ((name (intern (format "yas--direct-%s" mode))))
791 (set-default name nil)
792 (set (make-local-variable name) t)))
795 (yas--load-pending-jits))
797 ;; Uninstall the direct keymaps and the post-command hook
799 (remove-hook 'post-command-hook #'yas--post-command-handler t)
800 (setq emulation-mode-map-alists
801 (remove 'yas--direct-keymaps emulation-mode-map-alists)))))
803 (defun yas-activate-extra-mode (mode)
804 "Activates the snippets for the given `mode' in the buffer.
806 The function can be called in the hook of a minor mode to
807 activate snippets associated with that mode."
811 (maphash (lambda (k _)
812 (setq modes (cons (list k) modes)))
814 (setq symbol (completing-read
815 "Activate mode: " modes nil t))
817 (when (not (string= "" symbol))
820 (add-to-list (make-local-variable 'yas--extra-modes) mode)
821 (yas--load-pending-jits)))
823 (defun yas-deactivate-extra-mode (mode)
824 "Deactivates the snippets for the given `mode' in the buffer."
828 "Deactivate mode: " (mapcar #'list yas--extra-modes) nil t))))
829 (set (make-local-variable 'yas--extra-modes)
833 (define-obsolete-variable-alias 'yas-dont-activate
834 'yas-dont-activate-functions "0.9.2")
835 (defvar yas-dont-activate-functions (list #'minibufferp)
836 "Special hook to control which buffers `yas-global-mode' affects.
837 Functions are called with no argument, and should return non-nil to prevent
838 `yas-global-mode' from enabling yasnippet in this buffer.
840 In Emacsen < 24, this variable is buffer-local. Because
841 `yas-minor-mode-on' is called by `yas-global-mode' after
842 executing the buffer's major mode hook, setting this variable
843 there is an effective way to define exceptions to the \"global\"
844 activation behaviour.
846 In Emacsen >= 24, only the global value is used. To define
847 per-mode exceptions to the \"global\" activation behaviour, call
848 `yas-minor-mode' with a negative argument directily in the major
850 (unless (> emacs-major-version 23)
852 (make-variable-buffer-local 'yas-dont-activate)))
855 (defun yas-minor-mode-on ()
856 "Turn on YASnippet minor mode.
858 Honour `yas-dont-activate-functions', which see."
861 ;; The old behavior used for Emacs<24 was to set
862 ;; `yas-dont-activate-functions' to t buffer-locally.
863 (not (or (listp yas-dont-activate-functions)
864 (functionp yas-dont-activate-functions)))
865 (run-hook-with-args-until-success 'yas-dont-activate-functions))
869 (define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
873 (defun yas--global-mode-reload-with-jit-maybe ()
874 "Run `yas-reload-all' when `yas-global-mode' is on."
875 (when yas-global-mode (yas-reload-all)))
877 (add-hook 'yas-global-mode-hook #'yas--global-mode-reload-with-jit-maybe)
882 (defvar yas--font-lock-keywords
883 (append '(("^#.*$" . font-lock-comment-face))
885 (ignore-errors (emacs-lisp-mode))
886 (font-lock-set-defaults)
887 (if (eq t (car-safe font-lock-keywords))
888 ;; They're "compiled", so extract the source.
889 (cadr font-lock-keywords)
892 (0 font-lock-keyword-face)
893 (1 font-lock-string-face t))
895 (0 font-lock-keyword-face)
896 (1 font-lock-warning-face t))
897 ("\\(\\$(\\)" 1 font-lock-preprocessor-face)
899 (0 font-lock-keyword-face)))))
901 (defvar snippet-mode-map
902 (let ((map (make-sparse-keymap)))
903 (easy-menu-define nil
905 "Menu used when snippet-mode is active."
907 (mapcar #'(lambda (ent)
909 (define-key map (third ent) (second ent)))
910 (vector (first ent) (second ent) t))
911 '(("Load this snippet" yas-load-snippet-buffer "\C-c\C-l")
912 ("Load and quit window" yas-load-snippet-buffer-and-close "\C-c\C-c")
913 ("Try out this snippet" yas-tryout-snippet "\C-c\C-t")))))
915 "The keymap used when `snippet-mode' is active.")
919 (define-derived-mode snippet-mode text-mode "Snippet"
920 "A mode for editing yasnippets"
921 (setq font-lock-defaults '(yas--font-lock-keywords))
922 (set (make-local-variable 'require-final-newline) nil)
923 (set (make-local-variable 'comment-start) "#")
924 (set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
928 ;;; Internal structs for template management
930 (cl-defstruct (yas--template
931 (:constructor yas--make-template)
932 ;; Handles `yas-define-snippets' format, plus the
933 ;; initial TABLE argument.
935 yas--define-snippets-2
938 &optional xname condition group
939 expand-env load-file xkeybinding xuuid save-file
942 ;; A little redundant: we always get a name
943 ;; from `yas--parse-template' except when
944 ;; there isn't a file.
945 (and load-file (file-name-nondirectory load-file))
946 (and save-file (file-name-nondirectory save-file))
948 (keybinding (yas--read-keybinding xkeybinding))
949 (uuid (or xuuid name))
950 (old (gethash uuid (yas--table-uuidhash table)))
952 (and old (yas--template-menu-binding-pair old)))
954 (and old (yas--template-perm-group old))))))
955 "A template for a snippet."
966 group ;; as dictated by the #group: directive or .yas-make-groups
967 perm-group ;; as dictated by `yas-define-menu'
971 (defstruct (yas--table (:constructor yas--make-snippet-table (name)))
972 "A table to store snippets for a particular mode.
974 Has the following fields:
978 A symbol name normally corresponding to a major mode, but can
979 also be a pseudo major-mode to be used in
980 `yas-activate-extra-mode', for example.
984 A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
985 a string or a vector, where the former is the snippet's trigger
986 and the latter means it's a direct keybinding. NAMEHASH is yet
987 another hash of (NAME . TEMPLATE) where NAME is the snippet's
988 name and TEMPLATE is a `yas--template' object.
990 `yas--table-direct-keymap'
992 A keymap for the snippets in this table that have direct
993 keybindings. This is kept in sync with the keyhash, i.e., all
994 the elements of the keyhash that are vectors appear here as
995 bindings to `yas-expand-from-keymap'.
997 `yas--table-uuidhash'
999 A hash table mapping snippets uuid's to the same `yas--template'
1000 objects. A snippet uuid defaults to the snippet's name."
1002 (hash (make-hash-table :test 'equal))
1003 (uuidhash (make-hash-table :test 'equal))
1005 (direct-keymap (make-sparse-keymap)))
1007 (defun yas--get-template-by-uuid (mode uuid)
1008 "Find the snippet template in MODE by its UUID."
1009 (let* ((table (gethash mode yas--tables mode)))
1011 (gethash uuid (yas--table-uuidhash table)))))
1013 ;; Apropos storing/updating in TABLE, this works in two steps:
1015 ;; 1. `yas--remove-template-by-uuid' removes any
1016 ;; keyhash-namehash-template mappings from TABLE, grabbing the
1017 ;; snippet by its uuid. Also removes mappings from TABLE's
1018 ;; `yas--table-direct-keymap' (FIXME: and should probably take care
1019 ;; of potentially stale menu bindings right?.)
1021 ;; 2. `yas--add-template' adds this all over again.
1023 ;; Create a new or add to an existing keyhash-namehash mapping.
1025 ;; For reference on understanding this, consider three snippet
1028 ;; A: # name: The Foo
1030 ;; # binding: C-c M-l
1032 ;; B: # name: Mrs Foo
1035 ;; C: # name: The Bar
1036 ;; # binding: C-c M-l
1041 ;; keyhash namehashes(3) yas--template structs(4)
1042 ;; -----------------------------------------------------
1045 ;; "foo" ---> "The Foo" ---> [yas--template A] |
1046 ;; "Mrs Foo" ---> [yas--template B] |
1048 ;; [C-c M-l] ---> "The Foo" -------------------------/
1049 ;; "The Bar" ---> [yas--template C]
1051 ;; "baz" ---> "Baz" ---> [yas--template D]
1053 ;; Additionally, since uuid defaults to the name, we have a
1054 ;; `yas--table-uuidhash' for TABLE
1056 ;; uuidhash yas--template structs
1057 ;; -------------------------------
1058 ;; "The Foo" ---> [yas--template A]
1059 ;; "Mrs Foo" ---> [yas--template B]
1060 ;; "The Bar" ---> [yas--template C]
1061 ;; "Baz" ---> [yas--template D]
1063 ;; FIXME: the more I look at this data-structure the more I think I'm
1064 ;; stupid. There has to be an easier way (but beware lots of code
1065 ;; depends on this).
1067 (defun yas--remove-template-by-uuid (table uuid)
1068 "Remove from TABLE a template identified by UUID."
1069 (let ((template (gethash uuid (yas--table-uuidhash table))))
1071 (let* ((name (yas--template-name template))
1073 ;; Remove the name from each of the targeted namehashes
1075 (maphash #'(lambda (k v)
1076 (let ((template (gethash name v)))
1078 (eq uuid (yas--template-uuid template)))
1080 (when (zerop (hash-table-count v))
1081 (push k empty-keys)))))
1082 (yas--table-hash table))
1083 ;; Remove the namehash themselves if they've become empty
1085 (dolist (key empty-keys)
1087 (define-key (yas--table-direct-keymap table) key nil))
1088 (remhash key (yas--table-hash table)))
1090 ;; Finally, remove the uuid from the uuidhash
1092 (remhash uuid (yas--table-uuidhash table))))))
1094 (defun yas--add-template (table template)
1095 "Store in TABLE the snippet template TEMPLATE.
1097 KEY can be a string (trigger key) of a vector (direct
1099 (let ((name (yas--template-name template))
1100 (key (yas--template-key template))
1101 (keybinding (yas--template-keybinding template))
1102 (_menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
1103 (dolist (k (remove nil (list key keybinding)))
1107 (yas--table-hash table))
1109 (make-hash-table :test 'equal)
1110 (yas--table-hash table))))
1112 (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
1114 ;; Update TABLE's `yas--table-uuidhash'
1115 (puthash (yas--template-uuid template)
1117 (yas--table-uuidhash table))))
1119 (defun yas--update-template (table template)
1120 "Add or update TEMPLATE in TABLE.
1122 Also takes care of adding and updating to the associated menu.
1124 ;; Remove from table by uuid
1126 (yas--remove-template-by-uuid table (yas--template-uuid template))
1127 ;; Add to table again
1129 (yas--add-template table template)
1130 ;; Take care of the menu
1132 (yas--update-template-menu table template)
1135 (defun yas--update-template-menu (table template)
1136 "Update every menu-related for TEMPLATE."
1137 (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
1138 (key (yas--template-key template))
1139 (keybinding (yas--template-keybinding template)))
1140 ;; The snippet might have changed name or keys, so update
1141 ;; user-visible strings
1143 (unless (eq (cdr menu-binding-pair) :none)
1144 ;; the menu item name
1146 (setf (cadar menu-binding-pair) (yas--template-name template))
1147 ;; the :keys information (also visible to the user)
1148 (setf (getf (cdr (car menu-binding-pair)) :keys)
1149 (or (and keybinding (key-description keybinding))
1150 (and key (concat key yas-trigger-symbol))))))
1151 (unless (yas--template-menu-managed-by-yas-define-menu template)
1153 (yas--menu-keymap-get-create (yas--table-mode table)
1154 (mapcar #'yas--table-mode
1155 (yas--table-parents table))))
1156 (group (yas--template-group template)))
1157 ;; Remove from menu keymap
1159 (assert menu-keymap)
1160 (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
1162 ;; Add necessary subgroups as necessary.
1164 (dolist (subgroup group)
1165 (let ((subgroup-keymap (lookup-key menu-keymap (vector (make-symbol subgroup)))))
1166 (unless (and subgroup-keymap
1167 (keymapp subgroup-keymap))
1168 (setq subgroup-keymap (make-sparse-keymap))
1169 (define-key menu-keymap (vector (make-symbol subgroup))
1170 `(menu-item ,subgroup ,subgroup-keymap)))
1171 (setq menu-keymap subgroup-keymap)))
1173 ;; Add this entry to the keymap
1175 (define-key menu-keymap
1176 (vector (make-symbol (yas--template-uuid template)))
1177 (car (yas--template-menu-binding-pair template))))))
1179 (defun yas--namehash-templates-alist (namehash)
1180 "Return NAMEHASH as an alist."
1182 (maphash #'(lambda (k v)
1183 (push (cons k v) alist))
1187 (defun yas--fetch (table key)
1188 "Fetch templates in TABLE by KEY.
1190 Return a list of cons (NAME . TEMPLATE) where NAME is a
1191 string and TEMPLATE is a `yas--template' structure."
1192 (let* ((keyhash (yas--table-hash table))
1193 (namehash (and keyhash (gethash key keyhash))))
1195 (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
1198 ;;; Filtering/condition logic
1200 (defun yas--eval-condition (condition)
1207 (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
1211 (defun yas--filter-templates-by-condition (templates)
1212 "Filter the templates using the applicable condition.
1214 TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
1215 string and TEMPLATE is a `yas--template' structure.
1217 This function implements the rules described in
1218 `yas-buffer-local-condition'. See that variables documentation."
1219 (let ((requirement (yas--require-template-specific-condition-p)))
1220 (if (eq requirement 'always)
1222 (remove-if-not #'(lambda (pair)
1223 (yas--template-can-expand-p
1224 (yas--template-condition (cdr pair)) requirement))
1227 (defun yas--require-template-specific-condition-p ()
1228 "Decide if this buffer requests/requires snippet-specific
1229 conditions to filter out potential expansions."
1230 (if (eq 'always yas-buffer-local-condition)
1232 (let ((local-condition (or (and (consp yas-buffer-local-condition)
1233 (yas--eval-condition yas-buffer-local-condition))
1234 yas-buffer-local-condition)))
1235 (when local-condition
1236 (if (eq local-condition t)
1238 (and (consp local-condition)
1239 (eq 'require-snippet-condition (car local-condition))
1240 (symbolp (cdr local-condition))
1241 (cdr local-condition)))))))
1243 (defun yas--template-can-expand-p (condition requirement)
1244 "Evaluate CONDITION and REQUIREMENT and return a boolean."
1245 (let* ((result (or (null condition)
1246 (yas--eval-condition condition))))
1247 (cond ((eq requirement t)
1250 (eq requirement result)))))
1252 (defun yas--table-templates (table)
1255 (maphash #'(lambda (_key namehash)
1256 (maphash #'(lambda (name template)
1257 (push (cons name template) acc))
1259 (yas--table-hash table))
1260 (yas--filter-templates-by-condition acc))))
1262 (defun yas--templates-for-key-at-point ()
1263 "Find `yas--template' objects for any trigger keys preceding point.
1264 Returns (TEMPLATES START END). This function respects
1265 `yas-key-syntaxes', which see."
1267 (let ((original (point))
1268 (methods yas-key-syntaxes)
1273 (unless (eq method (car methods))
1274 ;; TRICKY: `eq'-ness test means we can only be here if
1275 ;; `method' is a function that returned `again', and hence
1276 ;; don't revert back to original position as per
1277 ;; `yas-key-syntaxes'.
1278 (goto-char original))
1279 (setq method (car methods))
1280 (cond ((stringp method)
1281 (skip-syntax-backward method)
1282 (setq methods (cdr methods)))
1284 (unless (eq (funcall method original)
1286 (setq methods (cdr methods))))
1288 (setq methods (cdr methods))
1289 (yas--warning "Invalid element `%s' in `yas-key-syntaxes'" method)))
1290 (let ((possible-key (buffer-substring-no-properties (point) original)))
1292 (goto-char original)
1294 (mapcan #'(lambda (table)
1295 (yas--fetch table possible-key))
1296 (yas--get-snippet-tables))))))
1298 (list templates (point) original)))))
1300 (defun yas--table-all-keys (table)
1301 "Get trigger keys of all active snippets in TABLE."
1303 (maphash #'(lambda (key namehash)
1304 (when (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash))
1306 (yas--table-hash table))
1309 (defun yas--table-mode (table)
1310 (intern (yas--table-name table)))
1313 ;;; Internal functions and macros:
1315 (defun yas--handle-error (err)
1316 "Handle error depending on value of `yas-good-grace'."
1317 (let ((msg (yas--format "elisp error: %s" (error-message-string err))))
1318 (if yas-good-grace msg
1321 (defun yas--eval-lisp (form)
1322 "Evaluate FORM and convert the result to string."
1323 (let ((retval (catch 'yas--exception
1329 (let ((result (eval form)))
1331 (format "%s" result))))))
1332 (error (yas--handle-error err))))))
1333 (when (and (consp retval)
1334 (eq 'yas--exception (car retval)))
1335 (error (cdr retval)))
1338 (defun yas--eval-lisp-no-saves (form)
1341 (error (message "%s" (yas--handle-error err)))))
1343 (defun yas--read-lisp (string &optional nil-on-error)
1344 "Read STRING as a elisp expression and return it.
1346 In case STRING in an invalid expression and NIL-ON-ERROR is nil,
1347 return an expression that when evaluated will issue an error."
1350 (error (and (not nil-on-error)
1351 `(error (error-message-string ,err))))))
1353 (defun yas--read-keybinding (keybinding)
1354 "Read KEYBINDING as a snippet keybinding, return a vector."
1355 (when (and keybinding
1356 (not (string-match "keybinding" keybinding)))
1358 (let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
1360 (read-kbd-macro keybinding 'need-vector))))
1363 (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
1364 keybinding (error-message-string err))
1367 (defun yas--table-get-create (mode)
1368 "Get or create the snippet table corresponding to MODE."
1369 (let ((table (gethash mode
1372 (setq table (yas--make-snippet-table (symbol-name mode)))
1373 (puthash mode table yas--tables)
1374 (push (cons (intern (format "yas--direct-%s" mode))
1375 (yas--table-direct-keymap table))
1376 yas--direct-keymaps))
1379 (defun yas--get-snippet-tables (&optional mode)
1380 "Get snippet tables for MODE.
1382 MODE defaults to the current buffer's `major-mode'.
1384 Return a list of `yas--table' objects. The list of modes to
1385 consider is returned by `yas--modes-to-activate'"
1387 (mapcar #'(lambda (name)
1388 (gethash name yas--tables))
1389 (yas--modes-to-activate mode))))
1391 (defun yas--menu-keymap-get-create (mode &optional parents)
1392 "Get or create the menu keymap for MODE and its PARENTS.
1394 This may very well create a plethora of menu keymaps and arrange
1395 them all in `yas--menu-table'"
1396 (let* ((menu-keymap (or (gethash mode yas--menu-table)
1397 (puthash mode (make-sparse-keymap) yas--menu-table))))
1398 (mapc #'yas--menu-keymap-get-create parents)
1399 (define-key yas--minor-mode-menu (vector mode)
1400 `(menu-item ,(symbol-name mode) ,menu-keymap
1401 :visible (yas--show-menu-p ',mode)))
1405 ;;; Template-related and snippet loading functions
1407 (defun yas--parse-template (&optional file)
1408 "Parse the template in the current buffer.
1410 Optional FILE is the absolute file name of the file being
1413 Optional GROUP is the group where the template is to go,
1414 otherwise we attempt to calculate it from FILE.
1416 Return a snippet-definition, i.e. a list
1418 (KEY TEMPLATE NAME CONDITION GROUP VARS LOAD-FILE KEYBINDING UUID)
1420 If the buffer contains a line of \"# --\" then the contents above
1421 this line are ignored. Directives can set most of these with the syntax:
1423 # directive-name : directive-value
1425 Here's a list of currently recognized directives:
1436 (goto-char (point-min))
1437 (let* ((type 'snippet)
1439 (file-name-nondirectory file)))
1445 (yas--calculate-group file)))
1449 (if (re-search-forward "^# --\n" nil t)
1450 (progn (setq template
1451 (buffer-substring-no-properties (point)
1453 (setq bound (point))
1454 (goto-char (point-min))
1455 (while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*?\\)[[:space:]]*$" bound t)
1456 (when (string= "uuid" (match-string-no-properties 1))
1457 (setq uuid (match-string-no-properties 2)))
1458 (when (string= "type" (match-string-no-properties 1))
1459 (setq type (if (string= "command" (match-string-no-properties 2))
1462 (when (string= "key" (match-string-no-properties 1))
1463 (setq key (match-string-no-properties 2)))
1464 (when (string= "name" (match-string-no-properties 1))
1465 (setq name (match-string-no-properties 2)))
1466 (when (string= "condition" (match-string-no-properties 1))
1467 (setq condition (yas--read-lisp (match-string-no-properties 2))))
1468 (when (string= "group" (match-string-no-properties 1))
1469 (setq group (match-string-no-properties 2)))
1470 (when (string= "expand-env" (match-string-no-properties 1))
1471 (setq expand-env (yas--read-lisp (match-string-no-properties 2)
1473 (when (string= "binding" (match-string-no-properties 1))
1474 (setq binding (match-string-no-properties 2)))))
1476 (buffer-substring-no-properties (point-min) (point-max))))
1477 (unless (or key binding)
1478 (setq key (and file (file-name-nondirectory file))))
1479 (when (eq type 'command)
1480 (setq template (yas--read-lisp (concat "(progn" template ")"))))
1482 (setq group (split-string group "\\.")))
1483 (list key template name condition group expand-env file binding uuid)))
1485 (defun yas--calculate-group (file)
1486 "Calculate the group for snippet file path FILE."
1487 (let* ((dominating-dir (locate-dominating-file file
1488 ".yas-make-groups"))
1489 (extra-path (and dominating-dir
1490 (file-relative-name file dominating-dir)))
1491 (extra-dir (and extra-path
1492 (file-name-directory extra-path)))
1493 (group (and extra-dir
1494 (replace-regexp-in-string "/"
1496 (directory-file-name extra-dir)))))
1499 (defun yas--subdirs (directory &optional filep)
1500 "Return subdirs or files of DIRECTORY according to FILEP."
1501 (cl-remove-if (lambda (file)
1502 (or (string-match "\\`\\."
1503 (file-name-nondirectory file))
1504 (string-match "\\`#.*#\\'"
1505 (file-name-nondirectory file))
1506 (string-match "~\\'"
1507 (file-name-nondirectory file))
1509 (file-directory-p file)
1510 (not (file-directory-p file)))))
1511 (directory-files directory t)))
1513 (defun yas--make-menu-binding (template)
1514 (let ((mode (yas--table-mode (yas--template-table template))))
1515 `(lambda () (interactive) (yas--expand-or-visit-from-menu ',mode ,(yas--template-uuid template)))))
1517 (defun yas--expand-or-visit-from-menu (mode uuid)
1518 (let* ((table (yas--table-get-create mode))
1519 (yas--current-template (and table
1520 (gethash uuid (yas--table-uuidhash table)))))
1521 (when yas--current-template
1522 (if yas-visit-from-menu
1523 (yas--visit-snippet-file-1 yas--current-template)
1524 (let ((where (if (region-active-p)
1525 (cons (region-beginning) (region-end))
1526 (cons (point) (point)))))
1527 (yas-expand-snippet (yas--template-content yas--current-template)
1530 (yas--template-expand-env yas--current-template)))))))
1532 (defun yas--key-from-desc (text)
1533 "Return a yasnippet key from a description string TEXT."
1534 (replace-regexp-in-string "\\(\\w+\\).*" "\\1" text))
1537 ;;; Popping up for keys and templates
1539 (defun yas--prompt-for-template (templates &optional prompt)
1540 "Interactively choose a template from the list TEMPLATES.
1542 TEMPLATES is a list of `yas--template'.
1544 Optional PROMPT sets the prompt to use."
1547 (sort templates #'(lambda (t1 t2)
1548 (< (length (yas--template-name t1))
1549 (length (yas--template-name t2))))))
1550 (some #'(lambda (fn)
1551 (funcall fn (or prompt "Choose a snippet: ")
1553 #'yas--template-name))
1554 yas-prompt-functions)))
1556 (defun yas--prompt-for-keys (keys &optional prompt)
1557 "Interactively choose a template key from the list KEYS.
1559 Optional PROMPT sets the prompt to use."
1561 (some #'(lambda (fn)
1562 (funcall fn (or prompt "Choose a snippet key: ") keys))
1563 yas-prompt-functions)))
1565 (defun yas--prompt-for-table (tables &optional prompt)
1566 "Interactively choose a table from the list TABLES.
1568 Optional PROMPT sets the prompt to use."
1570 (some #'(lambda (fn)
1571 (funcall fn (or prompt "Choose a snippet table: ")
1574 yas-prompt-functions)))
1576 (defun yas-x-prompt (prompt choices &optional display-fn)
1577 "Display choices in a x-window prompt."
1578 (when (and window-system choices)
1579 ;; Let window position be recalculated to ensure that
1580 ;; `posn-at-point' returns non-nil.
1584 (if (fboundp 'posn-at-point)
1585 (let ((x-y (posn-x-y (posn-at-point (point)))))
1586 (list (list (+ (car x-y) 10)
1591 ,@(mapcar* (lambda (c d) `(,(concat " " d) . ,c))
1593 (if display-fn (mapcar display-fn choices) choices)))))
1596 (defun yas-maybe-ido-prompt (prompt choices &optional display-fn)
1597 (when (bound-and-true-p ido-mode)
1598 (yas-ido-prompt prompt choices display-fn)))
1600 (defun yas-ido-prompt (prompt choices &optional display-fn)
1602 (yas-completing-prompt prompt choices display-fn #'ido-completing-read))
1604 (defun yas-dropdown-prompt (_prompt choices &optional display-fn)
1605 (when (fboundp 'dropdown-list)
1606 (let* ((formatted-choices
1607 (if display-fn (mapcar display-fn choices) choices))
1608 (n (dropdown-list formatted-choices)))
1609 (if n (nth n choices)
1612 (defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
1613 (let* ((formatted-choices
1614 (if display-fn (mapcar display-fn choices) choices))
1615 (chosen (funcall (or completion-fn #'completing-read)
1616 prompt formatted-choices
1617 nil 'require-match nil nil)))
1618 (if (eq choices formatted-choices)
1620 (nth (or (position chosen formatted-choices :test #'string=) 0)
1623 (defun yas-no-prompt (_prompt choices &optional _display-fn)
1627 ;;; Defining snippets
1628 ;; This consists of creating and registering `yas--template' objects in the
1632 (defvar yas--creating-compiled-snippets nil)
1634 (defun yas--define-snippets-1 (snippet snippet-table)
1635 "Helper for `yas-define-snippets'."
1636 ;; Update the appropriate table. Also takes care of adding the
1637 ;; key indicators in the templates menu entry, if any.
1638 (yas--update-template
1639 snippet-table (apply #'yas--define-snippets-2 snippet-table snippet)))
1641 (defun yas-define-snippets (mode snippets)
1642 "Define SNIPPETS for MODE.
1644 SNIPPETS is a list of snippet definitions, each taking the
1647 (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV LOAD-FILE KEYBINDING UUID SAVE-FILE)
1649 Within these, only KEY and TEMPLATE are actually mandatory.
1651 TEMPLATE might be a Lisp form or a string, depending on whether
1652 this is a snippet or a snippet-command.
1654 CONDITION, EXPAND-ENV and KEYBINDING are Lisp forms, they have
1655 been `yas--read-lisp'-ed and will eventually be
1656 `yas--eval-lisp'-ed.
1658 The remaining elements are strings.
1660 FILE is probably of very little use if you're programatically
1663 UUID is the snippet's \"unique-id\". Loading a second snippet
1664 file with the same uuid would replace the previous snippet.
1666 You can use `yas--parse-template' to return such lists based on
1667 the current buffers contents."
1668 (if yas--creating-compiled-snippets
1669 (let ((print-length nil))
1670 (insert ";;; Snippet definitions:\n;;;\n")
1671 (dolist (snippet snippets)
1672 ;; Fill in missing elements with nil.
1673 (setq snippet (append snippet (make-list (- 10 (length snippet)) nil)))
1674 ;; Move LOAD-FILE to SAVE-FILE because we will load from the
1675 ;; compiled file, not LOAD-FILE.
1676 (let ((load-file (nth 6 snippet)))
1677 (setcar (nthcdr 6 snippet) nil)
1678 (setcar (nthcdr 9 snippet) load-file)))
1679 (insert (pp-to-string
1680 `(yas-define-snippets ',mode ',snippets)))
1683 (let ((snippet-table (yas--table-get-create mode))
1685 (dolist (snippet snippets)
1686 (setq template (yas--define-snippets-1 snippet
1691 ;;; Loading snippets from files
1693 (defun yas--template-get-file (template)
1694 "Return TEMPLATE's LOAD-FILE or SAVE-FILE."
1695 (or (yas--template-load-file template)
1696 (let ((file (yas--template-save-file template)))
1698 (yas--message 2 "%s has no load file, use save file, %s, instead."
1699 (yas--template-name template) file))
1702 (defun yas--load-yas-setup-file (file)
1703 (if (not yas--creating-compiled-snippets)
1705 (load file 'noerror (<= yas-verbosity 2))
1706 (let ((elfile (concat file ".el")))
1707 (when (file-exists-p elfile)
1708 (insert ";;; contents of the .yas-setup.el support file:\n;;;\n")
1709 (insert-file-contents elfile)
1710 (goto-char (point-max))))))
1712 (defun yas--define-parents (mode parents)
1713 "Add PARENTS to the list of MODE's parents."
1714 (puthash mode (remove-duplicates
1716 (gethash mode yas--parents)))
1719 (defun yas-load-directory (top-level-dir &optional use-jit interactive)
1720 "Load snippets in directory hierarchy TOP-LEVEL-DIR.
1722 Below TOP-LEVEL-DIR each directory should be a mode name.
1724 With prefix argument USE-JIT do jit-loading of snippets."
1726 (list (read-directory-name "Select the root directory: " nil nil t)
1727 current-prefix-arg t))
1728 (unless yas-snippet-dirs
1729 (setq yas-snippet-dirs top-level-dir))
1730 (let ((impatient-buffers))
1731 (dolist (dir (yas--subdirs top-level-dir))
1732 (let* ((major-mode-and-parents (yas--compute-major-mode-and-parents
1733 (concat dir "/dummy")))
1734 (mode-sym (car major-mode-and-parents))
1735 (parents (cdr major-mode-and-parents)))
1736 ;; Attention: The parents and the menus are already defined
1737 ;; here, even if the snippets are later jit-loaded.
1739 ;; * We need to know the parents at this point since entering a
1740 ;; given mode should jit load for its parents
1741 ;; immediately. This could be reviewed, the parents could be
1742 ;; discovered just-in-time-as well
1744 ;; * We need to create the menus here to support the `full'
1745 ;; option to `yas-use-menu' (all known snippet menus are shown to the user)
1747 (yas--define-parents mode-sym parents)
1748 (yas--menu-keymap-get-create mode-sym)
1749 (let ((fun `(lambda () ;; FIXME: Simulating lexical-binding.
1750 (yas--load-directory-1 ',dir ',mode-sym))))
1752 (yas--schedule-jit mode-sym fun)
1754 ;; Look for buffers that are already in `mode-sym', and so
1755 ;; need the new snippets immediately...
1758 (cl-loop for buffer in (buffer-list)
1759 do (with-current-buffer buffer
1760 (when (eq major-mode mode-sym)
1761 (yas--message 3 "Discovered there was already %s in %s" buffer mode-sym)
1762 (push buffer impatient-buffers)))))))
1763 ;; ...after TOP-LEVEL-DIR has been completely loaded, call
1764 ;; `yas--load-pending-jits' in these impatient buffers.
1766 (cl-loop for buffer in impatient-buffers
1767 do (with-current-buffer buffer (yas--load-pending-jits))))
1769 (yas--message 3 "Loaded snippets from %s." top-level-dir)))
1771 (defun yas--load-directory-1 (directory mode-sym)
1772 "Recursively load snippet templates from DIRECTORY."
1773 (if yas--creating-compiled-snippets
1774 (let ((output-file (expand-file-name ".yas-compiled-snippets.el"
1776 (with-temp-file output-file
1777 (insert (format ";;; Compiled snippets and support files for `%s'\n"
1779 (yas--load-directory-2 directory mode-sym)
1780 (insert (format ";;; Do not edit! File generated at %s\n"
1781 (current-time-string)))))
1783 (unless (file-exists-p (expand-file-name ".yas-skip" directory))
1784 (unless (and (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3))
1785 (progn (yas--message 2 "Loaded compiled snippets from %s" directory) t))
1786 (yas--message 2 "Loading snippet files from %s" directory)
1787 (yas--load-directory-2 directory mode-sym)))))
1789 (defun yas--load-directory-2 (directory mode-sym)
1790 ;; Load .yas-setup.el files wherever we find them
1792 (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
1793 (let* ((default-directory directory)
1795 ;; load the snippet files
1798 (dolist (file (yas--subdirs directory 'no-subdirs-just-files))
1799 (when (file-readable-p file)
1800 (insert-file-contents file nil nil nil t)
1801 (push (yas--parse-template file)
1804 (yas-define-snippets mode-sym
1806 ;; now recurse to a lower level
1808 (dolist (subdir (yas--subdirs directory))
1809 (yas--load-directory-2 subdir
1812 (defun yas--load-snippet-dirs (&optional nojit)
1813 "Reload the directories listed in `yas-snippet-dirs' or
1814 prompt the user to select one."
1816 (if (null yas-snippet-dirs)
1817 (call-interactively 'yas-load-directory)
1818 (when (member yas--default-user-snippets-dir yas-snippet-dirs)
1819 (make-directory yas--default-user-snippets-dir t))
1820 (dolist (directory (reverse (yas-snippet-dirs)))
1821 (cond ((file-directory-p directory)
1822 (yas-load-directory directory (not nojit))
1824 (yas--message 3 "Loaded %s" directory)
1825 (yas--message 3 "Prepared just-in-time loading for %s" directory)))
1827 (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors)))))
1830 (defun yas-reload-all (&optional no-jit interactive)
1831 "Reload all snippets and rebuild the YASnippet menu.
1833 When NO-JIT is non-nil force immediate reload of all known
1834 snippets under `yas-snippet-dirs', otherwise use just-in-time
1837 When called interactively, use just-in-time loading when given a
1839 (interactive (list (not current-prefix-arg) t))
1842 (snippet-editing-buffers
1843 (remove-if-not #'(lambda (buffer)
1844 (with-current-buffer buffer yas--editing-template))
1846 ;; Warn if there are buffers visiting snippets, since reloading will break
1847 ;; any on-line editing of those buffers.
1849 (when snippet-editing-buffers
1851 (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
1852 (mapc #'kill-buffer snippet-editing-buffers)
1853 (yas--message 1 "Aborted reload...")
1855 ;; in a non-interactive use, at least set
1856 ;; `yas--editing-template' to nil, make it guess it next time around
1857 (mapc #'(lambda (buffer)
1858 (with-current-buffer buffer
1859 (kill-local-variable 'yas--editing-template)))
1862 ;; Empty all snippet tables and parenting info
1864 (setq yas--tables (make-hash-table))
1865 (setq yas--parents (make-hash-table))
1867 ;; Before killing `yas--menu-table' use its keys to cleanup the
1868 ;; mode menu parts of `yas--minor-mode-menu' (thus also cleaning
1869 ;; up `yas-minor-mode-map', which points to it)
1871 (maphash #'(lambda (menu-symbol _keymap)
1872 (define-key yas--minor-mode-menu (vector menu-symbol) nil))
1874 ;; Now empty `yas--menu-table' as well
1875 (setq yas--menu-table (make-hash-table))
1877 ;; Cancel all pending 'yas--scheduled-jit-loads'
1879 (setq yas--scheduled-jit-loads (make-hash-table))
1881 ;; Reload the directories listed in `yas-snippet-dirs' or prompt
1882 ;; the user to select one.
1884 (setq errors (yas--load-snippet-dirs no-jit))
1885 ;; Reload the direct keybindings
1887 (yas-direct-keymaps-reload)
1889 (run-hooks 'yas-after-reload-hook)
1890 (yas--message 3 "Reloaded everything%s...%s."
1891 (if no-jit "" " (snippets will load just-in-time)")
1892 (if errors " (some errors, check *Messages*)" "")))))
1894 (defvar yas-after-reload-hook nil
1895 "Hooks run after `yas-reload-all'.")
1897 (defun yas--load-pending-jits ()
1898 (dolist (mode (yas--modes-to-activate))
1899 (let ((funs (reverse (gethash mode yas--scheduled-jit-loads))))
1900 ;; must reverse to maintain coherence with `yas-snippet-dirs'
1902 (yas--message 3 "Loading for `%s', just-in-time: %s!" mode fun)
1904 (remhash mode yas--scheduled-jit-loads))))
1906 ;; (when (<= emacs-major-version 22)
1907 ;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
1909 (defun yas--quote-string (string)
1910 "Escape and quote STRING.
1911 foo\"bar\\! -> \"foo\\\"bar\\\\!\""
1913 (replace-regexp-in-string "[\\\"]"
1919 ;;; Snippet compilation function
1921 (defun yas-compile-directory (top-level-dir)
1922 "Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
1924 This works by stubbing a few functions, then calling
1925 `yas-load-directory'."
1926 (interactive "DTop level snippet directory?")
1927 (let ((yas--creating-compiled-snippets t))
1928 (yas-load-directory top-level-dir nil)))
1930 (defun yas-recompile-all ()
1931 "Compile every dir in `yas-snippet-dirs'."
1933 (mapc #'yas-compile-directory (yas-snippet-dirs)))
1939 (defvar yas--scheduled-jit-loads (make-hash-table)
1940 "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
1942 (defun yas--schedule-jit (mode fun)
1943 (push fun (gethash mode yas--scheduled-jit-loads)))
1947 ;;; Some user level functions
1951 (message (concat "yasnippet (version "
1953 ") -- pluskid/joaotavora/npostavs")))
1956 ;;; Apropos snippet menu:
1958 ;; The snippet menu keymaps are stored by mode in hash table called
1959 ;; `yas--menu-table'. They are linked to the main menu in
1960 ;; `yas--menu-keymap-get-create' and are initially created empty,
1961 ;; reflecting the table hierarchy.
1963 ;; They can be populated in two mutually exclusive ways: (1) by
1964 ;; reading `yas--template-group', which in turn is populated by the "#
1965 ;; group:" directives of the snippets or the ".yas-make-groups" file
1966 ;; or (2) by using a separate `yas-define-menu' call, which declares a
1967 ;; menu structure based on snippets uuids.
1969 ;; Both situations are handled in `yas--update-template-menu', which
1970 ;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
1971 ;; that can tell between the two situations.
1975 ;; * if `yas-define-menu' is used it must run before
1976 ;; `yas-define-snippets' and the UUIDS must match, otherwise we get
1977 ;; duplicate entries. The `yas--template' objects are created in
1978 ;; `yas-define-menu', holding nothing but the menu entry,
1979 ;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
1980 ;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
1981 ;; part is then stored in the menu keymap itself which make the item
1982 ;; appear to the user. These limitations could probably be revised.
1984 ;; * The `yas--template-perm-group' slot is only used in
1985 ;; `yas-describe-tables'.
1987 (defun yas--template-menu-binding-pair-get-create (template &optional type)
1988 "Get TEMPLATE's menu binding or assign it a new one.
1990 TYPE may be `:stay', signaling this menu binding should be
1991 static in the menu."
1992 (or (yas--template-menu-binding-pair template)
1993 (let (;; (key (yas--template-key template))
1994 ;; (keybinding (yas--template-keybinding template))
1996 (setf (yas--template-menu-binding-pair template)
1997 (cons `(menu-item ,(or (yas--template-name template)
1998 (yas--template-uuid template))
1999 ,(yas--make-menu-binding template)
2002 (defun yas--template-menu-managed-by-yas-define-menu (template)
2003 "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
2004 (cdr (yas--template-menu-binding-pair template)))
2007 (defun yas--show-menu-p (mode)
2008 (cond ((eq yas-use-menu 'abbreviate)
2010 (mapcar #'(lambda (table)
2011 (yas--table-mode table))
2012 (yas--get-snippet-tables))))
2015 (defun yas--delete-from-keymap (keymap uuid)
2016 "Recursively delete items with UUID from KEYMAP and its submenus."
2018 ;; XXX: This used to skip any submenus named \"parent mode\"
2020 ;; First of all, recursively enter submenus, i.e. the tree is
2021 ;; searched depth first so that stale submenus can be found in the
2024 (mapc #'(lambda (item)
2025 (when (and (listp (cdr item))
2026 (keymapp (third (cdr item))))
2027 (yas--delete-from-keymap (third (cdr item)) uuid)))
2029 ;; Set the uuid entry to nil
2031 (define-key keymap (vector (make-symbol uuid)) nil)
2032 ;; Destructively modify keymap
2034 (setcdr keymap (delete-if #'(lambda (item)
2035 (or (null (cdr item))
2036 (and (keymapp (third (cdr item)))
2037 (null (cdr (third (cdr item)))))))
2040 (defun yas-define-menu (mode menu &optional omit-items)
2041 "Define a snippet menu for MODE according to MENU, omitting OMIT-ITEMS.
2043 MENU is a list, its elements can be:
2045 - (yas-item UUID) : Creates an entry the snippet identified with
2046 UUID. The menu entry for a snippet thus identified is
2047 permanent, i.e. it will never move (be reordered) in the menu.
2049 - (yas-separator) : Creates a separator
2051 - (yas-submenu NAME SUBMENU) : Creates a submenu with NAME,
2052 SUBMENU has the same form as MENU. NAME is also added to the
2053 list of groups of the snippets defined thereafter.
2055 OMIT-ITEMS is a list of snippet uuid's that will always be
2056 omitted from MODE's menu, even if they're manually loaded."
2057 (let* ((table (yas--table-get-create mode))
2058 (hash (yas--table-uuidhash table)))
2059 (yas--define-menu-1 table
2060 (yas--menu-keymap-get-create mode)
2063 (dolist (uuid omit-items)
2064 (let ((template (or (gethash uuid hash)
2066 (yas--make-template :table table
2069 (setf (yas--template-menu-binding-pair template) (cons nil :none))))))
2071 (defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
2072 "Helper for `yas-define-menu'."
2073 (dolist (e (reverse menu))
2074 (cond ((eq (first e) 'yas-item)
2075 (let ((template (or (gethash (second e) uuidhash)
2079 :perm-group group-list
2082 (define-key menu-keymap (vector (gensym))
2083 (car (yas--template-menu-binding-pair-get-create template :stay)))))
2084 ((eq (first e) 'yas-submenu)
2085 (let ((subkeymap (make-sparse-keymap)))
2086 (define-key menu-keymap (vector (gensym))
2087 `(menu-item ,(second e) ,subkeymap))
2088 (yas--define-menu-1 table
2092 (append group-list (list (second e))))))
2093 ((eq (first e) 'yas-separator)
2094 (define-key menu-keymap (vector (gensym))
2095 '(menu-item "----")))
2097 (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
2099 (defun yas--define (mode key template &optional name condition group)
2100 "Define a snippet. Expanding KEY into TEMPLATE.
2102 NAME is a description to this template. Also update the menu if
2103 `yas-use-menu' is t. CONDITION is the condition attached to
2104 this snippet. If you attach a condition to a snippet, then it
2105 will only be expanded when the condition evaluated to non-nil."
2106 (yas-define-snippets mode
2107 (list (list key template name condition group))))
2109 (defun yas-hippie-try-expand (first-time?)
2110 "Integrate with hippie expand.
2112 Just put this function in `hippie-expand-try-functions-list'."
2113 (when yas-minor-mode
2114 (if (not first-time?)
2115 (let ((yas-fallback-behavior 'return-nil))
2121 ;;; Apropos condition-cache:
2126 (defvar yas--condition-cache-timestamp nil)
2127 (defmacro yas-define-condition-cache (func doc &rest body)
2128 "Define a function FUNC with doc DOC and body BODY.
2129 BODY is executed at most once every snippet expansion attempt, to check
2130 expansion conditions.
2132 It doesn't make any sense to call FUNC programatically."
2133 `(defun ,func () ,(if (and doc
2136 "\n\nFor use in snippets' conditions. Within each
2137 snippet-expansion routine like `yas-expand', computes actual
2138 value for the first time then always returns a cached value.")
2139 (setq body (cons doc body))
2141 (let ((timestamp-and-value (get ',func 'yas--condition-cache)))
2142 (if (equal (car timestamp-and-value) yas--condition-cache-timestamp)
2143 (cdr timestamp-and-value)
2144 (let ((new-value (progn
2147 (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
2150 (defalias 'yas-expand 'yas-expand-from-trigger-key)
2151 (defun yas-expand-from-trigger-key (&optional field)
2152 "Expand a snippet before point.
2154 If no snippet expansion is possible, fall back to the behaviour
2155 defined in `yas-fallback-behavior'.
2157 Optional argument FIELD is for non-interactive use and is an
2158 object satisfying `yas--field-p' to restrict the expansion to."
2160 (setq yas--condition-cache-timestamp (current-time))
2161 (let (templates-and-pos)
2162 (unless (and yas-expand-only-for-last-commands
2163 (not (member last-command yas-expand-only-for-last-commands)))
2164 (setq templates-and-pos (if field
2166 (narrow-to-region (yas--field-start field)
2167 (yas--field-end field))
2168 (yas--templates-for-key-at-point))
2169 (yas--templates-for-key-at-point))))
2170 (if templates-and-pos
2171 (yas--expand-or-prompt-for-template (nth 0 templates-and-pos)
2172 (nth 1 templates-and-pos)
2173 (nth 2 templates-and-pos))
2176 (defun yas-expand-from-keymap ()
2177 "Directly expand some snippets, searching `yas--direct-keymaps'.
2179 If expansion fails, execute the previous binding for this key"
2181 (setq yas--condition-cache-timestamp (current-time))
2182 (let* ((vec (subseq (this-command-keys-vector) (if current-prefix-arg
2183 (length (this-command-keys))
2185 (templates (mapcan #'(lambda (table)
2186 (yas--fetch table vec))
2187 (yas--get-snippet-tables))))
2189 (yas--expand-or-prompt-for-template templates)
2190 (let ((yas-fallback-behavior 'call-other-command))
2193 (defun yas--expand-or-prompt-for-template (templates &optional start end)
2194 "Expand one of TEMPLATES from START to END.
2196 Prompt the user if TEMPLATES has more than one element, else
2197 expand immediately. Common gateway for
2198 `yas-expand-from-trigger-key' and `yas-expand-from-keymap'."
2199 (let ((yas--current-template (or (and (rest templates) ;; more than one
2200 (yas--prompt-for-template (mapcar #'cdr templates)))
2202 (when yas--current-template
2203 (yas-expand-snippet (yas--template-content yas--current-template)
2206 (yas--template-expand-env yas--current-template)))))
2208 ;; Apropos the trigger key and the fallback binding:
2210 ;; When `yas-minor-mode-map' binds <tab>, that correctly overrides
2211 ;; org-mode's <tab>, for example and searching for fallbacks correctly
2212 ;; returns `org-cycle'. However, most other modes bind "TAB". TODO,
2213 ;; improve this explanation.
2215 (defun yas--fallback ()
2216 "Fallback after expansion has failed.
2218 Common gateway for `yas-expand-from-trigger-key' and
2219 `yas-expand-from-keymap'."
2220 (cond ((eq yas-fallback-behavior 'return-nil)
2223 ((eq yas-fallback-behavior 'yas--fallback)
2224 (error (concat "yasnippet fallback loop!\n"
2225 "This can happen when you bind `yas-expand' "
2226 "outside of the `yas-minor-mode-map'.")))
2227 ((eq yas-fallback-behavior 'call-other-command)
2228 (let* ((yas-fallback-behavior 'yas--fallback)
2229 ;; Also bind `yas-minor-mode' to prevent fallback
2230 ;; loops when other extensions use mechanisms similar
2231 ;; to `yas--keybinding-beyond-yasnippet'. (github #525
2234 (yas-minor-mode nil)
2235 (beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
2236 (yas--message 4 "Falling back to %s" beyond-yasnippet)
2237 (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
2238 (setq this-command beyond-yasnippet)
2239 (when beyond-yasnippet
2240 (call-interactively beyond-yasnippet))))
2241 ((and (listp yas-fallback-behavior)
2242 (cdr yas-fallback-behavior)
2243 (eq 'apply (car yas-fallback-behavior)))
2244 (let ((command-or-fn (cadr yas-fallback-behavior))
2245 (args (cddr yas-fallback-behavior))
2246 (yas-fallback-behavior 'yas--fallback)
2247 (yas-minor-mode nil))
2249 (apply command-or-fn args)
2250 (when (commandp command-or-fn)
2251 (setq this-command command-or-fn)
2252 (call-interactively command-or-fn)))))
2254 ;; also return nil if all the other fallbacks have failed
2257 (defun yas--keybinding-beyond-yasnippet ()
2258 "Get current keys's binding as if YASsnippet didn't exist."
2259 (let* ((yas-minor-mode nil)
2260 (yas--direct-keymaps nil)
2261 (keys (this-single-command-keys)))
2262 (or (key-binding keys t)
2263 (key-binding (yas--fallback-translate-input keys) t))))
2265 (defun yas--fallback-translate-input (keys)
2266 "Emulate `read-key-sequence', at least what I think it does.
2268 Keys should be an untranslated key vector. Returns a translated
2269 vector of keys. FIXME not thoroughly tested."
2272 (while (< i (length keys))
2274 (translated local-function-key-map))
2275 (while (and (< j (length keys))
2277 (keymapp translated))
2278 (setq translated (cdr (assoc (aref keys j) (remove 'keymap translated)))
2280 (setq retval (vconcat retval (cond ((symbolp translated)
2282 ((vectorp translated)
2285 (substring keys i j)))))
2290 ;;; Utils for snippet development:
2292 (defun yas--all-templates (tables)
2293 "Get `yas--template' objects in TABLES, applicable for buffer and point.
2295 Honours `yas-choose-tables-first', `yas-choose-keys-first' and
2296 `yas-buffer-local-condition'"
2297 (when yas-choose-tables-first
2298 (setq tables (list (yas--prompt-for-table tables))))
2300 (if yas-choose-keys-first
2301 (let ((key (yas--prompt-for-keys
2302 (mapcan #'yas--table-all-keys tables))))
2304 (mapcan #'(lambda (table)
2305 (yas--fetch table key))
2307 (remove-duplicates (mapcan #'yas--table-templates tables)
2310 (defun yas--lookup-snippet-1 (name mode)
2311 "Get the snippet called NAME in MODE's tables."
2312 (let ((yas-choose-tables-first nil) ; avoid prompts
2313 (yas-choose-keys-first nil))
2314 (cl-find name (yas--all-templates
2315 (yas--get-snippet-tables mode))
2316 :key #'yas--template-name :test #'string=)))
2318 (defun yas-lookup-snippet (name &optional mode noerror)
2319 "Get the snippet content for the snippet NAME in MODE's tables.
2321 MODE defaults to the current buffer's `major-mode'. If NOERROR
2322 is non-nil, then don't signal an error if there isn't any snippet
2325 Honours `yas-buffer-local-condition'."
2326 (let ((snippet (yas--lookup-snippet-1 name mode)))
2328 (snippet (yas--template-content snippet))
2330 (t (error "No snippet named: %s" name)))))
2332 (defun yas-insert-snippet (&optional no-condition)
2333 "Choose a snippet to expand, pop-up a list of choices according
2334 to `yas-prompt-functions'.
2336 With prefix argument NO-CONDITION, bypass filtering of snippets
2339 (setq yas--condition-cache-timestamp (current-time))
2340 (let* ((yas-buffer-local-condition (or (and no-condition
2342 yas-buffer-local-condition))
2343 (templates (yas--all-templates (yas--get-snippet-tables)))
2344 (yas--current-template (and templates
2345 (or (and (rest templates) ;; more than one template for same key
2346 (yas--prompt-for-template templates))
2348 (where (if (region-active-p)
2349 (cons (region-beginning) (region-end))
2350 (cons (point) (point)))))
2351 (if yas--current-template
2352 (yas-expand-snippet (yas--template-content yas--current-template)
2355 (yas--template-expand-env yas--current-template))
2356 (yas--message 3 "No snippets can be inserted here!"))))
2358 (defun yas-visit-snippet-file ()
2359 "Choose a snippet to edit, selection like `yas-insert-snippet'.
2361 Only success if selected snippet was loaded from a file. Put the
2362 visited file in `snippet-mode'."
2364 (let* ((yas-buffer-local-condition 'always)
2365 (templates (yas--all-templates (yas--get-snippet-tables)))
2366 (template (and templates
2367 (or (yas--prompt-for-template templates
2368 "Choose a snippet template to edit: ")
2372 (yas--visit-snippet-file-1 template)
2373 (message "No snippets tables active!"))))
2375 (defun yas--visit-snippet-file-1 (template)
2376 "Helper for `yas-visit-snippet-file'."
2377 (let ((file (yas--template-get-file template)))
2378 (cond ((and file (file-readable-p file))
2379 (find-file-other-window file)
2381 (set (make-local-variable 'yas--editing-template) template))
2383 (message "Original file %s no longer exists!" file))
2385 (switch-to-buffer (format "*%s*"(yas--template-name template)))
2386 (let ((type 'snippet))
2387 (when (listp (yas--template-content template))
2388 (insert (format "# type: command\n"))
2389 (setq type 'command))
2390 (insert (format "# key: %s\n" (yas--template-key template)))
2391 (insert (format "# name: %s\n" (yas--template-name template)))
2392 (when (yas--template-keybinding template)
2393 (insert (format "# binding: %s\n" (yas--template-keybinding template))))
2394 (when (yas--template-expand-env template)
2395 (insert (format "# expand-env: %s\n" (yas--template-expand-env template))))
2396 (when (yas--template-condition template)
2397 (insert (format "# condition: %s\n" (yas--template-condition template))))
2399 (insert (if (eq type 'command)
2400 (pp-to-string (yas--template-content template))
2401 (yas--template-content template))))
2403 (set (make-local-variable 'yas--editing-template) template)))))
2405 (defun yas--guess-snippet-directories-1 (table)
2406 "Guess possible snippet subdirectories for TABLE."
2407 (cons (yas--table-name table)
2408 (mapcan #'(lambda (parent)
2409 (yas--guess-snippet-directories-1
2411 (yas--table-parents table))))
2413 (defun yas--guess-snippet-directories (&optional table)
2414 "Try to guess suitable directories based on the current active
2415 tables (or optional TABLE).
2417 Returns a list of elements (TABLE . DIRS) where TABLE is a
2418 `yas--table' object and DIRS is a list of all possible directories
2419 where snippets of table might exist."
2420 (let ((main-dir (car (or (yas-snippet-dirs)
2421 (setq yas-snippet-dirs
2422 (list yas--default-user-snippets-dir)))))
2423 (tables (if table (list table)
2424 (yas--get-snippet-tables))))
2425 ;; HACK! the snippet table created here is actually registered!
2427 (unless (or table (gethash major-mode yas--tables))
2428 (push (yas--table-get-create major-mode)
2431 (mapcar #'(lambda (table)
2433 (mapcar #'(lambda (subdir)
2434 (expand-file-name subdir main-dir))
2435 (yas--guess-snippet-directories-1 table))))
2438 (defun yas--make-directory-maybe (table-and-dirs &optional main-table-string)
2439 "Return a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
2440 (or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
2441 (let ((candidate (first (cdr table-and-dirs))))
2442 (unless (file-writable-p (file-name-directory candidate))
2443 (error (yas--format "%s is not writable." candidate)))
2444 (if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
2446 (if (gethash (yas--table-mode (car table-and-dirs))
2450 (or main-table-string
2452 (yas--table-name (car table-and-dirs))))
2454 (make-directory candidate 'also-make-parents)
2455 ;; create the .yas-parents file here...
2458 (defun yas-new-snippet (&optional no-template)
2459 "Pops a new buffer for writing a snippet.
2461 Expands a snippet-writing snippet, unless the optional prefix arg
2462 NO-TEMPLATE is non-nil."
2464 (let ((guessed-directories (yas--guess-snippet-directories)))
2466 (switch-to-buffer "*new snippet*")
2468 (kill-all-local-variables)
2471 (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
2472 (yas--table-mode (car d)))
2473 guessed-directories))
2474 (if (and (not no-template) yas-new-snippet-default)
2475 (yas-expand-snippet yas-new-snippet-default))))
2477 (defun yas--compute-major-mode-and-parents (file)
2478 "Given FILE, find the nearest snippet directory for a given mode.
2480 Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
2481 representing one or more of the mode's parents.
2483 Note that MODE-SYM need not be the symbol of a real major mode,
2484 neither do the elements of PARENTS."
2485 (let* ((file-dir (and file
2486 (directory-file-name (or (some #'(lambda (special)
2487 (locate-dominating-file file special))
2491 (directory-file-name (file-name-directory file))))))
2492 (parents-file-name (concat file-dir "/.yas-parents"))
2493 (major-mode-name (and file-dir
2494 (file-name-nondirectory file-dir)))
2495 (major-mode-sym (or (and major-mode-name
2496 (intern major-mode-name))))
2497 (parents (when (file-readable-p parents-file-name)
2501 (insert-file-contents parents-file-name)
2502 (buffer-substring-no-properties (point-min)
2504 (when major-mode-sym
2505 (cons major-mode-sym (remove major-mode-sym parents)))))
2507 (defvar yas--editing-template nil
2508 "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
2510 (defvar yas--current-template nil
2511 "Holds the current template being expanded into a snippet.")
2513 (defvar yas--guessed-modes nil
2514 "List of guessed modes supporting `yas-load-snippet-buffer'.")
2516 (defun yas--read-table ()
2517 "Ask user for a snippet table, help with some guessing."
2518 (let ((prompt (if (and (featurep 'ido)
2520 'ido-completing-read 'completing-read)))
2521 (unless yas--guessed-modes
2522 (set (make-local-variable 'yas--guessed-modes)
2523 (or (yas--compute-major-mode-and-parents buffer-file-name))))
2525 (funcall prompt (format "Choose or enter a table (yas guesses %s): "
2526 (if yas--guessed-modes
2527 (first yas--guessed-modes)
2529 (mapcar #'symbol-name yas--guessed-modes)
2534 (if (first yas--guessed-modes)
2535 (symbol-name (first yas--guessed-modes)))))))
2537 (defun yas-load-snippet-buffer (table &optional interactive)
2538 "Parse and load current buffer's snippet definition into TABLE.
2540 TABLE is a symbol naming a passed to `yas--table-get-create'.
2542 When called interactively, prompt for the table name."
2543 (interactive (list (yas--read-table) t))
2545 ;; We have `yas--editing-template', this buffer's content comes from a
2546 ;; template which is already loaded and neatly positioned,...
2548 (yas--editing-template
2549 (yas--define-snippets-1 (yas--parse-template (yas--template-load-file yas--editing-template))
2550 (yas--template-table yas--editing-template)))
2551 ;; Try to use `yas--guessed-modes'. If we don't have that use the
2552 ;; value from `yas--compute-major-mode-and-parents'
2555 (unless yas--guessed-modes
2556 (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
2557 (let* ((table (yas--table-get-create table)))
2558 (set (make-local-variable 'yas--editing-template)
2559 (yas--define-snippets-1 (yas--parse-template buffer-file-name)
2562 (yas--message 3 "Snippet \"%s\" loaded for %s."
2563 (yas--template-name yas--editing-template)
2564 (yas--table-name (yas--template-table yas--editing-template)))))
2566 (defun yas-load-snippet-buffer-and-close (table &optional kill)
2567 "Load the snippet with `yas-load-snippet-buffer', possibly
2568 save, then `quit-window' if saved.
2570 If the snippet is new, ask the user whether (and where) to save
2571 it. If the snippet already has a file, just save it.
2573 The prefix argument KILL is passed to `quit-window'.
2575 Don't use this from a Lisp program, call `yas-load-snippet-buffer'
2576 and `kill-buffer' instead."
2577 (interactive (list (yas--read-table) current-prefix-arg))
2578 (yas-load-snippet-buffer table t)
2579 (let ((file (yas--template-get-file yas--editing-template)))
2581 ;; Only offer to save this if it looks like a library or new
2582 ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
2583 ;; which is not the first, or from an unwritable file)
2586 (not (file-writable-p file))
2587 (and (cdr-safe yas-snippet-dirs)
2588 (not (string-prefix-p (expand-file-name (car yas-snippet-dirs)) file))))
2589 (y-or-n-p (yas--format "Looks like a library or new snippet. Save to new file? ")))
2590 (let* ((option (first (yas--guess-snippet-directories (yas--template-table yas--editing-template))))
2592 (yas--make-directory-maybe option))))
2594 (let ((default-file-name (or (and file (file-name-nondirectory file))
2595 (yas--template-name yas--editing-template))))
2596 (write-file (expand-file-name
2597 (read-file-name (format "File name to create in %s? " chosen)
2598 chosen default-file-name)
2600 (setf (yas--template-load-file yas--editing-template) buffer-file-name))))))
2601 (when buffer-file-name
2603 (quit-window kill)))
2605 (defun yas-tryout-snippet (&optional debug)
2606 "Test current buffer's snippet template in other buffer."
2608 (let* ((major-mode-and-parent (yas--compute-major-mode-and-parents buffer-file-name))
2609 (parsed (yas--parse-template))
2610 (test-mode (or (and (car major-mode-and-parent)
2611 (fboundp (car major-mode-and-parent))
2612 (car major-mode-and-parent))
2613 (first yas--guessed-modes)
2614 (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
2615 (yas--current-template
2618 (yas--make-template :table nil ;; no tables for ephemeral snippets
2620 :content (nth 1 parsed)
2621 :name (nth 2 parsed)
2622 :expand-env (nth 5 parsed)))))
2623 (cond (yas--current-template
2624 (let ((buffer-name (format "*testing snippet: %s*" (yas--template-name yas--current-template))))
2625 (kill-buffer (get-buffer-create buffer-name))
2626 (switch-to-buffer (get-buffer-create buffer-name))
2627 (setq buffer-undo-list nil)
2628 (condition-case nil (funcall test-mode) (error nil))
2630 (setq buffer-read-only nil)
2631 (yas-expand-snippet (yas--template-content yas--current-template)
2634 (yas--template-expand-env yas--current-template))
2636 (require 'yasnippet-debug nil t))
2637 (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
2639 (yas--message 3 "Cannot test snippet for unknown major mode")))))
2641 (defun yas-active-keys ()
2642 "Return all active trigger keys for current buffer and point."
2644 (remove-if-not #'stringp (mapcan #'yas--table-all-keys (yas--get-snippet-tables)))
2647 (defun yas--template-fine-group (template)
2648 (car (last (or (yas--template-group template)
2649 (yas--template-perm-group template)))))
2651 (defun yas-describe-tables (&optional choose)
2652 "Display snippets for each table."
2654 (let* ((by-name-hash (and choose
2655 (y-or-n-p "Show by namehash? ")))
2656 (buffer (get-buffer-create "*YASnippet tables*"))
2657 (active-tables (yas--get-snippet-tables))
2658 (remain-tables (let ((all))
2659 (maphash #'(lambda (_k v)
2660 (unless (find v active-tables)
2664 (table-lists (list active-tables remain-tables))
2665 (original-buffer (current-buffer))
2667 (yas--condition-cache-timestamp (current-time)))
2668 (with-current-buffer buffer
2669 (setq buffer-read-only nil)
2671 (cond ((not by-name-hash)
2672 (insert "YASnippet tables:\n")
2673 (while (and table-lists
2675 (dolist (table (car table-lists))
2676 (yas--describe-pretty-table table original-buffer))
2677 (setq table-lists (cdr table-lists))
2679 (yas--create-snippet-xrefs)
2680 (display-buffer buffer)
2681 (setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
2682 (yas--create-snippet-xrefs)
2686 (insert "\n\nYASnippet tables by NAMEHASH: \n")
2687 (dolist (table (append active-tables remain-tables))
2688 (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
2690 (maphash #'(lambda (k _v)
2692 (yas--table-hash table))
2694 (insert (format " key %s maps snippets: %s\n" key
2696 (maphash #'(lambda (k _v)
2698 (gethash key (yas--table-hash table)))
2701 (setq buffer-read-only t))
2702 (display-buffer buffer)))
2704 (defun yas--describe-pretty-table (table &optional original-buffer)
2705 (insert (format "\nSnippet table `%s'"
2706 (yas--table-name table)))
2707 (if (yas--table-parents table)
2708 (insert (format " parents: %s\n"
2709 (mapcar #'yas--table-name
2710 (yas--table-parents table))))
2712 (insert (make-string 100 ?-) "\n")
2713 (insert "group state name key binding\n")
2714 (let ((groups-hash (make-hash-table :test #'equal)))
2715 (maphash #'(lambda (_k v)
2716 (let ((group (or (yas--template-fine-group v)
2718 (when (yas--template-name v)
2720 (cons v (gethash group groups-hash))
2722 (yas--table-uuidhash table))
2724 #'(lambda (group templates)
2725 (setq group (truncate-string-to-width group 25 0 ? "..."))
2726 (insert (make-string 100 ?-) "\n")
2727 (dolist (p templates)
2728 (let* ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas--template-name p))
2732 (setq group (make-string (length group) ? ))))
2733 (condition-string (let ((condition (yas--template-condition p)))
2736 (with-current-buffer original-buffer
2737 (if (yas--eval-condition condition)
2741 (key-description-string (key-description (yas--template-keybinding p)))
2742 (template-key-padding (if (string= key-description-string "") nil ? )))
2744 condition-string " "
2745 name (if (string-match "\\.\\.\\.$" name)
2748 (truncate-string-to-width (or (yas--template-key p) "")
2749 15 0 template-key-padding "...")
2750 (or template-key-padding "")
2751 (truncate-string-to-width key-description-string
2758 ;;; User convenience functions, for using in `yas-key-syntaxes'
2760 (defun yas-try-key-from-whitespace (_start-point)
2761 "As `yas-key-syntaxes' element, look for whitespace delimited key.
2763 A newline will be considered whitespace even if the mode syntax
2764 marks it as something else (typically comment ender)."
2765 (skip-chars-backward "^[:space:]\n"))
2767 (defun yas-shortest-key-until-whitespace (_start-point)
2768 "Like `yas-longest-key-from-whitespace' but take the shortest key."
2769 (when (/= (skip-chars-backward "^[:space:]\n" (1- (point))) 0)
2772 (defun yas-longest-key-from-whitespace (start-point)
2773 "As `yas-key-syntaxes' element, look for longest key between point and whitespace.
2775 A newline will be considered whitespace even if the mode syntax
2776 marks it as something else (typically comment ender)."
2777 (if (= (point) start-point)
2778 (yas-try-key-from-whitespace start-point)
2780 (unless (<= start-point (1+ (point)))
2785 ;;; User convenience functions, for using in snippet definitions
2787 (defvar yas-modified-p nil
2788 "Non-nil if field has been modified by user or transformation.")
2790 (defvar yas-moving-away-p nil
2791 "Non-nil if user is about to exit field.")
2793 (defvar yas-text nil
2794 "Contains current field text.")
2796 (defun yas-substr (str pattern &optional subexp)
2797 "Search PATTERN in STR and return SUBEXPth match.
2799 If found, the content of subexp group SUBEXP (default 0) is
2800 returned, or else the original STR will be returned."
2801 (let ((grp (or subexp 0)))
2803 (if (string-match pattern str)
2804 (match-string-no-properties grp str)
2807 (defun yas-choose-value (&rest possibilities)
2808 "Prompt for a string in POSSIBILITIES and return it.
2810 The last element of POSSIBILITIES may be a list of strings."
2811 (unless (or yas-moving-away-p
2813 (let* ((last-link (last possibilities))
2814 (last-elem (car last-link)))
2815 (when (listp last-elem)
2816 (setcar last-link (car last-elem))
2817 (setcdr last-link (cdr last-elem))))
2818 (some #'(lambda (fn)
2819 (funcall fn "Choose: " possibilities))
2820 yas-prompt-functions)))
2822 (defun yas-key-to-value (alist)
2823 (unless (or yas-moving-away-p
2825 (let ((key (read-key-sequence "")))
2827 (or (cdr (find key alist :key #'car :test #'string=))
2830 (defun yas-throw (text)
2831 "Throw a yas--exception with TEXT as the reason."
2832 (throw 'yas--exception (cons 'yas--exception text)))
2834 (defun yas-verify-value (possibilities)
2835 "Verify that the current field value is in POSSIBILITIES.
2837 Otherwise throw exception."
2838 (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
2839 (yas-throw (yas--format "Field only allows %s" possibilities))))
2841 (defun yas-field-value (number)
2842 "Get the string for field with NUMBER.
2844 Use this in primary and mirror transformations to tget."
2845 (let* ((snippet (car (yas--snippets-at-point)))
2847 (yas--snippet-find-field snippet number))))
2849 (yas--field-text-for-display field))))
2852 "Return `yas-text' if that exists and is non-empty, else nil."
2854 (not (string= "" yas-text)))
2857 (defun yas-selected-text ()
2858 "Return `yas-selected-text' if that exists and is non-empty, else nil."
2859 (if (and yas-selected-text
2860 (not (string= "" yas-selected-text)))
2863 (defun yas--get-field-once (number &optional transform-fn)
2864 (unless yas-modified-p
2866 (funcall transform-fn (yas-field-value number))
2867 (yas-field-value number))))
2869 (defun yas-default-from-field (number)
2870 (unless yas-modified-p
2871 (yas-field-value number)))
2873 (defun yas-inside-string ()
2874 "Return non-nil if the point is inside a string according to font-lock."
2875 (equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
2877 (defun yas-unimplemented (&optional missing-feature)
2878 (if yas--current-template
2879 (if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
2882 (yas--visit-snippet-file-1 yas--current-template))
2883 (message "No implementation. Missing %s" (or missing-feature "something"))))
2886 ;;; Snippet expansion and field management
2888 (defvar yas--active-field-overlay nil
2889 "Overlays the currently active field.")
2891 (defvar yas--field-protection-overlays nil
2892 "Two overlays protect the current active field.")
2894 (defvar yas-selected-text nil
2895 "The selected region deleted on the last snippet expansion.")
2897 (defvar yas--start-column nil
2898 "The column where the snippet expansion started.")
2900 (make-variable-buffer-local 'yas--active-field-overlay)
2901 (make-variable-buffer-local 'yas--field-protection-overlays)
2902 (put 'yas--active-field-overlay 'permanent-local t)
2903 (put 'yas--field-protection-overlays 'permanent-local t)
2905 (defstruct (yas--snippet (:constructor yas--make-snippet ()))
2911 (id (yas--snippet-next-id) :read-only t)
2912 (control-overlay nil)
2914 ;; stacked expansion: the `previous-active-field' slot saves the
2915 ;; active field where the child expansion took place
2916 previous-active-field
2919 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
2922 NUMBER is the field number.
2923 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2924 PARENT-FIELD is a `yas--field' this field is nested under, or nil.
2925 MIRRORS is a list of `yas--mirror's
2926 TRANSFORM is a lisp form.
2927 MODIFIED-P is a boolean set to true once user inputs text.
2928 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'.
2939 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
2942 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2943 TRANSFORM is a lisp form.
2944 PARENT-FIELD is a `yas--field' this mirror is nested under, or nil.
2945 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'
2946 DEPTH is a count of how many nested mirrors can affect this mirror"
2953 (defstruct (yas--exit (:constructor yas--make-exit (marker)))
2957 (defun yas--apply-transform (field-or-mirror field &optional empty-on-nil-p)
2958 "Calculate transformed string for FIELD-OR-MIRROR from FIELD.
2960 If there is no transform for ht field, return nil.
2962 If there is a transform but it returns nil, return the empty
2963 string iff EMPTY-ON-NIL-P is true."
2964 (let* ((yas-text (yas--field-text-for-display field))
2965 (yas-modified-p (yas--field-modified-p field))
2966 (yas-moving-away-p nil)
2967 (transform (if (yas--mirror-p field-or-mirror)
2968 (yas--mirror-transform field-or-mirror)
2969 (yas--field-transform field-or-mirror)))
2970 (start-point (if (yas--mirror-p field-or-mirror)
2971 (yas--mirror-start field-or-mirror)
2972 (yas--field-start field-or-mirror)))
2973 (transformed (and transform
2975 (goto-char start-point)
2976 (let ((ret (yas--eval-lisp transform)))
2977 (or ret (and empty-on-nil-p "")))))))
2980 (defsubst yas--replace-all (from to &optional text)
2981 "Replace all occurrences from FROM to TO.
2983 With optional string TEXT do it in that string."
2985 (replace-regexp-in-string (regexp-quote from) to text t t)
2986 (goto-char (point-min))
2987 (while (search-forward from nil t)
2988 (replace-match to t t text))))
2990 (defun yas--snippet-find-field (snippet number)
2991 (find-if #'(lambda (field)
2992 (eq number (yas--field-number field)))
2993 (yas--snippet-fields snippet)))
2995 (defun yas--snippet-sort-fields (snippet)
2996 "Sort the fields of SNIPPET in navigation order."
2997 (setf (yas--snippet-fields snippet)
2998 (sort (yas--snippet-fields snippet)
2999 #'yas--snippet-field-compare)))
3001 (defun yas--snippet-field-compare (field1 field2)
3002 "Compare FIELD1 and FIELD2.
3004 The field with a number is sorted first. If they both have a
3005 number, compare through the number. If neither have, compare
3006 through the field's start point"
3007 (let ((n1 (yas--field-number field1))
3008 (n2 (yas--field-number field2)))
3011 (or (zerop n2) (and (not (zerop n1))
3016 (< (yas--field-start field1)
3017 (yas--field-start field2))))))
3019 (defun yas--field-probably-deleted-p (snippet field)
3020 "Guess if SNIPPET's FIELD should be skipped."
3022 ;; field must be zero length
3024 (zerop (- (yas--field-start field) (yas--field-end field)))
3025 ;; field must have been modified
3027 (yas--field-modified-p field)
3030 ;; 1) it's a nested field
3032 (yas--field-parent-field field)
3033 ;; 2) ends just before the snippet end
3035 (and (eq field (car (last (yas--snippet-fields snippet))))
3036 (= (yas--field-start field) (overlay-end (yas--snippet-control-overlay snippet)))))
3037 ;; the field numbered 0, just before the exit marker, should
3040 (not (and (yas--field-number field)
3041 (zerop (yas--field-number field))))))
3043 (defun yas--snippets-at-point (&optional all-snippets)
3044 "Return a sorted list of snippets at point.
3046 The most recently-inserted snippets are returned first."
3048 (delq nil (delete-dups
3049 (mapcar (lambda (ov) (overlay-get ov 'yas--snippet))
3050 (if all-snippets (overlays-in (point-min) (point-max))
3051 (nconc (overlays-at (point))
3052 (overlays-at (1- (point))))))))
3054 (<= (yas--snippet-id s2) (yas--snippet-id s1)))))
3056 (defun yas-next-field-or-maybe-expand ()
3057 "Try to expand a snippet at a key before point.
3059 Otherwise delegate to `yas-next-field'."
3061 (if yas-triggers-in-field
3062 (let ((yas-fallback-behavior 'return-nil)
3063 (active-field (overlay-get yas--active-field-overlay 'yas--field)))
3065 (unless (yas-expand-from-trigger-key active-field)
3069 (defun yas-next-field-will-exit-p (&optional arg)
3070 "Return non-nil if (yas-next-field ARG) would exit the current snippet."
3071 (let ((snippet (car (yas--snippets-at-point)))
3072 (active (overlay-get yas--active-field-overlay 'yas--field)))
3074 (not (yas--find-next-field arg snippet active)))))
3076 (defun yas--find-next-field (n snippet active)
3077 "Return the Nth field after the ACTIVE one in SNIPPET."
3078 (let ((live-fields (cl-remove-if
3080 (and (not (eq field active))
3081 (yas--field-probably-deleted-p snippet field)))
3082 (yas--snippet-fields snippet))))
3083 (if (>= n 0) (nth n (memq active live-fields))
3084 (car (last (memq active (reverse live-fields)) (- n))))))
3086 (defun yas-next-field (&optional arg)
3087 "Navigate to the ARGth next field.
3089 If there's none, exit the snippet."
3091 (unless arg (setq arg 1))
3092 (let* ((snippet (car (yas--snippets-at-point)))
3093 (active-field (overlay-get yas--active-field-overlay 'yas--field))
3094 (target-field (yas--find-next-field arg snippet active-field)))
3095 ;; First check if we're moving out of a field with a transform.
3096 (when (and active-field (yas--field-transform active-field))
3097 (let* ((yas-moving-away-p t)
3098 (yas-text (yas--field-text-for-display active-field))
3099 (yas-modified-p (yas--field-modified-p active-field)))
3100 ;; primary field transform: exit call to field-transform
3101 (yas--eval-lisp (yas--field-transform active-field))))
3102 ;; Now actually move...
3104 (yas--move-to-field snippet target-field)
3105 (yas-exit-snippet snippet))))
3107 (defun yas--place-overlays (snippet field)
3108 "Correctly place overlays for SNIPPET's FIELD."
3109 (yas--make-move-field-protection-overlays snippet field)
3110 (yas--make-move-active-field-overlay snippet field))
3112 (defun yas--move-to-field (snippet field)
3113 "Update SNIPPET to move to field FIELD.
3115 Also create some protection overlays"
3116 (goto-char (yas--field-start field))
3117 (yas--place-overlays snippet field)
3118 (overlay-put yas--active-field-overlay 'yas--field field)
3119 (let ((number (yas--field-number field)))
3120 ;; check for the special ${0: ...} field
3121 (if (and number (zerop number))
3123 (set-mark (yas--field-end field))
3124 (setf (yas--snippet-force-exit snippet)
3125 (or (yas--field-transform field)
3127 ;; make this field active
3128 (setf (yas--snippet-active-field snippet) field)
3129 ;; primary field transform: first call to snippet transform
3130 (unless (yas--field-modified-p field)
3131 (if (yas--field-update-display field)
3132 (yas--update-mirrors snippet)
3133 (setf (yas--field-modified-p field) nil))))))
3135 (defun yas-prev-field ()
3136 "Navigate to prev field. If there's none, exit the snippet."
3138 (yas-next-field -1))
3140 (defun yas-abort-snippet (&optional snippet)
3142 (let ((snippet (or snippet
3143 (car (yas--snippets-at-point)))))
3145 (setf (yas--snippet-force-exit snippet) t))))
3147 (defun yas-exit-snippet (snippet)
3148 "Goto exit-marker of SNIPPET."
3149 (interactive (list (first (yas--snippets-at-point))))
3151 (setf (yas--snippet-force-exit snippet) t)
3152 (goto-char (if (yas--snippet-exit snippet)
3153 (yas--exit-marker (yas--snippet-exit snippet))
3154 (overlay-end (yas--snippet-control-overlay snippet))))))
3156 (defun yas-exit-all-snippets ()
3157 "Exit all snippets."
3159 (mapc #'(lambda (snippet)
3160 (yas-exit-snippet snippet)
3161 (yas--check-commit-snippet))
3162 (yas--snippets-at-point 'all-snippets)))
3165 ;;; Some low level snippet-routines:
3167 (defvar yas--inhibit-overlay-hooks nil
3168 "Bind this temporarily to non-nil to prevent running `yas--on-*-modification'.")
3170 (defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
3171 (defvar yas-snippet-end nil "End position of the last snippet committed.")
3173 (defun yas--commit-snippet (snippet)
3174 "Commit SNIPPET, but leave point as it is.
3176 This renders the snippet as ordinary text."
3178 (let ((control-overlay (yas--snippet-control-overlay snippet)))
3180 ;; Save the end of the moribund snippet in case we need to revive it
3181 ;; its original expansion.
3183 (when (and control-overlay
3184 (overlay-buffer control-overlay))
3185 (setq yas-snippet-beg (overlay-start control-overlay))
3186 (setq yas-snippet-end (overlay-end control-overlay))
3187 (delete-overlay control-overlay))
3189 (let ((yas--inhibit-overlay-hooks t))
3190 (when yas--active-field-overlay
3191 (delete-overlay yas--active-field-overlay))
3192 (when yas--field-protection-overlays
3193 (mapc #'delete-overlay yas--field-protection-overlays)))
3195 ;; stacked expansion: if the original expansion took place from a
3196 ;; field, make sure we advance it here at least to
3197 ;; `yas-snippet-end'...
3199 (let ((previous-field (yas--snippet-previous-active-field snippet)))
3200 (when (and yas-snippet-end previous-field)
3201 (yas--advance-end-maybe previous-field yas-snippet-end)))
3203 ;; Convert all markers to points,
3205 (yas--markers-to-points snippet)
3207 ;; Take care of snippet revival
3209 (if yas-snippet-revival
3210 (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
3212 ;; Dismember the snippet... this is useful if we get called
3213 ;; again from `yas--take-care-of-redo'....
3214 (setf (yas--snippet-fields snippet) nil)))
3216 (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
3218 (defun yas--safely-run-hooks (hook-var)
3219 (condition-case error
3220 (run-hooks hook-var)
3222 (yas--message 3 "%s error: %s" hook-var (error-message-string error)))))
3225 (defun yas--check-commit-snippet ()
3226 "Check if point exited the currently active field of the snippet.
3228 If so cleans up the whole snippet up."
3229 (let* ((snippets (yas--snippets-at-point 'all-snippets))
3230 (snippets-left snippets)
3231 (snippet-exit-transform))
3232 (dolist (snippet snippets)
3233 (let ((active-field (yas--snippet-active-field snippet)))
3234 (setq snippet-exit-transform (yas--snippet-force-exit snippet))
3235 (cond ((or snippet-exit-transform
3236 (not (and active-field (yas--field-contains-point-p active-field))))
3237 (setq snippets-left (delete snippet snippets-left))
3238 (setf (yas--snippet-force-exit snippet) nil)
3239 (yas--commit-snippet snippet))
3241 (or (not yas--active-field-overlay)
3242 (not (overlay-buffer yas--active-field-overlay))))
3244 ;; stacked expansion: this case is mainly for recent
3245 ;; snippet exits that place us back int the field of
3249 (yas--move-to-field snippet active-field)
3250 (yas--update-mirrors snippet)))
3253 (unless (or (null snippets) snippets-left)
3254 (if snippet-exit-transform
3255 (yas--eval-lisp-no-saves snippet-exit-transform))
3256 (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
3258 ;; Apropos markers-to-points:
3260 ;; This was found useful for performance reasons, so that an
3261 ;; excessive number of live markers aren't kept around in the
3262 ;; `buffer-undo-list'. However, in `markers-to-points', the
3263 ;; set-to-nil markers can't simply be discarded and replaced with
3264 ;; fresh ones in `points-to-markers'. The original marker that was
3265 ;; just set to nil has to be reused.
3267 ;; This shouldn't bring horrible problems with undo/redo, but it
3270 (defun yas--markers-to-points (snippet)
3271 "Convert all markers in SNIPPET to a cons (POINT . MARKER)
3272 where POINT is the original position of the marker and MARKER is
3273 the original marker object with the position set to nil."
3274 (dolist (field (yas--snippet-fields snippet))
3275 (let ((start (marker-position (yas--field-start field)))
3276 (end (marker-position (yas--field-end field))))
3277 (set-marker (yas--field-start field) nil)
3278 (set-marker (yas--field-end field) nil)
3279 (setf (yas--field-start field) (cons start (yas--field-start field)))
3280 (setf (yas--field-end field) (cons end (yas--field-end field))))
3281 (dolist (mirror (yas--field-mirrors field))
3282 (let ((start (marker-position (yas--mirror-start mirror)))
3283 (end (marker-position (yas--mirror-end mirror))))
3284 (set-marker (yas--mirror-start mirror) nil)
3285 (set-marker (yas--mirror-end mirror) nil)
3286 (setf (yas--mirror-start mirror) (cons start (yas--mirror-start mirror)))
3287 (setf (yas--mirror-end mirror) (cons end (yas--mirror-end mirror))))))
3288 (let ((snippet-exit (yas--snippet-exit snippet)))
3290 (let ((exit (marker-position (yas--exit-marker snippet-exit))))
3291 (set-marker (yas--exit-marker snippet-exit) nil)
3292 (setf (yas--exit-marker snippet-exit) (cons exit (yas--exit-marker snippet-exit)))))))
3294 (defun yas--points-to-markers (snippet)
3295 "Convert all cons (POINT . MARKER) in SNIPPET to markers.
3297 This is done by setting MARKER to POINT with `set-marker'."
3298 (dolist (field (yas--snippet-fields snippet))
3299 (setf (yas--field-start field) (set-marker (cdr (yas--field-start field))
3300 (car (yas--field-start field))))
3301 (setf (yas--field-end field) (set-marker (cdr (yas--field-end field))
3302 (car (yas--field-end field))))
3303 (dolist (mirror (yas--field-mirrors field))
3304 (setf (yas--mirror-start mirror) (set-marker (cdr (yas--mirror-start mirror))
3305 (car (yas--mirror-start mirror))))
3306 (setf (yas--mirror-end mirror) (set-marker (cdr (yas--mirror-end mirror))
3307 (car (yas--mirror-end mirror))))))
3308 (let ((snippet-exit (yas--snippet-exit snippet)))
3310 (setf (yas--exit-marker snippet-exit) (set-marker (cdr (yas--exit-marker snippet-exit))
3311 (car (yas--exit-marker snippet-exit)))))))
3313 (defun yas--field-contains-point-p (field &optional point)
3314 (let ((point (or point
3316 (and (>= point (yas--field-start field))
3317 (<= point (yas--field-end field)))))
3319 (defun yas--field-text-for-display (field)
3320 "Return the propertized display text for field FIELD."
3321 (buffer-substring (yas--field-start field) (yas--field-end field)))
3323 (defun yas--undo-in-progress ()
3324 "True if some kind of undo is in progress."
3325 (or undo-in-progress
3326 (eq this-command 'undo)
3327 (eq this-command 'redo)))
3329 (defun yas--make-control-overlay (snippet start end)
3330 "Create the control overlay that surrounds the snippet and
3332 (let ((overlay (make-overlay start
3337 (overlay-put overlay 'keymap yas-keymap)
3338 (overlay-put overlay 'priority 100)
3339 (overlay-put overlay 'yas--snippet snippet)
3342 (defun yas-skip-and-clear-or-delete-char (&optional field)
3343 "Clears unmodified field if at field start, skips to next tab.
3345 Otherwise deletes a character normally by calling `delete-char'."
3347 (let ((field (or field
3348 (and yas--active-field-overlay
3349 (overlay-buffer yas--active-field-overlay)
3350 (overlay-get yas--active-field-overlay 'yas--field)))))
3352 (not (yas--field-modified-p field))
3353 (eq (point) (marker-position (yas--field-start field))))
3354 (yas--skip-and-clear field)
3357 (call-interactively 'delete-char)))))
3359 (defun yas--skip-and-clear (field &optional from)
3360 "Deletes the region of FIELD and sets it's modified state to t.
3361 If given, FROM indicates position to start at instead of FIELD's beginning."
3362 ;; Just before skipping-and-clearing the field, mark its children
3363 ;; fields as modified, too. If the children have mirrors-in-fields
3364 ;; this prevents them from updating erroneously (we're skipping and
3367 (yas--mark-this-and-children-modified field)
3368 (unless (= (yas--field-start field) (yas--field-end field))
3369 (delete-region (or from (yas--field-start field)) (yas--field-end field))))
3371 (defun yas--mark-this-and-children-modified (field)
3372 (setf (yas--field-modified-p field) t)
3373 (let ((fom (yas--field-next field)))
3375 (yas--fom-parent-field fom))
3376 (when (and (eq (yas--fom-parent-field fom) field)
3378 (yas--mark-this-and-children-modified fom))
3379 (setq fom (yas--fom-next fom)))))
3381 (defun yas--make-move-active-field-overlay (snippet field)
3382 "Place the active field overlay in SNIPPET's FIELD.
3384 Move the overlay, or create it if it does not exit."
3385 (if (and yas--active-field-overlay
3386 (overlay-buffer yas--active-field-overlay))
3387 (move-overlay yas--active-field-overlay
3388 (yas--field-start field)
3389 (yas--field-end field))
3390 (setq yas--active-field-overlay
3391 (make-overlay (yas--field-start field)
3392 (yas--field-end field)
3394 (overlay-put yas--active-field-overlay 'priority 100)
3395 (overlay-put yas--active-field-overlay 'face 'yas-field-highlight-face)
3396 (overlay-put yas--active-field-overlay 'yas--snippet snippet)
3397 (overlay-put yas--active-field-overlay 'modification-hooks '(yas--on-field-overlay-modification))
3398 (overlay-put yas--active-field-overlay 'insert-in-front-hooks
3399 '(yas--on-field-overlay-modification))
3400 (overlay-put yas--active-field-overlay 'insert-behind-hooks
3401 '(yas--on-field-overlay-modification))))
3403 (defun yas--skip-and-clear-field-p (field beg _end length)
3404 "Tell if newly modified FIELD should be cleared and skipped.
3405 BEG, END and LENGTH like overlay modification hooks."
3406 (and (= length 0) ; A 0 pre-change length indicates insertion.
3407 (= beg (yas--field-start field)) ; Insertion at field start?
3408 (not (yas--field-modified-p field))))
3410 (defun yas--on-field-overlay-modification (overlay after? beg end &optional length)
3411 "Clears the field and updates mirrors, conditionally.
3413 Only clears the field if it hasn't been modified and point is at
3414 field start. This hook does nothing if an undo is in progress."
3415 (unless (or (not after?)
3416 yas--inhibit-overlay-hooks
3417 (not (overlayp yas--active-field-overlay)) ; Avoid Emacs bug #21824.
3418 (yas--undo-in-progress))
3419 (let* ((inhibit-modification-hooks t)
3420 (field (overlay-get overlay 'yas--field))
3421 (snippet (overlay-get yas--active-field-overlay 'yas--snippet)))
3422 (when (yas--skip-and-clear-field-p field beg end length)
3423 ;; We delete text starting from the END of insertion.
3424 (yas--skip-and-clear field end))
3425 (setf (yas--field-modified-p field) t)
3426 (yas--advance-end-maybe field (overlay-end overlay))
3428 (yas--field-update-display field))
3429 (yas--update-mirrors snippet))))
3431 ;;; Apropos protection overlays:
3433 ;; These exist for nasty users who will try to delete parts of the
3434 ;; snippet outside the active field. Actual protection happens in
3435 ;; `yas--on-protection-overlay-modification'.
3437 ;; As of github #537 this no longer inhibits the command by issuing an
3438 ;; error: all the snippets at point, including nested snippets, are
3439 ;; automatically commited and the current command can proceed.
3441 (defun yas--make-move-field-protection-overlays (snippet field)
3442 "Place protection overlays surrounding SNIPPET's FIELD.
3444 Move the overlays, or create them if they do not exit."
3445 (let ((start (yas--field-start field))
3446 (end (yas--field-end field)))
3447 ;; First check if the (1+ end) is contained in the buffer,
3448 ;; otherwise we'll have to do a bit of cheating and silently
3449 ;; insert a newline. the `(1+ (buffer-size))' should prevent this
3450 ;; when using stacked expansion
3452 (when (< (buffer-size) end)
3454 (let ((yas--inhibit-overlay-hooks t))
3455 (goto-char (point-max))
3457 ;; go on to normal overlay creation/moving
3459 (cond ((and yas--field-protection-overlays
3460 (every #'overlay-buffer yas--field-protection-overlays))
3461 (move-overlay (first yas--field-protection-overlays) (1- start) start)
3462 (move-overlay (second yas--field-protection-overlays) end (1+ end)))
3464 (setq yas--field-protection-overlays
3465 (list (make-overlay (1- start) start nil t nil)
3466 (make-overlay end (1+ end) nil t nil)))
3467 (dolist (ov yas--field-protection-overlays)
3468 (overlay-put ov 'face 'yas--field-debug-face)
3469 (overlay-put ov 'yas--snippet snippet)
3470 ;; (overlay-put ov 'evaporate t)
3471 (overlay-put ov 'modification-hooks '(yas--on-protection-overlay-modification)))))))
3473 (defun yas--on-protection-overlay-modification (_overlay after? beg end &optional length)
3474 "Commit the snippet if the protection overlay is being killed."
3475 (unless (or yas--inhibit-overlay-hooks
3477 (= length (- end beg)) ; deletion or insertion
3478 (yas--undo-in-progress))
3479 (let ((snippets (yas--snippets-at-point)))
3480 (yas--message 3 "Comitting snippets. Action would destroy a protection overlay.")
3481 (cl-loop for snippet in snippets
3482 do (yas--commit-snippet snippet)))))
3484 (add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
3487 ;;; Snippet expansion and "stacked" expansion:
3489 ;; Stacked expansion is when you try to expand a snippet when already
3490 ;; inside a snippet expansion.
3492 ;; The parent snippet does not run its fields modification hooks
3493 ;; (`yas--on-field-overlay-modification' and
3494 ;; `yas--on-protection-overlay-modification') while the child snippet
3495 ;; is active. This means, among other things, that the mirrors of the
3496 ;; parent snippet are not updated, this only happening when one exits
3497 ;; the child snippet.
3499 ;; Unfortunately, this also puts some ugly (and not fully-tested)
3500 ;; bits of code in `yas-expand-snippet' and
3501 ;; `yas--commit-snippet'. I've tried to mark them with "stacked
3504 ;; This was thought to be safer in an undo/redo perspective, but
3505 ;; maybe the correct implementation is to make the globals
3506 ;; `yas--active-field-overlay' and `yas--field-protection-overlays' be
3507 ;; snippet-local and be active even while the child snippet is
3508 ;; running. This would mean a lot of overlay modification hooks
3509 ;; running, but if managed correctly (including overlay priorities)
3510 ;; they should account for all situations...
3512 (defun yas-expand-snippet (content &optional start end expand-env)
3513 "Expand snippet CONTENT at current point.
3515 Text between START and END will be deleted before inserting
3516 template. EXPAND-ENV is a list of (SYM VALUE) let-style dynamic bindings
3517 considered when expanding the snippet."
3518 (cl-assert (and yas-minor-mode
3519 (memq 'yas--post-command-handler post-command-hook))
3521 "[yas] `yas-expand-snippet' needs properly setup `yas-minor-mode'")
3522 (run-hooks 'yas-before-expand-snippet-hook)
3525 (let* ((yas-selected-text (or yas-selected-text
3526 (and (region-active-p)
3527 (buffer-substring-no-properties (region-beginning)
3530 (and (region-active-p)
3534 (and (region-active-p)
3537 (to-delete (and start
3539 (buffer-substring-no-properties start end)))
3542 (setq yas--indent-original-column (current-column))
3543 ;; Delete the region to delete, this *does* get undo-recorded.
3545 (when (and to-delete
3547 (delete-region start end))
3549 (cond ((listp content)
3550 ;; x) This is a snippet-command
3552 (yas--eval-lisp-no-saves content))
3554 ;; x) This is a snippet-snippet :-)
3556 ;; Narrow the region down to the content, shoosh the
3557 ;; `buffer-undo-list', and create the snippet, the new
3558 ;; snippet updates its mirrors once, so we are left with
3559 ;; some plain text. The undo action for deleting this
3560 ;; plain text will get recorded at the end.
3562 ;; stacked expansion: also shoosh the overlay modification hooks
3563 (let ((buffer-undo-list t))
3564 ;; snippet creation might evaluate users elisp, which
3565 ;; might generate errors, so we have to be ready to catch
3566 ;; them mostly to make the undo information
3568 (setq yas--start-column (current-column))
3569 (let ((yas--inhibit-overlay-hooks t))
3572 (eval `(let* ,expand-env
3574 (yas--snippet-create start (point))))
3576 (yas--snippet-create start (point))))))
3578 ;; stacked-expansion: This checks for stacked expansion, save the
3579 ;; `yas--previous-active-field' and advance its boundary.
3581 (let ((existing-field (and yas--active-field-overlay
3582 (overlay-buffer yas--active-field-overlay)
3583 (overlay-get yas--active-field-overlay 'yas--field))))
3584 (when existing-field
3585 (setf (yas--snippet-previous-active-field snippet) existing-field)
3586 (yas--advance-end-maybe existing-field (overlay-end yas--active-field-overlay))))
3588 ;; Exit the snippet immediately if no fields
3590 (unless (yas--snippet-fields snippet)
3591 (yas-exit-snippet snippet))
3593 ;; Push two undo actions: the deletion of the inserted contents of
3594 ;; the new snippet (without the "key") followed by an apply of
3595 ;; `yas--take-care-of-redo' on the newly inserted snippet boundaries
3597 ;; A small exception, if `yas-also-auto-indent-first-line'
3598 ;; is t and `yas--indent' decides to indent the line to a
3599 ;; point before the actual expansion point, undo would be
3600 ;; messed up. We call the early point "newstart"". case,
3601 ;; and attempt to fix undo.
3603 (let ((newstart (overlay-start (yas--snippet-control-overlay snippet)))
3604 (end (overlay-end (yas--snippet-control-overlay snippet))))
3605 (when (< newstart start)
3606 (push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
3607 (push (cons newstart end) buffer-undo-list)
3608 (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
3610 ;; Now, schedule a move to the first field
3612 (let ((first-field (car (yas--snippet-fields snippet))))
3614 (sit-for 0) ;; fix issue 125
3615 (yas--move-to-field snippet first-field)))
3616 (yas--message 3 "snippet expanded.")
3619 (defun yas--take-care-of-redo (_beg _end snippet)
3620 "Commits SNIPPET, which in turn pushes an undo action for reviving it.
3622 Meant to exit in the `buffer-undo-list'."
3623 ;; slightly optimize: this action is only needed for snippets with
3624 ;; at least one field
3625 (when (yas--snippet-fields snippet)
3626 (yas--commit-snippet snippet)))
3628 (defun yas--snippet-revive (beg end snippet)
3629 "Revives SNIPPET and creates a control overlay from BEG to END.
3631 BEG and END are, we hope, the original snippets boundaries.
3632 All the markers/points exiting existing inside SNIPPET should point
3633 to their correct locations *at the time the snippet is revived*.
3635 After revival, push the `yas--take-care-of-redo' in the
3637 ;; Reconvert all the points to markers
3639 (yas--points-to-markers snippet)
3640 ;; When at least one editable field existed in the zombie snippet,
3641 ;; try to revive the whole thing...
3643 (let ((target-field (or (yas--snippet-active-field snippet)
3644 (car (yas--snippet-fields snippet)))))
3646 (setf (yas--snippet-control-overlay snippet) (yas--make-control-overlay snippet beg end))
3647 (overlay-put (yas--snippet-control-overlay snippet) 'yas--snippet snippet)
3649 (yas--move-to-field snippet target-field)
3651 (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
3652 buffer-undo-list))))
3654 (defun yas--snippet-create (begin end)
3655 "Create a snippet from a template inserted at BEGIN to END.
3657 Returns the newly created snippet."
3659 (narrow-to-region begin end)
3660 (let ((snippet (yas--make-snippet)))
3662 (yas--snippet-parse-create snippet)
3664 ;; Sort and link each field
3665 (yas--snippet-sort-fields snippet)
3667 ;; Create keymap overlay for snippet
3668 (setf (yas--snippet-control-overlay snippet)
3669 (yas--make-control-overlay snippet (point-min) (point-max)))
3672 (goto-char (point-max))
3677 ;;; Apropos adjacencies and "fom's":
3679 ;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
3680 ;; recently expanded snippet, we might actually have many fields,
3681 ;; mirrors (and the snippet exit) in the very same position in the
3682 ;; buffer. Therefore we need to single-link the
3683 ;; fields-or-mirrors-or-exit (which I have abbreviated to "fom")
3684 ;; according to their original positions in the buffer.
3686 ;; Then we have operation `yas--advance-end-maybe' and
3687 ;; `yas--advance-start-maybe', which conditionally push the starts and
3688 ;; ends of these foms down the chain.
3690 ;; This allows for like the printf with the magic ",":
3692 ;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
3693 ;; $2${1:$(if (string-match "%" text) "\);" "")}$0
3695 (defun yas--fom-start (fom)
3696 (cond ((yas--field-p fom)
3697 (yas--field-start fom))
3698 ((yas--mirror-p fom)
3699 (yas--mirror-start fom))
3701 (yas--exit-marker fom))))
3703 (defun yas--fom-end (fom)
3704 (cond ((yas--field-p fom)
3705 (yas--field-end fom))
3706 ((yas--mirror-p fom)
3707 (yas--mirror-end fom))
3709 (yas--exit-marker fom))))
3711 (defun yas--fom-next (fom)
3712 (cond ((yas--field-p fom)
3713 (yas--field-next fom))
3714 ((yas--mirror-p fom)
3715 (yas--mirror-next fom))
3717 (yas--exit-next fom))))
3719 (defun yas--fom-parent-field (fom)
3720 (cond ((yas--field-p fom)
3721 (yas--field-parent-field fom))
3722 ((yas--mirror-p fom)
3723 (yas--mirror-parent-field fom))
3727 (defun yas--calculate-adjacencies (snippet)
3728 "Calculate adjacencies for fields or mirrors of SNIPPET.
3730 This is according to their relative positions in the buffer, and
3731 has to be called before the $-constructs are deleted."
3732 (let* ((fom-set-next-fom
3733 (lambda (fom nextfom)
3734 (cond ((yas--field-p fom)
3735 (setf (yas--field-next fom) nextfom))
3736 ((yas--mirror-p fom)
3737 (setf (yas--mirror-next fom) nextfom))
3739 (setf (yas--exit-next fom) nextfom)))))
3742 (if (= (yas--fom-start fom2) (yas--fom-start fom1))
3743 (yas--mirror-p fom2)
3744 (>= (yas--fom-start fom2) (yas--fom-start fom1)))))
3745 (link-foms fom-set-next-fom))
3746 ;; make some yas--field, yas--mirror and yas--exit soup
3748 (when (yas--snippet-exit snippet)
3749 (push (yas--snippet-exit snippet) soup))
3750 (dolist (field (yas--snippet-fields snippet))
3752 (dolist (mirror (yas--field-mirrors field))
3753 (push mirror soup)))
3755 (sort soup compare-fom-begs))
3757 (reduce link-foms soup)))))
3759 (defun yas--calculate-mirrors-in-fields (snippet mirror)
3760 "Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
3762 Use the tightest containing field if more than one field contains
3763 the mirror. Intended to be called *before* the dollar-regions are
3765 (let ((min (point-min))
3767 (dolist (field (yas--snippet-fields snippet))
3768 (when (and (<= (yas--field-start field) (yas--mirror-start mirror))
3769 (<= (yas--mirror-end mirror) (yas--field-end field))
3770 (< min (yas--field-start field))
3771 (< (yas--field-end field) max))
3772 (setq min (yas--field-start field)
3773 max (yas--field-end field))
3774 (setf (yas--mirror-parent-field mirror) field)))))
3776 (defun yas--advance-end-maybe (fom newend)
3777 "Maybe advance FOM's end to NEWEND if it needs it.
3781 * call `yas--advance-start-maybe' on FOM's next fom.
3783 * in case FOM is field call `yas--advance-end-maybe' on its parent
3786 Also, if FOM is an exit-marker, always call
3787 `yas--advance-start-maybe' on its next fom. This is because
3788 exit-marker have identical start and end markers."
3789 (cond ((and fom (< (yas--fom-end fom) newend))
3790 (set-marker (yas--fom-end fom) newend)
3791 (yas--advance-start-maybe (yas--fom-next fom) newend)
3792 (yas--advance-end-of-parents-maybe (yas--fom-parent-field fom) newend))
3794 (yas--advance-start-maybe (yas--fom-next fom) newend))))
3796 (defun yas--advance-start-maybe (fom newstart)
3797 "Maybe advance FOM's start to NEWSTART if it needs it.
3799 If it does, also call `yas--advance-end-maybe' on FOM."
3800 (when (and fom (< (yas--fom-start fom) newstart))
3801 (set-marker (yas--fom-start fom) newstart)
3802 (yas--advance-end-maybe fom newstart)))
3804 (defun yas--advance-end-of-parents-maybe (field newend)
3805 "Like `yas--advance-end-maybe' but for parent fields.
3807 Only works for fields and doesn't care about the start of the
3808 next FOM. Works its way up recursively for parents of parents."
3810 (< (yas--field-end field) newend))
3811 (set-marker (yas--field-end field) newend)
3812 (yas--advance-end-of-parents-maybe (yas--field-parent-field field) newend)))
3814 (defvar yas--dollar-regions nil
3815 "When expanding the snippet the \"parse-create\" functions add
3816 cons cells to this var.")
3818 (defvar yas--backquote-markers-and-strings nil
3819 "List of (MARKER . STRING) marking where the values from
3820 backquoted Lisp expressions should be inserted at the end of
3823 (defun yas--snippet-parse-create (snippet)
3824 "Parse a recently inserted snippet template, creating all
3825 necessary fields, mirrors and exit points.
3827 Meant to be called in a narrowed buffer, does various passes"
3828 (let ((parse-start (point)))
3829 ;; Reset the yas--dollar-regions
3831 (setq yas--dollar-regions nil)
3832 ;; protect just the backquotes
3834 (yas--protect-escapes nil '(?`))
3835 ;; replace all backquoted expressions
3837 (goto-char parse-start)
3838 (yas--save-backquotes)
3839 ;; protect escaped characters
3841 (yas--protect-escapes)
3842 ;; parse fields with {}
3844 (goto-char parse-start)
3845 (yas--field-parse-create snippet)
3846 ;; parse simple mirrors and fields
3848 (goto-char parse-start)
3849 (yas--simple-mirror-parse-create snippet)
3850 ;; parse mirror transforms
3852 (goto-char parse-start)
3853 (yas--transform-mirror-parse-create snippet)
3854 ;; calculate adjacencies of fields and mirrors
3856 (yas--calculate-adjacencies snippet)
3857 ;; Delete $-constructs
3859 (save-restriction (widen) (yas--delete-regions yas--dollar-regions))
3860 ;; restore backquoted expression values
3862 (yas--restore-backquotes)
3865 (goto-char parse-start)
3866 (yas--restore-escapes)
3867 ;; update mirrors for the first time
3869 (yas--update-mirrors snippet)
3870 ;; indent the best we can
3872 (goto-char parse-start)
3873 (yas--indent snippet)))
3875 (defun yas--indent-region (from to snippet)
3876 "Indent the lines between FROM and TO with `indent-according-to-mode'.
3877 The SNIPPET's markers are preserved."
3878 ;;; Apropos indenting problems....
3880 ;; `indent-according-to-mode' uses whatever `indent-line-function'
3881 ;; is available. Some implementations of these functions delete text
3882 ;; before they insert. If there happens to be a marker just after
3883 ;; the text being deleted, the insertion actually happens after the
3884 ;; marker, which misplaces it.
3886 ;; This would also happen if we had used overlays with the
3887 ;; `front-advance' property set to nil.
3889 ;; This is why I have these `trouble-markers', they are the ones at
3890 ;; the first non-whitespace char at the line. After indentation
3891 ;; takes place we should be at the correct to restore them. All
3892 ;; other non-trouble-markers should have been *pushed* and don't
3893 ;; need special attention.
3894 (let* ((snippet-markers (yas--collect-snippet-markers snippet))
3895 (to (set-marker (make-marker) to)))
3901 (back-to-indentation)
3902 (let ((trouble-markers ; The markers at (point).
3903 (cl-remove (point) snippet-markers :test #'/=)))
3905 (indent-according-to-mode)
3906 (dolist (marker trouble-markers)
3907 (set-marker marker (point)))))
3908 while (and (zerop (forward-line 1))
3909 (< (point) to)))))))
3911 (defvar yas--indent-original-column nil)
3912 (defun yas--indent (snippet)
3913 ;; Look for those `$>'.
3915 (while (re-search-forward "$>" nil t)
3916 (delete-region (match-beginning 0) (match-end 0))
3917 (unless (eq yas-indent-line 'auto)
3918 (yas--indent-region (line-beginning-position)
3921 ;; Now do stuff for `fixed' and `auto'.
3923 (cond ((eq yas-indent-line 'fixed)
3924 (while (and (zerop (forward-line))
3925 (zerop (current-column)))
3926 (indent-to-column yas--indent-original-column)))
3927 ((eq yas-indent-line 'auto)
3928 (let ((end (set-marker (make-marker) (point-max))))
3929 (unless yas-also-auto-indent-first-line
3931 (yas--indent-region (line-beginning-position)
3935 (defun yas--collect-snippet-markers (snippet)
3936 "Make a list of all the markers used by SNIPPET."
3938 (dolist (field (yas--snippet-fields snippet))
3939 (push (yas--field-start field) markers)
3940 (push (yas--field-end field) markers)
3941 (dolist (mirror (yas--field-mirrors field))
3942 (push (yas--mirror-start mirror) markers)
3943 (push (yas--mirror-end mirror) markers)))
3944 (let ((snippet-exit (yas--snippet-exit snippet)))
3945 (when (and snippet-exit
3946 (marker-buffer (yas--exit-marker snippet-exit)))
3947 (push (yas--exit-marker snippet-exit) markers)))
3950 (defun yas--escape-string (escaped)
3951 (concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
3953 (defun yas--protect-escapes (&optional text escaped)
3954 "Protect all escaped characters with their numeric ASCII value.
3956 With optional string TEXT do it in string instead of buffer."
3957 (let ((changed-text text)
3958 (text-provided-p text))
3959 (mapc #'(lambda (escaped)
3961 (yas--replace-all (concat "\\" (char-to-string escaped))
3962 (yas--escape-string escaped)
3963 (when text-provided-p changed-text))))
3964 (or escaped yas--escaped-characters))
3967 (defun yas--restore-escapes (&optional text escaped)
3968 "Restore all escaped characters from their numeric ASCII value.
3970 With optional string TEXT do it in string instead of the buffer."
3971 (let ((changed-text text)
3972 (text-provided-p text))
3973 (mapc #'(lambda (escaped)
3975 (yas--replace-all (yas--escape-string escaped)
3976 (char-to-string escaped)
3977 (when text-provided-p changed-text))))
3978 (or escaped yas--escaped-characters))
3981 (defun yas--save-backquotes ()
3982 "Save all the \"`(lisp-expression)`\"-style expressions
3983 with their evaluated value into `yas--backquote-markers-and-strings'."
3984 (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
3985 (let ((current-string (match-string-no-properties 1)) transformed)
3986 (save-restriction (widen)
3987 (delete-region (match-beginning 0) (match-end 0)))
3988 (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
3989 (goto-char (match-beginning 0))
3991 (let ((marker (make-marker)))
3994 (insert "Y") ;; quite horrendous, I love it :)
3995 (set-marker marker (point))
3997 (push (cons marker transformed) yas--backquote-markers-and-strings))))))
3999 (defun yas--restore-backquotes ()
4000 "Replace markers in `yas--backquote-markers-and-strings' with their values."
4001 (while yas--backquote-markers-and-strings
4002 (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
4003 (marker (car marker-and-string))
4004 (string (cdr marker-and-string)))
4012 (set-marker marker nil)))))
4014 (defun yas--scan-sexps (from count)
4016 (save-match-data ; `scan-sexps' may modify match data.
4017 (with-syntax-table (standard-syntax-table)
4018 (scan-sexps from count)))))
4020 (defun yas--make-marker (pos)
4021 "Create a marker at POS with nil `marker-insertion-type'."
4022 (let ((marker (set-marker (make-marker) pos)))
4023 (set-marker-insertion-type marker nil)
4026 (defun yas--field-parse-create (snippet &optional parent-field)
4027 "Parse most field expressions in SNIPPET, except for the simple one \"$n\".
4029 The following count as a field:
4031 * \"${n: text}\", for a numbered field with default text, as long as N is not 0;
4033 * \"${n: text$(expression)}, the same with a Lisp expression;
4034 this is caught with the curiously named `yas--multi-dollar-lisp-expression-regexp'
4036 * the same as above but unnumbered, (no N:) and number is calculated automatically.
4038 When multiple expressions are found, only the last one counts."
4041 (while (re-search-forward yas--field-regexp nil t)
4042 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4043 (number (and (match-string-no-properties 1)
4044 (string-to-number (match-string-no-properties 1))))
4045 (brand-new-field (and real-match-end-0
4046 ;; break if on "$(" immediately
4047 ;; after the ":", this will be
4048 ;; caught as a mirror with
4050 (not (string-match-p "\\`\\$[ \t\n]*("
4051 (match-string-no-properties 2)))
4052 ;; allow ${0: some exit text}
4053 ;; (not (and number (zerop number)))
4054 (yas--make-field number
4055 (yas--make-marker (match-beginning 2))
4056 (yas--make-marker (1- real-match-end-0))
4058 (when brand-new-field
4059 (goto-char real-match-end-0)
4060 (push (cons (1- real-match-end-0) real-match-end-0)
4061 yas--dollar-regions)
4062 (push (cons (match-beginning 0) (match-beginning 2))
4063 yas--dollar-regions)
4064 (push brand-new-field (yas--snippet-fields snippet))
4067 (narrow-to-region (yas--field-start brand-new-field) (yas--field-end brand-new-field))
4068 (goto-char (point-min))
4069 (yas--field-parse-create snippet brand-new-field)))))))
4070 ;; if we entered from a parent field, now search for the
4071 ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
4072 ;; primary field transformations
4076 (while (re-search-forward yas--multi-dollar-lisp-expression-regexp nil t)
4077 (let* ((real-match-end-1 (yas--scan-sexps (match-beginning 1) 1)))
4078 ;; commit the primary field transformation if:
4080 ;; 1. we don't find it in yas--dollar-regions (a subnested
4081 ;; field) might have already caught it.
4083 ;; 2. we really make sure we have either two '$' or some
4084 ;; text and a '$' after the colon ':'. This is a FIXME: work
4085 ;; my regular expressions and end these ugly hacks.
4087 (when (and real-match-end-1
4088 (not (member (cons (match-beginning 0)
4090 yas--dollar-regions))
4092 (char-before (1- (match-beginning 1))))))
4093 (let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
4095 (setf (yas--field-transform parent-field)
4096 (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
4097 (push (cons (match-beginning 0) real-match-end-1)
4098 yas--dollar-regions)))))))
4100 (defun yas--transform-mirror-parse-create (snippet)
4101 "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
4102 (while (re-search-forward yas--transform-mirror-regexp nil t)
4103 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4104 (number (string-to-number (match-string-no-properties 1)))
4106 (not (zerop number))
4107 (yas--snippet-find-field snippet number)))
4109 (and real-match-end-0
4111 (yas--make-mirror (yas--make-marker (match-beginning 0))
4112 (yas--make-marker (match-beginning 0))
4114 (yas--restore-escapes
4115 (buffer-substring-no-properties (match-beginning 2)
4116 (1- real-match-end-0))))))))
4117 (when brand-new-mirror
4118 (push brand-new-mirror
4119 (yas--field-mirrors field))
4120 (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
4121 (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
4123 (defun yas--simple-mirror-parse-create (snippet)
4124 "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
4125 (while (re-search-forward yas--simple-mirror-regexp nil t)
4126 (let ((number (string-to-number (match-string-no-properties 1))))
4127 (cond ((zerop number)
4129 (setf (yas--snippet-exit snippet)
4130 (yas--make-exit (yas--make-marker (match-end 0))))
4132 (goto-char (match-beginning 0))
4133 (when (eq yas-wrap-around-region 'cua)
4134 (setq yas-wrap-around-region ?0))
4135 (cond ((and yas-wrap-around-region yas-selected-text)
4136 (insert yas-selected-text))
4137 ((and (characterp yas-wrap-around-region)
4138 (get-register yas-wrap-around-region))
4139 (insert (prog1 (get-register yas-wrap-around-region)
4140 (set-register yas-wrap-around-region nil)))))
4141 (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
4142 yas--dollar-regions)))
4144 (let ((field (yas--snippet-find-field snippet number)))
4146 (let ((brand-new-mirror (yas--make-mirror
4147 (yas--make-marker (match-beginning 0))
4148 (yas--make-marker (match-beginning 0))
4150 (push brand-new-mirror
4151 (yas--field-mirrors field))
4152 (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
4153 (push (yas--make-field number
4154 (yas--make-marker (match-beginning 0))
4155 (yas--make-marker (match-beginning 0))
4157 (yas--snippet-fields snippet))))
4158 (push (cons (match-beginning 0) (match-end 0))
4159 yas--dollar-regions))))))
4161 (defun yas--delete-regions (regions)
4162 "Sort disjuct REGIONS by start point, then delete from the back."
4163 (mapc #'(lambda (reg)
4164 (delete-region (car reg) (cdr reg)))
4167 (>= (car r1) (car r2))))))
4169 (defun yas--calculate-mirror-depth (mirror &optional traversed)
4170 (let* ((parent (yas--mirror-parent-field mirror))
4171 (parents-mirrors (and parent
4172 (yas--field-mirrors parent))))
4173 (or (yas--mirror-depth mirror)
4174 (setf (yas--mirror-depth mirror)
4175 (cond ((memq mirror traversed)
4177 ((and parent parents-mirrors)
4179 (mapcar #'(lambda (m)
4180 (yas--calculate-mirror-depth m
4189 (defun yas--update-mirrors (snippet)
4190 "Update all the mirrors of SNIPPET."
4194 (dolist (field-and-mirror
4196 ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
4197 ;; where F is the field that M is mirroring
4199 (cl-mapcan #'(lambda (field)
4200 (mapcar #'(lambda (mirror)
4201 (cons field mirror))
4202 (yas--field-mirrors field)))
4203 (yas--snippet-fields snippet))
4204 ;; then sort this list so that entries with mirrors with parent
4205 ;; fields appear before. This was important for fixing #290, and
4206 ;; luckily also handles the case where a mirror in a field causes
4207 ;; another mirror to need reupdating
4209 #'(lambda (field-and-mirror1 field-and-mirror2)
4210 (> (yas--calculate-mirror-depth (cdr field-and-mirror1))
4211 (yas--calculate-mirror-depth (cdr field-and-mirror2))))))
4212 (let* ((field (car field-and-mirror))
4213 (mirror (cdr field-and-mirror))
4214 (parent-field (yas--mirror-parent-field mirror)))
4215 ;; before updating a mirror with a parent-field, maybe advance
4219 (yas--advance-start-maybe mirror (yas--fom-start parent-field)))
4220 ;; update this mirror
4222 (yas--mirror-update-display mirror field snippet)
4223 ;; `yas--place-overlays' is needed since the active field and
4224 ;; protected overlays might have been changed because of insertions
4225 ;; in `yas--mirror-update-display'.
4226 (let ((active-field (yas--snippet-active-field snippet)))
4227 (when active-field (yas--place-overlays snippet active-field))))))))
4229 (defun yas--mirror-update-display (mirror field snippet)
4230 "Update MIRROR according to FIELD (and mirror transform)."
4232 (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
4233 (reflection (and (not (and mirror-parent-field
4234 (yas--field-modified-p mirror-parent-field)))
4235 (or (yas--apply-transform mirror field 'empty-on-nil)
4236 (yas--field-text-for-display field)))))
4237 (when (and reflection
4238 (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
4239 (yas--mirror-end mirror)))))
4240 (goto-char (yas--mirror-start mirror))
4241 (let ((yas--inhibit-overlay-hooks t))
4242 (insert reflection))
4243 (if (> (yas--mirror-end mirror) (point))
4244 (delete-region (point) (yas--mirror-end mirror))
4245 (set-marker (yas--mirror-end mirror) (point))
4246 (yas--advance-start-maybe (yas--mirror-next mirror) (point))
4247 ;; super-special advance
4248 (yas--advance-end-of-parents-maybe mirror-parent-field (point)))
4249 (let ((yas--inhibit-overlay-hooks t))
4250 (yas--indent-region (yas--mirror-start mirror)
4251 (yas--mirror-end mirror)
4254 (defun yas--field-update-display (field)
4255 "Much like `yas--mirror-update-display', but for fields."
4256 (when (yas--field-transform field)
4257 (let ((transformed (and (not (eq (yas--field-number field) 0))
4258 (yas--apply-transform field field))))
4259 (when (and transformed
4260 (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
4261 (yas--field-end field)))))
4262 (setf (yas--field-modified-p field) t)
4263 (goto-char (yas--field-start field))
4264 (let ((yas--inhibit-overlay-hooks t))
4265 (insert transformed)
4266 (if (> (yas--field-end field) (point))
4267 (delete-region (point) (yas--field-end field))
4268 (set-marker (yas--field-end field) (point))
4269 (yas--advance-start-maybe (yas--field-next field) (point)))
4273 ;;; Post-command hook:
4275 (defun yas--post-command-handler ()
4276 "Handles various yasnippet conditions after each command."
4277 (cond ((eq 'undo this-command)
4279 ;; After undo revival the correct field is sometimes not
4280 ;; restored correctly, this condition handles that
4282 (let* ((snippet (car (yas--snippets-at-point)))
4283 (target-field (and snippet
4284 (find-if-not #'(lambda (field)
4285 (yas--field-probably-deleted-p snippet field))
4287 (cons (yas--snippet-active-field snippet)
4288 (yas--snippet-fields snippet)))))))
4290 (yas--move-to-field snippet target-field))))
4291 ((not (yas--undo-in-progress))
4292 ;; When not in an undo, check if we must commit the snippet
4293 ;; (user exited it).
4294 (yas--check-commit-snippet))))
4298 ;; The docstrings for some functions are generated dynamically
4299 ;; depending on the context.
4301 (put 'yas-expand 'function-documentation
4302 '(yas--expand-from-trigger-key-doc t))
4303 (defun yas--expand-from-trigger-key-doc (context)
4304 "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
4305 (let* ((yas-fallback-behavior (and context yas-fallback-behavior))
4306 (fallback-description
4307 (cond ((eq yas-fallback-behavior 'call-other-command)
4308 (let* ((fallback (yas--keybinding-beyond-yasnippet)))
4310 (format "call command `%s'."
4311 (pp-to-string fallback)))
4312 "do nothing (`yas-expand' doesn't override\nanything).")))
4313 ((eq yas-fallback-behavior 'return-nil)
4315 (t "defer to `yas-fallback-behavior' (which see)."))))
4316 (concat "Expand a snippet before point. If no snippet
4317 expansion is possible, "
4318 fallback-description
4319 "\n\nOptional argument FIELD is for non-interactive use and is an
4320 object satisfying `yas--field-p' to restrict the expansion to.")))
4322 (put 'yas-expand-from-keymap 'function-documentation
4323 '(yas--expand-from-keymap-doc t))
4324 (defun yas--expand-from-keymap-doc (context)
4325 "A doc synthesizer for `yas--expand-from-keymap-doc'."
4326 (add-hook 'temp-buffer-show-hook #'yas--snippet-description-finish-runonce)
4327 (concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
4328 (when (and context (eq this-command 'describe-key))
4329 (let* ((vec (this-single-command-keys))
4330 (templates (mapcan #'(lambda (table)
4331 (yas--fetch table vec))
4332 (yas--get-snippet-tables)))
4333 (yas--direct-keymaps nil)
4334 (fallback (key-binding vec)))
4335 (concat "In this case, "
4337 (concat "these snippets are bound to this key:\n"
4338 (yas--template-pretty-list templates)
4339 "\n\nIf none of these expands, "))
4341 (format "fallback `%s' will be called." (pp-to-string fallback)))
4342 "no fallback keybinding is called."))))))
4344 (defun yas--template-pretty-list (templates)
4346 (yas-buffer-local-condition 'always))
4347 (dolist (plate templates)
4348 (setq acc (concat acc "\n*) "
4349 (propertize (concat "\\\\snippet `" (car plate) "'")
4350 'yasnippet (cdr plate)))))
4353 (define-button-type 'help-snippet-def
4354 :supertype 'help-xref
4355 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
4356 'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
4358 (defun yas--snippet-description-finish-runonce ()
4359 "Final adjustments for the help buffer when snippets are concerned."
4360 (yas--create-snippet-xrefs)
4361 (remove-hook 'temp-buffer-show-hook
4362 #'yas--snippet-description-finish-runonce))
4364 (defun yas--create-snippet-xrefs ()
4366 (goto-char (point-min))
4367 (while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
4368 (let ((template (get-text-property (match-beginning 1)
4371 (help-xref-button 1 'help-snippet-def template)
4372 (delete-region (match-end 1) (match-end 0))
4373 (delete-region (match-beginning 0) (match-beginning 1)))))))
4377 (defvar yas-verbosity 4
4378 "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
4380 (defun yas--message (level message &rest args)
4381 "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
4382 (when (> yas-verbosity level)
4383 (message "%s" (apply #'yas--format message args))))
4385 (defun yas--warning (format-control &rest format-args)
4386 (let ((msg (apply #'format format-control format-args)))
4387 (display-warning 'yasnippet msg :warning)
4388 (yas--message 1 msg)))
4390 (defun yas--format (format-control &rest format-args)
4391 (apply #'format (concat "[yas] " format-control) format-args))
4398 ;; `locate-dominating-file'
4399 ;; `region-active-p'
4401 ;; added for compatibility in emacsen < 23
4402 (unless (>= emacs-major-version 23)
4403 (unless (fboundp 'region-active-p)
4404 (defun region-active-p () (and transient-mark-mode mark-active)))
4406 (unless (fboundp 'locate-dominating-file)
4407 (defvar locate-dominating-stop-dir-regexp
4408 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
4409 "Regexp of directory names which stop the search in `locate-dominating-file'.
4410 Any directory whose name matches this regexp will be treated like
4411 a kind of root directory by `locate-dominating-file' which will stop its search
4412 when it bumps into it.
4413 The default regexp prevents fruitless and time-consuming attempts to find
4414 special files in directories in which filenames are interpreted as hostnames,
4415 or mount points potentially requiring authentication as a different user.")
4417 (defun locate-dominating-file (file name)
4418 "Look up the directory hierarchy from FILE for a file named NAME.
4419 Stop at the first parent directory containing a file NAME,
4420 and return the directory. Return nil if not found."
4421 ;; We used to use the above locate-dominating-files code, but the
4422 ;; directory-files call is very costly, so we're much better off doing
4423 ;; multiple calls using the code in here.
4425 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
4426 ;; `name' in /home or in /.
4427 (setq file (abbreviate-file-name file))
4430 (while (not (or root
4432 ;; FIXME: Disabled this heuristic because it is sometimes
4434 ;; As a heuristic, we stop looking up the hierarchy of
4435 ;; directories as soon as we find a directory belonging
4436 ;; to another user. This should save us from looking in
4437 ;; things like /net and /afs. This assumes that all the
4438 ;; files inside a project belong to the same user.
4439 ;; (let ((prev-user user))
4440 ;; (setq user (nth 2 (file-attributes file)))
4441 ;; (and prev-user (not (equal user prev-user))))
4442 (string-match locate-dominating-stop-dir-regexp file)))
4443 (setq try (file-exists-p (expand-file-name name file)))
4444 (cond (try (setq root file))
4445 ((equal file (setq file (file-name-directory
4446 (directory-file-name file))))
4451 ;;; Backward compatibility to yasnippet <= 0.7
4453 (defun yas-initialize ()
4454 "For backward compatibility, enable `yas-minor-mode' globally."
4455 (declare (obsolete "Use (yas-global-mode 1) instead." "0.8"))
4456 (yas-global-mode 1))
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
4525 ;; symbols that I "exported" for use
4526 ;; in snippets and hookage
4543 yas-default-from-field
4546 yas-define-condition-cache
4547 yas-hippie-try-expand
4549 ;; debug definitions
4550 ;; yas-debug-snippet-vars
4551 ;; yas-exterminate-package
4554 ;; testing definitions
4555 ;; yas-should-expand
4556 ;; yas-should-not-expand
4558 ;; yas-make-file-or-dirs
4560 ;; yas-saving-variables
4561 ;; yas-call-with-snippet-dirs
4562 ;; yas-with-snippet-dirs
4564 "Backported yasnippet symbols.
4566 They are mapped to \"yas/*\" variants.")
4568 (dolist (sym yas--backported-syms)
4569 (let ((backported (intern (replace-regexp-in-string "\\`yas-" "yas/" (symbol-name sym)))))
4571 (make-obsolete-variable backported sym "yasnippet 0.8")
4572 (defvaralias backported sym))
4574 (make-obsolete backported sym "yasnippet 0.8")
4575 (defalias backported sym))))
4577 (defvar yas--exported-syms
4579 (mapatoms (lambda (atom)
4580 (if (and (or (and (boundp atom)
4581 (not (get atom 'byte-obsolete-variable)))
4583 (not (get atom 'byte-obsolete-info))))
4584 (string-match-p "\\`yas-[^-]" (symbol-name atom)))
4585 (push atom exported))))
4587 "Exported yasnippet symbols.
4589 i.e. the ones with \"yas-\" single dash prefix. I will try to
4590 keep them in future yasnippet versions and other elisp libraries
4591 can more or less safely rely upon them.")
4594 (provide 'yasnippet)
4597 ;; indent-tabs-mode: nil
4598 ;; byte-compile-warnings: (not cl-functions)
4600 ;;; yasnippet.el ends here