1 ;;; yasnippet.el --- Yet another snippet extension for Emacs.
3 ;; Copyright (C) 2008-2013 Free Software Foundation, Inc.
4 ;; Authors: pluskid <pluskid@gmail.com>, João Távora <joaotavora@gmail.com>
5 ;; Maintainer: João Távora <joaotavora@gmail.com>
7 ;; Package-version: 0.8.0
8 ;; X-URL: http://github.com/capitaomorte/yasnippet
9 ;; Keywords: convenience, emulation
10 ;; URL: http://github.com/capitaomorte/yasnippet
11 ;; EmacsWiki: YaSnippetMode
13 ;; This program is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; This program is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
28 ;; Basic steps to setup:
30 ;; (add-to-list 'load-path
31 ;; "~/path-to-yasnippet")
32 ;; (require 'yasnippet)
33 ;; (yas-global-mode 1)
36 ;; Interesting variables are:
40 ;; The directory where user-created snippets are to be
41 ;; stored. Can also be a list of directories. In that case,
42 ;; when used for bulk (re)loading of snippets (at startup or
43 ;; via `yas-reload-all'), directories appearing earlier in
44 ;; the list shadow other dir's snippets. Also, the first
45 ;; directory is taken as the default for storing the user's
48 ;; The deprecated `yas/root-directory' aliases this variable
49 ;; for backward-compatibility.
52 ;; Major commands are:
56 ;; Try to expand snippets before point. In `yas-minor-mode',
57 ;; this is normally bound to TAB, but you can customize it in
58 ;; `yas-minor-mode-map'.
60 ;; M-x yas-load-directory
62 ;; Prompts you for a directory hierarchy of snippets to load.
64 ;; M-x yas-activate-extra-mode
66 ;; Prompts you for an extra mode to add snippets for in the
69 ;; M-x yas-insert-snippet
71 ;; Prompts you for possible snippet expansion if that is
72 ;; possible according to buffer-local and snippet-local
73 ;; expansion conditions. With prefix argument, ignore these
76 ;; M-x yas-visit-snippet-file
78 ;; Prompts you for possible snippet expansions like
79 ;; `yas-insert-snippet', but instead of expanding it, takes
80 ;; you directly to the snippet definition's file, if it
83 ;; M-x yas-new-snippet
85 ;; Lets you create a new snippet file in the correct
86 ;; subdirectory of `yas-snippet-dirs', according to the
89 ;; M-x yas-load-snippet-buffer
91 ;; When editing a snippet, this loads the snippet. This is
92 ;; bound to "C-c C-c" while in the `snippet-mode' editing
95 ;; M-x yas-tryout-snippet
97 ;; When editing a snippet, this opens a new empty buffer,
98 ;; sets it to the appropriate major mode and inserts the
99 ;; snippet there, so you can see what it looks like. This is
100 ;; bound to "C-c C-t" while in `snippet-mode'.
102 ;; M-x yas-describe-tables
104 ;; Lists known snippets in a separate buffer. User is
105 ;; prompted as to whether only the currently active tables
106 ;; are to be displayed, or all the tables for all major
109 ;; If you have `dropdown-list' installed, you can optionally use it
110 ;; as the preferred "prompting method", putting in your .emacs file,
113 ;; (require 'dropdown-list)
114 ;; (setq yas-prompt-functions '(yas-dropdown-prompt
116 ;; yas-completing-prompt))
118 ;; Also check out the customization group
120 ;; M-x customize-group RET yasnippet RET
122 ;; If you use the customization group to set variables
123 ;; `yas-snippet-dirs' or `yas-global-mode', make sure the path to
124 ;; "yasnippet.el" is present in the `load-path' *before* the
125 ;; `custom-set-variables' is executed in your .emacs file.
127 ;; For more information and detailed usage, refer to the project page:
128 ;; http://github.com/capitaomorte/yasnippet
138 (defvar yas--editing-template)
139 (defvar yas--guessed-modes)
140 (defvar yas--indent-original-column)
141 (defvar yas--scheduled-jit-loads)
143 (defvar yas-selected-text)
144 (defvar yas-verbosity)
145 (defvar yas--current-template)
148 ;;; User customizable variables
150 (defgroup yasnippet nil
151 "Yet Another Snippet extension"
154 (defvar yas--load-file-name load-file-name
155 "Store the filename that yasnippet.el was originally loaded from.")
157 (defcustom yas-snippet-dirs (remove nil
158 (list "~/.emacs.d/snippets"
159 (when yas--load-file-name
160 (concat (file-name-directory yas--load-file-name) "snippets"))))
161 "Directory or list of snippet dirs for each major mode.
163 The directory where user-created snippets are to be stored. Can
164 also be a list of directories. In that case, when used for
165 bulk (re)loading of snippets (at startup or via
166 `yas-reload-all'), directories appearing earlier in the list
167 shadow other dir's snippets. Also, the first directory is taken
168 as the default for storing the user's new snippets."
169 :type '(choice (string :tag "Single directory (string)")
170 (repeat :args (string) :tag "List of directories (strings)"))
173 :set #'(lambda (symbol new)
174 (let ((old (and (boundp symbol)
175 (symbol-value symbol))))
176 (set-default symbol new)
177 (unless (or (not (fboundp 'yas-reload-all))
181 (defun yas-snippet-dirs ()
182 "Return `yas-snippet-dirs' (which see) as a list."
183 (if (listp yas-snippet-dirs) yas-snippet-dirs (list yas-snippet-dirs)))
185 (defvaralias 'yas/root-directory 'yas-snippet-dirs)
187 (defcustom yas-new-snippet-default "\
188 # -*- mode: snippet; require-final-newline: nil -*-
190 # key: ${2:${1:$(yas--key-from-desc yas-text)}}${3:
191 # binding: ${4:direct-keybinding}}${5:
192 # expand-env: ((${6:some-var} ${7:some-value}))}${8:
196 "Default snippet to use when creating a new snippet.
197 If nil, don't use any snippet."
201 (defcustom yas-prompt-functions '(yas-x-prompt
203 yas-completing-prompt
206 "Functions to prompt for keys, templates, etc interactively.
208 These functions are called with the following arguments:
210 - PROMPT: A string to prompt the user
212 - CHOICES: a list of strings or objects.
214 - optional DISPLAY-FN : A function that, when applied to each of
215 the objects in CHOICES will return a string.
217 The return value of any function you put here should be one of
218 the objects in CHOICES, properly formatted with DISPLAY-FN (if
221 - To signal that your particular style of prompting is
222 unavailable at the moment, you can also have the function return
225 - To signal that the user quit the prompting process, you can
228 (signal 'quit \"user quit!\")."
229 :type '(repeat function)
232 (defcustom yas-indent-line 'auto
233 "Controls indenting applied to a recent snippet expansion.
235 The following values are possible:
237 - `fixed' Indent the snippet to the current column;
239 - `auto' Indent each line of the snippet with `indent-according-to-mode'
241 Every other value means don't apply any snippet-side indentation
242 after expansion (the manual per-line \"$>\" indentation still
244 :type '(choice (const :tag "Nothing" nothing)
245 (const :tag "Fixed" fixed)
246 (const :tag "Auto" auto))
249 (defcustom yas-also-auto-indent-first-line nil
250 "Non-nil means also auto indent first line according to mode.
252 Naturally this is only valid when `yas-indent-line' is `auto'"
256 (defcustom yas-snippet-revival t
257 "Non-nil means re-activate snippet fields after undo/redo."
261 (defcustom yas-triggers-in-field nil
262 "If non-nil, allow stacked expansions (snippets inside snippets).
264 Otherwise `yas-next-field-or-maybe-expand' just moves on to the
269 (defcustom yas-fallback-behavior 'call-other-command
270 "How to act when `yas-expand' does *not* expand a snippet.
272 - `call-other-command' means try to temporarily disable YASnippet
273 and call the next command bound to whatever key was used to
276 - nil or the symbol `return-nil' mean do nothing. (and
277 `yas-expand' returns nil)
279 - A Lisp form (apply COMMAND . ARGS) means interactively call
280 COMMAND, if ARGS is non-nil, call COMMAND non-interactively
281 with ARGS as arguments."
282 :type '(choice (const :tag "Call previous command" call-other-command)
283 (const :tag "Do nothing" return-nil))
286 (defcustom yas-choose-keys-first nil
287 "If non-nil, prompt for snippet key first, then for template.
289 Otherwise prompts for all possible snippet names.
291 This affects `yas-insert-snippet' and `yas-visit-snippet-file'."
295 (defcustom yas-choose-tables-first nil
296 "If non-nil, and multiple eligible snippet tables, prompts user for tables first.
298 Otherwise, user chooses between the merging together of all
301 This affects `yas-insert-snippet', `yas-visit-snippet-file'"
305 (defcustom yas-use-menu 'abbreviate
306 "Display a YASnippet menu in the menu bar.
308 When non-nil, submenus for each snippet table will be listed
309 under the menu \"Yasnippet\".
311 - If set to `abbreviate', only the current major-mode
312 menu and the modes set in `yas--extra-modes' are listed.
314 - If set to `full', every submenu is listed
316 - It set to nil, don't display a menu at all (this requires a
317 `yas-reload-all' call if the menu is already visible).
319 Any other non-nil value, every submenu is listed."
320 :type '(choice (const :tag "Full" full)
321 (const :tag "Abbreviate" abbreviate)
322 (const :tag "No menu" nil))
325 (defcustom yas-trigger-symbol (or (and (eq window-system 'mac)
327 (char-to-string ?\x21E5))) ;; little ->| sign
329 "The text that will be used in menu to represent the trigger."
333 (defcustom yas-wrap-around-region nil
334 "If non-nil, snippet expansion wraps around selected region.
336 The wrapping occurs just before the snippet's exit marker. This
337 can be overridden on a per-snippet basis."
341 (defcustom yas-good-grace t
342 "If non-nil, don't raise errors in inline elisp evaluation.
344 An error string \"[yas] error\" is returned instead."
348 (defcustom yas-visit-from-menu nil
349 "If non-nil visit snippets's files from menu, instead of expanding them.
351 This can only work when snippets are loaded from files."
355 (defcustom yas-expand-only-for-last-commands nil
356 "List of `last-command' values to restrict tab-triggering to, or nil.
358 Leave this set at nil (the default) to be able to trigger an
359 expansion simply by placing the cursor after a valid tab trigger,
360 using whichever commands.
362 Optionally, set this to something like '(self-insert-command) if
363 you to wish restrict expansion to only happen when the last
364 letter of the snippet tab trigger was typed immediately before
365 the trigger key itself."
366 :type '(repeat function)
369 ;; Only two faces, and one of them shouldn't even be used...
371 (defface yas-field-highlight-face
372 '((t (:inherit 'region)))
373 "The face used to highlight the currently active field of a snippet"
376 (defface yas--field-debug-face
378 "The face used for debugging some overlays normally hidden"
382 ;;; User-visible variables
384 (defvar yas-keymap (let ((map (make-sparse-keymap)))
385 (define-key map [(tab)] 'yas-next-field-or-maybe-expand)
386 (define-key map (kbd "TAB") 'yas-next-field-or-maybe-expand)
387 (define-key map [(shift tab)] 'yas-prev-field)
388 (define-key map [backtab] 'yas-prev-field)
389 (define-key map (kbd "C-g") 'yas-abort-snippet)
390 (define-key map (kbd "C-d") 'yas-skip-and-clear-or-delete-char)
392 "The active keymap while a snippet expansion is in progress.")
394 (defvar yas-key-syntaxes (list "w" "w_" "w_." "w_.()" "^ ")
395 "List of character syntaxes used to find a trigger key before point.
396 The list is tried in the order while scanning characters
397 backwards from point. For example, if the list is '(\"w\" \"w_\")
398 first look for trigger keys which are composed exclusively of
399 \"word\"-syntax characters, and then, if that fails, look for
400 keys which are either of \"word\" or \"symbol\"
401 syntax. Triggering after
405 will, according to the \"w\" element first try \"bar\". If that
406 isn't a trigger key, \"foo-bar\" is tried, respecting a second
409 (defvar yas-after-exit-snippet-hook
411 "Hooks to run after a snippet exited.
413 The hooks will be run in an environment where some variables bound to
416 `yas-snippet-beg' : The beginning of the region of the snippet.
418 `yas-snippet-end' : Similar to beg.
420 Attention: These hooks are not run when exiting nested/stacked snippet expansion!")
422 (defvar yas-before-expand-snippet-hook
424 "Hooks to run just before expanding a snippet.")
426 (defvar yas-buffer-local-condition
427 '(if (and (or (fourth (syntax-ppss))
428 (fifth (syntax-ppss)))
430 (eq this-command 'yas-expand-from-trigger-key))
431 '(require-snippet-condition . force-in-comment)
433 "Snippet expanding condition.
435 This variable is a Lisp form which is evaluated every time a
436 snippet expansion is attempted:
438 * If it evaluates to nil, no snippets can be expanded.
440 * If it evaluates to the a cons (require-snippet-condition
443 * Snippets bearing no \"# condition:\" directive are not
446 * Snippets bearing conditions that evaluate to nil (or
447 produce an error) won't be considered.
449 * If the snippet has a condition that evaluates to non-nil
452 * If REQUIREMENT is t, the snippet is considered
454 * If REQUIREMENT is `eq' RESULT, the snippet is
457 * Otherwise, the snippet is not considered.
459 * If it evaluates to the symbol 'always, all snippets are
460 considered for expansion, regardless of any conditions.
462 * If it evaluates to t or some other non-nil value
464 * Snippet bearing no conditions, or conditions that
465 evaluate to non-nil, are considered for expansion.
467 * Otherwise, the snippet is not considered.
469 Here's an example preventing snippets from being expanded from
470 inside comments, in `python-mode' only, with the exception of
471 snippets returning the symbol 'force-in-comment in their
474 (add-hook 'python-mode-hook
476 (setq yas-buffer-local-condition
477 '(if (python-in-string/comment)
478 '(require-snippet-condition . force-in-comment)
481 The default value is similar, it filters out potential snippet
482 expansions inside comments and string literals, unless the
483 snippet itself contains a condition that returns the symbol
484 `force-in-comment'.")
487 ;;; Internal variables
489 (defvar yas--version "0.8.0beta")
491 (defvar yas--menu-table (make-hash-table)
492 "A hash table of MAJOR-MODE symbols to menu keymaps.")
494 (defvar yas--known-modes
495 '(ruby-mode rst-mode markdown-mode)
496 "A list of mode which is well known but not part of Emacs.")
498 (defvar yas--escaped-characters
499 '(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
500 "List of characters which *might* need to be escaped.")
502 (defconst yas--field-regexp
503 "${\\([0-9]+:\\)?\\([^}]*\\)}"
504 "A regexp to *almost* recognize a field.")
506 (defconst yas--multi-dollar-lisp-expression-regexp
507 "$+[ \t\n]*\\(([^)]*)\\)"
508 "A regexp to *almost* recognize a \"$(...)\" expression.")
510 (defconst yas--backquote-lisp-expression-regexp
512 "A regexp to recognize a \"`lisp-expression`\" expression." )
514 (defconst yas--transform-mirror-regexp
515 "${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
516 "A regexp to *almost* recognize a mirror with a transform.")
518 (defconst yas--simple-mirror-regexp
520 "A regexp to recognize a simple mirror.")
522 (defvar yas--snippet-id-seed 0
523 "Contains the next id for a snippet.")
525 (defun yas--snippet-next-id ()
526 (let ((id yas--snippet-id-seed))
527 (incf yas--snippet-id-seed)
533 ;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
534 (defvar last-buffer-undo-list nil)
536 (defvar yas--minor-mode-menu nil
537 "Holds the YASnippet menu.")
539 (defun yas--init-minor-keymap ()
540 "Set up the `yas-minor-mode' keymap."
541 (let ((map (make-sparse-keymap)))
543 (easy-menu-define yas--minor-mode-menu
545 "Menu used when `yas-minor-mode' is active."
548 ["Expand trigger" yas-expand
549 :help "Possibly expand tab trigger before point"]
550 ["Insert at point..." yas-insert-snippet
551 :help "Prompt for an expandable snippet and expand it at point"]
552 ["New snippet..." yas-new-snippet
553 :help "Create a new snippet in an appropriate directory"]
554 ["Visit snippet file..." yas-visit-snippet-file
555 :help "Prompt for an expandable snippet and find its file"]
557 ("Snippet menu behaviour"
558 ["Visit snippets" (setq yas-visit-from-menu t)
559 :help "Visit snippets from the menu"
560 :active t :style radio :selected yas-visit-from-menu]
561 ["Expand snippets" (setq yas-visit-from-menu nil)
562 :help "Expand snippets from the menu"
563 :active t :style radio :selected (not yas-visit-from-menu)]
565 ["Show all known modes" (setq yas-use-menu 'full)
566 :help "Show one snippet submenu for each loaded table"
567 :active t :style radio :selected (eq yas-use-menu 'full)]
568 ["Abbreviate according to current mode" (setq yas-use-menu 'abbreviate)
569 :help "Show only snippet submenus for the current active modes"
570 :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
572 ["Auto" (setq yas-indent-line 'auto)
573 :help "Indent each line of the snippet with `indent-according-to-mode'"
574 :active t :style radio :selected (eq yas-indent-line 'auto)]
575 ["Fixed" (setq yas-indent-line 'fixed)
576 :help "Indent the snippet to the current column"
577 :active t :style radio :selected (eq yas-indent-line 'fixed)]
578 ["None" (setq yas-indent-line 'none)
579 :help "Don't apply any particular snippet indentation after expansion"
580 :active t :style radio :selected (not (member yas-indent-line '(fixed auto)))]
582 ["Also auto indent first line" (setq yas-also-auto-indent-first-line
583 (not yas-also-auto-indent-first-line))
584 :help "When auto-indenting also, auto indent the first line menu"
585 :active (eq yas-indent-line 'auto)
586 :style toggle :selected yas-also-auto-indent-first-line]
589 ["System X-widget" (setq yas-prompt-functions
591 (remove 'yas-x-prompt
592 yas-prompt-functions)))
593 :help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
594 :active t :style radio :selected (eq (car yas-prompt-functions)
596 ["Dropdown-list" (setq yas-prompt-functions
597 (cons 'yas-dropdown-prompt
598 (remove 'yas-dropdown-prompt
599 yas-prompt-functions)))
600 :help "Use a special dropdown list"
601 :active t :style radio :selected (eq (car yas-prompt-functions)
602 'yas-dropdown-prompt)]
603 ["Ido" (setq yas-prompt-functions
604 (cons 'yas-ido-prompt
605 (remove 'yas-ido-prompt
606 yas-prompt-functions)))
607 :help "Use an ido-style minibuffer prompt"
608 :active t :style radio :selected (eq (car yas-prompt-functions)
610 ["Completing read" (setq yas-prompt-functions
611 (cons 'yas-completing-prompt
612 (remove 'yas-completing-prompt
613 yas-prompt-functions)))
614 :help "Use a normal minibuffer prompt"
615 :active t :style radio :selected (eq (car yas-prompt-functions)
616 'yas-completing-prompt)]
619 ["Wrap region in exit marker"
620 (setq yas-wrap-around-region
621 (not yas-wrap-around-region))
622 :help "If non-nil automatically wrap the selected text in the $0 snippet exit"
623 :style toggle :selected yas-wrap-around-region]
624 ["Allow stacked expansions "
625 (setq yas-triggers-in-field
626 (not yas-triggers-in-field))
627 :help "If non-nil allow snippets to be triggered inside other snippet fields"
628 :style toggle :selected yas-triggers-in-field]
629 ["Revive snippets on undo "
630 (setq yas-snippet-revival
631 (not yas-snippet-revival))
632 :help "If non-nil allow snippets to become active again after undo"
633 :style toggle :selected yas-snippet-revival]
636 (not yas-good-grace))
637 :help "If non-nil don't raise errors in bad embedded elisp in snippets"
638 :style toggle :selected yas-good-grace]
641 ["Load snippets..." yas-load-directory
642 :help "Load snippets from a specific directory"]
643 ["Reload everything" yas-reload-all
644 :help "Cleanup stuff, reload snippets, rebuild menus"]
646 :help "Display some information about YASnippet"])))
648 ;; Now for the stuff that has direct keybindings
650 (define-key map [(tab)] 'yas-expand)
651 (define-key map (kbd "TAB") 'yas-expand)
652 (define-key map "\C-c&\C-s" 'yas-insert-snippet)
653 (define-key map "\C-c&\C-n" 'yas-new-snippet)
654 (define-key map "\C-c&\C-v" 'yas-visit-snippet-file)
657 (defvar yas-minor-mode-map (yas--init-minor-keymap)
658 "The keymap used when `yas-minor-mode' is active.")
660 (defvar yas--extra-modes nil
661 "An internal list of modes for which to also lookup snippets.
663 This variable probably makes more sense as buffer-local, so
664 ensure your use `make-local-variable' when you set it.")
665 (define-obsolete-variable-alias 'yas-extra-modes 'yas--extra-modes "0.8.1")
667 (defvar yas--tables (make-hash-table)
668 "A hash table of mode symbols to `yas--table' objects.")
670 (defvar yas--parents (make-hash-table)
671 "A hash table of mode symbols do lists of direct parent mode symbols.
673 This list is populated when reading the \".yas-parents\" files
674 found when traversing snippet directories with
675 `yas-load-directory'.
677 There might be additional parenting information stored in the
678 `derived-mode-parent' property of some mode symbols, but that is
681 (defvar yas--direct-keymaps (list)
682 "Keymap alist supporting direct snippet keybindings.
684 This variable is placed in `emulation-mode-map-alists'.
686 Its elements looks like (TABLE-NAME . KEYMAP). They're
687 instantiated on `yas-reload-all' but KEYMAP is added to only when
688 loading snippets. `yas--direct-TABLE-NAME' is then a variable set
689 buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
690 defined direct keybindings to the command
691 `yas-expand-from-keymap' which then which snippet to expand.")
693 (defun yas-direct-keymaps-reload ()
694 "Force reload the direct keybinding for active snippet tables."
696 (setq yas--direct-keymaps nil)
697 (maphash #'(lambda (name table)
698 (push (cons (intern (format "yas--direct-%s" name))
699 (yas--table-direct-keymap table))
700 yas--direct-keymaps))
703 (defun yas--modes-to-activate ()
704 "Compute list of mode symbols that are active for `yas-expand'
707 (setq dfs (lambda (mode &optional explored)
711 in (remove nil (cons (get mode
712 'derived-mode-parent)
713 (gethash mode yas--parents)))
715 unless (memq neighbour explored)
716 append (funcall dfs neighbour explored)))))
717 (remove-duplicates (append yas--extra-modes
718 (funcall dfs major-mode)))))
720 (defvar yas-minor-mode-hook nil
721 "Hook run when `yas-minor-mode' is turned on.")
724 (define-minor-mode yas-minor-mode
725 "Toggle YASnippet mode.
727 When YASnippet mode is enabled, `yas-expand', normally bound to
728 the TAB key, expands snippets of code depending on the major
731 With no argument, this command toggles the mode.
732 positive prefix argument turns on the mode.
733 Negative prefix argument turns off the mode.
736 \\{yas-minor-mode-map}"
738 ;; The indicator for the mode line.
741 (cond (yas-minor-mode
742 ;; Install the direct keymaps in `emulation-mode-map-alists'
743 ;; (we use `add-hook' even though it's not technically a hook,
744 ;; but it works). Then define variables named after modes to
745 ;; index `yas--direct-keymaps'.
747 ;; Also install the post-command-hook.
749 (add-hook 'emulation-mode-map-alists 'yas--direct-keymaps)
750 (add-hook 'post-command-hook 'yas--post-command-handler nil t)
751 ;; Set the `yas--direct-%s' vars for direct keymap expansion
753 (dolist (mode (yas--modes-to-activate))
754 (let ((name (intern (format "yas--direct-%s" mode))))
755 (set-default name nil)
756 (set (make-local-variable name) t)))
759 (yas--load-pending-jits))
761 ;; Uninstall the direct keymaps and the post-command hook
763 (remove-hook 'post-command-hook 'yas--post-command-handler t)
764 (remove-hook 'emulation-mode-map-alists 'yas--direct-keymaps))))
766 (defun yas-activate-extra-mode (mode)
767 "Activates the snippets for the given `mode' in the buffer.
769 The function can be called in the hook of a minor mode to
770 activate snippets associated with that mode."
774 (maphash (lambda (k _)
775 (setq modes (cons (list k) modes)))
777 (setq symbol (completing-read
778 "Activate mode: " modes nil t))
780 (when (not (string= "" symbol))
783 (add-to-list (make-local-variable 'yas--extra-modes) mode)
784 (yas--load-pending-jits)))
786 (defun yas-deactivate-extra-mode (mode)
787 "Deactivates the snippets for the given `mode' in the buffer."
791 "Deactivate mode: " (mapcar #'list yas--extra-modes) nil t))))
792 (set (make-local-variable 'yas--extra-modes)
796 (defvar yas-dont-activate '(minibufferp)
797 "If non-nil don't let `yas-global-mode' affect some buffers.
799 If a function of zero arguments, then its result is used.
801 If a list of functions, then all functions must return nil to
802 activate yas for this buffer.
804 In Emacsen <= 23, this variable is buffer-local. Because
805 `yas-minor-mode-on' is called by `yas-global-mode' after
806 executing the buffer's major mode hook, setting this variable
807 there is an effective way to define exceptions to the \"global\"
808 activation behaviour.
810 In Emacsen > 23, only the global value is used. To define
811 per-mode exceptions to the \"global\" activation behaviour, call
812 `yas-minor-mode' with a negative argument directily in the major
814 (unless (> emacs-major-version 23)
816 (make-variable-buffer-local 'yas-dont-activate)))
819 (defun yas-minor-mode-on ()
820 "Turn on YASnippet minor mode.
822 Honour `yas-dont-activate', which see."
824 ;; Check `yas-dont-activate'
825 (unless (cond ((functionp yas-dont-activate)
826 (funcall yas-dont-activate))
827 ((consp yas-dont-activate)
828 (some #'funcall yas-dont-activate))
833 (define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
837 (defun yas--global-mode-reload-with-jit-maybe ()
838 "Run `yas-reload-all' when `yas-global-mode' is on."
839 (when yas-global-mode (yas-reload-all)))
841 (add-hook 'yas-global-mode-hook 'yas--global-mode-reload-with-jit-maybe)
846 (defvar yas--font-lock-keywords
847 (append '(("^#.*$" . font-lock-comment-face))
848 lisp-font-lock-keywords-2
850 (0 font-lock-keyword-face)
851 (1 font-lock-string-face t))
853 (0 font-lock-keyword-face)
854 (1 font-lock-warning-face t))
855 ("${" . font-lock-keyword-face)
856 ("$[0-9]+?" . font-lock-preprocessor-face)
857 ("\\(\\$(\\)" 1 font-lock-preprocessor-face)
859 (0 font-lock-keyword-face)))))
861 (defvar snippet-mode-map
862 (let ((map (make-sparse-keymap)))
863 (easy-menu-define nil
865 "Menu used when snippet-mode is active."
867 (mapcar #'(lambda (ent)
869 (define-key map (third ent) (second ent)))
870 (vector (first ent) (second ent) t))
871 '(("Load this snippet" yas-load-snippet-buffer "\C-c\C-l")
872 ("Load and quit window" yas-load-snippet-buffer-and-close "\C-c\C-c")
873 ("Try out this snippet" yas-tryout-snippet "\C-c\C-t")))))
875 "The keymap used when `snippet-mode' is active.")
878 (define-derived-mode snippet-mode text-mode "Snippet"
879 "A mode for editing yasnippets"
880 (setq font-lock-defaults '(yas--font-lock-keywords))
881 (set (make-local-variable 'require-final-newline) nil)
882 (set (make-local-variable 'comment-start) "#")
883 (set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
887 ;;; Internal structs for template management
889 (defstruct (yas--template (:constructor yas--make-blank-template))
890 "A template for a snippet."
900 group ;; as dictated by the #group: directive or .yas-make-groups
901 perm-group ;; as dictated by `yas-define-menu'
905 (defun yas--populate-template (template &rest args)
906 "Helper function to populate TEMPLATE with properties."
909 (position (intern (substring (symbol-name (car args)) 1))
910 (mapcar #'car (get 'yas--template 'cl-struct-slots)))
912 (setq args (cddr args)))
915 (defstruct (yas--table (:constructor yas--make-snippet-table (name)))
916 "A table to store snippets for a particular mode.
918 Has the following fields:
922 A symbol name normally corresponding to a major mode, but can
923 also be a pseudo major-mode to be used in
924 `yas-activate-extra-mode', for example.
928 A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
929 a string or a vector, where the former is the snippet's trigger
930 and the latter means it's a direct keybinding. NAMEHASH is yet
931 another hash of (NAME . TEMPLATE) where NAME is the snippet's
932 name and TEMPLATE is a `yas--template' object.
934 `yas--table-direct-keymap'
936 A keymap for the snippets in this table that have direct
937 keybindings. This is kept in sync with the keyhash, i.e., all
938 the elements of the keyhash that are vectors appear here as
939 bindings to `yas-expand-from-keymap'.
941 `yas--table-uuidhash'
943 A hash table mapping snippets uuid's to the same `yas--template'
944 objects. A snippet uuid defaults to the snippet's name."
946 (hash (make-hash-table :test 'equal))
947 (uuidhash (make-hash-table :test 'equal))
949 (direct-keymap (make-sparse-keymap)))
951 (defun yas--get-template-by-uuid (mode uuid)
952 "Find the snippet template in MODE by its UUID."
953 (let* ((table (gethash mode yas--tables mode)))
955 (gethash uuid (yas--table-uuidhash table)))))
957 ;; Apropos storing/updating in TABLE, this works in two steps:
959 ;; 1. `yas--remove-template-by-uuid' removes any
960 ;; keyhash-namehash-template mappings from TABLE, grabbing the
961 ;; snippet by its uuid. Also removes mappings from TABLE's
962 ;; `yas--table-direct-keymap' (FIXME: and should probably take care
963 ;; of potentially stale menu bindings right?.)
965 ;; 2. `yas--add-template' adds this all over again.
967 ;; Create a new or add to an existing keyhash-namehash mapping.
969 ;; For reference on understanding this, consider three snippet
972 ;; A: # name: The Foo
974 ;; # binding: C-c M-l
976 ;; B: # name: Mrs Foo
979 ;; C: # name: The Bar
980 ;; # binding: C-c M-l
985 ;; keyhash namehashes(3) yas--template structs(4)
986 ;; -----------------------------------------------------
989 ;; "foo" ---> "The Foo" ---> [yas--template A] |
990 ;; "Mrs Foo" ---> [yas--template B] |
992 ;; [C-c M-l] ---> "The Foo" -------------------------/
993 ;; "The Bar" ---> [yas--template C]
995 ;; "baz" ---> "Baz" ---> [yas--template D]
997 ;; Additionally, since uuid defaults to the name, we have a
998 ;; `yas--table-uuidhash' for TABLE
1000 ;; uuidhash yas--template structs
1001 ;; -------------------------------
1002 ;; "The Foo" ---> [yas--template A]
1003 ;; "Mrs Foo" ---> [yas--template B]
1004 ;; "The Bar" ---> [yas--template C]
1005 ;; "Baz" ---> [yas--template D]
1007 ;; FIXME: the more I look at this data-structure the more I think I'm
1008 ;; stupid. There has to be an easier way (but beware lots of code
1009 ;; depends on this).
1011 (defun yas--remove-template-by-uuid (table uuid)
1012 "Remove from TABLE a template identified by UUID."
1013 (let ((template (gethash uuid (yas--table-uuidhash table))))
1015 (let* ((name (yas--template-name template))
1017 ;; Remove the name from each of the targeted namehashes
1019 (maphash #'(lambda (k v)
1020 (let ((template (gethash name v)))
1022 (eq uuid (yas--template-uuid template)))
1024 (when (zerop (hash-table-count v))
1025 (push k empty-keys)))))
1026 (yas--table-hash table))
1027 ;; Remove the namehash themselves if they've become empty
1029 (dolist (key empty-keys)
1031 (define-key (yas--table-direct-keymap table) key nil))
1032 (remhash key (yas--table-hash table)))
1034 ;; Finally, remove the uuid from the uuidhash
1036 (remhash uuid (yas--table-uuidhash table))))))
1038 (defun yas--add-template (table template)
1039 "Store in TABLE the snippet template TEMPLATE.
1041 KEY can be a string (trigger key) of a vector (direct
1043 (let ((name (yas--template-name template))
1044 (key (yas--template-key template))
1045 (keybinding (yas--template-keybinding template))
1046 (_menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
1047 (dolist (k (remove nil (list key keybinding)))
1051 (yas--table-hash table))
1053 (make-hash-table :test 'equal)
1054 (yas--table-hash table))))
1056 (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
1058 ;; Update TABLE's `yas--table-uuidhash'
1059 (puthash (yas--template-uuid template)
1061 (yas--table-uuidhash table))))
1063 (defun yas--update-template (table template)
1064 "Add or update TEMPLATE in TABLE.
1066 Also takes care of adding and updating to the associated menu."
1067 ;; Remove from table by uuid
1069 (yas--remove-template-by-uuid table (yas--template-uuid template))
1070 ;; Add to table again
1072 (yas--add-template table template)
1073 ;; Take care of the menu
1076 (yas--update-template-menu table template)))
1078 (defun yas--update-template-menu (table template)
1079 "Update every menu-related for TEMPLATE."
1080 (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
1081 (key (yas--template-key template))
1082 (keybinding (yas--template-keybinding template)))
1083 ;; The snippet might have changed name or keys, so update
1084 ;; user-visible strings
1086 (unless (eq (cdr menu-binding-pair) :none)
1087 ;; the menu item name
1089 (setf (cadar menu-binding-pair) (yas--template-name template))
1090 ;; the :keys information (also visible to the user)
1091 (setf (getf (cdr (car menu-binding-pair)) :keys)
1092 (or (and keybinding (key-description keybinding))
1093 (and key (concat key yas-trigger-symbol))))))
1094 (unless (yas--template-menu-managed-by-yas-define-menu template)
1096 (yas--menu-keymap-get-create (yas--table-mode table)
1097 (mapcar #'yas--table-mode
1098 (yas--table-parents table))))
1099 (group (yas--template-group template)))
1100 ;; Remove from menu keymap
1102 (assert menu-keymap)
1103 (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
1105 ;; Add necessary subgroups as necessary.
1107 (dolist (subgroup group)
1108 (let ((subgroup-keymap (lookup-key menu-keymap (vector (make-symbol subgroup)))))
1109 (unless (and subgroup-keymap
1110 (keymapp subgroup-keymap))
1111 (setq subgroup-keymap (make-sparse-keymap))
1112 (define-key menu-keymap (vector (make-symbol subgroup))
1113 `(menu-item ,subgroup ,subgroup-keymap)))
1114 (setq menu-keymap subgroup-keymap)))
1116 ;; Add this entry to the keymap
1118 (define-key menu-keymap
1119 (vector (make-symbol (yas--template-uuid template)))
1120 (car (yas--template-menu-binding-pair template))))))
1122 (defun yas--namehash-templates-alist (namehash)
1123 "Return NAMEHASH as an alist."
1125 (maphash #'(lambda (k v)
1126 (push (cons k v) alist))
1130 (defun yas--fetch (table key)
1131 "Fetch templates in TABLE by KEY.
1133 Return a list of cons (NAME . TEMPLATE) where NAME is a
1134 string and TEMPLATE is a `yas--template' structure."
1135 (let* ((keyhash (yas--table-hash table))
1136 (namehash (and keyhash (gethash key keyhash))))
1138 (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
1141 ;;; Filtering/condition logic
1143 (defun yas--eval-condition (condition)
1150 (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
1154 (defun yas--filter-templates-by-condition (templates)
1155 "Filter the templates using the applicable condition.
1157 TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
1158 string and TEMPLATE is a `yas--template' structure.
1160 This function implements the rules described in
1161 `yas-buffer-local-condition'. See that variables documentation."
1162 (let ((requirement (yas--require-template-specific-condition-p)))
1163 (if (eq requirement 'always)
1165 (remove-if-not #'(lambda (pair)
1166 (yas--template-can-expand-p
1167 (yas--template-condition (cdr pair)) requirement))
1170 (defun yas--require-template-specific-condition-p ()
1171 "Decide if this buffer requests/requires snippet-specific
1172 conditions to filter out potential expansions."
1173 (if (eq 'always yas-buffer-local-condition)
1175 (let ((local-condition (or (and (consp yas-buffer-local-condition)
1176 (yas--eval-condition yas-buffer-local-condition))
1177 yas-buffer-local-condition)))
1178 (when local-condition
1179 (if (eq local-condition t)
1181 (and (consp local-condition)
1182 (eq 'require-snippet-condition (car local-condition))
1183 (symbolp (cdr local-condition))
1184 (cdr local-condition)))))))
1186 (defun yas--template-can-expand-p (condition requirement)
1187 "Evaluate CONDITION and REQUIREMENT and return a boolean."
1188 (let* ((result (or (null condition)
1189 (yas--eval-condition condition))))
1190 (cond ((eq requirement t)
1193 (eq requirement result)))))
1195 (defun yas--table-templates (table)
1198 (maphash #'(lambda (_key namehash)
1199 (maphash #'(lambda (name template)
1200 (push (cons name template) acc))
1202 (yas--table-hash table))
1203 (yas--filter-templates-by-condition acc))))
1205 (defun yas--current-key ()
1206 "Get the key under current position.
1207 A key is used to find the template of a snippet in the current snippet-table."
1208 (let ((start (point))
1210 (syntaxes yas-key-syntaxes)
1214 (while (and (not done) syntaxes)
1215 (setq syntax (car syntaxes))
1216 (setq syntaxes (cdr syntaxes))
1218 (skip-syntax-backward syntax)
1219 (setq start (point)))
1221 (mapcan #'(lambda (table)
1222 (yas--fetch table (buffer-substring-no-properties start end)))
1223 (yas--get-snippet-tables)))
1232 (defun yas--table-all-keys (table)
1233 "Get trigger keys of all active snippets in TABLE."
1235 (maphash #'(lambda (key namehash)
1236 (when (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash))
1238 (yas--table-hash table))
1241 (defun yas--table-mode (table)
1242 (intern (yas--table-name table)))
1245 ;;; Internal functions and macros:
1247 (defun yas--real-mode? (mode)
1248 "Try to find out if MODE is a real mode.
1250 The MODE bound to a function (like `c-mode') is considered real
1251 mode. Other well known mode like `ruby-mode' which is not part of
1252 Emacs might not bound to a function until it is loaded. So
1253 yasnippet keeps a list of modes like this to help the judgment."
1255 (find mode yas--known-modes)))
1257 (defun yas--eval-lisp (form)
1258 "Evaluate FORM and convert the result to string."
1259 (let ((retval (catch 'yas--exception
1265 (let ((result (eval form)))
1267 (format "%s" result))))))
1268 (error (if yas-good-grace
1269 (yas--format "elisp error! %s" (error-message-string err))
1270 (error (yas--format "elisp error: %s"
1271 (error-message-string err)))))))))
1272 (when (and (consp retval)
1273 (eq 'yas--exception (car retval)))
1274 (error (cdr retval)))
1277 (defun yas--eval-lisp-no-saves (form)
1280 (error (if yas-good-grace
1281 (yas--format "elisp error! %s" (error-message-string err))
1282 (error (yas--format "elisp error: %s"
1283 (error-message-string err)))))))
1285 (defun yas--read-lisp (string &optional nil-on-error)
1286 "Read STRING as a elisp expression and return it.
1288 In case STRING in an invalid expression and NIL-ON-ERROR is nil,
1289 return an expression that when evaluated will issue an error."
1292 (error (and (not nil-on-error)
1293 `(error (error-message-string ,err))))))
1295 (defun yas--read-keybinding (keybinding)
1296 "Read KEYBINDING as a snippet keybinding, return a vector."
1297 (when (and keybinding
1298 (not (string-match "keybinding" keybinding)))
1300 (let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
1302 (read-kbd-macro keybinding 'need-vector))))
1305 (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
1306 keybinding (error-message-string err))
1309 (defun yas--table-get-create (mode)
1310 "Get or create the snippet table corresponding to MODE."
1311 (let ((table (gethash mode
1314 (setq table (yas--make-snippet-table (symbol-name mode)))
1315 (puthash mode table yas--tables)
1316 (push (cons (intern (format "yas--direct-%s" mode))
1317 (yas--table-direct-keymap table))
1318 yas--direct-keymaps))
1321 (defun yas--get-snippet-tables ()
1322 "Get snippet tables for current buffer.
1324 Return a list of `yas--table' objects. The list of modes to
1325 consider is returned by `yas--modes-to-activate'"
1327 (mapcar #'(lambda (name)
1328 (gethash name yas--tables))
1329 (yas--modes-to-activate))))
1331 (defun yas--menu-keymap-get-create (mode &optional parents)
1332 "Get or create the menu keymap for MODE and its PARENTS.
1334 This may very well create a plethora of menu keymaps and arrange
1335 them all in `yas--menu-table'"
1336 (let* ((menu-keymap (or (gethash mode yas--menu-table)
1337 (puthash mode (make-sparse-keymap) yas--menu-table))))
1338 (mapc #'yas--menu-keymap-get-create parents)
1339 (define-key yas--minor-mode-menu (vector mode)
1340 `(menu-item ,(symbol-name mode) ,menu-keymap
1341 :visible (yas--show-menu-p ',mode)))
1345 (defmacro yas--called-interactively-p (&optional kind)
1346 "A backward-compatible version of `called-interactively-p'.
1348 Optional KIND is as documented at `called-interactively-p'
1349 in GNU Emacs 24.1 or higher."
1350 (if (string< emacs-version "24.1")
1351 '(called-interactively-p)
1352 `(called-interactively-p ,kind)))
1355 ;;; Template-related and snippet loading functions
1357 (defun yas--parse-template (&optional file)
1358 "Parse the template in the current buffer.
1360 Optional FILE is the absolute file name of the file being
1363 Optional GROUP is the group where the template is to go,
1364 otherwise we attempt to calculate it from FILE.
1366 Return a snippet-definition, i.e. a list
1368 (KEY TEMPLATE NAME CONDITION GROUP VARS FILE KEYBINDING UUID)
1370 If the buffer contains a line of \"# --\" then the contents above
1371 this line are ignored. Directives can set most of these with the syntax:
1373 # directive-name : directive-value
1375 Here's a list of currently recognized directives:
1386 (goto-char (point-min))
1387 (let* ((type 'snippet)
1389 (file-name-nondirectory file)))
1395 (yas--calculate-group file)))
1399 (if (re-search-forward "^# --\n" nil t)
1400 (progn (setq template
1401 (buffer-substring-no-properties (point)
1403 (setq bound (point))
1404 (goto-char (point-min))
1405 (while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*\\)$" bound t)
1406 (when (string= "uuid" (match-string-no-properties 1))
1407 (setq uuid (match-string-no-properties 2)))
1408 (when (string= "type" (match-string-no-properties 1))
1409 (setq type (if (string= "command" (match-string-no-properties 2))
1412 (when (string= "key" (match-string-no-properties 1))
1413 (setq key (match-string-no-properties 2)))
1414 (when (string= "name" (match-string-no-properties 1))
1415 (setq name (match-string-no-properties 2)))
1416 (when (string= "condition" (match-string-no-properties 1))
1417 (setq condition (yas--read-lisp (match-string-no-properties 2))))
1418 (when (string= "group" (match-string-no-properties 1))
1419 (setq group (match-string-no-properties 2)))
1420 (when (string= "expand-env" (match-string-no-properties 1))
1421 (setq expand-env (yas--read-lisp (match-string-no-properties 2)
1423 (when (string= "binding" (match-string-no-properties 1))
1424 (setq binding (match-string-no-properties 2)))))
1426 (buffer-substring-no-properties (point-min) (point-max))))
1427 (unless (or key binding)
1428 (setq key (and file (file-name-nondirectory file))))
1429 (when (eq type 'command)
1430 (setq template (yas--read-lisp (concat "(progn" template ")"))))
1432 (setq group (split-string group "\\.")))
1433 (list key template name condition group expand-env file binding uuid)))
1435 (defun yas--calculate-group (file)
1436 "Calculate the group for snippet file path FILE."
1437 (let* ((dominating-dir (locate-dominating-file file
1438 ".yas-make-groups"))
1439 (extra-path (and dominating-dir
1440 (replace-regexp-in-string (concat "^"
1441 (expand-file-name dominating-dir))
1443 (expand-file-name file))))
1444 (extra-dir (and extra-path
1445 (file-name-directory extra-path)))
1446 (group (and extra-dir
1447 (replace-regexp-in-string "/"
1449 (directory-file-name extra-dir)))))
1452 (defun yas--subdirs (directory &optional filep)
1453 "Return subdirs or files of DIRECTORY according to FILEP."
1454 (remove-if (lambda (file)
1455 (or (string-match "^\\."
1456 (file-name-nondirectory file))
1457 (string-match "^#.*#$"
1458 (file-name-nondirectory file))
1460 (file-name-nondirectory file))
1462 (file-directory-p file)
1463 (not (file-directory-p file)))))
1464 (directory-files directory t)))
1466 (defun yas--make-menu-binding (template)
1467 (let ((mode (yas--table-mode (yas--template-table template))))
1468 `(lambda () (interactive) (yas--expand-or-visit-from-menu ',mode ,(yas--template-uuid template)))))
1470 (defun yas--expand-or-visit-from-menu (mode uuid)
1471 (let* ((table (yas--table-get-create mode))
1472 (yas--current-template (and table
1473 (gethash uuid (yas--table-uuidhash table)))))
1474 (when yas--current-template
1475 (if yas-visit-from-menu
1476 (yas--visit-snippet-file-1 yas--current-template)
1477 (let ((where (if (region-active-p)
1478 (cons (region-beginning) (region-end))
1479 (cons (point) (point)))))
1480 (yas-expand-snippet (yas--template-content yas--current-template)
1483 (yas--template-expand-env yas--current-template)))))))
1485 (defun yas--key-from-desc (text)
1486 "Return a yasnippet key from a description string TEXT."
1487 (replace-regexp-in-string "\\(\\w+\\).*" "\\1" text))
1490 ;;; Popping up for keys and templates
1492 (defun yas--prompt-for-template (templates &optional prompt)
1493 "Interactively choose a template from the list TEMPLATES.
1495 TEMPLATES is a list of `yas--template'.
1497 Optional PROMPT sets the prompt to use."
1500 (sort templates #'(lambda (t1 t2)
1501 (< (length (yas--template-name t1))
1502 (length (yas--template-name t2))))))
1503 (some #'(lambda (fn)
1504 (funcall fn (or prompt "Choose a snippet: ")
1506 #'yas--template-name))
1507 yas-prompt-functions)))
1509 (defun yas--prompt-for-keys (keys &optional prompt)
1510 "Interactively choose a template key from the list KEYS.
1512 Optional PROMPT sets the prompt to use."
1514 (some #'(lambda (fn)
1515 (funcall fn (or prompt "Choose a snippet key: ") keys))
1516 yas-prompt-functions)))
1518 (defun yas--prompt-for-table (tables &optional prompt)
1519 "Interactively choose a table from the list TABLES.
1521 Optional PROMPT sets the prompt to use."
1523 (some #'(lambda (fn)
1524 (funcall fn (or prompt "Choose a snippet table: ")
1527 yas-prompt-functions)))
1529 (defun yas-x-prompt (prompt choices &optional display-fn)
1530 "Display choices in a x-window prompt."
1531 ;; FIXME: HACK: if we notice that one of the objects in choices is
1532 ;; actually a `yas--template', defer to `yas--x-prompt-pretty-templates'
1534 ;; This would be better implemented by passing CHOICES as a
1535 ;; structured tree rather than a list. Modifications would go as far
1536 ;; up as `yas--all-templates' I think.
1538 (when (and window-system choices)
1541 (if (fboundp 'posn-at-point)
1542 (let ((x-y (posn-x-y (posn-at-point (point)))))
1543 (list (list (+ (car x-y) 10)
1548 ,@(mapcar* (lambda (c d) `(,(concat " " d) . ,c))
1550 (if display-fn (mapcar display-fn choices) choices)))))
1553 (defun yas-ido-prompt (prompt choices &optional display-fn)
1554 (when (and (fboundp 'ido-completing-read)
1555 (or (>= emacs-major-version 24)
1557 (yas-completing-prompt prompt choices display-fn #'ido-completing-read)))
1559 (defun yas-dropdown-prompt (_prompt choices &optional display-fn)
1560 (when (fboundp 'dropdown-list)
1561 (let* ((formatted-choices
1562 (if display-fn (mapcar display-fn choices) choices))
1563 (n (dropdown-list formatted-choices)))
1564 (if n (nth n choices)
1567 (defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
1568 (let* ((formatted-choices
1569 (if display-fn (mapcar display-fn choices) choices))
1570 (chosen (funcall (or completion-fn #'completing-read)
1571 prompt formatted-choices
1572 nil 'require-match nil nil)))
1573 (if (eq choices formatted-choices)
1575 (nth (or (position chosen formatted-choices :test #'string=) 0)
1578 (defun yas-no-prompt (_prompt choices &optional _display-fn)
1582 ;;; Defining snippets
1583 ;; This consists of creating and registering `yas--template' objects in the
1587 (defvar yas--creating-compiled-snippets nil)
1589 (defun yas--define-snippets-1 (snippet snippet-table)
1590 "Helper for `yas-define-snippets'."
1591 ;; X) Calculate some more defaults on the values returned by
1592 ;; `yas--parse-template'.
1594 (let* ((file (seventh snippet))
1596 (name (or (third snippet)
1598 (file-name-directory file))))
1599 (condition (fourth snippet))
1600 (group (fifth snippet))
1601 (keybinding (yas--read-keybinding (eighth snippet)))
1602 (uuid (or (ninth snippet)
1604 (template (or (gethash uuid (yas--table-uuidhash snippet-table))
1605 (yas--make-blank-template))))
1606 ;; X) populate the template object
1608 (yas--populate-template template
1609 :table snippet-table
1611 :content (second snippet)
1614 :condition condition
1615 :expand-env (sixth snippet)
1616 :file (seventh snippet)
1617 :keybinding keybinding
1619 ;; X) Update this template in the appropriate table. This step
1620 ;; also will take care of adding the key indicators in the
1621 ;; templates menu entry, if any
1623 (yas--update-template snippet-table template)
1624 ;; X) Return the template
1629 (defun yas-define-snippets (mode snippets)
1630 "Define SNIPPETS for MODE.
1632 SNIPPETS is a list of snippet definitions, each taking the
1635 (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV FILE KEYBINDING UUID)
1637 Within these, only KEY and TEMPLATE are actually mandatory.
1639 TEMPLATE might be a Lisp form or a string, depending on whether
1640 this is a snippet or a snippet-command.
1642 CONDITION, EXPAND-ENV and KEYBINDING are Lisp forms, they have
1643 been `yas--read-lisp'-ed and will eventually be
1644 `yas--eval-lisp'-ed.
1646 The remaining elements are strings.
1648 FILE is probably of very little use if you're programatically
1651 UUID is the snippets \"unique-id\". Loading a second snippet file
1652 with the same uuid replaced the previous snippet.
1654 You can use `yas--parse-template' to return such lists based on
1655 the current buffers contents."
1656 (if yas--creating-compiled-snippets
1658 (insert ";;; Snippet definitions:\n;;;\n")
1659 (let ((literal-snippets (list))
1661 (dolist (snippet snippets)
1662 (let ((key (nth 0 snippet))
1663 (template-content (nth 1 snippet))
1664 (name (nth 2 snippet))
1665 (condition (nth 3 snippet))
1666 (group (nth 4 snippet))
1667 (expand-env (nth 5 snippet))
1668 (file nil) ;; omit on purpose
1669 (binding (nth 7 snippet))
1670 (uuid (nth 8 snippet)))
1681 (insert (pp-to-string
1682 `(yas-define-snippets ',mode ',literal-snippets)))
1685 (let ((snippet-table (yas--table-get-create mode))
1687 (dolist (snippet snippets)
1688 (setq template (yas--define-snippets-1 snippet
1693 ;;; Loading snippets from files
1695 (defun yas--load-yas-setup-file (file)
1696 (if (not yas--creating-compiled-snippets)
1698 (load file 'noerror)
1699 (let ((elfile (concat file ".el")))
1700 (when (file-exists-p elfile)
1701 (insert ";;; .yas-setup.el support file if any:\n;;;\n")
1702 (insert-file-contents elfile)
1703 (goto-char (point-max))))))
1705 (defun yas--define-parents (mode parents)
1706 "Add PARENTS to the list of MODE's parents."
1707 (puthash mode (remove-duplicates
1709 (gethash mode yas--parents)))
1712 (defun yas-load-directory (top-level-dir &optional use-jit interactive)
1713 "Load snippets in directory hierarchy TOP-LEVEL-DIR.
1715 Below TOP-LEVEL-DIR each directory should be a mode name.
1717 Optional USE-JIT use jit-loading of snippets."
1718 (interactive "DSelect the root directory: ni\np")
1719 (unless yas-snippet-dirs
1720 (setq yas-snippet-dirs top-level-dir))
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 (not (some #'(lambda (buffer)
1743 (with-current-buffer buffer
1744 ;; FIXME: Shouldn't this use derived-mode-p?
1745 (when (eq major-mode mode-sym)
1746 (yas--message 3 "Discovered there was already %s in %s" buffer mode-sym)
1749 (yas--schedule-jit mode-sym fun)
1752 (yas--message 3 "Loaded snippets from %s." top-level-dir)))
1754 (defun yas--load-directory-1 (directory mode-sym)
1755 "Recursively load snippet templates from DIRECTORY."
1756 (if yas--creating-compiled-snippets
1757 (let ((output-file (expand-file-name ".yas-compiled-snippets.el"
1759 (with-temp-file output-file
1760 (insert (format ";;; Compiled snippets and support files for `%s'\n"
1762 (yas--load-directory-2 directory mode-sym)
1763 (insert (format ";;; Do not edit! File generated at %s\n"
1764 (current-time-string)))))
1766 (unless (file-exists-p (concat directory "/" ".yas-skip"))
1767 (if (and (progn (yas--message 2 "Loading compiled snippets from %s" directory) t)
1768 (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3)))
1769 (yas--message 2 "Loading snippet files from %s" directory)
1770 (yas--load-directory-2 directory mode-sym)))))
1772 (defun yas--load-directory-2 (directory mode-sym)
1773 ;; Load .yas-setup.el files wherever we find them
1775 (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
1776 (let* ((default-directory directory)
1778 ;; load the snippet files
1781 (dolist (file (yas--subdirs directory 'no-subdirs-just-files))
1782 (when (file-readable-p file)
1783 (insert-file-contents file nil nil nil t)
1784 (push (yas--parse-template file)
1787 (yas-define-snippets mode-sym
1789 ;; now recurse to a lower level
1791 (dolist (subdir (yas--subdirs directory))
1792 (yas--load-directory-2 subdir
1795 (defun yas--load-snippet-dirs (&optional nojit)
1796 "Reload the directories listed in `yas-snippet-dirs' or
1797 prompt the user to select one."
1799 (if yas-snippet-dirs
1800 (dolist (directory (reverse (yas-snippet-dirs)))
1801 (cond ((file-directory-p directory)
1802 (yas-load-directory directory (not nojit))
1804 (yas--message 3 "Loaded %s" directory)
1805 (yas--message 3 "Prepared just-in-time loading for %s" directory)))
1807 (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors))))
1808 (call-interactively 'yas-load-directory))
1811 (defun yas-reload-all (&optional interactive)
1812 "Reload all snippets and rebuild the YASnippet menu.
1814 When called interactively force immediate reload of all known
1815 snippets under `yas-snippet-dirs', otherwise use just-in-time
1820 (snippet-editing-buffers
1821 (remove-if-not #'(lambda (buffer)
1822 (with-current-buffer buffer yas--editing-template))
1824 ;; Warn if there are buffers visiting snippets, since reloading will break
1825 ;; any on-line editing of those buffers.
1827 (when snippet-editing-buffers
1829 (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
1830 (mapc #'kill-buffer snippet-editing-buffers)
1831 (yas--message 1 "Aborted reload...")
1833 ;; in a non-interactive use, at least set
1834 ;; `yas--editing-template' to nil, make it guess it next time around
1835 (mapc #'(lambda (buffer)
1836 (with-current-buffer buffer
1837 (kill-local-variable 'yas--editing-template)))
1840 ;; Empty all snippet tables and parenting info
1842 (setq yas--tables (make-hash-table))
1843 (setq yas--parents (make-hash-table))
1845 ;; Before killing `yas--menu-table' use its keys to cleanup the
1846 ;; mode menu parts of `yas--minor-mode-menu' (thus also cleaning
1847 ;; up `yas-minor-mode-map', which points to it)
1849 (maphash #'(lambda (menu-symbol _keymap)
1850 (define-key yas--minor-mode-menu (vector menu-symbol) nil))
1852 ;; Now empty `yas--menu-table' as well
1853 (setq yas--menu-table (make-hash-table))
1855 ;; Cancel all pending 'yas--scheduled-jit-loads'
1857 (setq yas--scheduled-jit-loads (make-hash-table))
1859 ;; Reload the directories listed in `yas-snippet-dirs' or prompt
1860 ;; the user to select one.
1862 (setq errors (yas--load-snippet-dirs interactive))
1863 ;; Reload the direct keybindings
1865 (yas-direct-keymaps-reload)
1867 (run-hooks 'yas-after-reload-hook)
1868 (yas--message 3 "Reloaded everything%s...%s."
1869 (if interactive "" " (snippets will load just-in-time)")
1870 (if errors " (some errors, check *Messages*)" "")))))
1872 (defvar yas-after-reload-hook nil
1873 "Hooks run after `yas-reload-all'.")
1875 (defun yas--load-pending-jits ()
1876 (dolist (mode (yas--modes-to-activate))
1877 (let ((funs (reverse (gethash mode yas--scheduled-jit-loads))))
1878 ;; must reverse to maintain coherence with `yas-snippet-dirs'
1880 (yas--message 3 "Loading for `%s', just-in-time: %s!" mode fun)
1882 (remhash mode yas--scheduled-jit-loads))))
1884 ;; (when (<= emacs-major-version 22)
1885 ;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
1887 (defun yas--quote-string (string)
1888 "Escape and quote STRING.
1889 foo\"bar\\! -> \"foo\\\"bar\\\\!\""
1891 (replace-regexp-in-string "[\\\"]"
1897 ;;; Snippet compilation function
1899 (defun yas--initialize ()
1900 "For backward compatibility, enable `yas-minor-mode' globally."
1901 (yas-global-mode 1))
1903 (defun yas-compile-directory (top-level-dir)
1904 "Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
1906 This works by stubbing a few functions, then calling
1907 `yas-load-directory'."
1908 (interactive "DTop level snippet directory?")
1909 (let ((yas--creating-compiled-snippets t))
1910 (yas-load-directory top-level-dir nil)))
1912 (defun yas-recompile-all ()
1913 "Compile every dir in `yas-snippet-dirs'."
1915 (mapc #'yas-compile-directory (yas-snippet-dirs)))
1921 (defvar yas--scheduled-jit-loads (make-hash-table)
1922 "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
1924 (defun yas--schedule-jit (mode fun)
1925 (push fun (gethash mode yas--scheduled-jit-loads)))
1929 ;;; Some user level functions
1933 (message (concat "yasnippet (version "
1935 ") -- pluskid <pluskid@gmail.com>/joaotavora <joaotavora@gmail.com>")))
1938 ;;; Apropos snippet menu:
1940 ;; The snippet menu keymaps are store by mode in hash table called
1941 ;; `yas--menu-table'. They are linked to the main menu in
1942 ;; `yas--menu-keymap-get-create' and are initially created empty,
1943 ;; reflecting the table hierarchy.
1945 ;; They can be populated in two mutually exclusive ways: (1) by
1946 ;; reading `yas--template-group', which in turn is populated by the "#
1947 ;; group:" directives of the snippets or the ".yas-make-groups" file
1948 ;; or (2) by using a separate `yas-define-menu' call, which declares a
1949 ;; menu structure based on snippets uuids.
1951 ;; Both situations are handled in `yas--update-template-menu', which
1952 ;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
1953 ;; that can tell between the two situations.
1957 ;; * if `yas-define-menu' is used it must run before
1958 ;; `yas-define-snippets' and the UUIDS must match, otherwise we get
1959 ;; duplicate entries. The `yas--template' objects are created in
1960 ;; `yas-define-menu', holding nothing but the menu entry,
1961 ;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
1962 ;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
1963 ;; part is then stored in the menu keymap itself which make the item
1964 ;; appear to the user. These limitations could probably be revised.
1966 ;; * The `yas--template-perm-group' slot is only used in
1967 ;; `yas-describe-tables'.
1969 (defun yas--template-menu-binding-pair-get-create (template &optional type)
1970 "Get TEMPLATE's menu binding or assign it a new one.
1972 TYPE may be `:stay', signaling this menu binding should be
1973 static in the menu."
1974 (or (yas--template-menu-binding-pair template)
1975 (let (;; (key (yas--template-key template))
1976 ;; (keybinding (yas--template-keybinding template))
1978 (setf (yas--template-menu-binding-pair template)
1979 (cons `(menu-item ,(or (yas--template-name template)
1980 (yas--template-uuid template))
1981 ,(yas--make-menu-binding template)
1984 (defun yas--template-menu-managed-by-yas-define-menu (template)
1985 "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
1986 (cdr (yas--template-menu-binding-pair template)))
1989 (defun yas--show-menu-p (mode)
1990 (cond ((eq yas-use-menu 'abbreviate)
1992 (mapcar #'(lambda (table)
1993 (yas--table-mode table))
1994 (yas--get-snippet-tables))))
1995 ((eq yas-use-menu 'full)
1997 ((eq yas-use-menu t)
2000 (defun yas--delete-from-keymap (keymap uuid)
2001 "Recursively delete items with UUID from KEYMAP and its submenus."
2003 ;; XXX: This used to skip any submenus named \"parent mode\"
2005 ;; First of all, recursively enter submenus, i.e. the tree is
2006 ;; searched depth first so that stale submenus can be found in the
2009 (mapc #'(lambda (item)
2010 (when (and (listp (cdr item))
2011 (keymapp (third (cdr item))))
2012 (yas--delete-from-keymap (third (cdr item)) uuid)))
2014 ;; Set the uuid entry to nil
2016 (define-key keymap (vector (make-symbol uuid)) nil)
2017 ;; Destructively modify keymap
2019 (setcdr keymap (delete-if #'(lambda (item)
2020 (or (null (cdr item))
2021 (and (keymapp (third (cdr item)))
2022 (null (cdr (third (cdr item)))))))
2025 (defun yas-define-menu (mode menu &optional omit-items)
2026 "Define a snippet menu for MODE according to MENU, omitting OMIT-ITEMS.
2028 MENU is a list, its elements can be:
2030 - (yas-item UUID) : Creates an entry the snippet identified with
2031 UUID. The menu entry for a snippet thus identified is
2032 permanent, i.e. it will never move (be reordered) in the menu.
2034 - (yas-separator) : Creates a separator
2036 - (yas-submenu NAME SUBMENU) : Creates a submenu with NAME,
2037 SUBMENU has the same form as MENU. NAME is also added to the
2038 list of groups of the snippets defined thereafter.
2040 OMIT-ITEMS is a list of snippet uuid's that will always be
2041 omitted from MODE's menu, even if they're manually loaded.
2043 This function does nothing if `yas-use-menu' is nil."
2045 (let* ((table (yas--table-get-create mode))
2046 (hash (yas--table-uuidhash table)))
2047 (yas--define-menu-1 table
2048 (yas--menu-keymap-get-create mode)
2051 (dolist (uuid omit-items)
2052 (let ((template (or (gethash uuid hash)
2053 (yas--populate-template (puthash uuid
2054 (yas--make-blank-template)
2058 (setf (yas--template-menu-binding-pair template) (cons nil :none)))))))
2060 (defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
2061 "Helper for `yas-define-menu'."
2062 (dolist (e (reverse menu))
2063 (cond ((eq (first e) 'yas-item)
2064 (let ((template (or (gethash (second e) uuidhash)
2065 (yas--populate-template (puthash (second e)
2066 (yas--make-blank-template)
2069 :perm-group group-list
2070 :uuid (second e)))))
2071 (define-key menu-keymap (vector (gensym))
2072 (car (yas--template-menu-binding-pair-get-create template :stay)))))
2073 ((eq (first e) 'yas-submenu)
2074 (let ((subkeymap (make-sparse-keymap)))
2075 (define-key menu-keymap (vector (gensym))
2076 `(menu-item ,(second e) ,subkeymap))
2077 (yas--define-menu-1 table
2081 (append group-list (list (second e))))))
2082 ((eq (first e) 'yas-separator)
2083 (define-key menu-keymap (vector (gensym))
2084 '(menu-item "----")))
2086 (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
2088 (defun yas--define (mode key template &optional name condition group)
2089 "Define a snippet. Expanding KEY into TEMPLATE.
2091 NAME is a description to this template. Also update the menu if
2092 `yas-use-menu' is t. CONDITION is the condition attached to
2093 this snippet. If you attach a condition to a snippet, then it
2094 will only be expanded when the condition evaluated to non-nil."
2095 (yas-define-snippets mode
2096 (list (list key template name condition group))))
2098 (defun yas-hippie-try-expand (first-time?)
2099 "Integrate with hippie expand.
2101 Just put this function in `hippie-expand-try-functions-list'."
2102 (when yas-minor-mode
2103 (if (not first-time?)
2104 (let ((yas-fallback-behavior 'return-nil))
2110 ;;; Apropos condition-cache:
2115 (defvar yas--condition-cache-timestamp nil)
2116 (defmacro yas-define-condition-cache (func doc &rest body)
2117 "Define a function FUNC with doc DOC and body BODY.
2118 BODY is executed at most once every snippet expansion attempt, to check
2119 expansion conditions.
2121 It doesn't make any sense to call FUNC programatically."
2122 `(defun ,func () ,(if (and doc
2125 "\n\nFor use in snippets' conditions. Within each
2126 snippet-expansion routine like `yas-expand', computes actual
2127 value for the first time then always returns a cached value.")
2128 (setq body (cons doc body))
2130 (let ((timestamp-and-value (get ',func 'yas--condition-cache)))
2131 (if (equal (car timestamp-and-value) yas--condition-cache-timestamp)
2132 (cdr timestamp-and-value)
2133 (let ((new-value (progn
2136 (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
2139 (defalias 'yas-expand 'yas-expand-from-trigger-key)
2140 (defun yas-expand-from-trigger-key (&optional field)
2141 "Expand a snippet before point.
2143 If no snippet expansion is possible, fall back to the behaviour
2144 defined in `yas-fallback-behavior'.
2146 Optional argument FIELD is for non-interactive use and is an
2147 object satisfying `yas--field-p' to restrict the expansion to."
2149 (setq yas--condition-cache-timestamp (current-time))
2150 (let (templates-and-pos)
2151 (unless (and yas-expand-only-for-last-commands
2152 (not (member last-command yas-expand-only-for-last-commands)))
2153 (setq templates-and-pos (if field
2155 (narrow-to-region (yas--field-start field)
2156 (yas--field-end field))
2158 (yas--current-key))))
2159 (if (and templates-and-pos
2160 (first 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 'call-other-command)
2214 (let* ((beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
2215 (yas--message 4 "Falling back to %s" beyond-yasnippet)
2216 (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
2217 (setq this-original-command beyond-yasnippet)
2218 (when beyond-yasnippet
2219 (call-interactively beyond-yasnippet))))
2220 ((and (listp yas-fallback-behavior)
2221 (cdr yas-fallback-behavior)
2222 (eq 'apply (car yas-fallback-behavior)))
2223 (if (cddr yas-fallback-behavior)
2224 (apply (cadr yas-fallback-behavior)
2225 (cddr yas-fallback-behavior))
2226 (when (commandp (cadr yas-fallback-behavior))
2227 (setq this-command (cadr yas-fallback-behavior))
2228 (call-interactively (cadr yas-fallback-behavior)))))
2230 ;; also return nil if all the other fallbacks have failed
2233 (defun yas--keybinding-beyond-yasnippet ()
2235 (let* ((yas-minor-mode nil)
2236 (yas--direct-keymaps nil)
2237 (keys (this-single-command-keys)))
2238 (or (key-binding keys t)
2239 (key-binding (yas--fallback-translate-input keys) t))))
2241 (defun yas--fallback-translate-input (keys)
2242 "Emulate `read-key-sequence', at least what I think it does.
2244 Keys should be an untranslated key vector. Returns a translated
2245 vector of keys. FIXME not thoroughly tested."
2248 (while (< i (length keys))
2250 (translated local-function-key-map))
2251 (while (and (< j (length keys))
2253 (keymapp translated))
2254 (setq translated (cdr (assoc (aref keys j) (remove 'keymap translated)))
2256 (setq retval (vconcat retval (cond ((symbolp translated)
2258 ((vectorp translated)
2261 (substring keys i j)))))
2266 ;;; Utils for snippet development:
2268 (defun yas--all-templates (tables)
2269 "Get `yas--template' objects in TABLES, applicable for buffer and point.
2271 Honours `yas-choose-tables-first', `yas-choose-keys-first' and
2272 `yas-buffer-local-condition'"
2273 (when yas-choose-tables-first
2274 (setq tables (list (yas--prompt-for-table tables))))
2276 (if yas-choose-keys-first
2277 (let ((key (yas--prompt-for-keys
2278 (mapcan #'yas--table-all-keys tables))))
2280 (mapcan #'(lambda (table)
2281 (yas--fetch table key))
2283 (remove-duplicates (mapcan #'yas--table-templates tables)
2286 (defun yas-insert-snippet (&optional no-condition)
2287 "Choose a snippet to expand, pop-up a list of choices according
2288 to `yas-prompt-functions'.
2290 With prefix argument NO-CONDITION, bypass filtering of snippets
2293 (setq yas--condition-cache-timestamp (current-time))
2294 (let* ((yas-buffer-local-condition (or (and no-condition
2296 yas-buffer-local-condition))
2297 (templates (yas--all-templates (yas--get-snippet-tables)))
2298 (yas--current-template (and templates
2299 (or (and (rest templates) ;; more than one template for same key
2300 (yas--prompt-for-template templates))
2302 (where (if (region-active-p)
2303 (cons (region-beginning) (region-end))
2304 (cons (point) (point)))))
2305 (if yas--current-template
2306 (yas-expand-snippet (yas--template-content yas--current-template)
2309 (yas--template-expand-env yas--current-template))
2310 (yas--message 3 "No snippets can be inserted here!"))))
2312 (defun yas-visit-snippet-file ()
2313 "Choose a snippet to edit, selection like `yas-insert-snippet'.
2315 Only success if selected snippet was loaded from a file. Put the
2316 visited file in `snippet-mode'."
2318 (let* ((yas-buffer-local-condition 'always)
2319 (templates (yas--all-templates (yas--get-snippet-tables)))
2320 (yas-prompt-functions '(yas-ido-prompt yas-completing-prompt))
2321 (template (and templates
2322 (or (yas--prompt-for-template templates
2323 "Choose a snippet template to edit: ")
2327 (yas--visit-snippet-file-1 template)
2328 (message "No snippets tables active!"))))
2330 (defun yas--visit-snippet-file-1 (template)
2331 "Helper for `yas-visit-snippet-file'."
2332 (let ((file (yas--template-file template)))
2333 (cond ((and file (file-readable-p file))
2334 (find-file-other-window file)
2336 (set (make-local-variable 'yas--editing-template) template))
2338 (message "Original file %s no longer exists!" file))
2340 (switch-to-buffer (format "*%s*"(yas--template-name template)))
2341 (let ((type 'snippet))
2342 (when (listp (yas--template-content template))
2343 (insert (format "# type: command\n"))
2344 (setq type 'command))
2345 (insert (format "# key: %s\n" (yas--template-key template)))
2346 (insert (format "# name: %s\n" (yas--template-name template)))
2347 (when (yas--template-keybinding template)
2348 (insert (format "# binding: %s\n" (yas--template-keybinding template))))
2349 (when (yas--template-expand-env template)
2350 (insert (format "# expand-env: %s\n" (yas--template-expand-env template))))
2351 (when (yas--template-condition template)
2352 (insert (format "# condition: %s\n" (yas--template-condition template))))
2354 (insert (if (eq type 'command)
2355 (pp-to-string (yas--template-content template))
2356 (yas--template-content template))))
2358 (set (make-local-variable 'yas--editing-template) template)))))
2360 (defun yas--guess-snippet-directories-1 (table)
2361 "Guess possible snippet subdirectories for TABLE."
2362 (cons (yas--table-name table)
2363 (mapcan #'(lambda (parent)
2364 (yas--guess-snippet-directories-1
2366 (yas--table-parents table))))
2368 (defun yas--guess-snippet-directories (&optional table)
2369 "Try to guess suitable directories based on the current active
2370 tables (or optional TABLE).
2372 Returns a list of elements (TABLE . DIRS) where TABLE is a
2373 `yas--table' object and DIRS is a list of all possible directories
2374 where snippets of table might exist."
2375 (let ((main-dir (replace-regexp-in-string
2377 (or (first (or (yas-snippet-dirs)
2378 (setq yas-snippet-dirs '("~/.emacs.d/snippets")))))))
2379 (tables (or (and table
2381 (yas--get-snippet-tables))))
2382 ;; HACK! the snippet table created here is actually registered!
2384 (unless (or table (gethash major-mode yas--tables))
2385 (push (yas--table-get-create major-mode)
2388 (mapcar #'(lambda (table)
2390 (mapcar #'(lambda (subdir)
2391 (concat main-dir "/" subdir))
2392 (yas--guess-snippet-directories-1 table))))
2395 (defun yas--make-directory-maybe (table-and-dirs &optional main-table-string)
2396 "Return a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
2397 (or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
2398 (let ((candidate (first (cdr table-and-dirs))))
2399 (unless (file-writable-p (file-name-directory candidate))
2400 (error (yas--format "%s is not writable." candidate)))
2401 (if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
2403 (if (gethash (yas--table-mode (car table-and-dirs))
2407 (or main-table-string
2409 (yas--table-name (car table-and-dirs))))
2411 (make-directory candidate 'also-make-parents)
2412 ;; create the .yas-parents file here...
2415 (defun yas-new-snippet (&optional no-template)
2416 "Pops a new buffer for writing a snippet.
2418 Expands a snippet-writing snippet, unless the optional prefix arg
2419 NO-TEMPLATE is non-nil."
2421 (let ((guessed-directories (yas--guess-snippet-directories)))
2423 (switch-to-buffer "*new snippet*")
2425 (kill-all-local-variables)
2428 (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
2429 (yas--table-mode (car d)))
2430 guessed-directories))
2431 (if (and (not no-template) yas-new-snippet-default)
2432 (yas-expand-snippet yas-new-snippet-default))))
2434 (defun yas--compute-major-mode-and-parents (file)
2435 "Given FILE, find the nearest snippet directory for a given mode.
2437 Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
2438 representing one or more of the mode's parents.
2440 Note that MODE-SYM need not be the symbol of a real major mode,
2441 neither do the elements of PARENTS."
2442 (let* ((file-dir (and file
2443 (directory-file-name (or (some #'(lambda (special)
2444 (locate-dominating-file file special))
2448 (directory-file-name (file-name-directory file))))))
2449 (parents-file-name (concat file-dir "/.yas-parents"))
2450 (major-mode-name (and file-dir
2451 (file-name-nondirectory file-dir)))
2452 (major-mode-sym (or (and major-mode-name
2453 (intern major-mode-name))))
2454 (parents (when (file-readable-p parents-file-name)
2458 (insert-file-contents parents-file-name)
2459 (buffer-substring-no-properties (point-min)
2461 (when major-mode-sym
2462 (cons major-mode-sym (remove major-mode-sym parents)))))
2464 (defvar yas--editing-template nil
2465 "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
2467 (defvar yas--current-template nil
2468 "Holds the current template being expanded into a snippet.")
2470 (defvar yas--guessed-modes nil
2471 "List of guessed modes supporting `yas-load-snippet-buffer'.")
2473 (defun yas--read-table ()
2474 "Ask user for a snippet table, help with some guessing."
2475 (let ((prompt (if (and (featurep 'ido)
2477 'ido-completing-read 'completing-read)))
2478 (unless yas--guessed-modes
2479 (set (make-local-variable 'yas--guessed-modes)
2480 (or (yas--compute-major-mode-and-parents buffer-file-name))))
2482 (funcall prompt (format "Choose or enter a table (yas guesses %s): "
2483 (if yas--guessed-modes
2484 (first yas--guessed-modes)
2486 (mapcar #'symbol-name yas--guessed-modes)
2491 (if (first yas--guessed-modes)
2492 (symbol-name (first yas--guessed-modes)))))))
2494 (defun yas-load-snippet-buffer (table &optional interactive)
2495 "Parse and load current buffer's snippet definition into TABLE.
2497 TABLE is a symbol naming a passed to `yas--table-get-create'.
2499 When called interactively, prompt for the table name."
2500 (interactive (list (yas--read-table) t))
2502 ;; We have `yas--editing-template', this buffer's content comes from a
2503 ;; template which is already loaded and neatly positioned,...
2505 (yas--editing-template
2506 (yas--define-snippets-1 (yas--parse-template (yas--template-file yas--editing-template))
2507 (yas--template-table yas--editing-template)))
2508 ;; Try to use `yas--guessed-modes'. If we don't have that use the
2509 ;; value from `yas--compute-major-mode-and-parents'
2512 (unless yas--guessed-modes
2513 (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
2514 (let* ((table (yas--table-get-create table)))
2515 (set (make-local-variable 'yas--editing-template)
2516 (yas--define-snippets-1 (yas--parse-template buffer-file-name)
2519 (yas--message 3 "Snippet \"%s\" loaded for %s."
2520 (yas--template-name yas--editing-template)
2521 (yas--table-name (yas--template-table yas--editing-template)))))
2523 (defun yas-load-snippet-buffer-and-close (table &optional kill)
2524 "Load the snippet with `yas-load-snippet-buffer', possibly
2525 save, then `quit-window' if saved.
2527 If the snippet is new, ask the user whether (and where) to save
2528 it. If the snippet already has a file, just save it.
2530 The prefix argument KILL is passed to `quit-window'.
2532 Don't use this from a Lisp program, call `yas-load-snippet-buffer'
2533 and `kill-buffer' instead."
2534 (interactive (list (yas--read-table) current-prefix-arg))
2535 (yas-load-snippet-buffer table t)
2537 ;; Only offer to save this if it looks like a library or new
2538 ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
2539 ;; which is not the first, or from an unwritable file)
2541 (not (yas--template-file yas--editing-template))
2542 (not (file-writable-p (yas--template-file yas--editing-template)))
2543 (and (listp yas-snippet-dirs)
2544 (second yas-snippet-dirs)
2545 (not (string-match (expand-file-name (first yas-snippet-dirs))
2546 (yas--template-file yas--editing-template)))))
2547 (y-or-n-p (yas--format "Looks like a library or new snippet. Save to new file? ")))
2548 (let* ((option (first (yas--guess-snippet-directories (yas--template-table yas--editing-template))))
2550 (yas--make-directory-maybe option))))
2552 (let ((default-file-name (or (and (yas--template-file yas--editing-template)
2553 (file-name-nondirectory (yas--template-file yas--editing-template)))
2554 (yas--template-name yas--editing-template))))
2555 (write-file (concat chosen "/"
2556 (read-from-minibuffer (format "File name to create in %s? " chosen)
2557 default-file-name)))
2558 (setf (yas--template-file yas--editing-template) buffer-file-name)))))
2559 (when buffer-file-name
2561 (quit-window kill)))
2563 (defun yas-tryout-snippet (&optional debug)
2564 "Test current buffer's snippet template in other buffer."
2566 (let* ((major-mode-and-parent (yas--compute-major-mode-and-parents buffer-file-name))
2567 (parsed (yas--parse-template))
2568 (test-mode (or (and (car major-mode-and-parent)
2569 (fboundp (car major-mode-and-parent))
2570 (car major-mode-and-parent))
2571 (first yas--guessed-modes)
2572 (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
2573 (yas--current-template
2576 (yas--populate-template (yas--make-blank-template)
2577 :table nil ;; no tables for ephemeral snippets
2579 :content (second parsed)
2580 :name (third parsed)
2581 :expand-env (sixth parsed)))))
2582 (cond (yas--current-template
2583 (let ((buffer-name (format "*testing snippet: %s*" (yas--template-name yas--current-template))))
2584 (kill-buffer (get-buffer-create buffer-name))
2585 (switch-to-buffer (get-buffer-create buffer-name))
2586 (setq buffer-undo-list nil)
2587 (condition-case nil (funcall test-mode) (error nil))
2589 (setq buffer-read-only nil)
2590 (yas-expand-snippet (yas--template-content yas--current-template)
2593 (yas--template-expand-env yas--current-template))
2595 (require 'yasnippet-debug nil t))
2596 (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
2598 (yas--message 3 "Cannot test snippet for unknown major mode")))))
2600 (defun yas-active-keys ()
2601 "Return all active trigger keys for current buffer and point."
2603 (remove-if-not #'stringp (mapcan #'yas--table-all-keys (yas--get-snippet-tables)))
2606 (defun yas--template-fine-group (template)
2607 (car (last (or (yas--template-group template)
2608 (yas--template-perm-group template)))))
2610 (defun yas-describe-tables (&optional choose)
2611 "Display snippets for each table."
2613 (let* ((by-name-hash (and choose
2614 (y-or-n-p "Show by namehash? ")))
2615 (buffer (get-buffer-create "*YASnippet tables*"))
2616 (active-tables (yas--get-snippet-tables))
2617 (remain-tables (let ((all))
2618 (maphash #'(lambda (_k v)
2619 (unless (find v active-tables)
2623 (table-lists (list active-tables remain-tables))
2624 (original-buffer (current-buffer))
2626 (yas--condition-cache-timestamp (current-time)))
2627 (with-current-buffer buffer
2628 (setq buffer-read-only nil)
2630 (cond ((not by-name-hash)
2631 (insert "YASnippet tables: \n")
2632 (while (and table-lists
2634 (dolist (table (car table-lists))
2635 (yas--describe-pretty-table table original-buffer))
2636 (setq table-lists (cdr table-lists))
2638 (yas--create-snippet-xrefs)
2639 (display-buffer buffer)
2640 (setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
2641 (yas--create-snippet-xrefs)
2645 (insert "\n\nYASnippet tables by NAMEHASH: \n")
2646 (dolist (table (append active-tables remain-tables))
2647 (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
2649 (maphash #'(lambda (k _v)
2651 (yas--table-hash table))
2653 (insert (format " key %s maps snippets: %s\n" key
2655 (maphash #'(lambda (k _v)
2657 (gethash key (yas--table-hash table)))
2660 (setq buffer-read-only t))
2661 (display-buffer buffer)))
2663 (defun yas--describe-pretty-table (table &optional original-buffer)
2664 (insert (format "\nSnippet table `%s'"
2665 (yas--table-name table)))
2666 (if (yas--table-parents table)
2667 (insert (format " parents: %s\n"
2668 (mapcar #'yas--table-name
2669 (yas--table-parents table))))
2671 (insert (make-string 100 ?-) "\n")
2672 (insert "group state name key binding\n")
2673 (let ((groups-hash (make-hash-table :test #'equal)))
2674 (maphash #'(lambda (_k v)
2675 (let ((group (or (yas--template-fine-group v)
2677 (when (yas--template-name v)
2679 (cons v (gethash group groups-hash))
2681 (yas--table-uuidhash table))
2683 #'(lambda (group templates)
2684 (setq group (truncate-string-to-width group 25 0 ? "..."))
2685 (insert (make-string 100 ?-) "\n")
2686 (dolist (p templates)
2687 (let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas--template-name p))
2691 (setq group (make-string (length group) ? ))))
2692 (condition-string (let ((condition (yas--template-condition p)))
2695 (with-current-buffer original-buffer
2696 (if (yas--eval-condition condition)
2701 (insert condition-string " ")
2703 (if (string-match "\\.\\.\\.$" name)
2707 (insert (truncate-string-to-width (or (yas--template-key p) "")
2709 (insert (truncate-string-to-width (key-description (yas--template-keybinding p))
2716 ;;; User convenience functions, for using in snippet definitions
2718 (defvar yas-modified-p nil
2719 "Non-nil if field has been modified by user or transformation.")
2721 (defvar yas-moving-away-p nil
2722 "Non-nil if user is about to exit field.")
2724 (defvar yas-text nil
2725 "Contains current field text.")
2727 (defun yas-substr (str pattern &optional subexp)
2728 "Search PATTERN in STR and return SUBEXPth match.
2730 If found, the content of subexp group SUBEXP (default 0) is
2731 returned, or else the original STR will be returned."
2732 (let ((grp (or subexp 0)))
2734 (if (string-match pattern str)
2735 (match-string-no-properties grp str)
2738 (defun yas-choose-value (&rest possibilities)
2739 "Prompt for a string in POSSIBILITIES and return it.
2741 The last element of POSSIBILITIES may be a list of strings."
2742 (unless (or yas-moving-away-p
2744 (let* ((last-link (last possibilities))
2745 (last-elem (car last-link)))
2746 (when (listp last-elem)
2747 (setcar last-link (car last-elem))
2748 (setcdr last-link (cdr last-elem))))
2749 (some #'(lambda (fn)
2750 (funcall fn "Choose: " possibilities))
2751 yas-prompt-functions)))
2753 (defun yas-key-to-value (alist)
2754 (unless (or yas-moving-away-p
2756 (let ((key (read-key-sequence "")))
2758 (or (cdr (find key alist :key #'car :test #'string=))
2761 (defun yas-throw (text)
2762 "Throw a yas--exception with TEXT as the reason."
2763 (throw 'yas--exception (cons 'yas--exception text)))
2765 (defun yas-verify-value (possibilities)
2766 "Verify that the current field value is in POSSIBILITIES.
2768 Otherwise throw exception."
2769 (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
2770 (yas-throw (yas--format "Field only allows %s" possibilities))))
2772 (defun yas-field-value (number)
2773 "Get the string for field with NUMBER.
2775 Use this in primary and mirror transformations to tget."
2776 (let* ((snippet (car (yas--snippets-at-point)))
2778 (yas--snippet-find-field snippet number))))
2780 (yas--field-text-for-display field))))
2783 "Return `yas-text' if that exists and is non-empty, else nil."
2785 (not (string= "" yas-text)))
2788 (defun yas-selected-text ()
2789 "Return `yas-selected-text' if that exists and is non-empty, else nil."
2790 (if (and yas-selected-text
2791 (not (string= "" yas-selected-text)))
2794 (defun yas--get-field-once (number &optional transform-fn)
2795 (unless yas-modified-p
2797 (funcall transform-fn (yas-field-value number))
2798 (yas-field-value number))))
2800 (defun yas-default-from-field (number)
2801 (unless yas-modified-p
2802 (yas-field-value number)))
2804 (defun yas-inside-string ()
2805 "Return non-nil if the point is inside a string according to font-lock."
2806 (equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
2808 (defun yas-unimplemented (&optional missing-feature)
2809 (if yas--current-template
2810 (if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
2813 (yas--visit-snippet-file-1 yas--current-template))
2814 (message "No implementation. Missing %s" (or missing-feature "something"))))
2817 ;;; Snippet expansion and field management
2819 (defvar yas--active-field-overlay nil
2820 "Overlays the currently active field.")
2822 (defvar yas--field-protection-overlays nil
2823 "Two overlays protect the current active field.")
2825 (defvar yas-selected-text nil
2826 "The selected region deleted on the last snippet expansion.")
2828 (defvar yas--start-column nil
2829 "The column where the snippet expansion started.")
2831 (make-variable-buffer-local 'yas--active-field-overlay)
2832 (make-variable-buffer-local 'yas--field-protection-overlays)
2833 (put 'yas--active-field-overlay 'permanent-local t)
2834 (put 'yas--field-protection-overlays 'permanent-local t)
2836 (defstruct (yas--snippet (:constructor yas--make-snippet ()))
2842 (id (yas--snippet-next-id) :read-only t)
2843 (control-overlay nil)
2845 ;; stacked expansion: the `previous-active-field' slot saves the
2846 ;; active field where the child expansion took place
2847 previous-active-field
2850 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
2853 NUMBER is the field number.
2854 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2855 PARENT-FIELD is a `yas--field' this field is nested under, or nil.
2856 MIRRORS is a list of `yas--mirror's
2857 TRANSFORM is a lisp form.
2858 MODIFIED-P is a boolean set to true once user inputs text.
2859 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'.
2870 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
2873 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2874 TRANSFORM is a lisp form.
2875 PARENT-FIELD is a `yas--field' this mirror is nested under, or nil.
2876 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'
2877 DEPTH is a count of how many nested mirrors can affect this mirror"
2884 (defstruct (yas--exit (:constructor yas--make-exit (marker)))
2888 (defun yas--apply-transform (field-or-mirror field &optional empty-on-nil-p)
2889 "Calculate transformed string for FIELD-OR-MIRROR from FIELD.
2891 If there is no transform for ht field, return nil.
2893 If there is a transform but it returns nil, return the empty
2894 string iff EMPTY-ON-NIL-P is true."
2895 (let* ((yas-text (yas--field-text-for-display field))
2896 (yas-modified-p (yas--field-modified-p field))
2897 (yas-moving-away-p nil)
2898 (transform (if (yas--mirror-p field-or-mirror)
2899 (yas--mirror-transform field-or-mirror)
2900 (yas--field-transform field-or-mirror)))
2901 (start-point (if (yas--mirror-p field-or-mirror)
2902 (yas--mirror-start field-or-mirror)
2903 (yas--field-start field-or-mirror)))
2904 (transformed (and transform
2906 (goto-char start-point)
2907 (let ((ret (yas--eval-lisp transform)))
2908 (or ret (and empty-on-nil-p "")))))))
2911 (defsubst yas--replace-all (from to &optional text)
2912 "Replace all occurrences from FROM to TO.
2914 With optional string TEXT do it in that string."
2916 (replace-regexp-in-string (regexp-quote from) to text t t)
2917 (goto-char (point-min))
2918 (while (search-forward from nil t)
2919 (replace-match to t t text))))
2921 (defun yas--snippet-find-field (snippet number)
2922 (find-if #'(lambda (field)
2923 (eq number (yas--field-number field)))
2924 (yas--snippet-fields snippet)))
2926 (defun yas--snippet-sort-fields (snippet)
2927 "Sort the fields of SNIPPET in navigation order."
2928 (setf (yas--snippet-fields snippet)
2929 (sort (yas--snippet-fields snippet)
2930 #'yas--snippet-field-compare)))
2932 (defun yas--snippet-field-compare (field1 field2)
2933 "Compare FIELD1 and FIELD2.
2935 The field with a number is sorted first. If they both have a
2936 number, compare through the number. If neither have, compare
2937 through the field's start point"
2938 (let ((n1 (yas--field-number field1))
2939 (n2 (yas--field-number field2)))
2942 (or (zerop n2) (and (not (zerop n1))
2947 (< (yas--field-start field1)
2948 (yas--field-start field2))))))
2950 (defun yas--field-probably-deleted-p (snippet field)
2951 "Guess if SNIPPET's FIELD should be skipped."
2953 ;; field must be zero length
2955 (zerop (- (yas--field-start field) (yas--field-end field)))
2958 ;; 1) is a nested field and it's been modified
2960 (and (yas--field-parent-field field)
2961 (yas--field-modified-p field))
2962 ;; 2) ends just before the snippet end
2964 (and (eq field (car (last (yas--snippet-fields snippet))))
2965 (= (yas--field-start field) (overlay-end (yas--snippet-control-overlay snippet)))))
2966 ;; the field numbered 0, just before the exit marker, should
2969 (not (zerop (yas--field-number field)))))
2971 (defun yas--snippets-at-point (&optional all-snippets)
2972 "Return a sorted list of snippets at point.
2974 The most recently-inserted snippets are returned first."
2976 (remove nil (remove-duplicates (mapcar #'(lambda (ov)
2977 (overlay-get ov 'yas--snippet))
2979 (overlays-in (point-min) (point-max))
2980 (nconc (overlays-at (point)) (overlays-at (1- (point))))))))
2982 (<= (yas--snippet-id s2) (yas--snippet-id s1)))))
2984 (defun yas-next-field-or-maybe-expand ()
2985 "Try to expand a snippet at a key before point.
2987 Otherwise delegate to `yas-next-field'."
2989 (if yas-triggers-in-field
2990 (let ((yas-fallback-behavior 'return-nil)
2991 (active-field (overlay-get yas--active-field-overlay 'yas--field)))
2993 (unless (yas-expand-from-trigger-key active-field)
2997 (defun yas-next-field (&optional arg)
2998 "Navigate to the ARGth next field.
3000 If there's none, exit the snippet."
3004 (snippet (first (yas--snippets-at-point)))
3005 (active-field (overlay-get yas--active-field-overlay 'yas--field))
3006 (live-fields (remove-if #'(lambda (field)
3007 (and (not (eq field active-field))
3008 (yas--field-probably-deleted-p snippet field)))
3009 (yas--snippet-fields snippet)))
3010 (active-field-pos (position active-field live-fields))
3011 (target-pos (and active-field-pos (+ arg active-field-pos)))
3012 (target-field (and target-pos (nth target-pos live-fields))))
3013 ;; First check if we're moving out of a field with a transform
3015 (when (and active-field
3016 (yas--field-transform active-field))
3017 (let* ((yas-moving-away-p t)
3018 (yas-text (yas--field-text-for-display active-field))
3019 (yas-modified-p (yas--field-modified-p active-field)))
3020 ;; primary field transform: exit call to field-transform
3021 (yas--eval-lisp (yas--field-transform active-field))))
3022 ;; Now actually move...
3023 (cond ((and target-pos (>= target-pos (length live-fields)))
3024 (yas-exit-snippet snippet))
3026 (yas--move-to-field snippet target-field))
3030 (defun yas--place-overlays (snippet field)
3031 "Correctly place overlays for SNIPPET's FIELD."
3032 (yas--make-move-field-protection-overlays snippet field)
3033 (yas--make-move-active-field-overlay snippet field))
3035 (defun yas--move-to-field (snippet field)
3036 "Update SNIPPET to move to field FIELD.
3038 Also create some protection overlays"
3039 (goto-char (yas--field-start field))
3040 (yas--place-overlays snippet field)
3041 (overlay-put yas--active-field-overlay 'yas--field field)
3042 (let ((number (yas--field-number field)))
3043 ;; check for the special ${0: ...} field
3044 (if (and number (zerop number))
3046 (set-mark (yas--field-end field))
3047 (setf (yas--snippet-force-exit snippet)
3048 (or (yas--field-transform field)
3050 ;; make this field active
3051 (setf (yas--snippet-active-field snippet) field)
3052 ;; primary field transform: first call to snippet transform
3053 (unless (yas--field-modified-p field)
3054 (if (yas--field-update-display field)
3055 (yas--update-mirrors snippet)
3056 (setf (yas--field-modified-p field) nil))))))
3058 (defun yas-prev-field ()
3059 "Navigate to prev field. If there's none, exit the snippet."
3061 (yas-next-field -1))
3063 (defun yas-abort-snippet (&optional snippet)
3065 (let ((snippet (or snippet
3066 (car (yas--snippets-at-point)))))
3068 (setf (yas--snippet-force-exit snippet) t))))
3070 (defun yas-exit-snippet (snippet)
3071 "Goto exit-marker of SNIPPET."
3072 (interactive (list (first (yas--snippets-at-point))))
3074 (setf (yas--snippet-force-exit snippet) t)
3075 (goto-char (if (yas--snippet-exit snippet)
3076 (yas--exit-marker (yas--snippet-exit snippet))
3077 (overlay-end (yas--snippet-control-overlay snippet))))))
3079 (defun yas-exit-all-snippets ()
3080 "Exit all snippets."
3082 (mapc #'(lambda (snippet)
3083 (yas-exit-snippet snippet)
3084 (yas--check-commit-snippet))
3085 (yas--snippets-at-point 'all-snippets)))
3088 ;;; Some low level snippet-routines:
3090 (defvar yas--inhibit-overlay-hooks nil
3091 "Bind this temporarily to non-nil to prevent running `yas--on-*-modification'.")
3093 (defmacro yas--inhibit-overlay-hooks (&rest body)
3094 "Run BODY with `yas--inhibit-overlay-hooks' set to t."
3095 (declare (indent 0))
3096 `(let ((yas--inhibit-overlay-hooks t))
3099 (defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
3100 (defvar yas-snippet-end nil "End position of the last snippet committed.")
3102 (defun yas--commit-snippet (snippet)
3103 "Commit SNIPPET, but leave point as it is.
3105 This renders the snippet as ordinary text."
3107 (let ((control-overlay (yas--snippet-control-overlay snippet)))
3109 ;; Save the end of the moribund snippet in case we need to revive it
3110 ;; its original expansion.
3112 (when (and control-overlay
3113 (overlay-buffer control-overlay))
3114 (setq yas-snippet-beg (overlay-start control-overlay))
3115 (setq yas-snippet-end (overlay-end control-overlay))
3116 (delete-overlay control-overlay))
3118 (yas--inhibit-overlay-hooks
3119 (when yas--active-field-overlay
3120 (delete-overlay yas--active-field-overlay))
3121 (when yas--field-protection-overlays
3122 (mapc #'delete-overlay yas--field-protection-overlays)))
3124 ;; stacked expansion: if the original expansion took place from a
3125 ;; field, make sure we advance it here at least to
3126 ;; `yas-snippet-end'...
3128 (let ((previous-field (yas--snippet-previous-active-field snippet)))
3129 (when (and yas-snippet-end previous-field)
3130 (yas--advance-end-maybe previous-field yas-snippet-end)))
3132 ;; Convert all markers to points,
3134 (yas--markers-to-points snippet)
3136 ;; Take care of snippet revival
3138 (if yas-snippet-revival
3139 (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
3141 ;; Dismember the snippet... this is useful if we get called
3142 ;; again from `yas--take-care-of-redo'....
3143 (setf (yas--snippet-fields snippet) nil)))
3145 (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
3147 (defun yas--safely-run-hooks (hook-var)
3148 (condition-case error
3149 (run-hooks hook-var)
3151 (yas--message 3 "%s error: %s" hook-var (error-message-string error)))))
3154 (defun yas--check-commit-snippet ()
3155 "Check if point exited the currently active field of the snippet.
3157 If so cleans up the whole snippet up."
3158 (let* ((snippets (yas--snippets-at-point 'all-snippets))
3159 (snippets-left snippets)
3160 (snippet-exit-transform))
3161 (dolist (snippet snippets)
3162 (let ((active-field (yas--snippet-active-field snippet)))
3163 (setq snippet-exit-transform (yas--snippet-force-exit snippet))
3164 (cond ((or snippet-exit-transform
3165 (not (and active-field (yas--field-contains-point-p active-field))))
3166 (setq snippets-left (delete snippet snippets-left))
3167 (setf (yas--snippet-force-exit snippet) nil)
3168 (yas--commit-snippet snippet))
3170 (or (not yas--active-field-overlay)
3171 (not (overlay-buffer yas--active-field-overlay))))
3173 ;; stacked expansion: this case is mainly for recent
3174 ;; snippet exits that place us back int the field of
3178 (yas--move-to-field snippet active-field)
3179 (yas--update-mirrors snippet)))
3182 (unless (or (null snippets) snippets-left)
3183 (if snippet-exit-transform
3184 (yas--eval-lisp-no-saves snippet-exit-transform))
3185 (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
3187 ;; Apropos markers-to-points:
3189 ;; This was found useful for performance reasons, so that an
3190 ;; excessive number of live markers aren't kept around in the
3191 ;; `buffer-undo-list'. However, in `markers-to-points', the
3192 ;; set-to-nil markers can't simply be discarded and replaced with
3193 ;; fresh ones in `points-to-markers'. The original marker that was
3194 ;; just set to nil has to be reused.
3196 ;; This shouldn't bring horrible problems with undo/redo, but it
3199 (defun yas--markers-to-points (snippet)
3200 "Convert all markers in SNIPPET to a cons (POINT . MARKER)
3201 where POINT is the original position of the marker and MARKER is
3202 the original marker object with the position set to nil."
3203 (dolist (field (yas--snippet-fields snippet))
3204 (let ((start (marker-position (yas--field-start field)))
3205 (end (marker-position (yas--field-end field))))
3206 (set-marker (yas--field-start field) nil)
3207 (set-marker (yas--field-end field) nil)
3208 (setf (yas--field-start field) (cons start (yas--field-start field)))
3209 (setf (yas--field-end field) (cons end (yas--field-end field))))
3210 (dolist (mirror (yas--field-mirrors field))
3211 (let ((start (marker-position (yas--mirror-start mirror)))
3212 (end (marker-position (yas--mirror-end mirror))))
3213 (set-marker (yas--mirror-start mirror) nil)
3214 (set-marker (yas--mirror-end mirror) nil)
3215 (setf (yas--mirror-start mirror) (cons start (yas--mirror-start mirror)))
3216 (setf (yas--mirror-end mirror) (cons end (yas--mirror-end mirror))))))
3217 (let ((snippet-exit (yas--snippet-exit snippet)))
3219 (let ((exit (marker-position (yas--exit-marker snippet-exit))))
3220 (set-marker (yas--exit-marker snippet-exit) nil)
3221 (setf (yas--exit-marker snippet-exit) (cons exit (yas--exit-marker snippet-exit)))))))
3223 (defun yas--points-to-markers (snippet)
3224 "Convert all cons (POINT . MARKER) in SNIPPET to markers.
3226 This is done by setting MARKER to POINT with `set-marker'."
3227 (dolist (field (yas--snippet-fields snippet))
3228 (setf (yas--field-start field) (set-marker (cdr (yas--field-start field))
3229 (car (yas--field-start field))))
3230 (setf (yas--field-end field) (set-marker (cdr (yas--field-end field))
3231 (car (yas--field-end field))))
3232 (dolist (mirror (yas--field-mirrors field))
3233 (setf (yas--mirror-start mirror) (set-marker (cdr (yas--mirror-start mirror))
3234 (car (yas--mirror-start mirror))))
3235 (setf (yas--mirror-end mirror) (set-marker (cdr (yas--mirror-end mirror))
3236 (car (yas--mirror-end mirror))))))
3237 (let ((snippet-exit (yas--snippet-exit snippet)))
3239 (setf (yas--exit-marker snippet-exit) (set-marker (cdr (yas--exit-marker snippet-exit))
3240 (car (yas--exit-marker snippet-exit)))))))
3242 (defun yas--field-contains-point-p (field &optional point)
3243 (let ((point (or point
3245 (and (>= point (yas--field-start field))
3246 (<= point (yas--field-end field)))))
3248 (defun yas--field-text-for-display (field)
3249 "Return the propertized display text for field FIELD."
3250 (buffer-substring (yas--field-start field) (yas--field-end field)))
3252 (defun yas--undo-in-progress ()
3253 "True if some kind of undo is in progress."
3254 (or undo-in-progress
3255 (eq this-command 'undo)
3256 (eq this-command 'redo)))
3258 (defun yas--make-control-overlay (snippet start end)
3259 "Create the control overlay that surrounds the snippet and
3261 (let ((overlay (make-overlay start
3266 (overlay-put overlay 'keymap yas-keymap)
3267 (overlay-put overlay 'priority 100)
3268 (overlay-put overlay 'yas--snippet snippet)
3271 (defun yas-skip-and-clear-or-delete-char (&optional field)
3272 "Clears unmodified field if at field start, skips to next tab.
3274 Otherwise deletes a character normally by calling `delete-char'."
3276 (let ((field (or field
3277 (and yas--active-field-overlay
3278 (overlay-buffer yas--active-field-overlay)
3279 (overlay-get yas--active-field-overlay 'yas--field)))))
3281 (not (yas--field-modified-p field))
3282 (eq (point) (marker-position (yas--field-start field))))
3283 (yas--skip-and-clear field)
3286 (call-interactively 'delete-char)))))
3288 (defun yas--skip-and-clear (field)
3289 "Deletes the region of FIELD and sets it's modified state to t."
3290 ;; Just before skipping-and-clearing the field, mark its children
3291 ;; fields as modified, too. If the children have mirrors-in-fields
3292 ;; this prevents them from updating erroneously (we're skipping and
3295 (yas--mark-this-and-children-modified field)
3296 (delete-region (yas--field-start field) (yas--field-end field)))
3298 (defun yas--mark-this-and-children-modified (field)
3299 (setf (yas--field-modified-p field) t)
3300 (let ((fom (yas--field-next field)))
3302 (yas--fom-parent-field fom))
3303 (when (and (eq (yas--fom-parent-field fom) field)
3305 (yas--mark-this-and-children-modified fom))
3306 (setq fom (yas--fom-next fom)))))
3308 (defun yas--make-move-active-field-overlay (snippet field)
3309 "Place the active field overlay in SNIPPET's FIELD.
3311 Move the overlay, or create it if it does not exit."
3312 (if (and yas--active-field-overlay
3313 (overlay-buffer yas--active-field-overlay))
3314 (move-overlay yas--active-field-overlay
3315 (yas--field-start field)
3316 (yas--field-end field))
3317 (setq yas--active-field-overlay
3318 (make-overlay (yas--field-start field)
3319 (yas--field-end field)
3321 (overlay-put yas--active-field-overlay 'priority 100)
3322 (overlay-put yas--active-field-overlay 'face 'yas-field-highlight-face)
3323 (overlay-put yas--active-field-overlay 'yas--snippet snippet)
3324 (overlay-put yas--active-field-overlay 'modification-hooks '(yas--on-field-overlay-modification))
3325 (overlay-put yas--active-field-overlay 'insert-in-front-hooks
3326 '(yas--on-field-overlay-modification))
3327 (overlay-put yas--active-field-overlay 'insert-behind-hooks
3328 '(yas--on-field-overlay-modification))))
3330 (defun yas--on-field-overlay-modification (overlay after? _beg _end &optional _length)
3331 "Clears the field and updates mirrors, conditionally.
3333 Only clears the field if it hasn't been modified and it point it
3334 at field start. This hook doesn't do anything if an undo is in
3336 (unless (or yas--inhibit-overlay-hooks
3337 (yas--undo-in-progress))
3338 (let* ((field (overlay-get overlay 'yas--field))
3339 (snippet (overlay-get yas--active-field-overlay 'yas--snippet)))
3341 (yas--advance-end-maybe field (overlay-end overlay))
3343 (yas--field-update-display field))
3344 (yas--update-mirrors snippet))
3346 (when (and (not after?)
3347 (not (yas--field-modified-p field))
3348 (eq (point) (if (markerp (yas--field-start field))
3349 (marker-position (yas--field-start field))
3350 (yas--field-start field))))
3351 (yas--skip-and-clear field))
3352 (setf (yas--field-modified-p field) t))))))
3354 ;;; Apropos protection overlays:
3356 ;; These exist for nasty users who will try to delete parts of the
3357 ;; snippet outside the active field. Actual protection happens in
3358 ;; `yas--on-protection-overlay-modification'.
3360 ;; Currently this signals an error which inhibits the command. For
3361 ;; commands that move point (like `kill-line'), point is restored in
3362 ;; the `yas--post-command-handler' using a global
3363 ;; `yas--protection-violation' variable.
3365 ;; Alternatively, I've experimented with an implementation that
3366 ;; commits the snippet before actually calling `this-command'
3367 ;; interactively, and then signals an error, which is ignored. but
3368 ;; blocks all other million modification hooks. This presented some
3369 ;; problems with stacked expansion.
3371 (defun yas--make-move-field-protection-overlays (snippet field)
3372 "Place protection overlays surrounding SNIPPET's FIELD.
3374 Move the overlays, or create them if they do not exit."
3375 (let ((start (yas--field-start field))
3376 (end (yas--field-end field)))
3377 ;; First check if the (1+ end) is contained in the buffer,
3378 ;; otherwise we'll have to do a bit of cheating and silently
3379 ;; insert a newline. the `(1+ (buffer-size))' should prevent this
3380 ;; when using stacked expansion
3382 (when (< (buffer-size) end)
3384 (yas--inhibit-overlay-hooks
3385 (goto-char (point-max))
3387 ;; go on to normal overlay creation/moving
3389 (cond ((and yas--field-protection-overlays
3390 (every #'overlay-buffer yas--field-protection-overlays))
3391 (move-overlay (first yas--field-protection-overlays) (1- start) start)
3392 (move-overlay (second yas--field-protection-overlays) end (1+ end)))
3394 (setq yas--field-protection-overlays
3395 (list (make-overlay (1- start) start nil t nil)
3396 (make-overlay end (1+ end) nil t nil)))
3397 (dolist (ov yas--field-protection-overlays)
3398 (overlay-put ov 'face 'yas--field-debug-face)
3399 (overlay-put ov 'yas--snippet snippet)
3400 ;; (overlay-put ov 'evaporate t)
3401 (overlay-put ov 'modification-hooks '(yas--on-protection-overlay-modification)))))))
3403 (defvar yas--protection-violation nil
3404 "When non-nil, signals attempts to erroneously exit or modify the snippet.
3406 Functions in the `post-command-hook', for example
3407 `yas--post-command-handler' can check it and reset its value to
3408 nil. The variables value is the point where the violation
3411 (defun yas--on-protection-overlay-modification (_overlay after? _beg _end &optional _length)
3412 "Signals a snippet violation, then issues error.
3414 The error should be ignored in `debug-ignored-errors'"
3415 (unless yas--inhibit-overlay-hooks
3416 (cond ((not (or after?
3417 (yas--undo-in-progress)))
3418 (setq yas--protection-violation (point))
3419 (error "Exit the snippet first!")))))
3421 (add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
3424 ;;; Snippet expansion and "stacked" expansion:
3426 ;; Stacked expansion is when you try to expand a snippet when already
3427 ;; inside a snippet expansion.
3429 ;; The parent snippet does not run its fields modification hooks
3430 ;; (`yas--on-field-overlay-modification' and
3431 ;; `yas--on-protection-overlay-modification') while the child snippet
3432 ;; is active. This means, among other things, that the mirrors of the
3433 ;; parent snippet are not updated, this only happening when one exits
3434 ;; the child snippet.
3436 ;; Unfortunately, this also puts some ugly (and not fully-tested)
3437 ;; bits of code in `yas-expand-snippet' and
3438 ;; `yas--commit-snippet'. I've tried to mark them with "stacked
3441 ;; This was thought to be safer in an undo/redo perspective, but
3442 ;; maybe the correct implementation is to make the globals
3443 ;; `yas--active-field-overlay' and `yas--field-protection-overlays' be
3444 ;; snippet-local and be active even while the child snippet is
3445 ;; running. This would mean a lot of overlay modification hooks
3446 ;; running, but if managed correctly (including overlay priorities)
3447 ;; they should account for all situations...
3449 (defun yas-expand-snippet (content &optional start end expand-env)
3450 "Expand snippet CONTENT at current point.
3452 Text between START and END will be deleted before inserting
3453 template. EXPAND-ENV is are let-style variable to value bindings
3454 considered when expanding the snippet."
3455 (run-hooks 'yas-before-expand-snippet-hook)
3458 (let* ((yas-selected-text (or yas-selected-text
3459 (and (region-active-p)
3460 (buffer-substring-no-properties (region-beginning)
3463 (and (region-active-p)
3467 (and (region-active-p)
3470 (to-delete (and start
3472 (buffer-substring-no-properties start end)))
3475 (setq yas--indent-original-column (current-column))
3476 ;; Delete the region to delete, this *does* get undo-recorded.
3478 (when (and to-delete
3480 (delete-region start end))
3482 (cond ((listp content)
3483 ;; x) This is a snippet-command
3485 (yas--eval-lisp-no-saves content))
3487 ;; x) This is a snippet-snippet :-)
3489 ;; Narrow the region down to the content, shoosh the
3490 ;; `buffer-undo-list', and create the snippet, the new
3491 ;; snippet updates its mirrors once, so we are left with
3492 ;; some plain text. The undo action for deleting this
3493 ;; plain text will get recorded at the end.
3495 ;; stacked expansion: also shoosh the overlay modification hooks
3496 (let ((buffer-undo-list t))
3497 ;; snippet creation might evaluate users elisp, which
3498 ;; might generate errors, so we have to be ready to catch
3499 ;; them mostly to make the undo information
3501 (setq yas--start-column (current-column))
3502 (yas--inhibit-overlay-hooks
3505 (eval `(let* ,expand-env
3507 (yas--snippet-create start (point))))
3509 (yas--snippet-create start (point))))))
3511 ;; stacked-expansion: This checks for stacked expansion, save the
3512 ;; `yas--previous-active-field' and advance its boundary.
3514 (let ((existing-field (and yas--active-field-overlay
3515 (overlay-buffer yas--active-field-overlay)
3516 (overlay-get yas--active-field-overlay 'yas--field))))
3517 (when existing-field
3518 (setf (yas--snippet-previous-active-field snippet) existing-field)
3519 (yas--advance-end-maybe existing-field (overlay-end yas--active-field-overlay))))
3521 ;; Exit the snippet immediately if no fields
3523 (unless (yas--snippet-fields snippet)
3524 (yas-exit-snippet snippet))
3526 ;; Push two undo actions: the deletion of the inserted contents of
3527 ;; the new snippet (without the "key") followed by an apply of
3528 ;; `yas--take-care-of-redo' on the newly inserted snippet boundaries
3530 ;; A small exception, if `yas-also-auto-indent-first-line'
3531 ;; is t and `yas--indent' decides to indent the line to a
3532 ;; point before the actual expansion point, undo would be
3533 ;; messed up. We call the early point "newstart"". case,
3534 ;; and attempt to fix undo.
3536 (let ((newstart (overlay-start (yas--snippet-control-overlay snippet)))
3537 (end (overlay-end (yas--snippet-control-overlay snippet))))
3538 (when (< newstart start)
3539 (push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
3540 (push (cons newstart end) buffer-undo-list)
3541 (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
3543 ;; Now, schedule a move to the first field
3545 (let ((first-field (car (yas--snippet-fields snippet))))
3547 (sit-for 0) ;; fix issue 125
3548 (yas--move-to-field snippet first-field)))
3549 (yas--message 3 "snippet expanded.")
3552 (defun yas--take-care-of-redo (_beg _end snippet)
3553 "Commits SNIPPET, which in turn pushes an undo action for reviving it.
3555 Meant to exit in the `buffer-undo-list'."
3556 ;; slightly optimize: this action is only needed for snippets with
3557 ;; at least one field
3558 (when (yas--snippet-fields snippet)
3559 (yas--commit-snippet snippet)))
3561 (defun yas--snippet-revive (beg end snippet)
3562 "Revives SNIPPET and creates a control overlay from BEG to END.
3564 BEG and END are, we hope, the original snippets boundaries.
3565 All the markers/points exiting existing inside SNIPPET should point
3566 to their correct locations *at the time the snippet is revived*.
3568 After revival, push the `yas--take-care-of-redo' in the
3570 ;; Reconvert all the points to markers
3572 (yas--points-to-markers snippet)
3573 ;; When at least one editable field existed in the zombie snippet,
3574 ;; try to revive the whole thing...
3576 (let ((target-field (or (yas--snippet-active-field snippet)
3577 (car (yas--snippet-fields snippet)))))
3579 (setf (yas--snippet-control-overlay snippet) (yas--make-control-overlay snippet beg end))
3580 (overlay-put (yas--snippet-control-overlay snippet) 'yas--snippet snippet)
3582 (yas--move-to-field snippet target-field)
3584 (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
3585 buffer-undo-list))))
3587 (defun yas--snippet-create (begin end)
3588 "Create a snippet from a template inserted at BEGIN to END.
3590 Returns the newly created snippet."
3592 (narrow-to-region begin end)
3593 (let ((snippet (yas--make-snippet)))
3595 (yas--snippet-parse-create snippet)
3597 ;; Sort and link each field
3598 (yas--snippet-sort-fields snippet)
3600 ;; Create keymap overlay for snippet
3601 (setf (yas--snippet-control-overlay snippet)
3602 (yas--make-control-overlay snippet (point-min) (point-max)))
3605 (goto-char (point-max))
3610 ;;; Apropos adjacencies and "fom's":
3612 ;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
3613 ;; recently expanded snippet, we might actually have many fields,
3614 ;; mirrors (and the snippet exit) in the very same position in the
3615 ;; buffer. Therefore we need to single-link the
3616 ;; fields-or-mirrors-or-exit (which I have abbreviated to "fom")
3617 ;; according to their original positions in the buffer.
3619 ;; Then we have operation `yas--advance-end-maybe' and
3620 ;; `yas--advance-start-maybe', which conditionally push the starts and
3621 ;; ends of these foms down the chain.
3623 ;; This allows for like the printf with the magic ",":
3625 ;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
3626 ;; $2${1:$(if (string-match "%" text) "\);" "")}$0
3628 (defun yas--fom-start (fom)
3629 (cond ((yas--field-p fom)
3630 (yas--field-start fom))
3631 ((yas--mirror-p fom)
3632 (yas--mirror-start fom))
3634 (yas--exit-marker fom))))
3636 (defun yas--fom-end (fom)
3637 (cond ((yas--field-p fom)
3638 (yas--field-end fom))
3639 ((yas--mirror-p fom)
3640 (yas--mirror-end fom))
3642 (yas--exit-marker fom))))
3644 (defun yas--fom-next (fom)
3645 (cond ((yas--field-p fom)
3646 (yas--field-next fom))
3647 ((yas--mirror-p fom)
3648 (yas--mirror-next fom))
3650 (yas--exit-next fom))))
3652 (defun yas--fom-parent-field (fom)
3653 (cond ((yas--field-p fom)
3654 (yas--field-parent-field fom))
3655 ((yas--mirror-p fom)
3656 (yas--mirror-parent-field fom))
3660 (defun yas--calculate-adjacencies (snippet)
3661 "Calculate adjacencies for fields or mirrors of SNIPPET.
3663 This is according to their relative positions in the buffer, and
3664 has to be called before the $-constructs are deleted."
3665 (let* ((fom-set-next-fom
3666 (lambda (fom nextfom)
3667 (cond ((yas--field-p fom)
3668 (setf (yas--field-next fom) nextfom))
3669 ((yas--mirror-p fom)
3670 (setf (yas--mirror-next fom) nextfom))
3672 (setf (yas--exit-next fom) nextfom)))))
3675 (if (= (yas--fom-start fom2) (yas--fom-start fom1))
3676 (yas--mirror-p fom2)
3677 (>= (yas--fom-start fom2) (yas--fom-start fom1)))))
3678 (link-foms fom-set-next-fom))
3679 ;; make some yas--field, yas--mirror and yas--exit soup
3681 (when (yas--snippet-exit snippet)
3682 (push (yas--snippet-exit snippet) soup))
3683 (dolist (field (yas--snippet-fields snippet))
3685 (dolist (mirror (yas--field-mirrors field))
3686 (push mirror soup)))
3688 (sort soup compare-fom-begs))
3690 (reduce link-foms soup)))))
3692 (defun yas--calculate-mirrors-in-fields (snippet mirror)
3693 "Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
3695 Use the tightest containing field if more than one field contains
3696 the mirror. Intended to be called *before* the dollar-regions are
3698 (let ((min (point-min))
3700 (dolist (field (yas--snippet-fields snippet))
3701 (when (and (<= (yas--field-start field) (yas--mirror-start mirror))
3702 (<= (yas--mirror-end mirror) (yas--field-end field))
3703 (< min (yas--field-start field))
3704 (< (yas--field-end field) max))
3705 (setq min (yas--field-start field)
3706 max (yas--field-end field))
3707 (setf (yas--mirror-parent-field mirror) field)))))
3709 (defun yas--advance-end-maybe (fom newend)
3710 "Maybe advance FOM's end to NEWEND if it needs it.
3714 * call `yas--advance-start-maybe' on FOM's next fom.
3716 * in case FOM is field call `yas--advance-end-maybe' on its parent
3719 Also, if FOM is an exit-marker, always call
3720 `yas--advance-start-maybe' on its next fom. This is because
3721 exit-marker have identical start and end markers."
3722 (cond ((and fom (< (yas--fom-end fom) newend))
3723 (set-marker (yas--fom-end fom) newend)
3724 (yas--advance-start-maybe (yas--fom-next fom) newend)
3725 (yas--advance-end-of-parents-maybe (yas--fom-parent-field fom) newend))
3727 (yas--advance-start-maybe (yas--fom-next fom) newend))))
3729 (defun yas--advance-start-maybe (fom newstart)
3730 "Maybe advance FOM's start to NEWSTART if it needs it.
3732 If it does, also call `yas--advance-end-maybe' on FOM."
3733 (when (and fom (< (yas--fom-start fom) newstart))
3734 (set-marker (yas--fom-start fom) newstart)
3735 (yas--advance-end-maybe fom newstart)))
3737 (defun yas--advance-end-of-parents-maybe (field newend)
3738 "Like `yas--advance-end-maybe' but for parent fields.
3740 Only works for fields and doesn't care about the start of the
3741 next FOM. Works its way up recursively for parents of parents."
3743 (< (yas--field-end field) newend))
3744 (set-marker (yas--field-end field) newend)
3745 (yas--advance-end-of-parents-maybe (yas--field-parent-field field) newend)))
3747 (defvar yas--dollar-regions nil
3748 "When expanding the snippet the \"parse-create\" functions add
3749 cons cells to this var.")
3751 (defvar yas--backquote-markers-and-strings nil
3752 "List of (MARKER . STRING) marking where the values from
3753 backquoted Lisp expressions should be inserted at the end of
3756 (defun yas--snippet-parse-create (snippet)
3757 "Parse a recently inserted snippet template, creating all
3758 necessary fields, mirrors and exit points.
3760 Meant to be called in a narrowed buffer, does various passes"
3761 (let ((parse-start (point)))
3762 ;; Reset the yas--dollar-regions
3764 (setq yas--dollar-regions nil)
3765 ;; protect just the backquotes
3767 (yas--protect-escapes nil '(?`))
3768 ;; replace all backquoted expressions
3770 (goto-char parse-start)
3771 (yas--save-backquotes)
3772 ;; protect escaped characters
3774 (yas--protect-escapes)
3775 ;; parse fields with {}
3777 (goto-char parse-start)
3778 (yas--field-parse-create snippet)
3779 ;; parse simple mirrors and fields
3781 (goto-char parse-start)
3782 (yas--simple-mirror-parse-create snippet)
3783 ;; parse mirror transforms
3785 (goto-char parse-start)
3786 (yas--transform-mirror-parse-create snippet)
3787 ;; calculate adjacencies of fields and mirrors
3789 (yas--calculate-adjacencies snippet)
3790 ;; Delete $-constructs
3792 (save-restriction (widen) (yas--delete-regions yas--dollar-regions))
3793 ;; restore backquoted expression values
3795 (yas--restore-backquotes)
3798 (goto-char parse-start)
3799 (yas--restore-escapes)
3800 ;; update mirrors for the first time
3802 (yas--update-mirrors snippet)
3803 ;; indent the best we can
3805 (goto-char parse-start)
3806 (yas--indent snippet)))
3808 (defun yas--indent-according-to-mode (snippet-markers)
3809 "Indent current line according to mode, preserving SNIPPET-MARKERS."
3810 ;;; Apropos indenting problems....
3812 ;; `indent-according-to-mode' uses whatever `indent-line-function'
3813 ;; is available. Some implementations of these functions delete text
3814 ;; before they insert. If there happens to be a marker just after
3815 ;; the text being deleted, the insertion actually happens after the
3816 ;; marker, which misplaces it.
3818 ;; This would also happen if we had used overlays with the
3819 ;; `front-advance' property set to nil.
3821 ;; This is why I have these `trouble-markers', they are the ones at
3822 ;; they are the ones at the first non-whitespace char at the line
3823 ;; (i.e. at `yas--real-line-beginning'. After indentation takes place
3824 ;; we should be at the correct to restore them to. All other
3825 ;; non-trouble-markers have been *pushed* and don't need special
3828 (goto-char (yas--real-line-beginning))
3829 (let ((trouble-markers (remove-if-not #'(lambda (marker)
3835 (indent-according-to-mode)
3836 (error (yas--message 3 "Warning: `yas--indent-according-to-mode' having problems running %s" indent-line-function)
3838 (mapc #'(lambda (marker)
3839 (set-marker marker (point)))
3842 (defvar yas--indent-original-column nil)
3843 (defun yas--indent (snippet)
3844 (let ((snippet-markers (yas--collect-snippet-markers snippet)))
3845 ;; Look for those $>
3847 (while (re-search-forward "$>" nil t)
3848 (delete-region (match-beginning 0) (match-end 0))
3849 (when (not (eq yas-indent-line 'auto))
3850 (yas--indent-according-to-mode snippet-markers))))
3851 ;; Now do stuff for 'fixed and 'auto
3853 (cond ((eq yas-indent-line 'fixed)
3854 (while (and (zerop (forward-line))
3855 (zerop (current-column)))
3856 (indent-to-column yas--indent-original-column)))
3857 ((eq yas-indent-line 'auto)
3858 (let ((end (set-marker (make-marker) (point-max)))
3859 (indent-first-line-p yas-also-auto-indent-first-line))
3860 (while (and (zerop (if indent-first-line-p
3863 (setq indent-first-line-p nil))
3867 (yas--indent-according-to-mode snippet-markers))))
3871 (defun yas--collect-snippet-markers (snippet)
3872 "Make a list of all the markers used by SNIPPET."
3874 (dolist (field (yas--snippet-fields snippet))
3875 (push (yas--field-start field) markers)
3876 (push (yas--field-end field) markers)
3877 (dolist (mirror (yas--field-mirrors field))
3878 (push (yas--mirror-start mirror) markers)
3879 (push (yas--mirror-end mirror) markers)))
3880 (let ((snippet-exit (yas--snippet-exit snippet)))
3881 (when (and snippet-exit
3882 (marker-buffer (yas--exit-marker snippet-exit)))
3883 (push (yas--exit-marker snippet-exit) markers)))
3886 (defun yas--real-line-beginning ()
3887 (let ((c (char-after (line-beginning-position)))
3888 (n (line-beginning-position)))
3889 (while (or (eql c ?\ )
3892 (setq c (char-after n)))
3895 (defun yas--escape-string (escaped)
3896 (concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
3898 (defun yas--protect-escapes (&optional text escaped)
3899 "Protect all escaped characters with their numeric ASCII value.
3901 With optional string TEXT do it in string instead of buffer."
3902 (let ((changed-text text)
3903 (text-provided-p text))
3904 (mapc #'(lambda (escaped)
3906 (yas--replace-all (concat "\\" (char-to-string escaped))
3907 (yas--escape-string escaped)
3908 (when text-provided-p changed-text))))
3909 (or escaped yas--escaped-characters))
3912 (defun yas--restore-escapes (&optional text escaped)
3913 "Restore all escaped characters from their numeric ASCII value.
3915 With optional string TEXT do it in string instead of the buffer."
3916 (let ((changed-text text)
3917 (text-provided-p text))
3918 (mapc #'(lambda (escaped)
3920 (yas--replace-all (yas--escape-string escaped)
3921 (char-to-string escaped)
3922 (when text-provided-p changed-text))))
3923 (or escaped yas--escaped-characters))
3926 (defun yas--save-backquotes ()
3927 "Save all the \"`(lisp-expression)`\"-style expressions
3928 with their evaluated value into `yas--backquote-markers-and-strings'."
3929 (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
3930 (let ((current-string (match-string-no-properties 1)) transformed)
3931 (delete-region (match-beginning 0) (match-end 0))
3932 (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
3933 (goto-char (match-beginning 0))
3935 (let ((marker (make-marker)))
3936 (insert "Y") ;; quite horrendous, I love it :)
3937 (set-marker marker (point))
3939 (push (cons marker transformed) yas--backquote-markers-and-strings))))))
3941 (defun yas--restore-backquotes ()
3942 "Replace markers in `yas--backquote-markers-and-strings' with their values."
3943 (while yas--backquote-markers-and-strings
3944 (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
3945 (marker (car marker-and-string))
3946 (string (cdr marker-and-string)))
3952 (set-marker marker nil)))))
3954 (defun yas--scan-sexps (from count)
3956 (with-syntax-table (standard-syntax-table)
3957 (scan-sexps from count))
3961 (defun yas--make-marker (pos)
3962 "Create a marker at POS with nil `marker-insertion-type'."
3963 (let ((marker (set-marker (make-marker) pos)))
3964 (set-marker-insertion-type marker nil)
3967 (defun yas--field-parse-create (snippet &optional parent-field)
3968 "Parse most field expressions in SNIPPET, except for the simple one \"$n\".
3970 The following count as a field:
3972 * \"${n: text}\", for a numbered field with default text, as long as N is not 0;
3974 * \"${n: text$(expression)}, the same with a Lisp expression;
3975 this is caught with the curiously named `yas--multi-dollar-lisp-expression-regexp'
3977 * the same as above but unnumbered, (no N:) and number is calculated automatically.
3979 When multiple expressions are found, only the last one counts."
3982 (while (re-search-forward yas--field-regexp nil t)
3983 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
3984 (number (and (match-string-no-properties 1)
3985 (string-to-number (match-string-no-properties 1))))
3986 (brand-new-field (and real-match-end-0
3987 ;; break if on "$(" immediately
3988 ;; after the ":", this will be
3989 ;; caught as a mirror with
3991 (not (save-match-data
3992 (eq (string-match "$[ \t\n]*("
3993 (match-string-no-properties 2)) 0)))
3994 ;; allow ${0: some exit text}
3995 ;; (not (and number (zerop number)))
3996 (yas--make-field number
3997 (yas--make-marker (match-beginning 2))
3998 (yas--make-marker (1- real-match-end-0))
4000 (when brand-new-field
4001 (goto-char real-match-end-0)
4002 (push (cons (1- real-match-end-0) real-match-end-0)
4003 yas--dollar-regions)
4004 (push (cons (match-beginning 0) (match-beginning 2))
4005 yas--dollar-regions)
4006 (push brand-new-field (yas--snippet-fields snippet))
4009 (narrow-to-region (yas--field-start brand-new-field) (yas--field-end brand-new-field))
4010 (goto-char (point-min))
4011 (yas--field-parse-create snippet brand-new-field)))))))
4012 ;; if we entered from a parent field, now search for the
4013 ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
4014 ;; primary field transformations
4018 (while (re-search-forward yas--multi-dollar-lisp-expression-regexp nil t)
4019 (let* ((real-match-end-1 (yas--scan-sexps (match-beginning 1) 1)))
4020 ;; commit the primary field transformation if:
4022 ;; 1. we don't find it in yas--dollar-regions (a subnested
4023 ;; field) might have already caught it.
4025 ;; 2. we really make sure we have either two '$' or some
4026 ;; text and a '$' after the colon ':'. This is a FIXME: work
4027 ;; my regular expressions and end these ugly hacks.
4029 (when (and real-match-end-1
4030 (not (member (cons (match-beginning 0)
4032 yas--dollar-regions))
4034 (char-before (1- (match-beginning 1))))))
4035 (let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
4037 (setf (yas--field-transform parent-field)
4038 (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
4039 (push (cons (match-beginning 0) real-match-end-1)
4040 yas--dollar-regions)))))))
4042 (defun yas--transform-mirror-parse-create (snippet)
4043 "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
4044 (while (re-search-forward yas--transform-mirror-regexp nil t)
4045 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4046 (number (string-to-number (match-string-no-properties 1)))
4048 (not (zerop number))
4049 (yas--snippet-find-field snippet number)))
4051 (and real-match-end-0
4053 (yas--make-mirror (yas--make-marker (match-beginning 0))
4054 (yas--make-marker (match-beginning 0))
4056 (yas--restore-escapes
4057 (buffer-substring-no-properties (match-beginning 2)
4058 (1- real-match-end-0))))))))
4059 (when brand-new-mirror
4060 (push brand-new-mirror
4061 (yas--field-mirrors field))
4062 (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
4063 (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
4065 (defun yas--simple-mirror-parse-create (snippet)
4066 "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
4067 (while (re-search-forward yas--simple-mirror-regexp nil t)
4068 (let ((number (string-to-number (match-string-no-properties 1))))
4069 (cond ((zerop number)
4071 (setf (yas--snippet-exit snippet)
4072 (yas--make-exit (yas--make-marker (match-end 0))))
4074 (goto-char (match-beginning 0))
4075 (when yas-wrap-around-region
4076 (cond (yas-selected-text
4077 (insert yas-selected-text))
4078 ((and (eq yas-wrap-around-region 'cua)
4081 (insert (prog1 (get-register ?0)
4082 (set-register ?0 nil))))))
4083 (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
4084 yas--dollar-regions)))
4086 (let ((field (yas--snippet-find-field snippet number)))
4088 (let ((brand-new-mirror (yas--make-mirror
4089 (yas--make-marker (match-beginning 0))
4090 (yas--make-marker (match-beginning 0))
4092 (push brand-new-mirror
4093 (yas--field-mirrors field))
4094 (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
4095 (push (yas--make-field number
4096 (yas--make-marker (match-beginning 0))
4097 (yas--make-marker (match-beginning 0))
4099 (yas--snippet-fields snippet))))
4100 (push (cons (match-beginning 0) (match-end 0))
4101 yas--dollar-regions))))))
4103 (defun yas--delete-regions (regions)
4104 "Sort disjuct REGIONS by start point, then delete from the back."
4105 (mapc #'(lambda (reg)
4106 (delete-region (car reg) (cdr reg)))
4109 (>= (car r1) (car r2))))))
4111 (defun yas--calculate-mirror-depth (mirror &optional traversed)
4112 (let* ((parent (yas--mirror-parent-field mirror))
4113 (parents-mirrors (and parent
4114 (yas--field-mirrors parent))))
4115 (or (yas--mirror-depth mirror)
4116 (setf (yas--mirror-depth mirror)
4117 (cond ((memq mirror traversed)
4119 ((and parent parents-mirrors)
4121 (mapcar #'(lambda (m)
4122 (yas--calculate-mirror-depth m
4131 (defun yas--update-mirrors (snippet)
4132 "Update all the mirrors of SNIPPET."
4134 (dolist (field-and-mirror (sort
4135 ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
4136 ;; where F is the field that M is mirroring
4138 (mapcan #'(lambda (field)
4139 (mapcar #'(lambda (mirror)
4140 (cons field mirror))
4141 (yas--field-mirrors field)))
4142 (yas--snippet-fields snippet))
4143 ;; then sort this list so that entries with mirrors with parent
4144 ;; fields appear before. This was important for fixing #290, and
4145 ;; luckily also handles the case where a mirror in a field causes
4146 ;; another mirror to need reupdating
4148 #'(lambda (field-and-mirror1 field-and-mirror2)
4149 (> (yas--calculate-mirror-depth (cdr field-and-mirror1))
4150 (yas--calculate-mirror-depth (cdr field-and-mirror2))))))
4151 (let* ((field (car field-and-mirror))
4152 (mirror (cdr field-and-mirror))
4153 (parent-field (yas--mirror-parent-field mirror)))
4154 ;; before updating a mirror with a parent-field, maybe advance
4158 (yas--advance-start-maybe mirror (yas--fom-start parent-field)))
4159 ;; update this mirror
4161 (yas--mirror-update-display mirror field)
4162 ;; `yas--place-overlays' is needed if the active field and
4163 ;; protected overlays have been changed because of insertions
4164 ;; in `yas--mirror-update-display'
4166 (when (eq field (yas--snippet-active-field snippet))
4167 (yas--place-overlays snippet field))))))
4169 (defun yas--mirror-update-display (mirror field)
4170 "Update MIRROR according to FIELD (and mirror transform)."
4172 (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
4173 (reflection (and (not (and mirror-parent-field
4174 (yas--field-modified-p mirror-parent-field)))
4175 (or (yas--apply-transform mirror field 'empty-on-nil)
4176 (yas--field-text-for-display field)))))
4177 (when (and reflection
4178 (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
4179 (yas--mirror-end mirror)))))
4180 (goto-char (yas--mirror-start mirror))
4181 (yas--inhibit-overlay-hooks
4182 (insert reflection))
4183 (if (> (yas--mirror-end mirror) (point))
4184 (delete-region (point) (yas--mirror-end mirror))
4185 (set-marker (yas--mirror-end mirror) (point))
4186 (yas--advance-start-maybe (yas--mirror-next mirror) (point))
4187 ;; super-special advance
4188 (yas--advance-end-of-parents-maybe mirror-parent-field (point))))))
4190 (defun yas--field-update-display (field)
4191 "Much like `yas--mirror-update-display', but for fields."
4192 (when (yas--field-transform field)
4193 (let ((transformed (and (not (eq (yas--field-number field) 0))
4194 (yas--apply-transform field field))))
4195 (when (and transformed
4196 (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
4197 (yas--field-end field)))))
4198 (setf (yas--field-modified-p field) t)
4199 (goto-char (yas--field-start field))
4200 (yas--inhibit-overlay-hooks
4201 (insert transformed)
4202 (if (> (yas--field-end field) (point))
4203 (delete-region (point) (yas--field-end field))
4204 (set-marker (yas--field-end field) (point))
4205 (yas--advance-start-maybe (yas--field-next field) (point)))
4209 ;;; Post-command hook:
4211 (defun yas--post-command-handler ()
4212 "Handles various yasnippet conditions after each command."
4213 (cond (yas--protection-violation
4214 (goto-char yas--protection-violation)
4215 (setq yas--protection-violation nil))
4216 ((eq 'undo this-command)
4218 ;; After undo revival the correct field is sometimes not
4219 ;; restored correctly, this condition handles that
4221 (let* ((snippet (car (yas--snippets-at-point)))
4222 (target-field (and snippet
4223 (find-if-not #'(lambda (field)
4224 (yas--field-probably-deleted-p snippet field))
4226 (cons (yas--snippet-active-field snippet)
4227 (yas--snippet-fields snippet)))))))
4229 (yas--move-to-field snippet target-field))))
4230 ((not (yas--undo-in-progress))
4231 ;; When not in an undo, check if we must commit the snippet
4232 ;; (user exited it).
4233 (yas--check-commit-snippet))))
4237 ;; The docstrings for some functions are generated dynamically
4238 ;; depending on the context.
4240 (put 'yas-expand 'function-documentation
4241 '(yas--expand-from-trigger-key-doc t))
4242 (defun yas--expand-from-trigger-key-doc (context)
4243 "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
4244 (let* ((yas-fallback-behavior (and context yas-fallback-behavior))
4245 (fallback-description
4246 (cond ((eq yas-fallback-behavior 'call-other-command)
4247 (let* ((fallback (yas--keybinding-beyond-yasnippet)))
4249 (format "call command `%s'."
4250 (pp-to-string fallback)))
4251 "do nothing (`yas-expand' doesn't shadow\nanything).")))
4252 ((eq yas-fallback-behavior 'return-nil)
4254 (t "defer to `yas-fallback-behavior' (which see)."))))
4255 (concat "Expand a snippet before point. If no snippet
4256 expansion is possible, "
4257 fallback-description
4258 "\n\nOptional argument FIELD is for non-interactive use and is an
4259 object satisfying `yas--field-p' to restrict the expansion to.")))
4261 (put 'yas-expand-from-keymap 'function-documentation
4262 '(yas--expand-from-keymap-doc t))
4263 (defun yas--expand-from-keymap-doc (context)
4264 "A doc synthesizer for `yas--expand-from-keymap-doc'."
4265 (add-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce)
4266 (concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
4267 (when (and context (eq this-command 'describe-key))
4268 (let* ((vec (this-single-command-keys))
4269 (templates (mapcan #'(lambda (table)
4270 (yas--fetch table vec))
4271 (yas--get-snippet-tables)))
4272 (yas--direct-keymaps nil)
4273 (fallback (key-binding vec)))
4274 (concat "In this case, "
4276 (concat "these snippets are bound to this key:\n"
4277 (yas--template-pretty-list templates)
4278 "\n\nIf none of these expands, "))
4280 (format "fallback `%s' will be called." (pp-to-string fallback)))
4281 "no fallback keybinding is called."))))))
4283 (defun yas--template-pretty-list (templates)
4285 (yas-buffer-local-condition 'always))
4286 (dolist (plate templates)
4287 (setq acc (concat acc "\n*) "
4288 (propertize (concat "\\\\snippet `" (car plate) "'")
4289 'yasnippet (cdr plate)))))
4292 (define-button-type 'help-snippet-def
4293 :supertype 'help-xref
4294 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
4295 'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
4297 (defun yas--snippet-description-finish-runonce ()
4298 "Final adjustments for the help buffer when snippets are concerned."
4299 (yas--create-snippet-xrefs)
4300 (remove-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce))
4302 (defun yas--create-snippet-xrefs ()
4304 (goto-char (point-min))
4305 (while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
4306 (let ((template (get-text-property (match-beginning 1)
4309 (help-xref-button 1 'help-snippet-def template)
4310 (kill-region (match-end 1) (match-end 0))
4311 (kill-region (match-beginning 0) (match-beginning 1)))))))
4315 (defvar yas-verbosity 4
4316 "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
4318 (defun yas--message (level message &rest args)
4319 "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
4320 (when (> yas-verbosity level)
4321 (message "%s" (apply #'yas--format message args))))
4323 (defun yas--format (format-control &rest format-args)
4324 (apply #'format (concat "[yas] " format-control) format-args))
4331 ;; `locate-dominating-file'
4332 ;; `region-active-p'
4334 ;; added for compatibility in emacsen < 23
4335 (unless (>= emacs-major-version 23)
4336 (unless (fboundp 'region-active-p)
4337 (defun region-active-p () (and transient-mark-mode mark-active)))
4339 (unless (fboundp 'locate-dominating-file)
4340 (defvar locate-dominating-stop-dir-regexp
4341 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
4342 "Regexp of directory names which stop the search in `locate-dominating-file'.
4343 Any directory whose name matches this regexp will be treated like
4344 a kind of root directory by `locate-dominating-file' which will stop its search
4345 when it bumps into it.
4346 The default regexp prevents fruitless and time-consuming attempts to find
4347 special files in directories in which filenames are interpreted as hostnames,
4348 or mount points potentially requiring authentication as a different user.")
4350 (defun locate-dominating-file (file name)
4351 "Look up the directory hierarchy from FILE for a file named NAME.
4352 Stop at the first parent directory containing a file NAME,
4353 and return the directory. Return nil if not found."
4354 ;; We used to use the above locate-dominating-files code, but the
4355 ;; directory-files call is very costly, so we're much better off doing
4356 ;; multiple calls using the code in here.
4358 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
4359 ;; `name' in /home or in /.
4360 (setq file (abbreviate-file-name file))
4363 (while (not (or root
4365 ;; FIXME: Disabled this heuristic because it is sometimes
4367 ;; As a heuristic, we stop looking up the hierarchy of
4368 ;; directories as soon as we find a directory belonging
4369 ;; to another user. This should save us from looking in
4370 ;; things like /net and /afs. This assumes that all the
4371 ;; files inside a project belong to the same user.
4372 ;; (let ((prev-user user))
4373 ;; (setq user (nth 2 (file-attributes file)))
4374 ;; (and prev-user (not (equal user prev-user))))
4375 (string-match locate-dominating-stop-dir-regexp file)))
4376 (setq try (file-exists-p (expand-file-name name file)))
4377 (cond (try (setq root file))
4378 ((equal file (setq file (file-name-directory
4379 (directory-file-name file))))
4384 ;;; Backward compatibility to yasnippet <= 0.7
4386 (defvar yas--backported-syms '(;; `defcustom's
4389 yas-prompt-functions
4391 yas-also-auto-indent-first-line
4393 yas-triggers-in-field
4394 yas-fallback-behavior
4395 yas-choose-keys-first
4396 yas-choose-tables-first
4399 yas-wrap-around-region
4402 yas-expand-only-for-last-commands
4403 yas-field-highlight-face
4405 ;; these vars can be customized as well
4411 yas-after-exit-snippet-hook
4412 yas-before-expand-snippet-hook
4413 yas-buffer-local-condition
4416 ;; prompting functions
4421 yas-completing-prompt
4424 ;; interactive functions
4429 yas-direct-keymaps-reload
4433 yas-compile-directory
4436 yas-expand-from-trigger-key
4437 yas-expand-from-keymap
4439 yas-visit-snippet-file
4441 yas-load-snippet-buffer
4444 yas-next-field-or-maybe-expand
4449 yas-exit-all-snippets
4450 yas-skip-and-clear-or-delete-char
4452 ;; symbols that I "exported" for use
4453 ;; in snippets and hookage
4470 yas-default-from-field
4473 yas-define-condition-cache
4474 yas-hippie-try-expand
4476 ;; debug definitions
4477 ;; yas-debug-snippet-vars
4478 ;; yas-exterminate-package
4481 ;; testing definitions
4482 ;; yas-should-expand
4483 ;; yas-should-not-expand
4485 ;; yas-make-file-or-dirs
4487 ;; yas-saving-variables
4488 ;; yas-call-with-snippet-dirs
4489 ;; yas-with-snippet-dirs
4491 "Backported yasnippet symbols.
4493 They are mapped to \"yas/*\" variants.")
4495 (dolist (sym yas--backported-syms)
4496 (let ((backported (intern (replace-regexp-in-string "^yas-" "yas/" (symbol-name sym)))))
4498 (make-obsolete-variable backported sym "yasnippet 0.8")
4499 (defvaralias backported sym))
4501 (make-obsolete backported sym "yasnippet 0.8")
4502 (defalias backported sym))))
4504 (defvar yas--exported-syms
4506 (mapatoms (lambda (atom)
4507 (if (and (or (and (boundp atom)
4508 (not (get atom 'byte-obsolete-variable)))
4510 (not (get atom 'byte-obsolete-info))))
4511 (string-match-p "^yas-[^-]" (symbol-name atom)))
4512 (push atom exported))))
4514 "Exported yasnippet symbols.
4516 i.e. the ones with \"yas-\" single dash prefix. I will try to
4517 keep them in future yasnippet versions and other elisp libraries
4518 can more or less safely rely upon them.")
4521 (provide 'yasnippet)
4523 ;;; yasnippet.el ends here
4526 ;; byte-compile-warnings: (not cl-functions)