ld/yasnippet
1
0
Fork 0
mirror of https://github.com/joaotavora/yasnippet.git synced 2025-10-13 13:13:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

* More adjustments in issue 84, fix issue 78, and faq update for issue 71

Browse Source
This commit is contained in:
capitaomorte 2009-08-28 14:49:44 +00:00
parent 364a3c8378
commit 560fd2acf7
6 changed files with 116 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/faq.html
View File

@ -5,8 +5,6 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
<title>Frequently Asked Questions</title>
<meta name="author" content="pluskid" />
<meta name="date" content="2008-03-20" />
<link rel="stylesheet" href="styles.css" type="text/css" />
</head>
<body>
@ -68,10 +66,10 @@ newline for you automatically.</p>
</div>
<div class="section" id="why-tab-key-doesn-t-expand-a-snippet">
<h1>Why TAB key doesn't expand a snippet?</h1>
<p>First check the mode line to see if there's <tt class="docutils literal"><span class="pre">yas</span></tt>. If no, then try
<tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/minor-mode-on</span></tt> to manually turn on <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt> and
try to expand the snippet again. If it works, then, you can add the
following code to your <tt class="docutils literal"><span class="pre">.emacs</span></tt> <em>before</em> loading YASnippet:</p>
<p>First check the mode line to see if there's <tt class="docutils literal"><span class="pre">yas</span></tt>. If not, then try
<tt class="docutils literal"><span class="pre">M-x</span> <span class="pre">yas/minor-mode</span></tt> to manually turn on the minor mode and try to
expand the snippet again. If it works, then, you can add the following
code to your <tt class="docutils literal"><span class="pre">.emacs</span></tt> <em>before</em> loading YASnippet:</p>
<div class="highlight"><pre>(add-hook &#39;the-major-mode-hook &#39;yas/minor-mode-on)
</pre></div>
<p>where <tt class="docutils literal"><span class="pre">the-major-mode</span></tt> is the major mode in which <tt class="docutils literal"><span class="pre">yas/minor-mode</span></tt>
@ -89,16 +87,32 @@ latter has priority. If you see <tt class="docutils literal"><span class="pre">&
than <tt class="docutils literal"><span class="pre">yas/expand</span></tt>, (e.g. in <tt class="docutils literal"><span class="pre">org-mode</span></tt>) you can try the following
code to work around:</p>
<div class="highlight"><pre>(add-hook &#39;org-mode-hook
&#39;(lambda ()
(make-variable-buffer-local &#39;yas/trigger-key)
(setq yas/trigger-key [tab])))
#&#39;(lambda ()
(local-set-key [tab] &#39;yas/expand)))
</pre></div>
<p>replace <tt class="docutils literal"><span class="pre">org-mode-hook</span></tt> with the major mode hook you are dealing
with (<tt class="docutils literal"><span class="pre">C-h</span> <span class="pre">m</span></tt> to see what major mode you are in).</p>
<p>If it says <tt class="docutils literal"><span class="pre">TAB</span></tt> but YASnippet still doesn't work, check your
configuration and you may also ask for help on the <a class="reference external" href="http://groups.google.com/group/smart-snippet">discussion group</a>. Don't forget to
attach the information on what command is bound to TAB as well as the
mode information (Can be obtained by <tt class="docutils literal"><span class="pre">C-h</span> <span class="pre">m</span></tt>).</p>
<p>If this doesn't work, you can also try</p>
<div class="highlight"><pre>(defun yas/advise-indent-function (function-symbol)
(eval `(defadvice ,function-symbol (around yas/try-expand-first activate)
,(format
&quot;Try to expand a snippet before point, then call `%s&#39; as usual&quot;
function-symbol)
(let ((yas/fallback-behavior nil))
(unless (and (interactive-p)
(yas/expand))
ad-do-it)))))
(yas/advise-indent-function &#39;ruby-indent-line)
</pre></div>
<p>To <em>advise</em> the modes indentation function bound to TAB, (in this case
<tt class="docutils literal"><span class="pre">ruby-indent-line</span></tt>) to first try to run <tt class="docutils literal"><span class="pre">yas/expand</span></tt>.</p>
<p>If The output of <tt class="docutils literal"><span class="pre">C-h</span> <span class="pre">k</span> <span class="pre">RET</span> <span class="pre">&lt;tab&gt;</span></tt> tells you that <tt class="docutils literal"><span class="pre">&lt;tab&gt;</span></tt> is
indeed bound to <tt class="docutils literal"><span class="pre">yas/expand</span></tt> but YASnippet still doesn't work, check
your configuration and you may also ask for help on the <a class="reference external" href="http://groups.google.com/group/smart-snippet">discussion
group</a>.</p>
<p>Don't forget to attach the information on what command is bound to TAB
as well as the mode information (Can be obtained by <tt class="docutils literal"><span class="pre">C-h</span> <span class="pre">m</span></tt>).</p>
</div>
<div class="section" id="how-to-define-snippets-with-named-by-characters-not-supported-by-the-filesystem">
<h1>How to define snippets with named by characters not supported by the filesystem?</h1>

48
doc/faq.rst
View File

@ -2,10 +2,6 @@
Frequently Asked Questions
==========================
:Author: pluskid
:Contact: pluskid@gmail.com
:Date: 2008-03-20
Why there's an extra newline?
=============================
@ -21,10 +17,10 @@ newline for you automatically.
Why TAB key doesn't expand a snippet?
=====================================
First check the mode line to see if there's ``yas``. If no, then try
``M-x yas/minor-mode-on`` to manually turn on ``yas/minor-mode`` and
try to expand the snippet again. If it works, then, you can add the
following code to your ``.emacs`` *before* loading YASnippet:
First check the mode line to see if there's ``yas``. If not, then try
``M-x yas/minor-mode`` to manually turn on the minor mode and try to
expand the snippet again. If it works, then, you can add the following
code to your ``.emacs`` *before* loading YASnippet:
.. sourcecode:: lisp
@ -51,18 +47,38 @@ code to work around:
.. sourcecode:: lisp
(add-hook 'org-mode-hook
'(lambda ()
(make-variable-buffer-local 'yas/trigger-key)
(setq yas/trigger-key [tab])))
#'(lambda ()
(local-set-key [tab] 'yas/expand)))
replace ``org-mode-hook`` with the major mode hook you are dealing
with (``C-h m`` to see what major mode you are in).
If it says ``TAB`` but YASnippet still doesn't work, check your
configuration and you may also ask for help on the `discussion group
<http://groups.google.com/group/smart-snippet>`_. Don't forget to
attach the information on what command is bound to TAB as well as the
mode information (Can be obtained by ``C-h m``).
If this doesn't work, you can also try
.. sourcecode:: lisp
(defun yas/advise-indent-function (function-symbol)
(eval `(defadvice ,function-symbol (around yas/try-expand-first activate)
,(format
"Try to expand a snippet before point, then call `%s' as usual"
function-symbol)
(let ((yas/fallback-behavior nil))
(unless (and (interactive-p)
(yas/expand))
ad-do-it)))))
(yas/advise-indent-function 'ruby-indent-line)
To *advise* the modes indentation function bound to TAB, (in this case
``ruby-indent-line``) to first try to run ``yas/expand``.
If The output of ``C-h k RET <tab>`` tells you that ``<tab>`` is
indeed bound to ``yas/expand`` but YASnippet still doesn't work, check
your configuration and you may also ask for help on the `discussion
group <http://groups.google.com/group/smart-snippet>`_.
Don't forget to attach the information on what command is bound to TAB
as well as the mode information (Can be obtained by ``C-h m``).
How to define snippets with named by characters not supported by the filesystem?
================================================================================

2
snippets/text-mode/css-mode/disp.block
View File

@ -1,4 +1,4 @@
#contributor : rejeep <johan.rejeep@gmail.com>
#name : display: block
# --
dislpay: block;
display: block;

2
snippets/text-mode/css-mode/disp.inline
View File

@ -1,4 +1,4 @@
#contributor : rejeep <johan.rejeep@gmail.com>
#name : display: inline
# --
dislpay: inline;
display: inline;

2
snippets/text-mode/css-mode/disp.none
View File

@ -1,4 +1,4 @@
#contributor : rejeep <johan.rejeep@gmail.com>
#name : display: none
# --
dislpay: none;
display: none;

78
yasnippet.el
View File

@ -164,22 +164,22 @@ bulk reloading of all snippets using `yas/reload-all'"
These functions are called with the following arguments:
* PROMPT: A string to prompt the user
- PROMPT: A string to prompt the user
* CHOICES: a list of strings or objects.
- CHOICES: a list of strings or objects.
* optional DISPLAY-FN : A function that, when applied to each of
- optional DISPLAY-FN : A function that, when applied to each of
the objects in CHOICES will return a string.
The return value of any function you put here should be one of
the objects in CHOICES, properly formatted with DISPLAY-FN (if
that is passed).
* To signal that your particular style of prompting is
- To signal that your particular style of prompting is
unavailable at the moment, you can also have the function return
nil.
* To signal that the user quit the prompting process, you can
- To signal that the user quit the prompting process, you can
signal `quit' with
(signal 'quit \"user quit!\")."
@ -191,9 +191,9 @@ signal `quit' with
The following values are possible:
`fixed' Indent the snippet to the current column;
- `fixed' Indent the snippet to the current column;
`auto' Indent each line of the snippet with `indent-according-to-mode'
- `auto' Indent each line of the snippet with `indent-according-to-mode'
Every other value means don't apply any snippet-side indendation
after expansion (the manual per-line \"$>\" indentation still
@ -260,14 +260,15 @@ field"
(defcustom yas/fallback-behavior 'call-other-command
"How to act when `yas/trigger-key' does *not* expand a snippet.
`call-other-command' means try to temporarily disable YASnippet
- `call-other-command' means try to temporarily disable YASnippet
and call the next command bound to `yas/trigger-key'.
`return-nil' means return do nothing.
- nil or the symbol `return-nil' mean do nothing. (and
`yas/expand-returns' nil)
An entry (apply COMMAND . ARGS) means interactively call COMMAND,
if ARGS is non-nil, call COMMAND non-interactively with ARGS as
arguments."
- An entry (apply COMMAND . ARGS) means interactively call
COMMAND, if ARGS is non-nil, call COMMAND non-interactively
with ARGS as arguments."
:type '(choice (const :tag "Call previous command" 'call-other-command)
(const :tag "Do nothing" 'return-nil))
:group 'yasnippet)
@ -297,10 +298,10 @@ This affects `yas/insert-snippet', `yas/visit-snippet-file'"
When non-nil, submenus for each snippet table will be listed
under the menu \"Yasnippet\".
If set to `real-modes' only submenus whose name more or less
- If set to `real-modes' only submenus whose name more or less
corresponds to a major mode are listed.
If set to `abbreviate', only the current major-mode
- If set to `abbreviate', only the current major-mode
menu and the modes set in `yas/mode-symbol' are listed.
Any other non-nil value, every submenu is listed."
@ -634,10 +635,9 @@ Here's an example:
:help "Display some information about YASsnippet"]))
;; Now for the stuff that has direct keybindings
;;
(define-key yas/minor-mode-map (when yas/trigger-key
(read-kbd-macro
yas/trigger-key))
'yas/expand)
(when (and yas/trigger-key
(stringp yas/trigger-key))
(define-key yas/minor-mode-map (read-kbd-macro yas/trigger-key) 'yas/expand))
(define-key yas/minor-mode-map "\C-c&\C-s" 'yas/insert-snippet)
(define-key yas/minor-mode-map "\C-c&\C-n" 'yas/new-snippet)
(define-key yas/minor-mode-map "\C-c&\C-v" 'yas/visit-snippet-file)
@ -669,7 +669,8 @@ Key bindings:
;; if a `yas/minor-mode-map' is already built. Else, call
;; `yas/init-minor-keymap' to build it
(if (and (cdr yas/minor-mode-map)
yas/trigger-key)
yas/trigger-key
(stringp yas/trigger-key))
(define-key yas/minor-mode-map (read-kbd-macro yas/trigger-key) 'yas/expand)
(yas/init-minor-keymap))))
@ -1772,7 +1773,11 @@ defined in `yas/fallback-behavior'"
nil)
((eq yas/fallback-behavior 'call-other-command)
(let* ((yas/minor-mode nil)
(command (key-binding (read-kbd-macro yas/trigger-key))))
(keys (or (this-command-keys-vector)
(and yas/trigger-key
(stringp yas/trigger-key)
(read-kbd-macro yas/trigger-key))))
(command (key-binding keys)))
(when (commandp command)
(setq this-command command)
(call-interactively command))))
@ -1883,21 +1888,36 @@ lurking."
(let ((main-dir (or (and (listp yas/root-directory)
(first yas/root-directory))
yas/root-directory
"~/.emacs.d/snippets")))
(setq yas/root-directory "~/.emacs.d/snippets")))
(tables (yas/get-snippet-tables)))
;; HACK! the snippet table created here is a dummy table that
;; holds the correct name so that `yas/make-directory-maybe' can
;; work. The real table, if it does not exist in
;; yas/snippet-tables will be created when the first snippet for
;; that mode is loaded.
;;
(unless (gethash major-mode yas/snippet-tables)
(setq tables (cons (yas/make-snippet-table (symbol-name major-mode))
tables)))
(mapcar #'(lambda (table)
(cons table
(mapcar #'(lambda (subdir)
(concat main-dir "/" subdir))
(yas/guess-snippet-directories-1 table))))
(yas/get-snippet-tables))))
tables)))
(defun yas/make-directory-maybe (table-and-dirs &optional main-table-p)
(defun yas/make-directory-maybe (table-and-dirs &optional main-table-string)
"Returns a dir inside TABLE-AND-DIRS, prompts for creation if none exists."
(or (some #'(lambda (dir) (when (file-directory-p dir) dir)) (cdr table-and-dirs))
(let ((candidate (first (cdr table-and-dirs))))
(if (y-or-n-p (format "Guessed directory (%s) for %s table \"%s\" does not exist! Create? "
(if (y-or-n-p (format "Guessed directory (%s) for%s%s table \"%s\" does not exist! Create? "
candidate
(or main-table-p
(if (gethash (intern (yas/snippet-table-name (car table-and-dirs)))
yas/snippet-tables)
""
" brand new")
(or main-table-string
"")
(yas/snippet-table-name (car table-and-dirs))))
(progn
@ -1918,7 +1938,8 @@ lurking."
yas/prompt-functions))
(first guessed-directories)))
(chosen))
(setq chosen (yas/make-directory-maybe option))
(setq chosen (yas/make-directory-maybe option (unless choose-instead-of-guess
" main")))
(unless (or chosen
choose-instead-of-guess)
(if (y-or-n-p (format "Continue guessing for other active tables %s? "
@ -1939,6 +1960,8 @@ lurking."
(find-file-other-window (concat name
".yasnippet"))
(snippet-mode)
(unless (and choose-instead-of-guess
(not (y-or-n-p "Insert a snippet with useful headers? ")))
(yas/expand-snippet (format
"\
# -*- mode: snippet -*-
@ -1947,7 +1970,8 @@ lurking."
# binding: \"${3:keybinding}\"}${4:
# expand-env: ((${5:some-var} ${6:some-value}))}
# --
$0" name))))))
$0" name))))
(message "[yas] aborted snippet creation."))))
(defun yas/find-snippets (&optional same-window )
"Look for user snippets in guessed current mode's directory.