Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
4293 lines (3766 sloc) 170 KB
;;; Yasnippet.el --- Yet another snippet extension for Emacs.
;; Copyright 2008 pluskid
;; 2009 pluskid, joaotavora
;; Authors: pluskid <>, joaotavora <>
;; Version: 0.7.0
;; Package-version: 0.7.0
;; X-URL:
;; Keywords: convenience, emulation
;; URL:
;; EmacsWiki: YaSnippetMode
;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary:
;; Basic steps to setup:
;; (add-to-list 'load-path
;; "~/.emacs.d/plugins/yasnippet")
;; (require 'yasnippet) ;; not yasnippet-bundle
;; (yas/global-mode 1)
;; Interesting variables are:
;; `yas/snippet-dirs'
;; The directory where user-created snippets are to be
;; stored. Can also be a list of directories. In that case,
;; when used for bulk (re)loading of snippets (at startup or
;; via `yas/reload-all'), directories appearing earlier in
;; the list shadow other dir's snippets. Also, the first
;; directory is taken as the default for storing the user's
;; new snippets.
;; The deprecated `yas/root-directory' aliases this variable
;; for backward-compatibility.
;; `yas/extra-modes'
;; A local variable that you can set in a hook to override
;; snippet-lookup based on major mode. It is a a symbol (or
;; list of symbols) that correspond to subdirectories of
;; `yas/snippet-dirs' and is used for deciding which
;; snippets to consider for the active buffer.
;; Deprecated `yas/mode-symbol' aliases this variable for
;; backward-compatibility.
;; Major commands are:
;; M-x yas/expand
;; Try to expand snippets before point. In `yas/minor-mode',
;; this is bound to `yas/trigger-key' which you can customize.
;; M-x yas/load-directory
;; Prompts you for a directory hierarchy of snippets to load.
;; M-x yas/insert-snippet
;; Prompts you for possible snippet expansion if that is
;; possible according to buffer-local and snippet-local
;; expansion conditions. With prefix argument, ignore these
;; conditions.
;; M-x yas/find-snippets
;; Lets you find the snippet files in the correct
;; subdirectory of `yas/snippet-dirs', according to the
;; active major mode (if it exists) like
;; `find-file-other-window'.
;; M-x yas/visit-snippet-file
;; Prompts you for possible snippet expansions like
;; `yas/insert-snippet', but instead of expanding it, takes
;; you directly to the snippet definition's file, if it
;; exists.
;; M-x yas/new-snippet
;; Lets you create a new snippet file in the correct
;; subdirectory of `yas/snippet-dirs', according to the
;; active major mode.
;; M-x yas/load-snippet-buffer
;; When editing a snippet, this loads the snippet. This is
;; bound to "C-c C-c" while in the `snippet-mode' editing
;; mode.
;; M-x yas/tryout-snippet
;; When editing a snippet, this opens a new empty buffer,
;; sets it to the appropriate major mode and inserts the
;; snippet there, so you can see what it looks like. This is
;; bound to "C-c C-t" while in `snippet-mode'.
;; M-x yas/describe-tables
;; Lists known snippets in a separate buffer. User is
;; prompted as to whether only the currently active tables
;; are to be displayed, or all the tables for all major
;; modes.
;; The `dropdown-list.el' extension is bundled with YASnippet, you
;; can optionally use it the preferred "prompting method", puting in
;; your .emacs file, for example:
;; (require 'dropdown-list)
;; (setq yas/prompt-functions '(yas/dropdown-prompt
;; yas/ido-prompt
;; yas/completing-prompt))
;; Also check out the customization group
;; M-x customize-group RET yasnippet RET
;; If you use the customization group to set variables
;; `yas/snippet-dirs' or `yas/global-mode', make sure the path to
;; "yasnippet.el" is present in the `load-path' *before* the
;; `custom-set-variables' is executed in your .emacs file.
;; For more information and detailed usage, refer to the project page:
;;; Code:
(require 'cl)
(require 'assoc)
(require 'easymenu)
(require 'help-mode)
;;; User customizable variables
(defgroup yasnippet nil
"Yet Another Snippet extension"
:group 'editing)
(defvar yas/load-file-name load-file-name
"Store the filename that yasnippet.el was originally loaded from.")
(defcustom yas/snippet-dirs (remove nil
(list "~/.emacs.d/snippets"
(when yas/load-file-name
(concat (file-name-directory yas/load-file-name) "snippets"))))
"Directory or list of snippet dirs for each major mode.
The directory where user-created snippets are to be stored. Can
also be a list of directories. In that case, when used for
bulk (re)loading of snippets (at startup or via
`yas/reload-all'), directories appearing earlier in the list
shadow other dir's snippets. Also, the first directory is taken
as the default for storing the user's new snippets."
:type '(choice (string :tag "Single directory (string)")
(repeat :args (string) :tag "List of directories (strings)"))
:group 'yasnippet
:require 'yasnippet
:set #'(lambda (symbol new)
(let ((old (and (boundp symbol)
(symbol-value symbol))))
(set-default symbol new)
(unless (or (not (fboundp 'yas/reload-all))
(equal old new))
(defun yas/snippet-dirs ()
(if (listp yas/snippet-dirs) yas/snippet-dirs (list yas/snippet-dirs)))
(defvaralias 'yas/root-directory 'yas/snippet-dirs)
(defcustom yas/prompt-functions '(yas/x-prompt
"Functions to prompt for keys, templates, etc interactively.
These functions are called with the following arguments:
- PROMPT: A string to prompt the user
- CHOICES: a list of strings or objects.
- optional DISPLAY-FN : A function that, when applied to each of
the objects in CHOICES will return a string.
The return value of any function you put here should be one of
the objects in CHOICES, properly formatted with DISPLAY-FN (if
that is passed).
- To signal that your particular style of prompting is
unavailable at the moment, you can also have the function return
- To signal that the user quit the prompting process, you can
signal `quit' with
(signal 'quit \"user quit!\")."
:type '(repeat function)
:group 'yasnippet)
(defcustom yas/indent-line 'auto
"Controls indenting applied to a recent snippet expansion.
The following values are possible:
- `fixed' Indent the snippet to the current column;
- `auto' Indent each line of the snippet with `indent-according-to-mode'
Every other value means don't apply any snippet-side indendation
after expansion (the manual per-line \"$>\" indentation still
:type '(choice (const :tag "Nothing" nothing)
(const :tag "Fixed" fixed)
(const :tag "Auto" auto))
:group 'yasnippet)
(defcustom yas/also-auto-indent-first-line nil
"Non-nil means also auto indent first line according to mode.
Naturally this is only valid when `yas/indent-line' is `auto'"
:type 'boolean
:group 'yasnippet)
(defcustom yas/snippet-revival t
"Non-nil means re-activate snippet fields after undo/redo."
:type 'boolean
:group 'yasnippet)
(defcustom yas/trigger-key "TAB"
"The key bound to `yas/expand' when function `yas/minor-mode' is active.
Value is a string that is converted to the internal Emacs key
representation using `read-kbd-macro'."
:type 'string
:group 'yasnippet
:set #'(lambda (symbol key)
(let ((old (and (boundp symbol)
(symbol-value symbol))))
(set-default symbol key)
;; On very first loading of this defcustom,
;; `yas/trigger-key' is *not* loaded.
(if (fboundp 'yas/trigger-key-reload)
(yas/trigger-key-reload old)))))
(defcustom yas/next-field-key '("TAB" "<tab>")
"The key to navigate to next field when a snippet is active.
Value is a string that is converted to the internal Emacs key
representation using `read-kbd-macro'.
Can also be a list of strings."
:type '(choice (string :tag "String")
(repeat :args (string) :tag "List of strings"))
:group 'yasnippet
:set #'(lambda (symbol val)
(set-default symbol val)
(if (fboundp 'yas/init-yas-in-snippet-keymap)
(defcustom yas/prev-field-key '("<backtab>" "<S-tab>")
"The key to navigate to previous field when a snippet is active.
Value is a string that is converted to the internal Emacs key
representation using `read-kbd-macro'.
Can also be a list of strings."
:type '(choice (string :tag "String")
(repeat :args (string) :tag "List of strings"))
:group 'yasnippet
:set #'(lambda (symbol val)
(set-default symbol val)
(if (fboundp 'yas/init-yas-in-snippet-keymap)
(defcustom yas/skip-and-clear-key '("C-d" "<delete>" "<deletechar>")
"The key to clear the currently active field.
Value is a string that is converted to the internal Emacs key
representation using `read-kbd-macro'.
Can also be a list of strings."
:type '(choice (string :tag "String")
(repeat :args (string) :tag "List of strings"))
:group 'yasnippet
:set #'(lambda (symbol val)
(set-default symbol val)
(if (fboundp 'yas/init-yas-in-snippet-keymap)
(defcustom yas/triggers-in-field nil
"If non-nil, `yas/next-field-key' can trigger stacked expansions.
Otherwise, `yas/next-field-key' just tries to move on to the next
:type 'boolean
:group 'yasnippet)
(defcustom yas/fallback-behavior 'call-other-command
"How to act when `yas/trigger-key' does *not* expand a snippet.
- `call-other-command' means try to temporarily disable YASnippet
and call the next command bound to `yas/trigger-key'.
- nil or the symbol `return-nil' mean do nothing. (and
`yas/expand-returns' nil)
- A lisp form (apply COMMAND . ARGS) means interactively call
COMMAND, if ARGS is non-nil, call COMMAND non-interactively
with ARGS as arguments."
:type '(choice (const :tag "Call previous command" call-other-command)
(const :tag "Do nothing" return-nil))
:group 'yasnippet)
(defcustom yas/choose-keys-first nil
"If non-nil, prompt for snippet key first, then for template.
Otherwise prompts for all possible snippet names.
This affects `yas/insert-snippet' and `yas/visit-snippet-file'."
:type 'boolean
:group 'yasnippet)
(defcustom yas/choose-tables-first nil
"If non-nil, and multiple eligible snippet tables, prompts user for tables first.
Otherwise, user chooses between the merging together of all
eligible tables.
This affects `yas/insert-snippet', `yas/visit-snippet-file'"
:type 'boolean
:group 'yasnippet)
(defcustom yas/use-menu 'abbreviate
"Display a YASnippet menu in the menu bar.
When non-nil, submenus for each snippet table will be listed
under the menu \"Yasnippet\".
- If set to `real-modes' only submenus whose name more or less
corresponds to a major mode are listed.
- If set to `abbreviate', only the current major-mode
menu and the modes set in `yas/extra-modes' are listed.
Any other non-nil value, every submenu is listed."
:type '(choice (const :tag "Full" t)
(const :tag "Real modes only" real-modes)
(const :tag "Abbreviate" abbreviate))
:group 'yasnippet)
(defcustom yas/trigger-symbol " =>"
"The text that will be used in menu to represent the trigger."
:type 'string
:group 'yasnippet)
(defcustom yas/wrap-around-region nil
"If non-nil, snippet expansion wraps around selected region.
The wrapping occurs just before the snippet's exit marker. This
can be overriden on a per-snippet basis."
:type 'boolean
:group 'yasnippet)
(defcustom yas/good-grace t
"If non-nil, don't raise errors in inline elisp evaluation.
An error string \"[yas] error\" is returned instead."
:type 'boolean
:group 'yasnippet)
(defcustom yas/visit-from-menu nil
"If non-nil visit snippets's files from menu, instead of expanding them.
This cafn only work when snippets are loaded from files."
:type 'boolean
:group 'yasnippet)
(defcustom yas/expand-only-for-last-commands nil
"List of `last-command' values to restrict tab-triggering to, or nil.
Leave this set at nil (the default) to be able to trigger an
expansion simply by placing the cursor after a valid tab trigger,
using whichever commands.
Optionallly, set this to something like '(self-insert-command) if
you to wish restrict expansion to only happen when the last
letter of the snippet tab trigger was typed immediately before
the trigger key itself."
:type '(repeat function)
:group 'yasnippet)
;; Only two faces, and one of them shouldn't even be used...
(defface yas/field-highlight-face
'((t (:inherit 'region)))
"The face used to highlight the currently active field of a snippet"
:group 'yasnippet)
(defface yas/field-debug-face
"The face used for debugging some overlays normally hidden"
:group 'yasnippet)
;;; User can also customize the next defvars
(defun yas/define-some-keys (keys keymap definition)
"Bind KEYS to DEFINITION in KEYMAP, read with `read-kbd-macro'."
(let ((keys (or (and (listp keys) keys)
(list keys))))
(dolist (key keys)
(define-key keymap (read-kbd-macro key) definition))))
(defvar yas/keymap
(let ((map (make-sparse-keymap)))
(mapc #'(lambda (binding)
(yas/define-some-keys (car binding) map (cdr binding)))
`((,yas/next-field-key . yas/next-field-or-maybe-expand)
(,yas/prev-field-key . yas/prev-field)
("C-g" . yas/abort-snippet)
(,yas/skip-and-clear-key . yas/skip-and-clear-or-delete-char)))
"The keymap active while a snippet expansion is in progress.")
(defvar yas/key-syntaxes (list "w" "w_" "w_." "w_.()" "^ ")
"List of character syntaxes used to find a trigger key before point.
The list is tried in the order while scanning characters
backwards from point. For example, if the list is '(\"w\" \"w_\")
first look for trigger keys which are composed exclusively of
\"word\"-syntax characters, and then, if that fails, look for
keys which are either of \"word\" or \"symbol\"
syntax. Triggering after
will, according to the \"w\" element first try \"bar\". If that
isn't a trigger key, \"foo-bar\" is tried, respecting a second
\"w_\" element.")
(defvar yas/after-exit-snippet-hook
"Hooks to run after a snippet exited.
The hooks will be run in an environment where some variables bound to
proper values:
`yas/snippet-beg' : The beginning of the region of the snippet.
`yas/snippet-end' : Similar to beg.
Attention: These hooks are not run when exiting nested/stackd snippet expansion!")
(defvar yas/before-expand-snippet-hook
"Hooks to run just before expanding a snippet.")
(defvar yas/buffer-local-condition
'(if (and (or (fourth (syntax-ppss))
(fifth (syntax-ppss)))
(eq (symbol-function this-command) 'yas/expand-from-trigger-key))
'(require-snippet-condition . force-in-comment)
"Snippet expanding condition.
This variable is a lisp form which is evaluated everytime a
snippet expansion is attemped:
* If it evaluates to nil, no snippets can be expanded.
* If it evaluates to the a cons (require-snippet-condition
* Snippets bearing no \"# condition:\" directive are not
* Snippets bearing conditions that evaluate to nil (or
produce an error) won't be onsidered.
* If the snippet has a condition that evaluates to non-nil
* If REQUIREMENT is t, the snippet is considered
* If REQUIREMENT is `eq' RESULT, the snippet is
* Otherwise, the snippet is not considered.
* If it evaluates to the symbol 'always, all snippets are
considered for expansion, regardless of any conditions.
* If it evaluates to t or some other non-nil value
* Snippet bearing no conditions, or conditions that
evaluate to non-nil, are considered for expansion.
* Otherwise, the snippet is not considered.
Here's an example preventing snippets from being expanded from
inside comments, in `python-mode' only, with the exception of
snippets returning the symbol 'force-in-comment in their
(add-hook 'python-mode-hook
'(lambda ()
(setq yas/buffer-local-condition
'(if (python-in-string/comment)
'(require-snippet-condition . force-in-comment)
The default value is similar, it filters out potential snippet
expansions inside comments and string literals, unless the
snippet itself contains a condition that returns the symbol
;;; Internal variables
(defvar yas/version "0.7.0")
(defvar yas/menu-table (make-hash-table)
"A hash table of MAJOR-MODE symbols to menu keymaps.")
(defvar yas/known-modes
'(ruby-mode rst-mode markdown-mode)
"A list of mode which is well known but not part of emacs.")
(defvar yas/escaped-characters
'(?\\ ?` ?' ?$ ?} ?{ ?\( ?\))
"List of characters which *might* need to be escaped.")
(defconst yas/field-regexp
"A regexp to *almost* recognize a field.")
(defconst yas/multi-dollar-lisp-expression-regexp
"$+[ \t\n]*\\(([^)]*)\\)"
"A regexp to *almost* recognize a \"$(...)\" expression.")
(defconst yas/backquote-lisp-expression-regexp
"A regexp to recognize a \"`lisp-expression`\" expression." )
(defconst yas/transform-mirror-regexp
"${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
"A regexp to *almost* recognize a mirror with a transform.")
(defconst yas/simple-mirror-regexp
"A regexp to recognize a simple mirror.")
(defvar yas/snippet-id-seed 0
"Contains the next id for a snippet.")
(defun yas/snippet-next-id ()
(let ((id yas/snippet-id-seed))
(incf yas/snippet-id-seed)
;;; Minor mode stuff
;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
(defvar last-buffer-undo-list nil)
(defvar yas/minor-mode-menu nil
"Holds the YASnippet menu")
(defun yas/init-minor-keymap ()
(let ((map (make-sparse-keymap)))
(easy-menu-define yas/minor-mode-menu
"Menu used when YAS/minor-mode is active."
["Expand trigger" yas/expand
:help "Possibly expand tab trigger before point"]
["Insert at point..." yas/insert-snippet
:help "Prompt for an expandable snippet and expand it at point"]
["New snippet..." yas/new-snippet
:help "Create a new snippet in an appropriate directory"]
["Visit snippet file..." yas/visit-snippet-file
:help "Prompt for an expandable snippet and find its file"]
["Find snippets..." yas/find-snippets
:help "Invoke `find-file' in the appropriate snippet directory"]
("Snippet menu behaviour"
["Visit snippets" (setq yas/visit-from-menu t)
:help "Visit snippets from the menu"
:active t :style radio :selected yas/visit-from-menu]
["Expand snippets" (setq yas/visit-from-menu nil)
:help "Expand snippets from the menu"
:active t :style radio :selected (not yas/visit-from-menu)]
["Show \"Real\" modes only" (setq yas/use-menu 'real-modes)
:help "Show snippet submenus for modes that appear to be real major modes"
:active t :style radio :selected (eq yas/use-menu 'real-modes)]
["Show all modes" (setq yas/use-menu 't)
:help "Show one snippet submenu for each loaded table"
:active t :style radio :selected (eq yas/use-menu 't)]
["Abbreviate according to current mode" (setq yas/use-menu 'abbreviate)
:help "Show only snippet submenus for the current active modes"
:active t :style radio :selected (eq yas/use-menu 'abbreviate)])
["Auto" (setq yas/indent-line 'auto)
:help "Indent each line of the snippet with `indent-according-to-mode'"
:active t :style radio :selected (eq yas/indent-line 'auto)]
["Fixed" (setq yas/indent-line 'fixed)
:help "Indent the snippet to the current column"
:active t :style radio :selected (eq yas/indent-line 'fixed)]
["None" (setq yas/indent-line 'none)
:help "Don't apply any particular snippet indentation after expansion"
:active t :style radio :selected (not (member yas/indent-line '(fixed auto)))]
["Also auto indent first line" (setq yas/also-auto-indent-first-line
(not yas/also-auto-indent-first-line))
:help "When auto-indenting also, auto indent the first line menu"
:active (eq yas/indent-line 'auto)
:style toggle :selected yas/also-auto-indent-first-line]
("Prompting method"
["System X-widget" (setq yas/prompt-functions
(cons 'yas/x-prompt
(remove 'yas/x-prompt
:help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
:active t :style radio :selected (eq (car yas/prompt-functions)
["Dropdown-list" (setq yas/prompt-functions
(cons 'yas/dropdown-prompt
(remove 'yas/dropdown-prompt
:help "Use a special dropdown list"
:active t :style radio :selected (eq (car yas/prompt-functions)
["Ido" (setq yas/prompt-functions
(cons 'yas/ido-prompt
(remove 'yas/ido-prompt
:help "Use an ido-style minibuffer prompt"
:active t :style radio :selected (eq (car yas/prompt-functions)
["Completing read" (setq yas/prompt-functions
(cons 'yas/completing-prompt
(remove 'yas/completing-prompt-prompt
:help "Use a normal minibuffer prompt"
:active t :style radio :selected (eq (car yas/prompt-functions)
["Wrap region in exit marker"
(setq yas/wrap-around-region
(not yas/wrap-around-region))
:help "If non-nil automatically wrap the selected text in the $0 snippet exit"
:style toggle :selected yas/wrap-around-region]
["Allow stacked expansions "
(setq yas/triggers-in-field
(not yas/triggers-in-field))
:help "If non-nil allow snippets to be triggered inside other snippet fields"
:style toggle :selected yas/triggers-in-field]
["Revive snippets on undo "
(setq yas/snippet-revival
(not yas/snippet-revival))
:help "If non-nil allow snippets to become active again after undo"
:style toggle :selected yas/snippet-revival]
["Good grace "
(setq yas/good-grace
(not yas/good-grace))
:help "If non-nil don't raise errors in bad embedded eslip in snippets"
:style toggle :selected yas/good-grace]
["Load snippets..." yas/load-directory
:help "Load snippets from a specific directory"]
["Reload everything" yas/reload-all
:help "Cleanup stuff, reload snippets, rebuild menus"]
["About" yas/about
:help "Display some information about YASsnippet"]))
;; Now for the stuff that has direct keybindings
(define-key map "\C-c&\C-s" 'yas/insert-snippet)
(define-key map "\C-c&\C-n" 'yas/new-snippet)
(define-key map "\C-c&\C-v" 'yas/visit-snippet-file)
(define-key map "\C-c&\C-f" 'yas/find-snippets)
(defvar yas/minor-mode-map (yas/init-minor-keymap)
"The keymap used when `yas/minor-mode' is active.")
(defun yas/trigger-key-reload (&optional unbind-key)
"Rebind `yas/expand' to the new value of `yas/trigger-key'.
With optional UNBIND-KEY, try to unbind that key from
(when (and unbind-key
(stringp unbind-key)
(not (string= unbind-key "")))
(define-key yas/minor-mode-map (read-kbd-macro unbind-key) nil))
(when (and yas/trigger-key
(stringp yas/trigger-key)
(not (string= yas/trigger-key "")))
(define-key yas/minor-mode-map (read-kbd-macro yas/trigger-key) 'yas/expand)))
(defvar yas/tables (make-hash-table)
"A hash table of MAJOR-MODE symbols to `yas/table' objects.")
(defvar yas/direct-keymaps (list)
"Keymap alist supporting direct snippet keybindings.
This variable is is placed `emulation-mode-map-alists'.
Its elements looks like (TABLE-NAME . KEYMAP) and are
calculated when loading snippets. TABLE-NAME is a variable
set buffer-locally when entering `yas/minor-mode'. KEYMAP binds
all defined direct keybindings to the command
`yas/expand-from-keymap', which acts similarly to `yas/expand'")
(defun yas/direct-keymaps-reload ()
"Force reload the direct keybinding for active snippet tables."
(setq yas/direct-keymaps nil)
(maphash #'(lambda (name table)
(mapc #'(lambda (table)
(push (cons (intern (format "yas//direct-%s" name))
(yas/table-direct-keymap table))
(cons table (yas/table-get-all-parents table))))
(defun yas/direct-keymaps-set-vars ()
(let ((modes-to-activate (list major-mode))
(mode major-mode))
(while (setq mode (get mode 'derived-mode-parent))
(push mode modes-to-activate))
(dolist (mode (yas/extra-modes))
(push mode modes-to-activate))
(dolist (mode modes-to-activate)
(let ((name (intern (format "yas//direct-%s" mode))))
(set-default name nil)
(set (make-local-variable name) t)))))
(defvar yas/minor-mode-hook nil
"Hook run when yas/minor-mode is turned on")
(define-minor-mode yas/minor-mode
"Toggle YASnippet mode.
When YASnippet mode is enabled, the `tas/trigger-key' key expands
snippets of code depending on the mode.
With no argument, this command toggles the mode.
positive prefix argument turns on the mode.
Negative prefix argument turns off the mode.
You can customize the key through `yas/trigger-key'.
Key bindings:
;; The indicator for the mode line.
" yas"
:group 'yasnippet
(cond (yas/minor-mode
;; Reload the trigger key
;; Install the direct keymaps in `emulation-mode-map-alists'
;; (we use `add-hook' even though it's not technically a hook,
;; but it works). Then define variables named after modes to
;; index `yas/direct-keymaps'.
;; Also install the post-command-hook.
(add-hook 'emulation-mode-map-alists 'yas/direct-keymaps)
(add-hook 'post-command-hook 'yas/post-command-handler nil t)
(add-hook 'yas/minor-mode-hook 'yas/direct-keymaps-set-vars-runonce 'append))
;; Uninstall the direct keymaps and the post-command hook
(remove-hook 'post-command-hook 'yas/post-command-handler t)
(remove-hook 'emulation-mode-map-alists 'yas/direct-keymaps))))
(defun yas/direct-keymaps-set-vars-runonce ()
(remove-hook 'yas/minor-mode-hook 'yas/direct-keymaps-set-vars-runonce))
(defvar yas/dont-activate nil
"If non-nil don't let `yas/minor-mode-on' active yas for this buffer.
`yas/minor-mode-on' is usually called by `yas/global-mode' so
this effectively lets you define exceptions to the \"global\"
behaviour. Can also be a function of zero arguments.")
(make-variable-buffer-local 'yas/dont-activate)
(defun yas/minor-mode-on ()
"Turn on YASnippet minor mode.
Do this unless `yas/dont-activate' is truish "
(unless (or (minibufferp)
(if (functionp yas/dont-activate)
(funcall yas/dont-activate)
;; Load all snippets definitions unless we still don't have a
;; root-directory or some snippets have already been loaded.
(yas/minor-mode 1)))
(define-globalized-minor-mode yas/global-mode yas/minor-mode yas/minor-mode-on
:group 'yasnippet
:require 'yasnippet)
(add-hook 'yas/global-mode-hook 'yas/reload-all-maybe)
(defun yas/reload-all-maybe ()
(if yas/global-mode
;; Major mode stuff
(defvar yas/font-lock-keywords
(append '(("^#.*$" . font-lock-comment-face))
(0 font-lock-keyword-face)
(1 font-lock-string-face t))
(0 font-lock-keyword-face)
(1 font-lock-warning-face t))
("${" font-lock-keyword-face)
("$[0-9]+?" font-lock-preprocessor-face)
("\\(\\$(\\)" 1 font-lock-preprocessor-face)
(0 font-lock-keyword-face)))))
(defun yas/init-major-keymap ()
(let ((map (make-sparse-keymap)))
(easy-menu-define nil
"Menu used when snippet-mode is active."
(cons "Snippet"
(mapcar #'(lambda (ent)
(when (third ent)
(define-key map (third ent) (second ent)))
(vector (first ent) (second ent) t))
(list "Load this snippet" 'yas/load-snippet-buffer "\C-c\C-c")
(list "Try out this snippet" 'yas/tryout-snippet "\C-c\C-t")))))
(defvar snippet-mode-map
"The keymap used when `snippet-mode' is active")
(define-derived-mode snippet-mode text-mode "Snippet"
"A mode for editing yasnippets"
(set-syntax-table (standard-syntax-table))
(setq font-lock-defaults '(yas/font-lock-keywords))
(set (make-local-variable 'require-final-newline) nil)
(use-local-map snippet-mode-map))
;;; Internal structs for template management
(defstruct (yas/template (:constructor yas/make-blank-template))
"A template for a snippet."
group ;; as dictated by the #group: directive or .yas-make-groups
perm-group ;; as dictated by `yas/define-menu'
(defun yas/populate-template (template &rest args)
"Helper function to populate a template with properties"
(let (p v)
(while args
(aset template
(position (intern (substring (symbol-name (car args)) 1))
(mapcar #'car (get 'yas/template 'cl-struct-slots)))
(second args))
(setq args (cddr args)))
(defstruct (yas/table (:constructor yas/make-snippet-table (name)))
"A table to store snippets for a particular mode.
Has the following fields:
A symbol name normally corresponding to a major mode, but can
also be a pseudo major-mode to be referenced in
`yas/extra-modes', for example.
A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
a string or a vector, where the former is the snippet's trigger
and the latter means it's a direct keybinding. NAMEHASH is yet
another hash of (NAME . TEMPLATE) where NAME is the snippet's
name and TEMPLATE is a `yas/template' object.
A list of tables considered parents of this table: i.e. when
searching for expansions they are searched as well.
A keymap for the snippets in this table that have direct
keybindings. This is kept in sync with the keyhash, i.e., all
the elements of the keyhash that are vectors appear here as
bindings to `yas/expand-from-keymap'.
A hash table mapping snippets uuid's to the same `yas/template'
objects. A snippet uuid defaults to the snippet's name.
(hash (make-hash-table :test 'equal))
(uuidhash (make-hash-table :test 'equal))
(parents nil)
(direct-keymap (make-sparse-keymap)))
(defun yas/get-template-by-uuid (mode uuid)
"Find the snippet template in MODE by its UUID."
(let* ((table (gethash mode yas/tables mode)))
(when table
(gethash uuid (yas/table-uuidhash table)))))
;; Apropos storing/updating, this works with two steps:
;; 1. `yas/remove-template-by-uuid' to remove any existing mappings by
;; snippet uuid
;; 2. `yas/add-template' to add the mappings again:
;; Create or index the entry in TABLES's `yas/table-hash'
;; linking KEY to a namehash. That namehash links NAME to
;; TEMPLATE, and is also created a new namehash inside that
;; entry.
(defun yas/remove-template-by-uuid (table uuid)
"Remove from TABLE a template identified by UUID."
(let ((template (gethash uuid (yas/table-uuidhash table))))
(when template
(let* ((name (yas/template-name template))
(empty-keys nil))
;; Remove the name from each of the targeted namehashes
(maphash #'(lambda (k v)
(let ((template (gethash name v)))
(when (and template
(eq uuid (yas/template-uuid template)))
(remhash name v)
(when (zerop (hash-table-count v))
(push k empty-keys)))))
(yas/table-hash table))
;; Remove the namehashed themselves if they've become empty
(dolist (key empty-keys)
(remhash key (yas/table-hash table)))
;; Finally, remove the uuid from the uuidhash
(remhash uuid (yas/table-uuidhash table))))))
(defun yas/add-template (table template)
"Store in TABLE the snippet template TEMPLATE.
KEY can be a string (trigger key) of a vector (direct
(let ((name (yas/template-name template))
(key (yas/template-key template))
(keybinding (yas/template-keybinding template))
(menu-binding (car (yas/template-menu-binding-pair template))))
(dolist (k (remove nil (list key keybinding)))
(puthash name
(or (gethash k
(yas/table-hash table))
(puthash k
(make-hash-table :test 'equal)
(yas/table-hash table))))
(when (vectorp k)
(define-key (yas/table-direct-keymap table) k 'yas/expand-from-keymap)))
(when menu-binding
(setf (getf (cdr menu-binding) :keys)
(or (and keybinding (key-description keybinding))
(and key (concat key yas/trigger-symbol))))
(setcar (cdr menu-binding)
(puthash (yas/template-uuid template) template (yas/table-uuidhash table))))
(defun yas/update-template (snippet-table template)
Also takes care of adding and updaring to the associated menu."
;; Remove from table by uuid
(yas/remove-template-by-uuid snippet-table (yas/template-uuid template))
;; Add to table again
(yas/add-template snippet-table template)
;; Take care of the menu
(let ((keymap (yas/menu-keymap-get-create snippet-table))
(group (yas/template-group template)))
(when (and yas/use-menu
(not (cdr (yas/template-menu-binding-pair template))))
;; Remove from menu keymap
(yas/delete-from-keymap keymap (yas/template-uuid template))
;; Add necessary subgroups as necessary.
(dolist (subgroup group)
(let ((subgroup-keymap (lookup-key keymap (vector (make-symbol subgroup)))))
(unless (and subgroup-keymap
(keymapp subgroup-keymap))
(setq subgroup-keymap (make-sparse-keymap))
(define-key keymap (vector (make-symbol subgroup))
`(menu-item ,subgroup ,subgroup-keymap)))
(setq keymap subgroup-keymap)))
;; Add this entry to the keymap
(let ((menu-binding-pair (yas/snippet-menu-binding-pair-get-create template)))
(define-key keymap (vector (make-symbol (yas/template-uuid template))) (car menu-binding-pair))))))
(defun yas/namehash-templates-alist (namehash)
(let (alist)
(maphash #'(lambda (k v)
(push (cons k v) alist))
(defun yas/fetch (table key)
"Fetch templates in TABLE by KEY.
Return a list of cons (NAME . TEMPLATE) where NAME is a
string and TEMPLATE is a `yas/template' structure."
(let* ((keyhash (yas/table-hash table))
(namehash (and keyhash (gethash key keyhash))))
(when namehash
(yas/filter-templates-by-condition (yas/namehash-templates-alist namehash)))))
;;; Filtering/condition logic
(defun yas/eval-condition (condition)
(condition-case err
(eval condition))))
(error (progn
(message (format "[yas] error in condition evaluation: %s"
(error-message-string err)))
(defun yas/filter-templates-by-condition (templates)
"Filter the templates using the applicable condition.
TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
string and TEMPLATE is a `yas/template' structure.
This function implements the rules described in
`yas/buffer-local-condition'. See that variables documentation."
(let ((requirement (yas/require-template-specific-condition-p)))
(if (eq requirement 'always)
(remove-if-not #'(lambda (pair)
(yas/template-condition (cdr pair)) requirement))
(defun yas/require-template-specific-condition-p ()
"Decides if this buffer requests/requires snippet-specific
conditions to filter out potential expansions."
(if (eq 'always yas/buffer-local-condition)
(let ((local-condition (or (and (consp yas/buffer-local-condition)
(yas/eval-condition yas/buffer-local-condition))
(when local-condition
(if (eq local-condition t)
(and (consp local-condition)
(eq 'require-snippet-condition (car local-condition))
(symbolp (cdr local-condition))
(cdr local-condition)))))))
(defun yas/template-can-expand-p (condition requirement)
"Evaluates CONDITION and REQUIREMENT and returns a boolean"
(let* ((result (or (null condition)
(yas/eval-condition condition))))
(cond ((eq requirement t)
(eq requirement result)))))
(defun yas/table-get-all-parents (table)
"Returns a list of all parent tables of TABLE"
(let ((parents (yas/table-parents table)))
(when parents
(append (copy-list parents)
(mapcan #'yas/table-get-all-parents parents)))))
(defun yas/table-templates (table)
(when table
(let ((acc (list)))
(maphash #'(lambda (key namehash)
(maphash #'(lambda (name template)
(push (cons name template) acc))
(yas/table-hash table))
(yas/filter-templates-by-condition acc))))
(defun yas/current-key ()
"Get the key under current position. A key is used to find
the template of a snippet in the current snippet-table."
(let ((start (point))
(end (point))
(syntaxes yas/key-syntaxes)
(while (and (not done) syntaxes)
(setq syntax (car syntaxes))
(setq syntaxes (cdr syntaxes))
(skip-syntax-backward syntax)
(setq start (point)))
(setq templates
(mapcan #'(lambda (table)
(yas/fetch table (buffer-substring-no-properties start end)))
(if templates
(setq done t)
(setq start end)))
(list templates
(defun yas/table-all-keys (table)
(when table
(let ((acc))
(maphash #'(lambda (key namehash)
(when (yas/filter-templates-by-condition (yas/namehash-templates-alist namehash))
(push key acc)))
(yas/table-hash table))
;;; Internal functions
(defun yas/real-mode? (mode)
"Try to find out if MODE is a real mode. The MODE bound to
a function (like `c-mode') is considered real mode. Other well
known mode like `ruby-mode' which is not part of Emacs might
not bound to a function until it is loaded. So yasnippet keeps
a list of modes like this to help the judgement."
(or (fboundp mode)
(find mode yas/known-modes)))
(defun yas/eval-lisp (form)
"Evaluate FORM and convert the result to string."
(let ((retval (catch 'yas/exception
(condition-case err
(let ((result (eval form)))
(when result
(format "%s" result))))))
(error (if yas/good-grace
(format "[yas] elisp error! %s" (error-message-string err))
(error (format "[yas] elisp error: %s"
(error-message-string err)))))))))
(when (and (consp retval)
(eq 'yas/exception (car retval)))
(error (cdr retval)))
(defun yas/eval-lisp-no-saves (form)
(condition-case err
(eval form)
(error (if yas/good-grace
(format "[yas] elisp error! %s" (error-message-string err))
(error (format "[yas] elisp error: %s"
(error-message-string err)))))))
(defun yas/read-lisp (string &optional nil-on-error)
"Read STRING as a elisp expression and return it.
In case STRING in an invalid expression and NIL-ON-ERROR is nil,
return an expression that when evaluated will issue an error."
(condition-case err
(read string)
(error (and (not nil-on-error)
`(error (error-message-string err))))))
(defun yas/read-keybinding (keybinding)
"Read KEYBINDING as a snippet keybinding, return a vector."
(when (and keybinding
(not (string-match "keybinding" keybinding)))
(condition-case err
(let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
(read keybinding))
(read-kbd-macro keybinding 'need-vector))))
(message "[yas] warning: keybinding \"%s\" invalid since %s."
keybinding (error-message-string err))
(defvar yas/extra-modes nil
"If non-nil, also lookup snippets for this/these modes.
Can be a symbol or a list of symbols.
This variable probably makes more sense as buffer-local, so
ensure your use `make-local-variable' when you set it.")
(defun yas/extra-modes ()
(if (listp yas/extra-modes) yas/extra-modes (list yas/extra-modes)))
(defvaralias 'yas/mode-symbol 'yas/extra-modes)
(defun yas/table-get-create (mode)
"Get the snippet table corresponding to MODE.
Optional DIRECTORY gets recorded as the default directory to
search for snippet files if the retrieved/created table didn't
already have such a property."
(let ((table (gethash mode
(unless table
(setq table (yas/make-snippet-table (symbol-name mode)))
(puthash mode table yas/tables)
(aput 'yas/direct-keymaps (intern (format "yas//direct-%s" mode))
(yas/table-direct-keymap table)))
(defun yas/get-snippet-tables (&optional mode-symbol dont-search-parents)
"Get snippet tables for current buffer.
Return a list of 'yas/table' objects indexed by mode.
The modes are tried in this order: optional MODE-SYMBOL, then
`yas/extra-modes', then `major-mode' then, unless
DONT-SEARCH-PARENTS is non-nil, the guessed parent mode of either
MODE-SYMBOL or `major-mode'.
Guessing is done by looking up the MODE-SYMBOL's
`derived-mode-parent' property, see also `derived-mode-p'."
(let ((mode-tables
(remove nil
(mapcar #'(lambda (mode)
(gethash mode yas/tables))
(remove nil (append (list mode-symbol)
(list major-mode
(and (not dont-search-parents)
(get major-mode
(append mode-tables
(mapcan #'yas/table-get-all-parents mode-tables)))))
(defun yas/menu-keymap-get-create (table)
"Get or create the main menu keymap correspondong to MODE.
This may very well create a plethora of menu keymaps and arrange
them in all `yas/menu-table'"
(let* ((mode (intern (yas/table-name table)))
(menu-keymap (or (gethash mode yas/menu-table)
(puthash mode (make-sparse-keymap) yas/menu-table)))
(parents (yas/table-parents table)))
(mapc #'yas/menu-keymap-get-create parents)
(define-key yas/minor-mode-menu (vector mode)
`(menu-item ,(symbol-name mode) ,menu-keymap
:visible (yas/show-menu-p ',mode)))
;;; Template-related and snippet loading functions
(defun yas/parse-template (&optional file)
"Parse the template in the current buffer.
Optional FILE is the absolute file name of the file being
Optional GROUP is the group where the template is to go,
otherwise we attempt to calculate it from FILE.
Return a snippet-definition, i.e. a list
If the buffer contains a line of \"# --\" then the contents above
this line are ignored. Directives can set most of these with the syntax:
# directive-name : directive-value
Here's a list of currently recognized directives:
* type
* name
* contributor
* condition
* group
* key
* expand-env
* binding
* uuid"
(goto-char (point-min))
(let* ((type 'snippet)
(name (and file
(file-name-nondirectory file)))
(key nil)
(group (and file
(yas/calculate-group file)))
(if (re-search-forward "^# --\n" nil t)
(progn (setq template
(buffer-substring-no-properties (point)
(setq bound (point))
(goto-char (point-min))
(while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*\\)$" bound t)
(when (string= "uuid" (match-string-no-properties 1))
(setq uuid (match-string-no-properties 2)))
(when (string= "type" (match-string-no-properties 1))
(setq type (if (string= "command" (match-string-no-properties 2))
(when (string= "key" (match-string-no-properties 1))
(setq key (match-string-no-properties 2)))
(when (string= "name" (match-string-no-properties 1))
(setq name (match-string-no-properties 2)))
(when (string= "condition" (match-string-no-properties 1))
(setq condition (yas/read-lisp (match-string-no-properties 2))))
(when (string= "group" (match-string-no-properties 1))
(setq group (match-string-no-properties 2)))
(when (string= "expand-env" (match-string-no-properties 1))
(setq expand-env (yas/read-lisp (match-string-no-properties 2)
(when (string= "binding" (match-string-no-properties 1))
(setq binding (match-string-no-properties 2)))))
(setq template
(buffer-substring-no-properties (point-min) (point-max))))
(when (eq type 'command)
(setq template (yas/read-lisp (concat "(progn" template ")"))))
(when group
(setq group (split-string group "\\.")))
(list key template name condition group expand-env file binding uuid)))
(defun yas/calculate-group (file)
"Calculate the group for snippet file path FILE."
(let* ((dominating-dir (locate-dominating-file file
(extra-path (and dominating-dir
(replace-regexp-in-string (concat "^"
(expand-file-name dominating-dir))
(expand-file-name file))))
(extra-dir (and extra-path
(file-name-directory extra-path)))
(group (and extra-dir
(replace-regexp-in-string "/"
(directory-file-name extra-dir)))))
(defun yas/subdirs (directory &optional file?)
"Return subdirs or files of DIRECTORY according to FILE?."
(remove-if (lambda (file)
(or (string-match "^\\."
(file-name-nondirectory file))
(string-match "^#.*#$"
(file-name-nondirectory file))
(string-match "~$"
(file-name-nondirectory file))
(if file?
(file-directory-p file)
(not (file-directory-p file)))))
(directory-files directory t)))
(defun yas/make-menu-binding (template)
(let ((mode (intern (yas/table-name (yas/template-table template)))))
`(lambda () (interactive) (yas/expand-or-visit-from-menu ',mode ,(yas/template-uuid template)))))
(defun yas/expand-or-visit-from-menu (mode uuid)
(let* ((table (yas/table-get-create mode))
(yas/current-template (and table
(gethash uuid (yas/table-uuidhash table)))))
(when yas/current-template
(if yas/visit-from-menu
(yas/visit-snippet-file-1 yas/current-template)
(let ((where (if (region-active-p)
(cons (region-beginning) (region-end))
(cons (point) (point)))))
(yas/expand-snippet (yas/template-content yas/current-template)
(car where)
(cdr where)
(yas/template-expand-env yas/current-template)))))))
;; Popping up for keys and templates
(defun yas/prompt-for-template (templates &optional prompt)
"Interactively choose a template from the list TEMPLATES.
TEMPLATES is a list of `yas/template'."
(when templates
(setq templates
(sort templates #'(lambda (t1 t2)
(< (length (yas/template-name t1))
(length (yas/template-name t2))))))
(if yas/x-pretty-prompt-templates
(yas/x-pretty-prompt-templates "Choose a snippet" templates)
(some #'(lambda (fn)
(funcall fn (or prompt "Choose a snippet: ")
(defun yas/prompt-for-keys (keys &optional prompt)
"Interactively choose a template key from the list KEYS."
(when keys
(some #'(lambda (fn)
(funcall fn (or prompt "Choose a snippet key: ") keys))
(defun yas/prompt-for-table (tables &optional prompt)
(when tables
(some #'(lambda (fn)
(funcall fn (or prompt "Choose a snippet table: ")
(defun yas/x-prompt (prompt choices &optional display-fn)
"Display choices in a x-window prompt."
;; FIXME: HACK: if we notice that one of the objects in choices is
;; actually a `yas/template', defer to `yas/x-prompt-pretty-templates'
;; This would be better implemented by passing CHOICES as a
;; strucutred tree rather than a list. Modifications would go as far
;; up as `yas/all-templates' I think.
(when (and window-system choices)
(let ((chosen
(let (menu d) ;; d for display
(dolist (c choices)
(setq d (or (and display-fn (funcall display-fn c))
(cond ((stringp d)
(push (cons (concat " " d) c) menu))
((listp d)
(push (car d) menu))))
(setq menu (list prompt (push "title" menu)))
(x-popup-menu (if (fboundp 'posn-at-point)
(let ((x-y (posn-x-y (posn-at-point (point)))))
(list (list (+ (car x-y) 10)
(+ (cdr x-y) 20))
(or chosen
(defvar yas/x-pretty-prompt-templates nil
"If non-nil, attempt to prompt for templates like TextMate.")
(defun yas/x-pretty-prompt-templates (prompt templates)
"Display TEMPLATES, grouping neatly by table name."
(let ((pretty-alist (list))
(dolist (tl templates)
(aput 'pretty-alist (yas/template-table tl) (cons tl (aget pretty-alist (yas/template-table tl)))))
(setq more-than-one-table (> (length pretty-alist) 1))
(setq prefix (if more-than-one-table
" " ""))
(dolist (table-and-templates pretty-alist)
(when (cdr table-and-templates)
(if more-than-one-table
(push (yas/table-name (car table-and-templates)) menu))
(dolist (template (cdr table-and-templates))
(push (cons (concat prefix (yas/template-name template))
template) menu))))
(setq menu (nreverse menu))
(or (x-popup-menu (if (fboundp 'posn-at-point)
(let ((x-y (posn-x-y (posn-at-point (point)))))
(list (list (+ (car x-y) 10)
(+ (cdr x-y) 20))
(list prompt (push "title" menu)))
(defun yas/ido-prompt (prompt choices &optional display-fn)
(when (featurep 'ido)
(yas/completing-prompt prompt choices display-fn #'ido-completing-read)))
(eval-when-compile (require 'dropdown-list nil t))
(defun yas/dropdown-prompt (prompt choices &optional display-fn)
(when (featurep 'dropdown-list)
(let (formatted-choices
(dolist (choice choices)
(setq d (or (and display-fn (funcall display-fn choice))
(when (stringp d)
(push d formatted-choices)
(push choice filtered-choices)))
(setq n (and formatted-choices (dropdown-list formatted-choices)))
(if n
(nth n filtered-choices)
(defun yas/completing-prompt (prompt choices &optional display-fn completion-fn)
(let (formatted-choices
(completion-fn (or completion-fn
(dolist (choice choices)
(setq d (or (and display-fn (funcall display-fn choice))
(when (stringp d)
(push d formatted-choices)
(push choice filtered-choices)))
(setq chosen (and formatted-choices
(funcall completion-fn prompt
(when chosen
(nth (position chosen formatted-choices :test #'string=) filtered-choices))))
(defun yas/no-prompt (prompt choices &optional display-fn)
(first choices))
;; Loading snippets from files
(defun yas/load-directory-1 (directory &optional mode-sym parents)
"Recursively load snippet templates from DIRECTORY."
;; Load .yas-setup.el files wherever we find them
(let ((file (concat directory "/" ".yas-setup")))
(when (or (file-readable-p (concat file ".el"))
(file-readable-p (concat file ".elc")))
(load file)))
(unless (file-exists-p (concat directory "/" ".yas-skip"))
(let* ((major-mode-and-parents (if mode-sym
(cons mode-sym parents)
(yas/compute-major-mode-and-parents (concat directory
(default-directory directory)
(snippet-defs nil))
;; load the snippet files
(dolist (file (yas/subdirs directory 'no-subdirs-just-files))
(when (file-readable-p file)
(insert-file-contents file nil nil nil t)
(push (yas/parse-template file)
(when (or snippet-defs
(cdr major-mode-and-parents))
(yas/define-snippets (car major-mode-and-parents)
(cdr major-mode-and-parents)))
;; now recurse to a lower level
(dolist (subdir (yas/subdirs directory))
(yas/load-directory-1 subdir
(car major-mode-and-parents)
(cdr major-mode-and-parents))))))
(defun yas/load-directory (directory)
"Load snippet definition from a directory hierarchy.
Below the top-level directory, each directory is a mode
name. And under each subdirectory, each file is a definition
of a snippet. The file name is the trigger key and the
content of the file is the template."
(interactive "DSelect the root directory: ")
(unless (file-directory-p directory)
(error "%s is not a directory" directory))
(unless yas/snippet-dirs
(setq yas/snippet-dirs directory))
(dolist (dir (yas/subdirs directory))
(yas/load-directory-1 dir))
(when (interactive-p)
(message "[yas] Loaded snippets from %s." directory)))
(defun yas/load-snippet-dirs ()
"Reload the directories listed in `yas/snippet-dirs' or
prompt the user to select one."
(if yas/snippet-dirs
(dolist (directory (reverse (yas/snippet-dirs)))
(yas/load-directory directory))
(call-interactively 'yas/load-directory)))
(defun yas/reload-all (&optional interactive)
"Reload all snippets and rebuild the YASnippet menu. "
(interactive "p")
(let ((errors))
;; Empty all snippet tables and all menu tables
(setq yas/tables (make-hash-table))
(setq yas/menu-table (make-hash-table))
;; Init the `yas/minor-mode-map', taking care not to break the
;; menu....
(setf (cdr yas/minor-mode-map)
(cdr (yas/init-minor-keymap)))
;; Reload the directories listed in `yas/snippet-dirs' or prompt
;; the user to select one.
(condition-case oops
(error (push oops errors)
(message "[yas] Check your `yas/snippet-dirs': %s" (second oops))))
;; Reload the direct keybindings
(message "[yas] Reloaded everything...%s." (if errors " (some errors, check *Messages*)" ""))))
(defun yas/quote-string (string)
"Escape and quote STRING.
foo\"bar\\! -> \"foo\\\"bar\\\\!\""
(concat "\""
(replace-regexp-in-string "[\\\"]"
;;; Yasnippet Bundle
(defun yas/initialize ()
"For backward compatibility, enable `yas/minor-mode' globally"
(yas/global-mode 1))
(defun yas/compile-bundle
(&optional yasnippet yasnippet-bundle snippet-roots code dropdown)
"Compile snippets in SNIPPET-ROOTS to a single bundle file.
YASNIPPET is the yasnippet.el file path.
YASNIPPET-BUNDLE is the output file of the compile result.
SNIPPET-ROOTS is a list of root directories that contains the
snippets definition.
CODE is the code to be placed at the end of the generated file
and that can initialize the YASnippet bundle.
Last optional argument DROPDOWN is the filename of the
dropdown-list.el library.
Here's the default value for all the parameters:
(yas/compile-bundle \"yasnippet.el\"
### autoload
(require 'yasnippet-bundle)`\"
(interactive (concat "ffind the yasnippet.el file: \nFTarget bundle file: "
"\nDSnippet directory to bundle: \nMExtra code? \nfdropdown-library: "))
(let* ((yasnippet (or yasnippet
(yasnippet-bundle (or yasnippet-bundle
(snippet-roots (or snippet-roots
(dropdown (or dropdown
(code (or (and code
(condition-case err (read code) (error nil))
(concat "(yas/initialize-bundle)"
"\n;;;###autoload" ; break through so that won't
"(require 'yasnippet-bundle)")))
(dirs (or (and (listp snippet-roots) snippet-roots)
(list snippet-roots)))
(bundle-buffer nil))
(with-temp-file yasnippet-bundle
(insert ";;; yasnippet-bundle.el --- "
"Yet another snippet extension (Auto compiled bundle)\n")
(insert-file-contents yasnippet)
(goto-char (point-max))
(insert "\n")
(when dropdown
(insert-file-contents dropdown))
(goto-char (point-max))
(insert ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n")
(insert ";;;; Auto-generated code ;;;;\n")
(insert ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n")
(insert "(defun yas/initialize-bundle ()\n"
" \"Initialize YASnippet and load snippets in the bundle.\"")
(flet ((yas/define-snippets
(mode snippets &optional parent-or-parents)
(insert ";;; snippets for " (symbol-name mode) ", subdir " (file-name-nondirectory (replace-regexp-in-string "/$" "" default-directory)) "\n")
(let ((literal-snippets (list)))
(dolist (snippet snippets)
(let ((key (first snippet))
(template-content (second snippet))
(name (third snippet))
(condition (fourth snippet))
(group (fifth snippet))
(expand-env (sixth snippet))
(file nil) ;; (seventh snippet)) ;; omit on purpose
(binding (eighth snippet))
(uuid (ninth snippet)))
(push `(,key
(insert (pp-to-string `(yas/define-snippets ',mode ',literal-snippets ',parent-or-parents)))
(insert "\n\n"))))
(dolist (dir dirs)
(dolist (subdir (yas/subdirs dir))
(let ((file (concat subdir "/.yas-setup.el")))
(when (file-readable-p file)
(insert "\n;; Supporting elisp for subdir " (file-name-nondirectory subdir) "\n\n")
(insert-file-contents file)
(replace-regexp "^;;.*$" "" nil (point-min) (point-max))
(replace-regexp "^[\s\t]*\n\\([\s\t]*\n\\)+" "\n" nil (point-min) (point-max))
(kill-region (point-min) (point-max)))
(yas/load-directory-1 subdir nil))))
(insert (pp-to-string `(yas/global-mode 1)))
(insert ")\n\n" code "\n")
;; bundle-specific provide and value for yas/dont-activate
(let ((bundle-feature-name (file-name-nondirectory
(insert (pp-to-string `(set-default 'yas/dont-activate
#'(lambda ()
(and (or yas/snippet-dirs
(featurep ',(make-symbol bundle-feature-name)))
(null (yas/get-snippet-tables)))))))
(insert (pp-to-string `(provide ',(make-symbol bundle-feature-name)))))
(insert ";;; "
(file-name-nondirectory yasnippet-bundle)
" ends here\n"))))
(defun yas/compile-textmate-bundle ()
(yas/compile-bundle "yasnippet.el"
(concat "(yas/initialize-bundle)"
"\n;;;###autoload" ; break through so that won't
"(require 'yasnippet-textmate-bundle)")
;;; Some user level functions
(defun yas/about ()
(message (concat "yasnippet (version "
") -- pluskid <>/joaotavora <>")))
(defun yas/define-snippets (mode snippets &optional parent-mode)
"Define SNIPPETS for MODE.
SNIPPETS is a list of snippet definitions, each taking the
following form
Within these, only KEY and TEMPLATE are actually mandatory.
TEMPLATE might be a lisp form or a string, depending on whether
this is a snippet or a snippet-command.
CONDITION, EXPAND-ENV and KEYBINDING are lisp forms, they have
been `yas/read-lisp'-ed and will eventually be
The remaining elements are strings.
FILE is probably of very little use if you're programatically
defining snippets.
UUID is the snippets \"unique-id\". Loading a second snippet file
with the same uuid replaced the previous snippet.
You can use `yas/parse-template' to return such lists based on
the current buffers contents.
Optional PARENT-MODE can be used to specify the parent tables of
MODE. It can be a mode symbol of a list of mode symbols. It does
not need to be a real mode."
;; X) `snippet-table' is created or retrieved for MODE, same goes
;; for the list of snippet tables `parent-tables'.
(let ((snippet-table (yas/table-get-create mode))
(parent-tables (mapcar #'yas/table-get-create
(if (listp parent-mode)
(list parent-mode))))
(template nil))
;; X) Connect `snippet-table' with `parent-tables'.
;; TODO: this should be a remove-duplicates of the concatenation
;; of `snippet-table's existings parents with the new parents...
(dolist (parent parent-tables)
(unless (find parent (yas/table-parents snippet-table))
(push parent
(yas/table-parents snippet-table))))
;; X) Now, iterate for evey snippet def list
(dolist (snippet snippets)
(setq template (yas/define-snippets-1 snippet
(defun yas/define-snippets-1 (snippet snippet-table)
"Helper for `yas/define-snippets'."
;; X) Calculate some more defaults on the values returned by
;; `yas/parse-template'.
(let* ((file (seventh snippet))
(key (car snippet))
(name (or (third snippet)
(and file
(file-name-directory file))))
(condition (fourth snippet))
(group (fifth snippet))
(keybinding (yas/read-keybinding (eighth snippet)))
(uuid (or (ninth snippet)
(template (or (gethash uuid (yas/table-uuidhash snippet-table))
;; X) populate the template object
(yas/populate-template template
:table snippet-table
:key key
:content (second snippet)
:name (or name key)
:group group
:condition condition
:expand-env (sixth snippet)
:file (seventh snippet)
:keybinding keybinding
:uuid uuid)
;; X) Update this template in the appropriate table. This step
;; also will take care of adding the key indicators in the
;; templates menu entry, if any
(yas/update-template snippet-table template)
;; X) Return the template
(defun yas/snippet-menu-binding-pair-get-create (template &optional type)
"Get TEMPLATE's menu binding or assign it a new one."
(or (yas/template-menu-binding-pair template)
(let ((key (yas/template-key template))
(keybinding (yas/template-keybinding template)))
(setf (yas/template-menu-binding-pair template)
(cons `(menu-item ,(or (yas/template-name template)
(yas/template-uuid template))
,(yas/make-menu-binding template)
:keys ,nil)
(defun yas/show-menu-p (mode)
(cond ((eq yas/use-menu 'abbreviate)
(find mode
(mapcar #'(lambda (table)
(intern (yas/table-name table)))
((eq yas/use-menu 'real-modes)
(yas/real-mode? mode))
(defun yas/delete-from-keymap (keymap uuid)
"Recursively delete items with UUID from KEYMAP and its submenus."
;; XXX: This used to skip any submenus named \"parent mode\"
;; First of all, recursively enter submenus, i.e. the tree is
;; searched depth first so that stale submenus can be found in the
;; higher passes.
(mapc #'(lambda (item)
(when (and (listp (cdr item))
(keymapp (third (cdr item))))
(yas/delete-from-keymap (third (cdr item)) uuid)))
(rest keymap))
;; Set the uuid entry to nil
(define-key keymap (vector (make-symbol uuid)) nil)
;; Destructively modify keymap
(setcdr keymap (delete-if #'(lambda (item)
(or (null (cdr item))
(and (keymapp (third (cdr item)))
(null (cdr (third (cdr item)))))))
(rest keymap))))
(defun yas/define-menu (mode menu omit-items)
"Define a snippet menu for MODE according to MENU, ommitting OMIT-ITEMS.
MENU is a list, its elements can be:
- (yas/item UUID) : Creates an entry the snippet identified with
UUID. The menu entry for a snippet thus identified is
permanent, i.e. it will never move in the menu.
- (yas/separator) : Creates a separator
- (yas/submenu NAME SUBMENU) : Creates a submenu with NAME,
SUBMENU has the same form as MENU. NAME is also added to the
list of groups of the snippets defined thereafter.
OMIT-ITEMS is a list of snippet uuid's that will always be
ommited from MODE's menu, even if they're manually loaded.
(let* ((table (yas/table-get-create mode))
(hash (yas/table-uuidhash table)))
(yas/define-menu-1 table
(yas/menu-keymap-get-create table)
(dolist (uuid omit-items)
(let ((template (or (gethash uuid hash)
(yas/populate-template (puthash uuid
:table table
:uuid uuid))))
(setf (yas/template-menu-binding-pair template) (cons nil :none))))))
(defun yas/define-menu-1 (table keymap menu uuidhash &optional group-list)
(dolist (e (reverse menu))
(cond ((eq (first e) 'yas/item)
(let ((template (or (gethash (second e) uuidhash)
(yas/populate-template (puthash (second e)
:table table
:perm-group group-list
:uuid (second e)))))
(define-key keymap (vector (gensym))
(car (yas/snippet-menu-binding-pair-get-create template :stay)))))
((eq (first e) 'yas/submenu)
(let ((subkeymap (make-sparse-keymap)))
(define-key keymap (vector (gensym))
`(menu-item ,(second e) ,subkeymap))
(yas/define-menu-1 table
(third e)
(append group-list (list (second e))))))
((eq (first e) 'yas/separator)
(define-key keymap (vector (gensym))
'(menu-item "----")))
(message "[yas] don't know anything about menu entry %s" (first e))))))
(defun yas/define (mode key template &optional name condition group)
"Define a snippet. Expanding KEY into TEMPLATE.
NAME is a description to this template. Also update the menu if
`yas/use-menu' is `t'. CONDITION is the condition attached to
this snippet. If you attach a condition to a snippet, then it
will only be expanded when the condition evaluated to non-nil."
(yas/define-snippets mode
(list (list key template name condition group))))
(defun yas/hippie-try-expand (first-time?)
"Integrate with hippie expand. Just put this function in
(if (not first-time?)
(let ((yas/fallback-behavior 'return-nil))
(undo 1)
;;; Apropos condition-cache:
(defvar yas/condition-cache-timestamp nil)
(defmacro yas/define-condition-cache (func doc &rest body)
"Define a function FUNC with doc DOC and body BODY, BODY is
executed at most once every snippet expansion attempt, to check
expansion conditions.
It doesn't make any sense to call FUNC programatically."
`(defun ,func () ,(if (and doc
(stringp doc))
(concat doc
"\n\nFor use in snippets' conditions. Within each
snippet-expansion routine like `yas/expand', computes actual
value for the first time then always returns a cached value.")
(setq body (cons doc body))
(let ((timestamp-and-value (get ',func 'yas/condition-cache)))
(if (equal (car timestamp-and-value) yas/condition-cache-timestamp)
(cdr timestamp-and-value)
(let ((new-value (progn
(put ',func 'yas/condition-cache (cons yas/condition-cache-timestamp new-value))
(defalias 'yas/expand 'yas/expand-from-trigger-key)
(defun yas/expand-from-trigger-key (&optional field)
"Expand a snippet before point.
If no snippet expansion is possible, fall back to the behaviour
defined in `yas/fallback-behavior'.
Optional argument FIELD is for non-interactive use and is an
object satisfying `yas/field-p' to restrict the expansion to."
(setq yas/condition-cache-timestamp (current-time))
(let (templates-and-pos)
(unless (and yas/expand-only-for-last-commands
(not (member last-command yas/expand-only-for-last-commands)))
(setq templates-and-pos (if field
(narrow-to-region (yas/field-start field)
(yas/field-end field))
(if (and templates-and-pos
(first templates-and-pos))
(yas/expand-or-prompt-for-template (first templates-and-pos)
(second templates-and-pos)
(third templates-and-pos))
(yas/fallback 'trigger-key))))
(defun yas/expand-from-keymap ()
"Directly expand some snippets, searching `yas/direct-keymaps'.
If expansion fails, execute the previous binding for this key"
(setq yas/condition-cache-timestamp (current-time))
(let* ((vec (this-command-keys-vector))
(templates (mapcan #'(lambda (table)
(yas/fetch table vec))
(if templates
(yas/expand-or-prompt-for-template templates)
(let ((yas/fallback-behavior 'call-other-command))
(defun yas/expand-or-prompt-for-template (templates &optional start end)
"Expand one of TEMPLATES from START to END.
Prompt the user if TEMPLATES has more than one element, else
expand immediately. Common gateway for
`yas/expand-from-trigger-key' and `yas/expand-from-keymap'."
(let ((yas/current-template (or (and (rest templates) ;; more than one
(yas/prompt-for-template (mapcar #'cdr templates)))
(cdar templates))))
(when yas/current-template
(yas/expand-snippet (yas/template-content yas/current-template)
(yas/template-expand-env yas/current-template)))))
(defun yas/fallback (&optional from-trigger-key-p)
"Fallback after expansion has failed.
Common gateway for `yas/expand-from-trigger-key' and
(cond ((eq yas/fallback-behavior 'return-nil)
;; return nil
((eq yas/fallback-behavior 'call-other-command)
(let* ((yas/minor-mode nil)
(yas/direct-keymaps nil)
(keys-1 (this-command-keys-vector))
(keys-2 (and yas/trigger-key
(stringp yas/trigger-key)
(read-kbd-macro yas/trigger-key)))
(command-1 (and keys-1 (key-binding keys-1)))
(command-2 (and keys-2 (key-binding keys-2)))
;; An (ugly) safety: prevents infinite recursion of
;; yas/expand* calls.
(command (or (and (symbolp command-1)
(not (string-match "yas/expand" (symbol-name command-1)))
(and (symbolp command-2)
(when (and (commandp command)
(not (string-match "yas/expand" (symbol-name command))))
(setq this-command command)
(call-interactively command))))
((and (listp yas/fallback-behavior)
(cdr yas/fallback-behavior)
(eq 'apply (car yas/fallback-behavior)))
(if (cddr yas/fallback-behavior)
(apply (cadr yas/fallback-behavior)
(cddr yas/fallback-behavior))
(when (commandp (cadr yas/fallback-behavior))
(setq this-command (cadr yas/fallback-behavior))
(call-interactively (cadr yas/fallback-behavior)))))
;; also return nil if all the other fallbacks have failed
;;; Snippet development
(defun yas/all-templates (tables)
"Return all snippet tables applicable for the current buffer.
Honours `yas/choose-tables-first', `yas/choose-keys-first' and
(when yas/choose-tables-first
(setq tables (list (yas/prompt-for-table tables))))
(mapcar #'cdr
(if yas/choose-keys-first
(let ((key (yas/prompt-for-keys
(mapcan #'yas/table-all-keys tables))))
(when key
(mapcan #'(lambda (table)
(yas/fetch table key))
(remove-duplicates (mapcan #'yas/table-templates tables)
:test #'equal))))
(defun yas/insert-snippet (&optional no-condition)
"Choose a snippet to expand, pop-up a list of choices according
to `yas/prompt-function'.
With prefix argument NO-CONDITION, bypass filtering of snippets
by condition."
(interactive "P")
(setq yas/condition-cache-timestamp (current-time))
(let* ((yas/buffer-local-condition (or (and no-condition
(templates (yas/all-templates (yas/get-snippet-tables)))
(yas/current-template (and templates
(or (and (rest templates) ;; more than one template for same key
(yas/prompt-for-template templates))
(car templates))))
(where (if (region-active-p)
(cons (region-beginning) (region-end))
(cons (point) (point)))))
(if yas/current-template
(yas/expand-snippet (yas/template-content yas/current-template)
(car where)
(cdr where)
(yas/template-expand-env yas/current-template))
(message "[yas] No snippets can be inserted here!"))))
(defun yas/visit-snippet-file ()
"Choose a snippet to edit, selection like `yas/insert-snippet'.
Only success if selected snippet was loaded from a file. Put the
visited file in `snippet-mode'."
(let* ((yas/buffer-local-condition 'always)
(templates (yas/all-templates (yas/get-snippet-tables)))
(yas/prompt-functions '(yas/ido-prompt yas/completing-prompt))
(template (and templates
(or (yas/prompt-for-template templates
"Choose a snippet template to edit: ")
(car templates)))))
(if template
(yas/visit-snippet-file-1 template)
(message "No snippets tables active!"))))
(defun yas/visit-snippet-file-1 (template)
(let ((file (yas/template-file template)))
(cond ((and file (file-readable-p file))
(find-file-other-window file)
(set (make-local-variable 'yas/editing-template) template))
(message "Original file %s no longer exists!" file))
(switch-to-buffer (format "*%s*"(yas/template-name template)))
(let ((type 'snippet))
(when (listp (yas/template-content template))
(insert (format "# type: command\n"))
(setq type 'command))
(insert (format "# key: %s\n" (yas/template-key template)))
(insert (format "# name: %s\n" (yas/template-name template)))
(when (yas/template-keybinding template)
(insert (format "# binding: %s\n" (yas/template-keybinding template))))
(when (yas/template-expand-env template)
(insert (format "# expand-env: %s\n" (yas/template-expand-env template))))
(when (yas/template-condition template)
(insert (format "# condition: %s\n" (yas/template-condition template))))
(insert "# --\n")
(insert (if (eq type 'command)
(pp-to-string (yas/template-content template))
(yas/template-content template))))
(set (make-local-variable 'yas/editing-template) template)))))
(defun yas/guess-snippet-directories-1 (table)
"Guesses possible snippet subdirectories for TABLE."
(cons (yas/table-name table)
(mapcan #'(lambda (parent)
(yas/table-parents table))))
(defun yas/guess-snippet-directories (&optional table)
"Try to guess suitable directories based on the current active
tables (or optional TABLE).
Returns a list of elemts (TABLE . DIRS) where TABLE is a
`yas/table' object and DIRS is a list of all possible directories
where snippets of table might exist."
(let ((main-dir (replace-regexp-in-string
"/+$" ""
(or (first (or (yas/snippet-dirs)
(setq yas/snippet-dirs '("~/.emacs.d/snippets")))))))
(tables (or (and table
(list table))
;; HACK! the snippet table created here is actually registered!
(unless (or table (gethash major-mode yas/tables))
(push (yas/table-get-create major-mode)
(mapcar #'(lambda (table)
(cons table
(mapcar #'(lambda (subdir)
(concat main-dir "/" subdir))
(yas/guess-snippet-directories-1 table))))
(defun yas/make-directory-maybe (table-and-dirs &optional main-table-string)
"Returns a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
(or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
(let ((candidate (first (cdr table-and-dirs))))
(unless (file-writable-p (file-name-directory candidate))
(error "[yas] %s is not writable." candidate))
(if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
(if (gethash (intern (yas/table-name (car table-and-dirs)))
" brand new")
(or main-table-string
(yas/table-name (car table-and-dirs))))
(make-directory candidate 'also-make-parents)
;; create the .yas-parents file here...
(defun yas/new-snippet (&optional choose-instead-of-guess)
(interactive "P")
(let ((guessed-directories (yas/guess-snippet-directories)))
(switch-to-buffer "*new snippet*")
(set (make-local-variable 'yas/guessed-modes) (mapcar #'(lambda (d)
(intern (yas/table-name (car d))))
(unless (and choose-instead-of-guess
(not (y-or-n-p "Insert a snippet with useful headers? ")))
(yas/expand-snippet "\
# -*- mode: snippet -*-
# name: $1
# key: $2${3:
# binding: ${4:direct-keybinding}}${5:
# expand-env: ((${6:some-var} ${7:some-value}))}${8:
# type: command}
# --
(defun yas/find-snippets (&optional same-window )
"Find snippet file in guessed current mode's directory.
Calls `find-file' interactively in the guessed directory.
With prefix arg SAME-WINDOW opens the buffer in the same window.
Because snippets can be loaded from many different locations,
this has to guess the correct directory using
`yas/guess-snippet-directories', which returns a list of
If any one of these exists, it is taken and `find-file' is called
there, otherwise, proposes to create the first option returned by
(interactive "P")
(let* ((guessed-directories (yas/guess-snippet-directories))
(setq chosen (yas/make-directory-maybe (first guessed-directories) " main"))
(unless chosen
(if (y-or-n-p (format "Continue guessing for other active tables %s? "
(mapcar #'(lambda (table-and-dirs)
(yas/table-name (car table-and-dirs)))
(rest guessed-directories))))
(setq chosen (some #'yas/make-directory-maybe
(rest guessed-directories)))))
(unless chosen
(when (y-or-n-p "Having trouble... go to snippet root dir? ")
(setq chosen (first (yas/snippet-dirs)))))
(if chosen
(let ((default-directory chosen))
(setq buffer (call-interactively (if same-window
(when buffer
(set-buffer buffer)
(when (eq major-mode 'fundamental-mode)
(message "Could not guess snippet dir!"))))
(defun yas/compute-major-mode-and-parents (file &optional prompt-if-failed)
(let* ((file-dir (and file
(directory-file-name (or (some #'(lambda (special)
(locate-dominating-file file special))
(directory-file-name (file-name-directory file))))))
(parents-file-name (concat file-dir "/.yas-parents"))
(major-mode-name (and file-dir
(file-name-nondirectory file-dir)))
(major-mode-sym (or (and major-mode-name
(intern major-mode-name))
(when prompt-if-failed
"[yas] Cannot auto-detect major mode! Enter a major mode: "))))
(parents (when (file-readable-p parents-file-name)
(mapcar #'intern
(insert-file-contents parents-file-name)
(buffer-substring-no-properties (point-min)
(when major-mode-sym
(cons major-mode-sym parents))))
(defvar yas/editing-template nil
"Supporting variable for `yas/load-snippet-buffer' and `yas/visit-snippet'")
(defvar yas/current-template nil
"Holds the current template being expanded into a snippet.")
(defvar yas/guessed-modes nil
"List of guessed modes supporting `yas/load-snippet-buffer'.")
(defun yas/load-snippet-buffer (&optional kill)
"Parse and load current buffer's snippet definition.
With optional prefix argument KILL quit the window and buffer."
(interactive "P")
;; We have `yas/editing-template', this buffer's
;; content comes from a template which is already loaded and
;; neatly positioned,...
(yas/define-snippets-1 (yas/parse-template (yas/template-file yas/editing-template))
(yas/template-table yas/editing-template)))
;; Try to use `yas/guessed-modes'. If we don't have that use the
;; value from `yas/compute-major-mode-and-parents'
(unless yas/guessed-modes
(set (make-local-variable 'yas/guessed-modes) (or (yas/compute-major-mode-and-parents buffer-file-name))))
(let* ((prompt (if (and (featurep 'ido)
'ido-completing-read 'completing-read))
(table (yas/table-get-create
(funcall prompt (format "Choose or enter a table (yas guesses %s): "
(if yas/guessed-modes
(first yas/guessed-modes)
(mapcar #'symbol-name yas/guessed-modes)
(if (first yas/guessed-modes)
(symbol-name (first yas/guessed-modes))))))))
(set (make-local-variable 'yas/editing-template)
(yas/define-snippets-1 (yas/parse-template buffer-file-name)
;; Now, offer to save this shit iff:
;; 1) `yas/snippet-dirs' is a list and its first element does not
;; match this template's file (i.e. this is a library snippet, not
;; a user snippet) OR
;; 2) yas/editing-template comes from a file that we cannot write to...
(when (or (not (yas/template-file yas/editing-template))
(not (file-writable-p (yas/template-file yas/editing-template)))
(and (listp yas/snippet-dirs)
(second yas/snippet-dirs)
(not (string-match (expand-file-name (first yas/snippet-dirs))
(yas/template-file yas/editing-template)))))
(when (y-or-n-p "[yas] Looks like a library or new snippet. Save to new file? ")
(let* ((option (first (yas/guess-snippet-directories (yas/template-table yas/editing-template))))
(chosen (and option
(yas/make-directory-maybe option))))
(when chosen
(let ((default-file-name (or (and (yas/template-file yas/editing-template)
(file-name-nondirectory (yas/template-file yas/editing-template)))
(yas/template-name yas/editing-template))))
(write-file (concat chosen "/"
(read-from-minibuffer (format "File name to create in %s? " chosen)
(setf (yas/template-file yas/editing-template) buffer-file-name))))))
(when kill
(quit-window kill))
(message "[yas] Snippet \"%s\" loaded for %s."
(yas/template-name yas/editing-template)
(yas/table-name (yas/template-table yas/editing-template))))
(defun yas/tryout-snippet (&optional debug)
"Test current buffers's snippet template in other buffer."
(interactive "P")
(let* ((major-mode-and-parent (yas/compute-major-mode-and-parents buffer-file-name))
(parsed (yas/parse-template))
(test-mode (or (and (car major-mode-and-parent)
(fboundp (car major-mode-and-parent))
(car major-mode-and-parent))
(first yas/guessed-modes)
(intern (read-from-minibuffer "[yas] please input a mode: "))))
(and parsed
(fboundp test-mode)
(yas/populate-template (yas/make-blank-template)
:table nil ;; no tables for ephemeral snippets
:key (first parsed)
:content (second parsed)
:name (third parsed)
:expand-env (sixth parsed)))))
(cond (yas/current-template
(let ((buffer-name (format "*testing snippet: %s*" (yas/template-name yas/current-template))))
(kill-buffer (get-buffer-create buffer-name))
(switch-to-buffer (get-buffer-create buffer-name))
(setq buffer-undo-list nil)
(condition-case nil (funcall test-mode) (error nil))
(setq buffer-read-only nil)
(yas/expand-snippet (yas/template-content yas/current-template)
(yas/template-expand-env yas/current-template))
(when (and debug
(require 'yasnippet-debug nil t))
(add-hook 'post-command-hook 'yas/debug-snippet-vars nil t))))
(message "[yas] Cannot test snippet for unknown major mode")))))
(defun yas/template-fine-group (template)
(car (last (or (yas/template-group template)
(yas/template-perm-group template)))))
(defun yas/describe-tables (&optional choose)
"Display snippets for each table."
(interactive "P")
(let* ((by-name-hash (and choose
(y-or-n-p "Show by namehash? ")))
(buffer (get-buffer-create "*YASnippet tables*"))
(active-tables (yas/get-snippet-tables))
(remain-tables (let ((all))
(maphash #'(lambda (k v)
(unless (find v active-tables)
(push v all)))
(table-lists (list active-tables remain-tables))
(original-buffer (current-buffer))
(continue t)
(yas/condition-cache-timestamp (current-time)))
(with-current-buffer buffer
(setq buffer-read-only nil)
(cond ((not by-name-hash)
(insert "YASnippet tables: \n")
(while (and table-lists
(dolist (table (car table-lists))
(yas/describe-pretty-table table original-buffer))
(setq table-lists (cdr table-lists))
(when table-lists
(display-buffer buffer)
(setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
(goto-char 1))
(insert "\n\nYASnippet tables by NAMEHASH: \n")
(dolist (table (append active-tables remain-tables))
(insert (format "\nSnippet table `%s':\n\n" (yas/table-name table)))
(let ((keys))
(maphash #'(lambda (k v)
(push k keys))
(yas/table-hash table))
(dolist (key keys)
(insert (format " key %s maps snippets: %s\n" key
(let ((names))
(maphash #'(lambda (k v)
(push k names))
(gethash key (yas/table-hash table)))
(goto-char 1)
(setq buffer-read-only t))
(display-buffer buffer)))
(defun yas/describe-pretty-table (table &optional original-buffer)
(insert (format "\nSnippet table `%s'"
(yas/table-name table)))
(if (yas/table-parents table)
(insert (format " parents: %s\n"
(mapcar #'yas/table-name
(yas/table-parents table))))
(insert "\n"))
(insert (make-string 100 ?-) "\n")
(insert "group state name key binding\n")
(let ((groups-alist (list))
(maphash #'(lambda (k v)
(setq group (or (yas/template-fine-group v)
"(top level)"))
(when (yas/template-name v)
(aput 'groups-alist group (cons v (aget groups-alist group)))))
(yas/table-uuidhash table))
(dolist (group-and-templates groups-alist)
(when (rest group-and-templates)
(setq group (truncate-string-to-width (car group-and-templates) 25 0 ? "..."))
(insert (make-string 100 ?-) "\n")
(dolist (p (cdr group-and-templates))
(let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas/template-name p))
'yasnippet p)
50 0 ? "..."))
(group (prog1 group
(setq group (make-string (length group) ? ))))
(condition-string (let ((condition (yas/template-condition p)))
(if (and condition
(with-current-buffer original-buffer
(if (yas/eval-condition condition)
(insert group " ")
(insert condition-string " ")
(insert name
(if (string-match "\\.\\.\\.$" name)
" ")
" ")
(insert (truncate-string-to-width (or (yas/template-key p) "")
15 0 ? "...") " ")
(insert (truncate-string-to-width (key-description (yas/template-keybinding p))
15 0 ? "...") " ")
(insert "\n")))))))
;;; User convenience functions, for using in snippet definitions
(defvar yas/modified-p nil
"Non-nil if field has been modified by user or transformation.")
(defvar yas/moving-away-p nil
"Non-nil if user is about to exit field.")
(defvar yas/text nil
"Contains current field text.")
(defun yas/substr (str pattern &optional subexp)
"Search PATTERN in STR and return SUBEXPth match.
If found, the content of subexp group SUBEXP (default 0) is
returned, or else the original STR will be returned."
(let ((grp (or subexp 0)))
(if (string-match pattern str)
(match-string-no-properties grp str)
(defun yas/choose-value (possibilities)
"Prompt for a string in the list POSSIBILITIES and return it."
(unless (or yas/moving-away-p
(some #'(lambda (fn)
(funcall fn "Choose: " possibilities))
(defun yas/key-to-value (alist)
"Prompt for a string in the list POSSIBILITIES and return it."
(unless (or yas/moving-away-p
(let ((key (read-key-sequence "")))
(when (stringp key)
(or (cdr (find key alist :key #'car :test #'string=))
(defun yas/throw (text)
"Throw a yas/exception with TEXT as the reason."
(throw 'yas/exception (cons 'yas/exception text)))
(defun yas/verify-value (possibilities)
"Verify that the current field value is in POSSIBILITIES
Otherwise throw exception."
(when (and yas/moving-away-p (notany #'(lambda (pos) (string= pos yas/text)) possibilities))
(yas/throw (format "[yas] field only allows %s" possibilities))))
(defun yas/field-value (number)
"Get the string for field with NUMBER.
Use this in primary and mirror transformations to tget."
(let* ((snippet (car (yas/snippets-at-point)))
(field (and snippet
(yas/snippet-find-field snippet number))))
(when field
(yas/field-text-for-display field))))
(defun yas/text ()
"Return `yas/text' if that exists and is non-empty, else nil."
(if (and yas/text
(not (string= "" yas/text)))
;; (defun yas/selected-text ()
;; "Return `yas/selected-text' if that exists and is non-empty, else nil."
;; (if (and yas/selected-text
;; (not (string= "" yas/selected-text)))
;; yas/selected-text))
(defun yas/get-field-once (number &optional transform-fn)
(unless yas/modified-p
(if transform-fn
(funcall transform-fn (yas/field-value number))
(yas/field-value number))))
(defun yas/default-from-field (number)
(unless yas/modified-p
(yas/field-value number)))
(defun yas/inside-string ()
(equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
(defun yas/unimplemented (&optional missing-feature)
(if yas/current-template
(if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
(or missing-feature
(yas/visit-snippet-file-1 yas/current-template))
(message "No implementation. Missing %s" (or missing-feature "something"))))
;;; Snippet expansion and field management
(defvar yas/active-field-overlay nil
"Overlays the currently active field.")
(defvar yas/field-protection-overlays nil
"Two overlays protect the current active field ")
(defconst yas/prefix nil
"A prefix argument for expansion direct from keybindings")
(defvar yas/selected-text nil
"The selected region deleted on the last snippet expansion.")
(defvar yas/start-column nil
"The column where the snippet expansion started.")
(make-variable-buffer-local 'yas/active-field-overlay)
(make-variable-buffer-local 'yas/field-protection-overlays)
(put 'yas/active-field-overlay 'permanent-local t)
(put 'yas/field-protection-overlays 'permanent-local t)
(defstruct (yas/snippet (:constructor yas/make-snippet ()))
"A snippet.
(fields '())
(exit nil)
(id (yas/snippet-next-id) :read-only t)
(control-overlay nil)
;; stacked expansion: the `previous-active-field' slot saves the
;; active field where the child expansion took place
(defstruct (yas/field (:constructor yas/make-field (number start end parent-field)))
"A field."
start end
(mirrors '())
(transform nil)
(modified-p nil)
(defstruct (yas/mirror (:constructor yas/make-mirror (start end transform)))
"A mirror."
start end
(transform nil)
(defstruct (yas/exit (:constructor yas/make-exit (marker)))
(defun yas/apply-transform (field-or-mirror field &optional empty-on-nil-p)
"Calculate transformed string for FIELD-OR-MIRROR from FIELD.
If there is no transform for ht field, return nil.
If there is a transform but it returns nil, return the empty
string iff EMPTY-ON-NIL-P is true."
(let* ((yas/text (yas/field-text-for-display field))
(text yas/text)
(yas/modified-p (yas/field-modified-p field))
(yas/moving-away-p nil)
(transform (if (yas/mirror-p field-or-mirror)
(yas/mirror-transform field-or-mirror)
(yas/field-transform field-or-mirror)))
(start-point (if (yas/mirror-p field-or-mirror)
(yas/mirror-start field-or-mirror)
(yas/field-start field-or-mirror)))
(transformed (and transform
(goto-char start-point)
(let ((ret (yas/eval-lisp transform)))
(or ret (and empty-on-nil-p "")))))))
(defsubst yas/replace-all (from to &optional text)
"Replace all occurance from FROM to TO.
With optional string TEXT do it in that string."
(if text
(replace-regexp-in-string (regexp-quote from) to text t t)
(goto-char (point-min))
(while (search-forward from nil t)
(replace-match to t t text))))
(defun yas/snippet-find-field (snippet number)
(find-if #'(lambda (field)
(eq number (yas/field-number field)))
(yas/snippet-fields snippet)))
(defun yas/snippet-sort-fields (snippet)
"Sort the fields of SNIPPET in navigation order."
(setf (yas/snippet-fields snippet)
(sort (yas/snippet-fields snippet)
(defun yas/snippet-field-compare (field1 field2)
"Compare two fields. The field with a number is sorted first.
If they both have a number, compare through the number. If neither
have, compare through the field's start point"
(let ((n1 (yas/field-number field1))
(n2 (yas/field-number field2)))
(if n1
(if n2
(or (zerop n2) (and (not (zerop n1))
(< n1 n2)))
(not (zerop n1)))
(if n2
(zerop n2)
(< (yas/field-start field1)
(yas/field-start field2))))))
(defun yas/field-probably-deleted-p (snippet field)
"Guess if SNIPPET's FIELD should be skipped."
(and (zerop (- (yas/field-start field) (yas/field-end field)))
(or (yas/field-parent-field field)
(and (eq field (car (last (yas/snippet-fields snippet))))
(= (yas/field-start field) (overlay-end (yas/snippet-control-overlay snippet)))))
;; the field numbered 0, just before the exit marker, should
;; never be skipped
(not (zerop (yas/field-number field)))))
(defun yas/snippets-at-point (&optional all-snippets)
"Return a sorted list of snippets at point, most recently
inserted first."
(remove nil (remove-duplicates (mapcar #'(lambda (ov)
(overlay-get ov 'yas/snippet))
(if all-snippets
(overlays-in (point-min) (point-max))
(nconc (overlays-at (point)) (overlays-at (1- (point))))))))
#'(lambda (s1 s2)
(<= (yas/snippet-id s2) (yas/snippet-id s1)))))
(defun yas/next-field-or-maybe-expand ()
"Try to expand a snippet at a key before point, otherwise
delegate to `yas/next-field'."
(if yas/triggers-in-field
(let ((yas/fallback-behavior 'return-nil)
(active-field (overlay-get yas/active-field-overlay 'yas/field)))
(when active-field
(unless (yas/expand-from-trigger-key active-field)
(defun yas/next-field (&optional arg)
"Navigate to next field. If there's none, exit the snippet."
(let* ((arg (or arg
(snippet (first (yas/snippets-at-point)))
(active-field (overlay-get yas/active-field-overlay 'yas/field))
(live-fields (remove-if #'(lambda (field)
(and (not (eq field active-field))
(yas/field-probably-deleted-p snippet field)))
(yas/snippet-fields snippet)))
(active-field-pos (position active-field live-fields))
(target-pos (and active-field-pos (+ arg active-field-pos)))
(target-field (and target-pos (nth target-pos live-fields))))
;; First check if we're moving out of a field with a transform
(when (and active-field
(yas/field-transform active-field))
(let* ((yas/moving-away-p t)
(yas/text (yas/field-text-for-display active-field))
(text yas/text)
(yas/modified-p (yas/field-modified-p active-field)))
;; primary field transform: exit call to field-transform
(yas/eval-lisp (yas/field-transform active-field))))
;; Now actually move...
(cond ((and target-pos (>= target-pos (length live-fields)))
(yas/exit-snippet snippet))
(yas/move-to-field snippet target-field))
(defun yas/place-overlays (snippet field)
"Correctly place overlays for SNIPPET's FIELD"
(yas/make-move-field-protection-overlays snippet field)
(yas/make-move-active-field-overlay snippet field))
(defun yas/move-to-field (snippet field)
"Update SNIPPET to move to field FIELD.
Also create some protection overlays"
(goto-char (yas/field-start field))
(yas/place-overlays snippet field)
(overlay-put yas/active-field-overlay 'yas/field field)
(let ((number (yas/field-number field)))
;; check for the special ${0: ...} field
(if (and number (zerop number))
(set-mark (yas/field-end field))
(setf (yas/snippet-force-exit snippet)
(or (yas/field-transform field)
;; make this field active
(setf (yas/snippet-active-field snippet) field)
;; primary field transform: first call to snippet transform
(unless (yas/field-modified-p field)
(if (yas/field-update-display field snippet)
(yas/update-mirrors snippet)
(setf (yas/field-modified-p field) nil))))))
(defun yas/prev-field ()
"Navigate to prev field. If there's none, exit the snippet."
(yas/next-field -1))
(defun yas/abort-snippet (&optional snippet)
(let ((snippet (or snippet
(car (yas/snippets-at-point)))))
(when snippet
(setf (yas/snippet-force-exit snippet) t))))
(defun yas/exit-snippet (snippet)
"Goto exit-marker of SNIPPET."
(interactive (list (first (yas/snippets-at-point))))
(when snippet
(setf (yas/snippet-force-exit snippet) t)
(goto-char (if (yas/snippet-exit snippet)
(yas/exit-marker (yas/snippet-exit snippet))
(overlay-end (yas/snippet-control-overlay snippet))))))
(defun yas/exit-all-snippets ()
"Exit all snippets."
(mapc #'(lambda (snippet)
(yas/exit-snippet snippet)
;;; Some low level snippet-routines
(defmacro yas/inhibit-overlay-hooks (&rest body)
"Run BODY with `yas/inhibit-overlay-hooks' set to t."
(declare (indent 0))
`(let ((yas/inhibit-overlay-hooks t))
(progn ,@body)))
(defun yas/commit-snippet (snippet)
"Commit SNIPPET, but leave point as it is. This renders the
snippet as ordinary text.
Return a buffer position where the point should be placed if
exiting the snippet."
(let ((control-overlay (yas/snippet-control-overlay snippet))
;; Save the end of the moribund snippet in case we need to revive it
;; its original expansion.
(when (and control-overlay
(overlay-buffer control-overlay))
(setq yas/snippet-beg (overlay-start control-overlay))
(setq yas/snippet-end (overlay-end control-overlay))
(delete-overlay control-overlay))
(when yas/active-field-overlay
(delete-overlay yas/active-field-overlay))
(when yas/field-protection-overlays
(mapc #'delete-overlay yas/field-protection-overlays)))
;; stacked expansion: if the original expansion took place from a
;; field, make sure we advance it here at least to
;; `yas/snippet-end'...
(let ((previous-field (yas/snippet-previous-active-field snippet)))
(when (and yas/snippet-end previous-field)
(yas/advance-end-maybe previous-field yas/snippet-end)))
;; Convert all markers to points,
(yas/markers-to-points snippet)
;; Take care of snippet revival
(if yas/snippet-revival
(push `(apply yas/snippet-revive ,yas/snippet-beg ,yas/snippet-end ,snippet)
;; Dismember the snippet... this is useful if we get called
;; again from `yas/take-care-of-redo'....
(setf (yas/snippet-fields snippet) nil)))
(message "[yas] snippet %s exited." (yas/snippet-id snippet)))
(defun yas/safely-run-hooks (hook-var)
(condition-case error
(run-hooks hook-var)
(message "[yas] %s error: %s" hook-var (error-message-string error)))))
(defun yas/check-commit-snippet ()
"Checks if point exited the currently active field of the
snippet, if so cleans up the whole snippet up."
(let* ((snippets (yas/snippets-at-point 'all-snippets))
(snippets-left snippets)
(dolist (snippet snippets)
(let ((active-field (yas/snippet-active-field snippet)))
(setq snippet-exit-transform (yas/snippet-force-exit snippet))
(cond ((or snippet-exit-transform
(not (and active-field (yas/field-contains-point-p active-field))))
(setq snippets-left (delete snippet snippets-left))
(setf (yas/snippet-force-exit snippet) nil)
(yas/commit-snippet snippet))
((and active-field
(or (not yas/active-field-overlay)
(not (overlay-buffer yas/active-field-overlay))))
;; stacked expansion: this case is mainly for recent
;; snippet exits that place us back int the field of
;; another snippet
(yas/move-to-field snippet active-field)
(yas/update-mirrors snippet)))
(unless (or (null snippets) snippets-left)
(if snippet-exit-transform
(yas/eval-lisp-no-saves snippet-exit-transform))
(yas/safely-run-hooks 'yas/after-exit-snippet-hook))))
;; Apropos markers-to-points:
;; This was found useful for performance reasons, so that an
;; excessive number of live markers aren't kept around in the
;; `buffer-undo-list'. However, in `markers-to-points', the
;; set-to-nil markers can't simply be discarded and replaced with
;; fresh ones in `points-to-markers'. The original marker that was
;; just set to nil has to be reused.
;; This shouldn't bring horrible problems with undo/redo, but it
;; you never know
(defun yas/markers-to-points (snippet)
"Convert all markers in SNIPPET to a cons (POINT . MARKER)
where POINT is the original position of the marker and MARKER is
the original marker object with the position set to nil."
(dolist (field (yas/snippet-fields snippet))
(let ((start (marker-position (yas/field-start field)))
(end (marker-position (yas/field-end field))))
(set-marker (yas/field-start field) nil)
(set-marker (yas/field-end field) nil)
(setf (yas/field-start field) (cons start (yas/field-start field)))
(setf (yas/field-end field) (cons end (yas/field-end field))))
(dolist (mirror (yas/field-mirrors field))
(let ((start (marker-position (yas/mirror-start mirror)))
(end (marker-position (yas/mirror-end mirror))))
(set-marker (yas/mirror-start mirror) nil)
(set-marker (yas/mirror-end mirror) nil)
(setf (yas/mirror-start mirror) (cons start (yas/mirror-start mirror)))
(setf (yas/mirror-end mirror) (cons end (yas/mirror-end mirror))))))
(let ((snippet-exit (yas/snippet-exit snippet)))
(when snippet-exit
(let ((exit (marker-position (yas/exit-marker snippet-exit))))
(set-marker (yas/exit-marker snippet-exit) nil)
(setf (yas/exit-marker snippet-exit) (cons exit (yas/exit-marker snippet-exit)))))))
(defun yas/points-to-markers (snippet)
"Convert all cons (POINT . MARKER) in SNIPPET to markers. This
is done by setting MARKER to POINT with `set-marker'."
(dolist (field (yas/snippet-fields snippet))
(setf (yas/field-start field) (set-marker (cdr (yas/field-start field))
(car (yas/field-start field))))
(setf (yas/field-end field) (set-marker (cdr (yas/field-end field))
(car (yas/field-end field))))
(dolist (mirror (yas/field-mirrors field))
(setf (yas/mirror-start mirror) (set-marker (cdr (yas/mirror-start mirror))
(car (yas/mirror-start mirror))))
(setf (yas/mirror-end mirror) (set-marker (cdr (yas/mirror-end mirror))
(car (yas/mirror-end mirror))))))
(let ((snippet-exit (yas/snippet-exit snippet)))
(when snippet-exit
(setf (yas/exit-marker snippet-exit) (set-marker (cdr (yas/exit-marker snippet-exit))
(car (yas/exit-marker snippet-exit)))))))
(defun yas/field-contains-point-p (field &optional point)
(let ((point (or point
(and (>= point (yas/field-start field))
(<= point (yas/field-end field)))))
(defun yas/field-text-for-display (field)
"Return the propertized display text for field FIELD. "
(buffer-substring (yas/field-start field) (yas/field-end field)))
(defun yas/undo-in-progress ()
"True if some kind of undo is in progress"
(or undo-in-progress
(eq this-command 'undo)
(eq this-command 'redo)))
(defun yas/make-control-overlay (snippet start end)
"Creates the control overlay that surrounds the snippet and
holds the keymap."
(let ((overlay (make-overlay start
(overlay-put overlay 'keymap yas/keymap)
(overlay-put overlay 'priority 100)
(overlay-put overlay 'yas/snippet snippet)
(defun yas/skip-and-clear-or-delete-char (&optional field)
"Clears unmodified field if at field start, skips to next tab.
Otherwise deletes a character normally by calling `delete-char'."
(let ((field (or field
(and yas/active-field-overlay
(overlay-buffer yas/active-field-overlay)
(overlay-get yas/active-field-overlay 'yas/field)))))
(cond ((and field
(not (yas/field-modified-p field))
(eq (point) (marker-position (yas/field-start field))))
(yas/skip-and-clear field)
(yas/next-field 1))
(call-interactively 'delete-char)))))
(defun yas/skip-and-clear (field)
"Deletes the region of FIELD and sets it modified state to t"
;; Just before skipping-and-clearing the field, mark its children
;; fields as modified, too. If the childen have mirrors-in-fields
;; this prevents them from updating erroneously (we're skipping and
;; deleting!).
(yas/mark-this-and-children-modified field)
(delete-region (yas/field-start field) (yas/field-end field)))
(defun yas/mark-this-and-children-modified (field)
(setf (yas/field-modified-p field) t)
(let ((fom (yas/field-next field)))
(while (and fom
(yas/fom-parent-field fom))
(when (and (eq (yas/fom-parent-field fom) field)
(yas/field-p fom))
(yas/mark-this-and-children-modified fom))
(setq fom (yas/fom-next fom)))))
(defun yas/make-move-active-field-overlay (snippet field)
"Place the active field overlay in SNIPPET's FIELD.
Move the overlay, or create it if it does not exit."
(if (and yas/active-field-overlay
(overlay-buffer yas/active-field-overlay))
(move-overlay yas/active-field-overlay
(yas/field-start field)
(yas/field-end field))
(setq yas/active-field-overlay
(make-overlay (yas/field-start field)
(yas/field-end field)
nil nil t))
(overlay-put yas/active-field-overlay 'priority 100)
(overlay-put yas/active-field-overlay 'face 'yas/field-highlight-face)
(overlay-put yas/active-field-overlay 'yas/snippet snippet)
(overlay-put yas/active-field-overlay 'modification-hooks '(yas/on-field-overlay-modification))
(overlay-put yas/active-field-overlay 'insert-in-front-hooks
(overlay-put yas/active-field-overlay 'insert-behind-hooks
(defvar yas/inhibit-overlay-hooks nil
"Bind this temporarity to non-nil to prevent running `yas/on-*-modification'.")
(defun yas/on-field-overlay-modification (overlay after? beg end &optional length)
"Clears the field and updates mirrors, conditionally.
Only clears the field if it hasn't been modified and it point it
at field start. This hook doesn't do anything if an undo is in
(unless (or yas/inhibit-overlay-hooks
(let* ((field (overlay-get overlay 'yas/field))
(number (and field (yas/field-number field)))
(snippet (overlay-get yas/active-field-overlay 'yas/snippet)))
(cond (after?
(yas/advance-end-maybe field (overlay-end overlay))
(yas/field-update-display field snippet))
(yas/update-mirrors snippet))
(when (and (not after?)
(not (yas/field-modified-p field))
(eq (point) (if (markerp (yas/field-start field))
(marker-position (yas/field-start field))
(yas/field-start field))))
(yas/skip-and-clear field))
(setf (yas/field-modified-p field) t))))))
;;; Apropos protection overlays:
;; These exist for nasty users who will try to delete parts of the
;; snippet outside the active field. Actual protection happens in
;; `yas/on-protection-overlay-modification'.
;; Currently this signals an error which inhibits the command. For
;; commands that move point (like `kill-line'), point is restored in
;; the `yas/post-command-handler' using a global
;; `yas/protection-violation' variable.
;; Alternatively, I've experimented with an implementation that
;; commits the snippet before actually calling `this-command'
;; interactively, and then signals an eror, which is ignored. but
;; blocks all other million modification hooks. This presented some
;; problems with stacked expansion.
(defun yas/make-move-field-protection-overlays (snippet field)
"Place protection overlays surrounding SNIPPET's FIELD.
Move the overlays, or create them if they do not exit."
(let ((start (yas/field-start field))
(end (yas/field-end field)))
;; First check if the (1+ end) is contained in the buffer,
;; otherwise we'll have to do a bit of cheating and silently
;; insert a newline. the `(1+ (buffer-size))' should prevent this
;; when using stacked expansion
(when (< (buffer-size) end)
(goto-char (point-max))
;; go on to normal overlay creation/moving
(cond ((and yas/field-protection-overlays
(every #'overlay-buffer yas/field-protection-overlays))
(move-overlay (first yas/field-protection-overlays) (1- start) start)
(move-overlay (second yas/field-protection-overlays) end (1+ end)))
(setq yas/field-protection-overlays
(list (make-overlay (1- start) start nil t nil)
(make-overlay end (1+ end) nil t nil)))
(dolist (ov yas/field-protection-overlays)
(overlay-put ov 'face 'yas/field-debug-face)
(overlay-put ov 'yas/snippet snippet)
;; (overlay-put ov 'evaporate t)
(overlay-put ov 'modification-hooks '(yas/on-protection-overlay-modification)))))))
(defvar yas/protection-violation nil
"When non-nil, signals attempts to erronesly exit or modify the snippet.
Functions in the `post-command-hook', for example
`yas/post-command-handler' can check it and reset its value to
nil. The variables value is the point where the violation
(defun yas/on-protection-overlay-modification (overlay after? beg end &optional length)
"Signals a snippet violation, then issues error.
The error should be ignored in `debug-ignored-errors'"
(unless yas/inhibit-overlay-hooks
(cond ((not (or after?
(setq yas/protection-violation (point))
(error "Exit the snippet first!")))))
(add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
;;; Apropos stacked expansion:
;; the parent snippet does not run its fields modification hooks
;; (`yas/on-field-overlay-modification' and
;; `yas/on-protection-overlay-modification') while the child snippet
;; is active. This means, among other things, that the mirrors of the
;; parent snippet are not updated, this only happening when one exits
;; the child snippet.
;; Unfortunately, this also puts some ugly (and not fully-tested)
;; bits of code in `yas/expand-snippet' and
;; `yas/commit-snippet'. I've tried to mark them with "stacked
;; expansion:".
;; This was thought to be safer in in an undo/redo perpective, but
;; maybe the correct implementation is to make the globals
;; `yas/active-field-overlay' and `yas/field-protection-overlays' be
;; snippet-local and be active even while the child snippet is
;; running. This would mean a lot of overlay modification hooks
;; running, but if managed correctly (including overlay priorities)
;; they should account for all situations...
(defun yas/expand-snippet (content &optional start end expand-env)
"Expand snippet CONTENT at current point.
Text between START and END will be deleted before inserting
template. EXPAND-ENV is are let-style variable to value bindings
considered when expanding the snippet."
(run-hooks 'yas/before-expand-snippet-hook)
;; If a region is active, set `yas/selected-text'
(setq yas/selected-text
(when (region-active-p)
(prog1 (buffer-substring-no-properties (region-beginning)
(unless start (setq start (region-beginning))
(unless end (setq end (region-end)))))))
(when start
(goto-char start))
(let ((to-delete (and start end (buffer-substring-no-properties start end)))
(start (or start (point)))
(end (or end (point)))
(setq yas/indent-original-column (current-column))
;; Delete the region to delete, this *does* get undo-recorded.
(when (and to-delete
(> end start))
(delete-region start end))
(cond ((listp content)
;; x) This is a snippet-command
(yas/eval-lisp-no-saves content))
;; x) This is a snippet-snippet :-)
;; Narrow the region down to the content, shoosh the
;; `buffer-undo-list', and create the snippet, the new
;; snippet updates its mirrors once, so we are left with
;; some plain text. The undo action for deleting this
;; plain text will get recorded at the end.
;; stacked expansion: also shoosh the overlay modification hooks
(narrow-to-region start start)
(let ((buffer-undo-list t))
;; snippet creation might evaluate users elisp, which
;; might generate errors, so we have to be ready to catch
;; them mostly to make the undo information
(setq yas/start-column (save-restriction (widen) (current-column)))
(setq snippet
(if expand-env
(eval `(let* ,expand-env
(insert content)
(yas/snippet-create (point-min) (point-max))))
(insert content)
(yas/snippet-create (point-min) (point-max)))))))
;; stacked-expansion: This checks for stacked expansion, save the
;; `yas/previous-active-field' and advance its boudary.
(let ((existing-field (and yas/active-field-overlay
(overlay-buffer yas/active-field-overlay)
(overlay-get yas/active-field-overlay 'yas/field))))
(when existing-field
(setf (yas/snippet-previous-active-field snippet) existing-field)
(yas/advance-end-maybe existing-field (overlay-end yas/active-field-overlay))))
;; Exit the snippet immediately if no fields
(unless (yas/snippet-fields snippet)
(yas/exit-snippet snippet))
;; Push two undo actions: the deletion of the inserted contents of
;; the new snippet (without the "key") followed by an apply of
;; `yas/take-care-of-redo' on the newly inserted snippet boundaries
;; A small exception, if `yas/also-auto-indent-first-line'
;; is t and `yas/indent' decides to indent the line to a
;; point before the actual expansion point, undo would be
;; messed up. We call the early point "newstart"". case,
;; and attempt to fix undo.
(let ((newstart (overlay-start (yas/snippet-control-overlay snippet)))
(end (overlay-end (yas/snippet-control-overlay snippet))))
(when (< newstart start)
(push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
(push (cons newstart end) buffer-undo-list)
(push `(apply yas/take-care-of-redo ,start ,end ,snippet)
;; Now, schedule a move to the first field
(let ((first-field (car (yas/snippet-fields snippet))))
(when first-field
(sit-for 0) ;; fix issue 125
(yas/move-to-field snippet first-field)))
(message "[yas] snippet expanded.")
(defun yas/take-care-of-redo (beg end snippet)
"Commits SNIPPET, which in turn pushes an undo action for
reviving it.
Meant to exit in the `buffer-undo-list'."
;; slightly optimize: this action is only needed for snippets with
;; at least one field
(when (yas/snippet-fields snippet)
(yas/commit-snippet snippet)))
(defun yas/snippet-revive (beg end snippet)
"Revives the SNIPPET and creates a control overlay from BEG to
BEG and END are, we hope, the original snippets boudaries. All
the markers/points exiting existing inside SNIPPET should point
to their correct locations *at the time the snippet is revived*.
After revival, push the `yas/take-care-of-redo' in the
;; Reconvert all the points to markers
(yas/points-to-markers snippet)
;; When at least one editable field existed in the zombie snippet,
;; try to revive the whole thing...
(let ((target-field (or (yas/snippet-active-field snippet)
(car (yas/snippet-fields snippet)))))
(when target-field
(setf (yas/snippet-control-overlay snippet) (yas/make-control-overlay snippet beg end))
(overlay-put (yas/snippet-control-overlay snippet) 'yas/snippet snippet)
(yas/move-to-field snippet target-field)
(push `(apply yas/take-care-of-redo ,beg ,end ,snippet)
(defun yas/snippet-create (begin end)
"Creates a snippet from an template inserted between BEGIN and END.
Returns the newly created snippet."
(let ((snippet (yas/make-snippet)))
(goto-char begin)
(yas/snippet-parse-create snippet)
;; Sort and link each field
(yas/snippet-sort-fields snippet)
;; Create keymap overlay for snippet
(setf (yas/snippet-control-overlay snippet)
(yas/make-control-overlay snippet (point-min) (point-max)))
;; Move to end
(goto-char (point-max))
;;; Apropos adjacencies and "fom's":
;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
;; recently expanded snippet, we might actually have many fields,
;; mirrors (and the snippet exit) in the very same position in the
;; buffer. Therefore we need to single-link the
;; fields-or-mirrors-or-exit, which I have called "fom", according to
;; their original positions in the buffer.
;; Then we have operation `yas/advance-end-maybe' and
;; `yas/advance-start-maybe', which conditionally push the starts and
;; ends of these foms down the chain.
;; This allows for like the printf with the magic ",":
;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
;; $2${1:$(if (string-match "%" text) "\);" "")}$0
(defun yas/fom-start (fom)
(cond ((yas/field-p fom)
(yas/field-start fom))
((yas/mirror-p fom)
(yas/mirror-start fom))
(yas/exit-marker fom))))
(defun yas/fom-end (fom)
(cond ((yas/field-p fom)
(yas/field-end fom))
((yas/mirror-p fom)
(yas/mirror-end fom))
(yas/exit-marker fom))))
(defun yas/fom-next (fom)
(cond ((yas/field-p fom)
(yas/field-next fom))
((yas/mirror-p fom)
(yas/mirror-next fom))
(yas/exit-next fom))))
(defun yas/fom-parent-field (fom)
(cond ((yas/field-p fom)
(yas/field-parent-field fom))
((yas/mirror-p fom)
(yas/mirror-parent-field fom))
(defun yas/calculate-adjacencies (snippet)
"Calculate adjacencies for fields or mirrors of SNIPPET.
This is according to their relative positions in the buffer, and
has to be called before the $-constructs are deleted."
(flet ((yas/fom-set-next-fom (fom nextfom)
(cond ((yas/field-p fom)
(setf (yas/field-next fom) nextfom))
((yas/mirror-p fom)
(setf (yas/mirror-next fom) nextfom))
(setf (yas/exit-next fom) nextfom))))
(yas/compare-fom-begs (fom1 fom2)
(if (= (yas/fom-start fom2) (yas/fom-start fom1))
(yas/mirror-p fom2)
(>= (yas/fom-start fom2) (yas/fom-start fom1))))
(yas/link-foms (fom1 fom2)
(yas/fom-set-next-fom fom1 fom2)))
;; make some yas/field, yas/mirror and yas/exit soup
(let ((soup))
(when (yas/snippet-exit snippet)
(push (yas/snippet-exit snippet) soup))
(dolist (field (yas/snippet-fields snippet))
(push field soup)
(dolist (mirror (yas/field-mirrors field))
(push mirror soup)))
(setq soup
(sort soup
(when soup
(reduce #'yas/link-foms soup)))))
(defun yas/calculate-mirrors-in-fields (snippet mirror)
"Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
Use the tighest containing field if more than one field contains
the mirror. Intended to be called *before* the dollar-regions are
(let ((min (point-min))
(max (point-max)))
(dolist (field (yas/snippet-fields snippet))
(when (and (<= (yas/field-start field) (yas/mirror-start mirror))
(<= (yas/mirror-end mirror) (yas/field-end field))
(< min (yas/field-start field))
(< (yas/field-end field) max))
(setq min (yas/field-start field)
max (yas/field-end field))
(setf (yas/mirror-parent-field mirror) field)))))
(defun yas/advance-end-maybe (fom newend)
"Maybe advance FOM's end to NEWEND if it needs it.
If it does, also:
* call `yas/advance-start-maybe' on FOM's next fom.
* in case FOM is field call `yas/advance-end-maybe' on its parent
Also, if FOM is an exit-marker, always call
`yas/advance-start-maybe' on its next fom. This is beacuse
exit-marker have identical start and end markers.
(cond ((and fom (< (yas/fom-end fom) newend))
(set-marker (yas/fom-end fom) newend)
(yas/advance-start-maybe (yas/fom-next fom) newend)
(yas/advance-end-of-parents-maybe (yas/fom-parent-field fom) newend))
((yas/exit-p fom)
(yas/advance-start-maybe (yas/fom-next fom) newend))))
(defun yas/advance-start-maybe (fom newstart)
"Maybe advance FOM's start to NEWSTART if it needs it.
If it does, also call `yas/advance-end-maybe' on FOM."
(when (and fom (< (yas/fom-start fom) newstart))
(set-marker (yas/fom-start fom) newstart)
(yas/advance-end-maybe fom newstart)))
(defun yas/advance-end-of-parents-maybe (field newend)
"Like `yas/advance-end-maybe' but for parent fields.
Only works for fields and doesn't care about the start of the
next FOM. Works its way up recursively for parents of parents."
(when (and field
(< (yas/field-end field) newend))
(set-marker (yas/field-end field) newend)
(yas/advance-end-of-parents-maybe (yas/field-parent-field field) newend)))
(defvar yas/dollar-regions nil
"When expanding the snippet the \"parse-create\" functions add
cons cells to this var")
(defun yas/snippet-parse-create (snippet)
"Parse a recently inserted snippet template, creating all
necessary fields, mirrors and exit points.
Meant to be called in a narrowed buffer, does various passes"
(let ((parse-start (point)))
;; Reset the yas/dollar-regions
(setq yas/dollar-regions nil)
;; protect escaped quote, backquotes and backslashes
(yas/protect-escapes nil '(?\\ ?` ?'))
;; replace all backquoted expressions
(goto-char parse-start)
;; protect escapes again since previous steps might have generated
;; more characters needing escaping
(goto-char parse-start)
;; parse fields with {}
(goto-char parse-start)
(yas/field-parse-create snippet)
;; parse simple mirrors and fields
(goto-char parse-start)
(yas/simple-mirror-parse-create snippet)
;; parse mirror transforms
(goto-char parse-start)
(yas/transform-mirror-parse-create snippet)
;; calculate adjacencies of fields and mirrors
(yas/calculate-adjacencies snippet)
;; Delete $-constructs
(yas/delete-regions yas/dollar-regions)
;; restore escapes
(goto-char parse-start)
;; update mirrors for the first time
(yas/update-mirrors snippet)
;; indent the best we can
(goto-char parse-start)
(yas/indent snippet)))
(defun yas/indent-according-to-mode (snippet-markers)
"Indent current line according to mode, preserving
;;; Apropos indenting problems....
;; `indent-according-to-mode' uses whatever `indent-line-function'
;; is available. Some implementations of these functions delete text
;; before they insert. If there happens to be a marker just after
;; the text being deleted, the insertion actually happens after the
;; marker, which misplaces it.
;; This would also happen if we had used overlays with the
;; `front-advance' property set to nil.
;; This is why I have these `trouble-markers', they are the ones at
;; they are the ones at the first non-whitespace char at the line
;; (i.e. at `yas/real-line-beginning'. After indentation takes place
;; we should be at the correct to restore them to. All other
;; non-trouble-markers have been *pushed* and don't need special
;; attention.
(goto-char (yas/real-line-beginning))
(let ((trouble-markers (remove-if-not #'(lambda (marker)
(= marker (point)))
(condition-case err
(error (message "[yas] warning: yas/indent-according-to-mode habing problems running %s" indent-line-function)
(mapc #'(lambda (marker)
(set-marker marker (point)))
(defvar yas/indent-original-column nil)
(defun yas/indent (snippet)
(let ((snippet-markers (yas/collect-snippet-markers snippet)))
;; Look for those $>
(while (re-search-forward "$>" nil t)
(delete-region (match-beginning 0) (match-end 0))
(when (not (eq yas/indent-line 'auto))
(yas/indent-according-to-mode snippet-markers))))
;; Now do stuff for 'fixed and 'auto
(cond ((eq yas/indent-line 'fixed)
(while (and (zerop (forward-line))
(zerop (current-column)))
(indent-to-column yas/indent-original-column)))
((eq yas/indent-line 'auto)
(let ((end (set-marker (make-marker) (point-max)))
(indent-first-line-p yas/also-auto-indent-first-line))
(while (and (zerop (if indent-first-line-p
(forward-line 0)
(setq indent-first-line-p nil))
(forward-line 1)))
(not (eobp))
(<= (point) end))
(yas/indent-according-to-mode snippet-markers))))
(defun yas/collect-snippet-markers (snippet)
"Make a list of all the markers used by SNIPPET."
(let (markers)
(dolist (field (yas/snippet-fields snippet))
(push (yas/field-start field) markers)
(push (yas/field-end field) markers)
(dolist (mirror (yas/field-mirrors field))
(push (yas/mirror-start mirror) markers)
(push (yas/mirror-end mirror) markers)))
(let ((snippet-exit (yas/snippet-exit snippet)))
(when (and snippet-exit
(marker-buffer (yas/exit-marker snippet-exit)))
(push (yas/exit-marker snippet-exit) markers)))
(defun yas/real-line-beginning ()
(let ((c (char-after (line-beginning-position)))
(n (line-beginning-position)))
(while (or (eql c ?\ )
(eql c ?\t))
(incf n)
(setq c (char-after n)))
(defun yas/escape-string (escaped)
(concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
(defun yas/protect-escapes (&optional text escaped)
"Protect all escaped characters with their numeric ASCII value.
With optional string TEXT do it in string instead of buffer."
(let ((changed-text text)
(text-provided-p text))
(mapc #'(lambda (escaped)
(setq changed-text
(yas/replace-all (concat "\\" (char-to-string escaped))
(yas/escape-string escaped)
(when text-provided-p changed-text))))
(or escaped yas/escaped-characters))
(defun yas/restore-escapes (&optional text escaped)
"Restore all escaped characters from their numeric ASCII value.
With optional string TEXT do it in string instead of the buffer."
(let ((changed-text text)
(text-provided-p text))
(mapc #'(lambda (escaped)
(setq changed-text
(yas/replace-all (yas/escape-string escaped)
(char-to-string escaped)
(when text-provided-p changed-text))))
(or escaped yas/escaped-characters))
(defun yas/replace-backquotes ()
"Replace all the \"`(lisp-expression)`\"-style expression
with their evaluated value"
(while (re-search-forward yas/backquote-lisp-expression-regexp nil t)
(let ((current-string (match-string 1)) transformed)
(delete-region (match-beginning 0) (match-end 0))
(setq transformed (yas/eval-lisp (yas/read-lisp (yas/restore-escapes current-string))))
(goto-char (match-beginning 0))
(when transformed (insert transformed)))))
(defun yas/scan-sexps (from count)
(condition-case err
(with-syntax-table (standard-syntax-table)
(scan-sexps from count))
(defun yas/make-marker (pos)
"Create a marker at POS with `nil' `marker-insertion-type'"
(let ((marker (set-marker (make-marker) pos)))
(set-marker-insertion-type marker nil)
(defun yas/field-parse-create (snippet &optional parent-field)
"Parse most field expressions, except for the simple one \"$n\".
The following count as a field:
* \"${n: text}\", for a numbered field with default text, as long as N is not 0;
* \"${n: text$(expression)}, the same with a lisp expression;
this is caught with the curiously named `yas/multi-dollar-lisp-expression-regexp'
* the same as above but unnumbered, (no N:) and number is calculated automatically.
When multiple expressions are found, only the last one counts."
(while (re-search-forward yas/field-regexp nil t)
(let* ((real-match-end-0 (yas/scan-sexps (1+ (match-beginning 0)) 1))
(number (and (match-string-no-properties 1)
(string-to-number (match-string-no-properties 1))))
(brand-new-field (and real-match-end-0
;; break if on "$(" immediately
;; after the ":", this will be
;; caught as a mirror with
;; transform later.
(not (save-match-data
(eq (string-match "$[ \t\n]*("
(match-string-no-properties 2)) 0)))
;; allow ${0: some exit text}
;; (not (and number (zerop number)))
(yas/make-field number
(yas/make-marker (match-beginning 2))
(yas/make-marker (1- real-match-end-0))
(when brand-new-field
(goto-char real-match-end-0)
(push (cons (1- real-match-end-0) real-match-end-0)
(push (cons (match-beginning 0) (match-beginning 2))
(push brand-new-field (yas/snippet-fields snippet))
(narrow-to-region (yas/field-start brand-new-field) (yas/field-end brand-new-field))
(goto-char (point-min))
(yas/field-parse-create snippet brand-new-field)))))))
;; if we entered from a parent field, now search for the
;; `yas/multi-dollar-lisp-expression-regexp'. THis is used for
;; primary field transformations
(when parent-field
(while (re-search-forward yas/multi-dollar-lisp-expression-regexp nil t)
(let* ((real-match-end-1 (yas/scan-sexps (match-beginning 1) 1)))
;; commit the primary field transformation if: