lotsa changes
[emacs.git] / .emacs.d / elisp / yasnippet / yasnippet.el
1 ;;; yasnippet.el --- Yet another snippet extension for Emacs.
2
3 ;; Copyright (C) 2008-2012 Free Software Foundation, Inc.
4 ;; Authors: pluskid <pluskid@gmail.com>, João Távora <joaotavora@gmail.com>
5 ;; Version: 0.8.0
6 ;; Package-version: 0.8.0
7 ;; X-URL: http://github.com/capitaomorte/yasnippet
8 ;; Keywords: convenience, emulation
9 ;; URL: http://github.com/capitaomorte/yasnippet
10 ;; EmacsWiki: YaSnippetMode
11
12 ;; This program is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
16
17 ;; This program is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
24
25 ;;; Commentary:
26 ;;
27 ;; Basic steps to setup:
28 ;;
29 ;; (add-to-list 'load-path
30 ;; "~/path-to-yasnippet")
31 ;; (require 'yasnippet)
32 ;; (yas-global-mode 1)
33 ;;
34 ;;
35 ;; Interesting variables are:
36 ;;
37 ;; `yas-snippet-dirs'
38 ;;
39 ;; The directory where user-created snippets are to be
40 ;; stored. Can also be a list of directories. In that case,
41 ;; when used for bulk (re)loading of snippets (at startup or
42 ;; via `yas-reload-all'), directories appearing earlier in
43 ;; the list shadow other dir's snippets. Also, the first
44 ;; directory is taken as the default for storing the user's
45 ;; new snippets.
46 ;;
47 ;; The deprecated `yas/root-directory' aliases this variable
48 ;; for backward-compatibility.
49 ;;
50 ;; `yas-extra-modes'
51 ;;
52 ;; A local variable that you can set in a hook to override
53 ;; snippet-lookup based on major mode. It is a symbol (or
54 ;; list of symbols) that correspond to subdirectories of
55 ;; `yas-snippet-dirs' and is used for deciding which
56 ;; snippets to consider for the active buffer.
57 ;;
58 ;; Deprecated `yas/mode-symbol' aliases this variable for
59 ;; backward-compatibility.
60 ;;
61 ;; Major commands are:
62 ;;
63 ;; M-x yas-expand
64 ;;
65 ;; Try to expand snippets before point. In `yas-minor-mode',
66 ;; this is normally bound to TAB, but you can customize it in
67 ;; `yas-minor-mode-map'.
68 ;;
69 ;; M-x yas-load-directory
70 ;;
71 ;; Prompts you for a directory hierarchy of snippets to load.
72 ;;
73 ;; M-x yas-insert-snippet
74 ;;
75 ;; Prompts you for possible snippet expansion if that is
76 ;; possible according to buffer-local and snippet-local
77 ;; expansion conditions. With prefix argument, ignore these
78 ;; conditions.
79 ;;
80 ;; M-x yas-visit-snippet-file
81 ;;
82 ;; Prompts you for possible snippet expansions like
83 ;; `yas-insert-snippet', but instead of expanding it, takes
84 ;; you directly to the snippet definition's file, if it
85 ;; exists.
86 ;;
87 ;; M-x yas-new-snippet
88 ;;
89 ;; Lets you create a new snippet file in the correct
90 ;; subdirectory of `yas-snippet-dirs', according to the
91 ;; active major mode.
92 ;;
93 ;; M-x yas-load-snippet-buffer
94 ;;
95 ;; When editing a snippet, this loads the snippet. This is
96 ;; bound to "C-c C-c" while in the `snippet-mode' editing
97 ;; mode.
98 ;;
99 ;; M-x yas-tryout-snippet
100 ;;
101 ;; When editing a snippet, this opens a new empty buffer,
102 ;; sets it to the appropriate major mode and inserts the
103 ;; snippet there, so you can see what it looks like. This is
104 ;; bound to "C-c C-t" while in `snippet-mode'.
105 ;;
106 ;; M-x yas-describe-tables
107 ;;
108 ;; Lists known snippets in a separate buffer. User is
109 ;; prompted as to whether only the currently active tables
110 ;; are to be displayed, or all the tables for all major
111 ;; modes.
112 ;;
113 ;; The `dropdown-list.el' extension is bundled with YASnippet, you
114 ;; can optionally use it the preferred "prompting method", putting in
115 ;; your .emacs file, for example:
116 ;;
117 ;; (require 'dropdown-list)
118 ;; (setq yas-prompt-functions '(yas-dropdown-prompt
119 ;; yas-ido-prompt
120 ;; yas-completing-prompt))
121 ;;
122 ;; Also check out the customization group
123 ;;
124 ;; M-x customize-group RET yasnippet RET
125 ;;
126 ;; If you use the customization group to set variables
127 ;; `yas-snippet-dirs' or `yas-global-mode', make sure the path to
128 ;; "yasnippet.el" is present in the `load-path' *before* the
129 ;; `custom-set-variables' is executed in your .emacs file.
130 ;;
131 ;; For more information and detailed usage, refer to the project page:
132 ;; http://github.com/capitaomorte/yasnippet
133
134 ;;; Code:
135
136 (require 'cl)
137 (require 'easymenu)
138 (require 'help-mode)
139
140 (eval-when-compile
141 (defvar yas--editing-template)
142 (defvar yas--guessed-modes)
143 (defvar yas--indent-original-column)
144 (defvar yas--scheduled-jit-loads)
145 (defvar yas-keymap)
146 (defvar yas-selected-text)
147 (defvar yas-verbosity))
148
149
150 \f
151 ;;; User customizable variables
152
153 (defgroup yasnippet nil
154 "Yet Another Snippet extension"
155 :group 'editing)
156
157 (defvar yas--load-file-name load-file-name
158 "Store the filename that yasnippet.el was originally loaded from.")
159
160 (defcustom yas-snippet-dirs (remove nil
161 (list "~/.emacs.d/snippets"
162 (when yas--load-file-name
163 (concat (file-name-directory yas--load-file-name) "snippets"))))
164 "Directory or list of snippet dirs for each major mode.
165
166 The directory where user-created snippets are to be stored. Can
167 also be a list of directories. In that case, when used for
168 bulk (re)loading of snippets (at startup or via
169 `yas-reload-all'), directories appearing earlier in the list
170 shadow other dir's snippets. Also, the first directory is taken
171 as the default for storing the user's new snippets."
172 :type '(choice (string :tag "Single directory (string)")
173 (repeat :args (string) :tag "List of directories (strings)"))
174 :group 'yasnippet
175 :require 'yasnippet
176 :set #'(lambda (symbol new)
177 (let ((old (and (boundp symbol)
178 (symbol-value symbol))))
179 (set-default symbol new)
180 (unless (or (not (fboundp 'yas-reload-all))
181 (equal old new))
182 (yas-reload-all)))))
183
184 (defun yas-snippet-dirs ()
185 "Returns `yas-snippet-dirs' (which see) as a list."
186 (if (listp yas-snippet-dirs) yas-snippet-dirs (list yas-snippet-dirs)))
187
188 (defvaralias 'yas/root-directory 'yas-snippet-dirs)
189
190 (defcustom yas-prompt-functions '(yas-x-prompt
191 yas-dropdown-prompt
192 yas-completing-prompt
193 yas-ido-prompt
194 yas-no-prompt)
195 "Functions to prompt for keys, templates, etc interactively.
196
197 These functions are called with the following arguments:
198
199 - PROMPT: A string to prompt the user
200
201 - CHOICES: a list of strings or objects.
202
203 - optional DISPLAY-FN : A function that, when applied to each of
204 the objects in CHOICES will return a string.
205
206 The return value of any function you put here should be one of
207 the objects in CHOICES, properly formatted with DISPLAY-FN (if
208 that is passed).
209
210 - To signal that your particular style of prompting is
211 unavailable at the moment, you can also have the function return
212 nil.
213
214 - To signal that the user quit the prompting process, you can
215 signal `quit' with
216
217 (signal 'quit \"user quit!\")."
218 :type '(repeat function)
219 :group 'yasnippet)
220
221 (defcustom yas-indent-line 'auto
222 "Controls indenting applied to a recent snippet expansion.
223
224 The following values are possible:
225
226 - `fixed' Indent the snippet to the current column;
227
228 - `auto' Indent each line of the snippet with `indent-according-to-mode'
229
230 Every other value means don't apply any snippet-side indentation
231 after expansion (the manual per-line \"$>\" indentation still
232 applies)."
233 :type '(choice (const :tag "Nothing" nothing)
234 (const :tag "Fixed" fixed)
235 (const :tag "Auto" auto))
236 :group 'yasnippet)
237
238 (defcustom yas-also-auto-indent-first-line nil
239 "Non-nil means also auto indent first line according to mode.
240
241 Naturally this is only valid when `yas-indent-line' is `auto'"
242 :type 'boolean
243 :group 'yasnippet)
244
245 (defcustom yas-snippet-revival t
246 "Non-nil means re-activate snippet fields after undo/redo."
247 :type 'boolean
248 :group 'yasnippet)
249
250 (defcustom yas-triggers-in-field nil
251 "If non-nil, allow stacked expansions (snippets inside snippets).
252
253 Otherwise `yas-next-field-or-maybe-expand' just moves on to the
254 next field"
255 :type 'boolean
256 :group 'yasnippet)
257
258 (defcustom yas-fallback-behavior 'call-other-command
259 "How to act when `yas-expand' does *not* expand a snippet.
260
261 - `call-other-command' means try to temporarily disable YASnippet
262 and call the next command bound to whatever key was used to
263 invoke `yas-expand'.
264
265 - nil or the symbol `return-nil' mean do nothing. (and
266 `yas-expand' returns nil)
267
268 - A Lisp form (apply COMMAND . ARGS) means interactively call
269 COMMAND, if ARGS is non-nil, call COMMAND non-interactively
270 with ARGS as arguments."
271 :type '(choice (const :tag "Call previous command" call-other-command)
272 (const :tag "Do nothing" return-nil))
273 :group 'yasnippet)
274
275 (defcustom yas-choose-keys-first nil
276 "If non-nil, prompt for snippet key first, then for template.
277
278 Otherwise prompts for all possible snippet names.
279
280 This affects `yas-insert-snippet' and `yas-visit-snippet-file'."
281 :type 'boolean
282 :group 'yasnippet)
283
284 (defcustom yas-choose-tables-first nil
285 "If non-nil, and multiple eligible snippet tables, prompts user for tables first.
286
287 Otherwise, user chooses between the merging together of all
288 eligible tables.
289
290 This affects `yas-insert-snippet', `yas-visit-snippet-file'"
291 :type 'boolean
292 :group 'yasnippet)
293
294 (defcustom yas-use-menu 'abbreviate
295 "Display a YASnippet menu in the menu bar.
296
297 When non-nil, submenus for each snippet table will be listed
298 under the menu \"Yasnippet\".
299
300 - If set to `abbreviate', only the current major-mode
301 menu and the modes set in `yas-extra-modes' are listed.
302
303 - If set to `full', every submenu is listed
304
305 - It set to nil, don't display a menu at all (this requires a
306 `yas-reload-all' call if the menu is already visible).
307
308 Any other non-nil value, every submenu is listed."
309 :type '(choice (const :tag "Full" full)
310 (const :tag "Abbreviate" abbreviate)
311 (const :tag "No menu" nil))
312 :group 'yasnippet)
313
314 (defcustom yas-trigger-symbol (or (and (eq window-system 'mac)
315 (ignore-errors
316 (char-to-string ?\x21E5))) ;; little ->| sign
317 " =>")
318 "The text that will be used in menu to represent the trigger."
319 :type 'string
320 :group 'yasnippet)
321
322 (defcustom yas-wrap-around-region nil
323 "If non-nil, snippet expansion wraps around selected region.
324
325 The wrapping occurs just before the snippet's exit marker. This
326 can be overridden on a per-snippet basis."
327 :type 'boolean
328 :group 'yasnippet)
329
330 (defcustom yas-good-grace t
331 "If non-nil, don't raise errors in inline elisp evaluation.
332
333 An error string \"[yas] error\" is returned instead."
334 :type 'boolean
335 :group 'yasnippet)
336
337 (defcustom yas-visit-from-menu nil
338 "If non-nil visit snippets's files from menu, instead of expanding them.
339
340 This can only work when snippets are loaded from files."
341 :type 'boolean
342 :group 'yasnippet)
343
344 (defcustom yas-expand-only-for-last-commands nil
345 "List of `last-command' values to restrict tab-triggering to, or nil.
346
347 Leave this set at nil (the default) to be able to trigger an
348 expansion simply by placing the cursor after a valid tab trigger,
349 using whichever commands.
350
351 Optionally, set this to something like '(self-insert-command) if
352 you to wish restrict expansion to only happen when the last
353 letter of the snippet tab trigger was typed immediately before
354 the trigger key itself."
355 :type '(repeat function)
356 :group 'yasnippet)
357
358 ;; Only two faces, and one of them shouldn't even be used...
359 ;;
360 (defface yas-field-highlight-face
361 '((t (:inherit 'region)))
362 "The face used to highlight the currently active field of a snippet"
363 :group 'yasnippet)
364
365 (defface yas--field-debug-face
366 '()
367 "The face used for debugging some overlays normally hidden"
368 :group 'yasnippet)
369
370 \f
371 ;;; User-visible variables
372
373 (defvar yas-keymap (let ((map (make-sparse-keymap)))
374 (define-key map [(tab)] 'yas-next-field-or-maybe-expand)
375 (define-key map (kbd "TAB") 'yas-next-field-or-maybe-expand)
376 (define-key map [(shift tab)] 'yas-prev-field)
377 (define-key map [backtab] 'yas-prev-field)
378 (define-key map (kbd "C-g") 'yas-abort-snippet)
379 (define-key map (kbd "C-d") 'yas-skip-and-clear-or-delete-char)
380 map)
381 "The active keymap while a snippet expansion is in progress.")
382
383 (defvar yas-key-syntaxes (list "w" "w_" "w_." "w_.()" "^ ")
384 "List of character syntaxes used to find a trigger key before point.
385 The list is tried in the order while scanning characters
386 backwards from point. For example, if the list is '(\"w\" \"w_\")
387 first look for trigger keys which are composed exclusively of
388 \"word\"-syntax characters, and then, if that fails, look for
389 keys which are either of \"word\" or \"symbol\"
390 syntax. Triggering after
391
392 foo-bar
393
394 will, according to the \"w\" element first try \"bar\". If that
395 isn't a trigger key, \"foo-bar\" is tried, respecting a second
396 \"w_\" element.")
397
398 (defvar yas-after-exit-snippet-hook
399 '()
400 "Hooks to run after a snippet exited.
401
402 The hooks will be run in an environment where some variables bound to
403 proper values:
404
405 `yas-snippet-beg' : The beginning of the region of the snippet.
406
407 `yas-snippet-end' : Similar to beg.
408
409 Attention: These hooks are not run when exiting nested/stacked snippet expansion!")
410
411 (defvar yas-before-expand-snippet-hook
412 '()
413 "Hooks to run just before expanding a snippet.")
414
415 (defvar yas-buffer-local-condition
416 '(if (and (or (fourth (syntax-ppss))
417 (fifth (syntax-ppss)))
418 this-command
419 (eq this-command 'yas-expand-from-trigger-key))
420 '(require-snippet-condition . force-in-comment)
421 t)
422 "Snippet expanding condition.
423
424 This variable is a Lisp form which is evaluated every time a
425 snippet expansion is attempted:
426
427 * If it evaluates to nil, no snippets can be expanded.
428
429 * If it evaluates to the a cons (require-snippet-condition
430 . REQUIREMENT)
431
432 * Snippets bearing no \"# condition:\" directive are not
433 considered
434
435 * Snippets bearing conditions that evaluate to nil (or
436 produce an error) won't be considered.
437
438 * If the snippet has a condition that evaluates to non-nil
439 RESULT:
440
441 * If REQUIREMENT is t, the snippet is considered
442
443 * If REQUIREMENT is `eq' RESULT, the snippet is
444 considered
445
446 * Otherwise, the snippet is not considered.
447
448 * If it evaluates to the symbol 'always, all snippets are
449 considered for expansion, regardless of any conditions.
450
451 * If it evaluates to t or some other non-nil value
452
453 * Snippet bearing no conditions, or conditions that
454 evaluate to non-nil, are considered for expansion.
455
456 * Otherwise, the snippet is not considered.
457
458 Here's an example preventing snippets from being expanded from
459 inside comments, in `python-mode' only, with the exception of
460 snippets returning the symbol 'force-in-comment in their
461 conditions.
462
463 (add-hook 'python-mode-hook
464 '(lambda ()
465 (setq yas-buffer-local-condition
466 '(if (python-in-string/comment)
467 '(require-snippet-condition . force-in-comment)
468 t))))
469
470 The default value is similar, it filters out potential snippet
471 expansions inside comments and string literals, unless the
472 snippet itself contains a condition that returns the symbol
473 `force-in-comment'.")
474
475 \f
476 ;;; Internal variables
477
478 (defvar yas--version "0.8.0beta")
479
480 (defvar yas--menu-table (make-hash-table)
481 "A hash table of MAJOR-MODE symbols to menu keymaps.")
482
483 (defvar yas--known-modes
484 '(ruby-mode rst-mode markdown-mode)
485 "A list of mode which is well known but not part of Emacs.")
486
487 (defvar yas--escaped-characters
488 '(?\\ ?` ?\" ?' ?$ ?} ?{ ?\( ?\))
489 "List of characters which *might* need to be escaped.")
490
491 (defconst yas--field-regexp
492 "${\\([0-9]+:\\)?\\([^}]*\\)}"
493 "A regexp to *almost* recognize a field.")
494
495 (defconst yas--multi-dollar-lisp-expression-regexp
496 "$+[ \t\n]*\\(([^)]*)\\)"
497 "A regexp to *almost* recognize a \"$(...)\" expression.")
498
499 (defconst yas--backquote-lisp-expression-regexp
500 "`\\([^`]*\\)`"
501 "A regexp to recognize a \"`lisp-expression`\" expression." )
502
503 (defconst yas--transform-mirror-regexp
504 "${\\(?:\\([0-9]+\\):\\)?$\\([ \t\n]*([^}]*\\)"
505 "A regexp to *almost* recognize a mirror with a transform.")
506
507 (defconst yas--simple-mirror-regexp
508 "$\\([0-9]+\\)"
509 "A regexp to recognize a simple mirror.")
510
511 (defvar yas--snippet-id-seed 0
512 "Contains the next id for a snippet.")
513
514 (defun yas--snippet-next-id ()
515 (let ((id yas--snippet-id-seed))
516 (incf yas--snippet-id-seed)
517 id))
518
519 \f
520 ;;; Minor mode stuff
521
522 ;; XXX: `last-buffer-undo-list' is somehow needed in Carbon Emacs for MacOSX
523 (defvar last-buffer-undo-list nil)
524
525 (defvar yas--minor-mode-menu nil
526 "Holds the YASnippet menu.")
527
528 (defun yas--init-minor-keymap ()
529 "Set up the `yas-minor-mode' keymap."
530 (let ((map (make-sparse-keymap)))
531 (when yas-use-menu
532 (easy-menu-define yas--minor-mode-menu
533 map
534 "Menu used when `yas-minor-mode' is active."
535 '("YASnippet"
536 "----"
537 ["Expand trigger" yas-expand
538 :help "Possibly expand tab trigger before point"]
539 ["Insert at point..." yas-insert-snippet
540 :help "Prompt for an expandable snippet and expand it at point"]
541 ["New snippet..." yas-new-snippet
542 :help "Create a new snippet in an appropriate directory"]
543 ["Visit snippet file..." yas-visit-snippet-file
544 :help "Prompt for an expandable snippet and find its file"]
545 "----"
546 ("Snippet menu behaviour"
547 ["Visit snippets" (setq yas-visit-from-menu t)
548 :help "Visit snippets from the menu"
549 :active t :style radio :selected yas-visit-from-menu]
550 ["Expand snippets" (setq yas-visit-from-menu nil)
551 :help "Expand snippets from the menu"
552 :active t :style radio :selected (not yas-visit-from-menu)]
553 "----"
554 ["Show all known modes" (setq yas-use-menu 'full)
555 :help "Show one snippet submenu for each loaded table"
556 :active t :style radio :selected (eq yas-use-menu 'full)]
557 ["Abbreviate according to current mode" (setq yas-use-menu 'abbreviate)
558 :help "Show only snippet submenus for the current active modes"
559 :active t :style radio :selected (eq yas-use-menu 'abbreviate)])
560 ("Indenting"
561 ["Auto" (setq yas-indent-line 'auto)
562 :help "Indent each line of the snippet with `indent-according-to-mode'"
563 :active t :style radio :selected (eq yas-indent-line 'auto)]
564 ["Fixed" (setq yas-indent-line 'fixed)
565 :help "Indent the snippet to the current column"
566 :active t :style radio :selected (eq yas-indent-line 'fixed)]
567 ["None" (setq yas-indent-line 'none)
568 :help "Don't apply any particular snippet indentation after expansion"
569 :active t :style radio :selected (not (member yas-indent-line '(fixed auto)))]
570 "----"
571 ["Also auto indent first line" (setq yas-also-auto-indent-first-line
572 (not yas-also-auto-indent-first-line))
573 :help "When auto-indenting also, auto indent the first line menu"
574 :active (eq yas-indent-line 'auto)
575 :style toggle :selected yas-also-auto-indent-first-line]
576 )
577 ("Prompting method"
578 ["System X-widget" (setq yas-prompt-functions
579 (cons 'yas-x-prompt
580 (remove 'yas-x-prompt
581 yas-prompt-functions)))
582 :help "Use your windowing system's (gtk, mac, windows, etc...) default menu"
583 :active t :style radio :selected (eq (car yas-prompt-functions)
584 'yas-x-prompt)]
585 ["Dropdown-list" (setq yas-prompt-functions
586 (cons 'yas-dropdown-prompt
587 (remove 'yas-dropdown-prompt
588 yas-prompt-functions)))
589 :help "Use a special dropdown list"
590 :active t :style radio :selected (eq (car yas-prompt-functions)
591 'yas-dropdown-prompt)]
592 ["Ido" (setq yas-prompt-functions
593 (cons 'yas-ido-prompt
594 (remove 'yas-ido-prompt
595 yas-prompt-functions)))
596 :help "Use an ido-style minibuffer prompt"
597 :active t :style radio :selected (eq (car yas-prompt-functions)
598 'yas-ido-prompt)]
599 ["Completing read" (setq yas-prompt-functions
600 (cons 'yas-completing-prompt
601 (remove 'yas-completing-prompt
602 yas-prompt-functions)))
603 :help "Use a normal minibuffer prompt"
604 :active t :style radio :selected (eq (car yas-prompt-functions)
605 'yas-completing-prompt)]
606 )
607 ("Misc"
608 ["Wrap region in exit marker"
609 (setq yas-wrap-around-region
610 (not yas-wrap-around-region))
611 :help "If non-nil automatically wrap the selected text in the $0 snippet exit"
612 :style toggle :selected yas-wrap-around-region]
613 ["Allow stacked expansions "
614 (setq yas-triggers-in-field
615 (not yas-triggers-in-field))
616 :help "If non-nil allow snippets to be triggered inside other snippet fields"
617 :style toggle :selected yas-triggers-in-field]
618 ["Revive snippets on undo "
619 (setq yas-snippet-revival
620 (not yas-snippet-revival))
621 :help "If non-nil allow snippets to become active again after undo"
622 :style toggle :selected yas-snippet-revival]
623 ["Good grace "
624 (setq yas-good-grace
625 (not yas-good-grace))
626 :help "If non-nil don't raise errors in bad embedded elisp in snippets"
627 :style toggle :selected yas-good-grace]
628 )
629 "----"
630 ["Load snippets..." yas-load-directory
631 :help "Load snippets from a specific directory"]
632 ["Reload everything" yas-reload-all
633 :help "Cleanup stuff, reload snippets, rebuild menus"]
634 ["About" yas-about
635 :help "Display some information about YASnippet"])))
636
637 ;; Now for the stuff that has direct keybindings
638 ;;
639 (define-key map [(tab)] 'yas-expand)
640 (define-key map (kbd "TAB") 'yas-expand)
641 (define-key map "\C-c&\C-s" 'yas-insert-snippet)
642 (define-key map "\C-c&\C-n" 'yas-new-snippet)
643 (define-key map "\C-c&\C-v" 'yas-visit-snippet-file)
644 map))
645
646 (defvar yas-minor-mode-map (yas--init-minor-keymap)
647 "The keymap used when `yas-minor-mode' is active.")
648
649 (defvar yas--tables (make-hash-table)
650 "A hash table of mode symbols to `yas--table' objects.")
651
652 (defvar yas--parents (make-hash-table)
653 "A hash table of mode symbols do lists of direct parent mode symbols.
654
655 This list is populated when reading the \".yas-parents\" files
656 found when traversing snippet directories with
657 `yas-load-directory'.
658
659 There might be additional parenting information stored in the
660 `derived-mode-parent' property of some mode symbols, but that is
661 not recorded here.")
662
663 (defvar yas--direct-keymaps (list)
664 "Keymap alist supporting direct snippet keybindings.
665
666 This variable is placed in `emulation-mode-map-alists'.
667
668 Its elements looks like (TABLE-NAME . KEYMAP). They're
669 instantiated on `yas-reload-all' but KEYMAP is added to only when
670 loading snippets. `yas--direct-TABLE-NAME' is then a variable set
671 buffer-locally when entering `yas-minor-mode'. KEYMAP binds all
672 defined direct keybindings to the command
673 `yas-expand-from-keymap' which then which snippet to expand.")
674
675 (defun yas-direct-keymaps-reload ()
676 "Force reload the direct keybinding for active snippet tables."
677 (interactive)
678 (setq yas--direct-keymaps nil)
679 (maphash #'(lambda (name table)
680 (push (cons (intern (format "yas--direct-%s" name))
681 (yas--table-direct-keymap table))
682 yas--direct-keymaps))
683 yas--tables))
684
685 (defun yas--modes-to-activate ()
686 "Compute list of mode symbols that are active for `yas-expand'
687 and friends."
688 (let ((modes-to-activate (list major-mode))
689 (mode major-mode))
690 (while (setq mode (get mode 'derived-mode-parent))
691 (push mode modes-to-activate))
692 (dolist (mode (yas-extra-modes))
693 (push mode modes-to-activate))
694 (remove-duplicates
695 (append modes-to-activate
696 (mapcan #'(lambda (mode)
697 (yas--all-parents mode))
698 modes-to-activate)))))
699
700 (defvar yas-minor-mode-hook nil
701 "Hook run when `yas-minor-mode' is turned on.")
702
703 ;;;###autoload
704 (define-minor-mode yas-minor-mode
705 "Toggle YASnippet mode.
706
707 When YASnippet mode is enabled, `yas-expand', normally bound to
708 the TAB key, expands snippets of code depending on the major
709 mode.
710
711 With no argument, this command toggles the mode.
712 positive prefix argument turns on the mode.
713 Negative prefix argument turns off the mode.
714
715 Key bindings:
716 \\{yas-minor-mode-map}"
717 nil
718 ;; The indicator for the mode line.
719 " yas"
720 :group 'yasnippet
721 (cond (yas-minor-mode
722 ;; Install the direct keymaps in `emulation-mode-map-alists'
723 ;; (we use `add-hook' even though it's not technically a hook,
724 ;; but it works). Then define variables named after modes to
725 ;; index `yas--direct-keymaps'.
726 ;;
727 ;; Also install the post-command-hook.
728 ;;
729 (add-hook 'emulation-mode-map-alists 'yas--direct-keymaps)
730 (add-hook 'post-command-hook 'yas--post-command-handler nil t)
731 ;; Set the `yas--direct-%s' vars for direct keymap expansion
732 ;;
733 (dolist (mode (yas--modes-to-activate))
734 (let ((name (intern (format "yas--direct-%s" mode))))
735 (set-default name nil)
736 (set (make-local-variable name) t)))
737 ;; Perform JIT loads
738 ;;
739 (yas--load-pending-jits))
740 (t
741 ;; Uninstall the direct keymaps and the post-command hook
742 ;;
743 (remove-hook 'post-command-hook 'yas--post-command-handler t)
744 (remove-hook 'emulation-mode-map-alists 'yas--direct-keymaps))))
745
746 (defvar yas-dont-activate '(minibufferp)
747 "If non-nil don't let `yas-global-mode' affect some buffers.
748
749 If a function of zero arguments, then its result is used.
750
751 If a list of functions, then all functions must return nil to
752 activate yas for this buffer.
753
754 In Emacsen <= 23, this variable is buffer-local. Because
755 `yas-minor-mode-on' is called by `yas-global-mode' after
756 executing the buffer's major mode hook, setting this variable
757 there is an effective way to define exceptions to the \"global\"
758 activation behaviour.
759
760 In Emacsen > 23, only the global value is used. To define
761 per-mode exceptions to the \"global\" activation behaviour, call
762 `yas-minor-mode' with a negative argument directily in the major
763 mode's hook.")
764 (unless (> emacs-major-version 23)
765 (make-variable-buffer-local 'yas-dont-activate))
766
767
768 (defun yas-minor-mode-on ()
769 "Turn on YASnippet minor mode.
770
771 Honour `yas-dont-activate', which see."
772 (interactive)
773 ;; Check `yas-dont-activate'
774 (unless (cond ((functionp yas-dont-activate)
775 (funcall yas-dont-activate))
776 ((consp yas-dont-activate)
777 (some #'funcall yas-dont-activate))
778 (yas-dont-activate))
779 (yas-minor-mode 1)))
780
781 ;;;###autoload
782 (define-globalized-minor-mode yas-global-mode yas-minor-mode yas-minor-mode-on
783 :group 'yasnippet
784 :require 'yasnippet)
785
786 (defun yas--global-mode-reload-with-jit-maybe ()
787 "Run `yas-reload-all' when `yas-global-mode' is on."
788 (when yas-global-mode (yas-reload-all)))
789
790 (add-hook 'yas-global-mode-hook 'yas--global-mode-reload-with-jit-maybe)
791
792 \f
793 ;;; Major mode stuff
794
795 (defvar yas--font-lock-keywords
796 (append '(("^#.*$" . font-lock-comment-face))
797 lisp-font-lock-keywords
798 lisp-font-lock-keywords-1
799 lisp-font-lock-keywords-2
800 '(("$\\([0-9]+\\)"
801 (0 font-lock-keyword-face)
802 (1 font-lock-string-face t))
803 ("${\\([0-9]+\\):?"
804 (0 font-lock-keyword-face)
805 (1 font-lock-warning-face t))
806 ("${" font-lock-keyword-face)
807 ("$[0-9]+?" font-lock-preprocessor-face)
808 ("\\(\\$(\\)" 1 font-lock-preprocessor-face)
809 ("}"
810 (0 font-lock-keyword-face)))))
811
812 (defun yas--init-major-keymap ()
813 "Setup YASnippet major-mode keymap."
814 (let ((map (make-sparse-keymap)))
815 (easy-menu-define nil
816 map
817 "Menu used when snippet-mode is active."
818 (cons "Snippet"
819 (mapcar #'(lambda (ent)
820 (when (third ent)
821 (define-key map (third ent) (second ent)))
822 (vector (first ent) (second ent) t))
823 (list
824 (list "Load this snippet" 'yas-load-snippet-buffer "\C-c\C-c")
825 (list "Try out this snippet" 'yas-tryout-snippet "\C-c\C-t")))))
826 map))
827
828 (defvar snippet-mode-map
829 (yas--init-major-keymap)
830 "The keymap used when `snippet-mode' is active.")
831
832
833 (define-derived-mode snippet-mode text-mode "Snippet"
834 "A mode for editing yasnippets"
835 (setq font-lock-defaults '(yas--font-lock-keywords))
836 (set (make-local-variable 'require-final-newline) nil)
837 (set (make-local-variable 'comment-start) "#")
838 (set (make-local-variable 'comment-start-skip) "#+[\t ]*"))
839
840
841 \f
842 ;;; Internal structs for template management
843
844 (defstruct (yas--template (:constructor yas--make-blank-template))
845 "A template for a snippet."
846 key
847 content
848 name
849 condition
850 expand-env
851 file
852 keybinding
853 uuid
854 menu-binding-pair
855 group ;; as dictated by the #group: directive or .yas-make-groups
856 perm-group ;; as dictated by `yas-define-menu'
857 table
858 )
859
860 (defun yas--populate-template (template &rest args)
861 "Helper function to populate TEMPLATE with properties."
862 (let (p v)
863 (while args
864 (aset template
865 (position (intern (substring (symbol-name (car args)) 1))
866 (mapcar #'car (get 'yas--template 'cl-struct-slots)))
867 (second args))
868 (setq args (cddr args)))
869 template))
870
871 (defstruct (yas--table (:constructor yas--make-snippet-table (name)))
872 "A table to store snippets for a particular mode.
873
874 Has the following fields:
875
876 `yas--table-name'
877
878 A symbol name normally corresponding to a major mode, but can
879 also be a pseudo major-mode to be referenced in
880 `yas-extra-modes', for example.
881
882 `yas--table-hash'
883
884 A hash table (KEY . NAMEHASH), known as the \"keyhash\". KEY is
885 a string or a vector, where the former is the snippet's trigger
886 and the latter means it's a direct keybinding. NAMEHASH is yet
887 another hash of (NAME . TEMPLATE) where NAME is the snippet's
888 name and TEMPLATE is a `yas--template' object.
889
890 `yas--table-direct-keymap'
891
892 A keymap for the snippets in this table that have direct
893 keybindings. This is kept in sync with the keyhash, i.e., all
894 the elements of the keyhash that are vectors appear here as
895 bindings to `yas-expand-from-keymap'.
896
897 `yas--table-uuidhash'
898
899 A hash table mapping snippets uuid's to the same `yas--template'
900 objects. A snippet uuid defaults to the snippet's name.
901 "
902 name
903 (hash (make-hash-table :test 'equal))
904 (uuidhash (make-hash-table :test 'equal))
905 (parents nil)
906 (direct-keymap (make-sparse-keymap)))
907
908 (defun yas--get-template-by-uuid (mode uuid)
909 "Find the snippet template in MODE by its UUID."
910 (let* ((table (gethash mode yas--tables mode)))
911 (when table
912 (gethash uuid (yas--table-uuidhash table)))))
913
914 ;; Apropos storing/updating in TABLE, this works in two steps:
915 ;;
916 ;; 1. `yas--remove-template-by-uuid' removes any
917 ;; keyhash-namehash-template mappings from TABLE, grabbing the
918 ;; snippet by its uuid. Also removes mappings from TABLE's
919 ;; `yas--table-direct-keymap' (FIXME: and should probably take care
920 ;; of potentially stale menu bindings right?.)
921 ;;
922 ;; 2. `yas--add-template' adds this all over again.
923 ;;
924 ;; Create a new or add to an existing keyhash-namehash mapping.
925 ;;
926 ;; For reference on understanding this, consider three snippet
927 ;; definitions:
928 ;;
929 ;; A: # name: The Foo
930 ;; # key: foo
931 ;; # binding: C-c M-l
932 ;;
933 ;; B: # name: Mrs Foo
934 ;; # key: foo
935 ;;
936 ;; C: # name: The Bar
937 ;; # binding: C-c M-l
938 ;;
939 ;; D: # name: Baz
940 ;; # key: baz
941 ;;
942 ;; keyhash namehashes(3) yas--template structs(4)
943 ;; -----------------------------------------------------
944 ;; __________
945 ;; / \
946 ;; "foo" ---> "The Foo" ---> [yas--template A] |
947 ;; "Mrs Foo" ---> [yas--template B] |
948 ;; |
949 ;; [C-c M-l] ---> "The Foo" -------------------------/
950 ;; "The Bar" ---> [yas--template C]
951 ;;
952 ;; "baz" ---> "Baz" ---> [yas--template D]
953 ;;
954 ;; Additionally, since uuid defaults to the name, we have a
955 ;; `yas--table-uuidhash' for TABLE
956 ;;
957 ;; uuidhash yas--template structs
958 ;; -------------------------------
959 ;; "The Foo" ---> [yas--template A]
960 ;; "Mrs Foo" ---> [yas--template B]
961 ;; "The Bar" ---> [yas--template C]
962 ;; "Baz" ---> [yas--template D]
963 ;;
964 ;; FIXME: the more I look at this data-structure the more I think I'm
965 ;; stupid. There has to be an easier way (but beware lots of code
966 ;; depends on this).
967 ;;
968 (defun yas--remove-template-by-uuid (table uuid)
969 "Remove from TABLE a template identified by UUID."
970 (let ((template (gethash uuid (yas--table-uuidhash table))))
971 (when template
972 (let* ((name (yas--template-name template))
973 (empty-keys nil))
974 ;; Remove the name from each of the targeted namehashes
975 ;;
976 (maphash #'(lambda (k v)
977 (let ((template (gethash name v)))
978 (when (and template
979 (eq uuid (yas--template-uuid template)))
980 (remhash name v)
981 (when (zerop (hash-table-count v))
982 (push k empty-keys)))))
983 (yas--table-hash table))
984 ;; Remove the namehash themselves if they've become empty
985 ;;
986 (dolist (key empty-keys)
987 (when (vectorp key)
988 (define-key (yas--table-direct-keymap table) key nil))
989 (remhash key (yas--table-hash table)))
990
991 ;; Finally, remove the uuid from the uuidhash
992 ;;
993 (remhash uuid (yas--table-uuidhash table))))))
994
995 (defun yas--add-template (table template)
996 "Store in TABLE the snippet template TEMPLATE.
997
998 KEY can be a string (trigger key) of a vector (direct
999 keybinding)."
1000 (let ((name (yas--template-name template))
1001 (key (yas--template-key template))
1002 (keybinding (yas--template-keybinding template))
1003 (menu-binding-pair (yas--template-menu-binding-pair-get-create template)))
1004 (dolist (k (remove nil (list key keybinding)))
1005 (puthash name
1006 template
1007 (or (gethash k
1008 (yas--table-hash table))
1009 (puthash k
1010 (make-hash-table :test 'equal)
1011 (yas--table-hash table))))
1012 (when (vectorp k)
1013 (define-key (yas--table-direct-keymap table) k 'yas-expand-from-keymap)))
1014
1015 ;; Update TABLE's `yas--table-uuidhash'
1016 (puthash (yas--template-uuid template)
1017 template
1018 (yas--table-uuidhash table))))
1019
1020 (defun yas--update-template (table template)
1021 "Add or update TEMPLATE in TABLE.
1022
1023 Also takes care of adding and updating to the associated menu."
1024 ;; Remove from table by uuid
1025 ;;
1026 (yas--remove-template-by-uuid table (yas--template-uuid template))
1027 ;; Add to table again
1028 ;;
1029 (yas--add-template table template)
1030 ;; Take care of the menu
1031 ;;
1032 (when yas-use-menu
1033 (yas--update-template-menu table template)))
1034
1035 (defun yas--update-template-menu (table template)
1036 "Update every menu-related for TEMPLATE."
1037 (let ((menu-binding-pair (yas--template-menu-binding-pair-get-create template))
1038 (key (yas--template-key template))
1039 (keybinding (yas--template-keybinding template)))
1040 ;; The snippet might have changed name or keys, so update
1041 ;; user-visible strings
1042 ;;
1043 (unless (eq (cdr menu-binding-pair) :none)
1044 ;; the menu item name
1045 ;;
1046 (setf (cadar menu-binding-pair) (yas--template-name template))
1047 ;; the :keys information (also visible to the user)
1048 (setf (getf (cdr (car menu-binding-pair)) :keys)
1049 (or (and keybinding (key-description keybinding))
1050 (and key (concat key yas-trigger-symbol))))))
1051 (unless (yas--template-menu-managed-by-yas-define-menu template)
1052 (let ((menu-keymap
1053 (yas--menu-keymap-get-create (yas--table-mode table)
1054 (mapcar #'yas--table-mode
1055 (yas--table-parents table))))
1056 (group (yas--template-group template)))
1057 ;; Remove from menu keymap
1058 ;;
1059 (assert menu-keymap)
1060 (yas--delete-from-keymap menu-keymap (yas--template-uuid template))
1061
1062 ;; Add necessary subgroups as necessary.
1063 ;;
1064 (dolist (subgroup group)
1065 (let ((subgroup-keymap (lookup-key menu-keymap (vector (make-symbol subgroup)))))
1066 (unless (and subgroup-keymap
1067 (keymapp subgroup-keymap))
1068 (setq subgroup-keymap (make-sparse-keymap))
1069 (define-key menu-keymap (vector (make-symbol subgroup))
1070 `(menu-item ,subgroup ,subgroup-keymap)))
1071 (setq menu-keymap subgroup-keymap)))
1072
1073 ;; Add this entry to the keymap
1074 ;;
1075 (define-key menu-keymap
1076 (vector (make-symbol (yas--template-uuid template)))
1077 (car (yas--template-menu-binding-pair template))))))
1078
1079 (defun yas--namehash-templates-alist (namehash)
1080 "Return NAMEHASH as an alist."
1081 (let (alist)
1082 (maphash #'(lambda (k v)
1083 (push (cons k v) alist))
1084 namehash)
1085 alist))
1086
1087 (defun yas--fetch (table key)
1088 "Fetch templates in TABLE by KEY.
1089
1090 Return a list of cons (NAME . TEMPLATE) where NAME is a
1091 string and TEMPLATE is a `yas--template' structure."
1092 (let* ((keyhash (yas--table-hash table))
1093 (namehash (and keyhash (gethash key keyhash))))
1094 (when namehash
1095 (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash)))))
1096
1097 \f
1098 ;;; Filtering/condition logic
1099
1100 (defun yas--eval-condition (condition)
1101 (condition-case err
1102 (save-excursion
1103 (save-restriction
1104 (save-match-data
1105 (eval condition))))
1106 (error (progn
1107 (yas--message 1 "Error in condition evaluation: %s" (error-message-string err))
1108 nil))))
1109
1110
1111 (defun yas--filter-templates-by-condition (templates)
1112 "Filter the templates using the applicable condition.
1113
1114 TEMPLATES is a list of cons (NAME . TEMPLATE) where NAME is a
1115 string and TEMPLATE is a `yas--template' structure.
1116
1117 This function implements the rules described in
1118 `yas-buffer-local-condition'. See that variables documentation."
1119 (let ((requirement (yas--require-template-specific-condition-p)))
1120 (if (eq requirement 'always)
1121 templates
1122 (remove-if-not #'(lambda (pair)
1123 (yas--template-can-expand-p
1124 (yas--template-condition (cdr pair)) requirement))
1125 templates))))
1126
1127 (defun yas--require-template-specific-condition-p ()
1128 "Decides if this buffer requests/requires snippet-specific
1129 conditions to filter out potential expansions."
1130 (if (eq 'always yas-buffer-local-condition)
1131 'always
1132 (let ((local-condition (or (and (consp yas-buffer-local-condition)
1133 (yas--eval-condition yas-buffer-local-condition))
1134 yas-buffer-local-condition)))
1135 (when local-condition
1136 (if (eq local-condition t)
1137 t
1138 (and (consp local-condition)
1139 (eq 'require-snippet-condition (car local-condition))
1140 (symbolp (cdr local-condition))
1141 (cdr local-condition)))))))
1142
1143 (defun yas--template-can-expand-p (condition requirement)
1144 "Evaluates CONDITION and REQUIREMENT and returns a boolean."
1145 (let* ((result (or (null condition)
1146 (yas--eval-condition condition))))
1147 (cond ((eq requirement t)
1148 result)
1149 (t
1150 (eq requirement result)))))
1151
1152 (defun yas--all-parents (mode)
1153 "Returns a list of all parent modes of MODE."
1154 (let ((parents (gethash mode yas--parents)))
1155 (append parents
1156 (mapcan #'yas--all-parents parents))))
1157
1158 (defun yas--table-templates (table)
1159 (when table
1160 (let ((acc (list)))
1161 (maphash #'(lambda (key namehash)
1162 (maphash #'(lambda (name template)
1163 (push (cons name template) acc))
1164 namehash))
1165 (yas--table-hash table))
1166 (yas--filter-templates-by-condition acc))))
1167
1168 (defun yas--current-key ()
1169 "Get the key under current position. A key is used to find
1170 the template of a snippet in the current snippet-table."
1171 (let ((start (point))
1172 (end (point))
1173 (syntaxes yas-key-syntaxes)
1174 syntax
1175 done
1176 templates)
1177 (while (and (not done) syntaxes)
1178 (setq syntax (car syntaxes))
1179 (setq syntaxes (cdr syntaxes))
1180 (save-excursion
1181 (skip-syntax-backward syntax)
1182 (setq start (point)))
1183 (setq templates
1184 (mapcan #'(lambda (table)
1185 (yas--fetch table (buffer-substring-no-properties start end)))
1186 (yas--get-snippet-tables)))
1187 (if templates
1188 (setq done t)
1189 (setq start end)))
1190 (list templates
1191 start
1192 end)))
1193
1194
1195 (defun yas--table-all-keys (table)
1196 "Get trigger keys of all active snippets in TABLE."
1197 (let ((acc))
1198 (maphash #'(lambda (key namehash)
1199 (when (yas--filter-templates-by-condition (yas--namehash-templates-alist namehash))
1200 (push key acc)))
1201 (yas--table-hash table))
1202 acc))
1203
1204 (defun yas--table-mode (table)
1205 (intern (yas--table-name table)))
1206
1207 \f
1208 ;;; Internal functions and macros:
1209
1210 (defun yas--real-mode? (mode)
1211 "Try to find out if MODE is a real mode.
1212
1213 The MODE bound to a function (like `c-mode') is considered real
1214 mode. Other well known mode like `ruby-mode' which is not part of
1215 Emacs might not bound to a function until it is loaded. So
1216 yasnippet keeps a list of modes like this to help the judgment."
1217 (or (fboundp mode)
1218 (find mode yas--known-modes)))
1219
1220 (defun yas--eval-lisp (form)
1221 "Evaluate FORM and convert the result to string."
1222 (let ((retval (catch 'yas--exception
1223 (condition-case err
1224 (save-excursion
1225 (save-restriction
1226 (save-match-data
1227 (widen)
1228 (let ((result (eval form)))
1229 (when result
1230 (format "%s" result))))))
1231 (error (if yas-good-grace
1232 (yas--format "elisp error! %s" (error-message-string err))
1233 (error (yas--format "elisp error: %s"
1234 (error-message-string err)))))))))
1235 (when (and (consp retval)
1236 (eq 'yas--exception (car retval)))
1237 (error (cdr retval)))
1238 retval))
1239
1240 (defun yas--eval-lisp-no-saves (form)
1241 (condition-case err
1242 (eval form)
1243 (error (if yas-good-grace
1244 (yas--format "elisp error! %s" (error-message-string err))
1245 (error (yas--format "elisp error: %s"
1246 (error-message-string err)))))))
1247
1248 (defun yas--read-lisp (string &optional nil-on-error)
1249 "Read STRING as a elisp expression and return it.
1250
1251 In case STRING in an invalid expression and NIL-ON-ERROR is nil,
1252 return an expression that when evaluated will issue an error."
1253 (condition-case err
1254 (read string)
1255 (error (and (not nil-on-error)
1256 `(error (error-message-string ,err))))))
1257
1258 (defun yas--read-keybinding (keybinding)
1259 "Read KEYBINDING as a snippet keybinding, return a vector."
1260 (when (and keybinding
1261 (not (string-match "keybinding" keybinding)))
1262 (condition-case err
1263 (let ((res (or (and (string-match "^\\[.*\\]$" keybinding)
1264 (read keybinding))
1265 (read-kbd-macro keybinding 'need-vector))))
1266 res)
1267 (error
1268 (yas--message 3 "warning: keybinding \"%s\" invalid since %s."
1269 keybinding (error-message-string err))
1270 nil))))
1271
1272 (defvar yas-extra-modes nil
1273 "If non-nil, also lookup snippets for this/these modes.
1274
1275 Can be a symbol or a list of symbols.
1276
1277 This variable probably makes more sense as buffer-local, so
1278 ensure your use `make-local-variable' when you set it.")
1279 (defun yas-extra-modes ()
1280 (if (listp yas-extra-modes) yas-extra-modes (list yas-extra-modes)))
1281 (defvaralias 'yas/mode-symbol 'yas-extra-modes)
1282
1283 (defun yas--table-get-create (mode)
1284 "Get or create the snippet table corresponding to MODE."
1285 (let ((table (gethash mode
1286 yas--tables)))
1287 (unless table
1288 (setq table (yas--make-snippet-table (symbol-name mode)))
1289 (puthash mode table yas--tables)
1290 (push (cons (intern (format "yas--direct-%s" mode))
1291 (yas--table-direct-keymap table))
1292 yas--direct-keymaps))
1293 table))
1294
1295 (defun yas--get-snippet-tables ()
1296 "Get snippet tables for current buffer.
1297
1298 Return a list of `yas--table' objects. The list of modes to
1299 consider is returned by `yas--modes-to-activate'"
1300 (remove nil
1301 (mapcar #'(lambda (mode-name)
1302 (gethash mode-name yas--tables))
1303 (yas--modes-to-activate))))
1304
1305 (defun yas--menu-keymap-get-create (mode &optional parents)
1306 "Get or create the menu keymap for MODE and its PARENTS.
1307
1308 This may very well create a plethora of menu keymaps and arrange
1309 them all in `yas--menu-table'"
1310 (let* ((menu-keymap (or (gethash mode yas--menu-table)
1311 (puthash mode (make-sparse-keymap) yas--menu-table))))
1312 (mapc #'yas--menu-keymap-get-create parents)
1313 (define-key yas--minor-mode-menu (vector mode)
1314 `(menu-item ,(symbol-name mode) ,menu-keymap
1315 :visible (yas--show-menu-p ',mode)))
1316 menu-keymap))
1317
1318
1319 (defmacro yas--called-interactively-p (&optional kind)
1320 "A backward-compatible version of `called-interactively-p'.
1321
1322 Optional KIND is as documented at `called-interactively-p'
1323 in GNU Emacs 24.1 or higher."
1324 (if (string< emacs-version "24.1")
1325 '(called-interactively-p)
1326 `(called-interactively-p ,kind)))
1327
1328
1329 (defun yas--call-with-temporary-redefinitions (function
1330 &rest function-names-and-overriding-functions)
1331 (let* ((overrides (remove-if-not #'(lambda (fdef)
1332 (fboundp (first fdef)))
1333 function-names-and-overriding-functions))
1334 (definition-names (mapcar #'first overrides))
1335 (overriding-functions (mapcar #'second overrides))
1336 (saved-functions (mapcar #'symbol-function definition-names)))
1337 ;; saving all definitions before overriding anything ensures FDEFINITION
1338 ;; errors don't cause accidental permanent redefinitions.
1339 ;;
1340 (labels ((set-fdefinitions (names functions)
1341 (loop for name in names
1342 for fn in functions
1343 do (fset name fn))))
1344 (set-fdefinitions definition-names overriding-functions)
1345 (unwind-protect (funcall function)
1346 (set-fdefinitions definition-names saved-functions)))))
1347
1348
1349 (defmacro yas--with-temporary-redefinitions (fdefinitions &rest body)
1350 ;; "Temporarily (but globally) redefine each function in FDEFINITIONS.
1351 ;; E.g.: (yas--with-temporary-redefinitions ((foo (x) ...)
1352 ;; (bar (x) ...))
1353 ;; ;; code that eventually calls foo, bar of (setf foo)
1354 ;; ...)"
1355 `(yas--call-with-temporary-redefinitions
1356 (lambda () ,@body)
1357 ,@(mapcar #'(lambda (thingy)
1358 `(list ',(first thingy)
1359 (lambda ,@(rest thingy))))
1360 fdefinitions)))
1361
1362 (put 'yas--with-temporary-redefinitions 'lisp-indent-function 1)
1363 (put 'yas--with-temporary-redefinitions 'edebug-form-spec '((&rest (defun*)) cl-declarations body))
1364
1365 \f
1366 ;;; Template-related and snippet loading functions
1367
1368 (defun yas--parse-template (&optional file)
1369 "Parse the template in the current buffer.
1370
1371 Optional FILE is the absolute file name of the file being
1372 parsed.
1373
1374 Optional GROUP is the group where the template is to go,
1375 otherwise we attempt to calculate it from FILE.
1376
1377 Return a snippet-definition, i.e. a list
1378
1379 (KEY TEMPLATE NAME CONDITION GROUP VARS FILE KEYBINDING UUID)
1380
1381 If the buffer contains a line of \"# --\" then the contents above
1382 this line are ignored. Directives can set most of these with the syntax:
1383
1384 # directive-name : directive-value
1385
1386 Here's a list of currently recognized directives:
1387
1388 * type
1389 * name
1390 * contributor
1391 * condition
1392 * group
1393 * key
1394 * expand-env
1395 * binding
1396 * uuid"
1397 (goto-char (point-min))
1398 (let* ((type 'snippet)
1399 (name (and file
1400 (file-name-nondirectory file)))
1401 (key nil)
1402 template
1403 bound
1404 condition
1405 (group (and file
1406 (yas--calculate-group file)))
1407 expand-env
1408 binding
1409 uuid)
1410 (if (re-search-forward "^# --\n" nil t)
1411 (progn (setq template
1412 (buffer-substring-no-properties (point)
1413 (point-max)))
1414 (setq bound (point))
1415 (goto-char (point-min))
1416 (while (re-search-forward "^# *\\([^ ]+?\\) *: *\\(.*\\)$" bound t)
1417 (when (string= "uuid" (match-string-no-properties 1))
1418 (setq uuid (match-string-no-properties 2)))
1419 (when (string= "type" (match-string-no-properties 1))
1420 (setq type (if (string= "command" (match-string-no-properties 2))
1421 'command
1422 'snippet)))
1423 (when (string= "key" (match-string-no-properties 1))
1424 (setq key (match-string-no-properties 2)))
1425 (when (string= "name" (match-string-no-properties 1))
1426 (setq name (match-string-no-properties 2)))
1427 (when (string= "condition" (match-string-no-properties 1))
1428 (setq condition (yas--read-lisp (match-string-no-properties 2))))
1429 (when (string= "group" (match-string-no-properties 1))
1430 (setq group (match-string-no-properties 2)))
1431 (when (string= "expand-env" (match-string-no-properties 1))
1432 (setq expand-env (yas--read-lisp (match-string-no-properties 2)
1433 'nil-on-error)))
1434 (when (string= "binding" (match-string-no-properties 1))
1435 (setq binding (match-string-no-properties 2)))))
1436 (setq template
1437 (buffer-substring-no-properties (point-min) (point-max))))
1438 (unless (or key binding)
1439 (setq key (and file (file-name-nondirectory file))))
1440 (when (eq type 'command)
1441 (setq template (yas--read-lisp (concat "(progn" template ")"))))
1442 (when group
1443 (setq group (split-string group "\\.")))
1444 (list key template name condition group expand-env file binding uuid)))
1445
1446 (defun yas--calculate-group (file)
1447 "Calculate the group for snippet file path FILE."
1448 (let* ((dominating-dir (locate-dominating-file file
1449 ".yas-make-groups"))
1450 (extra-path (and dominating-dir
1451 (replace-regexp-in-string (concat "^"
1452 (expand-file-name dominating-dir))
1453 ""
1454 (expand-file-name file))))
1455 (extra-dir (and extra-path
1456 (file-name-directory extra-path)))
1457 (group (and extra-dir
1458 (replace-regexp-in-string "/"
1459 "."
1460 (directory-file-name extra-dir)))))
1461 group))
1462
1463 (defun yas--subdirs (directory &optional filep)
1464 "Return subdirs or files of DIRECTORY according to FILEP."
1465 (remove-if (lambda (file)
1466 (or (string-match "^\\."
1467 (file-name-nondirectory file))
1468 (string-match "^#.*#$"
1469 (file-name-nondirectory file))
1470 (string-match "~$"
1471 (file-name-nondirectory file))
1472 (if filep
1473 (file-directory-p file)
1474 (not (file-directory-p file)))))
1475 (directory-files directory t)))
1476
1477 (defun yas--make-menu-binding (template)
1478 (let ((mode (yas--table-mode (yas--template-table template))))
1479 `(lambda () (interactive) (yas--expand-or-visit-from-menu ',mode ,(yas--template-uuid template)))))
1480
1481 (defun yas--expand-or-visit-from-menu (mode uuid)
1482 (let* ((table (yas--table-get-create mode))
1483 (yas--current-template (and table
1484 (gethash uuid (yas--table-uuidhash table)))))
1485 (when yas--current-template
1486 (if yas-visit-from-menu
1487 (yas--visit-snippet-file-1 yas--current-template)
1488 (let ((where (if (region-active-p)
1489 (cons (region-beginning) (region-end))
1490 (cons (point) (point)))))
1491 (yas-expand-snippet (yas--template-content yas--current-template)
1492 (car where)
1493 (cdr where)
1494 (yas--template-expand-env yas--current-template)))))))
1495
1496 \f
1497 ;;; Popping up for keys and templates
1498
1499 (defvar yas--x-pretty-prompt-templates nil
1500 "If non-nil, attempt to prompt for templates like TextMate.")
1501
1502
1503 (defun yas--prompt-for-template (templates &optional prompt)
1504 "Interactively choose a template from the list TEMPLATES.
1505
1506 TEMPLATES is a list of `yas--template'.
1507
1508 Optional PROMPT sets the prompt to use."
1509 (when templates
1510 (setq templates
1511 (sort templates #'(lambda (t1 t2)
1512 (< (length (yas--template-name t1))
1513 (length (yas--template-name t2))))))
1514 (if yas--x-pretty-prompt-templates
1515 (yas--x-pretty-prompt-templates "Choose a snippet" templates)
1516 (some #'(lambda (fn)
1517 (funcall fn (or prompt "Choose a snippet: ")
1518 templates
1519 #'yas--template-name))
1520 yas-prompt-functions))))
1521
1522 (defun yas--prompt-for-keys (keys &optional prompt)
1523 "Interactively choose a template key from the list KEYS.
1524
1525 Optional PROMPT sets the prompt to use."
1526 (when keys
1527 (some #'(lambda (fn)
1528 (funcall fn (or prompt "Choose a snippet key: ") keys))
1529 yas-prompt-functions)))
1530
1531 (defun yas--prompt-for-table (tables &optional prompt)
1532 "Interactively choose a table from the list TABLES.
1533
1534 Optional PROMPT sets the prompt to use."
1535 (when tables
1536 (some #'(lambda (fn)
1537 (funcall fn (or prompt "Choose a snippet table: ")
1538 tables
1539 #'yas--table-name))
1540 yas-prompt-functions)))
1541
1542 (defun yas-x-prompt (prompt choices &optional display-fn)
1543 "Display choices in a x-window prompt."
1544 ;; FIXME: HACK: if we notice that one of the objects in choices is
1545 ;; actually a `yas--template', defer to `yas--x-prompt-pretty-templates'
1546 ;;
1547 ;; This would be better implemented by passing CHOICES as a
1548 ;; structured tree rather than a list. Modifications would go as far
1549 ;; up as `yas--all-templates' I think.
1550 ;;
1551 (when (and window-system choices)
1552 (let ((chosen
1553 (let (menu d) ;; d for display
1554 (dolist (c choices)
1555 (setq d (or (and display-fn (funcall display-fn c))
1556 c))
1557 (cond ((stringp d)
1558 (push (cons (concat " " d) c) menu))
1559 ((listp d)
1560 (push (car d) menu))))
1561 (setq menu (list prompt (push "title" menu)))
1562 (x-popup-menu (if (fboundp 'posn-at-point)
1563 (let ((x-y (posn-x-y (posn-at-point (point)))))
1564 (list (list (+ (car x-y) 10)
1565 (+ (cdr x-y) 20))
1566 (selected-window)))
1567 t)
1568 menu))))
1569 (or chosen
1570 (keyboard-quit)))))
1571
1572 (defun yas--x-pretty-prompt-templates (prompt templates)
1573 "Display TEMPLATES, grouping neatly by table name."
1574 (let ((organized (make-hash-table :test #'equal))
1575 menu
1576 more-than-one-table
1577 prefix)
1578 (dolist (tl templates)
1579 (puthash (yas--template-table tl)
1580 (cons tl
1581 (gethash (yas--template-table tl) organized))
1582 organized))
1583 (setq more-than-one-table (> (hash-table-count organized) 1))
1584 (setq prefix (if more-than-one-table
1585 " " ""))
1586 (if more-than-one-table
1587 (maphash #'(lambda (table templates)
1588 (push (yas--table-name table) menu)
1589 (dolist (tl templates)
1590 (push (cons (concat prefix (yas--template-name tl)) tl) menu))) organized)
1591 (setq menu (mapcar #'(lambda (tl) (cons (concat prefix (yas--template-name tl)) tl)) templates)))
1592
1593 (setq menu (nreverse menu))
1594 (or (x-popup-menu (if (fboundp 'posn-at-point)
1595 (let ((x-y (posn-x-y (posn-at-point (point)))))
1596 (list (list (+ (car x-y) 10)
1597 (+ (cdr x-y) 20))
1598 (selected-window)))
1599 t)
1600 (list prompt (push "title" menu)))
1601 (keyboard-quit))))
1602
1603 (defun yas-ido-prompt (prompt choices &optional display-fn)
1604 (when (and (fboundp 'ido-completing-read)
1605 (or (>= emacs-major-version 24)
1606 ido-mode))
1607 (yas-completing-prompt prompt choices display-fn #'ido-completing-read)))
1608
1609 (eval-when-compile (require 'dropdown-list nil t))
1610 (defun yas-dropdown-prompt (prompt choices &optional display-fn)
1611 (when (featurep 'dropdown-list)
1612 (let (formatted-choices
1613 filtered-choices
1614 d
1615 n)
1616 (dolist (choice choices)
1617 (setq d (or (and display-fn (funcall display-fn choice))
1618 choice))
1619 (when (stringp d)
1620 (push d formatted-choices)
1621 (push choice filtered-choices)))
1622
1623 (setq n (and formatted-choices (dropdown-list formatted-choices)))
1624 (if n
1625 (nth n filtered-choices)
1626 (keyboard-quit)))))
1627
1628 (defun yas-completing-prompt (prompt choices &optional display-fn completion-fn)
1629 (let (formatted-choices
1630 filtered-choices
1631 chosen
1632 d
1633 (completion-fn (or completion-fn
1634 #'completing-read)))
1635 (dolist (choice choices)
1636 (setq d (or (and display-fn (funcall display-fn choice))
1637 choice))
1638 (when (stringp d)
1639 (push d formatted-choices)
1640 (push choice filtered-choices)))
1641 (setq chosen (and formatted-choices
1642 (funcall completion-fn prompt
1643 formatted-choices
1644 nil
1645 'require-match
1646 nil
1647 nil)))
1648 (let ((position (or (and chosen
1649 (position chosen formatted-choices :test #'string=))
1650 0)))
1651 (nth position filtered-choices))))
1652
1653 (defun yas-no-prompt (prompt choices &optional display-fn)
1654 (first choices))
1655
1656 \f
1657 ;;; Defining snippets
1658 ;; This consists of creating and registering `yas--template' objects in the
1659 ;; correct tables.
1660 ;;
1661
1662 (defun yas--define-snippets-1 (snippet snippet-table)
1663 "Helper for `yas-define-snippets'."
1664 ;; X) Calculate some more defaults on the values returned by
1665 ;; `yas--parse-template'.
1666 ;;
1667 (let* ((file (seventh snippet))
1668 (key (car snippet))
1669 (name (or (third snippet)
1670 (and file
1671 (file-name-directory file))))
1672 (condition (fourth snippet))
1673 (group (fifth snippet))
1674 (keybinding (yas--read-keybinding (eighth snippet)))
1675 (uuid (or (ninth snippet)
1676 name))
1677 (template (or (gethash uuid (yas--table-uuidhash snippet-table))
1678 (yas--make-blank-template))))
1679 ;; X) populate the template object
1680 ;;
1681 (yas--populate-template template
1682 :table snippet-table
1683 :key key
1684 :content (second snippet)
1685 :name (or name key)
1686 :group group
1687 :condition condition
1688 :expand-env (sixth snippet)
1689 :file (seventh snippet)
1690 :keybinding keybinding
1691 :uuid uuid)
1692 ;; X) Update this template in the appropriate table. This step
1693 ;; also will take care of adding the key indicators in the
1694 ;; templates menu entry, if any
1695 ;;
1696 (yas--update-template snippet-table template)
1697 ;; X) Return the template
1698 ;;
1699 ;;
1700 template))
1701
1702 (defun yas-define-snippets (mode snippets)
1703 "Define SNIPPETS for MODE.
1704
1705 SNIPPETS is a list of snippet definitions, each taking the
1706 following form
1707
1708 (KEY TEMPLATE NAME CONDITION GROUP EXPAND-ENV FILE KEYBINDING UUID)
1709
1710 Within these, only KEY and TEMPLATE are actually mandatory.
1711
1712 TEMPLATE might be a lisp form or a string, depending on whether
1713 this is a snippet or a snippet-command.
1714
1715 CONDITION, EXPAND-ENV and KEYBINDING are lisp forms, they have
1716 been `yas--read-lisp'-ed and will eventually be
1717 `yas--eval-lisp'-ed.
1718
1719 The remaining elements are strings.
1720
1721 FILE is probably of very little use if you're programatically
1722 defining snippets.
1723
1724 UUID is the snippets \"unique-id\". Loading a second snippet file
1725 with the same uuid replaced the previous snippet.
1726
1727 You can use `yas--parse-template' to return such lists based on
1728 the current buffers contents."
1729 (let ((snippet-table (yas--table-get-create mode))
1730 (template nil))
1731 (dolist (snippet snippets)
1732 (setq template (yas--define-snippets-1 snippet
1733 snippet-table)))
1734 template))
1735
1736 \f
1737 ;;; Loading snippets from files
1738
1739 (defun yas--load-yas-setup-file (file)
1740 (load file 'noerror))
1741
1742 (defun yas--define-parents (mode parents)
1743 "Add PARENTS to the list of MODE's parents."
1744 (puthash mode (remove-duplicates
1745 (append parents
1746 (gethash mode yas--parents)))
1747 yas--parents))
1748
1749 (defun yas-load-directory (top-level-dir &optional use-jit)
1750 "Load snippets in directory hierarchy TOP-LEVEL-DIR.
1751
1752 Below TOP-LEVEL-DIR each directory should be a mode name.
1753
1754 Optional USE-JIT use jit-loading of snippets."
1755 (interactive "DSelect the root directory: ")
1756 (unless yas-snippet-dirs
1757 (setq yas-snippet-dirs top-level-dir))
1758 (dolist (dir (yas--subdirs top-level-dir))
1759 (let* ((major-mode-and-parents (yas--compute-major-mode-and-parents
1760 (concat dir "/dummy")))
1761 (mode-sym (car major-mode-and-parents))
1762 (parents (cdr major-mode-and-parents)))
1763 ;; Attention: The parents and the menus are already defined
1764 ;; here, even if the snippets are later jit-loaded.
1765 ;;
1766 ;; * We need to know the parents at this point since entering a
1767 ;; given mode should jit load for its parents
1768 ;; immediately. This could be reviewed, the parents could be
1769 ;; discovered just-in-time-as well
1770 ;;
1771 ;; * We need to create the menus here to support the `full'
1772 ;; option to `yas-use-menu' (all known snippet menus are shown to the user)
1773 ;;
1774 (yas--define-parents mode-sym parents)
1775 (yas--menu-keymap-get-create mode-sym)
1776 (let ((form `(yas--load-directory-1 ,dir
1777 ',mode-sym
1778 ',parents)))
1779 (if (and use-jit
1780 (not (some #'(lambda (buffer)
1781 (with-current-buffer buffer
1782 (when (eq major-mode mode-sym)
1783 (yas--message 3 "Discovered there was already %s in %s" buffer mode-sym)
1784 t)))
1785 (buffer-list))))
1786 (yas--schedule-jit mode-sym form)
1787 (eval form)))))
1788 (when (yas--called-interactively-p 'interactive)
1789 (yas--message 3 "Loaded snippets from %s." top-level-dir)))
1790
1791 (defun yas--load-directory-1 (directory mode-sym parents &optional no-compiled-snippets)
1792 "Recursively load snippet templates from DIRECTORY."
1793 (unless (file-exists-p (concat directory "/" ".yas-skip"))
1794 (if (and (not no-compiled-snippets)
1795 (progn (yas--message 2 "Loading compiled snippets from %s" directory) t)
1796 (load (expand-file-name ".yas-compiled-snippets" directory) 'noerror (<= yas-verbosity 3)))
1797 (yas--message 2 "Loading snippet files from %s" directory)
1798 (yas--load-directory-2 directory mode-sym))))
1799
1800 (defun yas--load-directory-2 (directory mode-sym)
1801 ;; Load .yas-setup.el files wherever we find them
1802 ;;
1803 (yas--load-yas-setup-file (expand-file-name ".yas-setup" directory))
1804 (let* ((default-directory directory)
1805 (snippet-defs nil))
1806 ;; load the snippet files
1807 ;;
1808 (with-temp-buffer
1809 (dolist (file (yas--subdirs directory 'no-subdirs-just-files))
1810 (when (file-readable-p file)
1811 (insert-file-contents file nil nil nil t)
1812 (push (yas--parse-template file)
1813 snippet-defs))))
1814 (when snippet-defs
1815 (yas-define-snippets mode-sym
1816 snippet-defs))
1817 ;; now recurse to a lower level
1818 ;;
1819 (dolist (subdir (yas--subdirs directory))
1820 (yas--load-directory-2 subdir
1821 mode-sym))))
1822
1823 (defun yas--load-snippet-dirs (&optional nojit)
1824 "Reload the directories listed in `yas-snippet-dirs' or
1825 prompt the user to select one."
1826 (let (errors)
1827 (if yas-snippet-dirs
1828 (dolist (directory (reverse (yas-snippet-dirs)))
1829 (cond ((file-directory-p directory)
1830 (yas-load-directory directory (not nojit))
1831 (if nojit
1832 (yas--message 3 "Loaded %s" directory)
1833 (yas--message 3 "Prepared just-in-time loading for %s" directory)))
1834 (t
1835 (push (yas--message 0 "Check your `yas-snippet-dirs': %s is not a directory" directory) errors))))
1836 (call-interactively 'yas-load-directory))
1837 errors))
1838
1839 (defun yas-reload-all (&optional interactive)
1840 "Reload all snippets and rebuild the YASnippet menu.
1841
1842 When called interactively force immediate reload of all known
1843 snippets under `yas-snippet-dirs', otherwise use just-in-time
1844 loading."
1845 (interactive "p")
1846 (catch 'abort
1847 (let ((errors)
1848 (snippet-editing-buffers
1849 (remove-if-not #'(lambda (buffer)
1850 (with-current-buffer buffer yas--editing-template))
1851 (buffer-list))))
1852 ;; Warn if there are buffers visiting snippets, since reloading will break
1853 ;; any on-line editing of those buffers.
1854 ;;
1855 (when snippet-editing-buffers
1856 (if interactive
1857 (if (y-or-n-p "Some buffers editing live snippets, close them and proceed with reload? ")
1858 (mapc #'kill-buffer snippet-editing-buffers)
1859 (yas--message 1 "Aborted reload...")
1860 (throw 'abort nil))
1861 ;; in a non-interactive use, at least set
1862 ;; `yas--editing-template' to nil, make it guess it next time around
1863 (mapc #'(lambda (buffer) (setq yas--editing-template nil)) (buffer-list))))
1864
1865 ;; Empty all snippet tables and parenting info
1866 ;;
1867 (setq yas--tables (make-hash-table))
1868 (setq yas--parents (make-hash-table))
1869
1870 ;; Before killing `yas--menu-table' use its keys to cleanup the
1871 ;; mode menu parts of `yas--minor-mode-menu' (thus also cleaning
1872 ;; up `yas-minor-mode-map', which points to it)
1873 ;;
1874 (maphash #'(lambda (menu-symbol keymap)
1875 (define-key yas--minor-mode-menu (vector menu-symbol) nil))
1876 yas--menu-table)
1877 ;; Now empty `yas--menu-table' as well
1878 (setq yas--menu-table (make-hash-table))
1879
1880 ;; Cancel all pending 'yas--scheduled-jit-loads'
1881 ;;
1882 (setq yas--scheduled-jit-loads (make-hash-table))
1883
1884 ;; Reload the directories listed in `yas-snippet-dirs' or prompt
1885 ;; the user to select one.
1886 ;;
1887 (setq errors (yas--load-snippet-dirs interactive))
1888 ;; Reload the direct keybindings
1889 ;;
1890 (yas-direct-keymaps-reload)
1891
1892 (yas--message 3 "Reloaded everything%s...%s."
1893 (if interactive "" " (snippets will load just-in-time)")
1894 (if errors " (some errors, check *Messages*)" "")))))
1895
1896 (defun yas--load-pending-jits ()
1897 (dolist (mode (yas--modes-to-activate))
1898 (let ((forms (reverse (gethash mode yas--scheduled-jit-loads))))
1899 ;; must reverse to maintain coherence with `yas-snippet-dirs'
1900 (dolist (form forms)
1901 (yas--message 3 "Loading for `%s', just-in-time: %s!" mode form)
1902 (eval form))
1903 (remhash mode yas--scheduled-jit-loads))))
1904
1905 ;; (when (<= emacs-major-version 22)
1906 ;; (add-hook 'after-change-major-mode-hook 'yas--load-pending-jits))
1907
1908 (defun yas--quote-string (string)
1909 "Escape and quote STRING.
1910 foo\"bar\\! -> \"foo\\\"bar\\\\!\""
1911 (concat "\""
1912 (replace-regexp-in-string "[\\\"]"
1913 "\\\\\\&"
1914 string
1915 t)
1916 "\""))
1917 \f
1918 ;;; Snippet compilation function
1919
1920 (defun yas--initialize ()
1921 "For backward compatibility, enable `yas-minor-mode' globally."
1922 (yas-global-mode 1))
1923
1924 (defun yas-compile-directory (top-level-dir)
1925 "Create .yas-compiled-snippets.el files under subdirs of TOP-LEVEL-DIR.
1926
1927 This works by stubbing a few functions, then calling
1928 `yas-load-directory'."
1929 (interactive "DTop level snippet directory?")
1930 (yas--with-temporary-redefinitions
1931 ((yas--load-yas-setup-file
1932 (file)
1933 (let ((elfile (concat file ".el")))
1934 (when (file-exists-p elfile)
1935 (insert ";;; .yas-setup.el support file if any:\n;;;\n")
1936 (insert-file-contents elfile)
1937 (goto-char (point-max))
1938 )))
1939 (yas-define-snippets
1940 (mode snippets)
1941 (insert ";;; Snippet definitions:\n;;;\n")
1942 (let ((literal-snippets (list))
1943 (print-length nil))
1944 (dolist (snippet snippets)
1945 (let ((key (first snippet))
1946 (template-content (second snippet))
1947 (name (third snippet))
1948 (condition (fourth snippet))
1949 (group (fifth snippet))
1950 (expand-env (sixth snippet))
1951 (file nil) ;; (seventh snippet)) ;; omit on purpose
1952 (binding (eighth snippet))
1953 (uuid (ninth snippet)))
1954 (push `(,key
1955 ,template-content
1956 ,name
1957 ,condition
1958 ,group
1959 ,expand-env
1960 ,file
1961 ,binding
1962 ,uuid)
1963 literal-snippets)))
1964 (insert (pp-to-string `(yas-define-snippets ',mode ',literal-snippets)))
1965 (insert "\n\n")))
1966 (yas--load-directory-1
1967 (dir mode parents &rest ignore)
1968 (let ((output-file (concat (file-name-as-directory dir) ".yas-compiled-snippets.el")))
1969 (with-temp-file output-file
1970 (insert (format ";;; Compiled snippets and support files for `%s'\n" mode))
1971 (yas--load-directory-2 dir mode)
1972 (insert (format ";;; Do not edit! File generated at %s\n" (current-time-string)))))))
1973 (yas-load-directory top-level-dir nil)))
1974
1975 (defun yas-recompile-all ()
1976 "Compile every dir in `yas-snippet-dirs'."
1977 (interactive)
1978 (mapc #'yas-compile-directory (yas-snippet-dirs)))
1979
1980
1981 ;;; JIT loading
1982 ;;;
1983
1984 (defvar yas--scheduled-jit-loads (make-hash-table)
1985 "Alist of mode-symbols to forms to be evaled when `yas-minor-mode' kicks in.")
1986
1987 (defun yas--schedule-jit (mode form)
1988 (puthash mode
1989 (cons form
1990 (gethash mode yas--scheduled-jit-loads))
1991 yas--scheduled-jit-loads))
1992
1993
1994 \f
1995 ;;; Some user level functions
1996
1997 (defun yas-about ()
1998 (interactive)
1999 (message (concat "yasnippet (version "
2000 yas--version
2001 ") -- pluskid <pluskid@gmail.com>/joaotavora <joaotavora@gmail.com>")))
2002
2003 \f
2004 ;;; Apropos snippet menu:
2005 ;;
2006 ;; The snippet menu keymaps are store by mode in hash table called
2007 ;; `yas--menu-table'. They are linked to the main menu in
2008 ;; `yas--menu-keymap-get-create' and are initially created empty,
2009 ;; reflecting the table hierarchy.
2010 ;;
2011 ;; They can be populated in two mutually exclusive ways: (1) by
2012 ;; reading `yas--template-group', which in turn is populated by the "#
2013 ;; group:" directives of the snippets or the ".yas-make-groups" file
2014 ;; or (2) by using a separate `yas-define-menu' call, which declares a
2015 ;; menu structure based on snippets uuids.
2016 ;;
2017 ;; Both situations are handled in `yas--update-template-menu', which
2018 ;; uses the predicate `yas--template-menu-managed-by-yas-define-menu'
2019 ;; that can tell between the two situations.
2020 ;;
2021 ;; Note:
2022 ;;
2023 ;; * if `yas-define-menu' is used it must run before
2024 ;; `yas-define-snippets' and the UUIDS must match, otherwise we get
2025 ;; duplicate entries. The `yas--template' objects are created in
2026 ;; `yas-define-menu', holding nothing but the menu entry,
2027 ;; represented by a pair of ((menu-item NAME :keys KEYS) TYPE) and
2028 ;; stored in `yas--template-menu-binding-pair'. The (menu-item ...)
2029 ;; part is then stored in the menu keymap itself which make the item
2030 ;; appear to the user. These limitations could probably be revised.
2031 ;;
2032 ;; * The `yas--template-perm-group' slot is only used in
2033 ;; `yas-describe-tables'.
2034 ;;
2035 (defun yas--template-menu-binding-pair-get-create (template &optional type)
2036 "Get TEMPLATE's menu binding or assign it a new one.
2037
2038 TYPE may be `:stay', signaling this menu binding should be
2039 static in the menu."
2040 (or (yas--template-menu-binding-pair template)
2041 (let ((key (yas--template-key template))
2042 (keybinding (yas--template-keybinding template)))
2043 (setf (yas--template-menu-binding-pair template)
2044 (cons `(menu-item ,(or (yas--template-name template)
2045 (yas--template-uuid template))
2046 ,(yas--make-menu-binding template)
2047 :keys ,nil)
2048 type)))))
2049 (defun yas--template-menu-managed-by-yas-define-menu (template)
2050 "Non-nil if TEMPLATE's menu entry was included in a `yas-define-menu' call."
2051 (cdr (yas--template-menu-binding-pair template)))
2052
2053
2054 (defun yas--show-menu-p (mode)
2055 (cond ((eq yas-use-menu 'abbreviate)
2056 (find mode
2057 (mapcar #'(lambda (table)
2058 (yas--table-mode table))
2059 (yas--get-snippet-tables))))
2060 ((eq yas-use-menu 'full)
2061 t)
2062 ((eq yas-use-menu t)
2063 t)))
2064
2065 (defun yas--delete-from-keymap (keymap uuid)
2066 "Recursively delete items with UUID from KEYMAP and its submenus."
2067
2068 ;; XXX: This used to skip any submenus named \"parent mode\"
2069 ;;
2070 ;; First of all, recursively enter submenus, i.e. the tree is
2071 ;; searched depth first so that stale submenus can be found in the
2072 ;; higher passes.
2073 ;;
2074 (mapc #'(lambda (item)
2075 (when (and (listp (cdr item))
2076 (keymapp (third (cdr item))))
2077 (yas--delete-from-keymap (third (cdr item)) uuid)))
2078 (rest keymap))
2079 ;; Set the uuid entry to nil
2080 ;;
2081 (define-key keymap (vector (make-symbol uuid)) nil)
2082 ;; Destructively modify keymap
2083 ;;
2084 (setcdr keymap (delete-if #'(lambda (item)
2085 (or (null (cdr item))
2086 (and (keymapp (third (cdr item)))
2087 (null (cdr (third (cdr item)))))))
2088 (rest keymap))))
2089
2090 (defun yas-define-menu (mode menu &optional omit-items)
2091 "Define a snippet menu for MODE according to MENU, omitting OMIT-ITEMS.
2092
2093 MENU is a list, its elements can be:
2094
2095 - (yas-item UUID) : Creates an entry the snippet identified with
2096 UUID. The menu entry for a snippet thus identified is
2097 permanent, i.e. it will never move (be reordered) in the menu.
2098
2099 - (yas-separator) : Creates a separator
2100
2101 - (yas-submenu NAME SUBMENU) : Creates a submenu with NAME,
2102 SUBMENU has the same form as MENU. NAME is also added to the
2103 list of groups of the snippets defined thereafter.
2104
2105 OMIT-ITEMS is a list of snippet uuid's that will always be
2106 omitted from MODE's menu, even if they're manually loaded.
2107
2108 This function does nothing if `yas-use-menu' is nil."
2109 (when yas-use-menu
2110 (let* ((table (yas--table-get-create mode))
2111 (hash (yas--table-uuidhash table)))
2112 (yas--define-menu-1 table
2113 (yas--menu-keymap-get-create mode)
2114 menu
2115 hash)
2116 (dolist (uuid omit-items)
2117 (let ((template (or (gethash uuid hash)
2118 (yas--populate-template (puthash uuid
2119 (yas--make-blank-template)
2120 hash)
2121 :table table
2122 :uuid uuid))))
2123 (setf (yas--template-menu-binding-pair template) (cons nil :none)))))))
2124
2125 (defun yas--define-menu-1 (table menu-keymap menu uuidhash &optional group-list)
2126 "Helper for `yas-define-menu'."
2127 (dolist (e (reverse menu))
2128 (cond ((eq (first e) 'yas-item)
2129 (let ((template (or (gethash (second e) uuidhash)
2130 (yas--populate-template (puthash (second e)
2131 (yas--make-blank-template)
2132 uuidhash)
2133 :table table
2134 :perm-group group-list
2135 :uuid (second e)))))
2136 (define-key menu-keymap (vector (gensym))
2137 (car (yas--template-menu-binding-pair-get-create template :stay)))))
2138 ((eq (first e) 'yas-submenu)
2139 (let ((subkeymap (make-sparse-keymap)))
2140 (define-key menu-keymap (vector (gensym))
2141 `(menu-item ,(second e) ,subkeymap))
2142 (yas--define-menu-1 table
2143 subkeymap
2144 (third e)
2145 uuidhash
2146 (append group-list (list (second e))))))
2147 ((eq (first e) 'yas-separator)
2148 (define-key menu-keymap (vector (gensym))
2149 '(menu-item "----")))
2150 (t
2151 (yas--message 3 "Don't know anything about menu entry %s" (first e))))))
2152 \f
2153 (defun yas--define (mode key template &optional name condition group)
2154 "Define a snippet. Expanding KEY into TEMPLATE.
2155
2156 NAME is a description to this template. Also update the menu if
2157 `yas-use-menu' is t. CONDITION is the condition attached to
2158 this snippet. If you attach a condition to a snippet, then it
2159 will only be expanded when the condition evaluated to non-nil."
2160 (yas-define-snippets mode
2161 (list (list key template name condition group))))
2162
2163 (defun yas-hippie-try-expand (first-time?)
2164 "Integrate with hippie expand.
2165
2166 Just put this function in `hippie-expand-try-functions-list'."
2167 (when yas-minor-mode
2168 (if (not first-time?)
2169 (let ((yas-fallback-behavior 'return-nil))
2170 (yas-expand))
2171 (undo 1)
2172 nil)))
2173
2174
2175 ;;; Apropos condition-cache:
2176 ;;;
2177 ;;;
2178 ;;;
2179 ;;;
2180 (defvar yas--condition-cache-timestamp nil)
2181 (defmacro yas-define-condition-cache (func doc &rest body)
2182 "Define a function FUNC with doc DOC and body BODY, BODY is
2183 executed at most once every snippet expansion attempt, to check
2184 expansion conditions.
2185
2186 It doesn't make any sense to call FUNC programatically."
2187 `(defun ,func () ,(if (and doc
2188 (stringp doc))
2189 (concat doc
2190 "\n\nFor use in snippets' conditions. Within each
2191 snippet-expansion routine like `yas-expand', computes actual
2192 value for the first time then always returns a cached value.")
2193 (setq body (cons doc body))
2194 nil)
2195 (let ((timestamp-and-value (get ',func 'yas--condition-cache)))
2196 (if (equal (car timestamp-and-value) yas--condition-cache-timestamp)
2197 (cdr timestamp-and-value)
2198 (let ((new-value (progn
2199 ,@body
2200 )))
2201 (put ',func 'yas--condition-cache (cons yas--condition-cache-timestamp new-value))
2202 new-value)))))
2203
2204 (defalias 'yas-expand 'yas-expand-from-trigger-key)
2205 (defun yas-expand-from-trigger-key (&optional field)
2206 "Expand a snippet before point.
2207
2208 If no snippet expansion is possible, fall back to the behaviour
2209 defined in `yas-fallback-behavior'.
2210
2211 Optional argument FIELD is for non-interactive use and is an
2212 object satisfying `yas--field-p' to restrict the expansion to."
2213 (interactive)
2214 (setq yas--condition-cache-timestamp (current-time))
2215 (let (templates-and-pos)
2216 (unless (and yas-expand-only-for-last-commands
2217 (not (member last-command yas-expand-only-for-last-commands)))
2218 (setq templates-and-pos (if field
2219 (save-restriction
2220 (narrow-to-region (yas--field-start field)
2221 (yas--field-end field))
2222 (yas--current-key))
2223 (yas--current-key))))
2224 (if (and templates-and-pos
2225 (first templates-and-pos))
2226 (yas--expand-or-prompt-for-template (first templates-and-pos)
2227 (second templates-and-pos)
2228 (third templates-and-pos))
2229 (yas--fallback 'trigger-key))))
2230
2231 (defun yas-expand-from-keymap ()
2232 "Directly expand some snippets, searching `yas--direct-keymaps'.
2233
2234 If expansion fails, execute the previous binding for this key"
2235 (interactive)
2236 (setq yas--condition-cache-timestamp (current-time))
2237 (let* ((yas--prefix current-prefix-arg)
2238 (vec (subseq (this-command-keys-vector) (if current-prefix-arg
2239 universal-argument-num-events
2240 0)))
2241 (templates (mapcan #'(lambda (table)
2242 (yas--fetch table vec))
2243 (yas--get-snippet-tables))))
2244 (if templates
2245 (yas--expand-or-prompt-for-template templates)
2246 (let ((yas-fallback-behavior 'call-other-command))
2247 (yas--fallback)))))
2248
2249 (defun yas--expand-or-prompt-for-template (templates &optional start end)
2250 "Expand one of TEMPLATES from START to END.
2251
2252 Prompt the user if TEMPLATES has more than one element, else
2253 expand immediately. Common gateway for
2254 `yas-expand-from-trigger-key' and `yas-expand-from-keymap'."
2255 (let ((yas--current-template (or (and (rest templates) ;; more than one
2256 (yas--prompt-for-template (mapcar #'cdr templates)))
2257 (cdar templates))))
2258 (when yas--current-template
2259 (yas-expand-snippet (yas--template-content yas--current-template)
2260 start
2261 end
2262 (yas--template-expand-env yas--current-template)))))
2263
2264 ;; Apropos the trigger key and the fallback binding:
2265 ;;
2266 ;; When `yas-minor-mode-map' binds <tab>, that correctly overrides
2267 ;; org-mode's <tab>, for example and searching for fallbacks correctly
2268 ;; returns `org-cycle'. However, most other modes bind "TAB". TODO,
2269 ;; improve this explanation.
2270 ;;
2271 (defun yas--fallback (&optional from-trigger-key-p)
2272 "Fallback after expansion has failed.
2273
2274 Common gateway for `yas-expand-from-trigger-key' and
2275 `yas-expand-from-keymap'."
2276 (cond ((eq yas-fallback-behavior 'return-nil)
2277 ;; return nil
2278 nil)
2279 ((eq yas-fallback-behavior 'call-other-command)
2280 (let* ((beyond-yasnippet (yas--keybinding-beyond-yasnippet)))
2281 (yas--message 4 "Falling back to %s" beyond-yasnippet)
2282 (assert (or (null beyond-yasnippet) (commandp beyond-yasnippet)))
2283 (setq this-original-command beyond-yasnippet)
2284 (call-interactively beyond-yasnippet)))
2285 ((and (listp yas-fallback-behavior)
2286 (cdr yas-fallback-behavior)
2287 (eq 'apply (car yas-fallback-behavior)))
2288 (if (cddr yas-fallback-behavior)
2289 (apply (cadr yas-fallback-behavior)
2290 (cddr yas-fallback-behavior))
2291 (when (commandp (cadr yas-fallback-behavior))
2292 (setq this-command (cadr yas-fallback-behavior))
2293 (call-interactively (cadr yas-fallback-behavior)))))
2294 (t
2295 ;; also return nil if all the other fallbacks have failed
2296 nil)))
2297
2298 (defun yas--keybinding-beyond-yasnippet ()
2299 "Returns the "
2300 (let* ((yas-minor-mode nil)
2301 (yas--direct-keymaps nil)
2302 (keys (this-single-command-keys)))
2303 (or (key-binding keys t)
2304 (key-binding (yas--fallback-translate-input keys) t))))
2305
2306 (defun yas--fallback-translate-input (keys)
2307 "Emulate `read-key-sequence', at least what I think it does.
2308
2309 Keys should be an untranslated key vector. Returns a translated
2310 vector of keys. FIXME not thoroughly tested"
2311 (let ((retval [])
2312 (i 0))
2313 (while (< i (length keys))
2314 (let ((j i)
2315 (translated local-function-key-map))
2316 (while (and (< j (length keys))
2317 translated
2318 (keymapp translated))
2319 (setq translated (cdr (assoc (aref keys j) (remove 'keymap translated)))
2320 j (1+ j)))
2321 (setq retval (vconcat retval (cond ((symbolp translated)
2322 `[,translated])
2323 ((vectorp translated)
2324 translated)
2325 (t
2326 (substring keys i j)))))
2327 (setq i j)))
2328 retval))
2329
2330 \f
2331 ;;; Utils for snippet development:
2332
2333 (defun yas--all-templates (tables)
2334 "Get `yas--template' objects in TABLES, applicable for buffer and point.
2335
2336 Honours `yas-choose-tables-first', `yas-choose-keys-first' and
2337 `yas-buffer-local-condition'"
2338 (when yas-choose-tables-first
2339 (setq tables (list (yas--prompt-for-table tables))))
2340 (mapcar #'cdr
2341 (if yas-choose-keys-first
2342 (let ((key (yas--prompt-for-keys
2343 (mapcan #'yas--table-all-keys tables))))
2344 (when key
2345 (mapcan #'(lambda (table)
2346 (yas--fetch table key))
2347 tables)))
2348 (remove-duplicates (mapcan #'yas--table-templates tables)
2349 :test #'equal))))
2350
2351 (defun yas-insert-snippet (&optional no-condition)
2352 "Choose a snippet to expand, pop-up a list of choices according
2353 to `yas--prompt-function'.
2354
2355 With prefix argument NO-CONDITION, bypass filtering of snippets
2356 by condition."
2357 (interactive "P")
2358 (setq yas--condition-cache-timestamp (current-time))
2359 (let* ((yas-buffer-local-condition (or (and no-condition
2360 'always)
2361 yas-buffer-local-condition))
2362 (templates (yas--all-templates (yas--get-snippet-tables)))
2363 (yas--current-template (and templates
2364 (or (and (rest templates) ;; more than one template for same key
2365 (yas--prompt-for-template templates))
2366 (car templates))))
2367 (where (if (region-active-p)
2368 (cons (region-beginning) (region-end))
2369 (cons (point) (point)))))
2370 (if yas--current-template
2371 (yas-expand-snippet (yas--template-content yas--current-template)
2372 (car where)
2373 (cdr where)
2374 (yas--template-expand-env yas--current-template))
2375 (yas--message 3 "No snippets can be inserted here!"))))
2376
2377 (defun yas-visit-snippet-file ()
2378 "Choose a snippet to edit, selection like `yas-insert-snippet'.
2379
2380 Only success if selected snippet was loaded from a file. Put the
2381 visited file in `snippet-mode'."
2382 (interactive)
2383 (let* ((yas-buffer-local-condition 'always)
2384 (templates (yas--all-templates (yas--get-snippet-tables)))
2385 (yas-prompt-functions '(yas-ido-prompt yas-completing-prompt))
2386 (template (and templates
2387 (or (yas--prompt-for-template templates
2388 "Choose a snippet template to edit: ")
2389 (car templates)))))
2390
2391 (if template
2392 (yas--visit-snippet-file-1 template)
2393 (message "No snippets tables active!"))))
2394
2395 (defun yas--visit-snippet-file-1 (template)
2396 "Helper for `yas-visit-snippet-file'."
2397 (let ((file (yas--template-file template)))
2398 (cond ((and file (file-readable-p file))
2399 (find-file-other-window file)
2400 (snippet-mode)
2401 (set (make-local-variable 'yas--editing-template) template))
2402 (file
2403 (message "Original file %s no longer exists!" file))
2404 (t
2405 (switch-to-buffer (format "*%s*"(yas--template-name template)))
2406 (let ((type 'snippet))
2407 (when (listp (yas--template-content template))
2408 (insert (format "# type: command\n"))
2409 (setq type 'command))
2410 (insert (format "# key: %s\n" (yas--template-key template)))
2411 (insert (format "# name: %s\n" (yas--template-name template)))
2412 (when (yas--template-keybinding template)
2413 (insert (format "# binding: %s\n" (yas--template-keybinding template))))
2414 (when (yas--template-expand-env template)
2415 (insert (format "# expand-env: %s\n" (yas--template-expand-env template))))
2416 (when (yas--template-condition template)
2417 (insert (format "# condition: %s\n" (yas--template-condition template))))
2418 (insert "# --\n")
2419 (insert (if (eq type 'command)
2420 (pp-to-string (yas--template-content template))
2421 (yas--template-content template))))
2422 (snippet-mode)
2423 (set (make-local-variable 'yas--editing-template) template)))))
2424
2425 (defun yas--guess-snippet-directories-1 (table)
2426 "Guesses possible snippet subdirectories for TABLE."
2427 (cons (yas--table-name table)
2428 (mapcan #'(lambda (parent)
2429 (yas--guess-snippet-directories-1
2430 parent))
2431 (yas--table-parents table))))
2432
2433 (defun yas--guess-snippet-directories (&optional table)
2434 "Try to guess suitable directories based on the current active
2435 tables (or optional TABLE).
2436
2437 Returns a list of elements (TABLE . DIRS) where TABLE is a
2438 `yas--table' object and DIRS is a list of all possible directories
2439 where snippets of table might exist."
2440 (let ((main-dir (replace-regexp-in-string
2441 "/+$" ""
2442 (or (first (or (yas-snippet-dirs)
2443 (setq yas-snippet-dirs '("~/.emacs.d/snippets")))))))
2444 (tables (or (and table
2445 (list table))
2446 (yas--get-snippet-tables))))
2447 ;; HACK! the snippet table created here is actually registered!
2448 ;;
2449 (unless (or table (gethash major-mode yas--tables))
2450 (push (yas--table-get-create major-mode)
2451 tables))
2452
2453 (mapcar #'(lambda (table)
2454 (cons table
2455 (mapcar #'(lambda (subdir)
2456 (concat main-dir "/" subdir))
2457 (yas--guess-snippet-directories-1 table))))
2458 tables)))
2459
2460 (defun yas--make-directory-maybe (table-and-dirs &optional main-table-string)
2461 "Returns a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
2462 (or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
2463 (let ((candidate (first (cdr table-and-dirs))))
2464 (unless (file-writable-p (file-name-directory candidate))
2465 (error (yas--format "%s is not writable." candidate)))
2466 (if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
2467 candidate
2468 (if (gethash (yas--table-mode (car table-and-dirs))
2469 yas--tables)
2470 ""
2471 " brand new")
2472 (or main-table-string
2473 "")
2474 (yas--table-name (car table-and-dirs))))
2475 (progn
2476 (make-directory candidate 'also-make-parents)
2477 ;; create the .yas-parents file here...
2478 candidate)))))
2479
2480 (defun yas-new-snippet (&optional no-template)
2481 "Pops a new buffer for writing a snippet.
2482
2483 Expands a snippet-writing snippet, unless the optional prefix arg
2484 NO-TEMPLATE is non-nil."
2485 (interactive "P")
2486 (let ((guessed-directories (yas--guess-snippet-directories)))
2487
2488 (switch-to-buffer "*new snippet*")
2489 (erase-buffer)
2490 (kill-all-local-variables)
2491 (snippet-mode)
2492 (yas-minor-mode 1)
2493 (set (make-local-variable 'yas--guessed-modes) (mapcar #'(lambda (d)
2494 (yas--table-mode (car d)))
2495 guessed-directories))
2496 (unless no-template (yas-expand-snippet "\
2497 # -*- mode: snippet -*-
2498 # name: $1
2499 # key: ${2:${1:$(replace-regexp-in-string \"\\\\\\\\(\\\\\\\\w+\\\\\\\\).*\" \"\\\\\\\\1\" yas-text)}}${3:
2500 # binding: ${4:direct-keybinding}}${5:
2501 # expand-env: ((${6:some-var} ${7:some-value}))}${8:
2502 # type: command}
2503 # --
2504 $0"))))
2505
2506 (defun yas--compute-major-mode-and-parents (file)
2507 "Given FILE, find the nearest snippet directory for a given mode.
2508
2509 Returns a list (MODE-SYM PARENTS), the mode's symbol and a list
2510 representing one or more of the mode's parents.
2511
2512 Note that MODE-SYM need not be the symbol of a real major mode,
2513 neither do the elements of PARENTS."
2514 (let* ((file-dir (and file
2515 (directory-file-name (or (some #'(lambda (special)
2516 (locate-dominating-file file special))
2517 '(".yas-setup.el"
2518 ".yas-make-groups"
2519 ".yas-parents"))
2520 (directory-file-name (file-name-directory file))))))
2521 (parents-file-name (concat file-dir "/.yas-parents"))
2522 (major-mode-name (and file-dir
2523 (file-name-nondirectory file-dir)))
2524 (major-mode-sym (or (and major-mode-name
2525 (intern major-mode-name))))
2526 (parents (when (file-readable-p parents-file-name)
2527 (mapcar #'intern
2528 (split-string
2529 (with-temp-buffer
2530 (insert-file-contents parents-file-name)
2531 (buffer-substring-no-properties (point-min)
2532 (point-max))))))))
2533 (when major-mode-sym
2534 (cons major-mode-sym parents))))
2535
2536 (defvar yas--editing-template nil
2537 "Supporting variable for `yas-load-snippet-buffer' and `yas--visit-snippet'.")
2538
2539 (defvar yas--current-template nil
2540 "Holds the current template being expanded into a snippet.")
2541
2542 (defvar yas--guessed-modes nil
2543 "List of guessed modes supporting `yas-load-snippet-buffer'.")
2544
2545 (defun yas--read-table ()
2546 "Ask user for a snippet table, help with some guessing."
2547 (let ((prompt (if (and (featurep 'ido)
2548 ido-mode)
2549 'ido-completing-read 'completing-read)))
2550 (unless yas--guessed-modes
2551 (set (make-local-variable 'yas--guessed-modes)
2552 (or (yas--compute-major-mode-and-parents buffer-file-name))))
2553 (intern
2554 (funcall prompt (format "Choose or enter a table (yas guesses %s): "
2555 (if yas--guessed-modes
2556 (first yas--guessed-modes)
2557 "nothing"))
2558 (mapcar #'symbol-name yas--guessed-modes)
2559 nil
2560 nil
2561 nil
2562 nil
2563 (if (first yas--guessed-modes)
2564 (symbol-name (first yas--guessed-modes)))))))
2565
2566 (defun yas-load-snippet-buffer (table &optional interactive)
2567 "Parse and load current buffer's snippet definition into TABLE.
2568
2569 TABLE is a symbol naming a passed to `yas--table-get-create'.
2570
2571 When called interactively, prompt for the table name and
2572 whether (and where) to save the snippet, then quit the window."
2573 (interactive (list (yas--read-table) t))
2574 (cond
2575 ;; We have `yas--editing-template', this buffer's content comes from a
2576 ;; template which is already loaded and neatly positioned,...
2577 ;;
2578 (yas--editing-template
2579 (yas--define-snippets-1 (yas--parse-template (yas--template-file yas--editing-template))
2580 (yas--template-table yas--editing-template)))
2581 ;; Try to use `yas--guessed-modes'. If we don't have that use the
2582 ;; value from `yas--compute-major-mode-and-parents'
2583 ;;
2584 (t
2585 (unless yas--guessed-modes
2586 (set (make-local-variable 'yas--guessed-modes) (or (yas--compute-major-mode-and-parents buffer-file-name))))
2587 (let* ((table (yas--table-get-create table)))
2588 (set (make-local-variable 'yas--editing-template)
2589 (yas--define-snippets-1 (yas--parse-template buffer-file-name)
2590 table)))))
2591
2592 (when (and interactive
2593 (or
2594 ;; Only offer to save this if it looks like a library or new
2595 ;; snippet (loaded from elisp, from a dir in `yas-snippet-dirs'
2596 ;; which is not the first, or from an unwritable file)
2597 ;;
2598 (not (yas--template-file yas--editing-template))
2599 (not (file-writable-p (yas--template-file yas--editing-template)))
2600 (and (listp yas-snippet-dirs)
2601 (second yas-snippet-dirs)
2602 (not (string-match (expand-file-name (first yas-snippet-dirs))
2603 (yas--template-file yas--editing-template)))))
2604 (y-or-n-p (yas--format "Looks like a library or new snippet. Save to new file? ")))
2605 (let* ((option (first (yas--guess-snippet-directories (yas--template-table yas--editing-template))))
2606 (chosen (and option
2607 (yas--make-directory-maybe option))))
2608 (when chosen
2609 (let ((default-file-name (or (and (yas--template-file yas--editing-template)
2610 (file-name-nondirectory (yas--template-file yas--editing-template)))
2611 (yas--template-name yas--editing-template))))
2612 (write-file (concat chosen "/"
2613 (read-from-minibuffer (format "File name to create in %s? " chosen)
2614 default-file-name)))
2615 (setf (yas--template-file yas--editing-template) buffer-file-name)))))
2616 (when interactive
2617 (yas--message 3 "Snippet \"%s\" loaded for %s."
2618 (yas--template-name yas--editing-template)
2619 (yas--table-name (yas--template-table yas--editing-template)))
2620 (quit-window interactive)))
2621
2622 (defun yas-tryout-snippet (&optional debug)
2623 "Test current buffer's snippet template in other buffer."
2624 (interactive "P")
2625 (let* ((major-mode-and-parent (yas--compute-major-mode-and-parents buffer-file-name))
2626 (parsed (yas--parse-template))
2627 (test-mode (or (and (car major-mode-and-parent)
2628 (fboundp (car major-mode-and-parent))
2629 (car major-mode-and-parent))
2630 (first yas--guessed-modes)
2631 (intern (read-from-minibuffer (yas--format "Please input a mode: ")))))
2632 (yas--current-template
2633 (and parsed
2634 (fboundp test-mode)
2635 (yas--populate-template (yas--make-blank-template)
2636 :table nil ;; no tables for ephemeral snippets
2637 :key (first parsed)
2638 :content (second parsed)
2639 :name (third parsed)
2640 :expand-env (sixth parsed)))))
2641 (cond (yas--current-template
2642 (let ((buffer-name (format "*testing snippet: %s*" (yas--template-name yas--current-template))))
2643 (kill-buffer (get-buffer-create buffer-name))
2644 (switch-to-buffer (get-buffer-create buffer-name))
2645 (setq buffer-undo-list nil)
2646 (condition-case nil (funcall test-mode) (error nil))
2647 (yas-minor-mode 1)
2648 (setq buffer-read-only nil)
2649 (yas-expand-snippet (yas--template-content yas--current-template)
2650 (point-min)
2651 (point-max)
2652 (yas--template-expand-env yas--current-template))
2653 (when (and debug
2654 (require 'yasnippet-debug nil t))
2655 (add-hook 'post-command-hook 'yas-debug-snippet-vars nil t))))
2656 (t
2657 (yas--message 3 "Cannot test snippet for unknown major mode")))))
2658
2659 (defun yas-active-keys ()
2660 "Return all active trigger keys for current buffer and point."
2661 (remove-duplicates
2662 (remove-if-not #'stringp (mapcan #'yas--table-all-keys (yas--get-snippet-tables)))
2663 :test #'string=))
2664
2665 (defun yas--template-fine-group (template)
2666 (car (last (or (yas--template-group template)
2667 (yas--template-perm-group template)))))
2668
2669 (defun yas-describe-tables (&optional choose)
2670 "Display snippets for each table."
2671 (interactive "P")
2672 (let* ((by-name-hash (and choose
2673 (y-or-n-p "Show by namehash? ")))
2674 (buffer (get-buffer-create "*YASnippet tables*"))
2675 (active-tables (yas--get-snippet-tables))
2676 (remain-tables (let ((all))
2677 (maphash #'(lambda (k v)
2678 (unless (find v active-tables)
2679 (push v all)))
2680 yas--tables)
2681 all))
2682 (table-lists (list active-tables remain-tables))
2683 (original-buffer (current-buffer))
2684 (continue t)
2685 (yas--condition-cache-timestamp (current-time)))
2686 (with-current-buffer buffer
2687 (setq buffer-read-only nil)
2688 (erase-buffer)
2689 (cond ((not by-name-hash)
2690 (insert "YASnippet tables: \n")
2691 (while (and table-lists
2692 continue)
2693 (dolist (table (car table-lists))
2694 (yas--describe-pretty-table table original-buffer))
2695 (setq table-lists (cdr table-lists))
2696 (when table-lists
2697 (yas--create-snippet-xrefs)
2698 (display-buffer buffer)
2699 (setq continue (and choose (y-or-n-p "Show also non-active tables? ")))))
2700 (yas--create-snippet-xrefs)
2701 (help-mode)
2702 (goto-char 1))
2703 (t
2704 (insert "\n\nYASnippet tables by NAMEHASH: \n")
2705 (dolist (table (append active-tables remain-tables))
2706 (insert (format "\nSnippet table `%s':\n\n" (yas--table-name table)))
2707 (let ((keys))
2708 (maphash #'(lambda (k v)
2709 (push k keys))
2710 (yas--table-hash table))
2711 (dolist (key keys)
2712 (insert (format " key %s maps snippets: %s\n" key
2713 (let ((names))
2714 (maphash #'(lambda (k v)
2715 (push k names))
2716 (gethash key (yas--table-hash table)))
2717 names))))))))
2718 (goto-char 1)
2719 (setq buffer-read-only t))
2720 (display-buffer buffer)))
2721
2722 (defun yas--describe-pretty-table (table &optional original-buffer)
2723 (insert (format "\nSnippet table `%s'"
2724 (yas--table-name table)))
2725 (if (yas--table-parents table)
2726 (insert (format " parents: %s\n"
2727 (mapcar #'yas--table-name
2728 (yas--table-parents table))))
2729 (insert "\n"))
2730 (insert (make-string 100 ?-) "\n")
2731 (insert "group state name key binding\n")
2732 (let ((groups-hash (make-hash-table :test #'equal)))
2733 (maphash #'(lambda (k v)
2734 (let ((group (or (yas--template-fine-group v)
2735 "(top level)")))
2736 (when (yas--template-name v)
2737 (puthash group
2738 (cons v (gethash group groups-hash))
2739 groups-hash))))
2740 (yas--table-uuidhash table))
2741 (maphash
2742 #'(lambda (group templates)
2743 (setq group (truncate-string-to-width group 25 0 ? "..."))
2744 (insert (make-string 100 ?-) "\n")
2745 (dolist (p templates)
2746 (let ((name (truncate-string-to-width (propertize (format "\\\\snippet `%s'" (yas--template-name p))
2747 'yasnippet p)
2748 50 0 ? "..."))
2749 (group (prog1 group
2750 (setq group (make-string (length group) ? ))))
2751 (condition-string (let ((condition (yas--template-condition p)))
2752 (if (and condition
2753 original-buffer)
2754 (with-current-buffer original-buffer
2755 (if (yas--eval-condition condition)
2756 "(y)"
2757 "(s)"))
2758 "(a)"))))
2759 (insert group " ")
2760 (insert condition-string " ")
2761 (insert name
2762 (if (string-match "\\.\\.\\.$" name)
2763 "'"
2764 " ")
2765 " ")
2766 (insert (truncate-string-to-width (or (yas--template-key p) "")
2767 15 0 ? "...") " ")
2768 (insert (truncate-string-to-width (key-description (yas--template-keybinding p))
2769 15 0 ? "...") " ")
2770 (insert "\n"))))
2771 groups-hash)))
2772
2773
2774 \f
2775 ;;; User convenience functions, for using in snippet definitions
2776
2777 (defvar yas-modified-p nil
2778 "Non-nil if field has been modified by user or transformation.")
2779
2780 (defvar yas-moving-away-p nil
2781 "Non-nil if user is about to exit field.")
2782
2783 (defvar yas-text nil
2784 "Contains current field text.")
2785
2786 (defun yas-substr (str pattern &optional subexp)
2787 "Search PATTERN in STR and return SUBEXPth match.
2788
2789 If found, the content of subexp group SUBEXP (default 0) is
2790 returned, or else the original STR will be returned."
2791 (let ((grp (or subexp 0)))
2792 (save-match-data
2793 (if (string-match pattern str)
2794 (match-string-no-properties grp str)
2795 str))))
2796
2797 (defun yas-choose-value (&rest possibilities)
2798 "Prompt for a string in POSSIBILITIES and return it.
2799
2800 The last element of POSSIBILITIES may be a list of strings."
2801 (unless (or yas-moving-away-p
2802 yas-modified-p)
2803 (setq possibilities (nreverse possibilities))
2804 (setq possibilities (if (listp (car possibilities))
2805 (append (reverse (car possibilities)) (rest possibilities))
2806 possibilities))
2807 (some #'(lambda (fn)
2808 (funcall fn "Choose: " possibilities))
2809 yas-prompt-functions)))
2810
2811 (defun yas-key-to-value (alist)
2812 (unless (or yas-moving-away-p
2813 yas-modified-p)
2814 (let ((key (read-key-sequence "")))
2815 (when (stringp key)
2816 (or (cdr (find key alist :key #'car :test #'string=))
2817 key)))))
2818
2819 (defun yas-throw (text)
2820 "Throw a yas--exception with TEXT as the reason."
2821 (throw 'yas--exception (cons 'yas--exception text)))
2822
2823 (defun yas-verify-value (possibilities)
2824 "Verify that the current field value is in POSSIBILITIES.
2825
2826 Otherwise throw exception."
2827 (when (and yas-moving-away-p (notany #'(lambda (pos) (string= pos yas-text)) possibilities))
2828 (yas-throw (yas--format "Field only allows %s" possibilities))))
2829
2830 (defun yas-field-value (number)
2831 "Get the string for field with NUMBER.
2832
2833 Use this in primary and mirror transformations to tget."
2834 (let* ((snippet (car (yas--snippets-at-point)))
2835 (field (and snippet
2836 (yas--snippet-find-field snippet number))))
2837 (when field
2838 (yas--field-text-for-display field))))
2839
2840 (defun yas-text ()
2841 "Return `yas-text' if that exists and is non-empty, else nil."
2842 (if (and yas-text
2843 (not (string= "" yas-text)))
2844 yas-text))
2845
2846 (defun yas-selected-text ()
2847 "Return `yas-selected-text' if that exists and is non-empty, else nil."
2848 (if (and yas-selected-text
2849 (not (string= "" yas-selected-text)))
2850 yas-selected-text))
2851
2852 (defun yas--get-field-once (number &optional transform-fn)
2853 (unless yas-modified-p
2854 (if transform-fn
2855 (funcall transform-fn (yas-field-value number))
2856 (yas-field-value number))))
2857
2858 (defun yas-default-from-field (number)
2859 (unless yas-modified-p
2860 (yas-field-value number)))
2861
2862 (defun yas-inside-string ()
2863 "Return non-nil if the point is inside a string according to font-lock."
2864 (equal 'font-lock-string-face (get-char-property (1- (point)) 'face)))
2865
2866 (defun yas-unimplemented (&optional missing-feature)
2867 (if yas--current-template
2868 (if (y-or-n-p (format "This snippet is unimplemented (missing %s) Visit the snippet definition? "
2869 (or missing-feature
2870 "something")))
2871 (yas--visit-snippet-file-1 yas--current-template))
2872 (message "No implementation. Missing %s" (or missing-feature "something"))))
2873
2874 \f
2875 ;;; Snippet expansion and field management
2876
2877 (defvar yas--active-field-overlay nil
2878 "Overlays the currently active field.")
2879
2880 (defvar yas--field-protection-overlays nil
2881 "Two overlays protect the current active field.")
2882
2883 (defconst yas--prefix nil
2884 "A prefix argument for expansion direct from keybindings.")
2885
2886 (defvar yas-selected-text nil
2887 "The selected region deleted on the last snippet expansion.")
2888
2889 (defvar yas--start-column nil
2890 "The column where the snippet expansion started.")
2891
2892 (make-variable-buffer-local 'yas--active-field-overlay)
2893 (make-variable-buffer-local 'yas--field-protection-overlays)
2894 (put 'yas--active-field-overlay 'permanent-local t)
2895 (put 'yas--field-protection-overlays 'permanent-local t)
2896
2897 (defstruct (yas--snippet (:constructor yas--make-snippet ()))
2898 "A snippet.
2899
2900 ..."
2901 (fields '())
2902 (exit nil)
2903 (id (yas--snippet-next-id) :read-only t)
2904 (control-overlay nil)
2905 active-field
2906 ;; stacked expansion: the `previous-active-field' slot saves the
2907 ;; active field where the child expansion took place
2908 previous-active-field
2909 force-exit)
2910
2911 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
2912 "A field.
2913
2914 NUMBER is the field number.
2915 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2916 PARENT-FIELD is a `yas--field' this field is nested under, or nil.
2917 MIRRORS is a list of `yas--mirror's
2918 TRANSFORM is a lisp form.
2919 MODIFIED-P is a boolean set to true once user inputs text.
2920 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'.
2921 "
2922 number
2923 start end
2924 parent-field
2925 (mirrors '())
2926 (transform nil)
2927 (modified-p nil)
2928 next)
2929
2930
2931 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
2932 "A mirror.
2933
2934 START and END are mostly buffer markers, but see \"apropos markers-to-points\".
2935 TRANSFORM is a lisp form.
2936 PARENT-FIELD is a `yas--field' this mirror is nested under, or nil.
2937 NEXT is another `yas--field' or `yas--mirror' or `yas--exit'
2938 DEPTH is a count of how many nested mirrors can affect this mirror"
2939 start end
2940 (transform nil)
2941 parent-field
2942 next
2943 depth)
2944
2945 (defstruct (yas--exit (:constructor yas--make-exit (marker)))
2946 marker
2947 next)
2948
2949 (defun yas--apply-transform (field-or-mirror field &optional empty-on-nil-p)
2950 "Calculate transformed string for FIELD-OR-MIRROR from FIELD.
2951
2952 If there is no transform for ht field, return nil.
2953
2954 If there is a transform but it returns nil, return the empty
2955 string iff EMPTY-ON-NIL-P is true."
2956 (let* ((yas-text (yas--field-text-for-display field))
2957 (text yas-text)
2958 (yas-modified-p (yas--field-modified-p field))
2959 (yas-moving-away-p nil)
2960 (transform (if (yas--mirror-p field-or-mirror)
2961 (yas--mirror-transform field-or-mirror)
2962 (yas--field-transform field-or-mirror)))
2963 (start-point (if (yas--mirror-p field-or-mirror)
2964 (yas--mirror-start field-or-mirror)
2965 (yas--field-start field-or-mirror)))
2966 (transformed (and transform
2967 (save-excursion
2968 (goto-char start-point)
2969 (let ((ret (yas--eval-lisp transform)))
2970 (or ret (and empty-on-nil-p "")))))))
2971 transformed))
2972
2973 (defsubst yas--replace-all (from to &optional text)
2974 "Replace all occurrences from FROM to TO.
2975
2976 With optional string TEXT do it in that string."
2977 (if text
2978 (replace-regexp-in-string (regexp-quote from) to text t t)
2979 (goto-char (point-min))
2980 (while (search-forward from nil t)
2981 (replace-match to t t text))))
2982
2983 (defun yas--snippet-find-field (snippet number)
2984 (find-if #'(lambda (field)
2985 (eq number (yas--field-number field)))
2986 (yas--snippet-fields snippet)))
2987
2988 (defun yas--snippet-sort-fields (snippet)
2989 "Sort the fields of SNIPPET in navigation order."
2990 (setf (yas--snippet-fields snippet)
2991 (sort (yas--snippet-fields snippet)
2992 #'yas--snippet-field-compare)))
2993
2994 (defun yas--snippet-field-compare (field1 field2)
2995 "Compare FIELD1 and FIELD2.
2996
2997 The field with a number is sorted first. If they both have a
2998 number, compare through the number. If neither have, compare
2999 through the field's start point"
3000 (let ((n1 (yas--field-number field1))
3001 (n2 (yas--field-number field2)))
3002 (if n1
3003 (if n2
3004 (or (zerop n2) (and (not (zerop n1))
3005 (< n1 n2)))
3006 (not (zerop n1)))
3007 (if n2
3008 (zerop n2)
3009 (< (yas--field-start field1)
3010 (yas--field-start field2))))))
3011
3012 (defun yas--field-probably-deleted-p (snippet field)
3013 "Guess if SNIPPET's FIELD should be skipped."
3014 (and
3015 ;; field must be zero length
3016 ;;
3017 (zerop (- (yas--field-start field) (yas--field-end field)))
3018 ;; skip if:
3019 (or
3020 ;; 1) is a nested field and it's been modified
3021 ;;
3022 (and (yas--field-parent-field field)
3023 (yas--field-modified-p field))
3024 ;; 2) ends just before the snippet end
3025 ;;
3026 (and (eq field (car (last (yas--snippet-fields snippet))))
3027 (= (yas--field-start field) (overlay-end (yas--snippet-control-overlay snippet)))))
3028 ;; the field numbered 0, just before the exit marker, should
3029 ;; never be skipped
3030 ;;
3031 (not (zerop (yas--field-number field)))))
3032
3033 (defun yas--snippets-at-point (&optional all-snippets)
3034 "Return a sorted list of snippets at point.
3035
3036 The most recently-inserted snippets are returned first."
3037 (sort
3038 (remove nil (remove-duplicates (mapcar #'(lambda (ov)
3039 (overlay-get ov 'yas--snippet))
3040 (if all-snippets
3041 (overlays-in (point-min) (point-max))
3042 (nconc (overlays-at (point)) (overlays-at (1- (point))))))))
3043 #'(lambda (s1 s2)
3044 (<= (yas--snippet-id s2) (yas--snippet-id s1)))))
3045
3046 (defun yas-next-field-or-maybe-expand ()
3047 "Try to expand a snippet at a key before point.
3048
3049 Otherwise delegate to `yas-next-field'."
3050 (interactive)
3051 (if yas-triggers-in-field
3052 (let ((yas-fallback-behavior 'return-nil)
3053 (active-field (overlay-get yas--active-field-overlay 'yas--field)))
3054 (when active-field
3055 (unless (yas-expand-from-trigger-key active-field)
3056 (yas-next-field))))
3057 (yas-next-field)))
3058
3059 (defun yas-next-field (&optional arg)
3060 "Navigate to the ARGth next field.
3061
3062 If there's none, exit the snippet."
3063 (interactive)
3064 (let* ((arg (or arg
3065 1))
3066 (snippet (first (yas--snippets-at-point)))
3067 (active-field (overlay-get yas--active-field-overlay 'yas--field))
3068 (live-fields (remove-if #'(lambda (field)
3069 (and (not (eq field active-field))
3070 (yas--field-probably-deleted-p snippet field)))
3071 (yas--snippet-fields snippet)))
3072 (active-field-pos (position active-field live-fields))
3073 (target-pos (and active-field-pos (+ arg active-field-pos)))
3074 (target-field (and target-pos (nth target-pos live-fields))))
3075 ;; First check if we're moving out of a field with a transform
3076 ;;
3077 (when (and active-field
3078 (yas--field-transform active-field))
3079 (let* ((yas-moving-away-p t)
3080 (yas-text (yas--field-text-for-display active-field))
3081 (text yas-text)
3082 (yas-modified-p (yas--field-modified-p active-field)))
3083 ;; primary field transform: exit call to field-transform
3084 (yas--eval-lisp (yas--field-transform active-field))))
3085 ;; Now actually move...
3086 (cond ((and target-pos (>= target-pos (length live-fields)))
3087 (yas-exit-snippet snippet))
3088 (target-field
3089 (yas--move-to-field snippet target-field))
3090 (t
3091 nil))))
3092
3093 (defun yas--place-overlays (snippet field)
3094 "Correctly place overlays for SNIPPET's FIELD."
3095 (yas--make-move-field-protection-overlays snippet field)
3096 (yas--make-move-active-field-overlay snippet field))
3097
3098 (defun yas--move-to-field (snippet field)
3099 "Update SNIPPET to move to field FIELD.
3100
3101 Also create some protection overlays"
3102 (goto-char (yas--field-start field))
3103 (yas--place-overlays snippet field)
3104 (overlay-put yas--active-field-overlay 'yas--field field)
3105 (let ((number (yas--field-number field)))
3106 ;; check for the special ${0: ...} field
3107 (if (and number (zerop number))
3108 (progn
3109 (set-mark (yas--field-end field))
3110 (setf (yas--snippet-force-exit snippet)
3111 (or (yas--field-transform field)
3112 t)))
3113 ;; make this field active
3114 (setf (yas--snippet-active-field snippet) field)
3115 ;; primary field transform: first call to snippet transform
3116 (unless (yas--field-modified-p field)
3117 (if (yas--field-update-display field snippet)
3118 (yas--update-mirrors snippet)
3119 (setf (yas--field-modified-p field) nil))))))
3120
3121 (defun yas-prev-field ()
3122 "Navigate to prev field. If there's none, exit the snippet."
3123 (interactive)
3124 (yas-next-field -1))
3125
3126 (defun yas-abort-snippet (&optional snippet)
3127 (interactive)
3128 (let ((snippet (or snippet
3129 (car (yas--snippets-at-point)))))
3130 (when snippet
3131 (setf (yas--snippet-force-exit snippet) t))))
3132
3133 (defun yas-exit-snippet (snippet)
3134 "Goto exit-marker of SNIPPET."
3135 (interactive (list (first (yas--snippets-at-point))))
3136 (when snippet
3137 (setf (yas--snippet-force-exit snippet) t)
3138 (goto-char (if (yas--snippet-exit snippet)
3139 (yas--exit-marker (yas--snippet-exit snippet))
3140 (overlay-end (yas--snippet-control-overlay snippet))))))
3141
3142 (defun yas-exit-all-snippets ()
3143 "Exit all snippets."
3144 (interactive)
3145 (mapc #'(lambda (snippet)
3146 (yas-exit-snippet snippet)
3147 (yas--check-commit-snippet))
3148 (yas--snippets-at-point 'all-snippets)))
3149
3150 \f
3151 ;;; Some low level snippet-routines:
3152
3153 (defmacro yas--inhibit-overlay-hooks (&rest body)
3154 "Run BODY with `yas--inhibit-overlay-hooks' set to t."
3155 (declare (indent 0))
3156 `(let ((yas--inhibit-overlay-hooks t))
3157 (progn ,@body)))
3158
3159 (defvar yas-snippet-beg nil "Beginning position of the last snippet committed.")
3160 (defvar yas-snippet-end nil "End position of the last snippet committed.")
3161
3162 (defun yas--commit-snippet (snippet)
3163 "Commit SNIPPET, but leave point as it is.
3164
3165 This renders the snippet as ordinary text."
3166
3167 (let ((control-overlay (yas--snippet-control-overlay snippet)))
3168 ;;
3169 ;; Save the end of the moribund snippet in case we need to revive it
3170 ;; its original expansion.
3171 ;;
3172 (when (and control-overlay
3173 (overlay-buffer control-overlay))
3174 (setq yas-snippet-beg (overlay-start control-overlay))
3175 (setq yas-snippet-end (overlay-end control-overlay))
3176 (delete-overlay control-overlay))
3177
3178 (yas--inhibit-overlay-hooks
3179 (when yas--active-field-overlay
3180 (delete-overlay yas--active-field-overlay))
3181 (when yas--field-protection-overlays
3182 (mapc #'delete-overlay yas--field-protection-overlays)))
3183
3184 ;; stacked expansion: if the original expansion took place from a
3185 ;; field, make sure we advance it here at least to
3186 ;; `yas-snippet-end'...
3187 ;;
3188 (let ((previous-field (yas--snippet-previous-active-field snippet)))
3189 (when (and yas-snippet-end previous-field)
3190 (yas--advance-end-maybe previous-field yas-snippet-end)))
3191
3192 ;; Convert all markers to points,
3193 ;;
3194 (yas--markers-to-points snippet)
3195
3196 ;; Take care of snippet revival
3197 ;;
3198 (if yas-snippet-revival
3199 (push `(apply yas--snippet-revive ,yas-snippet-beg ,yas-snippet-end ,snippet)
3200 buffer-undo-list)
3201 ;; Dismember the snippet... this is useful if we get called
3202 ;; again from `yas--take-care-of-redo'....
3203 (setf (yas--snippet-fields snippet) nil)))
3204
3205 (yas--message 3 "Snippet %s exited." (yas--snippet-id snippet)))
3206
3207 (defun yas--safely-run-hooks (hook-var)
3208 (condition-case error
3209 (run-hooks hook-var)
3210 (error
3211 (yas--message 3 "%s error: %s" hook-var (error-message-string error)))))
3212
3213
3214 (defun yas--check-commit-snippet ()
3215 "Checks if point exited the currently active field of the snippet.
3216
3217 If so cleans up the whole snippet up."
3218 (let* ((snippets (yas--snippets-at-point 'all-snippets))
3219 (snippets-left snippets)
3220 (snippet-exit-transform))
3221 (dolist (snippet snippets)
3222 (let ((active-field (yas--snippet-active-field snippet)))
3223 (setq snippet-exit-transform (yas--snippet-force-exit snippet))
3224 (cond ((or snippet-exit-transform
3225 (not (and active-field (yas--field-contains-point-p active-field))))
3226 (setq snippets-left (delete snippet snippets-left))
3227 (setf (yas--snippet-force-exit snippet) nil)
3228 (yas--commit-snippet snippet))
3229 ((and active-field
3230 (or (not yas--active-field-overlay)
3231 (not (overlay-buffer yas--active-field-overlay))))
3232 ;;
3233 ;; stacked expansion: this case is mainly for recent
3234 ;; snippet exits that place us back int the field of
3235 ;; another snippet
3236 ;;
3237 (save-excursion
3238 (yas--move-to-field snippet active-field)
3239 (yas--update-mirrors snippet)))
3240 (t
3241 nil))))
3242 (unless (or (null snippets) snippets-left)
3243 (if snippet-exit-transform
3244 (yas--eval-lisp-no-saves snippet-exit-transform))
3245 (yas--safely-run-hooks 'yas-after-exit-snippet-hook))))
3246
3247 ;; Apropos markers-to-points:
3248 ;;
3249 ;; This was found useful for performance reasons, so that an
3250 ;; excessive number of live markers aren't kept around in the
3251 ;; `buffer-undo-list'. However, in `markers-to-points', the
3252 ;; set-to-nil markers can't simply be discarded and replaced with
3253 ;; fresh ones in `points-to-markers'. The original marker that was
3254 ;; just set to nil has to be reused.
3255 ;;
3256 ;; This shouldn't bring horrible problems with undo/redo, but it
3257 ;; you never know
3258 ;;
3259 (defun yas--markers-to-points (snippet)
3260 "Convert all markers in SNIPPET to a cons (POINT . MARKER)
3261 where POINT is the original position of the marker and MARKER is
3262 the original marker object with the position set to nil."
3263 (dolist (field (yas--snippet-fields snippet))
3264 (let ((start (marker-position (yas--field-start field)))
3265 (end (marker-position (yas--field-end field))))
3266 (set-marker (yas--field-start field) nil)
3267 (set-marker (yas--field-end field) nil)
3268 (setf (yas--field-start field) (cons start (yas--field-start field)))
3269 (setf (yas--field-end field) (cons end (yas--field-end field))))
3270 (dolist (mirror (yas--field-mirrors field))
3271 (let ((start (marker-position (yas--mirror-start mirror)))
3272 (end (marker-position (yas--mirror-end mirror))))
3273 (set-marker (yas--mirror-start mirror) nil)
3274 (set-marker (yas--mirror-end mirror) nil)
3275 (setf (yas--mirror-start mirror) (cons start (yas--mirror-start mirror)))
3276 (setf (yas--mirror-end mirror) (cons end (yas--mirror-end mirror))))))
3277 (let ((snippet-exit (yas--snippet-exit snippet)))
3278 (when snippet-exit
3279 (let ((exit (marker-position (yas--exit-marker snippet-exit))))
3280 (set-marker (yas--exit-marker snippet-exit) nil)
3281 (setf (yas--exit-marker snippet-exit) (cons exit (yas--exit-marker snippet-exit)))))))
3282
3283 (defun yas--points-to-markers (snippet)
3284 "Convert all cons (POINT . MARKER) in SNIPPET to markers.
3285
3286 This is done by setting MARKER to POINT with `set-marker'."
3287 (dolist (field (yas--snippet-fields snippet))
3288 (setf (yas--field-start field) (set-marker (cdr (yas--field-start field))
3289 (car (yas--field-start field))))
3290 (setf (yas--field-end field) (set-marker (cdr (yas--field-end field))
3291 (car (yas--field-end field))))
3292 (dolist (mirror (yas--field-mirrors field))
3293 (setf (yas--mirror-start mirror) (set-marker (cdr (yas--mirror-start mirror))
3294 (car (yas--mirror-start mirror))))
3295 (setf (yas--mirror-end mirror) (set-marker (cdr (yas--mirror-end mirror))
3296 (car (yas--mirror-end mirror))))))
3297 (let ((snippet-exit (yas--snippet-exit snippet)))
3298 (when snippet-exit
3299 (setf (yas--exit-marker snippet-exit) (set-marker (cdr (yas--exit-marker snippet-exit))
3300 (car (yas--exit-marker snippet-exit)))))))
3301
3302 (defun yas--field-contains-point-p (field &optional point)
3303 (let ((point (or point
3304 (point))))
3305 (and (>= point (yas--field-start field))
3306 (<= point (yas--field-end field)))))
3307
3308 (defun yas--field-text-for-display (field)
3309 "Return the propertized display text for field FIELD."
3310 (buffer-substring (yas--field-start field) (yas--field-end field)))
3311
3312 (defun yas--undo-in-progress ()
3313 "True if some kind of undo is in progress."
3314 (or undo-in-progress
3315 (eq this-command 'undo)
3316 (eq this-command 'redo)))
3317
3318 (defun yas--make-control-overlay (snippet start end)
3319 "Creates the control overlay that surrounds the snippet and
3320 holds the keymap."
3321 (let ((overlay (make-overlay start
3322 end
3323 nil
3324 nil
3325 t)))
3326 (overlay-put overlay 'keymap yas-keymap)
3327 (overlay-put overlay 'priority 100)
3328 (overlay-put overlay 'yas--snippet snippet)
3329 overlay))
3330
3331 (defun yas-skip-and-clear-or-delete-char (&optional field)
3332 "Clears unmodified field if at field start, skips to next tab.
3333
3334 Otherwise deletes a character normally by calling `delete-char'."
3335 (interactive)
3336 (let ((field (or field
3337 (and yas--active-field-overlay
3338 (overlay-buffer yas--active-field-overlay)
3339 (overlay-get yas--active-field-overlay 'yas--field)))))
3340 (cond ((and field
3341 (not (yas--field-modified-p field))
3342 (eq (point) (marker-position (yas--field-start field))))
3343 (yas--skip-and-clear field)
3344 (yas-next-field 1))
3345 (t
3346 (call-interactively 'delete-char)))))
3347
3348 (defun yas--skip-and-clear (field)
3349 "Deletes the region of FIELD and sets it's modified state to t."
3350 ;; Just before skipping-and-clearing the field, mark its children
3351 ;; fields as modified, too. If the children have mirrors-in-fields
3352 ;; this prevents them from updating erroneously (we're skipping and
3353 ;; deleting!).
3354 ;;
3355 (yas--mark-this-and-children-modified field)
3356 (delete-region (yas--field-start field) (yas--field-end field)))
3357
3358 (defun yas--mark-this-and-children-modified (field)
3359 (setf (yas--field-modified-p field) t)
3360 (let ((fom (yas--field-next field)))
3361 (while (and fom
3362 (yas--fom-parent-field fom))
3363 (when (and (eq (yas--fom-parent-field fom) field)
3364 (yas--field-p fom))
3365 (yas--mark-this-and-children-modified fom))
3366 (setq fom (yas--fom-next fom)))))
3367
3368 (defun yas--make-move-active-field-overlay (snippet field)
3369 "Place the active field overlay in SNIPPET's FIELD.
3370
3371 Move the overlay, or create it if it does not exit."
3372 (if (and yas--active-field-overlay
3373 (overlay-buffer yas--active-field-overlay))
3374 (move-overlay yas--active-field-overlay
3375 (yas--field-start field)
3376 (yas--field-end field))
3377 (setq yas--active-field-overlay
3378 (make-overlay (yas--field-start field)
3379 (yas--field-end field)
3380 nil nil t))
3381 (overlay-put yas--active-field-overlay 'priority 100)
3382 (overlay-put yas--active-field-overlay 'face 'yas-field-highlight-face)
3383 (overlay-put yas--active-field-overlay 'yas--snippet snippet)
3384 (overlay-put yas--active-field-overlay 'modification-hooks '(yas--on-field-overlay-modification))
3385 (overlay-put yas--active-field-overlay 'insert-in-front-hooks
3386 '(yas--on-field-overlay-modification))
3387 (overlay-put yas--active-field-overlay 'insert-behind-hooks
3388 '(yas--on-field-overlay-modification))))
3389
3390 (defvar yas--inhibit-overlay-hooks nil
3391 "Bind this temporarily to non-nil to prevent running `yas--on-*-modification'.")
3392
3393 (defun yas--on-field-overlay-modification (overlay after? beg end &optional length)
3394 "Clears the field and updates mirrors, conditionally.
3395
3396 Only clears the field if it hasn't been modified and it point it
3397 at field start. This hook doesn't do anything if an undo is in
3398 progress."
3399 (unless (or yas--inhibit-overlay-hooks
3400 (yas--undo-in-progress))
3401 (let* ((field (overlay-get overlay 'yas--field))
3402 (number (and field (yas--field-number field)))
3403 (snippet (overlay-get yas--active-field-overlay 'yas--snippet)))
3404 (cond (after?
3405 (yas--advance-end-maybe field (overlay-end overlay))
3406 (save-excursion
3407 (yas--field-update-display field snippet))
3408 (yas--update-mirrors snippet))
3409 (field
3410 (when (and (not after?)
3411 (not (yas--field-modified-p field))
3412 (eq (point) (if (markerp (yas--field-start field))
3413 (marker-position (yas--field-start field))
3414 (yas--field-start field))))
3415 (yas--skip-and-clear field))
3416 (setf (yas--field-modified-p field) t))))))
3417 \f
3418 ;;; Apropos protection overlays:
3419 ;;
3420 ;; These exist for nasty users who will try to delete parts of the
3421 ;; snippet outside the active field. Actual protection happens in
3422 ;; `yas--on-protection-overlay-modification'.
3423 ;;
3424 ;; Currently this signals an error which inhibits the command. For
3425 ;; commands that move point (like `kill-line'), point is restored in
3426 ;; the `yas--post-command-handler' using a global
3427 ;; `yas--protection-violation' variable.
3428 ;;
3429 ;; Alternatively, I've experimented with an implementation that
3430 ;; commits the snippet before actually calling `this-command'
3431 ;; interactively, and then signals an error, which is ignored. but
3432 ;; blocks all other million modification hooks. This presented some
3433 ;; problems with stacked expansion.
3434 ;;
3435 (defun yas--make-move-field-protection-overlays (snippet field)
3436 "Place protection overlays surrounding SNIPPET's FIELD.
3437
3438 Move the overlays, or create them if they do not exit."
3439 (let ((start (yas--field-start field))
3440 (end (yas--field-end field)))
3441 ;; First check if the (1+ end) is contained in the buffer,
3442 ;; otherwise we'll have to do a bit of cheating and silently
3443 ;; insert a newline. the `(1+ (buffer-size))' should prevent this
3444 ;; when using stacked expansion
3445 ;;
3446 (when (< (buffer-size) end)
3447 (save-excursion
3448 (yas--inhibit-overlay-hooks
3449 (goto-char (point-max))
3450 (newline))))
3451 ;; go on to normal overlay creation/moving
3452 ;;
3453 (cond ((and yas--field-protection-overlays
3454 (every #'overlay-buffer yas--field-protection-overlays))
3455 (move-overlay (first yas--field-protection-overlays) (1- start) start)
3456 (move-overlay (second yas--field-protection-overlays) end (1+ end)))
3457 (t
3458 (setq yas--field-protection-overlays
3459 (list (make-overlay (1- start) start nil t nil)
3460 (make-overlay end (1+ end) nil t nil)))
3461 (dolist (ov yas--field-protection-overlays)
3462 (overlay-put ov 'face 'yas--field-debug-face)
3463 (overlay-put ov 'yas--snippet snippet)
3464 ;; (overlay-put ov 'evaporate t)
3465 (overlay-put ov 'modification-hooks '(yas--on-protection-overlay-modification)))))))
3466
3467 (defvar yas--protection-violation nil
3468 "When non-nil, signals attempts to erroneously exit or modify the snippet.
3469
3470 Functions in the `post-command-hook', for example
3471 `yas--post-command-handler' can check it and reset its value to
3472 nil. The variables value is the point where the violation
3473 originated")
3474
3475 (defun yas--on-protection-overlay-modification (overlay after? beg end &optional length)
3476 "Signals a snippet violation, then issues error.
3477
3478 The error should be ignored in `debug-ignored-errors'"
3479 (unless yas--inhibit-overlay-hooks
3480 (cond ((not (or after?
3481 (yas--undo-in-progress)))
3482 (setq yas--protection-violation (point))
3483 (error "Exit the snippet first!")))))
3484
3485 (add-to-list 'debug-ignored-errors "^Exit the snippet first!$")
3486
3487 \f
3488 ;;; Snippet expansion and "stacked" expansion:
3489 ;;
3490 ;; Stacked expansion is when you try to expand a snippet when already
3491 ;; inside a snippet expansion.
3492 ;;
3493 ;; The parent snippet does not run its fields modification hooks
3494 ;; (`yas--on-field-overlay-modification' and
3495 ;; `yas--on-protection-overlay-modification') while the child snippet
3496 ;; is active. This means, among other things, that the mirrors of the
3497 ;; parent snippet are not updated, this only happening when one exits
3498 ;; the child snippet.
3499 ;;
3500 ;; Unfortunately, this also puts some ugly (and not fully-tested)
3501 ;; bits of code in `yas-expand-snippet' and
3502 ;; `yas--commit-snippet'. I've tried to mark them with "stacked
3503 ;; expansion:".
3504 ;;
3505 ;; This was thought to be safer in an undo/redo perspective, but
3506 ;; maybe the correct implementation is to make the globals
3507 ;; `yas--active-field-overlay' and `yas--field-protection-overlays' be
3508 ;; snippet-local and be active even while the child snippet is
3509 ;; running. This would mean a lot of overlay modification hooks
3510 ;; running, but if managed correctly (including overlay priorities)
3511 ;; they should account for all situations...
3512 ;;
3513 (defun yas-expand-snippet (content &optional start end expand-env)
3514 "Expand snippet CONTENT at current point.
3515
3516 Text between START and END will be deleted before inserting
3517 template. EXPAND-ENV is are let-style variable to value bindings
3518 considered when expanding the snippet."
3519 (run-hooks 'yas-before-expand-snippet-hook)
3520
3521 ;;
3522 (let* ((yas-selected-text (or yas-selected-text
3523 (and (region-active-p)
3524 (buffer-substring-no-properties (region-beginning)
3525 (region-end)))))
3526 (start (or start
3527 (and (region-active-p)
3528 (region-beginning))
3529 (point)))
3530 (end (or end
3531 (and (region-active-p)
3532 (region-end))
3533 (point)))
3534 (to-delete (and start
3535 end
3536 (buffer-substring-no-properties start end)))
3537 snippet)
3538 (goto-char start)
3539 (setq yas--indent-original-column (current-column))
3540 ;; Delete the region to delete, this *does* get undo-recorded.
3541 ;;
3542 (when (and to-delete
3543 (> end start))
3544 (delete-region start end))
3545
3546 (cond ((listp content)
3547 ;; x) This is a snippet-command
3548 ;;
3549 (yas--eval-lisp-no-saves content))
3550 (t
3551 ;; x) This is a snippet-snippet :-)
3552 ;;
3553 ;; Narrow the region down to the content, shoosh the
3554 ;; `buffer-undo-list', and create the snippet, the new
3555 ;; snippet updates its mirrors once, so we are left with
3556 ;; some plain text. The undo action for deleting this
3557 ;; plain text will get recorded at the end.
3558 ;;
3559 ;; stacked expansion: also shoosh the overlay modification hooks
3560 (save-restriction
3561 (narrow-to-region start start)
3562 (let ((buffer-undo-list t))
3563 ;; snippet creation might evaluate users elisp, which
3564 ;; might generate errors, so we have to be ready to catch
3565 ;; them mostly to make the undo information
3566 ;;
3567 (setq yas--start-column (save-restriction (widen) (current-column)))
3568 (yas--inhibit-overlay-hooks
3569 (setq snippet
3570 (if expand-env
3571 (eval `(let* ,expand-env
3572 (insert content)
3573 (yas--snippet-create (point-min) (point-max))))
3574 (insert content)
3575 (yas--snippet-create (point-min) (point-max)))))))
3576
3577 ;; stacked-expansion: This checks for stacked expansion, save the
3578 ;; `yas--previous-active-field' and advance its boundary.
3579 ;;
3580 (let ((existing-field (and yas--active-field-overlay
3581 (overlay-buffer yas--active-field-overlay)
3582 (overlay-get yas--active-field-overlay 'yas--field))))
3583 (when existing-field
3584 (setf (yas--snippet-previous-active-field snippet) existing-field)
3585 (yas--advance-end-maybe existing-field (overlay-end yas--active-field-overlay))))
3586
3587 ;; Exit the snippet immediately if no fields
3588 ;;
3589 (unless (yas--snippet-fields snippet)
3590 (yas-exit-snippet snippet))
3591
3592 ;; Push two undo actions: the deletion of the inserted contents of
3593 ;; the new snippet (without the "key") followed by an apply of
3594 ;; `yas--take-care-of-redo' on the newly inserted snippet boundaries
3595 ;;
3596 ;; A small exception, if `yas-also-auto-indent-first-line'
3597 ;; is t and `yas--indent' decides to indent the line to a
3598 ;; point before the actual expansion point, undo would be
3599 ;; messed up. We call the early point "newstart"". case,
3600 ;; and attempt to fix undo.
3601 ;;
3602 (let ((newstart (overlay-start (yas--snippet-control-overlay snippet)))
3603 (end (overlay-end (yas--snippet-control-overlay snippet))))
3604 (when (< newstart start)
3605 (push (cons (make-string (- start newstart) ? ) newstart) buffer-undo-list))
3606 (push (cons newstart end) buffer-undo-list)
3607 (push `(apply yas--take-care-of-redo ,start ,end ,snippet)
3608 buffer-undo-list))
3609 ;; Now, schedule a move to the first field
3610 ;;
3611 (let ((first-field (car (yas--snippet-fields snippet))))
3612 (when first-field
3613 (sit-for 0) ;; fix issue 125
3614 (yas--move-to-field snippet first-field)))
3615 (yas--message 3 "snippet expanded.")
3616 t))))
3617
3618 (defun yas--take-care-of-redo (beg end snippet)
3619 "Commits SNIPPET, which in turn pushes an undo action for reviving it.
3620
3621 Meant to exit in the `buffer-undo-list'."
3622 ;; slightly optimize: this action is only needed for snippets with
3623 ;; at least one field
3624 (when (yas--snippet-fields snippet)
3625 (yas--commit-snippet snippet)))
3626
3627 (defun yas--snippet-revive (beg end snippet)
3628 "Revives SNIPPET and creates a control overlay from BEG to END.
3629
3630 BEG and END are, we hope, the original snippets boundaries. All
3631 the markers/points exiting existing inside SNIPPET should point
3632 to their correct locations *at the time the snippet is revived*.
3633
3634 After revival, push the `yas--take-care-of-redo' in the
3635 `buffer-undo-list'"
3636 ;; Reconvert all the points to markers
3637 ;;
3638 (yas--points-to-markers snippet)
3639 ;; When at least one editable field existed in the zombie snippet,
3640 ;; try to revive the whole thing...
3641 ;;
3642 (let ((target-field (or (yas--snippet-active-field snippet)
3643 (car (yas--snippet-fields snippet)))))
3644 (when target-field
3645 (setf (yas--snippet-control-overlay snippet) (yas--make-control-overlay snippet beg end))
3646 (overlay-put (yas--snippet-control-overlay snippet) 'yas--snippet snippet)
3647
3648 (yas--move-to-field snippet target-field)
3649
3650 (push `(apply yas--take-care-of-redo ,beg ,end ,snippet)
3651 buffer-undo-list))))
3652
3653 (defun yas--snippet-create (begin end)
3654 "Creates a snippet from an template inserted between BEGIN and END.
3655
3656 Returns the newly created snippet."
3657 (let ((snippet (yas--make-snippet)))
3658 (goto-char begin)
3659 (yas--snippet-parse-create snippet)
3660
3661 ;; Sort and link each field
3662 (yas--snippet-sort-fields snippet)
3663
3664 ;; Create keymap overlay for snippet
3665 (setf (yas--snippet-control-overlay snippet)
3666 (yas--make-control-overlay snippet (point-min) (point-max)))
3667
3668 ;; Move to end
3669 (goto-char (point-max))
3670
3671 snippet))
3672
3673 \f
3674 ;;; Apropos adjacencies and "fom's":
3675 ;;
3676 ;; Once the $-constructs bits like "$n" and "${:n" are deleted in the
3677 ;; recently expanded snippet, we might actually have many fields,
3678 ;; mirrors (and the snippet exit) in the very same position in the
3679 ;; buffer. Therefore we need to single-link the
3680 ;; fields-or-mirrors-or-exit (which I have abbreviated to "fom")
3681 ;; according to their original positions in the buffer.
3682 ;;
3683 ;; Then we have operation `yas--advance-end-maybe' and
3684 ;; `yas--advance-start-maybe', which conditionally push the starts and
3685 ;; ends of these foms down the chain.
3686 ;;
3687 ;; This allows for like the printf with the magic ",":
3688 ;;
3689 ;; printf ("${1:%s}\\n"${1:$(if (string-match "%" text) "," "\);")} \
3690 ;; $2${1:$(if (string-match "%" text) "\);" "")}$0
3691 ;;
3692 (defun yas--fom-start (fom)
3693 (cond ((yas--field-p fom)
3694 (yas--field-start fom))
3695 ((yas--mirror-p fom)
3696 (yas--mirror-start fom))
3697 (t
3698 (yas--exit-marker fom))))
3699
3700 (defun yas--fom-end (fom)
3701 (cond ((yas--field-p fom)
3702 (yas--field-end fom))
3703 ((yas--mirror-p fom)
3704 (yas--mirror-end fom))
3705 (t
3706 (yas--exit-marker fom))))
3707
3708 (defun yas--fom-next (fom)
3709 (cond ((yas--field-p fom)
3710 (yas--field-next fom))
3711 ((yas--mirror-p fom)
3712 (yas--mirror-next fom))
3713 (t
3714 (yas--exit-next fom))))
3715
3716 (defun yas--fom-parent-field (fom)
3717 (cond ((yas--field-p fom)
3718 (yas--field-parent-field fom))
3719 ((yas--mirror-p fom)
3720 (yas--mirror-parent-field fom))
3721 (t
3722 nil)))
3723
3724 (defun yas--calculate-adjacencies (snippet)
3725 "Calculate adjacencies for fields or mirrors of SNIPPET.
3726
3727 This is according to their relative positions in the buffer, and
3728 has to be called before the $-constructs are deleted."
3729 (labels ((yas--fom-set-next-fom (fom nextfom)
3730 (cond ((yas--field-p fom)
3731 (setf (yas--field-next fom) nextfom))
3732 ((yas--mirror-p fom)
3733 (setf (yas--mirror-next fom) nextfom))
3734 (t
3735 (setf (yas--exit-next fom) nextfom))))
3736 (yas--compare-fom-begs (fom1 fom2)
3737 (if (= (yas--fom-start fom2) (yas--fom-start fom1))
3738 (yas--mirror-p fom2)
3739 (>= (yas--fom-start fom2) (yas--fom-start fom1))))
3740 (yas--link-foms (fom1 fom2)
3741 (yas--fom-set-next-fom fom1 fom2)))
3742 ;; make some yas--field, yas--mirror and yas--exit soup
3743 (let ((soup))
3744 (when (yas--snippet-exit snippet)
3745 (push (yas--snippet-exit snippet) soup))
3746 (dolist (field (yas--snippet-fields snippet))
3747 (push field soup)
3748 (dolist (mirror (yas--field-mirrors field))
3749 (push mirror soup)))
3750 (setq soup
3751 (sort soup
3752 #'yas--compare-fom-begs))
3753 (when soup
3754 (reduce #'yas--link-foms soup)))))
3755
3756 (defun yas--calculate-mirrors-in-fields (snippet mirror)
3757 "Attempt to assign a parent field of SNIPPET to the mirror MIRROR.
3758
3759 Use the tightest containing field if more than one field contains
3760 the mirror. Intended to be called *before* the dollar-regions are
3761 deleted."
3762 (let ((min (point-min))
3763 (max (point-max)))
3764 (dolist (field (yas--snippet-fields snippet))
3765 (when (and (<= (yas--field-start field) (yas--mirror-start mirror))
3766 (<= (yas--mirror-end mirror) (yas--field-end field))
3767 (< min (yas--field-start field))
3768 (< (yas--field-end field) max))
3769 (setq min (yas--field-start field)
3770 max (yas--field-end field))
3771 (setf (yas--mirror-parent-field mirror) field)))))
3772
3773 (defun yas--advance-end-maybe (fom newend)
3774 "Maybe advance FOM's end to NEWEND if it needs it.
3775
3776 If it does, also:
3777
3778 * call `yas--advance-start-maybe' on FOM's next fom.
3779
3780 * in case FOM is field call `yas--advance-end-maybe' on its parent
3781 field
3782
3783 Also, if FOM is an exit-marker, always call
3784 `yas--advance-start-maybe' on its next fom. This is because
3785 exit-marker have identical start and end markers."
3786 (cond ((and fom (< (yas--fom-end fom) newend))
3787 (set-marker (yas--fom-end fom) newend)
3788 (yas--advance-start-maybe (yas--fom-next fom) newend)
3789 (yas--advance-end-of-parents-maybe (yas--fom-parent-field fom) newend))
3790 ((yas--exit-p fom)
3791 (yas--advance-start-maybe (yas--fom-next fom) newend))))
3792
3793 (defun yas--advance-start-maybe (fom newstart)
3794 "Maybe advance FOM's start to NEWSTART if it needs it.
3795
3796 If it does, also call `yas--advance-end-maybe' on FOM."
3797 (when (and fom (< (yas--fom-start fom) newstart))
3798 (set-marker (yas--fom-start fom) newstart)
3799 (yas--advance-end-maybe fom newstart)))
3800
3801 (defun yas--advance-end-of-parents-maybe (field newend)
3802 "Like `yas--advance-end-maybe' but for parent fields.
3803
3804 Only works for fields and doesn't care about the start of the
3805 next FOM. Works its way up recursively for parents of parents."
3806 (when (and field
3807 (< (yas--field-end field) newend))
3808 (set-marker (yas--field-end field) newend)
3809 (yas--advance-end-of-parents-maybe (yas--field-parent-field field) newend)))
3810
3811 (defvar yas--dollar-regions nil
3812 "When expanding the snippet the \"parse-create\" functions add
3813 cons cells to this var.")
3814
3815 (defvar yas--backquote-markers-and-strings nil
3816 "List of (MARKER . STRING) marking where the values from
3817 backquoted lisp expressions should be inserted at the end of
3818 expansion.")
3819
3820 (defun yas--snippet-parse-create (snippet)
3821 "Parse a recently inserted snippet template, creating all
3822 necessary fields, mirrors and exit points.
3823
3824 Meant to be called in a narrowed buffer, does various passes"
3825 (let ((parse-start (point)))
3826 ;; Reset the yas--dollar-regions
3827 ;;
3828 (setq yas--dollar-regions nil)
3829 ;; protect just the backquotes
3830 ;;
3831 (yas--protect-escapes nil '(?`))
3832 ;; replace all backquoted expressions
3833 ;;
3834 (goto-char parse-start)
3835 (yas--save-backquotes)
3836 ;; protect escaped characters
3837 ;;
3838 (yas--protect-escapes)
3839 ;; parse fields with {}
3840 ;;
3841 (goto-char parse-start)
3842 (yas--field-parse-create snippet)
3843 ;; parse simple mirrors and fields
3844 ;;
3845 (goto-char parse-start)
3846 (yas--simple-mirror-parse-create snippet)
3847 ;; parse mirror transforms
3848 ;;
3849 (goto-char parse-start)
3850 (yas--transform-mirror-parse-create snippet)
3851 ;; calculate adjacencies of fields and mirrors
3852 ;;
3853 (yas--calculate-adjacencies snippet)
3854 ;; Delete $-constructs
3855 ;;
3856 (yas--delete-regions yas--dollar-regions)
3857 ;; restore backquoted expression values
3858 ;;
3859 (yas--restore-backquotes)
3860 ;; restore escapes
3861 ;;
3862 (goto-char parse-start)
3863 (yas--restore-escapes)
3864 ;; update mirrors for the first time
3865 ;;
3866 (yas--update-mirrors snippet)
3867 ;; indent the best we can
3868 ;;
3869 (goto-char parse-start)
3870 (yas--indent snippet)))
3871
3872 (defun yas--indent-according-to-mode (snippet-markers)
3873 "Indent current line according to mode, preserving SNIPPET-MARKERS."
3874 ;;; Apropos indenting problems....
3875 ;;
3876 ;; `indent-according-to-mode' uses whatever `indent-line-function'
3877 ;; is available. Some implementations of these functions delete text
3878 ;; before they insert. If there happens to be a marker just after
3879 ;; the text being deleted, the insertion actually happens after the
3880 ;; marker, which misplaces it.
3881 ;;
3882 ;; This would also happen if we had used overlays with the
3883 ;; `front-advance' property set to nil.
3884 ;;
3885 ;; This is why I have these `trouble-markers', they are the ones at
3886 ;; they are the ones at the first non-whitespace char at the line
3887 ;; (i.e. at `yas--real-line-beginning'. After indentation takes place
3888 ;; we should be at the correct to restore them to. All other
3889 ;; non-trouble-markers have been *pushed* and don't need special
3890 ;; attention.
3891 ;;
3892 (goto-char (yas--real-line-beginning))
3893 (let ((trouble-markers (remove-if-not #'(lambda (marker)
3894 (= marker (point)))
3895 snippet-markers)))
3896 (save-restriction
3897 (widen)
3898 (condition-case err
3899 (indent-according-to-mode)
3900 (error (yas--message 3 "Warning: `yas--indent-according-to-mode' having problems running %s" indent-line-function)
3901 nil)))
3902 (mapc #'(lambda (marker)
3903 (set-marker marker (point)))
3904 trouble-markers)))
3905
3906 (defvar yas--indent-original-column nil)
3907 (defun yas--indent (snippet)
3908 (let ((snippet-markers (yas--collect-snippet-markers snippet)))
3909 ;; Look for those $>
3910 (save-excursion
3911 (while (re-search-forward "$>" nil t)
3912 (delete-region (match-beginning 0) (match-end 0))
3913 (when (not (eq yas-indent-line 'auto))
3914 (yas--indent-according-to-mode snippet-markers))))
3915 ;; Now do stuff for 'fixed and 'auto
3916 (save-excursion
3917 (cond ((eq yas-indent-line 'fixed)
3918 (while (and (zerop (forward-line))
3919 (zerop (current-column)))
3920 (indent-to-column yas--indent-original-column)))
3921 ((eq yas-indent-line 'auto)
3922 (let ((end (set-marker (make-marker) (point-max)))
3923 (indent-first-line-p yas-also-auto-indent-first-line))
3924 (while (and (zerop (if indent-first-line-p
3925 (prog1
3926 (forward-line 0)
3927 (setq indent-first-line-p nil))
3928 (forward-line 1)))
3929 (not (eobp))
3930 (<= (point) end))
3931 (yas--indent-according-to-mode snippet-markers))))
3932 (t
3933 nil)))))
3934
3935 (defun yas--collect-snippet-markers (snippet)
3936 "Make a list of all the markers used by SNIPPET."
3937 (let (markers)
3938 (dolist (field (yas--snippet-fields snippet))
3939 (push (yas--field-start field) markers)
3940 (push (yas--field-end field) markers)
3941 (dolist (mirror (yas--field-mirrors field))
3942 (push (yas--mirror-start mirror) markers)
3943 (push (yas--mirror-end mirror) markers)))
3944 (let ((snippet-exit (yas--snippet-exit snippet)))
3945 (when (and snippet-exit
3946 (marker-buffer (yas--exit-marker snippet-exit)))
3947 (push (yas--exit-marker snippet-exit) markers)))
3948 markers))
3949
3950 (defun yas--real-line-beginning ()
3951 (let ((c (char-after (line-beginning-position)))
3952 (n (line-beginning-position)))
3953 (while (or (eql c ?\ )
3954 (eql c ?\t))
3955 (incf n)
3956 (setq c (char-after n)))
3957 n))
3958
3959 (defun yas--escape-string (escaped)
3960 (concat "YASESCAPE" (format "%d" escaped) "PROTECTGUARD"))
3961
3962 (defun yas--protect-escapes (&optional text escaped)
3963 "Protect all escaped characters with their numeric ASCII value.
3964
3965 With optional string TEXT do it in string instead of buffer."
3966 (let ((changed-text text)
3967 (text-provided-p text))
3968 (mapc #'(lambda (escaped)
3969 (setq changed-text
3970 (yas--replace-all (concat "\\" (char-to-string escaped))
3971 (yas--escape-string escaped)
3972 (when text-provided-p changed-text))))
3973 (or escaped yas--escaped-characters))
3974 changed-text))
3975
3976 (defun yas--restore-escapes (&optional text escaped)
3977 "Restore all escaped characters from their numeric ASCII value.
3978
3979 With optional string TEXT do it in string instead of the buffer."
3980 (let ((changed-text text)
3981 (text-provided-p text))
3982 (mapc #'(lambda (escaped)
3983 (setq changed-text
3984 (yas--replace-all (yas--escape-string escaped)
3985 (char-to-string escaped)
3986 (when text-provided-p changed-text))))
3987 (or escaped yas--escaped-characters))
3988 changed-text))
3989
3990 (defun yas--save-backquotes ()
3991 "Save all the \"`(lisp-expression)`\"-style expressions
3992 with their evaluated value into `yas--backquote-markers-and-strings'."
3993 (while (re-search-forward yas--backquote-lisp-expression-regexp nil t)
3994 (let ((current-string (match-string-no-properties 1)) transformed)
3995 (delete-region (match-beginning 0) (match-end 0))
3996 (setq transformed (yas--eval-lisp (yas--read-lisp (yas--restore-escapes current-string '(?`)))))
3997 (goto-char (match-beginning 0))
3998 (when transformed
3999 (let ((marker (make-marker)))
4000 (insert "Y") ;; quite horrendous, I love it :)
4001 (set-marker marker (point))
4002 (insert "Y")
4003 (push (cons marker transformed) yas--backquote-markers-and-strings))))))
4004
4005 (defun yas--restore-backquotes ()
4006 "Replace markers in `yas--backquote-markers-and-strings' with their values."
4007 (while yas--backquote-markers-and-strings
4008 (let* ((marker-and-string (pop yas--backquote-markers-and-strings))
4009 (marker (car marker-and-string))
4010 (string (cdr marker-and-string)))
4011 (save-excursion
4012 (goto-char marker)
4013 (delete-char -1)
4014 (insert string)
4015 (delete-char 1)
4016 (set-marker marker nil)))))
4017
4018 (defun yas--scan-sexps (from count)
4019 (condition-case err
4020 (with-syntax-table (standard-syntax-table)
4021 (scan-sexps from count))
4022 (error
4023 nil)))
4024
4025 (defun yas--make-marker (pos)
4026 "Create a marker at POS with nil `marker-insertion-type'."
4027 (let ((marker (set-marker (make-marker) pos)))
4028 (set-marker-insertion-type marker nil)
4029 marker))
4030
4031 (defun yas--field-parse-create (snippet &optional parent-field)
4032 "Parse most field expressions in SNIPPET, except for the simple one \"$n\".
4033
4034 The following count as a field:
4035
4036 * \"${n: text}\", for a numbered field with default text, as long as N is not 0;
4037
4038 * \"${n: text$(expression)}, the same with a lisp expression;
4039 this is caught with the curiously named `yas--multi-dollar-lisp-expression-regexp'
4040
4041 * the same as above but unnumbered, (no N:) and number is calculated automatically.
4042
4043 When multiple expressions are found, only the last one counts."
4044 ;;
4045 (save-excursion
4046 (while (re-search-forward yas--field-regexp nil t)
4047 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4048 (number (and (match-string-no-properties 1)
4049 (string-to-number (match-string-no-properties 1))))
4050 (brand-new-field (and real-match-end-0
4051 ;; break if on "$(" immediately
4052 ;; after the ":", this will be
4053 ;; caught as a mirror with
4054 ;; transform later.
4055 (not (save-match-data
4056 (eq (string-match "$[ \t\n]*("
4057 (match-string-no-properties 2)) 0)))
4058 ;; allow ${0: some exit text}
4059 ;; (not (and number (zerop number)))
4060 (yas--make-field number
4061 (yas--make-marker (match-beginning 2))
4062 (yas--make-marker (1- real-match-end-0))
4063 parent-field))))
4064 (when brand-new-field
4065 (goto-char real-match-end-0)
4066 (push (cons (1- real-match-end-0) real-match-end-0)
4067 yas--dollar-regions)
4068 (push (cons (match-beginning 0) (match-beginning 2))
4069 yas--dollar-regions)
4070 (push brand-new-field (yas--snippet-fields snippet))
4071 (save-excursion
4072 (save-restriction
4073 (narrow-to-region (yas--field-start brand-new-field) (yas--field-end brand-new-field))
4074 (goto-char (point-min))
4075 (yas--field-parse-create snippet brand-new-field)))))))
4076 ;; if we entered from a parent field, now search for the
4077 ;; `yas--multi-dollar-lisp-expression-regexp'. This is used for
4078 ;; primary field transformations
4079 ;;
4080 (when parent-field
4081 (save-excursion
4082 (while (re-search-forward yas--multi-dollar-lisp-expression-regexp nil t)
4083 (let* ((real-match-end-1 (yas--scan-sexps (match-beginning 1) 1)))
4084 ;; commit the primary field transformation if:
4085 ;;
4086 ;; 1. we don't find it in yas--dollar-regions (a subnested
4087 ;; field) might have already caught it.
4088 ;;
4089 ;; 2. we really make sure we have either two '$' or some
4090 ;; text and a '$' after the colon ':'. This is a FIXME: work
4091 ;; my regular expressions and end these ugly hacks.
4092 ;;
4093 (when (and real-match-end-1
4094 (not (member (cons (match-beginning 0)
4095 real-match-end-1)
4096 yas--dollar-regions))
4097 (not (eq ?:
4098 (char-before (1- (match-beginning 1))))))
4099 (let ((lisp-expression-string (buffer-substring-no-properties (match-beginning 1)
4100 real-match-end-1)))
4101 (setf (yas--field-transform parent-field)
4102 (yas--read-lisp (yas--restore-escapes lisp-expression-string))))
4103 (push (cons (match-beginning 0) real-match-end-1)
4104 yas--dollar-regions)))))))
4105
4106 (defun yas--transform-mirror-parse-create (snippet)
4107 "Parse the \"${n:$(lisp-expression)}\" mirror transformations in SNIPPET."
4108 (while (re-search-forward yas--transform-mirror-regexp nil t)
4109 (let* ((real-match-end-0 (yas--scan-sexps (1+ (match-beginning 0)) 1))
4110 (number (string-to-number (match-string-no-properties 1)))
4111 (field (and number
4112 (not (zerop number))
4113 (yas--snippet-find-field snippet number)))
4114 (brand-new-mirror
4115 (and real-match-end-0
4116 field
4117 (yas--make-mirror (yas--make-marker (match-beginning 0))
4118 (yas--make-marker (match-beginning 0))
4119 (yas--read-lisp
4120 (yas--restore-escapes
4121 (buffer-substring-no-properties (match-beginning 2)
4122 (1- real-match-end-0))))))))
4123 (when brand-new-mirror
4124 (push brand-new-mirror
4125 (yas--field-mirrors field))
4126 (yas--calculate-mirrors-in-fields snippet brand-new-mirror)
4127 (push (cons (match-beginning 0) real-match-end-0) yas--dollar-regions)))))
4128
4129 (defun yas--simple-mirror-parse-create (snippet)
4130 "Parse the simple \"$n\" fields/mirrors/exitmarkers in SNIPPET."
4131 (while (re-search-forward yas--simple-mirror-regexp nil t)
4132 (let ((number (string-to-number (match-string-no-properties 1))))
4133 (cond ((zerop number)
4134
4135 (setf (yas--snippet-exit snippet)
4136 (yas--make-exit (yas--make-marker (match-end 0))))
4137 (save-excursion
4138 (goto-char (match-beginning 0))
4139 (when yas-wrap-around-region
4140 (cond (yas-selected-text
4141 (insert yas-selected-text))
4142 ((and (eq yas-wrap-around-region 'cua)
4143 cua-mode
4144 (get-register ?0))
4145 (insert (prog1 (get-register ?0)
4146 (set-register ?0 nil))))))
4147 (push (cons (point) (yas--exit-marker (yas--snippet-exit snippet)))
4148 yas--dollar-regions)))
4149 (t
4150 (let ((field (yas--snippet-find-field snippet number)))
4151 (if field
4152 (let ((brand-new-mirror (yas--make-mirror
4153 (yas--make-marker (match-beginning 0))
4154 (yas--make-marker (match-beginning 0))
4155 nil)))
4156 (push brand-new-mirror
4157 (yas--field-mirrors field))
4158 (yas--calculate-mirrors-in-fields snippet brand-new-mirror))
4159 (push (yas--make-field number
4160 (yas--make-marker (match-beginning 0))
4161 (yas--make-marker (match-beginning 0))
4162 nil)
4163 (yas--snippet-fields snippet))))
4164 (push (cons (match-beginning 0) (match-end 0))
4165 yas--dollar-regions))))))
4166
4167 (defun yas--delete-regions (regions)
4168 "Sort disjuct REGIONS by start point, then delete from the back."
4169 (mapc #'(lambda (reg)
4170 (delete-region (car reg) (cdr reg)))
4171 (sort regions
4172 #'(lambda (r1 r2)
4173 (>= (car r1) (car r2))))))
4174
4175 (defun yas--calculate-mirror-depth (mirror &optional traversed)
4176 (let* ((parent (yas--mirror-parent-field mirror))
4177 (parents-mirrors (and parent
4178 (yas--field-mirrors parent))))
4179 (or (yas--mirror-depth mirror)
4180 (setf (yas--mirror-depth mirror)
4181 (cond ((memq mirror traversed)
4182 0)
4183 ((and parent parents-mirrors)
4184 (1+ (reduce #'max
4185 (mapcar #'(lambda (m)
4186 (yas--calculate-mirror-depth m
4187 (cons mirror
4188 traversed)))
4189 parents-mirrors))))
4190 (parent
4191 1)
4192 (t
4193 0))))))
4194
4195 (defun yas--update-mirrors (snippet)
4196 "Updates all the mirrors of SNIPPET."
4197 (save-excursion
4198 (dolist (field-and-mirror (sort
4199 ;; make a list of ((F1 . M1) (F1 . M2) (F2 . M3) (F2 . M4) ...)
4200 ;; where F is the field that M is mirroring
4201 ;;
4202 (mapcan #'(lambda (field)
4203 (mapcar #'(lambda (mirror)
4204 (cons field mirror))
4205 (yas--field-mirrors field)))
4206 (yas--snippet-fields snippet))
4207 ;; then sort this list so that entries with mirrors with parent
4208 ;; fields appear before. This was important for fixing #290, and
4209 ;; luckily also handles the case where a mirror in a field causes
4210 ;; another mirror to need reupdating
4211 ;;
4212 #'(lambda (field-and-mirror1 field-and-mirror2)
4213 (> (yas--calculate-mirror-depth (cdr field-and-mirror1))
4214 (yas--calculate-mirror-depth (cdr field-and-mirror2))))))
4215 (let* ((field (car field-and-mirror))
4216 (mirror (cdr field-and-mirror))
4217 (parent-field (yas--mirror-parent-field mirror)))
4218 ;; before updating a mirror with a parent-field, maybe advance
4219 ;; its start (#290)
4220 ;;
4221 (when parent-field
4222 (yas--advance-start-maybe mirror (yas--fom-start parent-field)))
4223 ;; update this mirror
4224 ;;
4225 (yas--mirror-update-display mirror field)
4226 ;; `yas--place-overlays' is needed if the active field and
4227 ;; protected overlays have been changed because of insertions
4228 ;; in `yas--mirror-update-display'
4229 ;;
4230 (when (eq field (yas--snippet-active-field snippet))
4231 (yas--place-overlays snippet field))))))
4232
4233 (defun yas--mirror-update-display (mirror field)
4234 "Update MIRROR according to FIELD (and mirror transform)."
4235
4236 (let* ((mirror-parent-field (yas--mirror-parent-field mirror))
4237 (reflection (and (not (and mirror-parent-field
4238 (yas--field-modified-p mirror-parent-field)))
4239 (or (yas--apply-transform mirror field 'empty-on-nil)
4240 (yas--field-text-for-display field)))))
4241 (when (and reflection
4242 (not (string= reflection (buffer-substring-no-properties (yas--mirror-start mirror)
4243 (yas--mirror-end mirror)))))
4244 (goto-char (yas--mirror-start mirror))
4245 (yas--inhibit-overlay-hooks
4246 (insert reflection))
4247 (if (> (yas--mirror-end mirror) (point))
4248 (delete-region (point) (yas--mirror-end mirror))
4249 (set-marker (yas--mirror-end mirror) (point))
4250 (yas--advance-start-maybe (yas--mirror-next mirror) (point))
4251 ;; super-special advance
4252 (yas--advance-end-of-parents-maybe mirror-parent-field (point))))))
4253
4254 (defun yas--field-update-display (field snippet)
4255 "Much like `yas--mirror-update-display', but for fields."
4256 (when (yas--field-transform field)
4257 (let ((transformed (and (not (eq (yas--field-number field) 0))
4258 (yas--apply-transform field field)))
4259 (point (point)))
4260 (when (and transformed
4261 (not (string= transformed (buffer-substring-no-properties (yas--field-start field)
4262 (yas--field-end field)))))
4263 (setf (yas--field-modified-p field) t)
4264 (goto-char (yas--field-start field))
4265 (yas--inhibit-overlay-hooks
4266 (insert transformed)
4267 (if (> (yas--field-end field) (point))
4268 (delete-region (point) (yas--field-end field))
4269 (set-marker (yas--field-end field) (point))
4270 (yas--advance-start-maybe (yas--field-next field) (point)))
4271 t)))))
4272
4273 \f
4274 ;;; Post-command hook:
4275 ;;
4276 (defun yas--post-command-handler ()
4277 "Handles various yasnippet conditions after each command."
4278 (cond (yas--protection-violation
4279 (goto-char yas--protection-violation)
4280 (setq yas--protection-violation nil))
4281 ((eq 'undo this-command)
4282 ;;
4283 ;; After undo revival the correct field is sometimes not
4284 ;; restored correctly, this condition handles that
4285 ;;
4286 (let* ((snippet (car (yas--snippets-at-point)))
4287 (target-field (and snippet
4288 (find-if-not #'(lambda (field)
4289 (yas--field-probably-deleted-p snippet field))
4290 (remove nil
4291 (cons (yas--snippet-active-field snippet)
4292 (yas--snippet-fields snippet)))))))
4293 (when target-field
4294 (yas--move-to-field snippet target-field))))
4295 ((not (yas--undo-in-progress))
4296 ;; When not in an undo, check if we must commit the snippet
4297 ;; (user exited it).
4298 (yas--check-commit-snippet))))
4299 \f
4300 ;;; Fancy docs:
4301 ;;
4302 ;; The docstrings for some functions are generated dynamically
4303 ;; depending on the context.
4304 ;;
4305 (put 'yas-expand 'function-documentation
4306 '(yas--expand-from-trigger-key-doc))
4307 (defun yas--expand-from-trigger-key-doc ()
4308 "A doc synthesizer for `yas--expand-from-trigger-key-doc'."
4309 (let ((fallback-description
4310 (cond ((eq yas-fallback-behavior 'call-other-command)
4311 (let* ((fallback (yas--keybinding-beyond-yasnippet)))
4312 (or (and fallback
4313 (format " call command `%s'." (pp-to-string fallback)))
4314 " do nothing (`yas-expand' doesn't shadow\nanything)")))
4315 ((eq yas-fallback-behavior 'return-nil)
4316 ", do nothing.")
4317 (t
4318 ", defer to `yas-fallback-behaviour' (which see)"))))
4319 (concat "Expand a snippet before point. If no snippet
4320 expansion is possible,"
4321 fallback-description
4322 "\n\nOptional argument FIELD is for non-interactive use and is an
4323 object satisfying `yas--field-p' to restrict the expansion to.")))
4324
4325 (put 'yas-expand-from-keymap 'function-documentation '(yas--expand-from-keymap-doc))
4326 (defun yas--expand-from-keymap-doc ()
4327 "A doc synthesizer for `yas--expand-from-keymap-doc'."
4328 (add-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce)
4329 (concat "Expand/run snippets from keymaps, possibly falling back to original binding.\n"
4330 (when (eq this-command 'describe-key)
4331 (let* ((vec (this-single-command-keys))
4332 (templates (mapcan #'(lambda (table)
4333 (yas--fetch table vec))
4334 (yas--get-snippet-tables)))
4335 (yas--direct-keymaps nil)
4336 (fallback (key-binding vec)))
4337 (concat "In this case, "
4338 (when templates
4339 (concat "these snippets are bound to this key:\n"
4340 (yas--template-pretty-list templates)
4341 "\n\nIf none of these expands, "))
4342 (or (and fallback
4343 (format "fallback `%s' will be called." (pp-to-string fallback)))
4344 "no fallback keybinding is called."))))))
4345
4346 (defun yas--template-pretty-list (templates)
4347 (let ((acc)
4348 (yas-buffer-local-condition 'always))
4349 (dolist (plate templates)
4350 (setq acc (concat acc "\n*) "
4351 (propertize (concat "\\\\snippet `" (car plate) "'")
4352 'yasnippet (cdr plate)))))
4353 acc))
4354
4355 (define-button-type 'help-snippet-def
4356 :supertype 'help-xref
4357 'help-function (lambda (template) (yas--visit-snippet-file-1 template))
4358 'help-echo (purecopy "mouse-2, RET: find snippets's definition"))
4359
4360 (defun yas--snippet-description-finish-runonce ()
4361 "Final adjustments for the help buffer when snippets are concerned."
4362 (yas--create-snippet-xrefs)
4363 (remove-hook 'temp-buffer-show-hook 'yas--snippet-description-finish-runonce))
4364
4365 (defun yas--create-snippet-xrefs ()
4366 (save-excursion
4367 (goto-char (point-min))
4368 (while (search-forward-regexp "\\\\\\\\snippet[ \s\t]+`\\([^']+\\)'" nil t)
4369 (let ((template (get-text-property (match-beginning 1)
4370 'yasnippet)))
4371 (when template
4372 (help-xref-button 1 'help-snippet-def template)
4373 (kill-region (match-end 1) (match-end 0))
4374 (kill-region (match-beginning 0) (match-beginning 1)))))))
4375
4376 (defun yas--expand-uuid (mode-symbol uuid &optional start end expand-env)
4377 "Expand a snippet registered in MODE-SYMBOL's table with UUID.
4378
4379 Remaining args as in `yas-expand-snippet'."
4380 (let* ((table (gethash mode-symbol yas--tables))
4381 (yas--current-template (and table
4382 (gethash uuid (yas--table-uuidhash table)))))
4383 (when yas--current-template
4384 (yas-expand-snippet (yas--template-content yas--current-template)))))
4385 \f
4386 ;;; Utils
4387
4388 (defvar yas-verbosity 4
4389 "Log level for `yas--message' 4 means trace most anything, 0 means nothing.")
4390
4391 (defun yas--message (level message &rest args)
4392 "When LEVEL is above `yas-verbosity-level', log MESSAGE and ARGS."
4393 (when (> yas-verbosity level)
4394 (message "%s" (apply #'yas--format message args))))
4395
4396 (defun yas--format (format-control &rest format-args)
4397 (apply #'format (concat "[yas] " format-control) format-args))
4398
4399 \f
4400 ;;; Some hacks:
4401 ;;
4402 ;; The functions
4403 ;;
4404 ;; `locate-dominating-file'
4405 ;; `region-active-p'
4406 ;;
4407 ;; added for compatibility in emacsen < 23
4408 (unless (>= emacs-major-version 23)
4409 (unless (fboundp 'region-active-p)
4410 (defun region-active-p () (and transient-mark-mode mark-active)))
4411
4412 (unless (fboundp 'locate-dominating-file)
4413 (defvar locate-dominating-stop-dir-regexp
4414 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
4415 "Regexp of directory names which stop the search in `locate-dominating-file'.
4416 Any directory whose name matches this regexp will be treated like
4417 a kind of root directory by `locate-dominating-file' which will stop its search
4418 when it bumps into it.
4419 The default regexp prevents fruitless and time-consuming attempts to find
4420 special files in directories in which filenames are interpreted as hostnames,
4421 or mount points potentially requiring authentication as a different user.")
4422
4423 (defun locate-dominating-file (file name)
4424 "Look up the directory hierarchy from FILE for a file named NAME.
4425 Stop at the first parent directory containing a file NAME,
4426 and return the directory. Return nil if not found."
4427 ;; We used to use the above locate-dominating-files code, but the
4428 ;; directory-files call is very costly, so we're much better off doing
4429 ;; multiple calls using the code in here.
4430 ;;
4431 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
4432 ;; `name' in /home or in /.
4433 (setq file (abbreviate-file-name file))
4434 (let ((root nil)
4435 (prev-file file)
4436 ;; `user' is not initialized outside the loop because
4437 ;; `file' may not exist, so we may have to walk up part of the
4438 ;; hierarchy before we find the "initial UUID".
4439 (user nil)
4440 try)
4441 (while (not (or root
4442 (null file)
4443 ;; FIXME: Disabled this heuristic because it is sometimes
4444 ;; inappropriate.
4445 ;; As a heuristic, we stop looking up the hierarchy of
4446 ;; directories as soon as we find a directory belonging
4447 ;; to another user. This should save us from looking in
4448 ;; things like /net and /afs. This assumes that all the
4449 ;; files inside a project belong to the same user.
4450 ;; (let ((prev-user user))
4451 ;; (setq user (nth 2 (file-attributes file)))
4452 ;; (and prev-user (not (equal user prev-user))))
4453 (string-match locate-dominating-stop-dir-regexp file)))
4454 (setq try (file-exists-p (expand-file-name name file)))
4455 (cond (try (setq root file))
4456 ((equal file (setq prev-file file
4457 file (file-name-directory
4458 (directory-file-name file))))
4459 (setq file nil))))
4460 root))))
4461
4462 ;; `c-neutralize-syntax-in-CPP` sometimes fires "End of Buffer" error
4463 ;; (when it execute forward-char) and interrupt the after change
4464 ;; hook. Thus prevent the insert-behind hook of yasnippet to be
4465 ;; invoked. Here's a way to reproduce it:
4466
4467 ;; # open a *new* Emacs.
4468 ;; # load yasnippet.
4469 ;; # open a *new* .cpp file.
4470 ;; # input "inc" and press TAB to expand the snippet.
4471 ;; # select the `#include <...>` snippet.
4472 ;; # type inside `<>`
4473
4474 (defadvice c-neutralize-syntax-in-CPP
4475 (around yas--mp/c-neutralize-syntax-in-CPP activate)
4476 "Adviced `c-neutralize-syntax-in-CPP' to properly
4477 handle the end-of-buffer error fired in it by calling
4478 `forward-char' at the end of buffer."
4479 (condition-case err
4480 ad-do-it
4481 (error (message (error-message-string err)))))
4482
4483 ;; disable c-electric-* serial command in YAS fields
4484 (add-hook 'c-mode-common-hook
4485 '(lambda ()
4486 (dolist (k '(":" ">" ";" "<" "{" "}"))
4487 (define-key (symbol-value (make-local-variable 'yas-keymap))
4488 k 'self-insert-command))))
4489 \f
4490 ;;; Backward compatibility to yasnippet <= 0.7
4491
4492 (defvar yas--exported-syms '(;; `defcustom's
4493 ;;
4494 yas-snippet-dirs
4495 yas-prompt-functions
4496 yas-indent-line
4497 yas-also-auto-indent-first-line
4498 yas-snippet-revival
4499 yas-triggers-in-field
4500 yas-fallback-behavior
4501 yas-choose-keys-first
4502 yas-choose-tables-first
4503 yas-use-menu
4504 yas-trigger-symbol
4505 yas-wrap-around-region
4506 yas-good-grace
4507 yas-visit-from-menu
4508 yas-expand-only-for-last-commands
4509 yas-field-highlight-face
4510
4511 ;; these vars can be customized as well
4512 ;;
4513 yas-keymap
4514 yas-verbosity
4515 yas-extra-modes
4516 yas-key-syntaxes
4517 yas-after-exit-snippet-hook
4518 yas-before-expand-snippet-hook
4519 yas-buffer-local-condition
4520 yas-dont-activate
4521
4522 ;; prompting functions
4523 ;;
4524 yas-x-prompt
4525 yas-ido-prompt
4526 yas-no-prompt
4527 yas-completing-prompt
4528 yas-dropdown-prompt
4529
4530 ;; interactive functions
4531 ;;
4532 yas-expand
4533 yas-minor-mode
4534 yas-global-mode
4535 yas-direct-keymaps-reload
4536 yas-minor-mode-on
4537 yas-load-directory
4538 yas-reload-all
4539 yas-compile-directory
4540 yas-recompile-all
4541 yas-about
4542 yas-expand-from-trigger-key
4543 yas-expand-from-keymap
4544 yas-insert-snippet
4545 yas-visit-snippet-file
4546 yas-new-snippet
4547 yas-load-snippet-buffer
4548 yas-tryout-snippet
4549 yas-describe-tables
4550 yas-next-field-or-maybe-expand
4551 yas-next-field
4552 yas-prev-field
4553 yas-abort-snippet
4554 yas-exit-snippet
4555 yas-exit-all-snippets
4556 yas-skip-and-clear-or-delete-char
4557
4558 ;; symbols that I "exported" for use
4559 ;; in snippets and hookage
4560 ;;
4561 yas-expand-snippet
4562 yas-define-snippets
4563 yas-define-menu
4564 yas-snippet-beg
4565 yas-snippet-end
4566 yas-modified-p
4567 yas-moving-away-p
4568 yas-text
4569 yas-substr
4570 yas-choose-value
4571 yas-key-to-value
4572 yas-throw
4573 yas-verify-value
4574 yas-field-value
4575 yas-text
4576 yas-selected-text
4577 yas-default-from-field
4578 yas-inside-string
4579 yas-unimplemented
4580 yas-define-condition-cache
4581 yas-hippie-try-expand
4582 yas-active-keys
4583
4584 ;; debug definitions
4585 ;; yas-debug-snippet-vars
4586 ;; yas-exterminate-package
4587 ;; yas-debug-test
4588
4589 ;; testing definitions
4590 ;; yas-should-expand
4591 ;; yas-should-not-expand
4592 ;; yas-mock-insert
4593 ;; yas-make-file-or-dirs
4594 ;; yas-variables
4595 ;; yas-saving-variables
4596 ;; yas-call-with-snippet-dirs
4597 ;; yas-with-snippet-dirs
4598 )
4599 "Exported yasnippet symbols.
4600
4601 i.e. ones that I will try to keep in future yasnippet versions
4602 and ones that other elisp libraries can more or less safely rely
4603 upon.")
4604
4605 (defvar yas--dont-backport '(yas-active-keys)
4606 "Exported symbols that don't map back to \"yas/*\" variants.")
4607
4608 (dolist (sym (set-difference yas--exported-syms yas--dont-backport))
4609 (let ((backported (intern (replace-regexp-in-string "^yas-" "yas/" (symbol-name sym)))))
4610 (when (boundp sym)
4611 (make-obsolete-variable backported sym "yasnippet 0.8")
4612 (defvaralias backported sym))
4613 (when (fboundp sym)
4614 (make-obsolete backported sym "yasnippet 0.8")
4615 (defalias backported sym))))
4616
4617 \f
4618 (provide 'yasnippet)
4619
4620 ;;; yasnippet.el ends here
4621 ;; Local Variables:
4622 ;; coding: utf-8
4623 ;; byte-compile-warnings: (not cl-functions)
4624 ;; End: