Reference

Clears unmodified field if at field start, skips to next tab.

Otherwise deletes a character normally by calling delete-char.

Exit all snippets.

Goto exit-marker of SNIPPET.

/WARNING/: no doc for symbol yas-abort-snippet

Navigate to prev field. If there's none, exit the snippet.

Navigate to the /ARG/th next field.

If there's none, exit the snippet.

Try to expand a snippet at a key before point.

Otherwise delegate to yas-next-field.

Display snippets for each table.

Test current buffer's snippet template in other buffer.

Parse and load current buffer's snippet definition into TABLE.

TABLE is a symbol naming a passed to yas–table-get-create.

When called interactively, prompt for the table name.

Pops a new buffer for writing a snippet.

Expands a snippet-writing snippet, unless the optional prefix arg NO-TEMPLATE is non-nil.

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.

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.

Expand/run snippets from keymaps, possibly falling back to original binding.

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.

/WARNING/: no doc for symbol yas-about

Compile every dir in yas-snippet-dirs.

Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.

This works by stubbing a few functions, then calling yas-load-directory.

Reload all snippets and rebuild the /YAS/nippet menu.

When called interactively force immediate reload of all known snippets under yas-snippet-dirs, otherwise use just-in-time loading.

Load snippets in directory hierarchy TOP-LEVEL-DIR.

Below TOP-LEVEL-DIR each directory should be a mode name.

Optional USE-JIT use jit-loading of snippets.

Turn on /YAS/nippet minor mode.

Honour yas-dont-activate, which see.

Force reload the direct keybinding for active snippet tables.

Toggle Yas minor mode in all buffers. With prefix ARG, enable Yas-Global mode if ARG is positive; otherwise, disable it. If called from Lisp, enable the mode if ARG is omitted or nil.

Yas minor mode is enabled in all buffers where yas-minor-mode-on would do it. See yas-minor-mode for more information on Yas minor mode.

Toggle /YAS/nippet mode.

When /YAS/nippet mode is enabled, yas-expand, normally bound to the TAB key, expands snippets of code depending on the major mode.

With no argument, this command toggles the mode. positive prefix argument turns on the mode. Negative prefix argument turns off the mode.

Key bindings: \{yas-minor-mode-map}

Expand a snippet before point. If no snippet expansion is possible, defer to yas-fallback-behaviour (which see).

Optional argument FIELD is for non-interactive use and is an object satisfying yas–field-p to restrict the expansion to.

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.

Optionally, 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.

If non-nil visit snippets's files from menu, instead of expanding them.

This can only work when snippets are loaded from files.

If non-nil, don't raise errors in inline elisp evaluation.

An error string "[yas] error" is returned instead.

If non-nil, snippet expansion wraps around selected region.

The wrapping occurs just before the snippet's exit marker. This can be overridden on a per-snippet basis.

The text that will be used in menu to represent the trigger.

Display a /YAS/nippet menu in the menu bar.

When non-nil, submenus for each snippet table will be listed under the menu "Yasnippet".

• If set to abbreviate, only the current major-mode

menu and the modes set in yas–extra-modes are listed.

• If set to full, every submenu is listed
• It set to nil, don't display a menu at all (this requires a yas-reload-all call if the menu is already visible).

Any other non-nil value, every submenu is listed.

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

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.

How to act when yas-expand does not expand a snippet.

• call-other-command means try to temporarily disable /YAS/nippet and call the next command bound to whatever key was used to invoke yas-expand.
• 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.

If non-nil, allow stacked expansions (snippets inside snippets).

Otherwise yas-next-field-or-maybe-expand just moves on to the next field

Non-nil means re-activate snippet fields after undo/redo.

Non-nil means also auto indent first line according to mode.

Naturally this is only valid when yas-indent-line is 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 indentation after expansion (the manual per-line "$>" indentation still applies).

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 nil.

• To signal that the user quit the prompting process, you can

signal quit with

(signal 'quit "user quit!").

Return yas-snippet-dirs (which see) as a list.

Return all active trigger keys for current buffer and point.

Integrate with hippie expand.

Just put this function in hippie-expand-try-functions-list.

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.

/WARNING/: no doc for symbol yas-unimplemented

Return non-nil if the point is inside a string according to font-lock.

/WARNING/: no doc for symbol yas-default-from-field

Return yas-selected-text if that exists and is non-empty, else nil.

Return yas-text if that exists and is non-empty, else nil.

Get the string for field with NUMBER.

Use this in primary and mirror transformations to tget.

Verify that the current field value is in POSSIBILITIES.

Otherwise throw exception.

Throw a yas–exception with TEXT as the reason.

/WARNING/: no doc for symbol yas-key-to-value

Prompt for a string in POSSIBILITIES and return it.

The last element of POSSIBILITIES may be a list of strings.

Search PATTERN in STR and return /SUBEXP/th match.

If found, the content of subexp group SUBEXP (default 0) is returned, or else the original STR will be returned.

Return yas-text if that exists and is non-empty, else nil.

Define a snippet menu for MODE according to MENU, omitting 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 (be reordered) 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 omitted from MODE's menu, even if they're manually loaded.

This function does nothing if yas-use-menu is nil.

Define SNIPPETS for MODE.

SNIPPETS is a list of snippet definitions, each taking the following form

(KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV FILE KEYBINDING UUID)

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 yas–eval-lisp-ed.

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.

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.

/WARNING/: no doc for symbol yas-dropdown-prompt

/WARNING/: no doc for symbol yas-completing-prompt

/WARNING/: no doc for symbol yas-no-prompt

/WARNING/: no doc for symbol yas-ido-prompt

Display choices in a x-window prompt.

Non-nil if user is about to exit field.

Non-nil if field has been modified by user or transformation.

End position of the last snippet committed.

Beginning position of the last snippet committed.

If non-nil don't let yas-global-mode affect some buffers.

If a function of zero arguments, then its result is used.

If a list of functions, then all functions must return nil to activate yas for this buffer.

In Emacsen <= 23, this variable is buffer-local. Because yas-minor-mode-on is called by yas-global-mode after executing the buffer's major mode hook, setting this variable there is an effective way to define exceptions to the "global" activation behaviour.

In Emacsen > 23, only the global value is used. To define per-mode exceptions to the "global" activation behaviour, call yas-minor-mode with a negative argument directily in the major mode's hook.

Snippet expanding condition.

This variable is a Lisp form which is evaluated every time a snippet expansion is attempted:

• If it evaluates to nil, no snippets can be expanded.
• If it evaluates to the a cons (require-snippet-condition . REQUIREMENT)
  • Snippets bearing no "# condition:" directive are not considered
  • Snippets bearing conditions that evaluate to nil (or produce an error) won't be considered.
  • If the snippet has a condition that evaluates to non-nil RESULT:
    • If REQUIREMENT is t, the snippet is considered
    • If REQUIREMENT is eq RESULT, the snippet is considered
    • 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 conditions.

(add-hook 'python-mode-hook '(lambda () (setq yas-buffer-local-condition '(if (python-in-string/comment) '(require-snippet-condition . force-in-comment) t))))

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 force-in-comment.

Hooks to run just before expanding a snippet.

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/stacked snippet expansion!

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

foo-bar

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.

/WARNING/: no doc for symbol yas-extra-modes

Log level for yas–message 4 means trace most anything, 0 means nothing.

The active keymap while a snippet expansion is in progress.