1 ;;; yasnippet.el --- Yet another snippet extension for Emacs.
3 ;; Copyright (C) 2008-2013, 2015 Free Software Foundation, Inc.
4 ;; Authors: pluskid <pluskid@gmail.com>, João Távora <joaotavora@gmail.com>, Noam Postavsky <npostavs@gmail.com>
5 ;; Maintainer: Noam Postavsky <npostavs@gmail.com>
7 ;; Package-version: 0.8.0
8 ;; X-URL: http://github.com/capitaomorte/yasnippet
9 ;; Keywords: convenience, emulation
10 ;; URL: http://github.com/capitaomorte/yasnippet
11 ;; EmacsWiki: YaSnippetMode
13 ;; This program is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; This program is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
28 ;; Basic steps to setup:
30 ;; (add-to-list 'load-path
31 ;; "~/path-to-yasnippet")
32 ;; (require 'yasnippet)
33 ;; (yas-global-mode 1)
36 ;; Interesting variables are:
40 ;; The directory where user-created snippets are to be
41 ;; stored. Can also be a list of directories. In that case,
42 ;; when used for bulk (re)loading of snippets (at startup or
43 ;; via `yas-reload-all'), directories appearing earlier in
44 ;; the list override other dir's snippets. Also, the first
45 ;; directory is taken as the default for storing the user's
48 ;; The deprecated `yas/root-directory' aliases this variable
49 ;; for backward-compatibility.
52 ;; Major commands are:
56 ;; Try to expand snippets before point. In `yas-minor-mode',
57 ;; this is normally bound to TAB, but you can customize it in
58 ;; `yas-minor-mode-map'.
60 ;; M-x yas-load-directory
62 ;; Prompts you for a directory hierarchy of snippets to load.
64 ;; M-x yas-activate-extra-mode
66 ;; Prompts you for an extra mode to add snippets for in the
69 ;; M-x yas-insert-snippet
71 ;; Prompts you for possible snippet expansion if that is
72 ;; possible according to buffer-local and snippet-local
73 ;; expansion conditions. With prefix argument, ignore these
76 ;; M-x yas-visit-snippet-file
78 ;; Prompts you for possible snippet expansions like
79 ;; `yas-insert-snippet', but instead of expanding it, takes
80 ;; you directly to the snippet definition's file, if it
83 ;; M-x yas-new-snippet
85 ;; Lets you create a new snippet file in the correct
86 ;; subdirectory of `yas-snippet-dirs', according to the
89 ;; M-x yas-load-snippet-buffer
91 ;; When editing a snippet, this loads the snippet. This is
92 ;; bound to "C-c C-c" while in the `snippet-mode' editing
95 ;; M-x yas-tryout-snippet
97 ;; When editing a snippet, this opens a new empty buffer,
98 ;; sets it to the appropriate major mode and inserts the
99 ;; snippet there, so you can see what it looks like. This is
100 ;; bound to "C-c C-t" while in `snippet-mode'.
102 ;; M-x yas-describe-tables
104 ;; Lists known snippets in a separate buffer. User is
105 ;; prompted as to whether only the currently active tables
106 ;; are to be displayed, or all the tables for all major
109 ;; If you have `dropdown-list' installed, you can optionally use it
110 ;; as the preferred "prompting method", putting in your .emacs file,
113 ;; (require 'dropdown-list)
114 ;; (setq yas-prompt-functions '(yas-dropdown-prompt
116 ;; yas-completing-prompt))
118 ;; Also check out the customization group
120 ;; M-x customize-group RET yasnippet RET
122 ;; If you use the customization group to set variables
123 ;; `yas-snippet-dirs' or `yas-global-mode', make sure the path to
124 ;; "yasnippet.el" is present in the `load-path' *before* the
125 ;; `custom-set-variables' is executed in your .emacs file.
127 ;; For more information and detailed usage, refer to the project page:
128 ;; http://github.com/capitaomorte/yasnippet
137 (defvar yas--editing-template)
138 (defvar yas--guessed-modes)
139 (defvar yas--indent-original-column)
140 (defvar yas--scheduled-jit-loads)
142 (defvar yas-selected-text)
143 (defvar yas-verbosity)
144 (defvar yas--current-template)
147 ;;; User customizable variables
149 (defgroup yasnippet nil
150 "Yet Another Snippet extension"
154 (defvar yas-installed-snippets-dir nil)
155 (setq yas-installed-snippets-dir
157 (concat (file-name-directory load-file-name) "snippets")))
159 (defconst yas--default-user-snippets-dir
160 (concat user-emacs-directory "snippets"))
162 (defcustom yas-snippet-dirs (remove nil
163 (list yas--default-user-snippets-dir
164 'yas-installed-snippets-dir))
165 "List of top-level snippet directories.
167 Each element, a string or a symbol whose value is a string,
168 designates a top-level directory where per-mode snippet
169 directories can be found.
171 Elements appearing earlier in the list override later elements'
174 The first directory is taken as the default for storing snippet's
175 created with `yas-new-snippet'. "
176 :type '(choice (string :tag "Single directory (string)")
177 (repeat :args (string) :tag "List of directories (strings)"))
180 :set #'(lambda (symbol new)
181 (let ((old (and (boundp symbol)
182 (symbol-value symbol))))
183 (set-default symbol new)
184 (unless (or (not (fboundp 'yas-reload-all))
188 (defun yas-snippet-dirs ()
189 "Return variable `yas-snippet-dirs' as list of strings."
190 (cl-loop for e in (if (listp yas-snippet-dirs)
192 (list yas-snippet-dirs))
194 (cond ((stringp e) e)
197 (stringp (symbol-value e)))
200 (error "[yas] invalid element %s in `yas-snippet-dirs'" e)))))
202 (defvaralias 'yas/root-directory 'yas-snippet-dirs)
204 (defcustom yas-new-snippet-default "\
205 # -*- mode: snippet -*-
207 # key: ${2:${1:$(yas--key-from-desc yas-text)}}
210 "Default snippet to use when creating a new snippet.
211 If nil, don't use any snippet."
215 (defcustom yas-prompt-functions '(yas-dropdown-prompt
216 yas-completing-prompt
219 "Functions to prompt for keys, templates, etc interactively.
221 These functions are called with the following arguments:
223 - PROMPT: A string to prompt the user
225 - CHOICES: a list of strings or objects.
227 - optional DISPLAY-FN : A function that, when applied to each of
228 the objects in CHOICES will return a string.
230 The return value of any function you put here should be one of
231 the objects in CHOICES, properly formatted with DISPLAY-FN (if
234 - To signal that your particular style of prompting is
235 unavailable at the moment, you can also have the function return
238 - To signal that the user quit the prompting process, you can
241 (signal 'quit \"user quit!\")."
242 :type '(repeat function)
245 (defcustom yas-indent-line 'auto
246 "Controls indenting applied to a recent snippet expansion.
248 The following values are possible:
250 - `fixed' Indent the snippet to the current column;
252 - `auto' Indent each line of the snippet with `indent-according-to-mode'
254 Every other value means don't apply any snippet-side indentation
255 after expansion (the manual per-line \"$>\" indentation still
257 :type '(choice (const :tag "Nothing" nothing)
258 (const :tag "Fixed" fixed)
259 (const :tag "Auto" auto))
262 (defcustom yas-also-auto-indent-first-line nil
263 "Non-nil means also auto indent first line according to mode.
265 Naturally this is only valid when `yas-indent-line' is `auto'"
269 (defcustom yas-snippet-revival t
270 "Non-nil means re-activate snippet fields after undo/redo."
274 (defcustom yas-triggers-in-field nil
275 "If non-nil, allow stacked expansions (snippets inside snippets).
277 Otherwise `yas-next-field-or-maybe-expand' just moves on to the
282 (defcustom yas-fallback-behavior 'call-other-command
283 "How to act when `yas-expand' does *not* expand a snippet.
285 - `call-other-command' means try to temporarily disable YASnippet
286 and call the next command bound to whatever key was used to
289 - nil or the symbol `return-nil' mean do nothing. (and
290 `yas-expand' returns nil)
292 - A Lisp form (apply COMMAND . ARGS) means interactively call
293 COMMAND. If ARGS is non-nil, call COMMAND non-interactively
294 with ARGS as arguments."
295 :type '(choice (const :tag "Call previous command" call-other-command)
296 (const :tag "Do nothing" return-nil))
299 (defcustom yas-choose-keys-first nil
300 "If non-nil, prompt for snippet key first, then for template.
302 Otherwise prompts for all possible snippet names.
304 This affects `yas-insert-snippet' and `yas-visit-snippet-file'."
308 (defcustom yas-choose-tables-first nil
309 "If non-nil, and multiple eligible snippet tables, prompts user for tables first.
311 Otherwise, user chooses between the merging together of all
314 This affects `yas-insert-snippet', `yas-visit-snippet-file'"
318 (defcustom yas-use-menu 'abbreviate
319 "Display a YASnippet menu in the menu bar.
321 When non-nil, submenus for each snippet table will be listed
322 under the menu \"Yasnippet\".
324 - If set to `abbreviate', only the current major-mode
325 menu and the modes set in `yas--extra-modes' are listed.
327 - If set to `full', every submenu is listed
329 - If set to `nil', hide the menu.
331 Any other non-nil value, every submenu is listed."
332 :type '(choice (const :tag "Full" full)
333 (const :tag "Abbreviate" abbreviate)
334 (const :tag "No menu" nil))
337 (defcustom yas-trigger-symbol (or (and (eq window-system 'mac)
339 (char-to-string ?\x21E5))) ;; little ->| sign
341 "The text that will be used in menu to represent the trigger."
345 (defcustom yas-wrap-around-region nil
346 "If non-nil, snippet expansion wraps around selected region.
348 The wrapping occurs just before the snippet's exit marker. This
349 can be overridden on a per-snippet basis."
353 (defcustom yas-good-grace t
354 "If non-nil, don't raise errors in inline elisp evaluation.
356 An error string \"[yas] error\" is returned instead."
360 (defcustom yas-visit-from-menu nil
361 "If non-nil visit snippets's files from menu, instead of expanding them.
363 This can only work when snippets are loaded from files."
367 (defcustom yas-expand-only-for-last-commands nil
368 "List of `last-command' values to restrict tab-triggering to, or nil.
370 Leave this set at nil (the default) to be able to trigger an
371 expansion simply by placing the cursor after a valid tab trigger,
372 using whichever commands.
374 Optionally, set this to something like '(self-insert-command) if
375 you to wish restrict expansion to only happen when the last
376 letter of the snippet tab trigger was typed immediately before
377 the trigger key itself."
378 :type '(repeat function)
381 ;; Only two faces, and one of them shouldn't even be used...
383 (defface yas-field-highlight-face
384 '((t (:inherit 'region)))
385 "The face used to highlight the currently active field of a snippet"
388 (defface yas--field-debug-face
390 "The face used for debugging some overlays normally hidden"
394 ;;; User-visible variables
396 (defvar yas-keymap (let ((map (make-sparse-keymap)))
397 (define-key map [(tab)] 'yas-next-field-or-maybe-expand)
398 (define-key map (kbd "TAB") 'yas-next-field-or-maybe-expand)
399 (define-key map [(shift tab)] 'yas-prev-field)
400 (define-key map [backtab] 'yas-prev-field)
401 (define-key map (kbd "C-g") 'yas-abort-snippet)
402 (define-key map (kbd "C-d") 'yas-skip-and-clear-or-delete-char)
404 "The active keymap while a snippet expansion is in progress.")
406 (defvar yas-key-syntaxes (list "w" "w_" "w_." "w_.()"
407 #'yas-try-key-from-whitespace)
408 "Syntaxes and functions to help look for trigger keys before point.
410 Each element in this list specifies how to skip buffer positions
411 backwards and look for the start of a trigger key.
413 Each element can be either a string or a function receiving the
414 original point as an argument. A string element is simply passed
415 to `skip-syntax-backward' whereas a function element is called
416 with no arguments and should also place point before the original
419 The string between the resulting buffer position and the original
420 point is matched against the trigger keys in the active snippet
423 If no expandable snippets are found, the next element is the list
424 is tried, unless a function element returned the symbol `again',
425 in which case it is called again from the previous position and
426 may once more reposition point.
428 For example, if `yas-key-syntaxes'' value is '(\"w\" \"w_\"),
429 trigger keys composed exclusively of \"word\"-syntax characters
430 are looked for first. Failing that, longer keys composed of
431 \"word\" or \"symbol\" syntax are looked for. Therefore,
436 will, according to the \"w\" element first try \"barbaz\". If
437 that isn't a trigger key, \"foo-barbaz\" is tried, respecting the
438 second \"w_\" element. Notice that even if \"baz\" is a trigger
439 key for an active snippet, it won't be expanded, unless a
440 function is added to `yas-key-syntaxes' that eventually places
441 point between \"bar\" and \"baz\".
443 See also Info node `(elisp) Syntax Descriptors'.")
445 (defvar yas-after-exit-snippet-hook
447 "Hooks to run after a snippet exited.
449 The hooks will be run in an environment where some variables bound to
452 `yas-snippet-beg' : The beginning of the region of the snippet.
454 `yas-snippet-end' : Similar to beg.
456 Attention: These hooks are not run when exiting nested/stacked snippet expansion!")
458 (defvar yas-before-expand-snippet-hook
460 "Hooks to run just before expanding a snippet.")
462 (defvar yas-buffer-local-condition
463 '(if (and (let ((ppss (syntax-ppss)))
464 (or (nth 3 ppss) (nth 4 ppss)))
465 (memq this-command '(yas-expand yas-expand-from-trigger-key
466 yas-expand-from-keymap)))
467 '(require-snippet-condition . force-in-comment)
469 "Snippet expanding condition.
471 This variable is a Lisp form which is evaluated every time a
472 snippet expansion is attempted:
474 * If it evaluates to nil, no snippets can be expanded.
476 * If it evaluates to the a cons (require-snippet-condition
479 * Snippets bearing no \"# condition:\" directive are not
482 * Snippets bearing conditions that evaluate to nil (or
483 produce an error) won't be considered.
485 * If the snippet has a condition that evaluates to non-nil
488 * If REQUIREMENT is t, the snippet is considered
490 * If REQUIREMENT is `eq' RESULT, the snippet is
493 * Otherwise, the snippet is not considered.
495 * If it evaluates to the symbol 'always, all snippets are
496 considered for expansion, regardless of any conditions.
498 * If it evaluates to t or some other non-nil value
500 * Snippet bearing no conditions, or conditions that
501 evaluate to non-nil, are considered for expansion.
503 * Otherwise, the snippet is not considered.
505 Here's an example preventing snippets from being expanded from
506 inside comments, in `python-mode' only, with the exception of
507 snippets returning the symbol 'force-in-comment in their
510 (add-hook 'python-mode-hook
512 (setq yas-buffer-local-condition
513 '(if (python-in-string/comment)
514 '(require-snippet-condition . force-in-comment)
517 The default value is similar, it filters out potential snippet
518 expansions inside comments and string literals, unless the
519 snippet itself contains a condition that returns the symbol
520 `force-in-comment'.")
523 ;;; Internal variables
525 (defvar yas--version "0.8.0beta")
527 (defvar yas--menu-table (make-hash-table)
528 "A hash table of MAJOR-MODE symbols to menu keymaps.")
530 (defvar yas--escaped-characters
531 '(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
532 "List of characters which *might* need to be escaped.")
534 (defconst yas--field-regexp
535 "${\\([0-9]+:\\)?\\([^}]*\\)}"
536 "A regexp to *almost* recognize a field.")
538 (defconst yas--multi-dollar-lisp-expression-regexp
539 "$+[ \t\n]*\\(([^)]*)\\)"
540 "A regexp to *almost* recognize a \"$(...)\" expression.")
542 (defconst yas--backquote-lisp-expression-regexp
544 "A regexp to recognize a \"`lisp-expression`\" expression." )
546 (defconst yas--transform-mirror-regexp
547 "${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
548 "A regexp to *almost* recognize a mirror with a transform.")
550 (defconst yas--simple-mirror-regexp
552 "A regexp to recognize a simple mirror.")
554 (defvar yas--snippet-id-seed 0
555 "Contains the next id for a snippet.")
557 (defun yas--snippet-next-id ()
558 (let ((id yas--snippet-id-seed))
559 (cl-incf yas--snippet-id-seed)
565 ;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
566 (defvar last-buffer-undo-list nil)
568 (defvar yas--minor-mode-menu nil
569 "Holds the YASnippet menu.")
571 (defvar yas-minor-mode-map
572 (let ((map (make-sparse-keymap)))
573 (define-key map [(tab)] 'yas-expand)
574 (define-key map (kbd "TAB") 'yas-expand)
575 (define-key map "\C-c&\C-s" 'yas-insert-snippet)
576 (define-key map "\C-c&\C-n" 'yas-new-snippet)
577 (define-key map "\C-c&\C-v" 'yas-visit-snippet-file)
579 "The keymap used when `yas-minor-mode' is active.")
581 (easy-menu-define yas--minor-mode-menu
583 "Menu used when `yas-minor-mode' is active."
584 '("YASnippet" :visible yas-use-menu
586 ["Expand trigger" yas-expand
587 :help "Possibly expand tab trigger before point"]
588 ["Insert at point..." yas-insert-snippet
589 :help "Prompt for an expandable snippet and expand it at point"]
590 ["New snippet..." yas-new-snippet
591 :help "Create a new snippet in an appropriate directory"]
592 ["Visit snippet file..." yas-visit-snippet-file
593 :help "Prompt for an expandable snippet and find its file"]
595 ("Snippet menu behaviour"
596 ["Visit snippets" (setq yas-visit-from-menu t)
597 :help "Visit snippets from the menu"
598 :active t :style radio :selected yas-visit-from-menu]
599 ["Expand snippets" (setq yas-visit-from-menu nil)
600 :help "Expand snippets from the menu"
601 :active t :style radio :selected (not yas-visit-from-menu)]
603 ["Show all known modes" (setq yas-use-menu 'full)
604 :help "Show one snippet submenu for each loaded table"
605 :active t :style radio :selected (eq yas-use-menu 'full)]
606 ["Abbreviate according to current mode" (setq yas-use-menu 'abbreviate)
607 :help "Show only snippet submenus for the current active modes"
608 :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
610 ["Auto" (setq yas-indent-line 'auto)
611 :help "Indent each line of the snippet with `indent-according-to-mode'"
612 :active t :style radio :selected (eq yas-indent-line 'auto)]
613 ["Fixed" (setq yas-indent-line 'fixed)
614 :help "Indent the snippet to the current column"
615 :active t :style radio :selected (eq yas-indent-line 'fixed)]
616 ["None" (setq yas-indent-line 'none)
617 :help "Don't apply any particular snippet indentation after expansion"
618 :active t :style radio :selected (not (member yas-indent-line '(fixed auto)))]
620 ["Also auto indent first line" (setq yas-also-auto-indent-first-line
621 (not yas-also-auto-indent-first-line))
622 :help "When auto-indenting also, auto indent the first line menu"
623 :active (eq yas-indent-line 'auto)
624 :style toggle :selected yas-also-auto-indent-first-line]
627 ["System X-widget" (setq yas-prompt-functions
629 (remove 'yas-x-prompt
630 yas-prompt-functions)))
631 :help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
632 :active t :style radio :selected (eq (car yas-prompt-functions)
634 ["Dropdown-list" (setq yas-prompt-functions
635 (cons 'yas-dropdown-prompt
636 (remove 'yas-dropdown-prompt
637 yas-prompt-functions)))
638 :help "Use a special dropdown list"
639 :active t :style radio :selected (eq (car yas-prompt-functions)
640 'yas-dropdown-prompt)]
641 ["Ido" (setq yas-prompt-functions
642 (cons 'yas-ido-prompt
643 (remove 'yas-ido-prompt
644 yas-prompt-functions)))
645 :help "Use an ido-style minibuffer prompt"
646 :active t :style radio :selected (eq (car yas-prompt-functions)
648 ["Completing read" (setq yas-prompt-functions
649 (cons 'yas-completing-prompt
650 (remove 'yas-completing-prompt
651 yas-prompt-functions)))
652 :help "Use a normal minibuffer prompt"
653 :active t :style radio :selected (eq (car yas-prompt-functions)
654 'yas-completing-prompt)]
657 ["Wrap region in exit marker"
658 (setq yas-wrap-around-region
659 (not yas-wrap-around-region))
660 :help "If non-nil automatically wrap the selected text in the $0 snippet exit"
661 :style toggle :selected yas-wrap-around-region]
662 ["Allow stacked expansions "
663 (setq yas-triggers-in-field
664 (not yas-triggers-in-field))
665 :help "If non-nil allow snippets to be triggered inside other snippet fields"
666 :style toggle :selected yas-triggers-in-field]
667 ["Revive snippets on undo "
668 (setq yas-snippet-revival
669 (not yas-snippet-revival))
670 :help "If non-nil allow snippets to become active again after undo"
671 :style toggle :selected yas-snippet-revival]
674 (not yas-good-grace))
675 :help "If non-nil don't raise errors in bad embedded elisp in snippets"
676 :style toggle :selected yas-good-grace]
679 ["Load snippets..." yas-load-directory
680 :help "Load snippets from a specific directory"]
681 ["Reload everything" yas-reload-all
682 :help "Cleanup stuff, reload snippets, rebuild menus"]
684 :help "Display some information about YASnippet"]))
686 (defvar yas--extra-modes nil
687 "An internal list of modes for which to also lookup snippets.
689 This variable probably makes more sense as buffer-local, so
690 ensure your use `make-local-variable' when you set it.")
691 (define-obsolete-variable-alias 'yas-extra-modes 'yas--extra-modes "0.8.1")
693 (defvar yas--tables (make-hash-table)
694 "A hash table of mode symbols to `yas--table' objects.")
696 (defvar yas--parents (make-hash-table)
697 "A hash table of mode symbols do lists of direct parent mode symbols.
699 This list is populated when reading the \".yas-parents\" files
700 found when traversing snippet directories with
701 `yas-load-directory'.
703 There might be additional parenting information stored in the
704 `derived-mode-parent' property of some mode symbols, but that is
707 (defvar yas--direct-keymaps (list)
708 "Keymap alist supporting direct snippet keybindings.
710 This variable is placed in `emulation-mode-map-alists'.
712 Its elements looks like (TABLE-NAME . KEYMAP). They're
713 instantiated on `yas-reload-all' but KEYMAP is added to only when
714 loading snippets. `yas--direct-TABLE-NAME' is then a variable set
715 buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
716 defined direct keybindings to the command
717 `yas-expand-from-keymap' which then which snippet to expand.")
719 (defun yas-direct-keymaps-reload ()
720 "Force reload the direct keybinding for active snippet tables."
722 (setq yas--direct-keymaps nil)
723 (maphash #'(lambda (name table)
724 (push (cons (intern (format "yas--direct-%s" name))
725 (yas--table-direct-keymap table))
726 yas--direct-keymaps))
729 (defun yas--modes-to-activate (&optional mode)
730 "Compute list of mode symbols that are active for `yas-expand'
732 (let* ((explored (if mode (list mode) ; Building up list in reverse.
733 (cons major-mode (reverse yas--extra-modes))))
736 (cl-loop for neighbour
737 in (cl-list* (get mode 'derived-mode-parent)
738 (ignore-errors (symbol-function mode))
739 (gethash mode yas--parents))
741 (not (memq neighbour explored))
743 do (push neighbour explored)
744 (funcall dfs neighbour)))))
745 (mapcar dfs explored)
746 (nreverse explored)))
748 (defvar yas-minor-mode-hook nil
749 "Hook run when `yas-minor-mode' is turned on.")
752 (define-minor-mode yas-minor-mode
753 "Toggle YASnippet mode.
755 When YASnippet mode is enabled, `yas-expand', normally bound to
756 the TAB key, expands snippets of code depending on the major
759 With no argument, this command toggles the mode.
760 positive prefix argument turns on the mode.
761 Negative prefix argument turns off the mode.
764 \\{yas-minor-mode-map}"
766 ;; The indicator for the mode line.
769 (cond (yas-minor-mode
770 ;; Install the direct keymaps in `emulation-mode-map-alists'
771 ;; (we use `add-hook' even though it's not technically a hook,
772 ;; but it works). Then define variables named after modes to
773 ;; index `yas--direct-keymaps'.
775 ;; Also install the post-command-hook.
777 (add-hook 'emulation-mode-map-alists 'yas--direct-keymaps)
778 (add-hook 'post-command-hook 'yas--post-command-handler nil t)
779 ;; Set the `yas--direct-%s' vars for direct keymap expansion
781 (dolist (mode (yas--modes-to-activate))
782 (let ((name (intern (format "yas--direct-%s" mode))))
783 (set-default name nil)
784 (set (make-local-variable name) t)))
787 (yas--load-pending-jits))
789 ;; Uninstall the direct keymaps and the post-command hook
791 (remove-hook 'post-command-hook 'yas--post-command-handler t)
792 (remove-hook 'emulation-mode-map-alists 'yas--direct-keymaps))))
794 (defun yas-activate-extra-mode (mode)
795 "Activates the snippets for the given `mode' in the buffer.
797 The function can be called in the hook of a minor mode to
798 activate snippets associated with that mode."
802 (maphash (lambda (k _)
803 (setq modes (cons (list k) modes)))
805 (setq symbol (completing-read
806 "Activate mode: " modes nil t))
808 (when (not (string= "" symbol))
811 (add-to-list (make-local-variable 'yas--extra-modes) mode)
812 (yas--load-pending-jits)))
814 (defun yas-deactivate-extra-mode (mode)
815 "Deactivates the snippets for the given `mode' in the buffer."
819 "Deactivate mode: " (mapcar #'list yas--extra-modes) nil t))))
820 (set (make-local-variable 'yas--extra-modes)
824 (defvar yas-dont-activate '(minibufferp)
825 "If non-nil don't let `yas-global-mode' affect some buffers.
827 If a function of zero arguments, then its result is used.
829 If a list of functions, then all functions must return nil to
830 activate yas for this buffer.
832 In Emacsen <= 23, this variable is buffer-local. Because
833 `yas-minor-mode-on' is called by `yas-global-mode' after
834 executing the buffer's major mode hook, setting this variable
835 there is an effective way to define exceptions to the \"global\"
836 activation behaviour.
838 In Emacsen > 23, only the global value is used. To define
839 per-mode exceptions to the \"global\" activation behaviour, call
840 `yas-minor-mode' with a negative argument directily in the major
842 (unless (> emacs-major-version 23)
844 (make-variable-buffer-local 'yas-dont-activate)))
847 (defun yas-minor-mode-on ()
848 "Turn on YASnippet minor mode.
850 Honour `yas-dont-activate', which see."
852 ;; Check `yas-dont-activate'
853 (unless (cond ((functionp yas-dont-activate)
854 (funcall yas-dont-activate))
855 ((consp yas-dont-activate)
856 (some #'funcall yas-dont-activate))
861 (define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
865 (defun yas--global-mode-reload-with-jit-maybe ()
866 "Run `yas-reload-all' when `yas-global-mode' is on."
867 (when yas-global-mode (yas-reload-all)))
869 (add-hook 'yas-global-mode-hook 'yas--global-mode-reload-with-jit-maybe)
874 (defvar yas--font-lock-keywords
875 (append '(("^#.*$" . font-lock-comment-face))
876 lisp-font-lock-keywords-2
878 (0 font-lock-keyword-face)
879 (1 font-lock-string-face t))
881 (0 font-lock-keyword-face)
882 (1 font-lock-warning-face t))
883 ("${" . font-lock-keyword-face)
884 ("$[0-9]+?" . font-lock-preprocessor-face)
885 ("\\(\\$(\\)" 1 font-lock-preprocessor-face)
887 (0 font-lock-keyword-face)))))
889 (defvar snippet-mode-map
890 (let ((map (make-sparse-keymap)))
891 (easy-menu-define nil
893 "Menu used when snippet-mode is active."
895 (mapcar #'(lambda (ent)
897 (define-key map (third ent) (second ent)))
898 (vector (first ent) (second ent) t))
899 '(("Load this snippet" yas-load-snippet-buffer "\C-c\C-l")
900 ("Load and quit window" yas-load-snippet-buffer-and-close "\C-c\C-c")
901 ("Try out this snippet" yas-tryout-snippet "\C-c\C-t")))))
903 "The keymap used when `snippet-mode' is active.")
906 (define-derived-mode snippet-mode text-mode "Snippet"
907 "A mode for editing yasnippets"
908 (setq font-lock-defaults '(yas--font-lock-keywords))
909 (set (make-local-variable 'require-final-newline) nil)
910 (set (make-local-variable 'comment-start) "#")
911 (set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
915 ;;; Internal structs for template management
917 (cl-defstruct (yas--template
918 (:constructor yas--make-template)
919 ;; Handles `yas-define-snippets' format, plus the
920 ;; initial TABLE argument.
922 yas--define-snippets-2
925 &optional xname condition group
926 expand-env load-file xkeybinding xuuid save-file
929 ;; A little redundant: we always get a name
930 ;; from `yas--parse-template' except when
931 ;; there isn't a file.
932 (and load-file (file-name-nondirectory load-file))
933 (and save-file (file-name-nondirectory save-file))
935 (keybinding (yas--read-keybinding xkeybinding))
936 (uuid (or xuuid name))
937 (old (gethash uuid (yas--table-uuidhash table)))
939 (and old (yas--template-menu-binding-pair old)))
941 (and old (yas--template-perm-group old))))))
942 "A template for a snippet."
953 group ;; as dictated by the #group: directive or .yas-make-groups
954 perm-group ;; as dictated by `yas-define-menu'
958 (defstruct (yas--table (:constructor yas--make-snippet-table (name)))
959 "A table to store snippets for a particular mode.
961 Has the following fields:
965 A symbol name normally corresponding to a major mode, but can
966 also be a pseudo major-mode to be used in
967 `yas-activate-extra-mode', for example.
971 A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
972 a string or a vector, where the former is the snippet's trigger
973 and the latter means it's a direct keybinding. NAMEHASH is yet
974 another hash of (NAME . TEMPLATE) where NAME is the snippet's
975 name and TEMPLATE is a `yas--template' object.
977 `yas--table-direct-keymap'
979 A keymap for the snippets in this table that have direct
980 keybindings. This is kept in sync with the keyhash, i.e., all
981 the elements of the keyhash that are vectors appear here as
982 bindings to `yas-expand-from-keymap'.
984 `yas--table-uuidhash'
986 A hash table mapping snippets uuid's to the same `yas--template'
987 objects. A snippet uuid defaults to the snippet's name."
989 (hash (make-hash-table :test 'equal))
990 (uuidhash (make-hash-table :test 'equal))
992 (direct-keymap (make-sparse-keymap)))
994 (defun yas--get-template-by-uuid (mode uuid)
995 "Find the snippet template in MODE by its UUID."
996 (let* ((table (gethash mode yas--tables mode)))
998 (gethash uuid (yas--table-uuidhash table)))))
1000 ;; Apropos storing/updating in TABLE, this works in two steps:
1002 ;; 1. `yas--remove-template-by-uuid' removes any
1003 ;; keyhash-namehash-template mappings from TABLE, grabbing the
1004 ;; snippet by its uuid. Also removes mappings from TABLE's
1005 ;; `yas--table-direct-keymap' (FIXME: and should probably take care
1006 ;; of potentially stale menu bindings right?.)
1008 ;; 2. `yas--add-template' adds this all over again.
1010 ;; Create a new or add to an existing keyhash-namehash mapping.
1012 ;; For reference on understanding this, consider three snippet
1015 ;; A: # name: The Foo
1017 ;; # binding: C-c M-l
1019 ;; B: # name: Mrs Foo
1022 ;; C: # name: The Bar
1023 ;; # binding: C-c M-l
1028 ;; keyhash namehashes(3) yas--template structs(4)
1029 ;; -----------------------------------------------------
1032 ;; "foo" ---> "The Foo" ---> [yas--template A] |
1033 ;; "Mrs Foo" ---> [yas--template B] |
1035 ;; [C-c M-l] ---> "The Foo" -------------------------/
1036 ;; "The Bar" ---> [yas--template C]
1038 ;; "baz" ---> "Baz" ---> [yas--template D]
1040 ;; Additionally, since uuid defaults to the name, we have a
1041 ;; `yas--table-uuidhash' for TABLE
1043 ;; uuidhash yas--template structs
1044 ;; -------------------------------
1045 ;; "The Foo" ---> [yas--template A]
1046 ;; "Mrs Foo" ---> [yas--template B]
1047 ;; "The Bar" ---> [yas--template C]
1048 ;; "Baz" ---> [yas--template D]
1050 ;; FIXME: the more I look at this data-structure the more I think I'm
1051 ;; stupid. There has to be an easier way (but beware lots of code
1052 ;; depends on this).
1054 (defun yas--remove-template-by-uuid (table uuid)
1055 "Remove from TABLE a template identified by UUID."
1056 (let ((template (gethash uuid (yas--table-uuidhash table))))
1058 (let* ((name (yas--template-name template))
1060 ;; Remove the name from each of the targeted namehashes
1062 (maphash #'(lambda (k v)
1063 (let ((template (gethash name v)))
1065 (eq uuid (yas--template-uuid template)))
1067 (when (zerop (hash-table-count v))
1068 (push k empty-keys)))))
1069 (yas--table-hash table))
1070 ;; Remove the namehash themselves if they've become empty
1072 (dolist (key empty-keys)
1074 (define-key (yas--table-direct-keymap table) key nil))
1075 (remhash key (yas--table-hash table)))
1077 ;; Finally, remove the uuid from the uuidhash
1079 (remhash uuid (yas--table-uuidhash table))))))
1081 (defun yas--add-template (table template)
1082 "Store in TABLE the snippet template TEMPLATE.
1084 KEY can be a string (trigger key) of a vector (direct
1086 (let ((name (yas--template-name template))
1087 (key (yas--template-key template))
1088 (keybinding (yas--template-keybinding template))
1089 (_menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
1090 (dolist (k (remove nil (list key keybinding)))
1094 (yas--table-hash table))
1096 (make-hash-table :test 'equal)
1097 (yas--table-hash table))))
1099 (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
1101 ;; Update TABLE's `yas--table-uuidhash'
1102 (puthash (yas--template-uuid template)
1104 (yas--table-uuidhash table))))
1106 (defun yas--update-template (table template)
1107 "Add or update TEMPLATE in TABLE.
1109 Also takes care of adding and updating to the associated menu.
1111 ;; Remove from table by uuid
1113 (yas--remove-template-by-uuid table (yas--template-uuid template))
1114 ;; Add to table again
1116 (yas--add-template table template)
1117 ;; Take care of the menu
1119 (yas--update-template-menu table template)
1122 (defun yas--update-template-menu (table template)
1123 "Update every menu-related for TEMPLATE."
1124 (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
1125 (key (yas--template-key template))
1126 (keybinding (yas--template-keybinding template)))
1127 ;; The snippet might have changed name or keys, so update
1128 ;; user-visible strings
1130 (unless (eq (cdr menu-binding-pair) :none)
1131 ;; the menu item name
1133 (setf (cadar menu-binding-pair) (yas--template-name template))
1134 ;; the :keys information (also visible to the user)
1135 (setf (getf (cdr (car menu-binding-pair)) :keys)
1136 (or (and keybinding (key-description keybinding))
1137 (and key (concat key yas-trigger-symbol))))))
1138 (unless (yas--template-menu-managed-by-yas-define-menu template)
1140 (yas--menu-keymap-get-create (yas--table-mode table)
1141 (mapcar #'yas--table-mode
1142 (yas--table-parents table))))
1143 (group (yas--template-group template)))
1144 ;; Remove from menu keymap
1146 (assert menu-keymap)
1147 (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
1149 ;; Add necessary subgroups as necessary.
1151 (dolist (subgroup group)
1152 (let ((subgroup-keymap (lookup-key menu-keymap (vector (make-symbol subgroup)))))
1153 (unless (and subgroup-keymap
1154 (keymapp subgroup-keymap))
1155 (setq subgroup-keymap (make-sparse-keymap))
1156 (define-key menu-keymap (vector (make-symbol subgroup))
1157 `(menu-item ,subgroup ,subgroup-keymap)))
1158 (setq menu-keymap subgroup-keymap)))
1160 ;; Add this entry to the keymap
1162 (define-key menu-keymap
1163 (vector (make-symbol (yas--template-uuid template)))
1164 (car (yas--template-menu-binding-pair template))))))
1166 (defun yas--namehash-templates-alist (namehash)
1167 "Return NAMEHASH as an alist."
1169 (maphash #'(lambda (k v)
1170 (push (cons k v) alist))
1174 (defun yas--fetch (table key)
1175 "Fetch templates in TABLE by KEY.
1177 Return a list of cons (NAME . TEMPLATE) where NAME is a
1178 string and TEMPLATE is a `yas--template' structure."
1179 (let* ((keyhash (yas--table-hash table))
1180 (namehash (and keyhash (gethash key keyhash))))
1182 (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
1185 ;;; Filtering/condition logic
1187 (defun yas--eval-condition (condition)
1194 (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
1198 (defun yas--filter-templates-by-condition (templates)
1199 "Filter the templates using the applicable condition.
1201 TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
1202 string and TEMPLATE is a `yas--template' structure.
1204 This function implements the rules described in
1205 `yas-buffer-local-condition'. See that variables documentation."
1206 (let ((requirement (yas--require-template-specific-condition-p)))
1207 (if (eq requirement 'always)
1209 (remove-if-not #'(lambda (pair)
1210 (yas--template-can-expand-p
1211 (yas--template-condition (cdr pair)) requirement))
1214 (defun yas--require-template-specific-condition-p ()
1215 "Decide if this buffer requests/requires snippet-specific
1216 conditions to filter out potential expansions."
1217 (if (eq 'always yas-buffer-local-condition)
1219 (let ((local-condition (or (and (consp yas-buffer-local-condition)
1220 (yas--eval-condition yas-buffer-local-condition))
1221 yas-buffer-local-condition)))
1222 (when local-condition
1223 (if (eq local-condition t)
1225 (and (consp local-condition)
1226 (eq 'require-snippet-condition (car local-condition))
1227 (symbolp (cdr local-condition))
1228 (cdr local-condition)))))))
1230 (defun yas--template-can-expand-p (condition requirement)
1231 "Evaluate CONDITION and REQUIREMENT and return a boolean."
1232 (let* ((result (or (null condition)
1233 (yas--eval-condition condition))))
1234 (cond ((eq requirement t)
1237 (eq requirement result)))))
1239 (defun yas--table-templates (table)
1242 (maphash #'(lambda (_key namehash)
1243 (maphash #'(lambda (name template)
1244 (push (cons name template) acc))
1246 (yas--table-hash table))
1247 (yas--filter-templates-by-condition acc))))
1249 (defun yas--templates-for-key-at-point ()
1250 "Find `yas--template' objects for any trigger keys preceding point.
1251 Returns (TEMPLATES START END). This function respects
1252 `yas-key-syntaxes', which see."
1254 (let ((original (point))
1255 (methods yas-key-syntaxes)
1260 (unless (eq method (car methods))
1261 ;; TRICKY: `eq'-ness test means we can only be here if
1262 ;; `method' is a function that returned `again', and hence
1263 ;; don't revert back to original position as per
1264 ;; `yas-key-syntaxes'.
1265 (goto-char original))
1266 (setq method (car methods))
1267 (cond ((stringp method)
1268 (skip-syntax-backward method)
1269 (setq methods (cdr methods)))
1271 (unless (eq (funcall method original)
1273 (setq methods (cdr methods))))
1275 (setq methods (cdr methods))
1276 (yas--warning "Invalid element `%s' in `yas-key-syntaxes'" method)))
1277 (let ((possible-key (buffer-substring-no-properties (point) original)))
1279 (goto-char original)
1281 (mapcan #'(lambda (table)
1282 (yas--fetch table possible-key))
1283 (yas--get-snippet-tables))))))
1285 (list templates (point) original)))))
1287 (defun yas--table-all-keys (table)
1288 "Get trigger keys of all active snippets in TABLE."
1290 (maphash #'(lambda (key namehash)
1291 (when (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash))
1293 (yas--table-hash table))
1296 (defun yas--table-mode (table)
1297 (intern (yas--table-name table)))
1300 ;;; Internal functions and macros:
1302 (defun yas--handle-error (err)
1303 "Handle error depending on value of `yas-good-grace'."
1304 (let ((msg (yas--format "elisp error: %s" (error-message-string err))))
1305 (if yas-good-grace msg
1308 (defun yas--eval-lisp (form)
1309 "Evaluate FORM and convert the result to string."
1310 (let ((retval (catch 'yas--exception
1316 (let ((result (eval form)))
1318 (format "%s" result))))))
1319 (error (yas--handle-error err))))))
1320 (when (and (consp retval)
1321 (eq 'yas--exception (car retval)))
1322 (error (cdr retval)))
1325 (defun yas--eval-lisp-no-saves (form)
1328 (error (message "%s" (yas--handle-error err)))))
1330 (defun yas--read-lisp (string &optional nil-on-error)
1331 "Read STRING as a elisp expression and return it.
1333 In case STRING in an invalid expression and NIL-ON-ERROR is nil,
1334 return an expression that when evaluated will issue an error."
1337 (error (and (not nil-on-error)
1338 `(error (error-message-string ,err))))))
1340 (defun yas--read-keybinding (keybinding)
1341 "Read KEYBINDING as a snippet keybinding, return a vector."
1342 (when (and keybinding
1343 (not (string-match "keybinding" keybinding)))
1345 (let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
1347 (read-kbd-macro keybinding 'need-vector))))
1350 (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
1351 keybinding (error-message-string err))
1354 (defun yas--table-get-create (mode)
1355 "Get or create the snippet table corresponding to MODE."
1356 (let ((table (gethash mode
1359 (setq table (yas--make-snippet-table (symbol-name mode)))
1360 (puthash mode table yas--tables)
1361 (push (cons (intern (format "yas--direct-%s" mode))
1362 (yas--table-direct-keymap table))
1363 yas--direct-keymaps))
1366 (defun yas--get-snippet-tables (&optional mode)
1367 "Get snippet tables for MODE.
1369 MODE defaults to the current buffer's `major-mode'.
1371 Return a list of `yas--table' objects. The list of modes to
1372 consider is returned by `yas--modes-to-activate'"
1374 (mapcar #'(lambda (name)
1375 (gethash name yas--tables))
1376 (yas--modes-to-activate mode))))
1378 (defun yas--menu-keymap-get-create (mode &optional parents)
1379 "Get or create the menu keymap for MODE and its PARENTS.
1381 This may very well create a plethora of menu keymaps and arrange
1382 them all in `yas--menu-table'"
1383 (let* ((menu-keymap (or (gethash mode yas--menu-table)
1384 (puthash mode (make-sparse-keymap) yas--menu-table))))
1385 (mapc #'yas--menu-keymap-get-create parents)
1386 (define-key yas--minor-mode-menu (vector mode)
1387 `(menu-item ,(symbol-name mode) ,menu-keymap
1388 :visible (yas--show-menu-p ',mode)))
1392 ;;; Template-related and snippet loading functions
1394 (defun yas--parse-template (&optional file)
1395 "Parse the template in the current buffer.
1397 Optional FILE is the absolute file name of the file being
1400 Optional GROUP is the group where the template is to go,
1401 otherwise we attempt to calculate it from FILE.
1403 Return a snippet-definition, i.e. a list
1405 (KEY TEMPLATE NAME CONDITION GROUP VARS LOAD-FILE KEYBINDING UUID)
1407 If the buffer contains a line of \"# --\" then the contents above
1408 this line are ignored. Directives can set most of these with the syntax:
1410 # directive-name : directive-value
1412 Here's a list of currently recognized directives:
1423 (goto-char (point-min))
1424 (let* ((type 'snippet)
1426 (file-name-nondirectory file)))
1432 (yas--calculate-group file)))
1436 (if (re-search-forward "^# --\n" nil t)
1437 (progn (setq template
1438 (buffer-substring-no-properties (point)
1440 (setq bound (point))
1441 (goto-char (point-min))
1442 (while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*?\\)[[:space:]]*$" bound t)
1443 (when (string= "uuid" (match-string-no-properties 1))
1444 (setq uuid (match-string-no-properties 2)))
1445 (when (string= "type" (match-string-no-properties 1))
1446 (setq type (if (string= "command" (match-string-no-properties 2))
1449 (when (string= "key" (match-string-no-properties 1))
1450 (setq key (match-string-no-properties 2)))
1451 (when (string= "name" (match-string-no-properties 1))
1452 (setq name (match-string-no-properties 2)))
1453 (when (string= "condition" (match-string-no-properties 1))
1454 (setq condition (yas--read-lisp (match-string-no-properties 2))))
1455 (when (string= "group" (match-string-no-properties 1))
1456 (setq group (match-string-no-properties 2)))
1457 (when (string= "expand-env" (match-string-no-properties 1))
1458 (setq expand-env (yas--read-lisp (match-string-no-properties 2)
1460 (when (string= "binding" (match-string-no-properties 1))
1461 (setq binding (match-string-no-properties 2)))))
1463 (buffer-substring-no-properties (point-min) (point-max))))
1464 (unless (or key binding)
1465 (setq key (and file (file-name-nondirectory file))))
1466 (when (eq type 'command)
1467 (setq template (yas--read-lisp (concat "(progn" template ")"))))
1469 (setq group (split-string group "\\.")))
1470 (list key template name condition group expand-env file binding uuid)))
1472 (defun yas--calculate-group (file)
1473 "Calculate the group for snippet file path FILE."
1474 (let* ((dominating-dir (locate-dominating-file file
1475 ".yas-make-groups"))
1476 (extra-path (and dominating-dir
1477 (replace-regexp-in-string (concat "^"
1478 (expand-file-name dominating-dir))
1480 (expand-file-name file))))
1481 (extra-dir (and extra-path
1482 (file-name-directory extra-path)))
1483 (group (and extra-dir
1484 (replace-regexp-in-string "/"
1486 (directory-file-name extra-dir)))))
1489 (defun yas--subdirs (directory &optional filep)
1490 "Return subdirs or files of DIRECTORY according to FILEP."
1491 (remove-if (lambda (file)
1492 (or (string-match "^\\."
1493 (file-name-nondirectory file))
1494 (string-match "^#.*#$"
1495 (file-name-nondirectory file))
1497 (file-name-nondirectory file))
1499 (file-directory-p file)
1500 (not (file-directory-p file)))))
1501 (directory-files directory t)))
1503 (defun yas--make-menu-binding (template)
1504 (let ((mode (yas--table-mode (yas--template-table template))))
1505 `(lambda () (interactive) (yas--expand-or-visit-from-menu ',mode ,(yas--template-uuid template)))))
1507 (defun yas--expand-or-visit-from-menu (mode uuid)
1508 (let* ((table (yas--table-get-create mode))
1509 (yas--current-template (and table
1510 (gethash uuid (yas--table-uuidhash table)))))
1511 (when yas--current-template
1512 (if yas-visit-from-menu
1513 (yas--visit-snippet-file-1 yas--current-template)
1514 (let ((where (if (region-active-p)
1515 (cons (region-beginning) (region-end))
1516 (cons (point) (point)))))
1517 (yas-expand-snippet (yas--template-content yas--current-template)
1520 (yas--template-expand-env yas--current-template)))))))
1522 (defun yas--key-from-desc (text)
1523 "Return a yasnippet key from a description string TEXT."
1524 (replace-regexp-in-string "\\(\\w+\\).*" "\\1" text))
1527 ;;; Popping up for keys and templates
1529 (defun yas--prompt-for-template (templates &optional prompt)
1530 "Interactively choose a template from the list TEMPLATES.
1532 TEMPLATES is a list of `yas--template'.
1534 Optional PROMPT sets the prompt to use."
1537 (sort templates #'(lambda (t1 t2)
1538 (< (length (yas--template-name t1))
1539 (length (yas--template-name t2))))))
1540 (some #'(lambda (fn)
1541 (funcall fn (or prompt "Choose a snippet: ")
1543 #'yas--template-name))
1544 yas-prompt-functions)))
1546 (defun yas--prompt-for-keys (keys &optional prompt)
1547 "Interactively choose a template key from the list KEYS.
1549 Optional PROMPT sets the prompt to use."
1551 (some #'(lambda (fn)
1552 (funcall fn (or prompt "Choose a snippet key: ") keys))
1553 yas-prompt-functions)))
1555 (defun yas--prompt-for-table (tables &optional prompt)
1556 "Interactively choose a table from the list TABLES.
1558 Optional PROMPT sets the prompt to use."
1560 (some #'(lambda (fn)
1561 (funcall fn (or prompt "Choose a snippet table: ")
1564 yas-prompt-functions)))
1566 (defun yas-x-prompt (prompt choices &optional display-fn)
1567 "Display choices in a x-window prompt."
1568 (when (and window-system choices)
1569 ;; Let window position be recalculated to ensure that
1570 ;; `posn-at-point' returns non-nil.
1574 (if (fboundp 'posn-at-point)
1575 (let ((x-y (posn-x-y (posn-at-point (point)))))
1576 (list (list (+ (car x-y) 10)
1581 ,@(mapcar* (lambda (c d) `(,(concat " " d) . ,c))
1583 (if display-fn (mapcar display-fn choices) choices)))))
1586 (defun yas-maybe-ido-prompt (prompt choices &optional display-fn)
1587 (when (bound-and-true-p ido-mode)
1588 (yas-ido-prompt prompt choices display-fn)))
1590 (defun yas-ido-prompt (prompt choices &optional display-fn)
1592 (yas-completing-prompt prompt choices display-fn #'ido-completing-read))
1594 (defun yas-dropdown-prompt (_prompt choices &optional display-fn)
1595 (when (fboundp 'dropdown-list)
1596 (let* ((formatted-choices
1597 (if display-fn (mapcar display-fn choices) choices))
1598 (n (dropdown-list formatted-choices)))
1599 (if n (nth n choices)
1602 (defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
1603 (let* ((formatted-choices
1604 (if display-fn (mapcar display-fn choices) choices))
1605 (chosen (funcall (or completion-fn #'completing-read)
1606 prompt formatted-choices
1607 nil 'require-match nil nil)))
1608 (if (eq choices formatted-choices)
1610 (nth (or (position chosen formatted-choices :test #'string=) 0)
1613 (defun yas-no-prompt (_prompt choices &optional _display-fn)
1617 ;;; Defining snippets
1618 ;; This consists of creating and registering `yas--template' objects in the
1622 (defvar yas--creating-compiled-snippets nil)
1624 (defun yas--define-snippets-1 (snippet snippet-table)
1625 "Helper for `yas-define-snippets'."
1626 ;; Update the appropriate table. Also takes care of adding the
1627 ;; key indicators in the templates menu entry, if any.
1628 (yas--update-template
1629 snippet-table (apply #'yas--define-snippets-2 snippet-table snippet)))
1631 (defun yas-define-snippets (mode snippets)
1632 "Define SNIPPETS for MODE.
1634 SNIPPETS is a list of snippet definitions, each taking the
1637 (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV LOAD-FILE KEYBINDING UUID SAVE-FILE)
1639 Within these, only KEY and TEMPLATE are actually mandatory.
1641 TEMPLATE might be a Lisp form or a string, depending on whether
1642 this is a snippet or a snippet-command.
1644 CONDITION, EXPAND-ENV and KEYBINDING are Lisp forms, they have
1645 been `yas--read-lisp'-ed and will eventually be
1646 `yas--eval-lisp'-ed.
1648 The remaining elements are strings.
1650 FILE is probably of very little use if you're programatically
1653 UUID is the snippet's \"unique-id\". Loading a second snippet
1654 file with the same uuid would replace the previous snippet.
1656 You can use `yas--parse-template' to return such lists based on
1657 the current buffers contents."
1658 (if yas--creating-compiled-snippets
1659 (let ((print-length nil))
1660 (insert ";;; Snippet definitions:\n;;;\n")
1661 (dolist (snippet snippets)
1662 ;; Fill in missing elements with nil.
1663 (setq snippet (append snippet (make-list (- 10 (length snippet)) nil)))
1664 ;; Move LOAD-FILE to SAVE-FILE because we will load from the
1665 ;; compiled file, not LOAD-FILE.
1666 (let ((load-file (nth 6 snippet)))
1667 (setcar (nthcdr 6 snippet) nil)
1668 (setcar (nthcdr 9 snippet) load-file)))
1669 (insert (pp-to-string
1670 `(yas-define-snippets ',mode ',snippets)))
1673 (let ((snippet-table (yas--table-get-create mode))
1675 (dolist (snippet snippets)
1676 (setq template (yas--define-snippets-1 snippet
1681 ;;; Loading snippets from files
1683 (defun yas--template-get-file (template)
1684 "Return TEMPLATE's LOAD-FILE or SAVE-FILE."
1685 (or (yas--template-load-file template)
1686 (let ((file (yas--template-save-file template)))
1688 (yas--message 2 "%s has no load file, use save file, %s, instead."
1689 (yas--template-name template) file))
1692 (defun yas--load-yas-setup-file (file)
1693 (if (not yas--creating-compiled-snippets)
1695 (load file 'noerror (<= yas-verbosity 2))
1696 (let ((elfile (concat file ".el")))
1697 (when (file-exists-p elfile)
1698 (insert ";;; contents of the .yas-setup.el support file:\n;;;\n")
1699 (insert-file-contents elfile)
1700 (goto-char (point-max))))))
1702 (defun yas--define-parents (mode parents)
1703 "Add PARENTS to the list of MODE's parents."
1704 (puthash mode (remove-duplicates
1706 (gethash mode yas--parents)))
1709 (defun yas-load-directory (top-level-dir &optional use-jit interactive)
1710 "Load snippets in directory hierarchy TOP-LEVEL-DIR.
1712 Below TOP-LEVEL-DIR each directory should be a mode name.
1714 With prefix argument USE-JIT do jit-loading of snippets."
1716 (list (read-directory-name "Select the root directory: " nil nil t)
1717 current-prefix-arg t))
1718 (unless yas-snippet-dirs
1719 (setq yas-snippet-dirs top-level-dir))
1720 (let ((impatient-buffers))
1721 (dolist (dir (yas--subdirs top-level-dir))
1722 (let* ((major-mode-and-parents (yas--compute-major-mode-and-parents
1723 (concat dir "/dummy")))
1724 (mode-sym (car major-mode-and-parents))
1725 (parents (cdr major-mode-and-parents)))
1726 ;; Attention: The parents and the menus are already defined
1727 ;; here, even if the snippets are later jit-loaded.
1729 ;; * We need to know the parents at this point since entering a
1730 ;; given mode should jit load for its parents
1731 ;; immediately. This could be reviewed, the parents could be
1732 ;; discovered just-in-time-as well
1734 ;; * We need to create the menus here to support the `full'
1735 ;; option to `yas-use-menu' (all known snippet menus are shown to the user)
1737 (yas--define-parents mode-sym parents)
1738 (yas--menu-keymap-get-create mode-sym)
1739 (let ((fun `(lambda () ;; FIXME: Simulating lexical-binding.
1740 (yas--load-directory-1 ',dir ',mode-sym))))
1742 (yas--schedule-jit mode-sym fun)
1744 ;; Look for buffers that are already in `mode-sym', and so
1745 ;; need the new snippets immediately...
1748 (cl-loop for buffer in (buffer-list)
1749 do (with-current-buffer buffer
1750 (when (eq major-mode mode-sym)
1751 (yas--message 3 "Discovered there was already %s in %s" buffer mode-sym)
1752 (push buffer impatient-buffers)))))))
1753 ;; ...after TOP-LEVEL-DIR has been completely loaded, call
1754 ;; `yas--load-pending-jits' in these impatient buffers.
1756 (cl-loop for buffer in impatient-buffers
1757 do (with-current-buffer buffer (yas--load-pending-jits))))
1759 (yas--message 3 "Loaded snippets from %s." top-level-dir)))
1761 (defun yas--load-directory-1 (directory mode-sym)
1762 "Recursively load snippet templates from DIRECTORY."
1763 (if yas--creating-compiled-snippets
1764 (let ((output-file (expand-file-name ".yas-compiled-snippets.el"
1766 (with-temp-file output-file
1767 (insert (format ";;; Compiled snippets and support files for `%s'\n"
1769 (yas--load-directory-2 directory mode-sym)
1770 (insert (format ";;; Do not edit! File generated at %s\n"
1771 (current-time-string)))))
1773 (unless (file-exists-p (concat directory "/" ".yas-skip"))
1774 (unless (and (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3))
1775 (progn (yas--message 2 "Loaded compiled snippets from %s" directory) t))
1776 (yas--message 2 "Loading snippet files from %s" directory)
1777 (yas--load-directory-2 directory mode-sym)))))
1779 (defun yas--load-directory-2 (directory mode-sym)
1780 ;; Load .yas-setup.el files wherever we find them
1782 (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
1783 (let* ((default-directory directory)
1785 ;; load the snippet files
1788 (dolist (file (yas--subdirs directory 'no-subdirs-just-files))
1789 (when (file-readable-p file)
1790 (insert-file-contents file nil nil nil t)
1791 (push (yas--parse-template file)
1794 (yas-define-snippets mode-sym
1796 ;; now recurse to a lower level
1798 (dolist (subdir (yas--subdirs directory))
1799 (yas--load-directory-2 subdir
1802 (defun yas--load-snippet-dirs (&optional nojit)
1803 "Reload the directories listed in `yas-snippet-dirs' or
1804 prompt the user to select one."
1806 (if (null yas-snippet-dirs)
1807 (call-interactively 'yas-load-directory)
1808 (when (member yas--default-user-snippets-dir yas-snippet-dirs)
1809 (make-directory yas--default-user-snippets-dir t))
1810 (dolist (directory (reverse (yas-snippet-dirs)))
1811 (cond ((file-directory-p directory)
1812 (yas-load-directory directory (not nojit))
1814 (yas--message 3 "Loaded %s" directory)
1815 (yas--message 3 "Prepared just-in-time loading for %s" directory)))
1817 (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors)))))
1820 (defun yas-reload-all (&optional no-jit interactive)
1821 "Reload all snippets and rebuild the YASnippet menu.
1823 When NO-JIT is non-nil force immediate reload of all known
1824 snippets under `yas-snippet-dirs', otherwise use just-in-time
1827 When called interactively, use just-in-time loading when given a
1829 (interactive (list (not current-prefix-arg) t))
1832 (snippet-editing-buffers
1833 (remove-if-not #'(lambda (buffer)
1834 (with-current-buffer buffer yas--editing-template))
1836 ;; Warn if there are buffers visiting snippets, since reloading will break
1837 ;; any on-line editing of those buffers.
1839 (when snippet-editing-buffers
1841 (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
1842 (mapc #'kill-buffer snippet-editing-buffers)
1843 (yas--message 1 "Aborted reload...")
1845 ;; in a non-interactive use, at least set
1846 ;; `yas--editing-template' to nil, make it guess it next time around
1847 (mapc #'(lambda (buffer)
1848 (with-current-buffer buffer
1849 (kill-local-variable 'yas--editing-template)))
1852 ;; Empty all snippet tables and parenting info
1854 (setq yas--tables (make-hash-table))
1855 (setq yas--parents (make-hash-table))
1857 ;; Before killing `yas--menu-table' use its keys to cleanup the
1858 ;; mode menu parts of `yas--minor-mode-menu' (thus also cleaning
1859 ;; up `yas-minor-mode-map', which points to it)
1861 (maphash #'(lambda (menu-symbol _keymap)
1862 (define-key yas--minor-mode-menu (vector menu-symbol) nil))
1864 ;; Now empty `yas--menu-table' as well
1865 (setq yas--menu-table (make-hash-table))
1867 ;; Cancel all pending 'yas--scheduled-jit-loads'
1869 (setq yas--scheduled-jit-loads (make-hash-table))
1871 ;; Reload the directories listed in `yas-snippet-dirs' or prompt
1872 ;; the user to select one.
1874 (setq errors (yas--load-snippet-dirs no-jit))
1875 ;; Reload the direct keybindings
1877 (yas-direct-keymaps-reload)
1879 (run-hooks 'yas-after-reload-hook)
1880 (yas--message 3 "Reloaded everything%s...%s."
1881 (if no-jit "" " (snippets will load just-in-time)")
1882 (if errors " (some errors, check *Messages*)" "")))))
1884 (defvar yas-after-reload-hook nil
1885 "Hooks run after `yas-reload-all'.")
1887 (defun yas--load-pending-jits ()
1888 (dolist (mode (yas--modes-to-activate))
1889 (let ((funs (reverse (gethash mode yas--scheduled-jit-loads))))
1890 ;; must reverse to maintain coherence with `yas-snippet-dirs'
1892 (yas--message 3 "Loading for `%s', just-in-time: %s!" mode fun)
1894 (remhash mode yas--scheduled-jit-loads))))
1896 ;; (when (<= emacs-major-version 22)
1897 ;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
1899 (defun yas--quote-string (string)
1900 "Escape and quote STRING.
1901 foo\"bar\\! -> \"foo\\\"bar\\\\!\""
1903 (replace-regexp-in-string "[\\\"]"
1909 ;;; Snippet compilation function
1911 (defun yas-compile-directory (top-level-dir)
1912 "Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
1914 This works by stubbing a few functions, then calling
1915 `yas-load-directory'."
1916 (interactive "DTop level snippet directory?")
1917 (let ((yas--creating-compiled-snippets t))
1918 (yas-load-directory top-level-dir nil)))
1920 (defun yas-recompile-all ()
1921 "Compile every dir in `yas-snippet-dirs'."
1923 (mapc #'yas-compile-directory (yas-snippet-dirs)))
1929 (defvar yas--scheduled-jit-loads (make-hash-table)
1930 "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
1932 (defun yas--schedule-jit (mode fun)
1933 (push fun (gethash mode yas--scheduled-jit-loads)))
1937 ;;; Some user level functions
1941 (message (concat "yasnippet (version "
1943 ") -- pluskid/joaotavora/npostavs")))
1946 ;;; Apropos snippet menu:
1948 ;; The snippet menu keymaps are store by mode in hash table called
1949 ;; `yas--menu-table'. They are linked to the main menu in
1950 ;; `yas--menu-keymap-get-create' and are initially created empty,
1951 ;; reflecting the table hierarchy.
1953 ;; They can be populated in two mutually exclusive ways: (1) by
1954 ;; reading `yas--template-group', which in turn is populated by the "#
1955 ;; group:" directives of the snippets or the ".yas-make-groups" file
1956 ;; or (2) by using a separate `yas-define-menu' call, which declares a
1957 ;; menu structure based on snippets uuids.
1959 ;; Both situations are handled in `yas--update-template-menu', which
1960 ;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
1961 ;; that can tell between the two situations.
1965 ;; * if `yas-define-menu' is used it must run before
1966 ;; `yas-define-snippets' and the UUIDS must match, otherwise we get
1967 ;; duplicate entries. The `yas--template' objects are created in
1968 ;; `yas-define-menu', holding nothing but the menu entry,
1969 ;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
1970 ;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
1971 ;; part is then stored in the menu keymap itself which make the item
1972 ;; appear to the user. These limitations could probably be revised.
1974 ;; * The `yas--template-perm-group' slot is only used in
1975 ;; `yas-describe-tables'.
1977 (defun yas--template-menu-binding-pair-get-create (template &optional type)
1978 "Get TEMPLATE's menu binding or assign it a new one.
1980 TYPE may be `:stay', signaling this menu binding should be
1981 static in the menu."
1982 (or (yas--template-menu-binding-pair template)
1983 (let (;; (key (yas--template-key template))
1984 ;; (keybinding (yas--template-keybinding template))
1986 (setf (yas--template-menu-binding-pair template)
1987 (cons `(menu-item ,(or (yas--template-name template)
1988 (yas--template-uuid template))
1989 ,(yas--make-menu-binding template)
1992 (defun yas--template-menu-managed-by-yas-define-menu (template)
1993 "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
1994 (cdr (yas--template-menu-binding-pair template)))
1997 (defun yas--show-menu-p (mode)
1998 (cond ((eq yas-use-menu 'abbreviate)
2000 (mapcar #'(lambda (table)
2001 (yas--table-mode table))
2002 (yas--get-snippet-tables))))
2005 (defun yas--delete-from-keymap (keymap uuid)
2006 "Recursively delete items with UUID from KEYMAP and its submenus."
2008 ;; XXX: This used to skip any submenus named \"parent mode\"
2010 ;; First of all, recursively enter submenus, i.e. the tree is
2011 ;; searched depth first so that stale submenus can be found in the
2014 (mapc #'(lambda (item)
2015 (when (and (listp (cdr item))
2016 (keymapp (third (cdr item))))
2017 (yas--delete-from-keymap (third (cdr item)) uuid)))
2019 ;; Set the uuid entry to nil
2021 (define-key keymap (vector (make-symbol uuid)) nil)
2022 ;; Destructively modify keymap
2024 (setcdr keymap (delete-if #'(lambda (item)
2025 (or (null (cdr item))
2026 (and (keymapp (third (cdr item)))
2027 (null (cdr (third (cdr item)))))))
2030 (defun yas-define-menu (mode menu &optional omit-items)
2031 "Define a snippet menu for MODE according to MENU, omitting OMIT-ITEMS.
2033 MENU is a list, its elements can be:
2035 - (yas-item UUID) : Creates an entry the snippet identified with
2036 UUID. The menu entry for a snippet thus identified is
2037 permanent, i.e. it will never move (be reordered) in the menu.
2039 - (yas-separator) : Creates a separator
2041 - (yas-submenu NAME SUBMENU) : Creates a submenu with NAME,
2042 SUBMENU has the same form as MENU. NAME is also added to the
2043 list of groups of the snippets defined thereafter.
2045 OMIT-ITEMS is a list of snippet uuid's that will always be
2046 omitted from MODE's menu, even if they're manually loaded."
2047 (let* ((table (yas--table-get-create mode))
2048 (hash (yas--table-uuidhash table)))
2049 (yas--define-menu-1 table
2050 (yas--menu-keymap-get-create mode)
2053 (dolist (uuid omit-items)
2054 (let ((template (or (gethash uuid hash)
2056 (yas--make-template :table table
2059 (setf (yas--template-menu-binding-pair template) (cons nil :none))))))
2061 (defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
2062 "Helper for `yas-define-menu'."
2063 (dolist (e (reverse menu))
2064 (cond ((eq (first e) 'yas-item)
2065 (let ((template (or (gethash (second e) uuidhash)
2069 :perm-group group-list
2072 (define-key menu-keymap (vector (gensym))
2073 (car (yas--template-menu-binding-pair-get-create template :stay)))))
2074 ((eq (first e) 'yas-submenu)
2075 (let ((subkeymap (make-sparse-keymap)))
2076 (define-key menu-keymap (vector (gensym))
2077 `(menu-item ,(second e) ,subkeymap))
2078 (yas--define-menu-1 table
2082 (append group-list (list (second e))))))
2083 ((eq (first e) 'yas-separator)
2084 (define-key menu-keymap (vector (gensym))
2085 '(menu-item "----")))
2087 (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
2089 (defun yas--define (mode key template &optional name condition group)
2090 "Define a snippet. Expanding KEY into TEMPLATE.
2092 NAME is a description to this template. Also update the menu if
2093 `yas-use-menu' is t. CONDITION is the condition attached to
2094 this snippet. If you attach a condition to a snippet, then it
2095 will only be expanded when the condition evaluated to non-nil."
2096 (yas-define-snippets mode
2097 (list (list key template name condition group))))
2099 (defun yas-hippie-try-expand (first-time?)
2100 "Integrate with hippie expand.
2102 Just put this function in `hippie-expand-try-functions-list'."
2103 (when yas-minor-mode
2104 (if (not first-time?)
2105 (let ((yas-fallback-behavior 'return-nil))
2111 ;;; Apropos condition-cache:
2116 (defvar yas--condition-cache-timestamp nil)
2117 (defmacro yas-define-condition-cache (func doc &rest body)
2118 "Define a function FUNC with doc DOC and body BODY.
2119 BODY is executed at most once every snippet expansion attempt, to check
2120 expansion conditions.
2122 It doesn't make any sense to call FUNC programatically."
2123 `(defun ,func () ,(if (and doc
2126 "\n\nFor use in snippets' conditions. Within each
2127 snippet-expansion routine like `yas-expand', computes actual
2128 value for the first time then always returns a cached value.")
2129 (setq body (cons doc body))
2131 (let ((timestamp-and-value (get ',func 'yas--condition-cache)))
2132 (if (equal (car timestamp-and-value) yas--condition-cache-timestamp)
2133 (cdr timestamp-and-value)
2134 (let ((new-value (progn
2137 (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
2140 (defalias 'yas-expand 'yas-expand-from-trigger-key)
2141 (defun yas-expand-from-trigger-key (&optional field)
2142 "Expand a snippet before point.
2144 If no snippet expansion is possible, fall back to the behaviour
2145 defined in `yas-fallback-behavior'.
2147 Optional argument FIELD is for non-interactive use and is an
2148 object satisfying `yas--field-p' to restrict the expansion to."
2150 (setq yas--condition-cache-timestamp (current-time))
2151 (let (templates-and-pos)
2152 (unless (and yas-expand-only-for-last-commands
2153 (not (member last-command yas-expand-only-for-last-commands)))
2154 (setq templates-and-pos (if field
2156 (narrow-to-region (yas--field-start field)
2157 (yas--field-end field))
2158 (yas--templates-for-key-at-point))
2159 (yas--templates-for-key-at-point))))
2160 (if templates-and-pos
2161 (yas--expand-or-prompt-for-template (first templates-and-pos)
2162 (second templates-and-pos)
2163 (third templates-and-pos))
2166 (defun yas-expand-from-keymap ()
2167 "Directly expand some snippets, searching `yas--direct-keymaps'.
2169 If expansion fails, execute the previous binding for this key"
2171 (setq yas--condition-cache-timestamp (current-time))
2172 (let* ((vec (subseq (this-command-keys-vector) (if current-prefix-arg
2173 (length (this-command-keys))
2175 (templates (mapcan #'(lambda (table)
2176 (yas--fetch table vec))
2177 (yas--get-snippet-tables))))
2179 (yas--expand-or-prompt-for-template templates)
2180 (let ((yas-fallback-behavior 'call-other-command))
2183 (defun yas--expand-or-prompt-for-template (templates &optional start end)
2184 "Expand one of TEMPLATES from START to END.
2186 Prompt the user if TEMPLATES has more than one element, else
2187 expand immediately. Common gateway for
2188 `yas-expand-from-trigger-key' and `yas-expand-from-keymap'."
2189 (let ((yas--current-template (or (and (rest templates) ;; more than one
2190 (yas--prompt-for-template (mapcar #'cdr templates)))
2192 (when yas--current-template
2193 (yas-expand-snippet (yas--template-content yas--current-template)
2196 (yas--template-expand-env yas--current-template)))))
2198 ;; Apropos the trigger key and the fallback binding:
2200 ;; When `yas-minor-mode-map' binds <tab>, that correctly overrides
2201 ;; org-mode's <tab>, for example and searching for fallbacks correctly
2202 ;; returns `org-cycle'. However, most other modes bind "TAB". TODO,
2203 ;; improve this explanation.
2205 (defun yas--fallback ()
2206 "Fallback after expansion has failed.
2208 Common gateway for `yas-expand-from-trigger-key' and
2209 `yas-expand-from-keymap'."
2210 (cond ((eq yas-fallback-behavior 'return-nil)
2213 ((eq yas-fallback-behavior 'yas--fallback)
2214 (error (concat "yasnippet fallback loop!\n"
2215 "This can happen when you bind `yas-expand' "
2216 "outside of the `yas-minor-mode-map'.")))
2217 ((eq yas-fallback-behavior 'call-other-command)
2218 (let* ((yas-fallback-behavior 'yas--fallback)
2219 ;; Also bind `yas-minor-mode' to prevent fallback
2220 ;; loops when other extensions use mechanisms similar
2221 ;; to `yas--keybinding-beyond-yasnippet'. (github #525
2224 (yas-minor-mode nil)
2225 (beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
2226 (yas--message 4 "Falling back to %s" beyond-yasnippet)
2227 (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
2228 (setq this-command beyond-yasnippet)
2229 (when beyond-yasnippet
2230 (call-interactively beyond-yasnippet))))
2231 ((and (listp yas-fallback-behavior)
2232 (cdr yas-fallback-behavior)
2233 (eq 'apply (car yas-fallback-behavior)))
2234 (let ((command-or-fn (cadr yas-fallback-behavior))
2235 (args (cddr yas-fallback-behavior))
2236 (yas-fallback-behavior 'yas--fallback)
2237 (yas-minor-mode nil))
2239 (apply command-or-fn args)
2240 (when (commandp command-or-fn)
2241 (setq this-command command-or-fn)
2242 (call-interactively command-or-fn)))))
2244 ;; also return nil if all the other fallbacks have failed
2247 (defun yas--keybinding-beyond-yasnippet ()
2248 "Get current keys's binding as if YASsnippet didn't exist."
2249 (let* ((yas-minor-mode nil)
2250 (yas--direct-keymaps nil)
2251 (keys (this-single-command-keys)))
2252 (or (key-binding keys t)
2253 (key-binding (yas--fallback-translate-input keys) t))))
2255 (defun yas--fallback-translate-input (keys)
2256 "Emulate `read-key-sequence', at least what I think it does.
2258 Keys should be an untranslated key vector. Returns a translated
2259 vector of keys. FIXME not thoroughly tested."
2262 (while (< i (length keys))
2264 (translated local-function-key-map))
2265 (while (and (< j (length keys))
2267 (keymapp translated))
2268 (setq translated (cdr (assoc (aref keys j) (remove 'keymap translated)))
2270 (setq retval (vconcat retval (cond ((symbolp translated)
2272 ((vectorp translated)
2275 (substring keys i j)))))
2280 ;;; Utils for snippet development:
2282 (defun yas--all-templates (tables)
2283 "Get `yas--template' objects in TABLES, applicable for buffer and point.
2285 Honours `yas-choose-tables-first', `yas-choose-keys-first' and
2286 `yas-buffer-local-condition'"
2287 (when yas-choose-tables-first
2288 (setq tables (list (yas--prompt-for-table tables))))
2290 (if yas-choose-keys-first
2291 (let ((key (yas--prompt-for-keys
2292 (mapcan #'yas--table-all-keys tables))))
2294 (mapcan #'(lambda (table)
2295 (yas--fetch table key))
2297 (remove-duplicates (mapcan #'yas--table-templates tables)
2300 (defun yas--lookup-snippet-1 (name mode)
2301 "Get the snippet called NAME in MODE's tables."
2302 (let ((yas-choose-tables-first nil) ; avoid prompts
2303 (yas-choose-keys-first nil))
2304 (cl-find name (yas--all-templates
2305 (yas--get-snippet-tables mode))
2306 :key #'yas--template-name :test #'string=)))
2308 (defun yas-lookup-snippet (name &optional mode noerror)
2309 "Get the snippet content for the snippet NAME in MODE's tables.
2311 MODE defaults to the current buffer's `major-mode'. If NOERROR
2312 is non-nil, then don't signal an error if there isn't any snippet
2315 Honours `yas-buffer-local-condition'."
2316 (let ((snippet (yas--lookup-snippet-1 name mode)))
2318 (snippet (yas--template-content snippet))
2320 (t (error "No snippet named: %s" name)))))
2322 (defun yas-insert-snippet (&optional no-condition)
2323 "Choose a snippet to expand, pop-up a list of choices according
2324 to `yas-prompt-functions'.
2326 With prefix argument NO-CONDITION, bypass filtering of snippets
2329 (setq yas--condition-cache-timestamp (current-time))
2330 (let* ((yas-buffer-local-condition (or (and no-condition
2332 yas-buffer-local-condition))
2333 (templates (yas--all-templates (yas--get-snippet-tables)))
2334 (yas--current-template (and templates
2335 (or (and (rest templates) ;; more than one template for same key
2336 (yas--prompt-for-template templates))
2338 (where (if (region-active-p)
2339 (cons (region-beginning) (region-end))
2340 (cons (point) (point)))))
2341 (if yas--current-template
2342 (yas-expand-snippet (yas--template-content yas--current-template)
2345 (yas--template-expand-env yas--current-template))
2346 (yas--message 3 "No snippets can be inserted here!"))))
2348 (defun yas-visit-snippet-file ()
2349 "Choose a snippet to edit, selection like `yas-insert-snippet'.
2351 Only success if selected snippet was loaded from a file. Put the
2352 visited file in `snippet-mode'."
2354 (let* ((yas-buffer-local-condition 'always)
2355 (templates (yas--all-templates (yas--get-snippet-tables)))
2356 (template (and templates
2357 (or (yas--prompt-for-template templates
2358 "Choose a snippet template to edit: ")
2362 (yas--visit-snippet-file-1 template)
2363 (message "No snippets tables active!"))))
2365 (defun yas--visit-snippet-file-1 (template)
2366 "Helper for `yas-visit-snippet-file'."
2367 (let ((file (yas--template-get-file template)))
2368 (cond ((and file (file-readable-p file))
2369 (find-file-other-window file)
2371 (set (make-local-variable 'yas--editing-template) template))
2373 (message "Original file %s no longer exists!" file))
2375 (switch-to-buffer (format "*%s*"(yas--template-name template)))
2376 (let ((type 'snippet))
2377 (when (listp (yas--template-content template))
2378 (insert (format "# type: command\n"))
2379 (setq type 'command))
2380 (insert (format "# key: %s\n" (yas--template-key template)))
2381 (insert (format "# name: %s\n" (yas--template-name template)))
2382 (when (yas--template-keybinding template)
2383 (insert (format "# binding: %s\n" (yas--template-keybinding template))))
2384 (when (yas--template-expand-env template)
2385 (insert (format "# expand-env: %s\n" (yas--template-expand-env template))))
2386 (when (yas--template-condition template)
2387 (insert (format "# condition: %s\n" (yas--template-condition template))))
2389 (insert (if (eq type 'command)
2390 (pp-to-string (yas--template-content template))
2391 (yas--template-content template))))
2393 (set (make-local-variable 'yas--editing-template) template)))))
2395 (defun yas--guess-snippet-directories-1 (table)
2396 "Guess possible snippet subdirectories for TABLE."
2397 (cons (yas--table-name table)
2398 (mapcan #'(lambda (parent)
2399 (yas--guess-snippet-directories-1
2401 (yas--table-parents table))))
2403 (defun yas--guess-snippet-directories (&optional table)
2404 "Try to guess suitable directories based on the current active
2405 tables (or optional TABLE).
2407 Returns a list of elements (TABLE . DIRS) where TABLE is a
2408 `yas--table' object and DIRS is a list of all possible directories
2409 where snippets of table might exist."
2410 (let ((main-dir (replace-regexp-in-string
2412 (or (first (or (yas-snippet-dirs)
2413 (setq yas-snippet-dirs (list yas--default-user-snippets-dir)))))))
2414 (tables (or (and table
2416 (yas--get-snippet-tables))))
2417 ;; HACK! the snippet table created here is actually registered!
2419 (unless (or table (gethash major-mode yas--tables))
2420 (push (yas--table-get-create major-mode)
2423 (mapcar #'(lambda (table)
2425 (mapcar #'(lambda (subdir)
2426 (concat main-dir "/" subdir))
2427 (yas--guess-snippet-directories-1 table))))
2430 (defun yas--make-directory-maybe (table-and-dirs &optional main-table-string)
2431 "Return a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
2432 (or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
2433 (let ((candidate (first (cdr table-and-dirs))))
2434 (unless (file-writable-p (file-name-directory candidate))
2435 (error (yas--format "%s is not writable." candidate)))
2436 (if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
2438 (if (gethash (yas--table-mode (car table-and-dirs))
2442 (or main-table-string
2444 (yas--table-name (car table-and-dirs))))
2446 (make-directory candidate 'also-make-parents)
2447 ;; create the .yas-parents file here...
2450 (defun yas-new-snippet (&optional no-template)
2451 "Pops a new buffer for writing a snippet.
2453 Expands a snippet-writing snippet, unless the optional prefix arg
2454 NO-TEMPLATE is non-nil."
2456 (let ((guessed-directories (yas--guess-snippet-directories)))
2458 (switch-to-buffer "*new snippet*")
2460 (kill-all-local-variables)
2463 (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
2464 (yas--table-mode (car d)))
2465 guessed-directories))
2466 (if (and (not no-template) yas-new-snippet-default)
2467 (yas-expand-snippet yas-new-snippet-default))))
2469 (defun yas--compute-major-mode-and-parents (file)
2470 "Given FILE, find the nearest snippet directory for a given mode.
2472 Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
2473 representing one or more of the mode's parents.
2475 Note that MODE-SYM need not be the symbol of a real major mode,
2476 neither do the elements of PARENTS."
2477 (let* ((file-dir (and file
2478 (directory-file-name (or (some #'(lambda (special)
2479 (locate-dominating-file file special))
2483 (directory-file-name (file-name-directory file))))))
2484 (parents-file-name (concat file-dir "/.yas-parents"))
2485 (major-mode-name (and file-dir
2486 (file-name-nondirectory file-dir)))
2487 (major-mode-sym (or (and major-mode-name
2488 (intern major-mode-name))))
2489 (parents (when (file-readable-p parents-file-name)
2493 (insert-file-contents parents-file-name)
2494 (buffer-substring-no-properties (point-min)
2496 (when major-mode-sym
2497 (cons major-mode-sym (remove major-mode-sym parents)))))
2499 (defvar yas--editing-template nil
2500 "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
2502 (defvar yas--current-template nil
2503 "Holds the current template being expanded into a snippet.")
2505 (defvar yas--guessed-modes nil
2506 "List of guessed modes supporting `yas-load-snippet-buffer'.")
2508 (defun yas--read-table ()
2509 "Ask user for a snippet table, help with some guessing."
2510 (let ((prompt (if (and (featurep 'ido)
2512 'ido-completing-read 'completing-read)))
2513 (unless yas--guessed-modes
2514 (set (make-local-variable 'yas--guessed-modes)
2515 (or (yas--compute-major-mode-and-parents buffer-file-name))))
2517 (funcall prompt (format "Choose or enter a table (yas guesses %s): "
2518 (if yas--guessed-modes
2519 (first yas--guessed-modes)
2521 (mapcar #'symbol-name yas--guessed-modes)
2526 (if (first yas--guessed-modes)
2527 (symbol-name (first yas--guessed-modes)))))))
2529 (defun yas-load-snippet-buffer (table &optional interactive)
2530 "Parse and load current buffer's snippet definition into TABLE.
2532 TABLE is a symbol naming a passed to `yas--table-get-create'.
2534 When called interactively, prompt for the table name."
2535 (interactive (list (yas--read-table) t))
2537 ;; We have `yas--editing-template', this buffer's content comes from a
2538 ;; template which is already loaded and neatly positioned,...
2540 (yas--editing-template
2541 (yas--define-snippets-1 (yas--parse-template (yas--template-load-file yas--editing-template))
2542 (yas--template-table yas--editing-template)))
2543 ;; Try to use `yas--guessed-modes'. If we don't have that use the
2544 ;; value from `yas--compute-major-mode-and-parents'
2547 (unless yas--guessed-modes
2548 (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
2549 (let* ((table (yas--table-get-create table)))
2550 (set (make-local-variable 'yas--editing-template)
2551 (yas--define-snippets-1 (yas--parse-template buffer-file-name)
2554 (yas--message 3 "Snippet \"%s\" loaded for %s."
2555 (yas--template-name yas--editing-template)
2556 (yas--table-name (yas--template-table yas--editing-template)))))
2558 (defun yas-load-snippet-buffer-and-close (table &optional kill)
2559 "Load the snippet with `yas-load-snippet-buffer', possibly
2560 save, then `quit-window' if saved.
2562 If the snippet is new, ask the user whether (and where) to save
2563 it. If the snippet already has a file, just save it.
2565 The prefix argument KILL is passed to `quit-window'.
2567 Don't use this from a Lisp program, call `yas-load-snippet-buffer'
2568 and `kill-buffer' instead."
2569 (interactive (list (yas--read-table) current-prefix-arg))
2570 (yas-load-snippet-buffer table t)
2571 (let ((file (yas--template-get-file yas--editing-template)))
2573 ;; Only offer to save this if it looks like a library or new
2574 ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
2575 ;; which is not the first, or from an unwritable file)
2578 (not (file-writable-p file))
2579 (and (cdr-safe yas-snippet-dirs)
2580 (not (string-prefix-p (expand-file-name (car yas-snippet-dirs)) file))))
2581 (y-or-n-p (yas--format "Looks like a library or new snippet. Save to new file? ")))
2582 (let* ((option (first (yas--guess-snippet-directories (yas--template-table yas--editing-template))))
2584 (yas--make-directory-maybe option))))
2586 (let ((default-file-name (or (and file (file-name-nondirectory file))
2587 (yas--template-name yas--editing-template))))
2588 (write-file (concat chosen "/"
2589 (read-from-minibuffer (format "File name to create in %s? " chosen)
2590 default-file-name)))
2591 (setf (yas--template-load-file yas--editing-template) buffer-file-name))))))
2592 (when buffer-file-name
2594 (quit-window kill)))
2596 (defun yas-tryout-snippet (&optional debug)
2597 "Test current buffer's snippet template in other buffer."
2599 (let* ((major-mode-and-parent (yas--compute-major-mode-and-parents buffer-file-name))
2600 (parsed (yas--parse-template))
2601 (test-mode (or (and (car major-mode-and-parent)
2602 (fboundp (car major-mode-and-parent))
2603 (car major-mode-and-parent))
2604 (first yas--guessed-modes)
2605 (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
2606 (yas--current-template
2609 (yas--make-template :table nil ;; no tables for ephemeral snippets
2611 :content (second parsed)
2612 :name (third parsed)
2613 :expand-env (sixth parsed)))))
2614 (cond (yas--current-template
2615 (let ((buffer-name (format "*testing snippet: %s*" (yas--template-name yas--current-template))))
2616 (kill-buffer (get-buffer-create buffer-name))
2617 (switch-to-buffer (get-buffer-create buffer-name))
2618 (setq buffer-undo-list nil)
2619 (condition-case nil (funcall test-mode) (error nil))
2621 (setq buffer-read-only nil)
2622 (yas-expand-snippet (yas--template-content yas--current-template)
2625 (yas--template-expand-env yas--current-template))
2627 (require 'yasnippet-debug nil t))
2628 (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
2630 (yas--message 3 "Cannot test snippet for unknown major mode")))))
2632 (defun yas-active-keys ()
2633 "Return all active trigger keys for current buffer and point."
2635 (remove-if-not #'stringp (mapcan #'yas--table-all-keys (yas--get-snippet-tables)))
2638 (defun yas--template-fine-group (template)
2639 (car (last (or (yas--template-group template)
2640 (yas--template-perm-group template)))))
2642 (defun yas-describe-tables (&optional choose)
2643 "Display snippets for each table."
2645 (let* ((by-name-hash (and choose
2646 (y-or-n-p "Show by namehash? ")))
2647 (buffer (get-buffer-create "*YASnippet tables*"))
2648 (active-tables (yas--get-snippet-tables))
2649 (remain-tables (let ((all))
2650 (maphash #'(lambda (_k v)
2651 (unless (find v active-tables)
2655 (table-lists (list active-tables remain-tables))
2656 (original-buffer (current-buffer))
2658 (yas--condition-cache-timestamp (current-time)))
2659 (with-current-buffer buffer
2660 (setq buffer-read-only nil)
2662 (cond ((not by-name-hash)
2663 (insert "YASnippet tables: \n")
2664 (while (and table-lists
2666 (dolist (table (car table-lists))
2667 (yas--describe-pretty-table table original-buffer))
2668 (setq table-lists (cdr table-lists))
2670 (yas--create-snippet-xrefs)
2671 (display-buffer buffer)
2672 (setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
2673 (yas--create-snippet-xrefs)
2677 (insert "\n\nYASnippet tables by NAMEHASH: \n")
2678 (dolist (table (append active-tables remain-tables))
2679 (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
2681 (maphash #'(lambda (k _v)
2683 (yas--table-hash table))
2685 (insert (format " key %s maps snippets: %s\n" key
2687 (maphash #'(lambda (k _v)
2689 (gethash key (yas--table-hash table)))
2692 (setq buffer-read-only t))
2693 (display-buffer buffer)))
2695 (defun yas--describe-pretty-table (table &optional original-buffer)
2696 (insert (format "\nSnippet table `%s'"
2697 (yas--table-name table)))
2698 (if (yas--table-parents table)
2699 (insert (format " parents: %s\n"
2700 (mapcar #'yas--table-name
2701 (yas--table-parents table))))
2703 (insert (make-string 100 ?-) "\n")
2704 (insert "group state name key binding\n")
2705 (let ((groups-hash (make-hash-table :test #'equal)))
2706 (maphash #'(lambda (_k v)
2707 (let ((group (or (yas--template-fine-group v)
2709 (when (yas--template-name v)
2711 (cons v (gethash group groups-hash))
2713 (yas--table-uuidhash table))
2715 #'(lambda (group templates)
2716 (setq group (truncate-string-to-width group 25 0 ? "..."))
2717 (insert (make-string 100 ?-) "\n")
2718 (dolist (p templates)
2719 (let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas--template-name p))
2723 (setq group (make-string (length group) ? ))))
2724 (condition-string (let ((condition (yas--template-condition p)))
2727 (with-current-buffer original-buffer
2728 (if (yas--eval-condition condition)
2733 (insert condition-string " ")
2735 (if (string-match "\\.\\.\\.$" name)
2739 (insert (truncate-string-to-width (or (yas--template-key p) "")
2741 (insert (truncate-string-to-width (key-description (yas--template-keybinding p))
2748 ;;; User convenience functions, for using in `yas-key-syntaxes'
2750 (defun yas-try-key-from-whitespace (_start-point)
2751 "As `yas-key-syntaxes' element, look for whitespace delimited key.
2753 A newline will be considered whitespace even if the mode syntax
2754 marks it as something else (typically comment ender)."
2755 (skip-chars-backward "^[:space:]\n"))
2757 (defun yas-shortest-key-until-whitespace (_start-point)
2758 "Like `yas-longest-key-from-whitespace' but take the shortest key."
2759 (when (/= (skip-chars-backward "^[:space:]\n" (1- (point))) 0)
2762 (defun yas-longest-key-from-whitespace (start-point)
2763 "As `yas-key-syntaxes' element, look for longest key between point and whitespace.
2765 A newline will be considered whitespace even if the mode syntax
2766 marks it as something else (typically comment ender)."
2767 (if (= (point) start-point)
2768 (yas-try-key-from-whitespace start-point)
2770 (unless (<= start-point (1+ (point)))
2775 ;;; User convenience functions, for using in snippet definitions
2777 (defvar yas-modified-p nil
2778 "Non-nil if field has been modified by user or transformation.")
2780 (defvar yas-moving-away-p nil
2781 "Non-nil if user is about to exit field.")
2783 (defvar yas-text nil
2784 "Contains current field text.")
2786 (defun yas-substr (str pattern &optional subexp)
2787 "Search PATTERN in STR and return SUBEXPth match.
2789 If found, the content of subexp group SUBEXP (default 0) is
2790 returned, or else the original STR will be returned."
2791 (let ((grp (or subexp 0)))
2793 (if (string-match pattern str)
2794 (match-string-no-properties grp str)
2797 (defun yas-choose-value (&rest possibilities)
2798 "Prompt for a string in POSSIBILITIES and return it.
2800 The last element of POSSIBILITIES may be a list of strings."
2801 (unless (or yas-moving-away-p
2803 (let* ((last-link (last possibilities))
2804 (last-elem (car last-link)))
2805 (when (listp last-elem)
2806 (setcar last-link (car last-elem))
2807 (setcdr last-link (cdr last-elem))))
2808 (some #'(lambda (fn)
2809 (funcall fn "Choose: " possibilities))
2810 yas-prompt-functions)))
2812 (defun yas-key-to-value (alist)
2813 (unless (or yas-moving-away-p
2815 (let ((key (read-key-sequence "")))
2817 (or (cdr (find key alist :key #'car :test #'string=))
2820 (defun yas-throw (text)
2821 "Throw a yas--exception with TEXT as the reason."
2822 (throw 'yas--exception (cons 'yas--exception text)))
2824 (defun yas-verify-value (possibilities)
2825 "Verify that the current field value is in POSSIBILITIES.
2827 Otherwise throw exception."
2828 (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
2829 (yas-throw (yas--format "Field only allows %s" possibilities))))
2831 (defun yas-field-value (number)
2832 "Get the string for field with NUMBER.
2834 Use this in primary and mirror transformations to tget."
2835 (let* ((snippet (car (yas--snippets-at-point)))
2837 (yas--snippet-find-field snippet number))))
2839 (yas--field-text-for-display field))))
2842 "Return `yas-text' if that exists and is non-empty, else nil."
2844 (not (string= "" yas-text)))
2847 (defun yas-selected-text ()
2848 "Return `yas-selected-text' if that exists and is non-empty, else nil."
2849 (if (and yas-selected-text
2850 (not (string= "" yas-selected-text)))
2853 (defun yas--get-field-once (number &optional transform-fn)
2854 (unless yas-modified-p
2856 (funcall transform-fn (yas-field-value number))
2857 (yas-field-value number))))
2859 (defun yas-default-from-field (number)
2860 (unless yas-modified-p
2861 (yas-field-value number)))
2863 (defun yas-inside-string ()
2864 "Return non-nil if the point is inside a string according to font-lock."
2865 (equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
2867 (defun yas-unimplemented (&optional missing-feature)
2868 (if yas--current-template
2869 (if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
2872 (yas--visit-snippet-file-1 yas--current-template))
2873 (message "No implementation. Missing %s" (or missing-feature "something"))))
2876 ;;; Snippet expansion and field management
2878 (defvar yas--active-field-overlay nil
2879 "Overlays the currently active field.")
2881 (defvar yas--field-protection-overlays nil
2882 "Two overlays protect the current active field.")
2884 (defvar yas-selected-text nil
2885 "The selected region deleted on the last snippet expansion.")
2887 (defvar yas--start-column nil
2888 "The column where the snippet expansion started.")
2890 (make-variable-buffer-local 'yas--active-field-overlay)
2891 (make-variable-buffer-local 'yas--field-protection-overlays)
2892 (put 'yas--active-field-overlay 'permanent-local t)
2893 (put 'yas--field-protection-overlays 'permanent-local t)
2895 (defstruct (yas--snippet (:constructor yas--make-snippet ()))
2901 (id (yas--snippet-next-id) :read-only t)
2902 (control-overlay nil)
2904 ;; stacked expansion: the `previous-active-field' slot saves the
2905 ;; active field where the child expansion took place
2906 previous-active-field
2909 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
2912 NUMBER is the field number.
2913 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2914 PARENT-FIELD is a `yas--field' this field is nested under, or nil.
2915 MIRRORS is a list of `yas--mirror's
2916 TRANSFORM is a lisp form.
2917 MODIFIED-P is a boolean set to true once user inputs text.
2918 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'.
2929 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
2932 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2933 TRANSFORM is a lisp form.
2934 PARENT-FIELD is a `yas--field' this mirror is nested under, or nil.
2935 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'
2936 DEPTH is a count of how many nested mirrors can affect this mirror"
2943 (defstruct (yas--exit (:constructor yas--make-exit (marker)))
2947 (defun yas--apply-transform (field-or-mirror field &optional empty-on-nil-p)
2948 "Calculate transformed string for FIELD-OR-MIRROR from FIELD.
2950 If there is no transform for ht field, return nil.
2952 If there is a transform but it returns nil, return the empty
2953 string iff EMPTY-ON-NIL-P is true."
2954 (let* ((yas-text (yas--field-text-for-display field))
2955 (yas-modified-p (yas--field-modified-p field))
2956 (yas-moving-away-p nil)
2957 (transform (if (yas--mirror-p field-or-mirror)
2958 (yas--mirror-transform field-or-mirror)
2959 (yas--field-transform field-or-mirror)))
2960 (start-point (if (yas--mirror-p field-or-mirror)
2961 (yas--mirror-start field-or-mirror)
2962 (yas--field-start field-or-mirror)))
2963 (transformed (and transform
2965 (goto-char start-point)
2966 (let ((ret (yas--eval-lisp transform)))
2967 (or ret (and empty-on-nil-p "")))))))
2970 (defsubst yas--replace-all (from to &optional text)
2971 "Replace all occurrences from FROM to TO.
2973 With optional string TEXT do it in that string."
2975 (replace-regexp-in-string (regexp-quote from) to text t t)
2976 (goto-char (point-min))
2977 (while (search-forward from nil t)
2978 (replace-match to t t text))))
2980 (defun yas--snippet-find-field (snippet number)
2981 (find-if #'(lambda (field)
2982 (eq number (yas--field-number field)))
2983 (yas--snippet-fields snippet)))
2985 (defun yas--snippet-sort-fields (snippet)
2986 "Sort the fields of SNIPPET in navigation order."
2987 (setf (yas--snippet-fields snippet)
2988 (sort (yas--snippet-fields snippet)
2989 #'yas--snippet-field-compare)))
2991 (defun yas--snippet-field-compare (field1 field2)
2992 "Compare FIELD1 and FIELD2.
2994 The field with a number is sorted first. If they both have a
2995 number, compare through the number. If neither have, compare
2996 through the field's start point"
2997 (let ((n1 (yas--field-number field1))
2998 (n2 (yas--field-number field2)))
3001 (or (zerop n2) (and (not (zerop n1))
3006 (< (yas--field-start field1)
3007 (yas--field-start field2))))))
3009 (defun yas--field-probably-deleted-p (snippet field)
3010 "Guess if SNIPPET's FIELD should be skipped."
3012 ;; field must be zero length
3014 (zerop (- (yas--field-start field) (yas--field-end field)))
3015 ;; field must have been modified
3017 (yas--field-modified-p field)
3020 ;; 1) it's a nested field
3022 (yas--field-parent-field field)
3023 ;; 2) ends just before the snippet end
3025 (and (eq field (car (last (yas--snippet-fields snippet))))
3026 (= (yas--field-start field) (overlay-end (yas--snippet-control-overlay snippet)))))
3027 ;; the field numbered 0, just before the exit marker, should
3030 (not (and (yas--field-number field)
3031 (zerop (yas--field-number field))))))
3033 (defun yas--snippets-at-point (&optional all-snippets)
3034 "Return a sorted list of snippets at point.
3036 The most recently-inserted snippets are returned first."
3038 (delq nil (delete-dups
3039 (mapcar (lambda (ov) (overlay-get ov 'yas--snippet))
3040 (if all-snippets (overlays-in (point-min) (point-max))
3041 (nconc (overlays-at (point))
3042 (overlays-at (1- (point))))))))
3044 (<= (yas--snippet-id s2) (yas--snippet-id s1)))))
3046 (defun yas-next-field-or-maybe-expand ()
3047 "Try to expand a snippet at a key before point.
3049 Otherwise delegate to `yas-next-field'."
3051 (if yas-triggers-in-field
3052 (let ((yas-fallback-behavior 'return-nil)
3053 (active-field (overlay-get yas--active-field-overlay 'yas--field)))
3055 (unless (yas-expand-from-trigger-key active-field)
3059 (defun yas-next-field (&optional arg)
3060 "Navigate to the ARGth next field.
3062 If there's none, exit the snippet."
3066 (snippet (first (yas--snippets-at-point)))
3067 (active-field (overlay-get yas--active-field-overlay 'yas--field))
3068 (live-fields (remove-if #'(lambda (field)
3069 (and (not (eq field active-field))
3070 (yas--field-probably-deleted-p snippet field)))
3071 (yas--snippet-fields snippet)))
3072 (active-field-pos (position active-field live-fields))
3073 (target-pos (and active-field-pos (+ arg active-field-pos)))
3074 (target-field (and target-pos (nth target-pos live-fields))))
3075 ;; First check if we're moving out of a field with a transform
3077 (when (and active-field
3078 (yas--field-transform active-field))
3079 (let* ((yas-moving-away-p t)
3080 (yas-text (yas--field-text-for-display active-field))
3081 (yas-modified-p (yas--field-modified-p active-field)))
3082 ;; primary field transform: exit call to field-transform
3083 (yas--eval-lisp (yas--field-transform active-field))))
3084 ;; Now actually move...
3085 (cond ((and target-pos (>= target-pos (length live-fields)))
3086 (yas-exit-snippet snippet))
3088 (yas--move-to-field snippet target-field))
3092 (defun yas--place-overlays (snippet field)
3093 "Correctly place overlays for SNIPPET's FIELD."
3094 (yas--make-move-field-protection-overlays snippet field)
3095 (yas--make-move-active-field-overlay snippet field))
3097 (defun yas--move-to-field (snippet field)
3098 "Update SNIPPET to move to field FIELD.
3100 Also create some protection overlays"
3101 (goto-char (yas--field-start field))
3102 (yas--place-overlays snippet field)
3103 (overlay-put yas--active-field-overlay 'yas--field field)
3104 (let ((number (yas--field-number field)))
3105 ;; check for the special ${0: ...} field
3106 (if (and number (zerop number))
3108 (set-mark (yas--field-end field))
3109 (setf (yas--snippet-force-exit snippet)
3110 (or (yas--field-transform field)
3112 ;; make this field active
3113 (setf (yas--snippet-active-field snippet) field)
3114 ;; primary field transform: first call to snippet transform
3115 (unless (yas--field-modified-p field)
3116 (if (yas--field-update-display field)
3117 (yas--update-mirrors snippet)
3118 (setf (yas--field-modified-p field) nil))))))
3120 (defun yas-prev-field ()
3121 "Navigate to prev field. If there's none, exit the snippet."
3123 (yas-next-field -1))
3125 (defun yas-abort-snippet (&optional snippet)
3127 (let ((snippet (or snippet
3128 (car (yas--snippets-at-point)))))
3130 (setf (yas--snippet-force-exit snippet) t))))
3132 (defun yas-exit-snippet (snippet)
3133 "Goto exit-marker of SNIPPET."
3134 (interactive (list (first (yas--snippets-at-point))))
3136 (setf (yas--snippet-force-exit snippet) t)
3137 (goto-char (if (yas--snippet-exit snippet)
3138 (yas--exit-marker (yas--snippet-exit snippet))
3139 (overlay-end (yas--snippet-control-overlay snippet))))))
3141 (defun yas-exit-all-snippets ()
3142 "Exit all snippets."
3144 (mapc #'(lambda (snippet)
3145 (yas-exit-snippet snippet)
3146 (yas--check-commit-snippet))
3147 (yas--snippets-at-point 'all-snippets)))
3150 ;;; Some low level snippet-routines:
3152 (defvar yas--inhibit-overlay-hooks nil
3153 "Bind this temporarily to non-nil to prevent running `yas--on-*-modification'.")
3155 (defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
3156 (defvar yas-snippet-end nil "End position of the last snippet committed.")
3158 (defun yas--commit-snippet (snippet)
3159 "Commit SNIPPET, but leave point as it is.
3161 This renders the snippet as ordinary text."
3163 (let ((control-overlay (yas--snippet-control-overlay snippet)))
3165 ;; Save the end of the moribund snippet in case we need to revive it
3166 ;; its original expansion.
3168 (when (and control-overlay
3169 (overlay-buffer control-overlay))
3170 (setq yas-snippet-beg (overlay-start control-overlay))
3171 (setq yas-snippet-end (overlay-end control-overlay))
3172 (delete-overlay control-overlay))
3174 (let ((yas--inhibit-overlay-hooks t))
3175 (when yas--active-field-overlay
3176 (delete-overlay yas--active-field-overlay))
3177 (when yas--field-protection-overlays
3178 (mapc #'delete-overlay yas--field-protection-overlays)))
3180 ;; stacked expansion: if the original expansion took place from a
3181 ;; field, make sure we advance it here at least to
3182 ;; `yas-snippet-end'...
3184 (let ((previous-field (yas--snippet-previous-active-field snippet)))
3185 (when (and yas-snippet-end previous-field)
3186 (yas--advance-end-maybe previous-field yas-snippet-end)))
3188 ;; Convert all markers to points,
3190 (yas--markers-to-points snippet)
3192 ;; Take care of snippet revival
3194 (if yas-snippet-revival
3195 (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
3197 ;; Dismember the snippet... this is useful if we get called
3198 ;; again from `yas--take-care-of-redo'....
3199 (setf (yas--snippet-fields snippet) nil)))
3201 (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
3203 (defun yas--safely-run-hooks (hook-var)
3204 (condition-case error
3205 (run-hooks hook-var)
3207 (yas--message 3 "%s error: %s" hook-var (error-message-string error)))))
3210 (defun yas--check-commit-snippet ()
3211 "Check if point exited the currently active field of the snippet.
3213 If so cleans up the whole snippet up."
3214 (let* ((snippets (yas--snippets-at-point 'all-snippets))
3215 (snippets-left snippets)
3216 (snippet-exit-transform))
3217 (dolist (snippet snippets)
3218 (let ((active-field (yas--snippet-active-field snippet)))
3219 (setq snippet-exit-transform (yas--snippet-force-exit snippet))
3220 (cond ((or snippet-exit-transform
3221 (not (and active-field (yas--field-contains-point-p active-field))))
3222 (setq snippets-left (delete snippet snippets-left))
3223 (setf (yas--snippet-force-exit snippet) nil)
3224 (yas--commit-snippet snippet))
3226 (or (not yas--active-field-overlay)
3227 (not (overlay-buffer yas--active-field-overlay))))
3229 ;; stacked expansion: this case is mainly for recent
3230 ;; snippet exits that place us back int the field of
3234 (yas--move-to-field snippet active-field)
3235 (yas--update-mirrors snippet)))
3238 (unless (or (null snippets) snippets-left)
3239 (if snippet-exit-transform
3240 (yas--eval-lisp-no-saves snippet-exit-transform))
3241 (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
3243 ;; Apropos markers-to-points:
3245 ;; This was found useful for performance reasons, so that an
3246 ;; excessive number of live markers aren't kept around in the
3247 ;; `buffer-undo-list'. However, in `markers-to-points', the
3248 ;; set-to-nil markers can't simply be discarded and replaced with
3249 ;; fresh ones in `points-to-markers'. The original marker that was
3250 ;; just set to nil has to be reused.
3252 ;; This shouldn't bring horrible problems with undo/redo, but it
3255 (defun yas--markers-to-points (snippet)
3256 "Convert all markers in SNIPPET to a cons (POINT . MARKER)
3257 where POINT is the original position of the marker and MARKER is
3258 the original marker object with the position set to nil."
3259 (dolist (field (yas--snippet-fields snippet))
3260 (let ((start (marker-position (yas--field-start field)))
3261 (end (marker-position (yas--field-end field))))
3262 (set-marker (yas--field-start field) nil)
3263 (set-marker (yas--field-end field) nil)
3264 (setf (yas--field-start field) (cons start (yas--field-start field)))
3265 (setf (yas--field-end field) (cons end (yas--field-end field))))
3266 (dolist (mirror (yas--field-mirrors field))
3267 (let ((start (marker-position (yas--mirror-start mirror)))
3268 (end (marker-position (yas--mirror-end mirror))))
3269 (set-marker (yas--mirror-start mirror) nil)
3270 (set-marker (yas--mirror-end mirror) nil)
3271 (setf (yas--mirror-start mirror) (cons start (yas--mirror-start mirror)))
3272 (setf (yas--mirror-end mirror) (cons end (yas--mirror-end mirror))))))
3273 (let ((snippet-exit (yas--snippet-exit snippet)))
3275 (let ((exit (marker-position (yas--exit-marker snippet-exit))))
3276 (set-marker (yas--exit-marker snippet-exit) nil)
3277 (setf (yas--exit-marker snippet-exit) (cons exit (yas--exit-marker snippet-exit)))))))
3279 (defun yas--points-to-markers (snippet)
3280 "Convert all cons (POINT . MARKER) in SNIPPET to markers.
3282 This is done by setting MARKER to POINT with `set-marker'."
3283 (dolist (field (yas--snippet-fields snippet))
3284 (setf (yas--field-start field) (set-marker (cdr (yas--field-start field))
3285 (car (yas--field-start field))))
3286 (setf (yas--field-end field) (set-marker (cdr (yas--field-end field))
3287 (car (yas--field-end field))))
3288 (dolist (mirror (yas--field-mirrors field))
3289 (setf (yas--mirror-start mirror) (set-marker (cdr (yas--mirror-start mirror))
3290 (car (yas--mirror-start mirror))))
3291 (setf (yas--mirror-end mirror) (set-marker (cdr (yas--mirror-end mirror))
3292 (car (yas--mirror-end mirror))))))
3293 (let ((snippet-exit (yas--snippet-exit snippet)))
3295 (setf (yas--exit-marker snippet-exit) (set-marker (cdr (yas--exit-marker snippet-exit))
3296 (car (yas--exit-marker snippet-exit)))))))
3298 (defun yas--field-contains-point-p (field &optional point)
3299 (let ((point (or point
3301 (and (>= point (yas--field-start field))
3302 (<= point (yas--field-end field)))))
3304 (defun yas--field-text-for-display (field)
3305 "Return the propertized display text for field FIELD."
3306 (buffer-substring (yas--field-start field) (yas--field-end field)))
3308 (defun yas--undo-in-progress ()
3309 "True if some kind of undo is in progress."
3310 (or undo-in-progress
3311 (eq this-command 'undo)
3312 (eq this-command 'redo)))
3314 (defun yas--make-control-overlay (snippet start end)
3315 "Create the control overlay that surrounds the snippet and
3317 (let ((overlay (make-overlay start
3322 (overlay-put overlay 'keymap yas-keymap)
3323 (overlay-put overlay 'priority 100)
3324 (overlay-put overlay 'yas--snippet snippet)
3327 (defun yas-skip-and-clear-or-delete-char (&optional field)
3328 "Clears unmodified field if at field start, skips to next tab.
3330 Otherwise deletes a character normally by calling `delete-char'."
3332 (let ((field (or field
3333 (and yas--active-field-overlay
3334 (overlay-buffer yas--active-field-overlay)
3335 (overlay-get yas--active-field-overlay 'yas--field)))))
3337 (not (yas--field-modified-p field))
3338 (eq (point) (marker-position (yas--field-start field))))
3339 (yas--skip-and-clear field)
3342 (call-interactively 'delete-char)))))
3344 (defun yas--skip-and-clear (field)
3345 "Deletes the region of FIELD and sets it's modified state to t."
3346 ;; Just before skipping-and-clearing the field, mark its children
3347 ;; fields as modified, too. If the children have mirrors-in-fields
3348 ;; this prevents them from updating erroneously (we're skipping and
3351 (yas--mark-this-and-children-modified field)
3352 (delete-region (yas--field-start field) (yas--field-end field)))
3354 (defun yas--mark-this-and-children-modified (field)
3355 (setf (yas--field-modified-p field) t)
3356 (let ((fom (yas--field-next field)))
3358 (yas--fom-parent-field fom))
3359 (when (and (eq (yas--fom-parent-field fom) field)
3361 (yas--mark-this-and-children-modified fom))
3362 (setq fom (yas--fom-next fom)))))
3364 (defun yas--make-move-active-field-overlay (snippet field)
3365 "Place the active field overlay in SNIPPET's FIELD.
3367 Move the overlay, or create it if it does not exit."
3368 (if (and yas--active-field-overlay
3369 (overlay-buffer yas--active-field-overlay))
3370 (move-overlay yas--active-field-overlay
3371 (yas--field-start field)
3372 (yas--field-end field))
3373 (setq yas--active-field-overlay
3374 (make-overlay (yas--field-start field)
3375 (yas--field-end field)
3377 (overlay-put yas--active-field-overlay 'priority 100)
3378 (overlay-put yas--active-field-overlay 'face 'yas-field-highlight-face)
3379 (overlay-put yas--active-field-overlay 'yas--snippet snippet)
3380 (overlay-put yas--active-field-overlay 'modification-hooks '(yas--on-field-overlay-modification))
3381 (overlay-put yas--active-field-overlay 'insert-in-front-hooks
3382 '(yas--on-field-overlay-modification))
3383 (overlay-put yas--active-field-overlay 'insert-behind-hooks
3384 '(yas--on-field-overlay-modification))))
3386 (defun yas--skip-and-clear-field-p (field _beg _end &optional _length)
3387 "Tell if newly modified FIELD should be cleared and skipped.
3388 BEG, END and LENGTH like overlay modification hooks."
3389 (and (not (yas--field-modified-p field))
3390 (= (point) (yas--field-start field))
3392 ;; `yank' sets `this-command' to t during execution.
3393 (let* ((command (if (commandp this-command) this-command
3394 this-original-command))
3395 (clearp (if (symbolp command) (get command 'delete-selection))))
3396 (when (and (not (memq clearp '(yank supersede kill)))
3398 (setq clearp (funcall clearp)))
3401 (defun yas--on-field-overlay-modification (overlay after? beg end &optional length)
3402 "Clears the field and updates mirrors, conditionally.
3404 Only clears the field if it hasn't been modified and point is at
3405 field start. This hook does nothing if an undo is in progress."
3406 (unless (or yas--inhibit-overlay-hooks
3407 (not (overlayp yas--active-field-overlay)) ; Avoid Emacs bug #21824.
3408 (yas--undo-in-progress))
3409 (let* ((field (overlay-get overlay 'yas--field))
3410 (snippet (overlay-get yas--active-field-overlay 'yas--snippet)))
3412 (yas--advance-end-maybe field (overlay-end overlay))
3414 (yas--field-update-display field))
3415 (yas--update-mirrors snippet))
3417 (when (yas--skip-and-clear-field-p field beg end)
3418 (yas--skip-and-clear field))
3419 (setf (yas--field-modified-p field) t))))))
3421 ;;; Apropos protection overlays:
3423 ;; These exist for nasty users who will try to delete parts of the
3424 ;; snippet outside the active field. Actual protection happens in
3425 ;; `yas--on-protection-overlay-modification'.
3427 ;; As of github #537 this no longer inhibits the command by issuing an
3428 ;; error: all the snippets at point, including nested snippets, are
3429 ;; automatically commited and the current command can proceed.
3431 (defun yas--make-move-field-protection-overlays (snippet field)
3432 "Place protection overlays surrounding SNIPPET's FIELD.
3434 Move the overlays, or create them if they do not exit."
3435 (let ((start (yas--field-start field))
3436 (end (yas--field-end field)))
3437 ;; First check if the (1+ end) is contained in the buffer,
3438 ;; otherwise we'll have to do a bit of cheating and silently
3439 ;; insert a newline. the `(1+ (buffer-size))' should prevent this
3440 ;; when using stacked expansion
3442 (when (< (buffer-size) end)
3444 (let ((yas--inhibit-overlay-hooks t))
3445 (goto-char (point-max))
3447 ;; go on to normal overlay creation/moving
3449 (cond ((and yas--field-protection-overlays
3450 (every #'overlay-buffer yas--field-protection-overlays))
3451 (move-overlay (first yas--field-protection-overlays) (1- start) start)
3452 (move-overlay (second yas--field-protection-overlays) end (1+ end)))
3454 (setq yas--field-protection-overlays
3455 (list (make-overlay (1- start) start nil t nil)
3456 (make-overlay end (1+ end) nil t nil)))
3457 (dolist (ov yas--field-protection-overlays)
3458 (overlay-put ov 'face 'yas--field-debug-face)
3459 (overlay-put ov 'yas--snippet snippet)
3460 ;; (overlay-put ov 'evaporate t)
3461 (overlay-put ov 'modification-hooks '(yas--on-protection-overlay-modification)))))))
3463 (defun yas--on-protection-overlay-modification (_overlay after? _beg _end &optional _length)
3464 "Signals a snippet violation, then issues error.
3466 The error should be ignored in `debug-ignored-errors'"
3467 (unless (or yas--inhibit-overlay-hooks
3469 (yas--undo-in-progress))
3470 (let ((snippets (yas--snippets-at-point)))
3471 (yas--message 3 "Comitting snippets. Action would destroy a protection overlay.")
3472 (cl-loop for snippet in snippets
3473 do (yas--commit-snippet snippet)))))
3475 (add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
3478 ;;; Snippet expansion and "stacked" expansion:
3480 ;; Stacked expansion is when you try to expand a snippet when already
3481 ;; inside a snippet expansion.
3483 ;; The parent snippet does not run its fields modification hooks
3484 ;; (`yas--on-field-overlay-modification' and
3485 ;; `yas--on-protection-overlay-modification') while the child snippet
3486 ;; is active. This means, among other things, that the mirrors of the
3487 ;; parent snippet are not updated, this only happening when one exits
3488 ;; the child snippet.
3490 ;; Unfortunately, this also puts some ugly (and not fully-tested)
3491 ;; bits of code in `yas-expand-snippet' and
3492 ;; `yas--commit-snippet'. I've tried to mark them with "stacked
3495 ;; This was thought to be safer in an undo/redo perspective, but
3496 ;; maybe the correct implementation is to make the globals
3497 ;; `yas--active-field-overlay' and `yas--field-protection-overlays' be
3498 ;; snippet-local and be active even while the child snippet is
3499 ;; running. This would mean a lot of overlay modification hooks
3500 ;; running, but if managed correctly (including overlay priorities)
3501 ;; they should account for all situations...
3503 (defun yas-expand-snippet (content &optional start end expand-env)
3504 "Expand snippet CONTENT at current point.
3506 Text between START and END will be deleted before inserting
3507 template. EXPAND-ENV is a list of (SYM VALUE) let-style dynamic bindings
3508 considered when expanding the snippet."
3509 (cl-assert (and yas-minor-mode
3510 (memq 'yas--post-command-handler post-command-hook))
3512 "[yas] `yas-expand-snippet' needs properly setup `yas-minor-mode'")
3513 (run-hooks 'yas-before-expand-snippet-hook)
3516 (let* ((yas-selected-text (or yas-selected-text
3517 (and (region-active-p)
3518 (buffer-substring-no-properties (region-beginning)
3521 (and (region-active-p)
3525 (and (region-active-p)
3528 (to-delete (and start
3530 (buffer-substring-no-properties start end)))
3533 (setq yas--indent-original-column (current-column))
3534 ;; Delete the region to delete, this *does* get undo-recorded.
3536 (when (and to-delete
3538 (delete-region start end))
3540 (cond ((listp content)
3541 ;; x) This is a snippet-command
3543 (yas--eval-lisp-no-saves content))
3545 ;; x) This is a snippet-snippet :-)
3547 ;; Narrow the region down to the content, shoosh the
3548 ;; `buffer-undo-list', and create the snippet, the new
3549 ;; snippet updates its mirrors once, so we are left with
3550 ;; some plain text. The undo action for deleting this
3551 ;; plain text will get recorded at the end.
3553 ;; stacked expansion: also shoosh the overlay modification hooks
3554 (let ((buffer-undo-list t))
3555 ;; snippet creation might evaluate users elisp, which
3556 ;; might generate errors, so we have to be ready to catch
3557 ;; them mostly to make the undo information
3559 (setq yas--start-column (current-column))
3560 (let ((yas--inhibit-overlay-hooks t))
3563 (eval `(let* ,expand-env
3565 (yas--snippet-create start (point))))
3567 (yas--snippet-create start (point))))))
3569 ;; stacked-expansion: This checks for stacked expansion, save the
3570 ;; `yas--previous-active-field' and advance its boundary.
3572 (let ((existing-field (and yas--active-field-overlay
3573 (overlay-buffer yas--active-field-overlay)
3574 (overlay-get yas--active-field-overlay 'yas--field))))
3575 (when existing-field
3576 (setf (yas--snippet-previous-active-field snippet) existing-field)
3577 (yas--advance-end-maybe existing-field (overlay-end yas--active-field-overlay))))
3579 ;; Exit the snippet immediately if no fields
3581 (unless (yas--snippet-fields snippet)
3582 (yas-exit-snippet snippet))
3584 ;; Push two undo actions: the deletion of the inserted contents of
3585 ;; the new snippet (without the "key") followed by an apply of
3586 ;; `yas--take-care-of-redo' on the newly inserted snippet boundaries
3588 ;; A small exception, if `yas-also-auto-indent-first-line'
3589 ;; is t and `yas--indent' decides to indent the line to a
3590 ;; point before the actual expansion point, undo would be
3591 ;; messed up. We call the early point "newstart"". case,
3592 ;; and attempt to fix undo.
3594 (let ((newstart (overlay-start (yas--snippet-control-overlay snippet)))
3595 (end (overlay-end (yas--snippet-control-overlay snippet))))
3596 (when (< newstart start)
3597 (push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
3598 (push (cons newstart end) buffer-undo-list)
3599 (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
3601 ;; Now, schedule a move to the first field
3603 (let ((first-field (car (yas--snippet-fields snippet))))
3605 (sit-for 0) ;; fix issue 125
3606 (yas--move-to-field snippet first-field)))
3607 (yas--message 3 "snippet expanded.")
3610 (defun yas--take-care-of-redo (_beg _end snippet)
3611 "Commits SNIPPET, which in turn pushes an undo action for reviving it.
3613 Meant to exit in the `buffer-undo-list'."
3614 ;; slightly optimize: this action is only needed for snippets with
3615 ;; at least one field
3616 (when (yas--snippet-fields snippet)
3617 (yas--commit-snippet snippet)))
3619 (defun yas--snippet-revive (beg end snippet)
3620 "Revives SNIPPET and creates a control overlay from BEG to END.
3622 BEG and END are, we hope, the original snippets boundaries.
3623 All the markers/points exiting existing inside SNIPPET should point
3624 to their correct locations *at the time the snippet is revived*.
3626 After revival, push the `yas--take-care-of-redo' in the
3628 ;; Reconvert all the points to markers
3630 (yas--points-to-markers snippet)
3631 ;; When at least one editable field existed in the zombie snippet,
3632 ;; try to revive the whole thing...
3634 (let ((target-field (or (yas--snippet-active-field snippet)
3635 (car (yas--snippet-fields snippet)))))
3637 (setf (yas--snippet-control-overlay snippet) (yas--make-control-overlay snippet beg end))
3638 (overlay-put (yas--snippet-control-overlay snippet) 'yas--snippet snippet)
3640 (yas--move-to-field snippet target-field)
3642 (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
3643 buffer-undo-list))))
3645 (defun yas--snippet-create (begin end)
3646 "Create a snippet from a template inserted at BEGIN to END.
3648 Returns the newly created snippet."
3650 (narrow-to-region begin end)
3651 (let ((snippet (yas--make-snippet)))
3653 (yas--snippet-parse-create snippet)
3655 ;; Sort and link each field
3656 (yas--snippet-sort-fields snippet)
3658 ;; Create keymap overlay for snippet
3659 (setf (yas--snippet-control-overlay snippet)
3660 (yas--make-control-overlay snippet (point-min) (point-max)))
3663 (goto-char (point-max))
3668 ;;; Apropos adjacencies and "fom's":
3670 ;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
3671 ;; recently expanded snippet, we might actually have many fields,
3672 ;; mirrors (and the snippet exit) in the very same position in the
3673 ;; buffer. Therefore we need to single-link the
3674 ;; fields-or-mirrors-or-exit (which I have abbreviated to "fom")
3675 ;; according to their original positions in the buffer.
3677 ;; Then we have operation `yas--advance-end-maybe' and
3678 ;; `yas--advance-start-maybe', which conditionally push the starts and
3679 ;; ends of these foms down the chain.
3681 ;; This allows for like the printf with the magic ",":
3683 ;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
3684 ;; $2${1:$(if (string-match "%" text) "\);" "")}$0
3686 (defun yas--fom-start (fom)
3687 (cond ((yas--field-p fom)
3688 (yas--field-start fom))
3689 ((yas--mirror-p fom)
3690 (yas--mirror-start fom))
3692 (yas--exit-marker fom))))
3694 (defun yas--fom-end (fom)
3695 (cond ((yas--field-p fom)
3696 (yas--field-end fom))
3697 ((yas--mirror-p fom)
3698 (yas--mirror-end fom))
3700 (yas--exit-marker fom))))
3702 (defun yas--fom-next (fom)
3703 (cond ((yas--field-p fom)
3704 (yas--field-next fom))
3705 ((yas--mirror-p fom)
3706 (yas--mirror-next fom))
3708 (yas--exit-next fom))))
3710 (defun yas--fom-parent-field (fom)
3711 (cond ((yas--field-p fom)
3712 (yas--field-parent-field fom))
3713 ((yas--mirror-p fom)
3714 (yas--mirror-parent-field fom))
3718 (defun yas--calculate-adjacencies (snippet)
3719 "Calculate adjacencies for fields or mirrors of SNIPPET.
3721 This is according to their relative positions in the buffer, and
3722 has to be called before the $-constructs are deleted."
3723 (let* ((fom-set-next-fom
3724 (lambda (fom nextfom)
3725 (cond ((yas--field-p fom)
3726 (setf (yas--field-next fom) nextfom))
3727 ((yas--mirror-p fom)
3728 (setf (yas--mirror-next fom) nextfom))
3730 (setf (yas--exit-next fom) nextfom)))))
3733 (if (= (yas--fom-start fom2) (yas--fom-start fom1))
3734 (yas--mirror-p fom2)
3735 (>= (yas--fom-start fom2) (yas--fom-start fom1)))))
3736 (link-foms fom-set-next-fom))
3737 ;; make some yas--field, yas--mirror and yas--exit soup
3739 (when (yas--snippet-exit snippet)
3740 (push (yas--snippet-exit snippet) soup))
3741 (dolist (field (yas--snippet-fields snippet))
3743 (dolist (mirror (yas--field-mirrors field))
3744 (push mirror soup)))
3746 (sort soup compare-fom-begs))
3748 (reduce link-foms soup)))))
3750 (defun yas--calculate-mirrors-in-fields (snippet mirror)
3751 "Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
3753 Use the tightest containing field if more than one field contains
3754 the mirror. Intended to be called *before* the dollar-regions are
3756 (let ((min (point-min))
3758 (dolist (field (yas--snippet-fields snippet))
3759 (when (and (<= (yas--field-start field) (yas--mirror-start mirror))
3760 (<= (yas--mirror-end mirror) (yas--field-end field))
3761 (< min (yas--field-start field))
3762 (< (yas--field-end field) max))
3763 (setq min (yas--field-start field)
3764 max (yas--field-end field))
3765 (setf (yas--mirror-parent-field mirror) field)))))
3767 (defun yas--advance-end-maybe (fom newend)
3768 "Maybe advance FOM's end to NEWEND if it needs it.
3772 * call `yas--advance-start-maybe' on FOM's next fom.
3774 * in case FOM is field call `yas--advance-end-maybe' on its parent
3777 Also, if FOM is an exit-marker, always call
3778 `yas--advance-start-maybe' on its next fom. This is because
3779 exit-marker have identical start and end markers."
3780 (cond ((and fom (< (yas--fom-end fom) newend))
3781 (set-marker (yas--fom-end fom) newend)
3782 (yas--advance-start-maybe (yas--fom-next fom) newend)
3783 (yas--advance-end-of-parents-maybe (yas--fom-parent-field fom) newend))
3785 (yas--advance-start-maybe (yas--fom-next fom) newend))))
3787 (defun yas--advance-start-maybe (fom newstart)
3788 "Maybe advance FOM's start to NEWSTART if it needs it.
3790 If it does, also call `yas--advance-end-maybe' on FOM."
3791 (when (and fom (< (yas--fom-start fom) newstart))
3792 (set-marker (yas--fom-start fom) newstart)
3793 (yas--advance-end-maybe fom newstart)))
3795 (defun yas--advance-end-of-parents-maybe (field newend)
3796 "Like `yas--advance-end-maybe' but for parent fields.
3798 Only works for fields and doesn't care about the start of the
3799 next FOM. Works its way up recursively for parents of parents."
3801 (< (yas--field-end field) newend))
3802 (set-marker (yas--field-end field) newend)
3803 (yas--advance-end-of-parents-maybe (yas--field-parent-field field) newend)))
3805 (defvar yas--dollar-regions nil
3806 "When expanding the snippet the \"parse-create\" functions add
3807 cons cells to this var.")
3809 (defvar yas--backquote-markers-and-strings nil
3810 "List of (MARKER . STRING) marking where the values from
3811 backquoted Lisp expressions should be inserted at the end of
3814 (defun yas--snippet-parse-create (snippet)
3815 "Parse a recently inserted snippet template, creating all
3816 necessary fields, mirrors and exit points.
3818 Meant to be called in a narrowed buffer, does various passes"
3819 (let ((parse-start (point)))
3820 ;; Reset the yas--dollar-regions
3822 (setq yas--dollar-regions nil)
3823 ;; protect just the backquotes
3825 (yas--protect-escapes nil '(?`))
3826 ;; replace all backquoted expressions
3828 (goto-char parse-start)
3829 (yas--save-backquotes)
3830 ;; protect escaped characters
3832 (yas--protect-escapes)
3833 ;; parse fields with {}
3835 (goto-char parse-start)
3836 (yas--field-parse-create snippet)
3837 ;; parse simple mirrors and fields
3839 (goto-char parse-start)
3840 (yas--simple-mirror-parse-create snippet)
3841 ;; parse mirror transforms
3843 (goto-char parse-start)
3844 (yas--transform-mirror-parse-create snippet)
3845 ;; calculate adjacencies of fields and mirrors
3847 (yas--calculate-adjacencies snippet)
3848 ;; Delete $-constructs
3850 (save-restriction (widen) (yas--delete-regions yas--dollar-regions))
3851 ;; restore backquoted expression values
3853 (yas--restore-backquotes)
3856 (goto-char parse-start)
3857 (yas--restore-escapes)
3858 ;; update mirrors for the first time
3860 (yas--update-mirrors snippet)
3861 ;; indent the best we can
3863 (goto-char parse-start)
3864 (yas--indent snippet)))
3866 (defun yas--indent-according-to-mode (snippet-markers)
3867 "Indent current line according to mode, preserving SNIPPET-MARKERS."
3868 ;;; Apropos indenting problems....
3870 ;; `indent-according-to-mode' uses whatever `indent-line-function'
3871 ;; is available. Some implementations of these functions delete text
3872 ;; before they insert. If there happens to be a marker just after
3873 ;; the text being deleted, the insertion actually happens after the
3874 ;; marker, which misplaces it.
3876 ;; This would also happen if we had used overlays with the
3877 ;; `front-advance' property set to nil.
3879 ;; This is why I have these `trouble-markers', they are the ones at
3880 ;; they are the ones at the first non-whitespace char at the line
3881 ;; (i.e. at `yas--real-line-beginning'. After indentation takes place
3882 ;; we should be at the correct to restore them to. All other
3883 ;; non-trouble-markers have been *pushed* and don't need special
3886 (goto-char (yas--real-line-beginning))
3887 (let ((trouble-markers (remove-if-not #'(lambda (marker)
3893 (indent-according-to-mode)
3894 (error (yas--message 3 "Warning: `yas--indent-according-to-mode' having problems running %s" indent-line-function)
3896 (mapc #'(lambda (marker)
3897 (set-marker marker (point)))
3900 (defvar yas--indent-original-column nil)
3901 (defun yas--indent (snippet)
3902 (let ((snippet-markers (yas--collect-snippet-markers snippet)))
3903 ;; Look for those $>
3905 (while (re-search-forward "$>" nil t)
3906 (delete-region (match-beginning 0) (match-end 0))
3907 (when (not (eq yas-indent-line 'auto))
3908 (yas--indent-according-to-mode snippet-markers))))
3909 ;; Now do stuff for 'fixed and 'auto
3911 (cond ((eq yas-indent-line 'fixed)
3912 (while (and (zerop (forward-line))
3913 (zerop (current-column)))
3914 (indent-to-column yas--indent-original-column)))
3915 ((eq yas-indent-line 'auto)
3916 (let ((end (set-marker (make-marker) (point-max)))
3917 (indent-first-line-p yas-also-auto-indent-first-line))
3918 (while (and (zerop (if indent-first-line-p
3921 (setq indent-first-line-p nil))
3925 (yas--indent-according-to-mode snippet-markers))))
3929 (defun yas--collect-snippet-markers (snippet)
3930 "Make a list of all the markers used by SNIPPET."
3932 (dolist (field (yas--snippet-fields snippet))
3933 (push (yas--field-start field) markers)
3934 (push (yas--field-end field) markers)
3935 (dolist (mirror (yas--field-mirrors field))
3936 (push (yas--mirror-start mirror) markers)
3937 (push (yas--mirror-end mirror) markers)))
3938 (let ((snippet-exit (yas--snippet-exit snippet)))
3939 (when (and snippet-exit
3940 (marker-buffer (yas--exit-marker snippet-exit)))
3941 (push (yas--exit-marker snippet-exit) markers)))
3944 (defun yas--real-line-beginning ()
3945 (let ((c (char-after (line-beginning-position)))
3946 (n (line-beginning-position)))
3947 (while (or (eql c ?\ )
3950 (setq c (char-after n)))
3953 (defun yas--escape-string (escaped)
3954 (concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
3956 (defun yas--protect-escapes (&optional text escaped)
3957 "Protect all escaped characters with their numeric ASCII value.
3959 With optional string TEXT do it in string instead of buffer."
3960 (let ((changed-text text)
3961 (text-provided-p text))
3962 (mapc #'(lambda (escaped)
3964 (yas--replace-all (concat "\\" (char-to-string escaped))
3965 (yas--escape-string escaped)
3966 (when text-provided-p changed-text))))
3967 (or escaped yas--escaped-characters))
3970 (defun yas--restore-escapes (&optional text escaped)
3971 "Restore all escaped characters from their numeric ASCII value.
3973 With optional string TEXT do it in string instead of the buffer."
3974 (let ((changed-text text)
3975 (text-provided-p text))
3976 (mapc #'(lambda (escaped)
3978 (yas--replace-all (yas--escape-string escaped)
3979 (char-to-string escaped)
3980 (when text-provided-p changed-text))))
3981 (or escaped yas--escaped-characters))
3984 (defun yas--save-backquotes ()
3985 "Save all the \"`(lisp-expression)`\"-style expressions
3986 with their evaluated value into `yas--backquote-markers-and-strings'."
3987 (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
3988 (let ((current-string (match-string-no-properties 1)) transformed)
3989 (save-restriction (widen)
3990 (delete-region (match-beginning 0) (match-end 0)))
3991 (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
3992 (goto-char (match-beginning 0))
3994 (let ((marker (make-marker)))
3997 (insert "Y") ;; quite horrendous, I love it :)
3998 (set-marker marker (point))
4000 (push (cons marker transformed) yas--backquote-markers-and-strings))))))
4002 (defun yas--restore-backquotes ()
4003 "Replace markers in `yas--backquote-markers-and-strings' with their values."
4004 (while yas--backquote-markers-and-strings
4005 (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
4006 (marker (car marker-and-string))
4007 (string (cdr marker-and-string)))
4015 (set-marker marker nil)))))
4017 (defun yas--scan-sexps (from count)
4019 (save-match-data ; `scan-sexps' may modify match data.
4020 (with-syntax-table (standard-syntax-table)
4021 (scan-sexps from count)))))
4023 (defun yas--make-marker (pos)
4024 "Create a marker at POS with nil `marker-insertion-type'."
4025 (let ((marker (set-marker (make-marker) pos)))
4026 (set-marker-insertion-type marker nil)
4029 (defun yas--field-parse-create (snippet &optional parent-field)
4030 "Parse most field expressions in SNIPPET, except for the simple one \"$n\".
4032 The following count as a field:
4034 * \"${n: text}\", for a numbered field with default text, as long as N is not 0;
4036 * \"${n: text$(expression)}, the same with a Lisp expression;
4037 this is caught with the curiously named `yas--multi-dollar-lisp-expression-regexp'
4039 * the same as above but unnumbered, (no N:) and number is calculated automatically.
4041 When multiple expressions are found, only the last one counts."
4044 (while (re-search-forward yas--field-regexp nil t)
4045 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4046 (number (and (match-string-no-properties 1)
4047 (string-to-number (match-string-no-properties 1))))
4048 (brand-new-field (and real-match-end-0
4049 ;; break if on "$(" immediately
4050 ;; after the ":", this will be
4051 ;; caught as a mirror with
4053 (not (string-match-p "\\`\\$[ \t\n]*("
4054 (match-string-no-properties 2)))
4055 ;; allow ${0: some exit text}
4056 ;; (not (and number (zerop number)))
4057 (yas--make-field number
4058 (yas--make-marker (match-beginning 2))
4059 (yas--make-marker (1- real-match-end-0))
4061 (when brand-new-field
4062 (goto-char real-match-end-0)
4063 (push (cons (1- real-match-end-0) real-match-end-0)
4064 yas--dollar-regions)
4065 (push (cons (match-beginning 0) (match-beginning 2))
4066 yas--dollar-regions)
4067 (push brand-new-field (yas--snippet-fields snippet))
4070 (narrow-to-region (yas--field-start brand-new-field) (yas--field-end brand-new-field))
4071 (goto-char (point-min))
4072 (yas--field-parse-create snippet brand-new-field)))))))
4073 ;; if we entered from a parent field, now search for the
4074 ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
4075 ;; primary field transformations
4079 (while (re-search-forward yas--multi-dollar-lisp-expression-regexp nil t)
4080 (let* ((real-match-end-1 (yas--scan-sexps (match-beginning 1) 1)))
4081 ;; commit the primary field transformation if:
4083 ;; 1. we don't find it in yas--dollar-regions (a subnested
4084 ;; field) might have already caught it.
4086 ;; 2. we really make sure we have either two '$' or some
4087 ;; text and a '$' after the colon ':'. This is a FIXME: work
4088 ;; my regular expressions and end these ugly hacks.
4090 (when (and real-match-end-1
4091 (not (member (cons (match-beginning 0)
4093 yas--dollar-regions))
4095 (char-before (1- (match-beginning 1))))))
4096 (let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
4098 (setf (yas--field-transform parent-field)
4099 (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
4100 (push (cons (match-beginning 0) real-match-end-1)
4101 yas--dollar-regions)))))))
4103 (defun yas--transform-mirror-parse-create (snippet)
4104 "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
4105 (while (re-search-forward yas--transform-mirror-regexp nil t)
4106 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4107 (number (string-to-number (match-string-no-properties 1)))
4109 (not (zerop number))
4110 (yas--snippet-find-field snippet number)))
4112 (and real-match-end-0
4114 (yas--make-mirror (yas--make-marker (match-beginning 0))
4115 (yas--make-marker (match-beginning 0))
4117 (yas--restore-escapes
4118 (buffer-substring-no-properties (match-beginning 2)
4119 (1- real-match-end-0))))))))
4120 (when brand-new-mirror
4121 (push brand-new-mirror
4122 (yas--field-mirrors field))
4123 (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
4124 (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
4126 (defun yas--simple-mirror-parse-create (snippet)
4127 "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
4128 (while (re-search-forward yas--simple-mirror-regexp nil t)
4129 (let ((number (string-to-number (match-string-no-properties 1))))
4130 (cond ((zerop number)
4132 (setf (yas--snippet-exit snippet)
4133 (yas--make-exit (yas--make-marker (match-end 0))))
4135 (goto-char (match-beginning 0))
4136 (when yas-wrap-around-region
4137 (cond (yas-selected-text
4138 (insert yas-selected-text))
4139 ((and (eq yas-wrap-around-region 'cua)
4142 (insert (prog1 (get-register ?0)
4143 (set-register ?0 nil))))))
4144 (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
4145 yas--dollar-regions)))
4147 (let ((field (yas--snippet-find-field snippet number)))
4149 (let ((brand-new-mirror (yas--make-mirror
4150 (yas--make-marker (match-beginning 0))
4151 (yas--make-marker (match-beginning 0))
4153 (push brand-new-mirror
4154 (yas--field-mirrors field))
4155 (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
4156 (push (yas--make-field number
4157 (yas--make-marker (match-beginning 0))
4158 (yas--make-marker (match-beginning 0))
4160 (yas--snippet-fields snippet))))
4161 (push (cons (match-beginning 0) (match-end 0))
4162 yas--dollar-regions))))))
4164 (defun yas--delete-regions (regions)
4165 "Sort disjuct REGIONS by start point, then delete from the back."
4166 (mapc #'(lambda (reg)
4167 (delete-region (car reg) (cdr reg)))
4170 (>= (car r1) (car r2))))))
4172 (defun yas--calculate-mirror-depth (mirror &optional traversed)
4173 (let* ((parent (yas--mirror-parent-field mirror))
4174 (parents-mirrors (and parent
4175 (yas--field-mirrors parent))))
4176 (or (yas--mirror-depth mirror)
4177 (setf (yas--mirror-depth mirror)
4178 (cond ((memq mirror traversed)
4180 ((and parent parents-mirrors)
4182 (mapcar #'(lambda (m)
4183 (yas--calculate-mirror-depth m
4192 (defun yas--update-mirrors (snippet)
4193 "Update all the mirrors of SNIPPET."
4195 (dolist (field-and-mirror (sort
4196 ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
4197 ;; where F is the field that M is mirroring
4199 (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)
4223 ;; `yas--place-overlays' is needed if the active field and
4224 ;; protected overlays have been changed because of insertions
4225 ;; in `yas--mirror-update-display'
4227 (when (eq field (yas--snippet-active-field snippet))
4228 (yas--place-overlays snippet field))))))
4230 (defun yas--mirror-update-display (mirror field)
4231 "Update MIRROR according to FIELD (and mirror transform)."
4233 (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
4234 (reflection (and (not (and mirror-parent-field
4235 (yas--field-modified-p mirror-parent-field)))
4236 (or (yas--apply-transform mirror field 'empty-on-nil)
4237 (yas--field-text-for-display field)))))
4238 (when (and reflection
4239 (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
4240 (yas--mirror-end mirror)))))
4241 (goto-char (yas--mirror-start mirror))
4242 (let ((yas--inhibit-overlay-hooks t))
4243 (insert reflection))
4244 (if (> (yas--mirror-end mirror) (point))
4245 (delete-region (point) (yas--mirror-end mirror))
4246 (set-marker (yas--mirror-end mirror) (point))
4247 (yas--advance-start-maybe (yas--mirror-next mirror) (point))
4248 ;; super-special advance
4249 (yas--advance-end-of-parents-maybe mirror-parent-field (point))))))
4251 (defun yas--field-update-display (field)
4252 "Much like `yas--mirror-update-display', but for fields."
4253 (when (yas--field-transform field)
4254 (let ((transformed (and (not (eq (yas--field-number field) 0))
4255 (yas--apply-transform field field))))
4256 (when (and transformed
4257 (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
4258 (yas--field-end field)))))
4259 (setf (yas--field-modified-p field) t)
4260 (goto-char (yas--field-start field))
4261 (let ((yas--inhibit-overlay-hooks t))
4262 (insert transformed)
4263 (if (> (yas--field-end field) (point))
4264 (delete-region (point) (yas--field-end field))
4265 (set-marker (yas--field-end field) (point))
4266 (yas--advance-start-maybe (yas--field-next field) (point)))
4270 ;;; Post-command hook:
4272 (defun yas--post-command-handler ()
4273 "Handles various yasnippet conditions after each command."
4274 (cond ((eq 'undo this-command)
4276 ;; After undo revival the correct field is sometimes not
4277 ;; restored correctly, this condition handles that
4279 (let* ((snippet (car (yas--snippets-at-point)))
4280 (target-field (and snippet
4281 (find-if-not #'(lambda (field)
4282 (yas--field-probably-deleted-p snippet field))
4284 (cons (yas--snippet-active-field snippet)
4285 (yas--snippet-fields snippet)))))))
4287 (yas--move-to-field snippet target-field))))
4288 ((not (yas--undo-in-progress))
4289 ;; When not in an undo, check if we must commit the snippet
4290 ;; (user exited it).
4291 (yas--check-commit-snippet))))
4295 ;; The docstrings for some functions are generated dynamically
4296 ;; depending on the context.
4298 (put 'yas-expand 'function-documentation
4299 '(yas--expand-from-trigger-key-doc t))
4300 (defun yas--expand-from-trigger-key-doc (context)
4301 "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
4302 (let* ((yas-fallback-behavior (and context yas-fallback-behavior))
4303 (fallback-description
4304 (cond ((eq yas-fallback-behavior 'call-other-command)
4305 (let* ((fallback (yas--keybinding-beyond-yasnippet)))
4307 (format "call command `%s'."
4308 (pp-to-string fallback)))
4309 "do nothing (`yas-expand' doesn't override\nanything).")))
4310 ((eq yas-fallback-behavior 'return-nil)
4312 (t "defer to `yas-fallback-behavior' (which see)."))))
4313 (concat "Expand a snippet before point. If no snippet
4314 expansion is possible, "
4315 fallback-description
4316 "\n\nOptional argument FIELD is for non-interactive use and is an
4317 object satisfying `yas--field-p' to restrict the expansion to.")))
4319 (put 'yas-expand-from-keymap 'function-documentation
4320 '(yas--expand-from-keymap-doc t))
4321 (defun yas--expand-from-keymap-doc (context)
4322 "A doc synthesizer for `yas--expand-from-keymap-doc'."
4323 (add-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce)
4324 (concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
4325 (when (and context (eq this-command 'describe-key))
4326 (let* ((vec (this-single-command-keys))
4327 (templates (mapcan #'(lambda (table)
4328 (yas--fetch table vec))
4329 (yas--get-snippet-tables)))
4330 (yas--direct-keymaps nil)
4331 (fallback (key-binding vec)))
4332 (concat "In this case, "
4334 (concat "these snippets are bound to this key:\n"
4335 (yas--template-pretty-list templates)
4336 "\n\nIf none of these expands, "))
4338 (format "fallback `%s' will be called." (pp-to-string fallback)))
4339 "no fallback keybinding is called."))))))
4341 (defun yas--template-pretty-list (templates)
4343 (yas-buffer-local-condition 'always))
4344 (dolist (plate templates)
4345 (setq acc (concat acc "\n*) "
4346 (propertize (concat "\\\\snippet `" (car plate) "'")
4347 'yasnippet (cdr plate)))))
4350 (define-button-type 'help-snippet-def
4351 :supertype 'help-xref
4352 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
4353 'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
4355 (defun yas--snippet-description-finish-runonce ()
4356 "Final adjustments for the help buffer when snippets are concerned."
4357 (yas--create-snippet-xrefs)
4358 (remove-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce))
4360 (defun yas--create-snippet-xrefs ()
4362 (goto-char (point-min))
4363 (while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
4364 (let ((template (get-text-property (match-beginning 1)
4367 (help-xref-button 1 'help-snippet-def template)
4368 (kill-region (match-end 1) (match-end 0))
4369 (kill-region (match-beginning 0) (match-beginning 1)))))))
4373 (defvar yas-verbosity 4
4374 "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
4376 (defun yas--message (level message &rest args)
4377 "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
4378 (when (> yas-verbosity level)
4379 (message "%s" (apply #'yas--format message args))))
4381 (defun yas--warning (format-control &rest format-args)
4382 (let ((msg (apply #'format format-control format-args)))
4383 (display-warning 'yasnippet msg :warning)
4384 (yas--message 1 msg)))
4386 (defun yas--format (format-control &rest format-args)
4387 (apply #'format (concat "[yas] " format-control) format-args))
4394 ;; `locate-dominating-file'
4395 ;; `region-active-p'
4397 ;; added for compatibility in emacsen < 23
4398 (unless (>= emacs-major-version 23)
4399 (unless (fboundp 'region-active-p)
4400 (defun region-active-p () (and transient-mark-mode mark-active)))
4402 (unless (fboundp 'locate-dominating-file)
4403 (defvar locate-dominating-stop-dir-regexp
4404 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
4405 "Regexp of directory names which stop the search in `locate-dominating-file'.
4406 Any directory whose name matches this regexp will be treated like
4407 a kind of root directory by `locate-dominating-file' which will stop its search
4408 when it bumps into it.
4409 The default regexp prevents fruitless and time-consuming attempts to find
4410 special files in directories in which filenames are interpreted as hostnames,
4411 or mount points potentially requiring authentication as a different user.")
4413 (defun locate-dominating-file (file name)
4414 "Look up the directory hierarchy from FILE for a file named NAME.
4415 Stop at the first parent directory containing a file NAME,
4416 and return the directory. Return nil if not found."
4417 ;; We used to use the above locate-dominating-files code, but the
4418 ;; directory-files call is very costly, so we're much better off doing
4419 ;; multiple calls using the code in here.
4421 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
4422 ;; `name' in /home or in /.
4423 (setq file (abbreviate-file-name file))
4426 (while (not (or root
4428 ;; FIXME: Disabled this heuristic because it is sometimes
4430 ;; As a heuristic, we stop looking up the hierarchy of
4431 ;; directories as soon as we find a directory belonging
4432 ;; to another user. This should save us from looking in
4433 ;; things like /net and /afs. This assumes that all the
4434 ;; files inside a project belong to the same user.
4435 ;; (let ((prev-user user))
4436 ;; (setq user (nth 2 (file-attributes file)))
4437 ;; (and prev-user (not (equal user prev-user))))
4438 (string-match locate-dominating-stop-dir-regexp file)))
4439 (setq try (file-exists-p (expand-file-name name file)))
4440 (cond (try (setq root file))
4441 ((equal file (setq file (file-name-directory
4442 (directory-file-name file))))
4447 ;;; Backward compatibility to yasnippet <= 0.7
4449 (defun yas-initialize ()
4450 "For backward compatibility, enable `yas-minor-mode' globally."
4451 (declare (obsolete "Use (yas-global-mode 1) instead." "0.8"))
4452 (yas-global-mode 1))
4454 (defvar yas--backported-syms '(;; `defcustom's
4457 yas-prompt-functions
4459 yas-also-auto-indent-first-line
4461 yas-triggers-in-field
4462 yas-fallback-behavior
4463 yas-choose-keys-first
4464 yas-choose-tables-first
4467 yas-wrap-around-region
4470 yas-expand-only-for-last-commands
4471 yas-field-highlight-face
4473 ;; these vars can be customized as well
4479 yas-after-exit-snippet-hook
4480 yas-before-expand-snippet-hook
4481 yas-buffer-local-condition
4484 ;; prompting functions
4489 yas-completing-prompt
4492 ;; interactive functions
4497 yas-direct-keymaps-reload
4501 yas-compile-directory
4504 yas-expand-from-trigger-key
4505 yas-expand-from-keymap
4507 yas-visit-snippet-file
4509 yas-load-snippet-buffer
4512 yas-next-field-or-maybe-expand
4517 yas-exit-all-snippets
4518 yas-skip-and-clear-or-delete-char
4521 ;; symbols that I "exported" for use
4522 ;; in snippets and hookage
4539 yas-default-from-field
4542 yas-define-condition-cache
4543 yas-hippie-try-expand
4545 ;; debug definitions
4546 ;; yas-debug-snippet-vars
4547 ;; yas-exterminate-package
4550 ;; testing definitions
4551 ;; yas-should-expand
4552 ;; yas-should-not-expand
4554 ;; yas-make-file-or-dirs
4556 ;; yas-saving-variables
4557 ;; yas-call-with-snippet-dirs
4558 ;; yas-with-snippet-dirs
4560 "Backported yasnippet symbols.
4562 They are mapped to \"yas/*\" variants.")
4564 (dolist (sym yas--backported-syms)
4565 (let ((backported (intern (replace-regexp-in-string "^yas-" "yas/" (symbol-name sym)))))
4567 (make-obsolete-variable backported sym "yasnippet 0.8")
4568 (defvaralias backported sym))
4570 (make-obsolete backported sym "yasnippet 0.8")
4571 (defalias backported sym))))
4573 (defvar yas--exported-syms
4575 (mapatoms (lambda (atom)
4576 (if (and (or (and (boundp atom)
4577 (not (get atom 'byte-obsolete-variable)))
4579 (not (get atom 'byte-obsolete-info))))
4580 (string-match-p "^yas-[^-]" (symbol-name atom)))
4581 (push atom exported))))
4583 "Exported yasnippet symbols.
4585 i.e. the ones with \"yas-\" single dash prefix. I will try to
4586 keep them in future yasnippet versions and other elisp libraries
4587 can more or less safely rely upon them.")
4590 (provide 'yasnippet)
4593 ;; indent-tabs-mode: nil
4594 ;; byte-compile-warnings: (not cl-functions)
4596 ;;; yasnippet.el ends here