;; Copyright (C) 2008-2012 Free Software Foundation, Inc.
;; Authors: pluskid <pluskid@gmail.com>, João Távora <joaotavora@gmail.com>
-;; Version: 0.7.0
-;; Package-version: 0.7.0
+;; Version: 0.8.0
+;; Package-version: 0.8.0
;; X-URL: http://github.com/capitaomorte/yasnippet
;; Keywords: convenience, emulation
;; URL: http://github.com/capitaomorte/yasnippet
;; EmacsWiki: YaSnippetMode
-;; This file is free software; you can redistribute it and/or modify
+;; This program 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.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
-;; This file is distributed in the hope that it will be useful,
+;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; 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.
+;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; (add-to-list 'load-path
;; "~/path-to-yasnippet")
;; (require 'yasnippet)
-;; (yas/global-mode 1)
+;; (yas-global-mode 1)
;;
;;
;; Interesting variables are:
;;
-;; `yas/snippet-dirs'
+;; `yas-snippet-dirs'
;;
;; The directory where user-created snippets are to be
-;; stored. Can also be a list of directories. In that case,
+;; 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
+;; 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'
+;; `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
+;; snippet-lookup based on major mode. It is a symbol (or
;; list of symbols) that correspond to subdirectories of
-;; `yas/snippet-dirs' and is used for deciding which
+;; `yas-snippet-dirs' and is used for deciding which
;; snippets to consider for the active buffer.
;;
;; Deprecated `yas/mode-symbol' aliases this variable for
;;
;; Major commands are:
;;
-;; M-x yas/expand
+;; 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.
+;; Try to expand snippets before point. In `yas-minor-mode',
+;; this is normally bound to TAB, but you can customize it in
+;; `yas-minor-mode-map'.
;;
-;; M-x yas/load-directory
+;; M-x yas-load-directory
;;
;; Prompts you for a directory hierarchy of snippets to load.
;;
-;; M-x yas/insert-snippet
+;; 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/visit-snippet-file
+;; M-x yas-visit-snippet-file
;;
;; Prompts you for possible snippet expansions like
-;; `yas/insert-snippet', but instead of expanding it, takes
+;; `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
+;; M-x yas-new-snippet
;;
;; Lets you create a new snippet file in the correct
-;; subdirectory of `yas/snippet-dirs', according to the
+;; subdirectory of `yas-snippet-dirs', according to the
;; active major mode.
;;
-;; M-x yas/load-snippet-buffer
+;; 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
+;; 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
+;; M-x yas-describe-tables
;;
-;; Lists known snippets in a separate buffer. User is
+;; 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
+;; can optionally use it the preferred "prompting method", putting in
;; your .emacs file, for example:
;;
;; (require 'dropdown-list)
-;; (setq yas/prompt-functions '(yas/dropdown-prompt
-;; yas/ido-prompt
-;; yas/completing-prompt))
+;; (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
+;; `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.
;;
(require 'easymenu)
(require 'help-mode)
+(eval-when-compile
+ (defvar yas--editing-template)
+ (defvar yas--guessed-modes)
+ (defvar yas--indent-original-column)
+ (defvar yas--scheduled-jit-loads)
+ (defvar yas-keymap)
+ (defvar yas-selected-text)
+ (defvar yas-verbosity))
+
\f
;;; User customizable variables
"Yet Another Snippet extension"
:group 'editing)
-(defvar yas/load-file-name load-file-name
+(defvar yas--load-file-name load-file-name
"Store the filename that yasnippet.el was originally loaded from.")
-(defcustom yas/snippet-dirs (remove nil
+
+(defcustom yas-snippet-dirs (remove nil
(list "~/.emacs.d/snippets"
- (when yas/load-file-name
- (concat (file-name-directory yas/load-file-name) "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
+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
+`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)"))
(let ((old (and (boundp symbol)
(symbol-value symbol))))
(set-default symbol new)
- (unless (or (not (fboundp 'yas/reload-all))
+ (unless (or (not (fboundp 'yas-reload-all))
(equal old new))
- (yas/reload-all)))))
-(defun yas/snippet-dirs ()
- "Returns `yas/snippet-dirs' (which see) as a list."
- (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
- yas/dropdown-prompt
- yas/completing-prompt
- yas/ido-prompt
- yas/no-prompt)
+ (yas-reload-all)))))
+
+(defun yas-snippet-dirs ()
+ "Returns `yas-snippet-dirs' (which see) as a list."
+ (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
+ yas-dropdown-prompt
+ yas-completing-prompt
+ yas-ido-prompt
+ yas-no-prompt)
"Functions to prompt for keys, templates, etc interactively.
These functions are called with the following arguments:
:type '(repeat function)
:group 'yasnippet)
-(defcustom yas/indent-line 'auto
+(defcustom yas-indent-line 'auto
"Controls indenting applied to a recent snippet expansion.
The following values are possible:
- `auto' Indent each line of the snippet with `indent-according-to-mode'
-Every other value means don't apply any snippet-side indendation
+Every other value means don't apply any snippet-side indentation
after expansion (the manual per-line \"$>\" indentation still
applies)."
:type '(choice (const :tag "Nothing" nothing)
(const :tag "Auto" auto))
:group 'yasnippet)
-(defcustom yas/also-auto-indent-first-line nil
+(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'"
+Naturally this is only valid when `yas-indent-line' is `auto'"
:type 'boolean
:group 'yasnippet)
-(defcustom yas/snippet-revival t
+(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)
- (yas/init-yas-in-snippet-keymap))))
-
+(defcustom yas-triggers-in-field nil
+ "If non-nil, allow stacked expansions (snippets inside snippets).
-(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)
- (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)
- (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
-field"
+Otherwise `yas-next-field-or-maybe-expand' just moves on to the
+next field"
:type 'boolean
:group 'yasnippet)
-(defcustom yas/fallback-behavior 'call-other-command
- "How to act when `yas/trigger-key' does *not* expand a snippet.
+(defcustom yas-fallback-behavior 'call-other-command
+ "How to act when `yas-expand' does *not* expand a snippet.
- `call-other-command' means try to temporarily disable YASnippet
- and call the next command bound to `yas/trigger-key'.
+ 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)
+ `yas-expand' returns nil)
-- A lisp form (apply COMMAND . ARGS) means interactively call
+- 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
+(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'."
+This affects `yas-insert-snippet' and `yas-visit-snippet-file'."
:type 'boolean
:group 'yasnippet)
-(defcustom yas/choose-tables-first nil
+(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'"
+This affects `yas-insert-snippet', `yas-visit-snippet-file'"
:type 'boolean
:group 'yasnippet)
-(defcustom yas/use-menu 'abbreviate
+(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.
+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."
- :type '(choice (const :tag "Full" t)
- (const :tag "Real modes only" real-modes)
- (const :tag "Abbreviate" abbreviate))
+ :type '(choice (const :tag "Full" full)
+ (const :tag "Abbreviate" abbreviate)
+ (const :tag "No menu" nil))
:group 'yasnippet)
-(defcustom yas/trigger-symbol " =>"
+(defcustom yas-trigger-symbol (if (eq window-system 'mac)
+ (char-to-string ?\x21E5) ;; little ->| sign
+ " =>")
"The text that will be used in menu to represent the trigger."
:type 'string
:group 'yasnippet)
-(defcustom yas/wrap-around-region nil
+(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."
+can be overridden on a per-snippet basis."
:type 'boolean
:group 'yasnippet)
-(defcustom yas/good-grace t
+(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
+(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."
+This can only work when snippets are loaded from files."
:type 'boolean
:group 'yasnippet)
-(defcustom yas/expand-only-for-last-commands nil
+(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
+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."
;; Only two faces, and one of them shouldn't even be used...
;;
-(defface yas/field-highlight-face
+(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
+(defface yas--field-debug-face
'()
"The face used for debugging some overlays normally hidden"
:group 'yasnippet)
\f
-;;; 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)))
- map)
- "The keymap active while a snippet expansion is in progress.")
-
-(defvar yas/key-syntaxes (list "w" "w_" "w_." "w_.()" "^ ")
+(defvar yas-keymap (let ((map (make-sparse-keymap)))
+ (define-key map [(tab)] 'yas-next-field-or-maybe-expand)
+ (define-key map (kbd "TAB") 'yas-next-field-or-maybe-expand)
+ (define-key map [(shift tab)] 'yas-prev-field)
+ (define-key map [backtab] 'yas-prev-field)
+ (define-key map (kbd "C-g") 'yas-abort-snippet)
+ (define-key map (kbd "C-d") 'yas-skip-and-clear-or-delete-char)
+ map)
+ "The active keymap 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_\")
+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
+syntax. Triggering after
foo-bar
-will, according to the \"w\" element first try \"bar\". If that
+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
+(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-beg' : The beginning of the region of the snippet.
-`yas/snippet-end' : Similar to beg.
+`yas-snippet-end' : Similar to beg.
-Attention: These hooks are not run when exiting nested/stackd snippet expansion!")
+Attention: These hooks are not run when exiting nested/stacked snippet expansion!")
-(defvar yas/before-expand-snippet-hook
+(defvar yas-before-expand-snippet-hook
'()
"Hooks to run just before expanding a snippet.")
-(defvar yas/buffer-local-condition
+(defvar yas-buffer-local-condition
'(if (and (or (fourth (syntax-ppss))
(fifth (syntax-ppss)))
- (eq (symbol-function this-command) 'yas/expand-from-trigger-key))
+ (eq (symbol-function this-command) 'yas-expand-from-trigger-key))
'(require-snippet-condition . force-in-comment)
t)
"Snippet expanding condition.
-This variable is a lisp form which is evaluated everytime a
-snippet expansion is attemped:
+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.
considered
* Snippets bearing conditions that evaluate to nil (or
- produce an error) won't be onsidered.
+ produce an error) won't be considered.
* If the snippet has a condition that evaluates to non-nil
RESULT:
(add-hook 'python-mode-hook
'(lambda ()
- (setq yas/buffer-local-condition
+ (setq yas-buffer-local-condition
'(if (python-in-string/comment)
'(require-snippet-condition . force-in-comment)
t))))
\f
;;; Internal variables
-(defvar yas/version "0.7.0 (beta)")
+(defvar yas--version "0.8.0 (beta)")
-(defvar yas/menu-table (make-hash-table)
+(defvar yas--menu-table (make-hash-table)
"A hash table of MAJOR-MODE symbols to menu keymaps.")
-(defvar yas/known-modes
+(defvar yas--known-modes
'(ruby-mode rst-mode markdown-mode)
- "A list of mode which is well known but not part of emacs.")
+ "A list of mode which is well known but not part of Emacs.")
-(defvar yas/escaped-characters
+(defvar yas--escaped-characters
'(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
"List of characters which *might* need to be escaped.")
-(defconst yas/field-regexp
+(defconst yas--field-regexp
"${\\([0-9]+:\\)?\\([^}]*\\)}"
"A regexp to *almost* recognize a field.")
-(defconst yas/multi-dollar-lisp-expression-regexp
+(defconst yas--multi-dollar-lisp-expression-regexp
"$+[ \t\n]*\\(([^)]*)\\)"
"A regexp to *almost* recognize a \"$(...)\" expression.")
-(defconst yas/backquote-lisp-expression-regexp
+(defconst yas--backquote-lisp-expression-regexp
"`\\([^`]*\\)`"
"A regexp to recognize a \"`lisp-expression`\" expression." )
-(defconst yas/transform-mirror-regexp
+(defconst yas--transform-mirror-regexp
"${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
"A regexp to *almost* recognize a mirror with a transform.")
-(defconst yas/simple-mirror-regexp
+(defconst yas--simple-mirror-regexp
"$\\([0-9]+\\)"
"A regexp to recognize a simple mirror.")
-(defvar yas/snippet-id-seed 0
+(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)
+(defun yas--snippet-next-id ()
+ (let ((id yas--snippet-id-seed))
+ (incf yas--snippet-id-seed)
id))
\f
;; 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")
+(defvar yas--minor-mode-menu nil
+ "Holds the YASnippet menu.")
-(defun yas/init-minor-keymap ()
+(defun yas--init-minor-keymap ()
+ "Set up the `yas-minor-mode' keymap."
(let ((map (make-sparse-keymap)))
- (easy-menu-define yas/minor-mode-menu
+ (when yas-use-menu
+ (easy-menu-define yas--minor-mode-menu
map
- "Menu used when YAS/minor-mode is active."
+ "Menu used when `yas-minor-mode' is active."
'("YASnippet"
"----"
- ["Expand trigger" yas/expand
+ ["Expand trigger" yas-expand
:help "Possibly expand tab trigger before point"]
- ["Insert at point..." yas/insert-snippet
+ ["Insert at point..." yas-insert-snippet
:help "Prompt for an expandable snippet and expand it at point"]
- ["New snippet..." yas/new-snippet
+ ["New snippet..." yas-new-snippet
:help "Create a new snippet in an appropriate directory"]
- ["Visit snippet file..." yas/visit-snippet-file
+ ["Visit snippet file..." yas-visit-snippet-file
:help "Prompt for an expandable snippet and find its file"]
"----"
("Snippet menu behaviour"
- ["Visit snippets" (setq yas/visit-from-menu t)
+ ["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)
+ :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)]
+ :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)
+ ["Show all known modes" (setq yas-use-menu 'full)
: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)
+ :active t :style radio :selected (eq yas-use-menu 'full)]
+ ["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)])
+ :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
("Indenting"
- ["Auto" (setq yas/indent-line 'auto)
+ ["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)
+ :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)
+ :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)))]
+ :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))
+ ["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]
+ :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
- yas/prompt-functions)))
+ ["System X-widget" (setq yas-prompt-functions
+ (cons 'yas-x-prompt
+ (remove 'yas-x-prompt
+ yas-prompt-functions)))
:help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
- :active t :style radio :selected (eq (car yas/prompt-functions)
- 'yas/x-prompt)]
- ["Dropdown-list" (setq yas/prompt-functions
- (cons 'yas/dropdown-prompt
- (remove 'yas/dropdown-prompt
- yas/prompt-functions)))
+ :active t :style radio :selected (eq (car yas-prompt-functions)
+ 'yas-x-prompt)]
+ ["Dropdown-list" (setq yas-prompt-functions
+ (cons 'yas-dropdown-prompt
+ (remove 'yas-dropdown-prompt
+ yas-prompt-functions)))
:help "Use a special dropdown list"
- :active t :style radio :selected (eq (car yas/prompt-functions)
- 'yas/dropdown-prompt)]
- ["Ido" (setq yas/prompt-functions
- (cons 'yas/ido-prompt
- (remove 'yas/ido-prompt
- yas/prompt-functions)))
+ :active t :style radio :selected (eq (car yas-prompt-functions)
+ 'yas-dropdown-prompt)]
+ ["Ido" (setq yas-prompt-functions
+ (cons 'yas-ido-prompt
+ (remove 'yas-ido-prompt
+ yas-prompt-functions)))
:help "Use an ido-style minibuffer prompt"
- :active t :style radio :selected (eq (car yas/prompt-functions)
- 'yas/ido-prompt)]
- ["Completing read" (setq yas/prompt-functions
- (cons 'yas/completing-prompt
- (remove 'yas/completing-prompt-prompt
- yas/prompt-functions)))
+ :active t :style radio :selected (eq (car yas-prompt-functions)
+ 'yas-ido-prompt)]
+ ["Completing read" (setq yas-prompt-functions
+ (cons 'yas-completing-prompt
+ (remove 'yas-completing-prompt
+ yas-prompt-functions)))
:help "Use a normal minibuffer prompt"
- :active t :style radio :selected (eq (car yas/prompt-functions)
- 'yas/completing-prompt-prompt)]
+ :active t :style radio :selected (eq (car yas-prompt-functions)
+ 'yas-completing-prompt)]
)
("Misc"
["Wrap region in exit marker"
- (setq yas/wrap-around-region
- (not yas/wrap-around-region))
+ (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]
+ :style toggle :selected yas-wrap-around-region]
["Allow stacked expansions "
- (setq yas/triggers-in-field
- (not yas/triggers-in-field))
+ (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]
+ :style toggle :selected yas-triggers-in-field]
["Revive snippets on undo "
- (setq yas/snippet-revival
- (not yas/snippet-revival))
+ (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]
+ :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]
+ (setq yas-good-grace
+ (not yas-good-grace))
+ :help "If non-nil don't raise errors in bad embedded elisp in snippets"
+ :style toggle :selected yas-good-grace]
)
"----"
- ["Load snippets..." yas/load-directory
+ ["Load snippets..." yas-load-directory
:help "Load snippets from a specific directory"]
- ["Reload everything" yas/reload-all
+ ["Reload everything" yas-reload-all
:help "Cleanup stuff, reload snippets, rebuild menus"]
- ["About" yas/about
- :help "Display some information about YASsnippet"]))
+ ["About" yas-about
+ :help "Display some information about YASnippet"])))
+
;; 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 [(tab)] 'yas-expand)
+ (define-key map (kbd "TAB") 'yas-expand)
+ (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)
map))
-(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'.
+(defvar yas-minor-mode-map (yas--init-minor-keymap)
+ "The keymap used when `yas-minor-mode' is active.")
-With optional UNBIND-KEY, try to unbind that key from
-`yas/minor-mode-map'."
- (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 mode symbols to `yas--table' objects.")
-(defvar yas/tables (make-hash-table)
- "A hash table of mode symbols to `yas/table' objects.")
-
-(defvar yas/parents (make-hash-table)
+(defvar yas--parents (make-hash-table)
"A hash table of mode symbols do lists of direct parent mode symbols.
This list is populated when reading the \".yas-parents\" files
found when traversing snippet directories with
-`yas/load-directory'.
+`yas-load-directory'.
-There might be additionalal parenting information stored in the
+There might be additional parenting information stored in the
`derived-mode-parent' property of some mode symbols, but that is
not recorded here.")
-(defvar yas/direct-keymaps (list)
+(defvar yas--direct-keymaps (list)
"Keymap alist supporting direct snippet keybindings.
-This variable is is placed in `emulation-mode-map-alists'.
+This variable is placed in `emulation-mode-map-alists'.
-Its elements looks like (TABLE-NAME . KEYMAP). They're
-instantiated on `yas/reload-all' but KEYMAP is added to only when
-loading snippets. `yas//direct-TABLE-NAME' is then a variable set
-buffer-locally when entering `yas/minor-mode'. KEYMAP binds all
+Its elements looks like (TABLE-NAME . KEYMAP). They're
+instantiated on `yas-reload-all' but KEYMAP is added to only when
+loading snippets. `yas--direct-TABLE-NAME' is then a variable set
+buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
defined direct keybindings to the command
-`yas/expand-from-keymap' which then which snippet to expand.")
+`yas-expand-from-keymap' which then which snippet to expand.")
-(defun yas/direct-keymaps-reload ()
+(defun yas-direct-keymaps-reload ()
"Force reload the direct keybinding for active snippet tables."
(interactive)
- (setq yas/direct-keymaps nil)
+ (setq yas--direct-keymaps nil)
(maphash #'(lambda (name table)
- (push (cons (intern (format "yas//direct-%s" name))
- (yas/table-direct-keymap table))
- yas/direct-keymaps))
- yas/tables))
+ (push (cons (intern (format "yas--direct-%s" name))
+ (yas--table-direct-keymap table))
+ yas--direct-keymaps))
+ yas--tables))
-(defun yas/modes-to-activate ()
- "Compute list of mode symbols that are active for `yas/expand'
+(defun yas--modes-to-activate ()
+ "Compute list of mode symbols that are active for `yas-expand'
and friends."
(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))
+ (dolist (mode (yas-extra-modes))
(push mode modes-to-activate))
(remove-duplicates
(append modes-to-activate
(mapcan #'(lambda (mode)
- (yas/all-parents mode))
+ (yas--all-parents mode))
modes-to-activate)))))
-(defvar yas/minor-mode-hook nil
- "Hook run when yas/minor-mode is turned on")
+(defvar yas-minor-mode-hook nil
+ "Hook run when `yas-minor-mode' is turned on.")
;;;###autoload
-(define-minor-mode yas/minor-mode
+(define-minor-mode yas-minor-mode
"Toggle YASnippet mode.
-When YASnippet mode is enabled, the `yas/trigger-key' key expands
-snippets of code depending on the mode.
+When YASnippet 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.
-You can customize the key through `yas/trigger-key'.
-
Key bindings:
-\\{yas/minor-mode-map}"
+\\{yas-minor-mode-map}"
nil
;; The indicator for the mode line.
" yas"
:group 'yasnippet
- (cond (yas/minor-mode
- ;; Reload the trigger key
- ;;
- (yas/trigger-key-reload)
+ (cond (yas-minor-mode
;; 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'.
+ ;; 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)
- ;; Set the `yas//direct-%s' vars for direct keymap expansion
+ (add-hook 'emulation-mode-map-alists 'yas--direct-keymaps)
+ (add-hook 'post-command-hook 'yas--post-command-handler nil t)
+ ;; Set the `yas--direct-%s' vars for direct keymap expansion
;;
- (dolist (mode (yas/modes-to-activate))
- (let ((name (intern (format "yas//direct-%s" mode))))
+ (dolist (mode (yas--modes-to-activate))
+ (let ((name (intern (format "yas--direct-%s" mode))))
(set-default name nil)
(set (make-local-variable name) t)))
;; Perform JIT loads
;;
- (yas/load-pending-jits))
+ (yas--load-pending-jits))
(t
;; 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))))
-
+ (remove-hook 'post-command-hook 'yas--post-command-handler t)
+ (remove-hook 'emulation-mode-map-alists 'yas--direct-keymaps))))
-(defvar yas/dont-activate '(minibufferp)
- "If non-nil don't let `yas/minor-mode-on' active yas for this buffer.
+(defvar yas--dont-activate '(minibufferp)
+ "If non-nil don't let `yas-minor-mode-on' active yas for this buffer.
If a function, then its result is used.
If a list of functions, then all functions must return nil to
activate yas for this buffer.
-`yas/minor-mode-on' is usually called by `yas/global-mode' so
+`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)
+(make-variable-buffer-local 'yas--dont-activate)
-(defun yas/minor-mode-on ()
+(defun yas-minor-mode-on ()
"Turn on YASnippet minor mode.
-Do this unless `yas/dont-activate' is truish "
+Do this unless `yas--dont-activate' is truish."
(interactive)
- (unless (cond ((functionp yas/dont-activate)
- (funcall yas/dont-activate))
- ((consp yas/dont-activate)
- (some #'funcall yas/dont-activate))
- (yas/dont-activate))
+ (unless (cond ((functionp yas--dont-activate)
+ (funcall yas--dont-activate))
+ ((consp yas--dont-activate)
+ (some #'funcall yas--dont-activate))
+ (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)))
+ (yas-minor-mode 1)))
;;;###autoload
-(define-globalized-minor-mode yas/global-mode yas/minor-mode yas/minor-mode-on
+(define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
:group 'yasnippet
:require 'yasnippet)
-(defadvice yas/global-mode (before yas/reload-with-jit (arg) activate)
- (cond ((and arg
- (numberp arg)
- (> arg 1))
- ;; explicitly enabling
- (yas/reload-all))
- ((not yas/global-mode)
- ;; toggling
- (yas/reload-all))))
+(defun yas--global-mode-reload-with-jit-maybe ()
+ "Run `yas-reload-all' when `yas-global-mode' is on."
+ (when yas-global-mode (yas-reload-all)))
+
+(add-hook 'yas-global-mode-hook 'yas--global-mode-reload-with-jit-maybe)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Major mode stuff
;;
-(defvar yas/font-lock-keywords
+(defvar yas--font-lock-keywords
(append '(("^#.*$" . font-lock-comment-face))
lisp-font-lock-keywords
lisp-font-lock-keywords-1
("}"
(0 font-lock-keyword-face)))))
-(defun yas/init-major-keymap ()
+(defun yas--init-major-keymap ()
+ "Setup YASnippet major-mode keymap."
(let ((map (make-sparse-keymap)))
(easy-menu-define nil
map
(define-key map (third ent) (second ent)))
(vector (first ent) (second ent) t))
(list
- (list "Load this snippet" 'yas/load-snippet-buffer "\C-c\C-c")
- (list "Try out this snippet" 'yas/tryout-snippet "\C-c\C-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")))))
map))
(defvar snippet-mode-map
- (yas/init-major-keymap)
- "The keymap used when `snippet-mode' is active")
+ (yas--init-major-keymap)
+ "The keymap used when `snippet-mode' is active.")
(define-derived-mode snippet-mode text-mode "Snippet"
"A mode for editing yasnippets"
- (setq font-lock-defaults '(yas/font-lock-keywords))
+ (setq font-lock-defaults '(yas--font-lock-keywords))
(set (make-local-variable 'require-final-newline) nil)
(set (make-local-variable 'comment-start) "#")
(set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
\f
;;; Internal structs for template management
-(defstruct (yas/template (:constructor yas/make-blank-template))
+(defstruct (yas--template (:constructor yas--make-blank-template))
"A template for a snippet."
key
content
uuid
menu-binding-pair
group ;; as dictated by the #group: directive or .yas-make-groups
- perm-group ;; as dictated by `yas/define-menu'
+ perm-group ;; as dictated by `yas-define-menu'
table
)
-(defun yas/populate-template (template &rest args)
- "Helper function to populate a template with properties"
+(defun yas--populate-template (template &rest args)
+ "Helper function to populate 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)))
+ (mapcar #'car (get 'yas--template 'cl-struct-slots)))
(second args))
(setq args (cddr args)))
template))
-(defstruct (yas/table (:constructor yas/make-snippet-table (name)))
+(defstruct (yas--table (:constructor yas--make-snippet-table (name)))
"A table to store snippets for a particular mode.
Has the following fields:
-`yas/table-name'
+`yas--table-name'
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.
+ `yas-extra-modes', for example.
-`yas/table-hash'
+`yas--table-hash'
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.
+ name and TEMPLATE is a `yas--template' object.
-`yas/table-direct-keymap'
+`yas--table-direct-keymap'
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'.
+ bindings to `yas-expand-from-keymap'.
-`yas/table-uuidhash'
+`yas--table-uuidhash'
- A hash table mapping snippets uuid's to the same `yas/template'
+ A hash table mapping snippets uuid's to the same `yas--template'
objects. A snippet uuid defaults to the snippet's name.
"
name
(parents nil)
(direct-keymap (make-sparse-keymap)))
-(defun yas/get-template-by-uuid (mode uuid)
+(defun yas--get-template-by-uuid (mode uuid)
"Find the snippet template in MODE by its UUID."
- (let* ((table (gethash mode yas/tables mode)))
+ (let* ((table (gethash mode yas--tables mode)))
(when table
- (gethash uuid (yas/table-uuidhash table)))))
+ (gethash uuid (yas--table-uuidhash table)))))
;; Apropos storing/updating in TABLE, this works in two steps:
;;
-;; 1. `yas/remove-template-by-uuid' removes any
-;; keyhash-namehash-template mappings from TABLE, grabing the
+;; 1. `yas--remove-template-by-uuid' removes any
+;; keyhash-namehash-template mappings from TABLE, grabbing the
;; snippet by its uuid. Also removes mappings from TABLE's
-;; `yas/table-direct-keymap' (FIXME: and should probably take care
+;; `yas--table-direct-keymap' (FIXME: and should probably take care
;; of potentially stale menu bindings right?.)
;;
-;; 2. `yas/add-template' adds this all over again.
+;; 2. `yas--add-template' adds this all over again.
;;
;; Create a new or add to an existing keyhash-namehash mapping.
;;
;; D: # name: Baz
;; # key: baz
;;
-;; keyhash namehashes(3) yas/template structs(4)
+;; keyhash namehashes(3) yas--template structs(4)
;; -----------------------------------------------------
;; __________
;; / \
-;; "foo" ---> "The Foo" ---> [yas/template A] |
-;; "Mrs Foo" ---> [yas/template B] |
+;; "foo" ---> "The Foo" ---> [yas--template A] |
+;; "Mrs Foo" ---> [yas--template B] |
;; |
;; [C-c M-l] ---> "The Foo" -------------------------/
-;; "The Bar" ---> [yas/template C]
+;; "The Bar" ---> [yas--template C]
;;
-;; "baz" ---> "Baz" ---> [yas/template D]
+;; "baz" ---> "Baz" ---> [yas--template D]
;;
;; Additionally, since uuid defaults to the name, we have a
-;; `yas/table-uuidhash' for TABLE
+;; `yas--table-uuidhash' for TABLE
;;
-;; uuidhash yas/template structs
+;; uuidhash yas--template structs
;; -------------------------------
-;; "The Foo" ---> [yas/template A]
-;; "Mrs Foo" ---> [yas/template B]
-;; "The Bar" ---> [yas/template C]
-;; "Baz" ---> [yas/template D]
+;; "The Foo" ---> [yas--template A]
+;; "Mrs Foo" ---> [yas--template B]
+;; "The Bar" ---> [yas--template C]
+;; "Baz" ---> [yas--template D]
;;
;; FIXME: the more I look at this data-structure the more I think I'm
-;; stupid. There has to be an easier way (but beware lots of code depends on this).
+;; stupid. There has to be an easier way (but beware lots of code
+;; depends on this).
;;
-(defun yas/remove-template-by-uuid (table uuid)
+(defun yas--remove-template-by-uuid (table uuid)
"Remove from TABLE a template identified by UUID."
- (let ((template (gethash uuid (yas/table-uuidhash table))))
+ (let ((template (gethash uuid (yas--table-uuidhash table))))
(when template
- (let* ((name (yas/template-name 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)))
+ (eq uuid (yas--template-uuid template)))
(remhash name v)
(when (zerop (hash-table-count v))
(push k empty-keys)))))
- (yas/table-hash table))
+ (yas--table-hash table))
;; Remove the namehash themselves if they've become empty
;;
(dolist (key empty-keys)
(when (vectorp key)
- (define-key (yas/table-direct-keymap table) key nil))
- (remhash key (yas/table-hash table)))
+ (define-key (yas--table-direct-keymap table) key nil))
+ (remhash key (yas--table-hash table)))
;; Finally, remove the uuid from the uuidhash
;;
- (remhash uuid (yas/table-uuidhash table))))))
+ (remhash uuid (yas--table-uuidhash table))))))
-(defun yas/add-template (table template)
+(defun yas--add-template (table template)
"Store in TABLE the snippet template TEMPLATE.
KEY can be a string (trigger key) of a vector (direct
keybinding)."
- (let ((name (yas/template-name template))
- (key (yas/template-key template))
- (keybinding (yas/template-keybinding template))
- (menu-binding-pair (yas/snippet-menu-binding-pair-get-create template)))
+ (let ((name (yas--template-name template))
+ (key (yas--template-key template))
+ (keybinding (yas--template-keybinding template))
+ (menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
(dolist (k (remove nil (list key keybinding)))
(puthash name
template
(or (gethash k
- (yas/table-hash table))
+ (yas--table-hash table))
(puthash k
(make-hash-table :test 'equal)
- (yas/table-hash table))))
+ (yas--table-hash table))))
(when (vectorp k)
- (define-key (yas/table-direct-keymap table) k 'yas/expand-from-keymap)))
+ (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
- ;; Update trigger & keybinding in the menu-binding pair
- ;;
- (unless (eq (cdr menu-binding-pair) :none)
- (setf (getf (cdr (car menu-binding-pair)) :keys)
- (or (and keybinding (key-description keybinding))
- (and key (concat key yas/trigger-symbol)))))
-
- (puthash (yas/template-uuid template) template (yas/table-uuidhash table))))
+ ;; Update TABLE's `yas--table-uuidhash'
+ (puthash (yas--template-uuid template)
+ template
+ (yas--table-uuidhash table))))
-(defun yas/update-template (table template)
+(defun yas--update-template (table template)
"Add or update TEMPLATE in TABLE.
Also takes care of adding and updating to the associated menu."
;; Remove from table by uuid
;;
- (yas/remove-template-by-uuid table (yas/template-uuid template))
+ (yas--remove-template-by-uuid table (yas--template-uuid template))
;; Add to table again
;;
- (yas/add-template table template)
+ (yas--add-template table template)
;; Take care of the menu
;;
- (let ((keymap (yas/menu-keymap-get-create table))
- (group (yas/template-group template)))
- (when (and yas/use-menu
- keymap
- (not (cdr (yas/template-menu-binding-pair template))))
+ (when yas-use-menu
+ (yas--update-template-menu table template)))
+
+(defun yas--update-template-menu (table template)
+ "Update every menu-related for TEMPLATE."
+ (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
+ (key (yas--template-key template))
+ (keybinding (yas--template-keybinding template)))
+ ;; The snippet might have changed name or keys, so update
+ ;; user-visible strings
+ ;;
+ (unless (eq (cdr menu-binding-pair) :none)
+ ;; the menu item name
+ ;;
+ (setf (cadar menu-binding-pair) (yas--template-name template))
+ ;; the :keys information (also visible to the user)
+ (setf (getf (cdr (car menu-binding-pair)) :keys)
+ (or (and keybinding (key-description keybinding))
+ (and key (concat key yas-trigger-symbol))))))
+ (unless (yas--template-menu-managed-by-yas-define-menu template)
+ (let ((menu-keymap
+ (yas--menu-keymap-get-create (yas--table-mode table)
+ (mapcar #'yas--table-mode
+ (yas--table-parents table))))
+ (group (yas--template-group template)))
;; Remove from menu keymap
;;
- (yas/delete-from-keymap keymap (yas/template-uuid template))
+ (assert menu-keymap)
+ (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
;; Add necessary subgroups as necessary.
;;
(dolist (subgroup group)
- (let ((subgroup-keymap (lookup-key keymap (vector (make-symbol subgroup)))))
+ (let ((subgroup-keymap (lookup-key menu-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))
+ (define-key menu-keymap (vector (make-symbol subgroup))
`(menu-item ,subgroup ,subgroup-keymap)))
- (setq keymap subgroup-keymap)))
+ (setq menu-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))))))
+ (define-key menu-keymap
+ (vector (make-symbol (yas--template-uuid template)))
+ (car (yas--template-menu-binding-pair template))))))
-(defun yas/namehash-templates-alist (namehash)
+(defun yas--namehash-templates-alist (namehash)
+ "Return NAMEHASH as an alist."
(let (alist)
(maphash #'(lambda (k v)
(push (cons k v) alist))
namehash)
alist))
-(defun yas/fetch (table key)
+(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))
+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)))))
+ (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
\f
;;; Filtering/condition logic
-(defun yas/eval-condition (condition)
+(defun yas--eval-condition (condition)
(condition-case err
(save-excursion
(save-restriction
(save-match-data
(eval condition))))
(error (progn
- (yas/message 1 "Error in condition evaluation: %s" (error-message-string err))
+ (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
nil))))
-(defun yas/filter-templates-by-condition (templates)
+(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.
+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)))
+`yas-buffer-local-condition'. See that variables documentation."
+ (let ((requirement (yas--require-template-specific-condition-p)))
(if (eq requirement 'always)
templates
(remove-if-not #'(lambda (pair)
- (yas/template-can-expand-p
- (yas/template-condition (cdr pair)) requirement))
+ (yas--template-can-expand-p
+ (yas--template-condition (cdr pair)) requirement))
templates))))
-(defun yas/require-template-specific-condition-p ()
+(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)
+ (if (eq 'always yas-buffer-local-condition)
'always
- (let ((local-condition (or (and (consp yas/buffer-local-condition)
- (yas/eval-condition yas/buffer-local-condition))
- yas/buffer-local-condition)))
+ (let ((local-condition (or (and (consp yas-buffer-local-condition)
+ (yas--eval-condition yas-buffer-local-condition))
+ yas-buffer-local-condition)))
(when local-condition
(if (eq local-condition t)
t
(symbolp (cdr local-condition))
(cdr local-condition)))))))
-(defun yas/template-can-expand-p (condition requirement)
- "Evaluates CONDITION and REQUIREMENT and returns a boolean"
+(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))))
+ (yas--eval-condition condition))))
(cond ((eq requirement t)
result)
(t
(eq requirement result)))))
-(defun yas/all-parents (mode)
- "Returns a list of all parent modes of MODE"
- (let ((parents (gethash mode yas/parents)))
+(defun yas--all-parents (mode)
+ "Returns a list of all parent modes of MODE."
+ (let ((parents (gethash mode yas--parents)))
(append parents
- (mapcan #'yas/all-parents parents))))
+ (mapcan #'yas--all-parents parents))))
-(defun yas/table-templates (table)
+(defun yas--table-templates (table)
(when table
(let ((acc (list)))
(maphash #'(lambda (key namehash)
(maphash #'(lambda (name template)
(push (cons name template) acc))
namehash))
- (yas/table-hash table))
- (yas/filter-templates-by-condition acc))))
+ (yas--table-hash table))
+ (yas--filter-templates-by-condition acc))))
-(defun yas/current-key ()
+(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)
+ (syntaxes yas-key-syntaxes)
syntax
done
templates)
(setq start (point)))
(setq templates
(mapcan #'(lambda (table)
- (yas/fetch table (buffer-substring-no-properties start end)))
- (yas/get-snippet-tables)))
+ (yas--fetch table (buffer-substring-no-properties start end)))
+ (yas--get-snippet-tables)))
(if templates
(setq done t)
(setq start end)))
end)))
-(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))
- acc)))
+(defun yas--table-all-keys (table)
+ "Get trigger keys of all active snippets in 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))
+ acc))
+
+(defun yas--table-mode (table)
+ (intern (yas--table-name table)))
\f
-;;; 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."
+;;; 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 judgment."
(or (fboundp mode)
- (find mode yas/known-modes)))
+ (find mode yas--known-modes)))
-(defun yas/eval-lisp (form)
+(defun yas--eval-lisp (form)
"Evaluate FORM and convert the result to string."
- (let ((retval (catch 'yas/exception
+ (let ((retval (catch 'yas--exception
(condition-case err
(save-excursion
(save-restriction
(let ((result (eval form)))
(when result
(format "%s" result))))))
- (error (if yas/good-grace
- (yas/format "elisp error! %s" (error-message-string err))
- (error (yas/format "elisp error: %s"
+ (error (if yas-good-grace
+ (yas--format "elisp error! %s" (error-message-string err))
+ (error (yas--format "elisp error: %s"
(error-message-string err)))))))))
(when (and (consp retval)
- (eq 'yas/exception (car retval)))
+ (eq 'yas--exception (car retval)))
(error (cdr retval)))
retval))
-(defun yas/eval-lisp-no-saves (form)
+(defun yas--eval-lisp-no-saves (form)
(condition-case err
(eval form)
- (error (if yas/good-grace
- (yas/format "elisp error! %s" (error-message-string err))
- (error (yas/format "elisp error: %s"
+ (error (if yas-good-grace
+ (yas--format "elisp error! %s" (error-message-string err))
+ (error (yas--format "elisp error: %s"
(error-message-string err)))))))
-(defun yas/read-lisp (string &optional nil-on-error)
+(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,
(error (and (not nil-on-error)
`(error (error-message-string ,err))))))
-(defun yas/read-keybinding (keybinding)
+(defun yas--read-keybinding (keybinding)
"Read KEYBINDING as a snippet keybinding, return a vector."
(when (and keybinding
(not (string-match "keybinding" keybinding)))
(read-kbd-macro keybinding 'need-vector))))
res)
(error
- (yas/message 3 "warning: keybinding \"%s\" invalid since %s."
+ (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
keybinding (error-message-string err))
nil))))
-(defvar yas/extra-modes nil
+(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-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)
+(defun yas--table-get-create (mode)
"Get or create the snippet table corresponding to MODE."
(let ((table (gethash mode
- yas/tables)))
+ yas--tables)))
(unless table
- (setq table (yas/make-snippet-table (symbol-name mode)))
- (puthash mode table yas/tables)
- (push (cons (intern (format "yas//direct-%s" mode))
- (yas/table-direct-keymap table))
- yas/direct-keymaps))
+ (setq table (yas--make-snippet-table (symbol-name mode)))
+ (puthash mode table yas--tables)
+ (push (cons (intern (format "yas--direct-%s" mode))
+ (yas--table-direct-keymap table))
+ yas--direct-keymaps))
table))
-(defun yas/get-snippet-tables ()
+(defun yas--get-snippet-tables ()
"Get snippet tables for current buffer.
-Return a list of `yas/table' objects. The list of modes to
-consider is returned by `yas/modes-to-activate'"
+Return a list of `yas--table' objects. The list of modes to
+consider is returned by `yas--modes-to-activate'"
(remove nil
(mapcar #'(lambda (mode-name)
- (gethash mode-name yas/tables))
- (yas/modes-to-activate))))
+ (gethash mode-name yas--tables))
+ (yas--modes-to-activate))))
-(defun yas/menu-keymap-get-create (table)
- "Get or create the main menu keymap correspondong to MODE.
+(defun yas--menu-keymap-get-create (mode &optional parents)
+ "Get or create the menu keymap for MODE and its PARENTS.
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)
+them all in `yas--menu-table'"
+ (let* ((menu-keymap (or (gethash mode yas--menu-table)
+ (puthash mode (make-sparse-keymap) yas--menu-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)))
+ :visible (yas--show-menu-p ',mode)))
menu-keymap))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Template-related and snippet loading functions
-(defun yas/parse-template (&optional file)
+(defun yas--parse-template (&optional file)
"Parse the template in the current buffer.
Optional FILE is the absolute file name of the file being
bound
condition
(group (and file
- (yas/calculate-group file)))
+ (yas--calculate-group file)))
expand-env
binding
uuid)
(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))))
+ (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)
+ (setq expand-env (yas--read-lisp (match-string-no-properties 2)
'nil-on-error)))
(when (string= "binding" (match-string-no-properties 1))
(setq binding (match-string-no-properties 2)))))
(unless (or key binding)
(setq key (and file (file-name-nondirectory file))))
(when (eq type 'command)
- (setq template (yas/read-lisp (concat "(progn" template ")"))))
+ (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)
+(defun yas--calculate-group (file)
"Calculate the group for snippet file path FILE."
(let* ((dominating-dir (locate-dominating-file file
".yas-make-groups"))
(directory-file-name extra-dir)))))
group))
-(defun yas/subdirs (directory &optional filep)
+(defun yas--subdirs (directory &optional filep)
"Return subdirs or files of DIRECTORY according to FILEP."
(remove-if (lambda (file)
(or (string-match "^\\."
(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)
+(defun yas--make-menu-binding (template)
+ (let ((mode (yas--table-mode (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)
+ (yas-expand-snippet (yas--template-content yas--current-template)
(car where)
(cdr where)
- (yas/template-expand-env yas/current-template)))))))
+ (yas--template-expand-env yas--current-template)))))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Popping up for keys and templates
;;
-(defvar yas/x-pretty-prompt-templates nil
+(defvar yas--x-pretty-prompt-templates nil
"If non-nil, attempt to prompt for templates like TextMate.")
-(defun yas/prompt-for-template (templates &optional prompt)
+(defun yas--prompt-for-template (templates &optional prompt)
"Interactively choose a template from the list TEMPLATES.
-TEMPLATES is a list of `yas/template'."
+TEMPLATES is a list of `yas--template'.
+
+Optional PROMPT sets the prompt to use."
(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)
+ (< (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: ")
templates
- #'yas/template-name))
- yas/prompt-functions))))
+ #'yas--template-name))
+ yas-prompt-functions))))
+
+(defun yas--prompt-for-keys (keys &optional prompt)
+ "Interactively choose a template key from the list KEYS.
-(defun yas/prompt-for-keys (keys &optional prompt)
- "Interactively choose a template key from the list KEYS."
+Optional PROMPT sets the prompt to use."
(when keys
(some #'(lambda (fn)
(funcall fn (or prompt "Choose a snippet key: ") keys))
- yas/prompt-functions)))
+ yas-prompt-functions)))
-(defun yas/prompt-for-table (tables &optional prompt)
+(defun yas--prompt-for-table (tables &optional prompt)
+ "Interactively choose a table from the list TABLES.
+
+Optional PROMPT sets the prompt to use."
(when tables
(some #'(lambda (fn)
(funcall fn (or prompt "Choose a snippet table: ")
tables
- #'yas/table-name))
- yas/prompt-functions)))
+ #'yas--table-name))
+ yas-prompt-functions)))
-(defun yas/x-prompt (prompt choices &optional display-fn)
+(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'
+ ;; 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.
+ ;; structured tree rather than a list. Modifications would go as far
+ ;; up as `yas--all-templates' I think.
;;
(when (and window-system choices)
(let ((chosen
(or chosen
(keyboard-quit)))))
-(defun yas/x-pretty-prompt-templates (prompt templates)
+(defun yas--x-pretty-prompt-templates (prompt templates)
"Display TEMPLATES, grouping neatly by table name."
(let ((organized (make-hash-table :test #'equal))
menu
more-than-one-table
prefix)
(dolist (tl templates)
- (puthash (yas/template-table tl)
+ (puthash (yas--template-table tl)
(cons tl
- (gethash (yas/template-table tl) organized))
+ (gethash (yas--template-table tl) organized))
organized))
(setq more-than-one-table (> (hash-table-count organized) 1))
(setq prefix (if more-than-one-table
" " ""))
(if more-than-one-table
(maphash #'(lambda (table templates)
- (push (yas/table-name table) menu)
+ (push (yas--table-name table) menu)
(dolist (tl templates)
- (push (cons (concat prefix (yas/template-name tl)) tl) menu))) organized)
- (setq menu (mapcar #'(lambda (tl) (cons (concat prefix (yas/template-name tl)) tl)) templates)))
+ (push (cons (concat prefix (yas--template-name tl)) tl) menu))) organized)
+ (setq menu (mapcar #'(lambda (tl) (cons (concat prefix (yas--template-name tl)) tl)) templates)))
(setq menu (nreverse menu))
(or (x-popup-menu (if (fboundp 'posn-at-point)
(list prompt (push "title" menu)))
(keyboard-quit))))
-(defun yas/ido-prompt (prompt choices &optional display-fn)
- (when (fboundp 'ido-completing-read)
- (yas/completing-prompt prompt choices display-fn #'ido-completing-read)))
+(defun yas-ido-prompt (prompt choices &optional display-fn)
+ (when (and (fboundp 'ido-completing-read)
+ (or (>= emacs-major-version 24)
+ ido-mode))
+ (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)
+(defun yas-dropdown-prompt (prompt choices &optional display-fn)
(when (featurep 'dropdown-list)
(let (formatted-choices
filtered-choices
(nth n filtered-choices)
(keyboard-quit)))))
-(defun yas/completing-prompt (prompt choices &optional display-fn completion-fn)
+(defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
(let (formatted-choices
filtered-choices
chosen
0)))
(nth position filtered-choices))))
-(defun yas/no-prompt (prompt choices &optional display-fn)
+(defun yas-no-prompt (prompt choices &optional display-fn)
(first choices))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Loading snippets from files
;;
-(defun yas/load-yas-setup-file (file)
+(defun yas--load-yas-setup-file (file)
(load file 'noerror))
-(defun yas/load-directory (top-level-dir &optional use-jit)
+(defun yas-load-directory (top-level-dir &optional use-jit)
"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."
(interactive "DSelect the root directory: ")
- (unless yas/snippet-dirs
- (setq yas/snippet-dirs top-level-dir))
- (dolist (dir (yas/subdirs top-level-dir))
- (let* ((major-mode-and-parents (yas/compute-major-mode-and-parents
+ (unless yas-snippet-dirs
+ (setq yas-snippet-dirs top-level-dir))
+ (dolist (dir (yas--subdirs top-level-dir))
+ (let* ((major-mode-and-parents (yas--compute-major-mode-and-parents
(concat dir "/dummy")))
(mode-sym (car major-mode-and-parents))
(parents (cdr major-mode-and-parents)))
- (yas/define-parents mode-sym parents)
- (let ((form `(yas/load-directory-1 ,dir
+ ;; Attention: The parents and the menus are already defined
+ ;; here, even if the snippets are later jit-loaded.
+ ;;
+ ;; * We need to know the parents at this point since entering a
+ ;; given mode should jit load for its parents
+ ;; immediately. This could be reviewed, the parents could be
+ ;; discovered just-in-time-as well
+ ;;
+ ;; * We need to create the menus here to support the `full'
+ ;; option to `yas-use-menu' (all known snippet menus are shown to the user)
+ ;;
+ (yas--define-parents mode-sym parents)
+ (yas--menu-keymap-get-create mode-sym)
+ (let ((form `(yas--load-directory-1 ,dir
',mode-sym
',parents)))
(if use-jit
- (yas/schedule-jit mode-sym form)
+ (yas--schedule-jit mode-sym form)
(eval form)))))
(when (interactive-p)
- (yas/message 3 "Loaded snippets from %s." top-level-dir)))
+ (yas--message 3 "Loaded snippets from %s." top-level-dir)))
-(defun yas/load-directory-1 (directory mode-sym parents &optional no-compiled-snippets)
+(defun yas--load-directory-1 (directory mode-sym parents &optional no-compiled-snippets)
"Recursively load snippet templates from DIRECTORY."
(unless (file-exists-p (concat directory "/" ".yas-skip"))
(if (and (not no-compiled-snippets)
- (progn (yas/message 2 "Loading compiled snippets from %s" directory) t)
- (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas/verbosity 3)))
- (yas/message 2 "Loading snippet files from %s" directory)
- (yas/load-directory-2 directory mode-sym))))
+ (progn (yas--message 2 "Loading compiled snippets from %s" directory) t)
+ (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3)))
+ (yas--message 2 "Loading snippet files from %s" directory)
+ (yas--load-directory-2 directory mode-sym))))
-(defun yas/load-directory-2 (directory mode-sym)
+(defun yas--load-directory-2 (directory mode-sym)
;; Load .yas-setup.el files wherever we find them
;;
- (yas/load-yas-setup-file (expand-file-name ".yas-setup" directory))
+ (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
(let* ((default-directory directory)
(snippet-defs nil))
;; load the snippet files
;;
(with-temp-buffer
- (dolist (file (yas/subdirs directory 'no-subdirs-just-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)
+ (push (yas--parse-template file)
snippet-defs))))
(when snippet-defs
- (yas/define-snippets mode-sym
+ (yas-define-snippets mode-sym
snippet-defs))
;; now recurse to a lower level
;;
- (dolist (subdir (yas/subdirs directory))
- (yas/load-directory-2 subdir
+ (dolist (subdir (yas--subdirs directory))
+ (yas--load-directory-2 subdir
mode-sym))))
-(defun yas/load-snippet-dirs (&optional nojit)
- "Reload the directories listed in `yas/snippet-dirs' or
- prompt the user to select one."
+(defun yas--load-snippet-dirs (&optional nojit)
+ "Reload the directories listed in `yas-snippet-dirs' or
+prompt the user to select one."
(let (errors)
- (if yas/snippet-dirs
- (dolist (directory (reverse (yas/snippet-dirs)))
+ (if yas-snippet-dirs
+ (dolist (directory (reverse (yas-snippet-dirs)))
(cond ((file-directory-p directory)
- (yas/load-directory directory (not nojit))
+ (yas-load-directory directory (not nojit))
(if nojit
- (yas/message 3 "Loaded %s" directory)
- (yas/message 3 "Prepared just-in-time loading for %s" directory)))
+ (yas--message 3 "Loaded %s" directory)
+ (yas--message 3 "Prepared just-in-time loading for %s" directory)))
(t
- (push (yas/message 0 "Check your `yas/snippet-dirs': %s is not a directory" directory) errors))))
- (call-interactively 'yas/load-directory))
+ (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors))))
+ (call-interactively 'yas-load-directory))
errors))
-(defun yas/reload-all (&optional interactive)
+(defun yas-reload-all (&optional interactive)
"Reload all snippets and rebuild the YASnippet menu.
When called interactively force immediate reload of all known
-snippets under `yas/snippet-dirs', otherwise use just-in-time
+snippets under `yas-snippet-dirs', otherwise use just-in-time
loading."
(interactive "p")
(catch 'abort
(let ((errors)
(snippet-editing-buffers
(remove-if-not #'(lambda (buffer)
- (with-current-buffer buffer yas/editing-template))
+ (with-current-buffer buffer yas--editing-template))
(buffer-list))))
;; Warn if there are buffers visiting snippets, since reloading will break
;; any on-line editing of those buffers.
;;
(when snippet-editing-buffers
(if interactive
- (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload?")
+ (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
(mapc #'kill-buffer snippet-editing-buffers)
- (yas/message 1 "Aborted reload...")
+ (yas--message 1 "Aborted reload...")
(throw 'abort nil))
;; in a non-interactive use, at least set
- ;; `yas/editing-template' to nil, make it guess it next time around
- (mapc #'(lambda (buffer) (setq yas/editing-template nil)) (buffer-list))))
+ ;; `yas--editing-template' to nil, make it guess it next time around
+ (mapc #'(lambda (buffer) (setq yas--editing-template nil)) (buffer-list))))
;; Empty all snippet tables, parenting info and all menu tables
;;
- (setq yas/tables (make-hash-table))
- (setq yas/parents (make-hash-table))
- (setq yas/menu-table (make-hash-table))
+ (setq yas--tables (make-hash-table))
+ (setq yas--parents (make-hash-table))
+ (setq yas--menu-table (make-hash-table))
- ;; Cancel all pending 'yas/scheduled-jit-loads'
+ ;; Cancel all pending 'yas--scheduled-jit-loads'
;;
- (setq yas/scheduled-jit-loads (make-hash-table))
+ (setq yas--scheduled-jit-loads (make-hash-table))
- ;; Init the `yas/minor-mode-map', taking care not to break the
+ ;; Init the `yas-minor-mode-map', taking care not to break the
;; menu....
;;
- (setf (cdr yas/minor-mode-map)
- (cdr (yas/init-minor-keymap)))
+ (setcdr yas-minor-mode-map (cdr (yas--init-minor-keymap)))
- ;; Reload the directories listed in `yas/snippet-dirs' or prompt
+ ;; Reload the directories listed in `yas-snippet-dirs' or prompt
;; the user to select one.
;;
- (setq errors (yas/load-snippet-dirs interactive))
+ (setq errors (yas--load-snippet-dirs interactive))
;; Reload the direct keybindings
;;
- (yas/direct-keymaps-reload)
- ;; Reload the trigger-key (shoudn't be needed, but see issue #237)
- ;;
- (yas/trigger-key-reload)
+ (yas-direct-keymaps-reload)
- (yas/message 3 "Reloaded everything%s...%s."
+ (yas--message 3 "Reloaded everything%s...%s."
(if interactive "" " (snippets will load just-in-time)")
(if errors " (some errors, check *Messages*)" "")))))
-(defun yas/load-pending-jits ()
- (when yas/minor-mode
- (dolist (mode (yas/modes-to-activate))
- (let ((forms (gethash mode yas/scheduled-jit-loads)))
+(defun yas--load-pending-jits ()
+ (when yas-minor-mode
+ (dolist (mode (yas--modes-to-activate))
+ (let ((forms (reverse (gethash mode yas--scheduled-jit-loads))))
+ ;; must reverse to maintain coherence with `yas-snippet-dirs'
(dolist (form forms)
- (yas/message 3 "Loading for `%s', just-in-time: %s!" mode form)
+ (yas--message 3 "Loading for `%s', just-in-time: %s!" mode form)
(eval form))
- (remhash mode yas/scheduled-jit-loads)))))
+ (remhash mode yas--scheduled-jit-loads)))))
;; (when (<= emacs-major-version 22)
-;; (add-hook 'after-change-major-mode-hook 'yas/load-pending-jits))
+;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
-(defun yas/quote-string (string)
+(defun yas--quote-string (string)
"Escape and quote STRING.
foo\"bar\\! -> \"foo\\\"bar\\\\!\""
(concat "\""
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Snippet compilation function
-(defun yas/initialize ()
- "For backward compatibility, enable `yas/minor-mode' globally"
- (yas/global-mode 1))
+(defun yas--initialize ()
+ "For backward compatibility, enable `yas-minor-mode' globally."
+ (yas-global-mode 1))
-(defun yas/compile-directory (top-level-dir)
+(defun yas-compile-directory (top-level-dir)
"Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
This works by stubbing a few functions, then calling
-`yas/load-directory'."
+`yas-load-directory'."
(interactive "DTop level snippet directory?")
- (flet ((yas/load-yas-setup-file
+ (flet ((yas--load-yas-setup-file
(file)
(let ((elfile (concat file ".el")))
(when (file-exists-p elfile)
(insert ";;; .yas-setup.el support file if any:\n;;;\n")
(insert-file-contents elfile)
- (end-of-buffer)
+ (goto-char (point-max))
)))
- (yas/define-snippets
+ (yas-define-snippets
(mode snippets)
(insert ";;; Snippet definitions:\n;;;\n")
(let ((literal-snippets (list))
,binding
,uuid)
literal-snippets)))
- (insert (pp-to-string `(yas/define-snippets ',mode ',literal-snippets)))
+ (insert (pp-to-string `(yas-define-snippets ',mode ',literal-snippets)))
(insert "\n\n")))
- (yas/load-directory-1
+ (yas--load-directory-1
(dir mode parents &rest ignore)
(let ((output-file (concat (file-name-as-directory dir) ".yas-compiled-snippets.el")))
(with-temp-file output-file
(insert (format ";;; Compiled snippets and support files for `%s'\n" mode))
- (yas/load-directory-2 dir mode)
+ (yas--load-directory-2 dir mode)
(insert (format ";;; Do not edit! File generated at %s\n" (current-time-string)))))))
- (yas/load-directory top-level-dir nil)))
+ (yas-load-directory top-level-dir nil)))
-(defun yas/recompile-all ()
- "Compile every dir in `yas/snippet-dirs'."
+(defun yas-recompile-all ()
+ "Compile every dir in `yas-snippet-dirs'."
(interactive)
- (mapc #'yas/compile-directory (yas/snippet-dirs)))
+ (mapc #'yas-compile-directory (yas-snippet-dirs)))
;;; JIT loading
;;;
-(defvar yas/scheduled-jit-loads (make-hash-table)
- "Alist of mode-symbols to forms to be evaled when `yas/minor-mode' kicks in.")
+(defvar yas--scheduled-jit-loads (make-hash-table)
+ "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
-(defun yas/schedule-jit (mode form)
+(defun yas--schedule-jit (mode form)
(puthash mode
(cons form
- (gethash mode yas/scheduled-jit-loads))
- yas/scheduled-jit-loads))
+ (gethash mode yas--scheduled-jit-loads))
+ yas--scheduled-jit-loads))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Some user level functions
;;;
-(defun yas/about ()
+(defun yas-about ()
(interactive)
(message (concat "yasnippet (version "
- yas/version
+ yas--version
") -- pluskid <pluskid@gmail.com>/joaotavora <joaotavora@gmail.com>")))
-(defun yas/define-parents (mode parents)
- "Add PARENTS to the list of MODE's parents"
- (puthash mode-sym (remove-duplicates
- (append parents
- (gethash mode-sym yas/parents)))
- yas/parents))
+(defun yas--define-parents (mode parents)
+ "Add PARENTS to the list of MODE's parents."
+ (puthash mode (remove-duplicates
+ (append parents
+ (gethash mode yas--parents)))
+ yas--parents))
-(defun yas/define-snippets (mode snippets)
+(defun yas-define-snippets (mode snippets)
"Define SNIPPETS for MODE.
SNIPPETS is a list of snippet definitions, each taking the
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.
+been `yas--read-lisp'-ed and will eventually be
+`yas--eval-lisp'-ed.
The remaining elements are strings.
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
+You can use `yas--parse-template' to return such lists based on
the current buffers contents."
- (let ((snippet-table (yas/table-get-create mode))
+ (let ((snippet-table (yas--table-get-create mode))
(template nil))
(dolist (snippet snippets)
- (setq template (yas/define-snippets-1 snippet
+ (setq template (yas-define-snippets-1 snippet
snippet-table)))
template))
-(defun yas/define-snippets-1 (snippet snippet-table)
- "Helper for `yas/define-snippets'."
+(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'.
+ ;; `yas--parse-template'.
;;
(let* ((file (seventh snippet))
(key (car snippet))
(file-name-directory file))))
(condition (fourth snippet))
(group (fifth snippet))
- (keybinding (yas/read-keybinding (eighth snippet)))
+ (keybinding (yas--read-keybinding (eighth snippet)))
(uuid (or (ninth snippet)
name))
- (template (or (gethash uuid (yas/table-uuidhash snippet-table))
- (yas/make-blank-template))))
+ (template (or (gethash uuid (yas--table-uuidhash snippet-table))
+ (yas--make-blank-template))))
;; X) populate the template object
;;
- (yas/populate-template template
+ (yas--populate-template template
:table snippet-table
:key key
:content (second snippet)
;; also will take care of adding the key indicators in the
;; templates menu entry, if any
;;
- (yas/update-template snippet-table template)
+ (yas--update-template snippet-table template)
;; X) Return the template
;;
;;
template))
-(defun yas/snippet-menu-binding-pair-get-create (template &optional type)
+\f
+;;; Apropos snippet menu:
+;;
+;; The snippet menu keymaps are store by mode in hash table called
+;; `yas--menu-table'. They are linked to the main menu in
+;; `yas--menu-keymap-get-create' and are initially created empty,
+;; reflecting the table hierarchy.
+;;
+;; They can be populated in two mutually exclusive ways: (1) by
+;; reading `yas--template-group', which in turn is populated by the "#
+;; group:" directives of the snippets or the ".yas-make-groups" file
+;; or (2) by using a separate `yas-define-menu' call, which declares a
+;; menu structure based on snippets uuids.
+;;
+;; Both situations are handled in `yas--update-template-menu', which
+;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
+;; that can tell between the two situations.
+;;
+;; Note:
+;;
+;; * if `yas-define-menu' is used it must run before
+;; `yas-define-snippets' and the UUIDS must match, otherwise we get
+;; duplicate entries. The `yas--template' objects are created in
+;; `yas-define-menu', holding nothing but the menu entry,
+;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
+;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
+;; part is then stored in the menu keymap itself which make the item
+;; appear to the user. These limitations could probably be revised.
+;;
+;; * The `yas--template-perm-group' slot is only used in
+;; `yas-describe-tables'.
+;;
+(defun yas--template-menu-binding-pair-get-create (template &optional type)
"Get TEMPLATE's menu binding or assign it a new one.
-TYPE may be `:stay', signalling this menu binding should be
+TYPE may be `:stay', signaling this menu binding should be
static in the menu."
- (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)
+ (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)
type)))))
+(defun yas--template-menu-managed-by-yas-define-menu (template)
+ "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
+ (cdr (yas--template-menu-binding-pair template)))
-(defun yas/show-menu-p (mode)
- (cond ((eq yas/use-menu 'abbreviate)
+
+(defun yas--show-menu-p (mode)
+ (cond ((eq yas-use-menu 'abbreviate)
(find mode
(mapcar #'(lambda (table)
- (intern (yas/table-name table)))
- (yas/get-snippet-tables))))
- ((eq yas/use-menu 'real-modes)
- (yas/real-mode? mode))
- (t
+ (yas--table-mode table))
+ (yas--get-snippet-tables))))
+ ((eq yas-use-menu 'full)
+ t)
+ ((eq yas-use-menu t)
t)))
-(defun yas/delete-from-keymap (keymap uuid)
+(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\"
(mapc #'(lambda (item)
(when (and (listp (cdr item))
(keymapp (third (cdr item))))
- (yas/delete-from-keymap (third (cdr item)) uuid)))
+ (yas--delete-from-keymap (third (cdr item)) uuid)))
(rest keymap))
;; Set the uuid entry to nil
;;
(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.
+(defun yas-define-menu (mode menu &optional omit-items)
+ "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
+- (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-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
+- (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)
- menu
- hash)
- (dolist (uuid omit-items)
- (let ((template (or (gethash uuid hash)
- (yas/populate-template (puthash uuid
- (yas/make-blank-template)
- hash)
- :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)
+omitted from MODE's menu, even if they're manually loaded.
+
+This function does nothing if `yas-use-menu' is nil."
+ (when yas-use-menu
+ (let* ((table (yas--table-get-create mode))
+ (hash (yas--table-uuidhash table)))
+ (yas--define-menu-1 table
+ (yas--menu-keymap-get-create mode)
+ menu
+ hash)
+ (dolist (uuid omit-items)
+ (let ((template (or (gethash uuid hash)
+ (yas--populate-template (puthash uuid
+ (yas--make-blank-template)
+ hash)
+ :table table
+ :uuid uuid))))
+ (setf (yas--template-menu-binding-pair template) (cons nil :none)))))))
+
+(defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
+ "Helper for `yas-define-menu'."
(dolist (e (reverse menu))
- (cond ((eq (first e) 'yas/item)
+ (cond ((eq (first e) 'yas-item)
(let ((template (or (gethash (second e) uuidhash)
- (yas/populate-template (puthash (second e)
- (yas/make-blank-template)
+ (yas--populate-template (puthash (second e)
+ (yas--make-blank-template)
uuidhash)
: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)
+ (define-key menu-keymap (vector (gensym))
+ (car (yas--template-menu-binding-pair-get-create template :stay)))))
+ ((eq (first e) 'yas-submenu)
(let ((subkeymap (make-sparse-keymap)))
- (define-key keymap (vector (gensym))
+ (define-key menu-keymap (vector (gensym))
`(menu-item ,(second e) ,subkeymap))
- (yas/define-menu-1 table
+ (yas--define-menu-1 table
subkeymap
(third e)
uuidhash
(append group-list (list (second e))))))
- ((eq (first e) 'yas/separator)
- (define-key keymap (vector (gensym))
+ ((eq (first e) 'yas-separator)
+ (define-key menu-keymap (vector (gensym))
'(menu-item "----")))
(t
- (yas/message 3 "Don't know anything about menu entry %s" (first e))))))
-
-(defun yas/define (mode key template &optional name condition group)
+ (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
+\f
+(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
+`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
+ (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
-`hippie-expand-try-functions-list'."
- (when yas/minor-mode
+(defun yas-hippie-try-expand (first-time?)
+ "Integrate with hippie expand.
+
+Just put this function in `hippie-expand-try-functions-list'."
+ (when yas-minor-mode
(if (not first-time?)
- (let ((yas/fallback-behavior 'return-nil))
- (yas/expand))
+ (let ((yas-fallback-behavior 'return-nil))
+ (yas-expand))
(undo 1)
nil)))
;;;
;;;
;;;
-(defvar yas/condition-cache-timestamp nil)
-(defmacro yas/define-condition-cache (func doc &rest body)
+(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.
(stringp doc))
(concat doc
"\n\nFor use in snippets' conditions. Within each
-snippet-expansion routine like `yas/expand', computes actual
+snippet-expansion routine like `yas-expand', computes actual
value for the first time then always returns a cached value.")
(setq body (cons doc body))
nil)
- (let ((timestamp-and-value (get ',func 'yas/condition-cache)))
- (if (equal (car timestamp-and-value) yas/condition-cache-timestamp)
+ (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
,@body
)))
- (put ',func 'yas/condition-cache (cons yas/condition-cache-timestamp new-value))
+ (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
new-value)))))
-(defalias 'yas/expand 'yas/expand-from-trigger-key)
-(defun yas/expand-from-trigger-key (&optional field)
+(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'.
+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."
+object satisfying `yas--field-p' to restrict the expansion to."
(interactive)
- (setq yas/condition-cache-timestamp (current-time))
+ (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)))
+ (unless (and yas-expand-only-for-last-commands
+ (not (member last-command yas-expand-only-for-last-commands)))
(setq templates-and-pos (if field
(save-restriction
- (narrow-to-region (yas/field-start field)
- (yas/field-end field))
- (yas/current-key))
- (yas/current-key))))
+ (narrow-to-region (yas--field-start field)
+ (yas--field-end field))
+ (yas--current-key))
+ (yas--current-key))))
(if (and templates-and-pos
(first templates-and-pos))
- (yas/expand-or-prompt-for-template (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))))
+ (yas--fallback 'trigger-key))))
-(defun yas/expand-from-keymap ()
- "Directly expand some snippets, searching `yas/direct-keymaps'.
+(defun yas-expand-from-keymap ()
+ "Directly expand some snippets, searching `yas--direct-keymaps'.
If expansion fails, execute the previous binding for this key"
(interactive)
- (setq yas/condition-cache-timestamp (current-time))
- (let* ((yas/prefix current-prefix-arg)
+ (setq yas--condition-cache-timestamp (current-time))
+ (let* ((yas--prefix current-prefix-arg)
(vec (subseq (this-command-keys-vector) (if current-prefix-arg
universal-argument-num-events
0)))
(templates (mapcan #'(lambda (table)
- (yas/fetch table vec))
- (yas/get-snippet-tables))))
+ (yas--fetch table vec))
+ (yas--get-snippet-tables))))
(if templates
- (yas/expand-or-prompt-for-template templates)
- (let ((yas/fallback-behavior 'call-other-command))
- (yas/fallback)))))
+ (yas--expand-or-prompt-for-template templates)
+ (let ((yas-fallback-behavior 'call-other-command))
+ (yas--fallback)))))
-(defun yas/expand-or-prompt-for-template (templates &optional start end)
+(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)))
+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)
+ (when yas--current-template
+ (yas-expand-snippet (yas--template-content yas--current-template)
start
end
- (yas/template-expand-env yas/current-template)))))
+ (yas--template-expand-env yas--current-template)))))
-(defun yas/fallback (&optional from-trigger-key-p)
+;; Apropos the trigger key and the fallback binding:
+;;
+;; When `yas-minor-mode-map' binds <tab>, that correctly overrides
+;; org-mode's <tab>, for example and searching for fallbacks correctly
+;; returns `org-cycle'. However, most other modes bind "TAB". TODO,
+;; improve this explanation.
+;;
+(defun yas--fallback (&optional from-trigger-key-p)
"Fallback after expansion has failed.
-Common gateway for `yas/expand-from-trigger-key' and
-`yas/expand-from-keymap'."
- (cond ((eq yas/fallback-behavior 'return-nil)
+Common gateway for `yas-expand-from-trigger-key' and
+`yas-expand-from-keymap'."
+ (cond ((eq yas-fallback-behavior 'return-nil)
;; return nil
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
- from-trigger-key-p
- (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)))
- command-1)
- (and (symbolp command-2)
- 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)))))
+ ((eq yas-fallback-behavior 'call-other-command)
+ (let* ((beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
+ (yas--message 4 "Falling back to %s" beyond-yasnippet)
+ (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
+ (setq this-original-command beyond-yasnippet)
+ (call-interactively beyond-yasnippet)))
+ ((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)))))
(t
;; also return nil if all the other fallbacks have failed
nil)))
+(defun yas--keybinding-beyond-yasnippet ()
+ "Returns the "
+ (let* ((yas-minor-mode nil)
+ (yas--direct-keymaps nil)
+ (keys (this-single-command-keys)))
+ (or (key-binding keys t)
+ (key-binding (yas--fallback-translate-input keys) t))))
+
+(defun yas--fallback-translate-input (keys)
+ "Emulate `read-key-sequence', at least what I think it does.
+
+Keys should be an untranslated key vector. Returns a translated
+vector of keys. FIXME not thoroughly tested"
+ (let ((retval [])
+ (i 0))
+ (while (< i (length keys))
+ (let ((j i)
+ (translated local-function-key-map))
+ (while (and (< j (length keys))
+ translated
+ (keymapp translated))
+ (setq translated (aget (remove 'keymap translated) (aref keys j))
+ j (1+ j)))
+ (setq retval (vconcat retval (cond ((symbolp translated)
+ `[,translated])
+ ((vectorp translated)
+ translated)
+ (t
+ (substring keys i j)))))
+ (setq i j)))
+ retval))
\f
-;;; Snippet development
+;;; Utils for snippet development:
-(defun yas/all-templates (tables)
- "Return all snippet tables applicable for the current buffer.
+(defun yas--all-templates (tables)
+ "Get `yas--template' objects in TABLES, applicable for buffer and point.
-Honours `yas/choose-tables-first', `yas/choose-keys-first' and
-`yas/buffer-local-condition'"
- (when yas/choose-tables-first
- (setq tables (list (yas/prompt-for-table tables))))
+Honours `yas-choose-tables-first', `yas-choose-keys-first' and
+`yas-buffer-local-condition'"
+ (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))))
+ (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))
+ (yas--fetch table key))
tables)))
- (remove-duplicates (mapcan #'yas/table-templates tables)
+ (remove-duplicates (mapcan #'yas--table-templates tables)
:test #'equal))))
-(defun yas/insert-snippet (&optional no-condition)
+(defun yas-insert-snippet (&optional no-condition)
"Choose a snippet to expand, pop-up a list of choices according
-to `yas/prompt-function'.
+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
+ (setq yas--condition-cache-timestamp (current-time))
+ (let* ((yas-buffer-local-condition (or (and no-condition
'always)
- yas/buffer-local-condition))
- (templates (yas/all-templates (yas/get-snippet-tables)))
- (yas/current-template (and templates
+ yas-buffer-local-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))
+ (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)
+ (if yas--current-template
+ (yas-expand-snippet (yas--template-content yas--current-template)
(car where)
(cdr where)
- (yas/template-expand-env yas/current-template))
- (yas/message 3 "No snippets can be inserted here!"))))
+ (yas--template-expand-env yas--current-template))
+ (yas--message 3 "No snippets can be inserted here!"))))
-(defun yas/visit-snippet-file ()
- "Choose a snippet to edit, selection like `yas/insert-snippet'.
+(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'."
(interactive)
- (let* ((yas/buffer-local-condition 'always)
- (templates (yas/all-templates (yas/get-snippet-tables)))
- (yas/prompt-functions '(yas/ido-prompt yas/completing-prompt))
+ (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
+ (or (yas--prompt-for-template templates
"Choose a snippet template to edit: ")
(car templates)))))
(if template
- (yas/visit-snippet-file-1 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)))
+(defun yas--visit-snippet-file-1 (template)
+ "Helper for `yas-visit-snippet-file'."
+ (let ((file (yas--template-file template)))
(cond ((and file (file-readable-p file))
(find-file-other-window file)
(snippet-mode)
- (set (make-local-variable 'yas/editing-template) template))
+ (set (make-local-variable 'yas--editing-template) template))
(file
(message "Original file %s no longer exists!" file))
(t
- (switch-to-buffer (format "*%s*"(yas/template-name template)))
+ (switch-to-buffer (format "*%s*"(yas--template-name template)))
(let ((type 'snippet))
- (when (listp (yas/template-content template))
+ (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 (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))))
+ (pp-to-string (yas--template-content template))
+ (yas--template-content template))))
(snippet-mode)
- (set (make-local-variable 'yas/editing-template) template)))))
+ (set (make-local-variable 'yas--editing-template) template)))))
-(defun yas/guess-snippet-directories-1 (table)
+(defun yas--guess-snippet-directories-1 (table)
"Guesses possible snippet subdirectories for TABLE."
- (cons (yas/table-name table)
+ (cons (yas--table-name table)
(mapcan #'(lambda (parent)
- (yas/guess-snippet-directories-1
+ (yas--guess-snippet-directories-1
parent))
- (yas/table-parents table))))
+ (yas--table-parents table))))
-(defun yas/guess-snippet-directories (&optional 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
+Returns a list of elements (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")))))))
+ (or (first (or (yas-snippet-dirs)
+ (setq yas-snippet-dirs '("~/.emacs.d/snippets")))))))
(tables (or (and table
(list table))
- (yas/get-snippet-tables))))
+ (yas--get-snippet-tables))))
;; HACK! the snippet table created here is actually registered!
;;
- (unless (or table (gethash major-mode yas/tables))
- (push (yas/table-get-create major-mode)
+ (unless (or table (gethash major-mode yas--tables))
+ (push (yas--table-get-create major-mode)
tables))
(mapcar #'(lambda (table)
(cons table
(mapcar #'(lambda (subdir)
(concat main-dir "/" subdir))
- (yas/guess-snippet-directories-1 table))))
+ (yas--guess-snippet-directories-1 table))))
tables)))
-(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."
+(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/format "%s is not writable." candidate)))
+ (error (yas--format "%s is not writable." candidate)))
(if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
candidate
- (if (gethash (intern (yas/table-name (car table-and-dirs)))
- yas/tables)
+ (if (gethash (yas--table-mode (car table-and-dirs))
+ yas--tables)
""
" brand new")
(or main-table-string
"")
- (yas/table-name (car table-and-dirs))))
+ (yas--table-name (car table-and-dirs))))
(progn
(make-directory candidate 'also-make-parents)
;; create the .yas-parents file here...
candidate)))))
-(defun yas/new-snippet (&optional no-template)
+(defun yas-new-snippet (&optional no-template)
"Pops a new buffer for writing a snippet.
Expands a snippet-writing snippet, unless the optional prefix arg
NO-TEMPLATE is non-nil."
(interactive "P")
- (let ((guessed-directories (yas/guess-snippet-directories)))
+ (let ((guessed-directories (yas--guess-snippet-directories)))
(switch-to-buffer "*new snippet*")
(erase-buffer)
(kill-all-local-variables)
(snippet-mode)
- (yas/minor-mode 1)
- (set (make-local-variable 'yas/guessed-modes) (mapcar #'(lambda (d)
- (intern (yas/table-name (car d))))
+ (yas-minor-mode 1)
+ (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
+ (yas--table-mode (car d)))
guessed-directories))
- (unless no-template (yas/expand-snippet "\
+ (unless no-template (yas-expand-snippet "\
# -*- mode: snippet -*-
# name: $1
-# key: ${2:${1:$(replace-regexp-in-string \"\\\\\\\\(\\\\\\\\w+\\\\\\\\).*\" \"\\\\\\\\1\" yas/text)}}${3:
+# key: ${2:${1:$(replace-regexp-in-string \"\\\\\\\\(\\\\\\\\w+\\\\\\\\).*\" \"\\\\\\\\1\" yas-text)}}${3:
# binding: ${4:direct-keybinding}}${5:
# expand-env: ((${6:some-var} ${7:some-value}))}${8:
# type: command}
# --
$0"))))
-(defun yas/compute-major-mode-and-parents (file)
- "Given FILE, find the nearest snippet directory for a given
-mode, then return a list (MODE-SYM PARENTS), the mode's symbol and a list
+(defun yas--compute-major-mode-and-parents (file)
+ "Given FILE, find the nearest snippet directory for a given mode.
+
+Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
representing one or more of the mode's parents.
Note that MODE-SYM need not be the symbol of a real major mode,
(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--editing-template nil
+ "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
-(defvar yas/current-template nil
+(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")
+(defvar yas--guessed-modes nil
+ "List of guessed modes supporting `yas-load-snippet-buffer'.")
+
+(defun yas--read-table ()
+ "Ask user for a snippet table, help with some guessing."
+ (let ((prompt (if (and (featurep 'ido)
+ ido-mode)
+ 'ido-completing-read 'completing-read)))
+ (unless yas--guessed-modes
+ (set (make-local-variable 'yas--guessed-modes)
+ (or (yas--compute-major-mode-and-parents buffer-file-name))))
+ (intern
+ (funcall prompt (format "Choose or enter a table (yas guesses %s): "
+ (if yas--guessed-modes
+ (first yas--guessed-modes)
+ "nothing"))
+ (mapcar #'symbol-name yas--guessed-modes)
+ nil
+ nil
+ nil
+ nil
+ (if (first yas--guessed-modes)
+ (symbol-name (first yas--guessed-modes)))))))
+
+(defun yas-load-snippet-buffer (table &optional interactive)
+ "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 and
+whether (and where) to save the snippet, then quit the window."
+ (interactive (list (yas--read-table) t))
(cond
- ;; We have `yas/editing-template', this buffer's
- ;; content comes from a template which is already loaded and
- ;; neatly positioned,...
+ ;; We have `yas--editing-template', this buffer's content comes from a
+ ;; template which is already loaded and neatly positioned,...
;;
- (yas/editing-template
- (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'
+ (yas--editing-template
+ (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'
;;
(t
- (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-mode)
- 'ido-completing-read 'completing-read))
- (table (yas/table-get-create
- (intern
- (funcall prompt (format "Choose or enter a table (yas guesses %s): "
- (if yas/guessed-modes
- (first yas/guessed-modes)
- "nothing"))
- (mapcar #'symbol-name yas/guessed-modes)
- nil
- nil
- nil
- nil
- (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)
+ (unless yas--guessed-modes
+ (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
+ (let* ((table (yas--table-get-create table)))
+ (set (make-local-variable 'yas--editing-template)
+ (yas-define-snippets-1 (yas--parse-template buffer-file-name)
table)))))
- ;; 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/format "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)
- default-file-name)))
- (setf (yas/template-file yas/editing-template) buffer-file-name))))))
- (when kill
- (quit-window kill))
- (yas/message 3 "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."
+
+ (when (and interactive
+ (or
+ ;; Only offer to save this if it looks like a library or new
+ ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
+ ;; which is not the first, or from an unwritable file)
+ ;;
+ (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)))))
+ (y-or-n-p (yas--format "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)
+ default-file-name)))
+ (setf (yas--template-file yas--editing-template) buffer-file-name)))))
+ (when interactive
+ (yas--message 3 "Snippet \"%s\" loaded for %s."
+ (yas--template-name yas--editing-template)
+ (yas--table-name (yas--template-table yas--editing-template)))
+ (quit-window interactive)))
+
+(defun yas-tryout-snippet (&optional debug)
+ "Test current buffer'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))
+ (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/format "Please input a mode: ")))))
- (yas/current-template
+ (first yas--guessed-modes)
+ (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
+ (yas--current-template
(and parsed
(fboundp test-mode)
- (yas/populate-template (yas/make-blank-template)
+ (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))))
+ (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))
+ (yas-minor-mode 1)
(setq buffer-read-only nil)
- (yas/expand-snippet (yas/template-content yas/current-template)
+ (yas-expand-snippet (yas--template-content yas--current-template)
(point-min)
(point-max)
- (yas/template-expand-env 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))))
+ (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
(t
- (yas/message 3 "Cannot test snippet for unknown major mode")))))
+ (yas--message 3 "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-active-keys ()
+ "Return all active trigger keys for current buffer and point."
+ (remove-duplicates (mapcan #'yas--table-all-keys (yas--get-snippet-tables))
+ :test #'string=))
-(defun yas/describe-tables (&optional choose)
+(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))
+ (active-tables (yas--get-snippet-tables))
(remain-tables (let ((all))
(maphash #'(lambda (k v)
(unless (find v active-tables)
(push v all)))
- yas/tables)
+ yas--tables)
all))
(table-lists (list active-tables remain-tables))
(original-buffer (current-buffer))
(continue t)
- (yas/condition-cache-timestamp (current-time)))
+ (yas--condition-cache-timestamp (current-time)))
(with-current-buffer buffer
(setq buffer-read-only nil)
(erase-buffer)
(while (and table-lists
continue)
(dolist (table (car table-lists))
- (yas/describe-pretty-table table original-buffer))
+ (yas--describe-pretty-table table original-buffer))
(setq table-lists (cdr table-lists))
(when table-lists
- (yas/create-snippet-xrefs)
+ (yas--create-snippet-xrefs)
(display-buffer buffer)
(setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
- (yas/create-snippet-xrefs)
+ (yas--create-snippet-xrefs)
(help-mode)
(goto-char 1))
(t
(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)))
+ (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
(let ((keys))
(maphash #'(lambda (k v)
(push k keys))
- (yas/table-hash table))
+ (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)))
+ (gethash key (yas--table-hash table)))
names))))))))
(goto-char 1)
(setq buffer-read-only t))
(display-buffer buffer)))
-(defun yas/describe-pretty-table (table &optional original-buffer)
+(defun yas--describe-pretty-table (table &optional original-buffer)
(insert (format "\nSnippet table `%s'"
- (yas/table-name table)))
- (if (yas/table-parents table)
+ (yas--table-name table)))
+ (if (yas--table-parents table)
(insert (format " parents: %s\n"
- (mapcar #'yas/table-name
- (yas/table-parents table))))
+ (mapcar #'yas--table-name
+ (yas--table-parents table))))
(insert "\n"))
(insert (make-string 100 ?-) "\n")
(insert "group state name key binding\n")
(let ((groups-hash (make-hash-table :test #'equal)))
(maphash #'(lambda (k v)
- (let ((group (or (yas/template-fine-group v)
+ (let ((group (or (yas--template-fine-group v)
"(top level)")))
- (when (yas/template-name v)
+ (when (yas--template-name v)
(puthash group
(cons v (gethash group groups-hash))
groups-hash))))
- (yas/table-uuidhash table))
+ (yas--table-uuidhash table))
(maphash
#'(lambda (group templates)
(setq group (truncate-string-to-width group 25 0 ? "..."))
(insert (make-string 100 ?-) "\n")
(dolist (p templates)
- (let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas/template-name p))
+ (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)))
+ (condition-string (let ((condition (yas--template-condition p)))
(if (and condition
original-buffer)
(with-current-buffer original-buffer
- (if (yas/eval-condition condition)
+ (if (yas--eval-condition condition)
"(y)"
"(s)"))
"(a)"))))
"'"
" ")
" ")
- (insert (truncate-string-to-width (or (yas/template-key p) "")
+ (insert (truncate-string-to-width (or (yas--template-key p) "")
15 0 ? "...") " ")
- (insert (truncate-string-to-width (key-description (yas/template-keybinding p))
+ (insert (truncate-string-to-width (key-description (yas--template-keybinding p))
15 0 ? "...") " ")
(insert "\n"))))
groups-hash)))
\f
;;; User convenience functions, for using in snippet definitions
-(defvar yas/modified-p nil
+(defvar yas-modified-p nil
"Non-nil if field has been modified by user or transformation.")
-(defvar yas/moving-away-p nil
+(defvar yas-moving-away-p nil
"Non-nil if user is about to exit field.")
-(defvar yas/text nil
+(defvar yas-text nil
"Contains current field text.")
-(defun yas/substr (str pattern &optional subexp)
+(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
(match-string-no-properties grp str)
str))))
-(defun yas/choose-value (possibilities)
- "Prompt for a string in the list POSSIBILITIES and return it."
- (unless (or yas/moving-away-p
- yas/modified-p)
+(defun yas-choose-value (&rest possibilities)
+ "Prompt for a string in POSSIBILITIES and return it.
+
+The last element of POSSIBILITIES may be a list of strings."
+ (unless (or yas-moving-away-p
+ yas-modified-p)
+ (setq possibilities (nreverse possibilities))
+ (setq possibilities (if (listp (car possibilities))
+ (append (reverse (car possibilities)) (rest possibilities))
+ possibilities))
(some #'(lambda (fn)
(funcall fn "Choose: " possibilities))
- yas/prompt-functions)))
+ yas-prompt-functions)))
-(defun yas/key-to-value (alist)
- "Prompt for a string in the list POSSIBILITIES and return it."
- (unless (or yas/moving-away-p
- yas/modified-p)
+(defun yas-key-to-value (alist)
+ (unless (or yas-moving-away-p
+ yas-modified-p)
(let ((key (read-key-sequence "")))
(when (stringp key)
(or (cdr (find key alist :key #'car :test #'string=))
key)))))
-(defun yas/throw (text)
- "Throw a yas/exception with TEXT as the reason."
- (throw 'yas/exception (cons 'yas/exception text)))
+(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
+(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 (yas/format "Field only allows %s" possibilities))))
+ (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
+ (yas-throw (yas--format "Field only allows %s" possibilities))))
-(defun yas/field-value (number)
+(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)))
+ (let* ((snippet (car (yas--snippets-at-point)))
(field (and snippet
- (yas/snippet-find-field snippet number))))
+ (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)))
- 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
+ (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)))
+ 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))))
+ (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-default-from-field (number)
+ (unless yas-modified-p
+ (yas-field-value number)))
-(defun yas/inside-string ()
+(defun yas-inside-string ()
+ "Return non-nil if the point is inside a string according to font-lock."
(equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
-(defun yas/unimplemented (&optional missing-feature)
- (if yas/current-template
+(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
"something")))
- (yas/visit-snippet-file-1 yas/current-template))
+ (yas--visit-snippet-file-1 yas--current-template))
(message "No implementation. Missing %s" (or missing-feature "something"))))
\f
;;; Snippet expansion and field management
-(defvar yas/active-field-overlay nil
+(defvar yas--active-field-overlay nil
"Overlays the currently active field.")
-(defvar yas/field-protection-overlays nil
- "Two overlays protect the current 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")
+(defconst yas--prefix nil
+ "A prefix argument for expansion direct from keybindings.")
-(defvar yas/selected-text nil
+(defvar yas-selected-text nil
"The selected region deleted on the last snippet expansion.")
-(defvar yas/start-column nil
+(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)
+(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 ()))
+(defstruct (yas--snippet (:constructor yas--make-snippet ()))
"A snippet.
..."
(fields '())
(exit nil)
- (id (yas/snippet-next-id) :read-only t)
+ (id (yas--snippet-next-id) :read-only t)
(control-overlay nil)
active-field
;; stacked expansion: the `previous-active-field' slot saves the
previous-active-field
force-exit)
-(defstruct (yas/field (:constructor yas/make-field (number start end parent-field)))
+(defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
"A field."
number
start end
(modified-p nil)
next)
-(defstruct (yas/mirror (:constructor yas/make-mirror (start end transform)))
+(defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
"A mirror."
start end
(transform nil)
parent-field
next)
-(defstruct (yas/exit (:constructor yas/make-exit (marker)))
+(defstruct (yas--exit (:constructor yas--make-exit (marker)))
marker
next)
-(defun yas/apply-transform (field-or-mirror field &optional empty-on-nil-p)
+(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)))
+ (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
(save-excursion
(goto-char start-point)
- (let ((ret (yas/eval-lisp transform)))
+ (let ((ret (yas--eval-lisp transform)))
(or ret (and empty-on-nil-p "")))))))
transformed))
-(defsubst yas/replace-all (from to &optional text)
- "Replace all occurance from FROM to TO.
+(defsubst yas--replace-all (from to &optional text)
+ "Replace all occurrences from FROM to TO.
With optional string TEXT do it in that string."
(if text
(while (search-forward from nil t)
(replace-match to t t text))))
-(defun yas/snippet-find-field (snippet number)
+(defun yas--snippet-find-field (snippet number)
(find-if #'(lambda (field)
- (eq number (yas/field-number field)))
- (yas/snippet-fields snippet)))
+ (eq number (yas--field-number field)))
+ (yas--snippet-fields snippet)))
-(defun yas/snippet-sort-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)
- #'yas/snippet-field-compare)))
-
-(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)))
+ (setf (yas--snippet-fields snippet)
+ (sort (yas--snippet-fields snippet)
+ #'yas--snippet-field-compare)))
+
+(defun yas--snippet-field-compare (field1 field2)
+ "Compare FIELD1 and FIELD2.
+
+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))
(not (zerop n1)))
(if n2
(zerop n2)
- (< (yas/field-start field1)
- (yas/field-start field2))))))
+ (< (yas--field-start field1)
+ (yas--field-start field2))))))
-(defun yas/field-probably-deleted-p (snippet field)
+(defun yas--field-probably-deleted-p (snippet field)
"Guess if SNIPPET's FIELD should be skipped."
(and
- ;; field must be zero lentgh
+ ;; field must be zero length
;;
- (zerop (- (yas/field-start field) (yas/field-end field)))
+ (zerop (- (yas--field-start field) (yas--field-end field)))
;; skip if:
(or
;; 1) is a nested field and it's been modified
;;
- (and (yas/field-parent-field field)
- (yas/field-modified-p field))
+ (and (yas--field-parent-field field)
+ (yas--field-modified-p field))
;; 2) ends just before the snippet end
;;
- (and (eq field (car (last (yas/snippet-fields snippet))))
- (= (yas/field-start field) (overlay-end (yas/snippet-control-overlay snippet)))))
+ (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)))))
+ (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."
+(defun yas--snippets-at-point (&optional all-snippets)
+ "Return a sorted list of snippets at point.
+
+The most recently-inserted snippets are returned first."
(sort
(remove nil (remove-duplicates (mapcar #'(lambda (ov)
- (overlay-get ov 'yas/snippet))
+ (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)))))
+ (<= (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.
-(defun yas/next-field-or-maybe-expand ()
- "Try to expand a snippet at a key before point, otherwise
-delegate to `yas/next-field'."
+Otherwise delegate to `yas-next-field'."
(interactive)
- (if yas/triggers-in-field
- (let ((yas/fallback-behavior 'return-nil)
- (active-field (overlay-get yas/active-field-overlay 'yas/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)
- (yas/next-field))))
- (yas/next-field)))
+ (unless (yas-expand-from-trigger-key active-field)
+ (yas-next-field))))
+ (yas-next-field)))
-(defun yas/next-field (&optional arg)
- "Navigate to next field. If there's none, exit the snippet."
+(defun yas-next-field (&optional arg)
+ "Navigate to the ARGth next field.
+
+If there's none, exit the snippet."
(interactive)
(let* ((arg (or arg
1))
- (snippet (first (yas/snippets-at-point)))
- (active-field (overlay-get yas/active-field-overlay 'yas/field))
+ (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)))
+ (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)))
+ (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))))
+ (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-exit-snippet snippet))
(target-field
- (yas/move-to-field snippet target-field))
+ (yas--move-to-field snippet target-field))
(t
nil))))
-(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--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)
+(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)))
+ (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))
(progn
- (set-mark (yas/field-end field))
- (setf (yas/snippet-force-exit snippet)
- (or (yas/field-transform field)
+ (set-mark (yas--field-end field))
+ (setf (yas--snippet-force-exit snippet)
+ (or (yas--field-transform field)
t)))
;; make this field active
- (setf (yas/snippet-active-field snippet) field)
+ (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))))))
+ (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 ()
+(defun yas-prev-field ()
"Navigate to prev field. If there's none, exit the snippet."
(interactive)
- (yas/next-field -1))
+ (yas-next-field -1))
-(defun yas/abort-snippet (&optional snippet)
+(defun yas-abort-snippet (&optional snippet)
(interactive)
(let ((snippet (or snippet
- (car (yas/snippets-at-point)))))
+ (car (yas--snippets-at-point)))))
(when snippet
- (setf (yas/snippet-force-exit snippet) t))))
+ (setf (yas--snippet-force-exit snippet) t))))
-(defun yas/exit-snippet (snippet)
+(defun yas-exit-snippet (snippet)
"Goto exit-marker of SNIPPET."
- (interactive (list (first (yas/snippets-at-point))))
+ (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))))))
+ (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 ()
+(defun yas-exit-all-snippets ()
"Exit all snippets."
(interactive)
(mapc #'(lambda (snippet)
- (yas/exit-snippet snippet)
- (yas/check-commit-snippet))
- (yas/snippets-at-point 'all-snippets)))
+ (yas-exit-snippet snippet)
+ (yas--check-commit-snippet))
+ (yas--snippets-at-point 'all-snippets)))
\f
-;;; Some low level snippet-routines
+;;; Some low level snippet-routines:
-(defmacro yas/inhibit-overlay-hooks (&rest body)
- "Run BODY with `yas/inhibit-overlay-hooks' set to t."
+(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))
+ `(let ((yas--inhibit-overlay-hooks t))
(progn ,@body)))
-(defvar yas/snippet-beg nil "Beginning position of the last snippet commited.")
-(defvar yas/snippet-end nil "End position of the last snippet commited.")
+(defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
+(defvar yas-snippet-end nil "End position of the last snippet committed.")
+
+(defun yas--commit-snippet (snippet)
+ "Commit SNIPPET, but leave point as it is.
-(defun yas/commit-snippet (snippet)
- "Commit SNIPPET, but leave point as it is. This renders the
-snippet as ordinary text."
+This renders the snippet as ordinary text."
- (let ((control-overlay (yas/snippet-control-overlay 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))
+ (setq yas-snippet-beg (overlay-start control-overlay))
+ (setq yas-snippet-end (overlay-end control-overlay))
(delete-overlay control-overlay))
- (yas/inhibit-overlay-hooks
- (when yas/active-field-overlay
- (delete-overlay yas/active-field-overlay))
- (when yas/field-protection-overlays
- (mapc #'delete-overlay yas/field-protection-overlays)))
+ (yas--inhibit-overlay-hooks
+ (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'...
+ ;; `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)))
+ (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)
+ (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)
+ (if yas-snippet-revival
+ (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
buffer-undo-list)
;; Dismember the snippet... this is useful if we get called
- ;; again from `yas/take-care-of-redo'....
- (setf (yas/snippet-fields snippet) nil)))
+ ;; again from `yas--take-care-of-redo'....
+ (setf (yas--snippet-fields snippet) nil)))
- (yas/message 3 "Snippet %s exited." (yas/snippet-id snippet)))
+ (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
-(defun yas/safely-run-hooks (hook-var)
+(defun yas--safely-run-hooks (hook-var)
(condition-case error
(run-hooks hook-var)
(error
- (yas/message 3 "%s error: %s" hook-var (error-message-string error)))))
+ (yas--message 3 "%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.
-(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))
+If so cleans up the whole snippet up."
+ (let* ((snippets (yas--snippets-at-point 'all-snippets))
(snippets-left snippets)
(snippet-exit-transform))
(dolist (snippet snippets)
- (let ((active-field (yas/snippet-active-field snippet)))
- (setq snippet-exit-transform (yas/snippet-force-exit snippet))
+ (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))))
+ (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))
+ (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))))
+ (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
;;
(save-excursion
- (yas/move-to-field snippet active-field)
- (yas/update-mirrors snippet)))
+ (yas--move-to-field snippet active-field)
+ (yas--update-mirrors snippet)))
(t
nil))))
(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))))
+ (yas--eval-lisp-no-saves snippet-exit-transform))
+ (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
;; Apropos markers-to-points:
;;
;; This shouldn't bring horrible problems with undo/redo, but it
;; you never know
;;
-(defun yas/markers-to-points (snippet)
+(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)))
+ (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)))
+ (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)))))))
+ (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)
+(defun yas--field-contains-point-p (field &optional point)
(let ((point (or point
(point))))
- (and (>= point (yas/field-start field))
- (<= point (yas/field-end field)))))
+ (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--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"
+(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)
+(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
nil
nil
t)))
- (overlay-put overlay 'keymap yas/keymap)
+ (overlay-put overlay 'keymap yas-keymap)
(overlay-put overlay 'priority 100)
- (overlay-put overlay 'yas/snippet snippet)
+ (overlay-put overlay 'yas--snippet snippet)
overlay))
-(defun yas/skip-and-clear-or-delete-char (&optional field)
+(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'."
(interactive)
(let ((field (or field
- (and yas/active-field-overlay
- (overlay-buffer yas/active-field-overlay)
- (overlay-get yas/active-field-overlay 'yas/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))
+ (not (yas--field-modified-p field))
+ (eq (point) (marker-position (yas--field-start field))))
+ (yas--skip-and-clear field)
+ (yas-next-field 1))
(t
(call-interactively 'delete-char)))))
-(defun yas/skip-and-clear (field)
- "Deletes the region of FIELD and sets it modified state to t"
+(defun yas--skip-and-clear (field)
+ "Deletes the region of FIELD and sets it's 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
+ ;; fields as modified, too. If the children 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)))
+ (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)))
+(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)))))
+ (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)
+(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)
+ (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
- '(yas/on-field-overlay-modification))
- (overlay-put yas/active-field-overlay 'insert-behind-hooks
- '(yas/on-field-overlay-modification))))
-
-(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)
+ (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
+ '(yas--on-field-overlay-modification))
+ (overlay-put yas--active-field-overlay 'insert-behind-hooks
+ '(yas--on-field-overlay-modification))))
+
+(defvar yas--inhibit-overlay-hooks nil
+ "Bind this temporarily 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
progress."
- (unless (or yas/inhibit-overlay-hooks
- (yas/undo-in-progress))
- (let* ((field (overlay-get overlay 'yas/field))
- (number (and field (yas/field-number field)))
- (snippet (overlay-get yas/active-field-overlay 'yas/snippet)))
+ (unless (or yas--inhibit-overlay-hooks
+ (yas--undo-in-progress))
+ (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--advance-end-maybe field (overlay-end overlay))
(save-excursion
- (yas/field-update-display field snippet))
- (yas/update-mirrors snippet))
+ (yas--field-update-display field snippet))
+ (yas--update-mirrors snippet))
(field
(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))))))
+ (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))))))
\f
;;; 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'.
+;; `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.
+;; 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
+;; interactively, and then signals an error, 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)
+(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)))
+ (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 (< (buffer-size) end)
(save-excursion
- (yas/inhibit-overlay-hooks
+ (yas--inhibit-overlay-hooks
(goto-char (point-max))
(newline))))
;; 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)))
+ (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)))
(t
- (setq yas/field-protection-overlays
+ (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)
+ (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)))))))
+ (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.
+(defvar yas--protection-violation nil
+ "When non-nil, signals attempts to erroneously 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
+`yas--post-command-handler' can check it and reset its value to
+nil. The variables value is the point where the violation
originated")
-(defun yas/on-protection-overlay-modification (overlay after? beg end &optional length)
+(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
+ (unless yas--inhibit-overlay-hooks
(cond ((not (or after?
- (yas/undo-in-progress)))
- (setq yas/protection-violation (point))
+ (yas--undo-in-progress)))
+ (setq yas--protection-violation (point))
(error "Exit the snippet first!")))))
(add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
\f
-;;; Apropos stacked expansion:
+;; Snippet expansion and "stacked" expansion:
+;;
+;; Stacked expansion is when you try to expand a snippet when already
+;; inside a snippet 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
+;; 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
+;; 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
+;; This was thought to be safer in an undo/redo perspective, but
;; maybe the correct implementation is to make the globals
-;; `yas/active-field-overlay' and `yas/field-protection-overlays' be
+;; `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)
+(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
+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)
- (region-end))
- (unless start (setq start (region-beginning))
- (unless end (setq end (region-end)))))))
-
- (when start
- (goto-char start))
+ (run-hooks 'yas-before-expand-snippet-hook)
;;
- (let ((to-delete (and start end (buffer-substring-no-properties start end)))
- (start (or start (point)))
- (end (or end (point)))
- snippet)
- (setq yas/indent-original-column (current-column))
+ (let* ((yas-selected-text (or yas-selected-text
+ (and (region-active-p)
+ (buffer-substring-no-properties (region-beginning)
+ (region-end)))))
+ (start (or start
+ (and (region-active-p)
+ (region-beginning))
+ (point)))
+ (end (or end
+ (and (region-active-p)
+ (region-end))
+ (point)))
+ (to-delete (and start
+ end
+ (buffer-substring-no-properties start end)))
+ snippet)
+ (goto-char start)
+ (setq yas--indent-original-column (current-column))
;; Delete the region to delete, this *does* get undo-recorded.
;;
(when (and to-delete
(cond ((listp content)
;; x) This is a snippet-command
;;
- (yas/eval-lisp-no-saves content))
+ (yas--eval-lisp-no-saves content))
(t
;; x) This is a snippet-snippet :-)
;;
;; 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)))
- (yas/inhibit-overlay-hooks
+ (setq yas--start-column (save-restriction (widen) (current-column)))
+ (yas--inhibit-overlay-hooks
(setq snippet
(if expand-env
(eval `(let* ,expand-env
(insert content)
- (yas/snippet-create (point-min) (point-max))))
+ (yas--snippet-create (point-min) (point-max))))
(insert content)
- (yas/snippet-create (point-min) (point-max)))))))
+ (yas--snippet-create (point-min) (point-max)))))))
;; stacked-expansion: This checks for stacked expansion, save the
- ;; `yas/previous-active-field' and advance its boudary.
+ ;; `yas--previous-active-field' and advance its boundary.
;;
- (let ((existing-field (and yas/active-field-overlay
- (overlay-buffer yas/active-field-overlay)
- (overlay-get yas/active-field-overlay 'yas/field))))
+ (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))))
+ (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))
+ (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
+ ;; `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
+ ;; 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))))
+ (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)
+ (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
buffer-undo-list))
;; Now, schedule a move to the first field
;;
- (let ((first-field (car (yas/snippet-fields snippet))))
+ (let ((first-field (car (yas--snippet-fields snippet))))
(when first-field
(sit-for 0) ;; fix issue 125
- (yas/move-to-field snippet first-field)))
- (yas/message 3 "snippet expanded.")
+ (yas--move-to-field snippet first-field)))
+ (yas--message 3 "snippet expanded.")
t))))
-(defun yas/take-care-of-redo (beg end snippet)
- "Commits SNIPPET, which in turn pushes an undo action for
-reviving it.
+(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)))
+ (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
-END.
+(defun yas--snippet-revive (beg end snippet)
+ "Revives SNIPPET and creates a control overlay from BEG to END.
-BEG and END are, we hope, the original snippets boudaries. All
+BEG and END are, we hope, the original snippets boundaries. 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
+After revival, push the `yas--take-care-of-redo' in the
`buffer-undo-list'"
;; Reconvert all the points to markers
;;
- (yas/points-to-markers snippet)
+ (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)))))
+ (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)
+ (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)
+ (yas--move-to-field snippet target-field)
- (push `(apply yas/take-care-of-redo ,beg ,end ,snippet)
+ (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
buffer-undo-list))))
-(defun yas/snippet-create (begin end)
+(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)))
+ (let ((snippet (yas--make-snippet)))
(goto-char begin)
- (yas/snippet-parse-create snippet)
+ (yas--snippet-parse-create snippet)
;; Sort and link each field
- (yas/snippet-sort-fields snippet)
+ (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)))
+ (setf (yas--snippet-control-overlay snippet)
+ (yas--make-control-overlay snippet (point-min) (point-max)))
;; Move to end
(goto-char (point-max))
;; 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.
+;; fields-or-mirrors-or-exit (which I have abbreviated to "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
+;; 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))
+(defun yas--fom-start (fom)
+ (cond ((yas--field-p fom)
+ (yas--field-start fom))
+ ((yas--mirror-p fom)
+ (yas--mirror-start fom))
(t
- (yas/exit-marker 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))
+(defun yas--fom-end (fom)
+ (cond ((yas--field-p fom)
+ (yas--field-end fom))
+ ((yas--mirror-p fom)
+ (yas--mirror-end fom))
(t
- (yas/exit-marker 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))
+(defun yas--fom-next (fom)
+ (cond ((yas--field-p fom)
+ (yas--field-next fom))
+ ((yas--mirror-p fom)
+ (yas--mirror-next fom))
(t
- (yas/exit-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--fom-parent-field (fom)
+ (cond ((yas--field-p fom)
+ (yas--field-parent-field fom))
+ ((yas--mirror-p fom)
+ (yas--mirror-parent-field fom))
(t
nil)))
-(defun yas/calculate-adjacencies (snippet)
+(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))
+ (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))
(t
- (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
+ (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))
+ (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))
+ (dolist (mirror (yas--field-mirrors field))
(push mirror soup)))
(setq soup
(sort soup
- #'yas/compare-fom-begs))
+ #'yas--compare-fom-begs))
(when soup
- (reduce #'yas/link-foms soup)))))
+ (reduce #'yas--link-foms soup)))))
-(defun yas/calculate-mirrors-in-fields (snippet mirror)
+(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
+Use the tightest containing field if more than one field contains
+the mirror. Intended to be called *before* the dollar-regions are
deleted."
(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)
+ (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.
+* call `yas--advance-start-maybe' on FOM's next fom.
-* in case FOM is field call `yas/advance-end-maybe' on its parent
+* in case FOM is field call `yas--advance-end-maybe' on its parent
field
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)
+`yas--advance-start-maybe' on its next fom. This is because
+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)))
+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.
+(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)))
+ (< (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
+(defvar yas--dollar-regions nil
"When expanding the snippet the \"parse-create\" functions add
- cons cells to this var")
+cons cells to this var.")
+
+(defvar yas--backquote-markers-and-strings nil
+ "List of (MARKER . STRING) marking where the values from
+backquoted lisp expressions should be inserted at the end of
+expansion.")
-(defun yas/snippet-parse-create (snippet)
+(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
+ ;; Reset the yas--dollar-regions
;;
- (setq yas/dollar-regions nil)
- ;; protect escaped quote, backquotes and backslashes
+ (setq yas--dollar-regions nil)
+ ;; protect just the backquotes
;;
- (yas/protect-escapes nil `(?\\ ?` ?'))
+ (yas--protect-escapes nil '(?`))
;; replace all backquoted expressions
;;
(goto-char parse-start)
- (yas/replace-backquotes)
- ;; protect escapes again since previous steps might have generated
- ;; more characters needing escaping
+ (yas--save-backquotes)
+ ;; protect escaped characters
;;
- (goto-char parse-start)
- (yas/protect-escapes)
+ (yas--protect-escapes)
;; parse fields with {}
;;
(goto-char parse-start)
- (yas/field-parse-create snippet)
+ (yas--field-parse-create snippet)
;; parse simple mirrors and fields
;;
(goto-char parse-start)
- (yas/simple-mirror-parse-create snippet)
+ (yas--simple-mirror-parse-create snippet)
;; parse mirror transforms
;;
(goto-char parse-start)
- (yas/transform-mirror-parse-create snippet)
+ (yas--transform-mirror-parse-create snippet)
;; calculate adjacencies of fields and mirrors
;;
- (yas/calculate-adjacencies snippet)
+ (yas--calculate-adjacencies snippet)
;; Delete $-constructs
;;
- (yas/delete-regions yas/dollar-regions)
+ (yas--delete-regions yas--dollar-regions)
+ ;; restore backquoted expression values
+ ;;
+ (yas--restore-backquotes)
;; restore escapes
;;
(goto-char parse-start)
- (yas/restore-escapes)
+ (yas--restore-escapes)
;; update mirrors for the first time
;;
- (yas/update-mirrors snippet)
+ (yas--update-mirrors snippet)
;; indent the best we can
;;
(goto-char parse-start)
- (yas/indent snippet)))
+ (yas--indent snippet)))
-(defun yas/indent-according-to-mode (snippet-markers)
- "Indent current line according to mode, preserving
-SNIPPET-MARKERS."
+(defun yas--indent-according-to-mode (snippet-markers)
+ "Indent current line according to mode, preserving SNIPPET-MARKERS."
;;; Apropos indenting problems....
;;
;; `indent-according-to-mode' uses whatever `indent-line-function'
;;
;; 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
+ ;; (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))
+ (goto-char (yas--real-line-beginning))
(let ((trouble-markers (remove-if-not #'(lambda (marker)
(= marker (point)))
snippet-markers)))
(widen)
(condition-case err
(indent-according-to-mode)
- (error (yas/message 3 "Warning: `yas/indent-according-to-mode' having problems running %s" indent-line-function)
+ (error (yas--message 3 "Warning: `yas--indent-according-to-mode' having problems running %s" indent-line-function)
nil)))
(mapc #'(lambda (marker)
(set-marker marker (point)))
trouble-markers)))
-(defvar yas/indent-original-column nil)
-(defun yas/indent (snippet)
- (let ((snippet-markers (yas/collect-snippet-markers snippet)))
+(defvar yas--indent-original-column nil)
+(defun yas--indent (snippet)
+ (let ((snippet-markers (yas--collect-snippet-markers snippet)))
;; Look for those $>
(save-excursion
(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))))
+ (when (not (eq yas-indent-line 'auto))
+ (yas--indent-according-to-mode snippet-markers))))
;; Now do stuff for 'fixed and 'auto
(save-excursion
- (cond ((eq yas/indent-line 'fixed)
+ (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)
+ (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))
+ (indent-first-line-p yas-also-auto-indent-first-line))
(while (and (zerop (if indent-first-line-p
(prog1
(forward-line 0)
(forward-line 1)))
(not (eobp))
(<= (point) end))
- (yas/indent-according-to-mode snippet-markers))))
+ (yas--indent-according-to-mode snippet-markers))))
(t
nil)))))
-(defun yas/collect-snippet-markers (snippet)
+(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)))
+ (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)))
+ (marker-buffer (yas--exit-marker snippet-exit)))
+ (push (yas--exit-marker snippet-exit) markers)))
markers))
-(defun yas/real-line-beginning ()
+(defun yas--real-line-beginning ()
(let ((c (char-after (line-beginning-position)))
(n (line-beginning-position)))
(while (or (eql c ?\ )
(setq c (char-after n)))
n))
-(defun yas/escape-string (escaped)
+(defun yas--escape-string (escaped)
(concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
-(defun yas/protect-escapes (&optional text escaped)
+(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."
(text-provided-p text))
(mapc #'(lambda (escaped)
(setq changed-text
- (yas/replace-all (concat "\\" (char-to-string escaped))
- (yas/escape-string escaped)
+ (yas--replace-all (concat "\\" (char-to-string escaped))
+ (yas--escape-string escaped)
(when text-provided-p changed-text))))
- (or escaped yas/escaped-characters))
+ (or escaped yas--escaped-characters))
changed-text))
-(defun yas/restore-escapes (&optional text escaped)
+(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."
(text-provided-p text))
(mapc #'(lambda (escaped)
(setq changed-text
- (yas/replace-all (yas/escape-string escaped)
+ (yas--replace-all (yas--escape-string escaped)
(char-to-string escaped)
(when text-provided-p changed-text))))
- (or escaped yas/escaped-characters))
+ (or escaped yas--escaped-characters))
changed-text))
-(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)
+(defun yas--save-backquotes ()
+ "Save all the \"`(lisp-expression)`\"-style expressions
+with their evaluated value into `yas--backquote-markers-and-strings'."
+ (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
+ (let ((current-string (match-string-no-properties 1)) transformed)
(delete-region (match-beginning 0) (match-end 0))
- (setq transformed (yas/eval-lisp (yas/read-lisp (yas/restore-escapes current-string))))
+ (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
(goto-char (match-beginning 0))
- (when transformed (insert transformed)))))
+ (when transformed
+ (let ((marker (make-marker)))
+ (insert "Y") ;; quite horrendous, I love it :)
+ (set-marker marker (point))
+ (insert "Y")
+ (push (cons marker transformed) yas--backquote-markers-and-strings))))))
+
+(defun yas--restore-backquotes ()
+ "Replace markers in `yas--backquote-markers-and-strings' with their values."
+ (while yas--backquote-markers-and-strings
+ (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
+ (marker (car marker-and-string))
+ (string (cdr marker-and-string)))
+ (save-excursion
+ (goto-char marker)
+ (delete-char -1)
+ (insert string)
+ (delete-char 1)
+ (set-marker marker nil)))))
-(defun yas/scan-sexps (from count)
+(defun yas--scan-sexps (from count)
(condition-case err
(with-syntax-table (standard-syntax-table)
(scan-sexps from count))
(error
nil)))
-(defun yas/make-marker (pos)
- "Create a marker at POS with `nil' `marker-insertion-type'"
+(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)
marker))
-(defun yas/field-parse-create (snippet &optional parent-field)
- "Parse most field expressions, except for the simple one \"$n\".
+(defun yas--field-parse-create (snippet &optional parent-field)
+ "Parse most field expressions in SNIPPET, 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'
+ 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."
;;
(save-excursion
- (while (re-search-forward yas/field-regexp nil t)
- (let* ((real-match-end-0 (yas/scan-sexps (1+ (match-beginning 0)) 1))
+ (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
(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))
+ (yas--make-field number
+ (yas--make-marker (match-beginning 2))
+ (yas--make-marker (1- real-match-end-0))
parent-field))))
(when brand-new-field
(goto-char real-match-end-0)
(push (cons (1- real-match-end-0) real-match-end-0)
- yas/dollar-regions)
+ yas--dollar-regions)
(push (cons (match-beginning 0) (match-beginning 2))
- yas/dollar-regions)
- (push brand-new-field (yas/snippet-fields snippet))
+ yas--dollar-regions)
+ (push brand-new-field (yas--snippet-fields snippet))
(save-excursion
(save-restriction
- (narrow-to-region (yas/field-start brand-new-field) (yas/field-end brand-new-field))
+ (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)))))))
+ (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
+ ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
;; primary field transformations
;;
(when parent-field
(save-excursion
- (while (re-search-forward yas/multi-dollar-lisp-expression-regexp nil t)
- (let* ((real-match-end-1 (yas/scan-sexps (match-beginning 1) 1)))
+ (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:
;;
- ;; 1. we don't find it in yas/dollar-regions (a subnested
+ ;; 1. we don't find it in yas--dollar-regions (a subnested
;; field) might have already caught it.
;;
;; 2. we really make sure we have either two '$' or some
(when (and real-match-end-1
(not (member (cons (match-beginning 0)
real-match-end-1)
- yas/dollar-regions))
+ yas--dollar-regions))
(not (eq ?:
(char-before (1- (match-beginning 1))))))
(let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
real-match-end-1)))
- (setf (yas/field-transform parent-field)
- (yas/read-lisp (yas/restore-escapes lisp-expression-string))))
+ (setf (yas--field-transform parent-field)
+ (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
(push (cons (match-beginning 0) real-match-end-1)
- yas/dollar-regions)))))))
+ yas--dollar-regions)))))))
-(defun yas/transform-mirror-parse-create (snippet)
- "Parse the \"${n:$(lisp-expression)}\" mirror transformations."
- (while (re-search-forward yas/transform-mirror-regexp nil t)
- (let* ((real-match-end-0 (yas/scan-sexps (1+ (match-beginning 0)) 1))
+(defun yas--transform-mirror-parse-create (snippet)
+ "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
+ (while (re-search-forward yas--transform-mirror-regexp nil t)
+ (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
(number (string-to-number (match-string-no-properties 1)))
(field (and number
(not (zerop number))
- (yas/snippet-find-field snippet number)))
+ (yas--snippet-find-field snippet number)))
(brand-new-mirror
(and real-match-end-0
field
- (yas/make-mirror (yas/make-marker (match-beginning 0))
- (yas/make-marker (match-beginning 0))
- (yas/read-lisp
- (yas/restore-escapes
+ (yas--make-mirror (yas--make-marker (match-beginning 0))
+ (yas--make-marker (match-beginning 0))
+ (yas--read-lisp
+ (yas--restore-escapes
(buffer-substring-no-properties (match-beginning 2)
(1- real-match-end-0))))))))
(when brand-new-mirror
(push brand-new-mirror
- (yas/field-mirrors field))
- (yas/calculate-mirrors-in-fields snippet brand-new-mirror)
- (push (cons (match-beginning 0) real-match-end-0) yas/dollar-regions)))))
+ (yas--field-mirrors field))
+ (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
+ (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
-(defun yas/simple-mirror-parse-create (snippet)
- "Parse the simple \"$n\" fields/mirrors/exitmarkers."
- (while (re-search-forward yas/simple-mirror-regexp nil t)
+(defun yas--simple-mirror-parse-create (snippet)
+ "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
+ (while (re-search-forward yas--simple-mirror-regexp nil t)
(let ((number (string-to-number (match-string-no-properties 1))))
(cond ((zerop number)
- (setf (yas/snippet-exit snippet)
- (yas/make-exit (yas/make-marker (match-end 0))))
+ (setf (yas--snippet-exit snippet)
+ (yas--make-exit (yas--make-marker (match-end 0))))
(save-excursion
(goto-char (match-beginning 0))
- (when yas/wrap-around-region
- (cond (yas/selected-text
- (insert yas/selected-text))
- ((and (eq yas/wrap-around-region 'cua)
+ (when yas-wrap-around-region
+ (cond (yas-selected-text
+ (insert yas-selected-text))
+ ((and (eq yas-wrap-around-region 'cua)
cua-mode
(get-register ?0))
(insert (prog1 (get-register ?0)
(set-register ?0 nil))))))
- (push (cons (point) (yas/exit-marker (yas/snippet-exit snippet)))
- yas/dollar-regions)))
+ (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
+ yas--dollar-regions)))
(t
- (let ((field (yas/snippet-find-field snippet number)))
+ (let ((field (yas--snippet-find-field snippet number)))
(if field
- (let ((brand-new-mirror (yas/make-mirror
- (yas/make-marker (match-beginning 0))
- (yas/make-marker (match-beginning 0))
+ (let ((brand-new-mirror (yas--make-mirror
+ (yas--make-marker (match-beginning 0))
+ (yas--make-marker (match-beginning 0))
nil)))
(push brand-new-mirror
- (yas/field-mirrors field))
- (yas/calculate-mirrors-in-fields snippet brand-new-mirror))
- (push (yas/make-field number
- (yas/make-marker (match-beginning 0))
- (yas/make-marker (match-beginning 0))
+ (yas--field-mirrors field))
+ (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
+ (push (yas--make-field number
+ (yas--make-marker (match-beginning 0))
+ (yas--make-marker (match-beginning 0))
nil)
- (yas/snippet-fields snippet))))
+ (yas--snippet-fields snippet))))
(push (cons (match-beginning 0) (match-end 0))
- yas/dollar-regions))))))
+ yas--dollar-regions))))))
-(defun yas/delete-regions (regions)
+(defun yas--delete-regions (regions)
"Sort disjuct REGIONS by start point, then delete from the back."
(mapc #'(lambda (reg)
(delete-region (car reg) (cdr reg)))
#'(lambda (r1 r2)
(>= (car r1) (car r2))))))
-(defun yas/update-mirrors (snippet)
+(defun yas--update-mirrors (snippet)
"Updates all the mirrors of SNIPPET."
(save-excursion
- (let* ((fields (copy-list (yas/snippet-fields snippet)))
- (field (car fields)))
- (while field
- (dolist (mirror (yas/field-mirrors field))
- (let ((mirror-parent-field (yas/mirror-parent-field mirror)))
- ;; updatte this mirror
- ;;
- (yas/mirror-update-display mirror field)
- ;; for mirrors-in-fields: schedule a possible
- ;; parent field for reupdting later on
- ;;
- (when mirror-parent-field
- (add-to-list 'fields mirror-parent-field 'append #'eq))
- ;; `yas/place-overlays' is needed if the active field and
- ;; protected overlays have been changed because of insertions
- ;; in `yas/mirror-update-display'
- ;;
- (when (eq field (yas/snippet-active-field snippet))
- (yas/place-overlays snippet field))))
- (setq fields (cdr fields))
- (setq field (car fields))))))
-
-(defun yas/mirror-update-display (mirror field)
+ (dolist (field-and-mirror (sort
+ ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
+ ;; where F is the field that M is mirroring
+ ;;
+ (mapcan #'(lambda (field)
+ (mapcar #'(lambda (mirror)
+ (cons field mirror))
+ (yas--field-mirrors field)))
+ (yas--snippet-fields snippet))
+ ;; then sort this list so that entries with mirrors with parent
+ ;; fields appear before. This was important for fixing #290, and
+ ;; luckily also handles the case where a mirror in a field causes
+ ;; another mirror to need reupdating
+ ;;
+ #'(lambda (field-and-mirror1 field-and-mirror2)
+ (yas--mirror-parent-field (cdr field-and-mirror1)))))
+ (let* ((field (car field-and-mirror))
+ (mirror (cdr field-and-mirror))
+ (parent-field (yas--mirror-parent-field mirror)))
+ ;; before updating a mirror with a parent-field, maybe advance
+ ;; its start (#290)
+ ;;
+ (when parent-field
+ (yas--advance-start-maybe mirror (yas--fom-start parent-field)))
+ ;; update this mirror
+ ;;
+ (yas--mirror-update-display mirror field)
+ ;; `yas--place-overlays' is needed if the active field and
+ ;; protected overlays have been changed because of insertions
+ ;; in `yas--mirror-update-display'
+ ;;
+ (when (eq field (yas--snippet-active-field snippet))
+ (yas--place-overlays snippet field))))))
+
+(defun yas--mirror-update-display (mirror field)
"Update MIRROR according to FIELD (and mirror transform)."
- (let* ((mirror-parent-field (yas/mirror-parent-field mirror))
+ (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
(reflection (and (not (and mirror-parent-field
- (yas/field-modified-p mirror-parent-field)))
- (or (yas/apply-transform mirror field 'empty-on-nil)
- (yas/field-text-for-display field)))))
+ (yas--field-modified-p mirror-parent-field)))
+ (or (yas--apply-transform mirror field 'empty-on-nil)
+ (yas--field-text-for-display field)))))
(when (and reflection
- (not (string= reflection (buffer-substring-no-properties (yas/mirror-start mirror)
- (yas/mirror-end mirror)))))
- (goto-char (yas/mirror-start mirror))
- (yas/inhibit-overlay-hooks
+ (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
+ (yas--mirror-end mirror)))))
+ (goto-char (yas--mirror-start mirror))
+ (yas--inhibit-overlay-hooks
(insert reflection))
- (if (> (yas/mirror-end mirror) (point))
- (delete-region (point) (yas/mirror-end mirror))
- (set-marker (yas/mirror-end mirror) (point))
- (yas/advance-start-maybe (yas/mirror-next mirror) (point))
+ (if (> (yas--mirror-end mirror) (point))
+ (delete-region (point) (yas--mirror-end mirror))
+ (set-marker (yas--mirror-end mirror) (point))
+ (yas--advance-start-maybe (yas--mirror-next mirror) (point))
;; super-special advance
- (yas/advance-end-of-parents-maybe mirror-parent-field (point))))))
+ (yas--advance-end-of-parents-maybe mirror-parent-field (point))))))
-(defun yas/field-update-display (field snippet)
- "Much like `yas/mirror-update-display', but for fields"
- (when (yas/field-transform field)
- (let ((transformed (and (not (eq (yas/field-number field) 0))
- (yas/apply-transform field field)))
+(defun yas--field-update-display (field snippet)
+ "Much like `yas--mirror-update-display', but for fields."
+ (when (yas--field-transform field)
+ (let ((transformed (and (not (eq (yas--field-number field) 0))
+ (yas--apply-transform field field)))
(point (point)))
(when (and transformed
- (not (string= transformed (buffer-substring-no-properties (yas/field-start field)
- (yas/field-end field)))))
- (setf (yas/field-modified-p field) t)
- (goto-char (yas/field-start field))
- (yas/inhibit-overlay-hooks
+ (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
+ (yas--field-end field)))))
+ (setf (yas--field-modified-p field) t)
+ (goto-char (yas--field-start field))
+ (yas--inhibit-overlay-hooks
(insert transformed)
- (if (> (yas/field-end field) (point))
- (delete-region (point) (yas/field-end field))
- (set-marker (yas/field-end field) (point))
- (yas/advance-start-maybe (yas/field-next field) (point)))
+ (if (> (yas--field-end field) (point))
+ (delete-region (point) (yas--field-end field))
+ (set-marker (yas--field-end field) (point))
+ (yas--advance-start-maybe (yas--field-next field) (point)))
t)))))
\f
-;;; Post-command hooks:
+;;; Post-command hook:
-(defvar yas/post-command-runonce-actions nil
- "List of actions to run once in `post-command-hook'.
-
-Each element of this list looks like (FN . ARGS) where FN is
-called with ARGS as its arguments after the currently executing
-snippet command.
-
-After all actions have been run, this list is emptied, and after
-that the rest of `yas/post-command-handler' runs.")
-
-(defun yas/post-command-handler ()
+(defun yas--post-command-handler ()
"Handles various yasnippet conditions after each command."
- (when yas/post-command-runonce-actions
- (condition-case err
- (mapc #'(lambda (fn-and-args)
- (apply (car fn-and-args)
- (cdr fn-and-args)))
- yas/post-command-runonce-actions)
- (error (yas/message 3 "Problem running `yas/post-command-runonce-actions'!")))
- (setq yas/post-command-runonce-actions nil))
- (cond (yas/protection-violation
- (goto-char yas/protection-violation)
- (setq yas/protection-violation nil))
+ (cond (yas--protection-violation
+ (goto-char yas--protection-violation)
+ (setq yas--protection-violation nil))
((eq 'undo this-command)
;;
;; After undo revival the correct field is sometimes not
;; restored correctly, this condition handles that
;;
- (let* ((snippet (car (yas/snippets-at-point)))
+ (let* ((snippet (car (yas--snippets-at-point)))
(target-field (and snippet
(find-if-not #'(lambda (field)
- (yas/field-probably-deleted-p snippet field))
+ (yas--field-probably-deleted-p snippet field))
(remove nil
- (cons (yas/snippet-active-field snippet)
- (yas/snippet-fields snippet)))))))
+ (cons (yas--snippet-active-field snippet)
+ (yas--snippet-fields snippet)))))))
(when target-field
- (yas/move-to-field snippet target-field))))
- ((not (yas/undo-in-progress))
+ (yas--move-to-field snippet target-field))))
+ ((not (yas--undo-in-progress))
;; When not in an undo, check if we must commit the snippet
;; (user exited it).
- (yas/check-commit-snippet))))
+ (yas--check-commit-snippet))))
\f
;;; Fancy docs:
-
-(put 'yas/expand 'function-documentation
- '(yas/expand-from-trigger-key-doc))
-(defun yas/expand-from-trigger-key-doc ()
- "A doc synthethizer for `yas/expand-from-trigger-key-doc'."
+;;
+;; The docstrings for some functions are generated dynamically
+;; depending on the context.
+;;
+(put 'yas-expand 'function-documentation
+ '(yas--expand-from-trigger-key-doc))
+(defun yas--expand-from-trigger-key-doc ()
+ "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
(let ((fallback-description
- (cond ((eq yas/fallback-behavior 'call-other-command)
- (let* ((yas/minor-mode nil)
- (fallback (key-binding (read-kbd-macro yas/trigger-key))))
+ (cond ((eq yas-fallback-behavior 'call-other-command)
+ (let* ((fallback (yas--keybinding-beyond-yasnippet)))
(or (and fallback
(format " call command `%s'." (pp-to-string fallback)))
- " do nothing.")))
- ((eq yas/fallback-behavior 'return-nil)
+ " do nothing (`yas-expand' doesn't shadow\nanything)")))
+ ((eq yas-fallback-behavior 'return-nil)
", do nothing.")
(t
- ", defer to `yas/fallback-behaviour' :-)"))))
+ ", defer to `yas-fallback-behaviour' (which see)"))))
(concat "Expand a snippet before point. If no snippet
expansion is possible,"
fallback-description
"\n\nOptional argument FIELD is for non-interactive use and is an
-object satisfying `yas/field-p' to restrict the expansion to.")))
+object satisfying `yas--field-p' to restrict the expansion to.")))
-(put 'yas/expand-from-keymap 'function-documentation '(yas/expand-from-keymap-doc))
-(defun yas/expand-from-keymap-doc ()
- "A doc synthethizer for `yas/expand-from-keymap-doc'."
- (add-hook 'temp-buffer-show-hook 'yas/snippet-description-finish-runonce)
+(put 'yas-expand-from-keymap 'function-documentation '(yas--expand-from-keymap-doc))
+(defun yas--expand-from-keymap-doc ()
+ "A doc synthesizer for `yas--expand-from-keymap-doc'."
+ (add-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce)
(concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
(when (eq this-command 'describe-key)
(let* ((vec (this-single-command-keys))
(templates (mapcan #'(lambda (table)
- (yas/fetch table vec))
- (yas/get-snippet-tables)))
- (yas/direct-keymaps nil)
+ (yas--fetch table vec))
+ (yas--get-snippet-tables)))
+ (yas--direct-keymaps nil)
(fallback (key-binding vec)))
(concat "In this case, "
(when templates
(concat "these snippets are bound to this key:\n"
- (yas/template-pretty-list templates)
+ (yas--template-pretty-list templates)
"\n\nIf none of these expands, "))
(or (and fallback
(format "fallback `%s' will be called." (pp-to-string fallback)))
"no fallback keybinding is called."))))))
-(defun yas/template-pretty-list (templates)
+(defun yas--template-pretty-list (templates)
(let ((acc)
- (yas/buffer-local-condition 'always))
+ (yas-buffer-local-condition 'always))
(dolist (plate templates)
(setq acc (concat acc "\n*) "
(propertize (concat "\\\\snippet `" (car plate) "'")
(define-button-type 'help-snippet-def
:supertype 'help-xref
- 'help-function (lambda (template) (yas/visit-snippet-file-1 template))
+ 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
-(defun yas/snippet-description-finish-runonce ()
+(defun yas--snippet-description-finish-runonce ()
"Final adjustments for the help buffer when snippets are concerned."
- (yas/create-snippet-xrefs)
- (remove-hook 'temp-buffer-show-hook 'yas/snippet-description-finish-runonce))
+ (yas--create-snippet-xrefs)
+ (remove-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce))
-(defun yas/create-snippet-xrefs ()
+(defun yas--create-snippet-xrefs ()
(save-excursion
(goto-char (point-min))
(while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
(kill-region (match-end 1) (match-end 0))
(kill-region (match-beginning 0) (match-beginning 1)))))))
-(defun yas/expand-uuid (mode-symbol uuid &optional start end expand-env)
+(defun yas--expand-uuid (mode-symbol uuid &optional start end expand-env)
"Expand a snippet registered in MODE-SYMBOL's table with UUID.
-Remaining args as in `yas/expand-snippet'."
- (let* ((table (gethash mode-symbol yas/tables))
- (yas/current-template (and table
- (gethash uuid (yas/table-uuidhash table)))))
- (when yas/current-template
- (yas/expand-snippet (yas/template-content yas/current-template)))))
+Remaining args as in `yas-expand-snippet'."
+ (let* ((table (gethash mode-symbol yas--tables))
+ (yas--current-template (and table
+ (gethash uuid (yas--table-uuidhash table)))))
+ (when yas--current-template
+ (yas-expand-snippet (yas--template-content yas--current-template)))))
\f
;;; Utils
-;;;
-(defvar yas/verbosity 4
- "Log level for `yas/message' 4 means trace most anything, 0 means nothing.")
-(defun yas/message (level message &rest args)
- (when (> yas/verbosity level)
- (message (apply #'yas/format message args))))
+(defvar yas-verbosity 4
+ "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
+
+(defun yas--message (level message &rest args)
+ "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
+ (when (> yas-verbosity level)
+ (message (apply #'yas--format message args))))
-(defun yas/format (format-control &rest format-args)
+(defun yas--format (format-control &rest format-args)
(apply #'format (concat "[yas] " format-control) format-args))
\f
;;; Some hacks:
-;;;
+;;
+;; The functions
+;;
;; `locate-dominating-file'
;; `region-active-p'
;;
-;; added for compatibility in emacs < 23
+;; added for compatibility in emacsen < 23
(unless (>= emacs-major-version 23)
(unless (fboundp 'region-active-p)
(defun region-active-p () (and transient-mark-mode mark-active)))
;; # type inside `<>`
(defadvice c-neutralize-syntax-in-CPP
- (around yas-mp/c-neutralize-syntax-in-CPP activate)
+ (around yas--mp/c-neutralize-syntax-in-CPP activate)
"Adviced `c-neutralize-syntax-in-CPP' to properly
handle the end-of-buffer error fired in it by calling
`forward-char' at the end of buffer."
(add-hook 'c-mode-common-hook
'(lambda ()
(dolist (k '(":" ">" ";" "<" "{" "}"))
- (define-key (symbol-value (make-local-variable 'yas/keymap))
+ (define-key (symbol-value (make-local-variable 'yas-keymap))
k 'self-insert-command))))
+\f
+;;; Backward compatibility to yasnippet <= 0.7
+(defvar yas--exported-syms '(;; `defcustom's
+ ;;
+ yas-snippet-dirs
+ yas-prompt-functions
+ yas-indent-line
+ yas-also-auto-indent-first-line
+ yas-snippet-revival
+ yas-triggers-in-field
+ yas-fallback-behavior
+ yas-choose-keys-first
+ yas-choose-tables-first
+ yas-use-menu
+ yas-trigger-symbol
+ yas-wrap-around-region
+ yas-good-grace
+ yas-visit-from-menu
+ yas-expand-only-for-last-commands
+ yas-field-highlight-face
+
+ ;; these vars can be customized as well
+ ;;
+ yas-keymap
+ yas-verbosity
+ yas-extra-modes
+ yas-key-syntaxes
+ yas-after-exit-snippet-hook
+ yas-before-expand-snippet-hook
+ yas-buffer-local-condition
+
+ ;; prompting functions
+ ;;
+ yas-x-prompt
+ yas-ido-prompt
+ yas-no-prompt
+ yas-completing-prompt
+ yas-dropdown-prompt
+
+ ;; interactive functions
+ ;;
+ yas-expand
+ yas-minor-mode
+ yas-global-mode
+ yas-direct-keymaps-reload
+ yas-minor-mode-on
+ yas-load-directory
+ yas-reload-all
+ yas-compile-directory
+ yas-recompile-all
+ yas-about
+ yas-expand-from-trigger-key
+ yas-expand-from-keymap
+ yas-insert-snippet
+ yas-visit-snippet-file
+ yas-new-snippet
+ yas-load-snippet-buffer
+ yas-tryout-snippet
+ yas-describe-tables
+ yas-next-field-or-maybe-expand
+ yas-next-field
+ yas-prev-field
+ yas-abort-snippet
+ yas-exit-snippet
+ yas-exit-all-snippets
+ yas-skip-and-clear-or-delete-char
+
+ ;; symbols that I "exported" for use
+ ;; in snippets and hookage
+ ;;
+ yas-expand-snippet
+ yas-define-snippets
+ yas-define-menu
+ yas-snippet-beg
+ yas-snippet-end
+ yas-modified-p
+ yas-moving-away-p
+ yas-text
+ yas-substr
+ yas-choose-value
+ yas-key-to-value
+ yas-throw
+ yas-verify-value
+ yas-field-value
+ yas-text
+ yas-selected-text
+ yas-default-from-field
+ yas-inside-string
+ yas-unimplemented
+ yas-define-condition-cache
+ yas-hippie-try-expand
+ yas-active-keys
+
+ ;; debug definitions
+ ;; yas-debug-snippet-vars
+ ;; yas-exterminate-package
+ ;; yas-debug-test
+
+ ;; testing definitions
+ ;; yas-should-expand
+ ;; yas-should-not-expand
+ ;; yas-mock-insert
+ ;; yas-make-file-or-dirs
+ ;; yas-variables
+ ;; yas-saving-variables
+ ;; yas-call-with-snippet-dirs
+ ;; yas-with-snippet-dirs
+)
+ "Exported yasnippet symbols.
+
+i.e. ones that I will try to keep in future yasnippet versions
+and ones that other elisp libraries can more or less safely rely
+upon.")
+
+(defvar yas--dont-backport '(yas-active-keys)
+ "Exported symbols that don't map back to \"yas/*\" variants.")
+
+(dolist (sym (set-difference yas--exported-syms yas--dont-backport))
+ (let ((backported (intern (replace-regexp-in-string "^yas-" "yas/" (symbol-name sym)))))
+ (when (boundp sym)
+ (make-obsolete-variable backported sym "yasnippet 0.8")
+ (defvaralias backported sym))
+ (when (fboundp sym)
+ (make-obsolete backported sym "yasnippet 0.8")
+ (defalias backported sym))))
+\f
(provide 'yasnippet)
;;; yasnippet.el ends here
;; Local Variables:
;; coding: utf-8
+;; byte-compile-warnings: (not cl-functions)
;; End: