mirror of
https://github.com/joaotavora/yasnippet.git
synced 2025-10-13 21:13:04 +00:00
Compare commits
No commits in common. "master" and "0.12.0" have entirely different histories.
4
.gitignore
vendored
4
.gitignore
vendored
@ -9,7 +9,3 @@ extras/imported/**
|
||||
*.elc
|
||||
ert-x.*
|
||||
ert.*
|
||||
|
||||
# ELPA-generated files
|
||||
/yasnippet-autoloads.el
|
||||
/yasnippet-pkg.el
|
||||
|
||||
7
.gitmodules
vendored
7
.gitmodules
vendored
@ -0,0 +1,7 @@
|
||||
[submodule "snippets"]
|
||||
path = snippets
|
||||
url = https://github.com/AndreaCrotti/yasnippet-snippets.git
|
||||
branch = master
|
||||
[submodule "yasmate"]
|
||||
path = yasmate
|
||||
url = https://github.com/capitaomorte/yasmate.git
|
||||
24
.travis.yml
24
.travis.yml
@ -1,25 +1,13 @@
|
||||
language: generic
|
||||
os: linux
|
||||
dist: xenial
|
||||
|
||||
sudo: false
|
||||
git:
|
||||
submodules: false
|
||||
|
||||
env:
|
||||
global:
|
||||
- Wlexical=t
|
||||
- Werror=t
|
||||
- tests_Werror=t # For yasnippet-tests.el
|
||||
jobs:
|
||||
- EMACS_VERSION=23.4
|
||||
# 24.3 gives a bunch of 'value returned from (car value-N) is
|
||||
# unused' warnings.
|
||||
- EMACS_VERSION=24.3 tests_Werror=nil
|
||||
- EMACS_VERSION=24.3
|
||||
- EMACS_VERSION=24.5
|
||||
- EMACS_VERSION=25.3
|
||||
- EMACS_VERSION=26.3
|
||||
- EMACS_VERSION=27-prerelease
|
||||
|
||||
- EMACS_VERSION=25.2
|
||||
|
||||
install:
|
||||
- curl -LO https://github.com/npostavs/emacs-travis/releases/download/bins/emacs-bin-${EMACS_VERSION}.tar.gz
|
||||
@ -27,7 +15,7 @@ install:
|
||||
# Configure $PATH: Emacs installed to /tmp/emacs
|
||||
- export PATH=/tmp/emacs/bin:${PATH}
|
||||
- if ! emacs -Q --batch --eval "(require 'cl-lib)" ; then
|
||||
curl -Lo cl-lib.el http://elpa.gnu.org/packages/cl-lib-0.6.1.el ;
|
||||
curl -Lo cl-lib.el http://elpa.gnu.org/packages/cl-lib-0.5.el ;
|
||||
export warnings="'(not cl-functions)" ;
|
||||
fi
|
||||
- if ! emacs -Q --batch --eval "(require 'ert)" ; then
|
||||
@ -37,9 +25,7 @@ install:
|
||||
- emacs --version
|
||||
|
||||
script:
|
||||
- rake yasnippet.elc
|
||||
- rake yasnippet-debug.elc
|
||||
- rake yasnippet-tests.elc Werror=$tests_Werror
|
||||
- rake compile
|
||||
- rake tests
|
||||
|
||||
notifications:
|
||||
|
||||
46
Makefile
46
Makefile
@ -1,46 +0,0 @@
|
||||
### Makefile for Yasnippet (stolen from Eglot)
|
||||
# Variables
|
||||
#
|
||||
EMACS?=emacs
|
||||
SELECTOR?=t
|
||||
ERROR_ON_WARN=nil
|
||||
|
||||
LOAD_PATH=-L .
|
||||
|
||||
ELFILES := yasnippet.el yasnippet-tests.el
|
||||
ELCFILES := $(ELFILES:.el=.elc)
|
||||
|
||||
BYTECOMP_ERROR_ON_WARN := \
|
||||
--eval '(setq byte-compile-error-on-warn $(ERROR_ON_WARN))'
|
||||
|
||||
all: compile
|
||||
|
||||
%.elc: %.el
|
||||
$(EMACS) -Q $(BYTECOMP_ERROR_ON_WARN) $(LOAD_PATH) \
|
||||
--batch -f batch-byte-compile $<
|
||||
|
||||
compile: $(ELCFILES)
|
||||
|
||||
# Automated tests
|
||||
#
|
||||
yasnippet-check: compile
|
||||
$(EMACS) -Q --batch \
|
||||
$(LOAD_PATH) \
|
||||
-l yasnippet \
|
||||
-l yasnippet-tests \
|
||||
--eval '(setq ert-batch-backtrace-right-margin 200)' \
|
||||
--eval '(ert-run-tests-batch-and-exit (quote $(SELECTOR)))'
|
||||
|
||||
interactive: compile
|
||||
$(EMACS) -Q \
|
||||
$(LOAD_PATH) \
|
||||
-l yasnippet \
|
||||
-l yasnippet-tests \
|
||||
|
||||
check: yasnippet-check
|
||||
|
||||
# Cleanup
|
||||
#
|
||||
clean:
|
||||
find . -iname '*.elc' -exec rm {} \;
|
||||
.PHONY: all compile clean check
|
||||
175
NEWS
175
NEWS
@ -1,182 +1,11 @@
|
||||
Yasnippet NEWS -- history of user-visible changes.
|
||||
|
||||
Copyright (C) 2017-2025 Free Software Foundation, Inc.
|
||||
Copyright (C) 2016 Free Software Foundation, Inc.
|
||||
See the end of the file for license conditions.
|
||||
|
||||
Changes since 0.14.0:
|
||||
|
||||
- Silence warning about missing lexical-binding cookie.
|
||||
- Bug fixes and code cleanups.
|
||||
- Accept ${N} as another syntax for $N (issue #1012).
|
||||
- Understand the new AUCTeX modes hierarchy (issue #1193).
|
||||
- Try and use `major-mode-remap-alist` to find the right snippets for
|
||||
Tree Sitter modes (issue #1169).
|
||||
Don't delete snippets more than once.
|
||||
|
||||
* 0.14.0 (Dec 22, 2019)
|
||||
|
||||
** Changes
|
||||
|
||||
*** New 'yas-auto-next' macro, automatically moves to next field.
|
||||
See Github #937.
|
||||
|
||||
*** Yasnippet now officially requires Emacs 23 or greater.
|
||||
See Github #940.
|
||||
|
||||
*** Snippets for 'fundamental-mode' are available in all modes.
|
||||
See Github #949, and #936.
|
||||
|
||||
*** New function for snippets, 'yas-completing-read'.
|
||||
See Github #934.
|
||||
|
||||
*** New function 'yas-maybe-expand-abbrev-key-filter'.
|
||||
This can be used for making conditional keybindings for snippets.
|
||||
Promoted from 'yas--maybe-expand-key-filter'. See Github #943.
|
||||
|
||||
*** DEL can now be used to clear fields, similar <delete>.
|
||||
It is bound to the new conditional command 'yas-maybe-clear-field', which may
|
||||
be bound to other keys as well. See Github #960 and #957.
|
||||
|
||||
*** Snippet field movement commands may now trigger eldoc.
|
||||
See Github #952.
|
||||
|
||||
*** New variable 'yas-keymap-disable-hook'.
|
||||
Can be used (e.g., for company-mode) to temporarily disable
|
||||
'yas-keymap' bindings, or any binding made by the new function
|
||||
'yas-filtered-definition'. See Github #987.
|
||||
|
||||
*** New variable 'yas-inhibit-overlay-modification-protection'.
|
||||
This allows a snippet to remain active, even if some commands make
|
||||
modifications outside the expected area (i.e., the active snippet
|
||||
field).
|
||||
|
||||
*** 'yas-minor-mode' is no longer enabled in temp buffers.
|
||||
That is, buffers whose name starts with a space. This setting may be
|
||||
undone by removing 'yas-temp-buffer-p' from
|
||||
'yas-dont-activate-functions'. See Github #985.
|
||||
|
||||
*** Accept unescaped '{', for LSP compatibility.
|
||||
See Github #979.
|
||||
|
||||
** Fixed bugs
|
||||
|
||||
*** 'yas-not-string-or-comment-condition' no longer relies on 'this-command'.
|
||||
This lets it work correctly with conditional key-bindings. See Github
|
||||
#973, #991.
|
||||
|
||||
*** Fix snippet expansion in org src buffers.
|
||||
Note that this still doesn't work in text-mode blocks.
|
||||
See Github #976, #989.
|
||||
|
||||
*** Fix snippet insertion for keyless snippets.
|
||||
See Github #1014.
|
||||
|
||||
*** Fix errors with company-mode completion within snippet fields.
|
||||
See Github #995.
|
||||
|
||||
*** Fix errors with cc-mode.
|
||||
See Github #962.
|
||||
|
||||
*** Fix problems with lsp-mode.
|
||||
**** Improve performance in overlay heavy buffers (Github #926).
|
||||
**** Fix double call of 'before/after-change-functions' (Github #966).
|
||||
|
||||
*** Fix errors with nested snippet expansion.
|
||||
See Github #961, #1002.
|
||||
|
||||
*** Stop yas-field-highlight-face inheriting from bogus 'quote' face.
|
||||
|
||||
|
||||
* 0.13.0 (May 13, 2018)
|
||||
|
||||
** Changes
|
||||
|
||||
*** Snippets for Yasnippet must now be installed separately. The
|
||||
submodule linking to yasnippet-snippets was removed, as were the
|
||||
"classic" snippets that came with the GNU ELPA package. The latter
|
||||
can now be installed via the 'yasnippet-classic-snippets' package from
|
||||
GNU ELPA.
|
||||
See Github #848, #858, #834, #775.
|
||||
|
||||
*** 'snippet-mode' no longer derives from 'text-mode'.
|
||||
It will derive from 'prog-mode' where available (Emacs 24.1 and newer)
|
||||
or 'fundamental-mode' otherwise. See Github #826.
|
||||
|
||||
*** The default value of 'yas-key-syntaxes' is changed
|
||||
Longer snippet abbrev keys are now preferred over shorter ones.
|
||||
See Github #805.
|
||||
|
||||
*** New snippets are now created for the current major mode by default
|
||||
Previously, extra activated modes could be guessed first.
|
||||
See Github #875.
|
||||
|
||||
*** Yasnippet supports 'unload-feature' via 'yasnippet-unload-function'
|
||||
See Github #753, #891.
|
||||
|
||||
*** New command 'yas-skip-and-clear-field' conditionally bound to 'C-d'
|
||||
replaces obsoleted 'yas-skip-and-clear-or-delete-char'. The new
|
||||
function may be bound to any key via the conditional binding value
|
||||
'yas-maybe-skip-and-clear-field', instead of hardcoding the
|
||||
'delete-char' fallback action. See Github #408, #892.
|
||||
|
||||
*** 'yas-lookup-snippet' now returns a struct
|
||||
This allows 'yas-expand-snippet' to take looked up snippet's
|
||||
environment into account. 'yas-expand-snippet' handles both
|
||||
structured snippets, and plain text snippet bodies.
|
||||
See Github #897.
|
||||
|
||||
** Fixed bugs
|
||||
|
||||
*** Avoid crashing due to Emacs Bug#30931
|
||||
This prevents yasnippet's routines from triggering the bug, although
|
||||
it is still possible to trigger it independently.
|
||||
|
||||
*** Don't enable undo when it's disabled
|
||||
|
||||
*** yas-also-auto-indent-first-line is once again respected
|
||||
Yasnippet was behaving as if it was always t for single line snippets.
|
||||
See Github #912.
|
||||
|
||||
*** Fixed handling of fixed indent with fields at beginning of line
|
||||
See Github #906, #908.
|
||||
|
||||
*** Fixed incorrect snippets leaving "bad memory"
|
||||
and possibly corrupting future expansions.
|
||||
See Github #800.
|
||||
|
||||
*** 'global-whitespace-mode' now functions in new snippet buffers.
|
||||
To fix this, the buffer name for new snippet buffers is now '+new
|
||||
snippet+' instead of '*new snippet*'. See Github #842.
|
||||
|
||||
*** Nest snippet expansion may clear default field text
|
||||
See Github #844.
|
||||
|
||||
*** Fixed undo list corruption snippet expand+indent.
|
||||
See Github #869.
|
||||
|
||||
*** The '# --' marker in snippets now allows trailing whitespace.
|
||||
See Github #862.
|
||||
|
||||
*** Fixed handling of nested simple $n fields
|
||||
See Github #824, #894.
|
||||
|
||||
|
||||
* 0.12.2 (Aug 28, 2017)
|
||||
|
||||
** The new option 'yas-also-auto-indent-empty-lines' allows restoring
|
||||
the old indent behavior. See Github #850, #710, #685, #679.
|
||||
|
||||
** Keybinding triggered snippets once again deactivate the mark.
|
||||
See Github #840.
|
||||
|
||||
|
||||
* 0.12.1 (Jul 23, 2017)
|
||||
|
||||
This is a quick bugfix release.
|
||||
|
||||
** Compilation errors in yasnippet-tests.el and yasnippet-debug.el are fixed.
|
||||
|
||||
** A snippet-local setting of 'yas-indent-line' is now respected
|
||||
during indentation triggered by auto-fill as well. See Github #838.
|
||||
|
||||
|
||||
* 0.12.0 (Jul 17, 2017)
|
||||
|
||||
63
README.mdown
63
README.mdown
@ -15,7 +15,7 @@ YASnippet. Watch [a demo on YouTube][youtube-demo].
|
||||
|
||||
# Installation
|
||||
|
||||
## Manual install from Git
|
||||
## Install the most recent version
|
||||
|
||||
Clone this repository somewhere
|
||||
|
||||
@ -33,16 +33,12 @@ Add your own snippets to `~/.emacs.d/snippets` by placing files there or invokin
|
||||
|
||||
## Install with `package-install`
|
||||
|
||||
In a recent emacs `M-x list-packages` is the recommended way to list
|
||||
and install packages.
|
||||
It's available from [GNU ELPA][gnuelpa].
|
||||
If you need a very recent snapshot, you can get it from
|
||||
[GNU-devel ELPA][gnudevel] as well as [MELPA][melpa]
|
||||
(see http://melpa.org/#installing).
|
||||
In a recent emacs `M-x list-packages` is the recommended way to list and install packages.
|
||||
[MELPA][melpa] keeps a very recent snapshot of YASnippet, see http://melpa.org/#installing.
|
||||
|
||||
## Install with el-get
|
||||
|
||||
El-get is another nice way to get the most recent version, too. See
|
||||
El-get is a nice way to get the most recent version, too. See
|
||||
https://github.com/dimitri/el-get for instructions.
|
||||
|
||||
## Use `yas-minor-mode` on a per-buffer basis
|
||||
@ -59,22 +55,33 @@ where you want YASnippet enabled.
|
||||
|
||||
<a name="import"></a>
|
||||
|
||||
YASnippet no longer bundles snippets directly, but it's very easy to
|
||||
Yasnippet no longer bundles snippets directly, but it's very easy to
|
||||
get some!
|
||||
|
||||
1. [yasnippet-snippets] - a snippet collection package maintained by
|
||||
If you git-cloned yasnippet with the `--recursive` option you'll also
|
||||
download "git submodules" and find two subdirs under the main tree.
|
||||
|
||||
1. `snippets/`
|
||||
|
||||
Points to [yasnippet-snippets] the snippet collection of
|
||||
[AndreaCrotti](https://github.com/AndreaCrotti).
|
||||
|
||||
It can be installed with `M-x package-install RET
|
||||
yasnippet-snippets` if you have added MELPA to your package
|
||||
sources.
|
||||
The default configuraiton already points to this dir, so to use
|
||||
them, just make sure the submodule really was downloaded
|
||||
(i.e. there are some files under `snippets/`)
|
||||
|
||||
2. [yasmate] a tool which is dedicated to converting textmate bundles
|
||||
into yasnippet snippets.
|
||||
2. `yasmate/`
|
||||
|
||||
Points to a github repo of the [yasmate] tool, which is dedicated
|
||||
to converting textmate bundles into yasnippet snippets.
|
||||
|
||||
To use these snippets you have to run the tool first, so
|
||||
[see its doc][yasmate]), and then point the `yas-snippet-dirs`
|
||||
variable to the `.../yasmate/snippets` subdir.
|
||||
|
||||
If you have a working ruby environment, you can probably get lucky
|
||||
directly with `rake convert-bundles`.
|
||||
|
||||
3. [textmate-to-yas.el]
|
||||
|
||||
This is another textmate bundle converting tool using Elisp
|
||||
@ -89,23 +96,18 @@ should be added like this to `yas-snippet-dirs`:
|
||||
'("~/.emacs.d/snippets" ;; personal snippets
|
||||
"/path/to/some/collection/" ;; foo-mode and bar-mode snippet collection
|
||||
"/path/to/yasnippet/yasmate/snippets" ;; the yasmate collection
|
||||
"/path/to/yasnippet/snippets" ;; the default collection
|
||||
))
|
||||
|
||||
(yas-global-mode 1) ;; or M-x yas-reload-all if you've started YASnippet already.
|
||||
|
||||
# Manual, issues etc
|
||||
|
||||
There's comprehensive [documentation][docs] on using and customising
|
||||
YASnippet.
|
||||
|
||||
There's a [list of support issues][support-issues], with solutions to
|
||||
common problems and practical snippet examples.
|
||||
|
||||
The [Github issue tracker][issues] is where most YASnippet-related
|
||||
discussion happens. Nevertheless, since YASnippet is a part of Emacs,
|
||||
you may alternatively report bugs to Emacs via `M-x report-emacs-bug` or
|
||||
sending an email to `bug-gnu-emacs@gnu.org`, putting "yasnippet"
|
||||
somewhere in the subject.
|
||||
Please refer to the comprehensive [documentation][docs] for full
|
||||
customisation and support. If you find a bug in the code or in the
|
||||
documentation, please report it to the main Emacs bug list,
|
||||
bug-gnu-emacs@gnu.org, and put "yasnippet" somewhere in the subject.
|
||||
Alternatively, you may use the [Github issue tracker][issues].
|
||||
|
||||
## Important note regarding bug reporting
|
||||
|
||||
@ -153,16 +155,19 @@ do `git log -1` in the dir).
|
||||
Any more info is welcome, but don't just paste a backtrace or an error
|
||||
message string you got, unless we ask for it.
|
||||
|
||||
There is also a [YASnippet google group][forum]. I will keep the group
|
||||
open for reference and for discussion among users. Unfortunately I
|
||||
can't guarantee a timely response, so maybe it's better to create a
|
||||
github issue clearly marking your intent (user support/bug/feature
|
||||
request).
|
||||
|
||||
Finally, thank you very much for using YASnippet!
|
||||
|
||||
[docs]: http://joaotavora.github.io/yasnippet/
|
||||
[issues]: https://github.com/joaotavora/yasnippet/issues
|
||||
[support-issues]: https://github.com/joaotavora/yasnippet/issues?q=label%3Asupport
|
||||
[googlecode tracker]: http://code.google.com/p/yasnippet/issues/list
|
||||
[forum]: http://groups.google.com/group/smart-snippet
|
||||
[melpa]: http://melpa.milkbox.net/
|
||||
[gnuelpa]: http://elpa.gnu.org/packages/yasnippet.html
|
||||
[gnudevel]: http://elpa.gnu.org/devel/yasnippet.html
|
||||
[yasmate]: http://github.com/joaotavora/yasmate
|
||||
[textmate-to-yas.el]: https://github.com/mattfidler/textmate-to-yas.el
|
||||
[yasnippet-snippets]: http://github.com/AndreaCrotti/yasnippet-snippets
|
||||
|
||||
118
Rakefile
Normal file
118
Rakefile
Normal file
@ -0,0 +1,118 @@
|
||||
# -*- Ruby -*-
|
||||
|
||||
require 'fileutils'
|
||||
|
||||
$EMACS = ENV["EMACS"]
|
||||
if not $EMACS or $EMACS == 't'
|
||||
$EMACS = "emacs"
|
||||
end
|
||||
|
||||
def find_version
|
||||
File.read("yasnippet.el", :encoding => "UTF-8") =~ /;; Package-version: *([0-9.]+?) *$/
|
||||
$version = $1
|
||||
end
|
||||
find_version
|
||||
FileUtils.mkdir_p('pkg')
|
||||
|
||||
desc "run tests in batch mode"
|
||||
task :tests do
|
||||
sh "#{$EMACS} -Q -L . -l yasnippet-tests.el" +
|
||||
" --batch -f ert-run-tests-batch-and-exit"
|
||||
end
|
||||
|
||||
desc "run test in interactive mode"
|
||||
task :itests do
|
||||
sh "#{$EMACS} -Q -L . -l yasnippet-tests.el" +
|
||||
" --eval \"(call-interactively 'ert)\""
|
||||
end
|
||||
|
||||
desc "create a release package"
|
||||
task :package do
|
||||
release_dir = "pkg/yasnippet-#{$version}"
|
||||
FileUtils.mkdir_p(release_dir)
|
||||
files = ['snippets', 'yasnippet.el']
|
||||
FileUtils.cp_r files, release_dir
|
||||
File.open(File.join(release_dir,'yasnippet-pkg.el'), 'w') do |file|
|
||||
file.puts <<END
|
||||
(define-package "yasnippet"
|
||||
"#{$version}"
|
||||
"A template system for Emacs")
|
||||
END
|
||||
end
|
||||
sh "git clean -f snippets"
|
||||
FileUtils.cd 'pkg' do
|
||||
sh "tar cf yasnippet-#{$version}.tar yasnippet-#{$version}"
|
||||
end
|
||||
end
|
||||
|
||||
desc "create a release package and upload it to google code"
|
||||
task :release => [:package, 'doc:archive'] do
|
||||
raise "Not implemented for github yet!"
|
||||
end
|
||||
|
||||
desc "Generate document"
|
||||
task :doc, [:htmlize] do |t, args|
|
||||
load_path = '-L .'
|
||||
if args[:htmlize]
|
||||
load_path += " -L #{args[:htmlize]}"
|
||||
end
|
||||
sh "#{$EMACS} -Q #{load_path} --batch -l doc/yas-doc-helper.el" +
|
||||
" -f yas--generate-html-batch"
|
||||
end
|
||||
|
||||
namespace :doc do
|
||||
task :archive do
|
||||
release_dir = "pkg/yasnippet-#{$version}"
|
||||
FileUtils.mkdir_p(release_dir)
|
||||
sh "tar cjf pkg/yasnippet-doc-#{$version}.tar.bz2 " +
|
||||
"--exclude=doc/.svn --exclude=doc/images/.svn doc/*.html doc/images"
|
||||
end
|
||||
|
||||
task :upload do
|
||||
if File.exists? 'doc/gh-pages'
|
||||
Dir.chdir 'doc/gh-pages' do
|
||||
sh "git checkout gh-pages"
|
||||
end
|
||||
Dir.glob("doc/*.{html,css}").each do |file|
|
||||
FileUtils.cp file, 'doc/gh-pages'
|
||||
end
|
||||
Dir.glob("doc/images/*").each do |file|
|
||||
FileUtils.cp file, 'doc/gh-pages/images'
|
||||
end
|
||||
Dir.glob("doc/stylesheets/*.css").each do |file|
|
||||
FileUtils.cp file, 'doc/gh-pages/stylesheets'
|
||||
end
|
||||
curRev = `git describe`.chomp()
|
||||
expRev = IO.read('doc/html-revision').chomp()
|
||||
if curRev != expRev
|
||||
raise ("The HTML rev: #{expRev},\n" +
|
||||
"current rev: #{curRev}!\n")
|
||||
end
|
||||
Dir.chdir 'doc/gh-pages' do
|
||||
sh "git commit -a -m 'Automatic documentation update.\n\n" +
|
||||
"From #{curRev.chomp()}'"
|
||||
sh "git push"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
desc "Compile yasnippet.el into yasnippet.elc"
|
||||
|
||||
rule '.elc' => '.el' do |t|
|
||||
set_warnings = ""
|
||||
if ENV['warnings']
|
||||
set_warnings = " --eval \"(setq byte-compile-warnings #{ENV['warnings']})\""
|
||||
end
|
||||
sh "#{$EMACS} --batch -L . --eval \"(setq byte-compile-error-on-warn t)\"" +
|
||||
"#{set_warnings} -f batch-byte-compile #{t.source}"
|
||||
end
|
||||
task :compile => FileList["yasnippet.el"].ext('elc')
|
||||
|
||||
task :default => :doc
|
||||
|
||||
desc "use yasmate to convert textmate bundles"
|
||||
task :convert_bundles do
|
||||
cd "yasmate"
|
||||
sh "rake convert_bundles"
|
||||
end
|
||||
58
doc/faq.org
58
doc/faq.org
@ -2,21 +2,6 @@
|
||||
|
||||
#+TITLE: Frequently Asked Questions
|
||||
|
||||
- *Note*: In addition to the questions and answers presented here,
|
||||
you might also with to visit the list of [[https://github.com/joaotavora/yasnippet/issues?q=label%3Asupport][solved support issues]] in
|
||||
the Github issue tracker. It might be more up-to-date than this
|
||||
list.
|
||||
|
||||
* Why are my snippet abbrev keys triggering when I don't want them too?
|
||||
Expansion of abbrev keys is controlled by [[sym:yas-key-syntaxes][=yas-key-syntaxes=]]. Try
|
||||
removing entries which correspond to the abbrev key character syntax.
|
||||
For example, if you have a snippet with abbrev key "bar", that you
|
||||
don't want to trigger when point follows the text =foo_bar=, remove
|
||||
the ="w"= entry (since "bar" has only word syntax characters).
|
||||
|
||||
* Why aren't my snippet abbrev keys triggering when I want them too?
|
||||
See previous question, but in reverse.
|
||||
|
||||
* Why is there an extra newline?
|
||||
|
||||
If there is a newline at the end of a snippet definition file,
|
||||
@ -30,22 +15,27 @@ final newline automatically.
|
||||
|
||||
* Why doesn't TAB navigation work with flyspell
|
||||
|
||||
This is [[https://debbugs.gnu.org/26672][Emacs Bug#26672]], so you should upgrade to version 25.3 or
|
||||
better. Otherwise, a workaround is to inhibit flyspell overlays while
|
||||
the snippet is active:
|
||||
A workaround is to inhibit flyspell overlays while the snippet is
|
||||
active:
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(add-hook 'flyspell-incorrect-hook
|
||||
#'(lambda (&rest _)
|
||||
#'(lambda (dummy1 dummy2 dymmy3)
|
||||
(and yas-active-field-overlay
|
||||
(overlay-buffer yas-active-field-overlay))))
|
||||
#+END_SRC
|
||||
|
||||
* How do I use alternative keys, i.e. not TAB?
|
||||
This is apparently related to overlay priorities. For some reason, the
|
||||
=keymap= property of flyspell's overlays always takes priority over the
|
||||
same property in YASnippet's overlays, even if one sets the latter's
|
||||
=priority= property to something big. If you know emacs-lisp and can
|
||||
solve this problem, drop a line in the
|
||||
[[http://groups.google.com/group/smart-snippet][discussion group]].
|
||||
|
||||
Edit the keymaps [[sym:yas-minor-mode-map][=yas-minor-mode-map=]] and [[sym:yas-keymap][=yas-keymap=]] as you would
|
||||
any other keymap, but use [[sym:yas-filtered-definition][=yas-filtered-definition=]] on the definition
|
||||
if you want to respect [[sym:yas-keymap-disable-hook][=yas-keymap-disable-hook=]]:
|
||||
* How to I use alternative keys, i.e. not TAB?
|
||||
|
||||
Edit the keymaps [[sym:yas-minor-mode-map][=yas-minor-mode-map=]] and
|
||||
[[sym:yas-keymap][=yas-keymap=]] as you would any other keymap:
|
||||
|
||||
#+begin_src emacs-lisp :exports code
|
||||
(define-key yas-minor-mode-map (kbd "<tab>") nil)
|
||||
@ -57,12 +47,26 @@ if you want to respect [[sym:yas-keymap-disable-hook][=yas-keymap-disable-hook=]
|
||||
(define-key yas-keymap (kbd "TAB") nil)
|
||||
(define-key yas-keymap [(shift tab)] nil)
|
||||
(define-key yas-keymap [backtab] nil)
|
||||
(define-key yas-keymap (kbd "<new-next-field-key>")
|
||||
(yas-filtered-definition 'yas-next-field-or-maybe-expand))
|
||||
(define-key yas-keymap (kbd "<new-prev-field-key>")
|
||||
(yas-filtered-definition 'yas-prev-field))
|
||||
(define-key yas-keymap (kbd "<new-next-field-key>") 'yas-next-field-or-maybe-expand)
|
||||
(define-key yas-keymap (kbd "<new-prev-field-key>") 'yas-prev)
|
||||
#+end_src
|
||||
|
||||
* How do I turn off the minor mode where in some buffers?
|
||||
|
||||
The best way, since version 0.6.1c, is to set the default value of the
|
||||
variable [[sym:yas-dont-activate][=yas-dont-activate=]] to a lambda function like so:
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(set-default 'yas-dont-activate
|
||||
#'(lambda ()
|
||||
(and yas-root-directory
|
||||
(null (yas-get-snippet-tables)))))
|
||||
#+END_SRC
|
||||
|
||||
This is also the default value starting for that version. It skips the
|
||||
minor mode in buffers where it is not applicable (no snippet tables),
|
||||
but only once you have setup your yas-root-directory.
|
||||
|
||||
* How do I define an abbrev key containing characters not supported by the filesystem?
|
||||
|
||||
- *Note*: This question applies if you're still defining snippets
|
||||
|
||||
@ -3,8 +3,8 @@
|
||||
<li> <a href="index.html">Overview</a>
|
||||
<li> <a href="https://github.com/joaotavora/yasnippet/blob/master/README.mdown">
|
||||
Intro and Tutorial</a>
|
||||
<li class="center border">Snippet
|
||||
<ul class="nopad">
|
||||
<li class="center">Snippet
|
||||
<ul>
|
||||
<li> <a href="snippet-organization.html">Organization</a>
|
||||
<li> <a href="snippet-expansion.html">Expansion</a>
|
||||
<li> <a href="snippet-development.html">Development</a>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
|
||||
There are some ways you can quickly find a snippet file or create a new one:
|
||||
|
||||
- =M-x yas-new-snippet=, key binding: =C-c & C-n=
|
||||
- =M-x yas-new-snippet=, key bindind: =C-c & C-n=
|
||||
|
||||
Creates a new buffer with a template for making a new snippet. The
|
||||
buffer is in =snippet-mode= (see [[snippet-mode][below]]). When you are done editing
|
||||
@ -62,7 +62,7 @@ expanded.
|
||||
Optionally, if the file contains a line of =# --=, the lines above it
|
||||
count as comments, some of which can be /directives/ (or meta data).
|
||||
Snippet directives look like =# property: value= and tweak certain
|
||||
snippet properties described below. If no =# --= is found, the whole
|
||||
snippets properties described below. If no =# --= is found, the whole
|
||||
file is considered the snippet template.
|
||||
|
||||
Here's a typical example:
|
||||
@ -80,7 +80,7 @@ Here's a list of currently supported directives:
|
||||
|
||||
This is the probably the most important directive, it's the
|
||||
abbreviation you type to expand a snippet just before hitting the key
|
||||
that runs [[sym:yas-expand][=yas-expand=]]. If you don't specify this,
|
||||
that runs [[sym:yas-expand][=yas-expand=]]. If you don't specify this
|
||||
the snippet will not be expandable through the trigger mechanism.
|
||||
|
||||
** =# name:= snippet name
|
||||
@ -89,12 +89,12 @@ This is a one-line description of the snippet. It will be displayed in
|
||||
the menu. It's a good idea to select a descriptive name for a snippet --
|
||||
especially distinguishable among similar snippets.
|
||||
|
||||
If you omit this name, it will default to the file name the snippet
|
||||
was loaded from.
|
||||
If you omit this name it will default to the file name the snippet was
|
||||
loaded from.
|
||||
|
||||
** =# condition:= snippet condition
|
||||
|
||||
This is a piece of Emacs Lisp code. If a snippet has a condition, then
|
||||
This is a piece of Emacs-lisp code. If a snippet has a condition, then
|
||||
it will only be expanded when the condition code evaluate to some
|
||||
non-nil value.
|
||||
|
||||
@ -104,7 +104,7 @@ See also [[sym:yas-buffer-local-condition][=yas-buffer-local-condition=]] in
|
||||
** =# group:= snippet menu grouping
|
||||
|
||||
When expanding/visiting snippets from the menu-bar menu, snippets for a
|
||||
given mode can be grouped into sub-menus. This is useful if one has too
|
||||
given mode can be grouped into sub-menus . This is useful if one has too
|
||||
many snippets for a mode which will make the menu too long.
|
||||
|
||||
The =# group:= property only affect menu construction (See
|
||||
@ -113,14 +113,14 @@ achieved by grouping snippets into sub-directories and using the
|
||||
=.yas-make-groups= special file (for this see
|
||||
[[./snippet-organization.org][Organizing Snippets]]
|
||||
|
||||
Refer to the bundled snippets for =ruby-mode= for examples of the
|
||||
Refer to the bundled snippets for =ruby-mode= for examples on the
|
||||
=# group:= directive. Group can also be nested, e.g.
|
||||
=control structure.loops= indicates that the snippet is under the =loops=
|
||||
=control structure.loops= tells that the snippet is under the =loops=
|
||||
group which is under the =control structure= group.
|
||||
|
||||
** =# expand-env:= expand environment
|
||||
|
||||
This is another piece of Emacs Lisp code in the form of a =let= /varlist
|
||||
This is another piece of Emacs-lisp code in the form of a =let= /varlist
|
||||
form/, i.e. a list of lists assigning values to variables. It can be
|
||||
used to override variable values while the snippet is being expanded.
|
||||
|
||||
@ -154,9 +154,9 @@ You can use this directive to expand a snippet directly from a normal
|
||||
Emacs keybinding. The keybinding will be registered in the Emacs keymap
|
||||
named after the major mode the snippet is active for.
|
||||
|
||||
Additionally a variable [[sym:yas-prefix][=yas-prefix=]] is set to the prefix argument
|
||||
Additionally a variable [[sym:yas-prefix][=yas-prefix=]] is set to to the prefix argument
|
||||
you normally use for a command. This allows for small variations on the
|
||||
same snippet, for example in this =html-mode= snippet.
|
||||
same snippet, for example in this "html-mode" snippet.
|
||||
|
||||
#+BEGIN_SRC snippet
|
||||
# name: <p>...</p>
|
||||
@ -172,7 +172,7 @@ will expand the paragraph tag without newlines.
|
||||
** =# type:= =snippet= or =command=
|
||||
|
||||
If the =type= directive is set to =command=, the body of the snippet
|
||||
is interpreted as Lisp code to be evaluated when the snippet is
|
||||
is interpreted as lisp code to be evaluated when the snippet is
|
||||
triggered.
|
||||
|
||||
If it's =snippet= (the default when there is no =type= directive), the
|
||||
@ -202,14 +202,14 @@ usually interpreted as plain text, except =$= and =`=. You need to
|
||||
use =\= to escape them: =\$= and =\`=. The =\= itself may also needed to be
|
||||
escaped as =\\= sometimes.
|
||||
|
||||
** Embedded Emacs Lisp code
|
||||
** Embedded Emacs-lisp code
|
||||
|
||||
Emacs Lisp code can be embedded inside the template, written inside
|
||||
back-quotes (=`=). The Lisp forms are evaluated when the snippet is
|
||||
Emacs-Lisp code can be embedded inside the template, written inside
|
||||
back-quotes (=`=). The lisp forms are evaluated when the snippet is
|
||||
being expanded. The evaluation is done in the same buffer as the
|
||||
snippet being expanded.
|
||||
|
||||
Here's an example for =c-mode= to calculate the header file guard
|
||||
Here's an example for c-mode to calculate the header file guard
|
||||
dynamically:
|
||||
|
||||
#+BEGIN_SRC snippet
|
||||
@ -221,8 +221,8 @@ dynamically:
|
||||
#endif /* $1 */
|
||||
#+END_SRC
|
||||
|
||||
From version 0.6, snippet expansions are run with some special
|
||||
Emacs Lisp variables bound. One of these is [[sym:yas-selected-text][=yas-selected-text=]]. You can
|
||||
From version 0.6, snippets expansions are run with some special
|
||||
Emacs-lisp variables bound. One of this is [[sym:yas-selected-text][=yas-selected-text=]]. You can
|
||||
therefore define a snippet like:
|
||||
|
||||
#+BEGIN_SRC snippet
|
||||
@ -237,7 +237,7 @@ Alternatively, you can also customize the variable
|
||||
|
||||
*** Note: backquote expressions should not modify the buffer
|
||||
|
||||
Please note that the Lisp forms in backquotes should *not* modify the
|
||||
Please note that the lisp forms in backquotes should *not* modify the
|
||||
buffer, doing so will trigger a warning. For example, instead of
|
||||
doing
|
||||
|
||||
@ -277,16 +277,16 @@ like this:
|
||||
${N:default value}
|
||||
#+END_SRC
|
||||
|
||||
They act as the default value for a tab stop. But when you first
|
||||
They acts as the default value for a tab stop. But when you firstly
|
||||
type at a tab stop, the default value will be replaced by your typing.
|
||||
The number can be omitted if you don't want to create [[mirrors-fields][mirrors]] or
|
||||
[[mirror-transformations][transformations]] for this field.
|
||||
|
||||
** Mirrors <<mirrors-fields>>
|
||||
|
||||
We refer to tab stops with placeholders as a /field/. A field can
|
||||
have mirrors. *All* mirrors get updated whenever you update any field
|
||||
text. Here's an example:
|
||||
We refer the tab stops with placeholders as a /field/. A field can have
|
||||
mirrors. Its mirrors will get updated when you change the text of a
|
||||
field. Here's an example:
|
||||
|
||||
#+BEGIN_SRC snippet
|
||||
\begin{${1:enumerate}}
|
||||
@ -299,15 +299,15 @@ also be inserted at =\end{$1}=. The best explanation is to see the
|
||||
screencast([[http://www.youtube.com/watch?v=vOj7btx3ATg][YouTube]] or [[http://yasnippet.googlecode.com/files/yasnippet.avi][avi video]]).
|
||||
|
||||
The tab stops with the same number to the field act as its mirrors. If
|
||||
none of the tab stops have an initial value, the first one is selected as
|
||||
the field and the others are its mirrors.
|
||||
none of the tab stops has an initial value, the first one is selected as
|
||||
the field and others mirrors.
|
||||
|
||||
** Mirrors with transformations <<mirror-transformations>>
|
||||
|
||||
If the value of an =${n:=-construct starts with and contains =$(=,
|
||||
then it is interpreted as a mirror for field =n= with a
|
||||
transformation. The mirror's text content is calculated according to
|
||||
this transformation, which is Emacs Lisp code that gets evaluated in
|
||||
this transformation, which is Emacs-lisp code that gets evaluated in
|
||||
an environment where the variable [[sym:yas-text][=yas-text=]] is bound to the text
|
||||
content (string) contained in the field =n=. Here's an example for
|
||||
Objective-C:
|
||||
@ -362,26 +362,12 @@ is not. Here's an snippet for rst title:
|
||||
$0
|
||||
#+END_SRC
|
||||
|
||||
Note that a mirror with a transform is not restricted to the text of
|
||||
the field it is mirroring. By making use of [[sym:yas-field-value][=yas-field-value=]], a
|
||||
mirror can look at any of the snippet's field (as mentioned above, all
|
||||
mirrors are updated when any field is updated). Here is an example
|
||||
which shows a "live" result of calling format:
|
||||
|
||||
#+BEGIN_SRC snippet
|
||||
(format "${1:formatted %s}" "${2:value}")
|
||||
=> "${1:$(ignore-errors (format (yas-field-value 1) (yas-field-value 2)))}"
|
||||
#+END_SRC
|
||||
|
||||
To keep the example simple, it uses =ignore-errors= to suppress errors
|
||||
due to incomplete format codes.
|
||||
|
||||
** Fields with transformations
|
||||
|
||||
From version 0.6 on, you can also have Lisp transformation inside
|
||||
fields. These work mostly like mirror transformations. However, they
|
||||
are evaluated when you first enter the field, after each change you
|
||||
make to the field and also just before you exit the field.
|
||||
From version 0.6 on, you can also have lisp transformation inside
|
||||
fields. These work mostly mirror transformations but are evaluated when
|
||||
you first enter the field, after each change you make to the field and
|
||||
also just before you exit the field.
|
||||
|
||||
The syntax is also a tiny bit different, so that the parser can
|
||||
distinguish between fields and mirrors. In the following example
|
||||
@ -412,38 +398,25 @@ the field, and with some useful variables bound, notably
|
||||
can place a transformation in the primary field that lets you select
|
||||
default values for it.
|
||||
|
||||
For example, the [[sym:yas-choose-value][=yas-completing-read=]] function is version of
|
||||
=completing-read= which checks these variables. For example, asking
|
||||
the user for the initial value of a field:
|
||||
The [[sym:yas-choose-value][=yas-choose-value=]] does this work for you. For example:
|
||||
|
||||
#+BEGIN_SRC snippet
|
||||
<div align="${2:$$(yas-completing-read "Alignment? " '("right" "center" "left"))}">
|
||||
<div align="${2:$$(yas-choose-value '("right" "center" "left"))}">
|
||||
$0
|
||||
</div>
|
||||
#+END_SRC
|
||||
|
||||
See the definition of [[sym:yas-choose-value][=yas-completing-read=]] to see how it was written
|
||||
using the two variables. If you're really lazy :) and can't spare a
|
||||
tab keypress, you can automatically move to the next field (or exit)
|
||||
after choosing the value with [[sym:yas-auto-next][=yas-auto-next=]]. The snippet above
|
||||
becomes:
|
||||
See the definition of [[sym:yas-choose-value][=yas-choose-value=]] to see how it was written using
|
||||
the two variables.
|
||||
|
||||
#+BEGIN_SRC snippet
|
||||
<div align="${2:$$(yas-auto-next
|
||||
(yas-completing-read
|
||||
"Alignment? "
|
||||
'("right" "center" "left")))}">
|
||||
$0
|
||||
</div>
|
||||
#+END_SRC
|
||||
|
||||
Here's another use, for =LaTeX-mode=, which calls reftex-label just as you
|
||||
Here's another use, for LaTeX-mode, which calls reftex-label just as you
|
||||
enter snippet field 2. This one makes use of [[sym:yas-modified-p][=yas-modified-p=]] directly.
|
||||
|
||||
#+BEGIN_SRC snippet
|
||||
\section{${1:"Titel der Tour"}}%
|
||||
\index{$1}%
|
||||
\label{{2:"waiting for reftex-label call..."$(unless yas-modified-p (reftex-label nil 'dont-insert))}}%
|
||||
\label{{2:"waiting for reftex-label call..."$(unless yas-modified-p (reftex-label nil 'dont-
|
||||
insert))}}%
|
||||
#+END_SRC
|
||||
|
||||
The function [[sym:yas-verify-value][=yas-verify-value=]] has another neat trick, and makes use
|
||||
@ -458,7 +431,7 @@ From version 0.6 on, you can also have nested placeholders of the type:
|
||||
#+END_SRC
|
||||
|
||||
This allows you to choose if you want to give this =div= an =id=
|
||||
attribute. If you tab forward after expanding, it will let you change
|
||||
attribute. If you tab forward after expanding it will let you change
|
||||
"some\_id" to whatever you like. Alternatively, you can just press =C-d=
|
||||
(which executes [[sym:yas-skip-and-clear-or-delete-char][=yas-skip-and-clear-or-delete-char=]]) and go straight to
|
||||
the exit marker.
|
||||
|
||||
@ -21,7 +21,7 @@
|
||||
|
||||
- Using hippie-expand
|
||||
|
||||
- Call [[sym:yas-insert-snippet][=yas-insert-snippet=]] (use =M-x yas-insert-snippet= or its
|
||||
- Call [[sym:yas-insert-snippet][=yas-insert-snippet=]] (use =M-x yas-insert-snippet== or its
|
||||
keybinding =C-c & C-s=).
|
||||
|
||||
- Use m2m's excellent auto-complete
|
||||
@ -77,7 +77,7 @@ obsolete.
|
||||
|
||||
** Insert at point
|
||||
|
||||
The command [[sym:yas-insert-snippet][=yas-insert-snippet=]] lets you insert snippets at point
|
||||
The command [[#yas-insert-snippet][=yas-insert-snippet=]] lets you insert snippets at point
|
||||
/for your current major mode/. It prompts you for the snippet key
|
||||
first, and then for a snippet template if more than one template
|
||||
exists for the same key.
|
||||
@ -94,7 +94,7 @@ The prompting methods used are again controlled by
|
||||
It's often useful to inject already written text in the middle of a
|
||||
snippet. The variable [[sym:yas-wrap-around-region][=yas-wrap-around-region=]] when to t substitute
|
||||
the region contents into the =$0= placeholder of a snippet expanded by
|
||||
[[sym:yas-insert-snippet][=yas-insert-snippet=]]. Setting it to a character value (e.g. =?0=)
|
||||
[[#yas-insert-snippet][=yas-insert-snippet=]]. Setting it to a character value (e.g. =?0=)
|
||||
will insert the contents of corresponding register.
|
||||
|
||||
Older (versions 0.9.1 and below) of Yasnippet, supported a setting of
|
||||
@ -141,7 +141,7 @@ See the internal documentation on [[sym:yas-expand-snippet][=yas-expand-snippet=
|
||||
|
||||
* Controlling expansion
|
||||
|
||||
** Eligible snippets<<eligible-snippets>>
|
||||
** Eligible snippets
|
||||
|
||||
YASnippet does quite a bit of filtering to find out which snippets are
|
||||
eligible for expanding at the current cursor position.
|
||||
@ -163,15 +163,13 @@ In particular, the following things matter:
|
||||
|
||||
- Parent tables
|
||||
|
||||
Snippet tables defined as the parent of some other eligible table
|
||||
are also considered. This works recursively, i.e., parents of
|
||||
parents of eligible tables are also considered. As a special case,
|
||||
if a mode doesn't have a parent, then =fundamental-mode= is
|
||||
considered to be its parent.
|
||||
Snippet tables defined as the parent of some other eligible table are
|
||||
also considered. This works recursively, i.e. parents of parents of
|
||||
eligible tables are also considered.
|
||||
|
||||
- Buffer-local list of extra modes
|
||||
|
||||
Use [[sym:yas-activate-extra-mode][=yas-activate-extra-mode=]] to
|
||||
Use [[#yas-activate-extra-mode][=yas-activate-extra-mode=]] to
|
||||
consider snippet tables whose name does not correspond to a major
|
||||
mode. Typically, you call this from a minor mode hook, for example:
|
||||
|
||||
@ -212,10 +210,9 @@ inside a comment? Set [[sym:yas-buffer-local-condition][=yas-buffer-local-condi
|
||||
(add-hook 'python-mode-hook
|
||||
(lambda ()
|
||||
(setq yas-buffer-local-condition
|
||||
(lambda ()
|
||||
(if (python-syntax-comment-or-string-p)
|
||||
'(if (python-syntax-comment-or-string-p)
|
||||
'(require-snippet-condition . force-in-comment)
|
||||
t)))))
|
||||
t))))
|
||||
#+END_SRC
|
||||
|
||||
... and for a snippet that you want to expand in comments, specify a
|
||||
@ -228,7 +225,7 @@ For the full set of possible conditions, see the documentation for
|
||||
|
||||
** Multiples snippet with the same key
|
||||
|
||||
The rules outlined [[eligible-snippets][above]] can return more than
|
||||
The rules outlined [[Eligible%20snippets][above]] can return more than
|
||||
one snippet to be expanded at point.
|
||||
|
||||
When there are multiple candidates, YASnippet will let you select one.
|
||||
|
||||
@ -24,7 +24,7 @@ In this menu, you can find
|
||||
Invoking "Load snippets..." from the menu invokes [[sym:yas-load-directory][=yas-load-directory=]]
|
||||
and prompts you for a snippet directory hierarchy to load.
|
||||
|
||||
Also useful is the "Reload everything" item to invoke [[sym:yas-reload-all][=yas-reload-all=]]
|
||||
Also useful is the "Reload everything" item to invoke [[#yas-reload-all][=yas-reload-all=]]
|
||||
which uncondionally reloads all the snippets directories defined in
|
||||
[[sym:yas-snippet-dirs][=yas-snippet-dirs=]] and rebuilds the menus.
|
||||
|
||||
|
||||
@ -4,9 +4,8 @@
|
||||
|
||||
* Basic structure
|
||||
|
||||
Snippet collections can be stored in plain text files. They are
|
||||
arranged by sub-directories naming *snippet tables*. These mostly
|
||||
name Emacs major mode names.
|
||||
Snippet collections can be stored in plain text files. They are arranged by
|
||||
sub-directories naming *snippet tables*. These mostly name Emacs major names.
|
||||
|
||||
#+begin_example
|
||||
.
|
||||
@ -33,7 +32,7 @@
|
||||
The default considers:
|
||||
|
||||
- a personal collection that lives in =~/.emacs.d/snippets=
|
||||
- the bundled collection, taken as a relative path to =yasnippet.el= location
|
||||
- the bundled collection, taken as a relative path to =yasnippet.el= localtion
|
||||
|
||||
When you come across other snippet collections, do the following to try them
|
||||
out:
|
||||
@ -82,7 +81,7 @@
|
||||
|
||||
If you place an empty plain text file =.yas-make-groups= inside one
|
||||
of the mode directories, the names of these sub-directories are
|
||||
considered groups of snippets and [[file:snippet-menu.org][the menu]] is organized much more
|
||||
considered groups of snippets and [[snippet-menu.org][the menu]] is organized much more
|
||||
cleanly:
|
||||
|
||||
[[./images/menu-groups.png]]
|
||||
|
||||
@ -1,14 +1,5 @@
|
||||
.center { margin-left: auto; margin-right: auto; text-align: center; }
|
||||
.current {
|
||||
font-weight: bold;
|
||||
background-color: #E0E8F0;
|
||||
}
|
||||
|
||||
body { background-color: #E4F0F4 }
|
||||
div#content {
|
||||
max-width: 20cm;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
nav > ul > li.center > ul {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
nav li {
|
||||
@ -18,22 +9,20 @@ nav li {
|
||||
list-style-type: none;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
nav > ul > li {
|
||||
display: inline-block;
|
||||
}
|
||||
.nopad {
|
||||
padding: 0;
|
||||
}
|
||||
li.border {
|
||||
border: solid;
|
||||
border-width: 1px;
|
||||
|
||||
/* match org's css for <pre> */
|
||||
code {
|
||||
background-color: #F3F5F7;
|
||||
font-family: courier, monospace;
|
||||
}
|
||||
|
||||
pre, code{ background-color: #F3F5F7; }
|
||||
code {
|
||||
/* http://neugierig.org/software/chromium/notes/2009/09/monospace-fonts-workaround.html */
|
||||
font-family: WorkAroundWebKitAndMozilla, monospace;
|
||||
white-space: nowrap;
|
||||
#content {
|
||||
margin-left: 5%;
|
||||
margin-right: 10%;
|
||||
}
|
||||
|
||||
/* Styles for htmlize.el fontification. */
|
||||
|
||||
93
doc/stylesheets/styles.css
Normal file
93
doc/stylesheets/styles.css
Normal file
@ -0,0 +1,93 @@
|
||||
@media all
|
||||
{
|
||||
body {
|
||||
margin: 1em auto;
|
||||
/*margin: 10px 18% 10px 18%;*/
|
||||
font-family: Arial;
|
||||
/*text-align: justify;*/
|
||||
font-size: 14pt;
|
||||
padding: 10px;
|
||||
line-height: 1.2em;
|
||||
max-width: 600pt;
|
||||
}
|
||||
|
||||
div#table-of-contents {
|
||||
position: fixed;
|
||||
left: 0%;
|
||||
right: 0%;
|
||||
top: 0px;
|
||||
z-index: 100;
|
||||
background: black;
|
||||
}
|
||||
|
||||
div#table-of-contents h2 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div#table-of-contents a {
|
||||
text-decoration: none;
|
||||
color: white;
|
||||
}
|
||||
|
||||
div#table-of-contents a:visited {
|
||||
color: white;
|
||||
}
|
||||
|
||||
div#table-of-contents a:hover {
|
||||
color: orange;
|
||||
}
|
||||
|
||||
div.outline-2 h2{
|
||||
padding-top: 50px;
|
||||
}
|
||||
|
||||
div#text-table-of-contents {
|
||||
text-color: white;
|
||||
text-align: center;
|
||||
margin-left: 30%;
|
||||
margin-right: 30%;
|
||||
}
|
||||
|
||||
div#text-table-of-contents ul {
|
||||
height: 2em;
|
||||
width: 500px;
|
||||
list-style: none;
|
||||
margin: auto;
|
||||
}
|
||||
|
||||
div#text-table-of-contents ul li {
|
||||
float: left;
|
||||
margin-left:auto;
|
||||
margin-right: auto;
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
div#postamble{
|
||||
position: fixed;
|
||||
width: 800px;
|
||||
height: 250px;
|
||||
left: 50%;
|
||||
right: 50%;
|
||||
margin:-75px 0 0 -400px;
|
||||
bottom: -20px;
|
||||
font-size: 10pt;
|
||||
color: grey;
|
||||
background: url('siscog-bottom-logo.png') no-repeat;
|
||||
/* background-size: 100% 100%; */
|
||||
}
|
||||
|
||||
div#postamble *{
|
||||
display: none;
|
||||
}
|
||||
|
||||
div#postamble p.date{
|
||||
position: relative;
|
||||
bottom: -200px;
|
||||
text-align: center;
|
||||
display: block;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
@ -1,6 +1,6 @@
|
||||
;;; yas-doc-helper.el --- Help generate documentation for YASnippet -*- lexical-binding: t; -*-
|
||||
;;; yas-doc-helper.el --- Help generate documentation for YASnippet
|
||||
|
||||
;; Copyright (C) 2012-2023 Free Software Foundation, Inc.
|
||||
;; Copyright (C) 2012, 2013 Free Software Foundation, Inc.
|
||||
|
||||
;; Author: João Távora <joaotavora@gmail.com>
|
||||
;; Keywords: convenience
|
||||
@ -25,25 +25,19 @@
|
||||
;;; Code:
|
||||
|
||||
(eval-when-compile
|
||||
(require 'cl-lib))
|
||||
(require 'cl))
|
||||
(require 'org)
|
||||
(require 'ox-publish)
|
||||
(or (require 'org-publish nil t)
|
||||
(require 'ox-publish))
|
||||
(require 'yasnippet) ; docstrings must be loaded
|
||||
|
||||
;; Presumably one of org/ox-publish provided the following vars:
|
||||
(defvar org-publish-project-alist)
|
||||
(defvar org-publish-use-timestamps-flag)
|
||||
(defvar org-export-copy-to-kill-ring)
|
||||
(defvar org-html-htmlize-output-type)
|
||||
|
||||
(defun yas--org-raw-html (tag content &optional attrs)
|
||||
(defun yas--org-raw-html (tag content)
|
||||
;; in version 8.0 org-mode changed the export syntax, see
|
||||
;; http://orgmode.org/worg/org-8.0.html#sec-8-1
|
||||
(format (if (version< org-version "8.0.0")
|
||||
"@<%s>%s@</%s>" ; old: @<tag>
|
||||
"@@html:<%s>@@%s@@html:</%s>@@") ; new: @@html:<tag>@@
|
||||
(concat tag (if attrs " ") attrs)
|
||||
content tag))
|
||||
tag content tag))
|
||||
|
||||
(defun yas--document-symbol (symbol level)
|
||||
(let* ((stars (make-string level ?*))
|
||||
@ -51,17 +45,14 @@
|
||||
(mapcar #'symbol-name (help-function-arglist symbol t))))
|
||||
(heading (cond ((fboundp symbol)
|
||||
(format
|
||||
"%s %s (%s)\n" stars (yas--org-raw-html "code" symbol "class='function'")
|
||||
"%s =%s= (%s)" stars symbol
|
||||
(mapconcat (lambda (a)
|
||||
(format (if (string-prefix-p "&" a)
|
||||
"/%s/" "=%s=")
|
||||
a))
|
||||
"/%s/" "=%s=") a))
|
||||
args " ")))
|
||||
(t
|
||||
(format "%s %s\n" stars
|
||||
(yas--org-raw-html "code" symbol "class='variable'")))))
|
||||
(format "%s =%s=\n" stars symbol))))
|
||||
(after-heading (format ":PROPERTIES:\n:CUSTOM_ID: %s\n:END:" symbol))
|
||||
(text-quoting-style 'grave)
|
||||
(body (or (cond ((fboundp symbol)
|
||||
(let ((doc-synth (car-safe (get symbol 'function-documentation))))
|
||||
(if (functionp doc-synth)
|
||||
@ -73,17 +64,10 @@
|
||||
(format "*WARNING*: no symbol named =%s=" symbol)))
|
||||
(format "*WARNING*: no doc for symbol =%s=" symbol)))
|
||||
(case-fold-search nil))
|
||||
;; Do some transformations on the body:
|
||||
;; do some transformations on the body:
|
||||
;; ARGxxx becomes @<code>arg@</code>xxx
|
||||
;; FOO becomes /foo/
|
||||
;; `bar' becomes [[#bar][=bar=]]
|
||||
;; (...) becomes #+BEGIN_SRC elisp (...) #+END_SRC
|
||||
;; Info node `(some-manual) Node Name' becomes
|
||||
;; [[https://www.gnu.org/software/emacs/manual/html_node/some-manual/Node-Name.html]
|
||||
;; [(some-manual) Node Name]]
|
||||
;;
|
||||
;; This is fairly fragile, though it seems to be working for
|
||||
;; now...
|
||||
(setq body (replace-regexp-in-string
|
||||
"\\<\\([A-Z][-A-Z0-9]+\\)\\(\\sw+\\)?\\>"
|
||||
#'(lambda (match)
|
||||
@ -98,52 +82,27 @@
|
||||
match1)))
|
||||
body t t 1)
|
||||
body (replace-regexp-in-string
|
||||
"\\\\{[^}]+}"
|
||||
(lambda (match)
|
||||
(concat "#+BEGIN_EXAMPLE\n"
|
||||
(substitute-command-keys match)
|
||||
"#+END_EXAMPLE\n"))
|
||||
body t t)
|
||||
body (substitute-command-keys body)
|
||||
body (replace-regexp-in-string
|
||||
"Info node `(\\([-a-z]+\\)) \\([A-Za-z0-9 ]+\\)'"
|
||||
(lambda (match)
|
||||
(let* ((manual (match-string 1 match))
|
||||
(node (match-string 2 match))
|
||||
(html-node (replace-regexp-in-string " " "-" node t t)))
|
||||
(format "Info node\
|
||||
[[https://www.gnu.org/software/emacs/manual/html_node/%s/%s.html][(%s) %s]]"
|
||||
manual html-node manual node)))
|
||||
body t t)
|
||||
body (replace-regexp-in-string
|
||||
"`\\([-a-z]+\\)'"
|
||||
"`\\([a-z-]+\\)'"
|
||||
#'(lambda (match)
|
||||
(let* ((name (downcase (match-string 1 match)))
|
||||
(sym (intern-soft name)))
|
||||
(sym (intern name)))
|
||||
(if (memq sym yas--exported-syms)
|
||||
(format "[[#%s][=%s=]]" name name)
|
||||
(format "=%s=" name))))
|
||||
body t t)
|
||||
body (replace-regexp-in-string
|
||||
"\n\n +(.+\\(?:\n +.+\\)*"
|
||||
(lambda (match)
|
||||
(concat "\n#+BEGIN_SRC elisp\n"
|
||||
match
|
||||
"\n#+END_SRC\n"))
|
||||
body t t))
|
||||
body t))
|
||||
;; output the paragraph
|
||||
(concat heading after-heading "\n" body)))
|
||||
(concat heading "\n" after-heading "\n" body)))
|
||||
|
||||
(defun yas--document-symbols (level &rest names-and-predicates)
|
||||
(let ((sym-lists (make-vector (length names-and-predicates) nil))
|
||||
(stars (make-string level ?*)))
|
||||
(cl-loop for sym in yas--exported-syms
|
||||
do (cl-loop for test in (mapcar #'cdr names-and-predicates)
|
||||
(loop for sym in yas--exported-syms
|
||||
do (loop for test in (mapcar #'cdr names-and-predicates)
|
||||
for i from 0
|
||||
do (when (funcall test sym)
|
||||
(push sym (aref sym-lists i))
|
||||
(cl-return))))
|
||||
(cl-loop for slist across sym-lists
|
||||
(return))))
|
||||
(loop for slist across sym-lists
|
||||
for name in (mapcar #'car names-and-predicates)
|
||||
concat (format "\n%s %s\n" stars name)
|
||||
concat (mapconcat (lambda (sym)
|
||||
@ -154,27 +113,11 @@
|
||||
(interactive)
|
||||
(yas-expand-snippet "[[#$1][=${1:`yas/selected-text`}=]]"))
|
||||
|
||||
(define-key org-mode-map [M-f8] #'yas--internal-link-snippet)
|
||||
(define-key org-mode-map [M-f8] 'yas--internal-link-snippet)
|
||||
|
||||
;; This lets all the org files be exported to HTML with
|
||||
;; `org-publish-current-project' (C-c C-e P).
|
||||
|
||||
(defun yas--make-preamble (props)
|
||||
"Return contents of nav-menu-html.inc.
|
||||
But replace link to \"current\" page with a span element."
|
||||
(with-temp-buffer
|
||||
(let ((dir (file-name-directory (plist-get props :input-file))))
|
||||
(insert-file-contents (expand-file-name "nav-menu.html.inc" dir))
|
||||
(goto-char (point-min))
|
||||
(search-forward (concat "<a href=\""
|
||||
(file-name-nondirectory
|
||||
(plist-get props :output-file))
|
||||
"\">"))
|
||||
(replace-match "<span class='current'>")
|
||||
(search-forward "</a>")
|
||||
(replace-match "</span>")
|
||||
(buffer-string))))
|
||||
|
||||
(let* ((dir (if load-file-name (file-name-directory load-file-name)
|
||||
default-directory))
|
||||
(src-epoch (getenv "SOURCE_DATE_EPOCH"))
|
||||
@ -195,11 +138,13 @@ But replace link to \"current\" page with a span element."
|
||||
`(,@(when (fboundp 'org-html-publish-to-html)
|
||||
'(:publishing-function org-html-publish-to-html))
|
||||
:base-directory ,dir :publishing-directory ,dir
|
||||
:html-preamble yas--make-preamble
|
||||
;;:with-broken-links mark
|
||||
:html-preamble
|
||||
,(with-temp-buffer
|
||||
(insert-file-contents (expand-file-name "nav-menu.html.inc" dir))
|
||||
(buffer-string))
|
||||
:html-postamble
|
||||
,(concat "<hr><p class='creator'>Generated by %c from "
|
||||
rev " " date "</p>\n"
|
||||
(or rev yas--version) " " date "</p>\n"
|
||||
"<p class='xhtml-validation'>%v</p>\n")))
|
||||
(project (assoc "yasnippet" org-publish-project-alist)))
|
||||
(when rev ;; Rakefile :doc:upload uses "html-revision".
|
||||
|
||||
1
snippets
Submodule
1
snippets
Submodule
@ -0,0 +1 @@
|
||||
Subproject commit 885050d34737e2fb36a3e7759d60c09347bd4ce0
|
||||
1
yasmate
Submodule
1
yasmate
Submodule
@ -0,0 +1 @@
|
||||
Subproject commit 0543618bd34a6715918992f01161c118f136bb37
|
||||
@ -1,6 +1,6 @@
|
||||
;;; yasnippet-debug.el --- debug functions for yasnippet -*- lexical-binding: t -*-
|
||||
|
||||
;; Copyright (C) 2010-2025 Free Software Foundation, Inc.
|
||||
;; Copyright (C) 2010, 2013, 2014, 2017 Free Software Foundation, Inc.
|
||||
|
||||
;; Author: João Távora
|
||||
;; Keywords: emulations, convenience
|
||||
@ -36,26 +36,15 @@
|
||||
(file-name-directory (or load-file-name buffer-file-name))
|
||||
"Directory that yasnippet was loaded from.")
|
||||
|
||||
(require 'yasnippet (if (boundp 'yas--loaddir)
|
||||
;; Don't require '-L <path>' when debugging.
|
||||
(expand-file-name "yasnippet" yas--loaddir)))
|
||||
(require 'yasnippet (expand-file-name "yasnippet" yas--loaddir))
|
||||
(require 'cl-lib)
|
||||
(require 'color nil t)
|
||||
(require 'edebug)
|
||||
(eval-when-compile
|
||||
(require 'subr-x nil t)
|
||||
(cond ((fboundp 'when-let*) nil) ; Introduced in 26.
|
||||
((fboundp 'when-let) ; Introduced in 25.1,
|
||||
(defalias 'when-let* 'when-let)) ; deprecated in 26.
|
||||
(t (defmacro when-let* (key-vals &rest body)
|
||||
(unless (require 'subr-x nil t)
|
||||
(defmacro when-let (key-val &rest body)
|
||||
(declare (indent 1) (debug ((symbolp form) body)))
|
||||
(let ((key-val (pop key-vals)))
|
||||
(if key-val
|
||||
`(let ((,(car key-val) ,(cadr key-val)))
|
||||
(if ,(car key-val)
|
||||
(when-let* ,key-vals
|
||||
,@body)))
|
||||
`(progn ,@body)))))))
|
||||
(when ,(car key-val)
|
||||
,@body)))))
|
||||
|
||||
(defvar yas-debug-live-indicators
|
||||
(make-hash-table :test #'eq))
|
||||
@ -76,7 +65,7 @@
|
||||
(setq beg (setq end (marker-position location)))
|
||||
(setq beg (yas-debug-ov-fom-start location)
|
||||
end (yas-debug-ov-fom-end location)))
|
||||
(or (when-let* ((color-ov (gethash location yas-debug-live-indicators)))
|
||||
(or (when-let (color-ov (gethash location yas-debug-live-indicators))
|
||||
(if (and beg end) (move-overlay (cdr color-ov) beg end)
|
||||
(delete-overlay (cdr color-ov)))
|
||||
color-ov)
|
||||
@ -84,9 +73,7 @@
|
||||
(color
|
||||
(cl-loop with best-color = nil with max-dist = -1
|
||||
for color = (format "#%06X" (random #x1000000))
|
||||
for comp = (if (fboundp 'color-complement)
|
||||
(apply #'color-rgb-to-hex (color-complement color))
|
||||
color)
|
||||
for comp = (apply #'color-rgb-to-hex (color-complement color))
|
||||
if (< (color-distance color (face-foreground 'default))
|
||||
(color-distance comp (face-foreground 'default)))
|
||||
do (setq color comp)
|
||||
@ -104,7 +91,8 @@
|
||||
(puthash location (cons color ov) yas-debug-live-indicators)))))
|
||||
|
||||
(defun yas-debug-live-marker (marker)
|
||||
(let* ((color-ov (yas-debug-get-live-indicator marker))
|
||||
(let* ((buffer (current-buffer))
|
||||
(color-ov (yas-debug-get-live-indicator marker))
|
||||
(color (car color-ov))
|
||||
(ov (cdr color-ov))
|
||||
(decorator (overlay-get ov 'before-string))
|
||||
@ -112,7 +100,7 @@
|
||||
(if (markerp marker)
|
||||
(propertize str
|
||||
'cursor-sensor-functions
|
||||
`(,(lambda (_window _oldpos dir)
|
||||
`(,(lambda (window _oldpos dir)
|
||||
(overlay-put
|
||||
ov 'before-string
|
||||
(propertize decorator
|
||||
@ -138,12 +126,10 @@
|
||||
(decorator-end (overlay-get ov 'after-string))
|
||||
(beg (yas-debug-ov-fom-start range))
|
||||
(end (yas-debug-ov-fom-end range)))
|
||||
(if (and beg end (or (overlayp range)
|
||||
(and (not (integerp beg))
|
||||
(not (integerp end)))))
|
||||
(if (and beg end (not (integerp beg)) (not (integerp end)))
|
||||
(propertize (format "from %d to %d" (+ beg) (+ end))
|
||||
'cursor-sensor-functions
|
||||
`(,(lambda (_window _oldpos dir)
|
||||
`(,(lambda (window _oldpos dir)
|
||||
(let ((face (if (eq dir 'entered)
|
||||
'mode-line-highlight color)))
|
||||
(overlay-put ov 'before-string
|
||||
@ -154,7 +140,7 @@
|
||||
"<dead>")))
|
||||
|
||||
(defmacro yas-debug-with-tracebuf (outbuf &rest body)
|
||||
(declare (indent 1) (debug (sexp body)))
|
||||
(declare (indent 1))
|
||||
(let ((tracebuf-var (make-symbol "tracebuf")))
|
||||
`(let ((,tracebuf-var (or ,outbuf (get-buffer-create "*YASnippet trace*"))))
|
||||
(unless (eq ,tracebuf-var (current-buffer))
|
||||
@ -175,34 +161,30 @@
|
||||
|
||||
(defun yas-debug-snippet (snippet &optional outbuf)
|
||||
(yas-debug-with-tracebuf outbuf
|
||||
(when-let* ((overlay (yas--snippet-control-overlay snippet)))
|
||||
(when-let (overlay (yas--snippet-control-overlay snippet))
|
||||
(printf "\tsid: %d control overlay %s\n"
|
||||
(yas--snippet-id snippet)
|
||||
(yas-debug-live-range overlay)))
|
||||
(when-let* ((active-field (yas--snippet-active-field snippet)))
|
||||
(when-let (active-field (yas--snippet-active-field snippet))
|
||||
(unless (consp (yas--field-start active-field))
|
||||
(printf "\tactive field: #%d %s %s covering \"%s\"\n"
|
||||
(or (yas--field-number active-field) -1)
|
||||
(yas--field-number active-field)
|
||||
(if (yas--field-modified-p active-field) "**" "--")
|
||||
(yas-debug-live-range active-field)
|
||||
(buffer-substring-no-properties (yas--field-start active-field) (yas--field-end active-field)))))
|
||||
(when-let* ((exit (yas--snippet-exit snippet)))
|
||||
(when-let (exit (yas--snippet-exit snippet))
|
||||
(printf "\tsnippet-exit: %s next: %s\n"
|
||||
(yas-debug-live-marker (yas--exit-marker exit))
|
||||
(yas--exit-next exit)))
|
||||
(dolist (field (yas--snippet-fields snippet))
|
||||
(unless (consp (yas--field-start field))
|
||||
(printf "\tfield: %d %s %s covering \"%s\" next: %s%s\n"
|
||||
(or (yas--field-number field) -1)
|
||||
(yas--field-number field)
|
||||
(if (yas--field-modified-p field) "**" "--")
|
||||
(yas-debug-live-range field)
|
||||
(buffer-substring-no-properties (yas--field-start field) (yas--field-end field))
|
||||
(yas--debug-format-fom-concise (yas--field-next field))
|
||||
(if (yas--field-parent-field field)
|
||||
(format " parent: %s"
|
||||
(yas--debug-format-fom-concise
|
||||
(yas--field-parent-field field)))
|
||||
"")))
|
||||
(if (yas--field-parent-field field) "(has a parent)" "")))
|
||||
(dolist (mirror (yas--field-mirrors field))
|
||||
(unless (consp (yas--mirror-start mirror))
|
||||
(printf "\t\tmirror: %s covering \"%s\" next: %s\n"
|
||||
@ -211,9 +193,7 @@
|
||||
(yas--debug-format-fom-concise (yas--mirror-next mirror))))))))
|
||||
|
||||
(defvar yas-debug-target-buffer nil)
|
||||
(defvar yas-debug-target-snippets nil nil)
|
||||
(make-variable-buffer-local 'yas-debug-target-snippets)
|
||||
|
||||
(defvar-local yas-debug-target-snippets nil)
|
||||
(defvar yas-debug-undo nil)
|
||||
|
||||
(defun yas-toggle-debug-undo (value)
|
||||
@ -221,26 +201,18 @@
|
||||
(setq yas-debug-undo value)
|
||||
(yas--message 3 "debug undo %sabled" (if yas-debug-undo "en" "dis")))
|
||||
|
||||
(defun yas-debug--target-snippet (snippet)
|
||||
(defadvice yas--snippet-parse-create (before yas-debug-target-snippet (snippet))
|
||||
(add-to-list 'yas-debug-target-snippets snippet))
|
||||
|
||||
(defun yas-debug--untarget-snippet (snippet)
|
||||
(defadvice yas--commit-snippet (after yas-debug-untarget-snippet (snippet))
|
||||
(setq yas-debug-target-snippets
|
||||
(remq snippet yas-debug-target-snippets))
|
||||
(maphash (lambda (_k color-ov)
|
||||
(maphash (lambda (k color-ov)
|
||||
(delete-overlay (cdr color-ov)))
|
||||
yas-debug-live-indicators)
|
||||
(clrhash yas-debug-live-indicators))
|
||||
|
||||
(defun yas-debug-snippets (&optional outbuf hook)
|
||||
"Print debug information on active snippets to buffer OUTBUF.
|
||||
If OUTBUF is nil, use a buffer named \"*YASsnippet trace*\".
|
||||
If HOOK is non-nil, install `yas-debug-snippets' in
|
||||
`post-command-hook' to update the information on every command
|
||||
after this one. If it is `snippet-navigation' then install hook
|
||||
buffer-locally, otherwise install it globally. If HOOK is
|
||||
`edebug-create', also instrument the function
|
||||
`yas--snippet-parse-create' with `edebug' and show its source."
|
||||
(interactive (list nil t))
|
||||
(condition-case err
|
||||
(yas-debug-with-tracebuf outbuf
|
||||
@ -251,8 +223,6 @@ buffer-locally, otherwise install it globally. If HOOK is
|
||||
(setq yas-debug-target-snippets
|
||||
(cl-delete-if-not #'yas--snippet-p yas-debug-target-snippets)))
|
||||
(let ((yas-debug-recently-live-indicators nil))
|
||||
(printf "(length yas--snippets-snippets) => %d\n"
|
||||
(length yas--active-snippets))
|
||||
(dolist (snippet (or yas-debug-target-snippets
|
||||
(yas-active-snippets)))
|
||||
(printf "snippet %d\n" (yas--snippet-id snippet))
|
||||
@ -268,14 +238,16 @@ buffer-locally, otherwise install it globally. If HOOK is
|
||||
do (printf "%S\n" undo-elem))))
|
||||
(when hook
|
||||
(setq yas-debug-target-buffer (current-buffer))
|
||||
(advice-add 'yas--snippet-parse-create :before #'yas-debug--target-snippet)
|
||||
(advice-add 'yas--commit-snippet :after #'yas-debug--untarget-snippet)
|
||||
(add-hook 'post-command-hook #'yas-debug-snippets
|
||||
nil (eq hook 'snippet-navigation))
|
||||
(ad-enable-advice 'yas--snippet-parse-create 'before 'yas-debug-target-snippet)
|
||||
(ad-activate 'yas--snippet-parse-create)
|
||||
(ad-enable-advice 'yas--commit-snippet 'after 'yas-debug-untarget-snippet)
|
||||
(ad-activate 'yas--commit-snippet)
|
||||
(add-hook 'post-command-hook #'yas-debug-snippets)
|
||||
;; Window management is slapped together, it does what I
|
||||
;; want when the caller has a single window open. Good
|
||||
;; enough for now.
|
||||
(when (eq hook 'edebug-create)
|
||||
(when (eq hook 'create)
|
||||
(require 'edebug)
|
||||
(edebug-instrument-function 'yas--snippet-parse-create)
|
||||
(let ((buf-point (find-function-noselect 'yas--snippet-parse-create)))
|
||||
(with-current-buffer (car buf-point)
|
||||
@ -286,6 +258,36 @@ buffer-locally, otherwise install it globally. If HOOK is
|
||||
(defun yas-debug-snippet-create ()
|
||||
(yas-debug-snippets nil 'create))
|
||||
|
||||
(defun yas-debug-snippet-vars ()
|
||||
"Debug snippets, fields, mirrors and the `buffer-undo-list'."
|
||||
(interactive)
|
||||
(yas-debug-with-tracebuf ()
|
||||
(printf "Interesting YASnippet vars: \n\n")
|
||||
|
||||
(printf "\nPost command hook: %s\n" post-command-hook)
|
||||
(printf "\nPre command hook: %s\n" pre-command-hook)
|
||||
|
||||
(printf "%s live snippets in total\n" (length (yas-active-snippets 'all-snippets)))
|
||||
(printf "%s overlays in buffer:\n\n" (length (overlays-in (point-min) (point-max))))
|
||||
(printf "%s live snippets at point:\n\n" (length (yas-active-snippets)))
|
||||
|
||||
(yas-debug-snippets outbuf)
|
||||
|
||||
(printf "\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)
|
||||
(printf "Undpolist has %s elements. First 10 elements follow:\n"
|
||||
(length buffer-undo-list))
|
||||
(let ((first-ten (cl-subseq buffer-undo-list 0
|
||||
(min 19 (length buffer-undo-list)))))
|
||||
(dolist (undo-elem first-ten)
|
||||
(printf "%2s: %s\n" (cl-position undo-elem first-ten)
|
||||
(truncate-string-to-width (format "%s" undo-elem) 70)))))
|
||||
(display-buffer tracebuf)))
|
||||
|
||||
(defun yas--debug-format-fom-concise (fom)
|
||||
(when fom
|
||||
(cond ((yas--field-p fom)
|
||||
@ -306,22 +308,23 @@ buffer-locally, otherwise install it globally. If HOOK is
|
||||
(setq yas-verbosity 99)
|
||||
(setq yas-triggers-in-field t)
|
||||
(setq debug-on-error t)
|
||||
(let* ((snippet-mode 'fundamental-mode)
|
||||
(let* ((snippet-file nil)
|
||||
(snippet-mode 'fundamental-mode)
|
||||
(snippet-key nil))
|
||||
(unless options
|
||||
(setq options (cl-loop for opt = (pop command-line-args-left)
|
||||
while (and opt (not (equal opt "--"))
|
||||
(string-prefix-p "-" opt))
|
||||
collect opt)))
|
||||
(when-let* ((mode (cl-member "-M:" options :test #'string-prefix-p)))
|
||||
(when-let (mode (cl-member "-M:" options :test #'string-prefix-p))
|
||||
(setq snippet-mode (intern (concat (substring (car mode) 3) "-mode"))))
|
||||
(when-let* ((mode (cl-member "-M." options :test #'string-prefix-p)))
|
||||
(when-let (mode (cl-member "-M." options :test #'string-prefix-p))
|
||||
(setq snippet-mode
|
||||
(cdr (cl-assoc (substring (car mode) 2) auto-mode-alist
|
||||
:test (lambda (ext regexp) (string-match-p regexp ext))))))
|
||||
(switch-to-buffer (get-buffer-create "*yas test*"))
|
||||
(funcall snippet-mode)
|
||||
(when-let* ((snippet-file (cl-member "-S:" options :test #'string-prefix-p)))
|
||||
(when-let (snippet-file (cl-member "-S:" options :test #'string-prefix-p))
|
||||
(setq snippet-file (substring (car snippet-file) 3))
|
||||
(if (file-exists-p snippet-file)
|
||||
(with-temp-buffer
|
||||
@ -336,19 +339,26 @@ buffer-locally, otherwise install it globally. If HOOK is
|
||||
(error "No such snippet `%s'" snippet-file)))))
|
||||
(display-buffer (find-file-noselect
|
||||
(expand-file-name "yasnippet.el" yas--loaddir)))
|
||||
(when-let* ((verbosity (car (or (member "-v" options) (member "-vv" options)))))
|
||||
(when-let (verbosity (car (or (member "-v" options) (member "-vv" options))))
|
||||
(set-window-buffer
|
||||
(split-window) (yas-debug-snippets
|
||||
nil (if (equal verbosity "-vv") 'edebug-create t))))
|
||||
nil (if (equal verbosity "-vv") 'create t))))
|
||||
(yas-minor-mode +1)
|
||||
(when snippet-key (insert snippet-key))))
|
||||
|
||||
(when command-line-args-left
|
||||
(yas-debug-process-command-line))
|
||||
|
||||
(defun yas-exterminate-package ()
|
||||
(interactive)
|
||||
(yas-global-mode -1)
|
||||
(yas-minor-mode -1)
|
||||
(mapatoms #'(lambda (atom)
|
||||
(when (string-match "yas[-/]" (symbol-name atom))
|
||||
(unintern atom obarray)))))
|
||||
|
||||
(provide 'yasnippet-debug)
|
||||
;; Local Variables:
|
||||
;; indent-tabs-mode: nil
|
||||
;; autoload-compute-prefixes: nil
|
||||
;; End:
|
||||
;;; yasnippet-debug.el ends here
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
1590
yasnippet.el
1590
yasnippet.el
File diff suppressed because it is too large
Load Diff
Loading…
x
Reference in New Issue
Block a user