UltiSnips/plugin/PySnipEmu.py

810 lines
23 KiB
Python

#!/usr/bin/env python
# encoding: utf-8
import vim
import string
import re
import os
def debug(s):
f = open("/tmp/file.txt","a")
f.write(s+'\n')
f.close()
class Buffer(object):
def _replace(self, start, end, content, first_line, last_line):
text = content[:]
if len(text) == 1:
arr = [ first_line + text[0] + last_line ]
new_end = start + Position(0,len(text[0]))
else:
arr = [ first_line + text[0] ] + \
text[1:-1] + \
[ text[-1] + last_line ]
new_end = Position(start.line + len(text)-1, len(text[-1]))
self[start.line:end.line+1] = arr
return new_end
class TextBuffer(Buffer):
def __init__(self, textblock):
# We do not use splitlines() here because it handles cases like 'text\n'
# differently than we want it here
self._lines = textblock.replace('\r','').split('\n')
def calc_end(self, start):
text = self._lines[:]
if len(text) == 1:
new_end = start + Position(0,len(text[0]))
else:
new_end = Position(start.line + len(text)-1, len(text[-1]))
return new_end
def replace_text( self, start, end, content ):
first_line = self[start.line][:start.col]
last_line = self[end.line][end.col:]
return self._replace( start, end, content, first_line, last_line)
def __getitem__(self, a):
return self._lines.__getitem__(a)
def __setitem__(self, a, b):
return self._lines.__setitem__(a,b)
def __repr__(self):
return repr('\n'.join(self._lines))
def __str__(self):
return '\n'.join(self._lines)
class VimBuffer(Buffer):
def __init__(self, before, after):
self._bf = before
self._af = after
def __getitem__(self, a):
return vim.current.buffer[a]
def __setitem__(self, a, b):
if isinstance(a,slice):
vim.current.buffer[a.start:a.stop] = b
else:
vim.current.buffer[a] = b
def __repr__(self):
return "VimBuffer()"
def replace_text( self, start, end, content ):
return self._replace( start, end, content, self._bf, self._af)
class Position(object):
def __init__(self, line, col):
self.line = line
self.col = col
def col():
def fget(self):
return self._col
def fset(self, value):
self._col = value
return locals()
col = property(**col())
def line():
doc = "Zero base line numbers"
def fget(self):
return self._line
def fset(self, value):
self._line = value
return locals()
line = property(**line())
def __add__(self,pos):
if not isinstance(pos,Position):
raise TypeError("unsupported operand type(s) for +: " \
"'Position' and %s" % type(pos))
return Position(self.line + pos.line, self.col + pos.col)
def __sub__(self,pos):
if not isinstance(pos,Position):
raise TypeError("unsupported operand type(s) for +: " \
"'Position' and %s" % type(pos))
return Position(self.line - pos.line, self.col - pos.col)
def __repr__(self):
return "(%i,%i)" % (self._line, self._col)
class TextObject(object):
"""
This base class represents any object in the text
that has a span in any ways
"""
# A simple tabstop with default value
_TABSTOP = re.compile(r'''\${(\d+)(?::(.*?))?}''')
# A mirror or a tabstop without default value.
_MIRROR_OR_TS = re.compile(r'\$(\d+)')
# A mirror or a tabstop without default value.
_TRANSFORMATION = re.compile(r'\${(\d+)/(.*?)/(.*?)/([a-zA-z]*)}')
def __init__(self, parent, start, end, initial_text):
self._start = start
self._end = end
self._parent = parent
self._children = []
self._tabstops = {}
if parent is not None:
parent.add_child(self)
self._has_parsed = False
self._current_text = initial_text
def __cmp__(self, other):
s = self._start.line, self._start.col
o = other._start.line, other._start.col
return cmp(s, o)
def _do_update(self):
pass
def update(self, change_buffer):
if not self._has_parsed:
self._current_text = TextBuffer(self._parse(self._current_text))
for idx,c in enumerate(self._children):
oldend = Position(c.end.line, c.end.col)
moved_lines, moved_cols = c.update(self._current_text)
self._move_textobjects_behind(c.start, oldend, moved_lines,
moved_cols, idx)
self._do_update()
new_end = change_buffer.replace_text(self.start, self.end,
self._current_text)
moved_lines = new_end.line - self._end.line
moved_cols = new_end.col - self._end.col
self._end = new_end
return moved_lines, moved_cols
def _move_textobjects_behind(self, start, end, lines, cols, obj_idx):
if lines == 0 and cols == 0:
return
for idx,m in enumerate(self._children[obj_idx+1:]):
delta_lines = 0
delta_cols_begin = 0
delta_cols_end = 0
if m.start.line > end.line:
delta_lines = lines
elif m.start.line == end.line:
if m.start.col >= end.col:
if lines:
delta_lines = lines
delta_cols_begin = cols
if m.start.line == m.end.line:
delta_cols_end = cols
m.start.line += delta_lines
m.end.line += delta_lines
m.start.col += delta_cols_begin
m.end.col += delta_cols_end
def _get_start_end(self, val, start_pos, end_pos):
def _get_pos(s, pos):
line_idx = s[:pos].count('\n')
line_start = s[:pos].rfind('\n') + 1
start_in_line = pos - line_start
return Position(line_idx, start_in_line)
return _get_pos(val, start_pos), _get_pos(val, end_pos)
def _handle_tabstop(self, m, val):
no = int(m.group(1))
def_text = m.group(2)
if def_text is None:
def_text = ""
start_pos, end_pos = m.span()
start, end = self._get_start_end(val,start_pos,end_pos)
ts = TabStop(self, start, end, def_text)
self.add_tabstop(no,ts)
def _get_tabstop(self,no):
if no in self._tabstops:
return self._tabstops[no]
if self._parent:
return self._parent._get_tabstop(no)
def _handle_ts_or_mirror(self, m, val):
no = int(m.group(1))
start_pos, end_pos = m.span()
start, end = self._get_start_end(val,start_pos,end_pos)
ts = self._get_tabstop(no)
if ts is not None:
Mirror(self, ts, start, end)
else:
ts = TabStop(self, start, end)
self.add_tabstop(no,ts)
def _handle_transformation(self, m, val):
no = int(m.group(1))
search = m.group(2)
replace = m.group(3)
options = m.group(4)
start_pos, end_pos = m.span()
start, end = self._get_start_end(val,start_pos,end_pos)
ts = self._get_tabstop(no)
# TODO: This is so ugly
if ts is None:
Transformation(self, no, start, end, search, replace, options)
else:
Transformation(self, no, start, end, search, replace, options)
def add_tabstop(self,no, ts):
self._tabstops[no] = ts
def _parse(self, val):
self._has_parsed = True
if not len(val):
return val
for m in self._TABSTOP.finditer(val):
self._handle_tabstop(m,val)
# Replace the whole definition with spaces
s, e = m.span()
val = val[:s] + (e-s)*" " + val[e:]
for m in self._TRANSFORMATION.finditer(val):
self._handle_transformation(m,val)
# Replace the whole definition with spaces
s, e = m.span()
val = val[:s] + (e-s)*" " + val[e:]
for m in self._MIRROR_OR_TS.finditer(val):
self._handle_ts_or_mirror(m,val)
# Replace the whole definition with spaces
s, e = m.span()
val = val[:s] + (e-s)*" " + val[e:]
return val
def add_child(self,c):
self._children.append(c)
self._children.sort()
def parent():
doc = "The parent TextObject this TextObject resides in"
def fget(self):
return self._parent
def fset(self, value):
self._parent = value
return locals()
parent = property(**parent())
def start(self):
return self._start
start = property(start)
def end(self):
return self._end
end = property(end)
class ChangeableText(TextObject):
def __init__(self, parent, start, end, initial = ""):
TextObject.__init__(self, parent, start, end, initial)
def _set_text(self, text):
self._current_text = TextBuffer(text)
# Now, we can have no more childen
self._children = []
def current_text():
def fget(self):
return str(self._current_text)
def fset(self, text):
self._set_text(text)
return locals()
current_text = property(**current_text())
class Mirror(ChangeableText):
"""
A Mirror object mirrors a TabStop that is, text is repeated here
"""
def __init__(self, parent, ts, start, end):
ChangeableText.__init__(self, parent, start, end)
self._ts = ts
def _do_update(self):
self.current_text = self._ts.current_text
def __repr__(self):
return "Mirror(%s -> %s)" % (self._start, self._end)
class CleverReplace(object):
"""
This class mimics TextMates replace syntax
"""
_DOLLAR = re.compile(r"\$(\d+)", re.DOTALL)
_SIMPLE_CASEFOLDINGS = re.compile(r"\\([ul].)", re.DOTALL)
_LONG_CASEFOLDINGS = re.compile(r"\\([UL].*?)\\E", re.DOTALL)
_CONDITIONAL = re.compile(r"\(\?(\d+):(.*?)(?<!\\)\)", re.DOTALL)
_UNESCAPE = re.compile(r'\\[^ntrab]')
def __init__(self, s):
self._s = s
def _scase_folding(self, m):
if m.group(1)[0] == 'u':
return m.group(1)[-1].upper()
else:
return m.group(1)[-1].lower()
def _lcase_folding(self, m):
if m.group(1)[0] == 'U':
return m.group(1)[1:].upper()
else:
return m.group(1)[1:].lower()
def _unescape(self, v):
return self._UNESCAPE.subn(lambda m: m.group(0)[-1], v)[0]
def replace(self, match):
start, end = match.span()
tv = self._s
# Replace all $? with capture groups
tv = self._DOLLAR.subn(lambda m: match.group(int(m.group(1))), tv)[0]
def _conditional(m):
args = m.group(2).split(':')
# TODO: the returned string should be checked for conditionals
if match.group(int(m.group(1))):
return self._unescape(args[0])
elif len(args) > 1:
return self._unescape(args[1])
else:
return ""
# Replace CaseFoldings
tv = self._SIMPLE_CASEFOLDINGS.subn(self._scase_folding, tv)[0]
tv = self._LONG_CASEFOLDINGS.subn(self._lcase_folding, tv)[0]
tv = self._CONDITIONAL.subn(_conditional, tv)[0]
rv = tv.decode("string-escape")
return rv
class Transformation(Mirror):
def __init__(self, parent, ts, start, end, s, r, options):
Mirror.__init__(self, parent, ts, start, end)
flags = 0
self._match_this_many = 1
if options:
if "g" in options:
self._match_this_many = 0
if "i" in options:
flags |= re.IGNORECASE
self._find = re.compile(s, flags)
self._replace = CleverReplace(r)
def _do_update(self):
if isinstance(self._ts,int):
self._ts = self._parent._get_tabstop(self._ts)
t = self._ts.current_text
t = self._find.subn(self._replace.replace, t, self._match_this_many)[0]
self.current_text = t
def __repr__(self):
return "Transformation(%s -> %s)" % (self._start, self._end)
class TabStop(ChangeableText):
"""
This is the most important TextObject. A TabStop is were the cursor
comes to rest when the user taps through the Snippet.
"""
def __init__(self, parent, start, end, default_text = ""):
ChangeableText.__init__(self, parent, start, end, default_text)
def __repr__(self):
return "TabStop(%s -> %s, %s)" % (self._start, self._end,
repr(self._current_text))
def select(self, start):
lineno, col = start.line, start.col
newline = lineno + self._start.line
newcol = self._start.col
if newline == lineno:
newcol += col
vim.current.window.cursor = newline + 1, newcol
if len(self.current_text) == 0:
if newcol == 0:
vim.command(r'call feedkeys("\<Esc>i")')
else:
vim.command(r'call feedkeys("\<Esc>a")')
else:
# Select the word
# Depending on the current mode and position, we
# might need to move escape out of the mode and this
# will move our cursor one left
if newcol != 0 and vim.eval("mode()") == 'i':
move_one_right = "l"
else:
move_one_right = ""
if len(self.current_text) <= 1:
do_select = ""
else:
do_select = "%il" % (len(self.current_text)-1)
vim.command(r'call feedkeys("\<Esc>%sv%s\<c-g>")' %
(move_one_right, do_select))
class SnippetInstance(TextObject):
"""
A Snippet instance is an instance of a Snippet Definition. That is,
when the user expands a snippet, a SnippetInstance is created to
keep track of the corresponding TextObjects. The Snippet itself is
also a TextObject because it has a start an end
"""
def __init__(self, start, end, initial_text, text_before, text_after):
TextObject.__init__(self, None, start, end, initial_text)
self._cts = None
self._tab_selected = False
self._vb = VimBuffer(text_before, text_after)
self._current_text = TextBuffer(self._parse(initial_text))
TextObject.update(self, self._vb)
def tab_selected(self):
return self._tab_selected
tab_selected = property(tab_selected)
def update(self, buf, cur):
TextObject.update(self, buf)
cts = self._tabstops[self._cts]
cursor = self.start + cts.end
if cts.end.line != 0:
cursor.col -= self.start.col
lineno, col = cursor.line, cursor.col
vim.current.window.cursor = lineno +1, col
def has_tabs(self):
return len(self._children) > 0
def select_next_tab(self, backwards = False):
if self._cts == 0:
if not backwards:
return False
if backwards:
cts_bf = self._cts
if self._cts == 0:
self._cts = max(self._tabstops.keys())
else:
self._cts -= 1
if self._cts <= 0:
self._cts = cts_bf
else:
# All tabs handled?
if self._cts is None:
self._cts = 1
else:
self._cts += 1
if self._cts not in self._tabstops:
self._cts = 0
if 0 not in self._tabstops:
return False
ts = self._tabstops[self._cts]
ts.select(self._start)
self._tab_selected = True
return True
def backspace(self,count, previous_cp):
cts = self._tabstops[self._cts]
cts.current_text = cts.current_text[:-count]
self.update(self._vb, previous_cp)
def chars_entered(self, chars, cur):
cts = self._tabstops[self._cts]
if self._tab_selected:
cts.current_text = chars
self._tab_selected = False
else:
cts.current_text += chars
self.update(self._vb, cur)
class Snippet(object):
_INDENT = re.compile(r"^[ \t]*")
def __init__(self,trigger,value, descr):
self._t = trigger
self._v = value
self._d = descr
def description(self):
return self._d
description = property(description)
def trigger(self):
return self._t
trigger = property(trigger)
def launch(self, before, after):
lineno, col = vim.current.window.cursor
start = Position(lineno-1,col - len(self._t))
end = Position(lineno-1,col)
line = vim.current.line
text_before = line[:start.col]
text_after = line[end.col:]
indend = self._INDENT.match(text_before).group(0)
v = self._v
if len(indend):
lines = self._v.splitlines()
v = lines[0] + os.linesep + \
os.linesep.join([ indend + l for l in lines[1:]])
s = SnippetInstance(start, end, v, text_before, text_after)
if s.has_tabs():
s.select_next_tab()
return s
else:
vim.current.window.cursor = s.end.line + 1, s.end.col
class Cursor(object):
def __init__(self):
self._abs_pos = None
self._moved = Position(0,0)
def update_position(self):
line, col = vim.current.window.cursor
line -= 1
abs_pos = Position(line,col)
if self._abs_pos:
self._moved = abs_pos - self._abs_pos
# self._start = abs_pos - self._parent.start
self._abs_pos = abs_pos
def pos(self):
return self._abs_pos
pos = property(pos)
def ppos(self):
if not self.has_moved:
return self.pos
return self.pos - self.moved
ppos = property(ppos)
def moved(self):
return self._moved
moved = property(moved)
def has_moved(self):
return bool(self._moved.line or self._moved.col)
has_moved = property(has_moved)
class SnippetManager(object):
def __init__(self):
self.reset()
self._cursor = Cursor()
def _load_snippets_from(self, ft, fn):
cs = None
cv = ""
cdescr = ""
for line in open(fn):
if line.startswith("#"):
continue
if line.startswith("snippet"):
cs = line.split()[1]
left = line.find('"')
if left != -1:
right = line.rfind('"')
cdescr = line[left+1:right]
continue
if cs != None:
if line.startswith("endsnippet"):
cv = cv[:-1] # Chop the last newline
l = self._snippets[ft].get(cs,[])
l.append(Snippet(cs,cv,cdescr))
self._snippets[ft][cs] = l
cv = ""
cdescr = ""
cs = None
continue
else:
cv += line
def _load_snippets_for(self, ft):
self._snippets[ft] = {}
for p in vim.eval("&runtimepath").split(','):
fn = p + os.path.sep + "PySnippets" + os.path.sep + \
"%s.snippets" % ft
if os.path.exists(fn):
self._load_snippets_from(ft, fn)
def reset(self):
self._snippets = {}
self._current_snippets = []
def add_snippet(self,trigger,value, descr):
if "all" not in self._snippets:
self._snippets["all"] = {}
l = self._snippets["all"].get(trigger,[])
l.append(Snippet(trigger,value, descr))
self._snippets["all"][trigger] = l
def _find_snippets(self, ft, trigger):
snips = self._snippets.get(ft,None)
if not snips:
return []
return snips.get(trigger, [])
def try_expand(self, backwards = False):
ft = vim.eval("&filetype")
if len(ft) and ft not in self._snippets:
self._load_snippets_for(ft)
if "all" not in self._snippets:
self._load_snippets_for("all")
if len(self._current_snippets):
cs = self._current_snippets[-1]
if not cs.select_next_tab(backwards):
# Jump to the end of the snippet and enter insert mode
cs = self._current_snippets[-1]
vim.current.window.cursor = cs.end.line +1, cs.end.col
vim.command(r'call feedkeys("\<Esc>a")')
self._current_snippets.pop()
return True
self._cursor.update_position()
return True
dummy,col = vim.current.window.cursor
if col == 0:
return False
line = vim.current.line
if col > 0 and line[col-1] in string.whitespace:
return False
# Get the word to the left of the current edit position
before,after = line[:col], line[col:]
word = before.split()[-1]
snippets = []
if len(ft):
snippets += self._find_snippets(ft, word)
snippets += self._find_snippets("all", word)
if not len(snippets):
# No snippet found
return False
elif len(snippets) == 1:
snippet, = snippets
else:
display = repr(
[ "%i: %s" % (i+1,s.description) for i,s in
enumerate(snippets)
]
)
rv = vim.eval("inputlist(%s)" % display)
if rv is None:
return True
rv = int(rv)
snippet = snippets[rv-1]
s = snippet.launch(before.rstrip()[:-len(word)], after)
self._cursor.update_position()
if s is not None:
self._current_snippets.append(s)
return True
def cursor_moved(self):
debug("Cursor moved")
self._cursor.update_position()
if len(self._current_snippets) and (self._cursor.has_moved):
if 0 <= self._cursor.moved.line <= 1:
cs = self._current_snippets[-1]
# Detect a carriage return
if self._cursor.moved.col < 0 and self._cursor.moved.line == 1:
# Hack, remove a line in vim, because we are going to
# overwrite the old line range with the new snippet value.
# After the expansion, we put the cursor were the user left
# it. This action should be completely transparent for the
# user
cache_pos = vim.current.window.cursor
del vim.current.buffer[self._cursor.pos.line-1]
cs.chars_entered('\n', self._cursor)
vim.current.window.cursor = cache_pos
elif self._cursor.moved.col < 0: # Some deleting was going on
cs.backspace(-self._cursor.moved.col, self._cursor)
else:
line = vim.current.line
chars = line[self._cursor.pos.col - self._cursor.moved.col:
self._cursor.pos.col]
cs.chars_entered(chars, self._cursor)
self._cursor.update_position()
def entered_insert_mode(self):
if len(self._current_snippets) and \
not self._current_snippets[-1].tab_selected:
self._current_snippets = []
PySnipSnippets = SnippetManager()