1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
#!/usr/bin/env python
# encoding: utf-8
"""Parsing of snippet files."""
from collections import defaultdict
import glob
import os
from UltiSnips import vim_helper
from UltiSnips.snippet.definition import UltiSnipsSnippetDefinition
from UltiSnips.snippet.source.file.base import SnippetFileSource
from UltiSnips.snippet.source.file.common import (
handle_extends,
handle_action,
handle_context,
)
from UltiSnips.text import LineIterator, head_tail
def find_snippet_files(ft, directory):
"""Returns all matching snippet files for 'ft' in 'directory'."""
patterns = ["%s.snippets", "%s_*.snippets", os.path.join("%s", "*")]
ret = set()
directory = os.path.expanduser(directory)
for pattern in patterns:
for fn in glob.glob(os.path.join(directory, pattern % ft)):
ret.add(os.path.realpath(fn))
return ret
def _find_all_snippet_directories():
"""Returns a list of the absolute path of all snippet directories to
search."""
if vim_helper.eval("exists('b:UltiSnipsSnippetDirectories')") == "1":
snippet_dirs = vim_helper.eval("b:UltiSnipsSnippetDirectories")
else:
snippet_dirs = vim_helper.eval("g:UltiSnipsSnippetDirectories")
if len(snippet_dirs) == 1:
# To reduce confusion and increase consistency with
# `UltiSnipsSnippetsDir`, we expand ~ here too.
full_path = os.path.expanduser(snippet_dirs[0])
if os.path.isabs(full_path):
return [full_path]
all_dirs = []
check_dirs = vim_helper.eval("&runtimepath").split(",")
for rtp in check_dirs:
for snippet_dir in snippet_dirs:
if snippet_dir == "snippets":
raise RuntimeError(
"You have 'snippets' in UltiSnipsSnippetDirectories. This "
"directory is reserved for snipMate snippets. Use another "
"directory for UltiSnips snippets."
)
pth = os.path.realpath(os.path.expanduser(os.path.join(rtp, snippet_dir)))
if os.path.isdir(pth):
all_dirs.append(pth)
return all_dirs
def find_all_snippet_files(ft):
"""Returns all snippet files matching 'ft' in the given runtime path
directory."""
patterns = ["%s.snippets", "%s_*.snippets", os.path.join("%s", "*")]
ret = set()
for directory in _find_all_snippet_directories():
for pattern in patterns:
for fn in glob.glob(os.path.join(directory, pattern % ft)):
ret.add(fn)
return ret
def _handle_snippet_or_global(
filename, line, lines, python_globals, priority, pre_expand, context
):
"""Parses the snippet that begins at the current line."""
start_line_index = lines.line_index
descr = ""
opts = ""
# Ensure this is a snippet
snip = line.split()[0]
# Get and strip options if they exist
remain = line[len(snip) :].strip()
words = remain.split()
if len(words) > 2:
# second to last word ends with a quote
if '"' not in words[-1] and words[-2][-1] == '"':
opts = words[-1]
remain = remain[: -len(opts) - 1].rstrip()
if "e" in opts and not context:
left = remain[:-1].rfind('"')
if left != -1 and left != 0:
context, remain = remain[left:].strip('"'), remain[:left]
# Get and strip description if it exists
remain = remain.strip()
if len(remain.split()) > 1 and remain[-1] == '"':
left = remain[:-1].rfind('"')
if left != -1 and left != 0:
descr, remain = remain[left:], remain[:left]
# The rest is the trigger
trig = remain.strip()
if len(trig.split()) > 1 or "r" in opts:
if trig[0] != trig[-1]:
return "error", ("Invalid multiword trigger: '%s'" % trig, lines.line_index)
trig = trig[1:-1]
end = "end" + snip
content = ""
found_end = False
for line in lines:
if line.rstrip() == end:
content = content[:-1] # Chomp the last newline
found_end = True
break
content += line
if not found_end:
return "error", ("Missing 'endsnippet' for %r" % trig, lines.line_index)
if snip == "global":
python_globals[trig].append(content)
elif snip == "snippet":
definition = UltiSnipsSnippetDefinition(
priority,
trig,
content,
descr,
opts,
python_globals,
"%s:%i" % (filename, start_line_index),
context,
pre_expand,
)
return "snippet", (definition,)
else:
return "error", ("Invalid snippet type: '%s'" % snip, lines.line_index)
def _parse_snippets_file(data, filename):
"""Parse 'data' assuming it is a snippet file.
Yields events in the file.
"""
python_globals = defaultdict(list)
lines = LineIterator(data)
current_priority = 0
actions = {}
context = None
for line in lines:
if not line.strip():
continue
head, tail = head_tail(line)
if head in ("snippet", "global"):
snippet = _handle_snippet_or_global(
filename,
line,
lines,
python_globals,
current_priority,
actions,
context,
)
actions = {}
context = None
if snippet is not None:
yield snippet
elif head == "extends":
yield handle_extends(tail, lines.line_index)
elif head == "clearsnippets":
yield "clearsnippets", (current_priority, tail.split())
elif head == "context":
head, context, = handle_context(tail, lines.line_index)
if head == "error":
yield (head, tail)
elif head == "priority":
try:
current_priority = int(tail.split()[0])
except (ValueError, IndexError):
yield "error", ("Invalid priority %r" % tail, lines.line_index)
elif head in ["pre_expand", "post_expand", "post_jump"]:
head, tail = handle_action(head, tail, lines.line_index)
if head == "error":
yield (head, tail)
else:
actions[head], = tail
elif head and not head.startswith("#"):
yield "error", ("Invalid line %r" % line.rstrip(), lines.line_index)
class UltiSnipsFileSource(SnippetFileSource):
"""Manages all snippets definitions found in rtp for ultisnips."""
def _get_all_snippet_files_for(self, ft):
return find_all_snippet_files(ft)
def _parse_snippet_file(self, filedata, filename):
for event, data in _parse_snippets_file(filedata, filename):
yield event, data
|
