;;; yasnippet.el --- Yet another snippet extension for Emacs. ;; Copyright 2008 pluskid ;; ;; Author: pluskid ;; Version: 0.5.6 XXX: Change this ;; X-URL: http://code.google.com/p/yasnippet/ ;; This file is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 2, or (at your option) ;; any later version. ;; This file is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, USA. ;;; Commentary: ;; Basic steps to setup: ;; 1. Place `yasnippet.el' in your `load-path'. ;; 2. In your .emacs file: ;; (require 'yasnippet) ;; 3. Place the `snippets' directory somewhere. E.g: ~/.emacs.d/snippets ;; 4. In your .emacs file ;; (yas/initialize) ;; (yas/load-directory "~/.emacs.d/snippets") ;; ;; For more information and detailed usage, refer to the project page: ;; http://code.google.com/p/yasnippet/ (require 'cl) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; User customizable variables ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defvar yas/dont-activate nil "If set to t, don't activate yas/minor-mode automatically.") (make-variable-buffer-local 'yas/dont-activate) (defvar yas/key-syntaxes (list "w" "w_" "w_." "^ ") "A list of syntax of a key. This list is tried in the order to try to find a key. For example, if the list is '(\"w\" \"w_\"). And in emacs-lisp-mode, where \"-\" has the syntax of \"_\": foo-bar will first try \"bar\", if not found, then \"foo-bar\" is tried.") (defvar yas/root-directory nil "The (list of) root directory that stores the snippets for each major modes.") (defvar yas/indent-line t "Each (except the 1st) line of the snippet template is indented to current column if this variable is non-`nil'.") (make-variable-buffer-local 'yas/indent-line) (defvar yas/trigger-key (kbd "") "The key to bind as a trigger of snippet.") (defvar yas/next-field-key (kbd "") "The key to navigate to next field.") (defvar yas/keymap (make-sparse-keymap) "The keymap of snippet.") (define-key yas/keymap yas/next-field-key 'yas/next-field) (define-key yas/keymap (kbd "S-TAB") 'yas/prev-field) (define-key yas/keymap (kbd "") 'yas/prev-field) (define-key yas/keymap (kbd "") 'yas/prev-field) (define-key yas/keymap (kbd "") 'yas/prev-field) (defvar yas/show-all-modes-in-menu nil "Currently yasnippet only all \"real modes\" to menubar. For example, you define snippets for \"cc-mode\" and make it the parent of `c-mode', `c++-mode' and `java-mode'. There's really no such mode like \"cc-mode\". So we don't show it in the yasnippet menu to avoid the menu becoming too big with strange modes. The snippets defined for \"cc-mode\" can still be accessed from menu-bar->c-mode->parent (or c++-mode, java-mode, all are ok). However, if you really like to show all modes in the menu, set this variable to t.") (defvar yas/use-menu t "If this is set to `t', all snippet template of the current mode will be listed under the menu \"yasnippet\".") (defvar yas/trigger-symbol " =>" "The text that will be used in menu to represent the trigger.") (defface yas/field-highlight-face '((((class color) (background light)) (:background "DarkSeaGreen1")) (t (:background "DimGrey"))) "The face used to highlight the currently active field of a snippet") (defface yas/field-debug-face '((((class color) (background light)) (:background "tomato")) (t (:background "tomato"))) "The face used for debugging") (defvar yas/window-system-popup-function #'yas/dropdown-list-popup-for-template "When there's multiple candidate for a snippet key. This function is called to let user select one of them. `yas/text-popup-function' is used instead when not in a window system.") (defvar yas/text-popup-function #'yas/dropdown-list-popup-for-template "When there's multiple candidate for a snippet key. If not in a window system, this function is called to let user select one of them. `yas/window-system-popup-function' is used instead when in a window system.") (defvar yas/extra-mode-hooks '() "A list of mode-hook that should be hooked to enable yas/minor-mode. Most modes need no special consideration. Some mode (like `ruby-mode') doesn't call `after-change-major-mode-hook' need to be hooked explicitly.") (mapc '(lambda (x) (add-to-list 'yas/extra-mode-hooks x)) '(ruby-mode-hook actionscript-mode-hook ox-mode-hook python-mode-hook)) (defvar yas/after-exit-snippet-hook '() "Hooks to run after a snippet exited. The hooks will be run in an environment where some variables bound to proper values: * yas/snippet-beg : The beginning of the region of the snippet. * yas/snippet-end : Similar to beg.") (defvar yas/before-expand-snippet-hook '() "Hooks to run after a before expanding a snippet.") (defvar yas/buffer-local-condition '(if (and (not (bobp)) (or (equal "font-lock-comment-face" (get-char-property (1- (point)) 'face)) (equal "font-lock-string-face" (get-char-property (1- (point)) 'face)))) '(require-snippet-condition . force-in-comment) t) "Condition to yasnippet local to each buffer. * If yas/buffer-local-condition evaluate to nil, snippet won't be expanded. * If it evaluate to the a cons cell where the car is the symbol require-snippet-condition and the cdr is a symbol (let's call it requirement): * If the snippet has no condition, then it won't be expanded. * If the snippet has a condition but evaluate to nil or error occured during evaluation, it won't be expanded. * If the snippet has a condition that evaluate to non-nil (let's call it result): * If requirement is t, the snippet is ready to be expanded. * If requirement is eq to result, the snippet is ready to be expanded. * Otherwise the snippet won't be expanded. * If it evaluate to other non-nil value: * If the snippet has no condition, or has a condition that evaluate to non-nil, it is ready to be expanded. * Otherwise, it won't be expanded. Here's an example: (add-hook 'python-mode-hook '(lambda () (setq yas/buffer-local-condition '(if (python-in-string/comment) '(require-snippet-condition . force-in-comment) t))))") (defvar yas/fallback-behavior 'call-other-command "The fall back behavior of YASnippet when it can't find a snippet to expand. * 'call-other-command means try to temporarily disable YASnippet and call other command bound to `yas/trigger-key'. * 'return-nil means return nil.") ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Internal variables ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defvar yas/version "0.5.6") (defvar yas/snippet-tables (make-hash-table) "A hash table of snippet tables corresponding to each major-mode.") (defvar yas/menu-table (make-hash-table) "A hash table of menus of corresponding major-mode.") (defvar yas/menu-keymap (make-sparse-keymap "YASnippet")) ;; empty menu will cause problems, so we insert some items (define-key yas/menu-keymap [yas/about] '(menu-item "About" yas/about)) (define-key yas/menu-keymap [yas/reload] '(menu-item "Reload all snippets" yas/reload-all)) (define-key yas/menu-keymap [yas/load] '(menu-item "Load snippets..." yas/load-directory)) (define-key yas/menu-keymap [yas/separator] '(menu-item "--")) (defvar yas/known-modes '(ruby-mode rst-mode markdown-mode) "A list of mode which is well known but not part of emacs.") (defconst yas/escape-backslash (concat "YASESCAPE" "BACKSLASH" "PROTECTGUARD")) (defconst yas/escape-dollar (concat "YASESCAPE" "DOLLAR" "PROTECTGUARD")) (defconst yas/escape-backquote (concat "YASESCAPE" "BACKQUOTE" "PROTECTGUARD")) ;; (defconst yas/field-regexp ;; (concat "$\\([0-9]+\\)" "\\|" ;; "${\\(?:\\([0-9]+\\):\\)?\\([^}]*\\)}")) (defconst yas/field-regexp (concat "$\\([0-9]+\\)" "\\|" "${\\(?:\\([0-9]+\\):\\)?\\(.*\\)}")) (defvar yas/snippet-id-seed 0 "Contains the next id for a snippet.") (defun yas/snippet-next-id () (let ((id yas/snippet-id-seed)) (incf yas/snippet-id-seed) id)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; YASnippet minor mode ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defvar yas/minor-mode-map (make-sparse-keymap) "The keymap of yas/minor-mode") (defvar yas/minor-mode-on-hook nil "Hook to call when yas/minor-mode is on.") (defvar yas/minor-mode-off-hook nil "Hook to call when yas/minor-mode is off.") (define-minor-mode yas/minor-mode "Toggle YASnippet mode. With no argument, this command toggles the mode. positive prefix argument turns on the mode. Negative prefix argument turns off the mode. When YASnippet mode is enabled, the TAB key expands snippets of code depending on the mode. You can customize the key through `yas/trigger-key'." ;; The initial value. nil ;; The indicator for the mode line. " yas" :group 'editing (define-key yas/minor-mode-map yas/trigger-key 'yas/expand) (set 'yas/registered-snippets (make-hash-table :test 'eq))) (defun yas/minor-mode-auto-on () "Turn on YASnippet minor mode unless `yas/dont-activate' is set to t." (unless yas/dont-activate (yas/minor-mode-on))) (defun yas/minor-mode-on () "Turn on YASnippet minor mode." (interactive) (yas/minor-mode 1)) (defun yas/minor-mode-off () "Turn off YASnippet minor mode." (interactive) (yas/minor-mode -1)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Internal Structs ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defstruct (yas/template (:constructor yas/make-template (content name condition))) "A template for a snippet." content name condition) (defstruct (yas/snippet (:constructor yas/make-snippet ())) "A snippet. ..." (fields '()) (exit nil) (id (yas/snippet-next-id) :read-only t) (control-overlay nil) (active-field-overlay nil) (active-field nil)) (defstruct (yas/field (:constructor yas/make-field (number overlay-pair parent-field))) "A field." number overlay-pair parent-field (mirrors '()) (next nil) (prev nil) (transform nil) (modified nil)) (defstruct (yas/mirror (:constructor yas/make-mirror (overlay))) "A mirror." overlay (transform nil)) (defun yas/field-start (field) (overlay-start (car (yas/field-overlay-pair field)))) (defun yas/field-end (field) (overlay-end (cdr (yas/field-overlay-pair field)))) (defun yas/mirror-start (mirror) (overlay-start (yas/mirror-overlay mirror))) (defun yas/mirror-end (mirror) (overlay-end (yas/mirror-overlay mirror))) (defstruct (yas/snippet-table (:constructor yas/make-snippet-table ())) "A table to store snippets for a perticular mode." (hash (make-hash-table :test 'equal)) (parent nil)) (defun yas/snippet-find-field (snippet number) (find-if #'(lambda (field) (eq number (yas/field-number field))) (yas/snippet-fields snippet))) (defun yas/snippet-field-compare (field1 field2) "Compare two fields. The field with a number is sorted first. If they both have a number, compare through the number. If neither have, compare through the field's start point" (let ((n1 (yas/field-number field1)) (n2 (yas/field-number field2))) (if n1 (if n2 (< n1 n2) t) (if n2 nil (< (yas/field-start field1) (yas/field-start field2)))))) (defun yas/template-condition-predicate (condition) (condition-case err (save-excursion (save-restriction (save-match-data (eval condition)))) (error (progn (message (format "[yas]error in condition evaluation: %s" (error-message-string err))) nil)))) (defun yas/filter-templates-by-condition (templates) "Filter the templates using the condition. The rules are: * If the template has no condition, it is kept. * If the template's condition eval to non-nil, it is kept. * Otherwise (eval error or eval to nil) it is filtered." (remove-if-not '(lambda (pair) (let ((condition (yas/template-condition (cdr pair)))) (if (null condition) (if yas/require-template-condition nil t) (let ((result (yas/template-condition-predicate condition))) (if yas/require-template-condition (if (eq yas/require-template-condition t) result (eq result yas/require-template-condition)) result))))) templates)) (defun yas/snippet-table-fetch (table key) "Fetch a snippet binding to KEY from TABLE. If not found, fetch from parent if any." (let ((templates (yas/filter-templates-by-condition (gethash key (yas/snippet-table-hash table))))) (when (and (null templates) (not (null (yas/snippet-table-parent table)))) (setq templates (yas/snippet-table-fetch (yas/snippet-table-parent table) key))) templates)) (defun yas/snippet-table-store (table full-key key template) "Store a snippet template in the table." (puthash key (yas/modify-alist (gethash key (yas/snippet-table-hash table)) full-key template) (yas/snippet-table-hash table))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Internal functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defun yas/ensure-minor-mode-priority () "Ensure that the key binding of yas/minor-mode takes priority." (unless (eq 'yas/minor-mode (caar minor-mode-map-alist)) (setq minor-mode-map-alist (cons (cons 'yas/minor-mode yas/minor-mode-map) (assq-delete-all 'yas/minor-mode minor-mode-map-alist))))) (defun yas/real-mode? (mode) "Try to find out if MODE is a real mode. The MODE bound to a function (like `c-mode') is considered real mode. Other well known mode like `ruby-mode' which is not part of Emacs might not bound to a function until it is loaded. So yasnippet keeps a list of modes like this to help the judgement." (or (fboundp mode) (find mode yas/known-modes))) (defun yas/eval-string (string) "Evaluate STRING and convert the result to string." (condition-case err (save-excursion (save-restriction (save-match-data (widen) (format "%s" (eval (read string)))))) (error (format "(error in elisp evaluation: %s)" (error-message-string err))))) (defun yas/apply-transform (field-or-mirror field) "Calculate the value of the field. If there's a transform for this field, apply it. Otherwise, the value is returned unmodified." (let ((text (yas/field-text-for-display field)) (transform (if (yas/mirror-p field-or-mirror) (yas/mirror-transform field-or-mirror) (yas/field-transform field-or-mirror)))) (if transform (yas/eval-string transform) text))) (defsubst yas/replace-all (from to) "Replace all occurance from FROM to TO." (goto-char (point-min)) (while (search-forward from nil t) (replace-match to t t))) (defun yas/snippet-table (mode) "Get the snippet table corresponding to MODE." (let ((table (gethash mode yas/snippet-tables))) (unless table (setq table (yas/make-snippet-table)) (puthash mode table yas/snippet-tables)) table)) (defsubst yas/current-snippet-table () "Get the snippet table for current major-mode." (yas/snippet-table major-mode)) (defun yas/menu-keymap-for-mode (mode) "Get the menu keymap correspondong to MODE." (let ((keymap (gethash mode yas/menu-table))) (unless keymap (setq keymap (make-sparse-keymap)) (puthash mode keymap yas/menu-table)) keymap)) (defun yas/current-key () "Get the key under current position. A key is used to find the template of a snippet in the current snippet-table." (let ((start (point)) (end (point)) (syntaxes yas/key-syntaxes) syntax done templates) (while (and (not done) syntaxes) (setq syntax (car syntaxes)) (setq syntaxes (cdr syntaxes)) (save-excursion (skip-syntax-backward syntax) (setq start (point))) (setq templates (yas/snippet-table-fetch (yas/current-snippet-table) (buffer-substring-no-properties start end))) (if templates (setq done t) (setq start end))) (list templates start end))) (defun yas/field-text-for-display (field &optional field-number) "Return the propertized display text for field FIELD. " (let ((text (yas/current-field-text field))) (when text (while (and (string-match yas/field-regexp text) (match-beginning 3)) (setq text (concat (substring text 0 (match-beginning 0)) (if (and field-number (match-beginning 2) (= field-number (string-to-number (substring text (match-beginning 2))))) (propertize (substring text (match-beginning 3) (match-end 3)) 'face 'yas/field-highlight-face) (substring text (match-beginning 3) (match-end 3))) (substring text (match-end 0))))) text))) (defun yas/current-field-text (field) (buffer-substring-no-properties (yas/field-start field) (yas/field-end field))) (defun yas/make-control-overlay (start end) "..." (let ((overlay (make-overlay start end nil nil t))) (overlay-put overlay 'keymap yas/keymap) (overlay-put overlay 'yas/snippet-reference snippet) overlay)) (defun yas/on-field-overlay-modification (overlay after? beg end &optional length) "To be written" (when (and after? yas/registered-snippets) (maphash #'(lambda (key snippet) (dolist (field (yas/snippet-fields snippet)) (dolist (mirror (yas/field-mirrors field)) (yas/mirror-update-display mirror field)))) yas/registered-snippets))) (defun yas/on-hidden-overlay-modification (overlay after? beg end &optional length) (defun yas/overlay-insert-in-front-hook (overlay after? beg end &optional length) "To be written" ) (defun yas/overlay-insert-behind-hook (overlay after? beg end &optional length) "To be written" ) (defun yas/expand-snippet (start end template) "Expand snippet at current point. Text between START and END will be deleted before inserting template." (run-hooks 'yas/before-expand-snippet-hook) (goto-char start) (let* ((key (buffer-substring-no-properties start end)) (original-undo-list buffer-undo-list) ;; save previous undo information (buffer-undo-list t) (inhibit-modification-hooks t) (length (- end start)) (column (current-column))) (save-restriction (narrow-to-region start start) ;; (setq buffer-undo-list t) ;; disable undo for a short while (insert template) ;; Step XX: do necessary indent (when yas/indent-line (let* ((indent (if indent-tabs-mode (concat (make-string (/ column tab-width) ?\t) (make-string (% column tab-width) ?\ )) (make-string column ?\ )))) (goto-char (point-min)) (while (and (zerop (forward-line)) (= (current-column) 0)) (insert indent)))) ;; Step XX: protect backslash and backquote (yas/replace-all "\\\\" yas/escape-backslash) (yas/replace-all "\\`" yas/escape-backquote) ;; Step XX: evaluate all backquotes (goto-char (point-min)) (while (re-search-forward "`\\([^`]*\\)`" nil t) ;; go back so that (current-column) in elisp code evaluation ;; will calculate to a meaningful value (goto-char (match-beginning 0)) (replace-match (yas/eval-string (match-string-no-properties 1)) t t)) ;; Step XX: protect all escapes, including backslash and backquot ;; which may be produced in Step 3 (yas/replace-all "\\\\" yas/escape-backslash) (yas/replace-all "\\`" yas/escape-backquote) (yas/replace-all "\\$" yas/escape-dollar) ;; Step XX: Create and register a brand new snippet in the local ;; `yas/registered-snippets' var. Create fields. (let ((snippet (yas/register-snippet (yas/make-snippet)))) (goto-char (point-min)) (yas/field-parse-create snippet) ;; Step XX: Sort and link each field (setf (yas/snippet-fields snippet) (sort (yas/snippet-fields snippet) '(lambda (field1 field2) (yas/snippet-field-compare field1 field2)))) (let ((prev nil)) (dolist (field (yas/snippet-fields snippet)) (setf (yas/field-prev field) prev) (when prev (setf (yas/field-next prev) field)) (setq prev field))) ;; Step XX: Hide (or highlight for debugging) all hidden overlays (let ((prop-list)) (push (if (member 'yas/debug-some-vars post-command-hook) (cons 'face 'yas/field-debug-face) (cons 'invisible t)) prop-list) (push (cons 'evaporate t) prop-list) (dolist (prop prop-list) (dolist (field (yas/snippet-fields snippet)) (overlay-put (car (yas/field-overlay-pair field)) (car prop) (cdr prop)) (overlay-put (cdr (yas/field-overlay-pair field)) (car prop) (cdr prop)) (dolist (mirror (yas/field-mirrors field)) (overlay-put (yas/mirror-overlay mirror) (car prop) (cdr prop)) (yas/mirror-update-display mirror field))) (when (overlayp (yas/snippet-exit snippet)) (overlay-put (yas/snippet-exit snippet) (car prop) (cdr prop))))) ;; Step XX: Create keymap overlay for snippet (setf (yas/snippet-control-overlay snippet) (yas/make-control-overlay (point-min) (point-max))) ;; Step XX: restore all escape characters (yas/replace-all yas/escape-dollar "$") (yas/replace-all yas/escape-backquote "`") (yas/replace-all yas/escape-backslash "\\") ;; Step XX: move to end and make sure exit-marker exist (goto-char (point-max)) (unless (yas/snippet-exit snippet) (setf (yas/snippet-exit snippet) (copy-marker (point) t))) ;; Step XX: remove the trigger key (widen) (delete-char length) ;; Step XX: place the cursor at a proper place (let* ((first-field (car (yas/snippet-fields snippet))) overlay) (cond (first-field ;; Step XX: Move to the new field, setting up ;; properties of the wandering active field overlay. (yas/move-to-field snippet first-field)) (t ;; no need to call exit-snippet, since no overlay created. (yas/exit-snippet snippet)))) ;; Step XX: Do necessary indenting (save-excursion (goto-char (overlay-start (yas/snippet-control-overlay snippet))) (while (re-search-forward "$>" nil t) (replace-match "") (indent-according-to-mode))))))) (defun yas/field-parse-create (snippet &optional parent-field) "Parse a recently inserted snippet template, creating all necessary fields. Allows nested placeholder in the style of Textmate." (while (re-search-forward yas/field-regexp nil t) (let ((number (or (match-string-no-properties 1) (match-string-no-properties 2)))) (cond ((and number (string= "0" number)) (setf (yas/snippet-exit snippet) (make-overlay (match-beginning 0) (match-end 0)))) ((match-beginning 3) (let ((brand-new-field (yas/make-field (and number (string-to-number number)) (cons (make-overlay (match-beginning 0) (match-beginning 3)) (make-overlay (match-end 3) (match-end 0))) parent-field))) (push brand-new-field (yas/snippet-fields snippet)) (save-excursion (save-restriction (narrow-to-region (match-beginning 3) (match-end 3)) (goto-char (point-min)) (yas/field-parse-create snippet brand-new-field))))) (t (let ((field (yas/snippet-find-field snippet (and number (string-to-number number))))) (when field (push (yas/make-mirror (make-overlay (match-beginning 0) (match-end 0))) (yas/field-mirrors field))))))))) (defun yas/mirror-update-display (mirror field) (overlay-put (yas/mirror-overlay mirror) 'after-string (yas/apply-transform mirror field))) (defun yas/snippet-of-current-keymap (&optional point) "Return the most recently inserted snippet covering POINT." (let ((point (or point (point))) (keymap-snippet nil) (snippet nil)) (dolist (overlay (overlays-at point)) (setq snippet (overlay-get overlay 'yas/snippet-reference)) (when snippet (if (null keymap-snippet) (setq keymap-snippet snippet) (when (> (yas/snippet-id snippet) (yas/snippet-id keymap-snippet)) (setq keymap-snippet snippet))))) keymap-snippet)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; Template-related and snippet loading functions (defun yas/parse-template (&optional file-name) "Parse the template in the current buffer. If the buffer contains a line of \"# --\" then the contents above this line are ignored. Variables can be set above this line through the syntax: #name : value Here's a list of currently recognized variables: * name * contributor * condition #name: #include \"...\" # -- #include \"$1\"" (goto-char (point-min)) (let ((name file-name) template bound condition) (if (re-search-forward "^# --\n" nil t) (progn (setq template (buffer-substring-no-properties (point) (point-max))) (setq bound (point)) (goto-char (point-min)) (while (re-search-forward "^#\\([^ ]+\\) *: *\\(.*\\)$" bound t) (when (string= "name" (match-string-no-properties 1)) (setq name (match-string-no-properties 2))) (when (string= "condition" (match-string-no-properties 1)) (setq condition (read (match-string-no-properties 2)))))) (setq template (buffer-substring-no-properties (point-min) (point-max)))) (list template name condition))) (defun yas/directory-files (directory file?) "Return directory files or subdirectories in full path." (remove-if (lambda (file) (or (string-match "^\\." (file-name-nondirectory file)) (if file? (file-directory-p file) (not (file-directory-p file))))) (directory-files directory t))) (defun yas/make-menu-binding (template) (lexical-let ((template template)) (lambda () (interactive) (yas/expand-snippet (point) (point) template)))) (defun yas/modify-alist (alist key value) "Modify ALIST to map KEY to VALUE. return the new alist." (let ((pair (assoc key alist))) (if (null pair) (cons (cons key value) alist) (setcdr pair value) alist))) (defun yas/fake-keymap-for-popup (templates) "Create a fake keymap for popup menu usage." (cons 'keymap (mapcar (lambda (pair) (let* ((template (cdr pair)) (name (yas/template-name template)) (content (yas/template-content template))) (list content 'menu-item name t))) templates))) (defun yas/point-to-coord (&optional point) "Get the xoffset/yoffset information of POINT. If POINT is not given, default is to current point. If `posn-at-point' is not available (like in Emacs 21.3), t is returned simply." (if (fboundp 'posn-at-point) (let ((x-y (posn-x-y (posn-at-point (or point (point)))))) (list (list (+ (car x-y) 10) (+ (cdr x-y) 20)) (selected-window))) t)) (defun yas/x-popup-menu-for-template (templates) "Show a popup menu listing templates to let the user select one." (car (x-popup-menu (yas/point-to-coord) (yas/fake-keymap-for-popup templates)))) (defun yas/text-popup-for-template (templates) "Can't display popup menu in text mode. Just select the first one." (yas/template-content (cdar templates))) (defun yas/dropdown-list-popup-for-template (templates) "Use dropdown-list.el to popup for templates. Better than the default \"select first\" behavior of `yas/text-popup-for-template'. You can also use this in window-system. NOTE: You need to download and install dropdown-list.el to use this." (if (fboundp 'dropdown-list) (let ((n (dropdown-list (mapcar (lambda (i) (yas/template-name (cdr i))) templates)))) (if n (yas/template-content (cdr (nth n templates))) nil)) (error "Please download and install dropdown-list.el to use this"))) (defun yas/popup-for-template (templates) (if window-system (funcall yas/window-system-popup-function templates) (funcall yas/text-popup-function templates))) (defun yas/load-directory-1 (directory &optional parent) "Really do the job of loading snippets from a directory hierarchy." (let ((mode-sym (intern (file-name-nondirectory directory))) (snippets nil)) (with-temp-buffer (dolist (file (yas/directory-files directory t)) (when (file-readable-p file) (insert-file-contents file nil nil nil t) (let ((snippet-file-name (file-name-nondirectory file))) (push (cons snippet-file-name (yas/parse-template snippet-file-name)) snippets))))) (yas/define-snippets mode-sym snippets parent) (dolist (subdir (yas/directory-files directory nil)) (yas/load-directory-1 subdir mode-sym)))) (defun yas/quote-string (string) "Escape and quote STRING. foo\"bar\\! -> \"foo\\\"bar\\\\!\"" (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" string t) "\"")) (defun yas/compile-bundle (&optional yasnippet yasnippet-bundle snippet-roots code) "Compile snippets in SNIPPET-ROOTS to a single bundle file. SNIPPET-ROOTS is a list of root directories that contains the snippets definition. YASNIPPET is the yasnippet.el file path. YASNIPPET-BUNDLE is the output file of the compile result. CODE is the code you would like to used to initialize yasnippet. Here's the default value for all the parameters: (yas/compile-bundle \"yasnippet.el\" \"./yasnippet-bundle.el\" '(\"snippets\") \"(yas/initialize)\")" (when (null yasnippet) (setq yasnippet "yasnippet.el")) (when (null yasnippet-bundle) (setq yasnippet-bundle "./yasnippet-bundle.el")) (when (null snippet-roots) (setq snippet-roots '("snippets"))) (when (null code) (setq code "(yas/initialize)")) (let ((dirs (or (and (listp snippet-roots) snippet-roots) (list snippet-roots))) (bundle-buffer nil)) (with-temp-buffer (setq bundle-buffer (current-buffer)) (insert-file-contents yasnippet) (goto-char (point-max)) (insert ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n") (insert ";;;; Auto-generated code ;;;;\n") (insert ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;\n") (insert code "\n") (flet ((yas/define-snippets (mode snippets &optional parent) (with-current-buffer bundle-buffer (insert ";;; snippets for " (symbol-name mode) "\n") (insert "(yas/define-snippets '" (symbol-name mode) "\n") (insert "'(\n") (dolist (snippet snippets) (insert " (" (yas/quote-string (car snippet)) " " (yas/quote-string (cadr snippet)) " " (if (caddr snippet) (yas/quote-string (caddr snippet)) "nil") " " (if (nth 3 snippet) (format "'%s" (nth 3 snippet)) "nil") ")\n")) (insert " )\n") (insert (if parent (concat "'" (symbol-name parent)) "nil") ")\n\n")))) (dolist (dir dirs) (dolist (subdir (yas/directory-files dir nil)) (yas/load-directory-1 subdir nil)))) (insert "(provide '" (file-name-nondirectory (file-name-sans-extension yasnippet-bundle)) ")\n") (setq buffer-file-name yasnippet-bundle) (save-buffer)))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; User level functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defun yas/about () (interactive) (message (concat "yasnippet (version " yas/version ") -- pluskid "))) (defun yas/reload-all () "Reload all snippets." (interactive) (if yas/root-directory (if (listp yas/root-directory) (dolist (directory yas/root-directory) (yas/load-directory directory)) (yas/load-directory yas/root-directory)) (call-interactively 'yas/load-directory)) (message "done.")) (defun yas/load-directory (directory) "Load snippet definition from a directory hierarchy. Below the top-level directory, each directory is a mode name. And under each subdirectory, each file is a definition of a snippet. The file name is the trigger key and the content of the file is the template." (interactive "DSelect the root directory: ") (unless (file-directory-p directory) (error "Error %s not a directory" directory)) (add-to-list 'yas/root-directory directory) (dolist (dir (yas/directory-files directory nil)) (yas/load-directory-1 dir)) (when (interactive-p) (message "done."))) (defun yas/initialize () "Do necessary initialization." (add-hook 'after-change-major-mode-hook 'yas/minor-mode-auto-on) (dolist (hook yas/extra-mode-hooks) (add-hook hook 'yas/minor-mode-auto-on)) (add-hook 'yas/minor-mode-on-hook 'yas/ensure-minor-mode-priority) (when yas/use-menu (define-key-after (lookup-key global-map [menu-bar]) [yasnippet] (cons "YASnippet" yas/menu-keymap) 'buffer))) (defun yas/define-snippets (mode snippets &optional parent-mode) "Define snippets for MODE. SNIPPETS is a list of snippet definition, of the following form: (KEY TEMPLATE NAME CONDITION) or the NAME and CONDITION may be omitted. The optional 3rd parameter can be used to specify the parent mode of MODE. That is, when looking a snippet in MODE failed, it can refer to its parent mode. The PARENT-MODE may not need to be a real mode." (let ((snippet-table (yas/snippet-table mode)) (parent-table (if parent-mode (yas/snippet-table parent-mode) nil)) (keymap (if yas/use-menu (yas/menu-keymap-for-mode mode) nil))) (when parent-table (setf (yas/snippet-table-parent snippet-table) parent-table) (when yas/use-menu (define-key keymap (vector 'parent-mode) `(menu-item "parent mode" ,(yas/menu-keymap-for-mode parent-mode))))) (when (and yas/use-menu (yas/real-mode? mode)) (define-key yas/menu-keymap (vector mode) `(menu-item ,(symbol-name mode) ,keymap))) (dolist (snippet snippets) (let* ((full-key (car snippet)) (key (file-name-sans-extension full-key)) (name (or (caddr snippet) (file-name-extension full-key))) (condition (nth 3 snippet)) (template (yas/make-template (cadr snippet) (or name key) condition))) (yas/snippet-table-store snippet-table full-key key template) (when yas/use-menu (define-key keymap (vector (make-symbol full-key)) `(menu-item ,(yas/template-name template) ,(yas/make-menu-binding (yas/template-content template)) :keys ,(concat key yas/trigger-symbol)))))))) (defun yas/set-mode-parent (mode parent) "Set parent mode of MODE to PARENT." (setf (yas/snippet-table-parent (yas/snippet-table mode)) (yas/snippet-table parent)) (when yas/use-menu (define-key (yas/menu-keymap-for-mode mode) (vector 'parent-mode) `(menu-item "parent mode" ,(yas/menu-keymap-for-mode parent))))) (defun yas/define (mode key template &optional name condition) "Define a snippet. Expanding KEY into TEMPLATE. NAME is a description to this template. Also update the menu if `yas/use-menu' is `t'. CONDITION is the condition attached to this snippet. If you attach a condition to a snippet, then it will only be expanded when the condition evaluated to non-nil." (yas/define-snippets mode (list (list key template name condition)))) (defun yas/hippie-try-expand (first-time?) "Integrate with hippie expand. Just put this function in `hippie-expand-try-functions-list'." (if (not first-time?) (let ((yas/fallback-behavior 'return-nil)) (yas/expand)) (when (and (null (car buffer-undo-list)) (eq 'apply (car (cadr buffer-undo-list))) (eq 'yas/undo-expand-snippet (cadr (cadr buffer-undo-list)))) (undo 1)) nil)) (defun yas/expand () "Expand a snippet." (interactive) (let ((local-condition (yas/template-condition-predicate yas/buffer-local-condition))) (if local-condition (let ((yas/require-template-condition (if (and (consp local-condition) (eq 'require-snippet-condition (car local-condition)) (symbolp (cdr local-condition))) (cdr local-condition) nil))) (multiple-value-bind (templates start end) (yas/current-key) (if templates (let ((template (if (null (cdr templates)) ; only 1 template (yas/template-content (cdar templates)) (yas/popup-for-template templates)))) (if template (progn (yas/expand-snippet start end template) 'expanded) ; expanded successfully 'interrupted)) ; interrupted by user (if (eq yas/fallback-behavior 'return-nil) nil ; return nil (let* ((yas/minor-mode nil) (command (key-binding yas/trigger-key))) (when (commandp command) (call-interactively command)))))))))) (defun yas/field-probably-deleted-p (field) "Guess if FIELD was deleted because of his parent-field" (and (zerop (- (yas/field-start field) (yas/field-end field))) (yas/field-parent-field field))) (defun yas/next-field (&optional arg) "Navigate to next field. If there's none, exit the snippet." (interactive) (let* ((arg (or arg 1)) (snippet (yas/snippet-of-current-keymap)) (number (and snippet (+ arg (yas/field-number (yas/snippet-active-field snippet))))) (live-fields (remove-if #'yas/field-probably-deleted-p (yas/snippet-fields snippet))) (target-field (yas/snippet-find-field snippet number))) (cond ((and number (> number (length live-fields))) (yas/exit-snippet snippet)) (target-field (yas/move-to-field snippet target-field)) (t nil)))) (defun yas/move-to-field (snippet field) "Update SNIPPET to move to field FIELD." (goto-char (overlay-end (car (yas/field-overlay-pair field)))) (setf (yas/snippet-active-field snippet) field) (let ((overlay (yas/snippet-active-field-overlay snippet))) (if overlay (move-overlay overlay (overlay-end (car (yas/field-overlay-pair field))) (overlay-start (cdr (yas/field-overlay-pair field)))) (setf (yas/snippet-active-field-overlay snippet) (make-overlay (overlay-end (car (yas/field-overlay-pair field))) (overlay-start (cdr (yas/field-overlay-pair field))))) (setq overlay (yas/snippet-active-field-overlay snippet)) (overlay-put overlay 'face 'yas/field-highlight-face) (overlay-put overlay 'modification-hooks '(yas/on-field-overlay-modification)) (overlay-put overlay 'insert-in-front-hooks '(yas/on-field-overlay-modification)) (overlay-put overlay 'insert-behind-hooks '(yas/on-field-overlay-modification))) (overlay-put overlay 'yas/field field))) (defun yas/prev-field () "Navigate to prev field. If there's none, exit the snippet." (interactive) (yas/next-field -1)) (defun yas/exit-snippet (snippet) "Goto exit-marker of SNIPPET and commit the snippet. Cleaning up the snippet does not delete it!" (interactive) (let ((exit-marker (set-marker (make-marker) (if (markerp (yas/snippet-exit snippet)) (yas/snippet-exit snippet) (overlay-start (yas/snippet-exit snippet)))))) (yas/commit-snippet snippet) (goto-char exit-marker) (set-marker exit-marker nil))) ;; Snippet register and unregister routines. ;; (defvar yas/registered-snippets nil "A hash table holding all active snippets") (eval-when-compile (make-variable-buffer-local 'yas/registered-snippets)) (defun yas/register-snippet (snippet) "Register SNIPPET in the `yas/registered-snippets' table. Add a `yas/pre-command-handler' function to the buffer-local `pre-command-hook' and `yas/post-command-handler' to the `post-command-hook'. This should exist while registered snippets exists in the current buffer. Return snippet" (unless yas/registered-snippets (setq yas/registered-snippets (make-hash-table :test 'eq))) ;; ;; register the snippet ;; (puthash (yas/snippet-id snippet) snippet yas/registered-snippets) ;; ;; setup the `pre-command-hook' and `post-command-hook' ;; (add-hook 'pre-command-hook 'yas/pre-command-handler) (add-hook 'post-command-hook 'yas/post-command-handler) snippet) (defun yas/unregister-snippet (snippet) "Unregister snippet from the `yas/registered-snippets' table. Remove the handlers registered in `yas/register-snippet' if no more snippets registered in the current buffer." ;; ;; ;; (remhash (yas/snippet-id snippet) yas/registered-snippets) ;; ;; ;; (when (eq 0 (hash-table-count yas/registered-snippets)) (remove-hook 'pre-command-hook 'yas/pre-command-handler) (remove-hook 'post-command-hook 'yas/post-command-handler))) (defun yas/exterminate-snippets () "Remove all locally registered snippets and remove `yas/check-cleanup-snippet' from the `post-command-hook'" (interactive) (when yas/registered-snippets (maphash #'(lambda (key value) (yas/commit-snippet value)) yas/registered-snippets))) (defun yas/delete-overlay-region (overlay) (delete-region (overlay-start overlay) (overlay-end overlay))) (defun yas/commit-snippet (snippet) "Commit SNIPPET, but leave point as it is. This renders the snippet as ordinary text" (let* ((control-overlay (yas/snippet-control-overlay snippet)) (active-field-overlay (yas/snippet-active-field-overlay snippet)) yas/snippet-beg yas/snippet-end) ;; ;; Save the end of the moribund snippet in case we need to undo ;; its original expansion. This is used by `yas/undo-expand-snippet' ;; (when (and control-overlay (overlay-buffer control-overlay)) (setq yas/snippet-beg (overlay-start control-overlay)) (setq yas/snippet-end (overlay-end control-overlay)) (delete-overlay control-overlay)) (when active-field-overlay (delete-overlay active-field-overlay)) ;; Delete all the text under the overlays ;; (dolist (field (yas/snippet-fields snippet)) (dolist (mirror (yas/field-mirrors field)) (goto-char (overlay-start (yas/mirror-overlay mirror))) (yas/delete-overlay-region (yas/mirror-overlay mirror)) (insert (yas/apply-transform mirror field))) (yas/delete-overlay-region (car (yas/field-overlay-pair field))) (yas/delete-overlay-region (cdr (yas/field-overlay-pair field)))) (if (overlayp (yas/snippet-exit snippet)) (yas/delete-overlay-region (yas/snippet-exit snippet)) (set-marker (yas/snippet-exit snippet) nil)) ;; TODO: Maybe action for snippet revival ;; ;; ;; XXX: `yas/after-exit-snippet-hook' should be run with ;; `yas/snippet-beg' and `yas/snippet-end' bound. That might not ;; be the case if the main overlay had somehow already ;; disappeared, which sometimes happens when the snippet's messed ;; up... ;; (run-hooks 'yas/after-exit-snippet-hook)) (yas/unregister-snippet snippet)) (defun yas/check-commit-snippet () "Checks if point exited the currently active field of the snippet, if so cleans up the whole snippet up. This function is part of `post-command-hook' while registered snippets last." (let* ((snippet (yas/snippet-of-current-keymap)) (field (and snippet (yas/snippet-active-field snippet)))) (cond (;; ;; No snippet at point, cleanup *all* snippets ;; (null snippet) ;; (yas/cleanup-all-snippets) ) (;; A snippet exits at point, but point left the currently ;; active field overlay (or (not field) (and field (not (yas/point-in-field-p (yas/field-primary-field field))))) (yas/cleanup-snippet snippet)) (;; ;; Snippet at point, and point inside a snippet field, ;; everything is normal ;; t nil)))) (defun yas/point-in-field-p (field &optional point) "..." (let ((point (or point (point)))) (and (>= point (yas/field-start field)) (<= point (yas/field-end field))))) ;; ;; Pre and post command handlers ;; (defun yas/pre-command-handler () ) (defun yas/post-command-handler () ) ;; Debug functions. Use (or change) at will whenever needed. (defun yas/debug-some-vars () (interactive) (with-output-to-temp-buffer "*YASnippet trace*" (princ "Interesting YASnippet vars: \n\n") (princ (format "Register hash-table: %s\n\n" yas/registered-snippets)) (cond ((not yas/registered-snippets) (princ " No snippet hash table!")) ((eq (hash-table-count yas/registered-snippets) 0) (princ " No registered snippets\n")) (t (maphash #'(lambda (key snippet) (princ (format "\t key %s for snippet %s\n" key (yas/snippet-id snippet))) (princ (format "\t Control overlay %s\n" (yas/snippet-control-overlay snippet))) (dolist (field (yas/snippet-fields snippet)) (princ (format "\t field %s with %s mirrors is %s and %s" (yas/field-number field) (length (yas/field-mirrors field)) (if (yas/field-probably-deleted-p field) "DELETED" "alive") (if (eq field (yas/snippet-active-field snippet)) "ACTIVE!\n" "NOT ACTIVE!\n"))) (princ (format "\t\t Covering: %s\n" (yas/current-field-text field))) (princ (format "\t\t Displays: %s\n" (yas/field-text-for-display field))) ;; (dolist (mirror (yas/field-mirrors field)) ;; (princ (format "\t\t Mirror displays: \n" ;; (if (eq field (yas/field-primary-field field)) ;; "Primary" "Mirror")))) )) yas/registered-snippets))) (princ (format "\nPost command hook: %s\n" post-command-hook)) (princ (format "\nPre command hook: %s\n" pre-command-hook)) (princ (format "\nUndo is %s and point-max is %s.\n" (if (eq buffer-undo-list t) "DISABLED" "ENABLED") (point-max))) (unless (eq buffer-undo-list t) (princ (format "Undolist has %s elements. First 10 elements follow:\n" (length buffer-undo-list))) (let ((first-ten (subseq buffer-undo-list 0 19))) (dolist (undo-elem first-ten) (princ (format "%2s: %s\n" (position undo-elem first-ten) (truncate-string-to-width (format "%s" undo-elem) 70)))))))) (defun yas/exterminate-package () (interactive) (yas/minor-mode -1) (mapatoms #'(lambda (atom) (when (string-match "yas/" (symbol-name atom)) (unintern atom))))) (defun yas/debug-test (&optional verbose) (interactive "P") (yas/load-directory "~/Source/yasnippet/snippets/") ;;(kill-buffer (get-buffer "*YAS TEST*")) (set-buffer (switch-to-buffer "*YAS TEST*")) (yas/exterminate-snippets) (erase-buffer) (setq buffer-undo-list nil) (insert "dov") (html-mode) (when verbose (add-hook (make-local-variable 'post-command-hook) 'yas/debug-some-vars)) (yas/expand)) (provide 'yasnippet) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; Monkey patching for other functions that's causing ;; problems to yasnippet. For details on why I patch ;; those functions, refer to ;; http://code.google.com/p/yasnippet/wiki/MonkeyPatching ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defadvice c-neutralize-syntax-in-CPP (around yas-mp/c-neutralize-syntax-in-CPP activate) "Adviced `c-neutralize-syntax-in-CPP' to properly handle the end-of-buffer error fired in it by calling `forward-char' at the end of buffer." (condition-case err ad-do-it (error (message (error-message-string err)))))