mirror of
https://github.com/gryf/pythonhelper.git
synced 2025-12-18 12:00:27 +01:00
Separate vim and pthon scripts
This commit is contained in:
444
plugin/pythonhelper.py
Normal file
444
plugin/pythonhelper.py
Normal file
@@ -0,0 +1,444 @@
|
||||
import re
|
||||
import sys
|
||||
import time
|
||||
import traceback
|
||||
import vim
|
||||
|
||||
|
||||
# global dictionaries of tags and their line numbers, keys are buffer numbers
|
||||
TAGS = {}
|
||||
TAGLINENUMBERS = {}
|
||||
BUFFERTICKS = {}
|
||||
|
||||
|
||||
class PythonTag(object):
|
||||
"""A simple storage class representing a python tag."""
|
||||
# possible tag types
|
||||
TT_CLASS = 0
|
||||
TT_METHOD = 1
|
||||
TT_FUNCTION = 2
|
||||
|
||||
# tag type names
|
||||
TAG_TYPE_NAME = {TT_CLASS: "class",
|
||||
TT_METHOD: "method",
|
||||
TT_FUNCTION: "function"}
|
||||
|
||||
def __init__(self, type, name, fullName, lineNumber, indentLevel):
|
||||
"""
|
||||
Initializes instances of PythonTag().
|
||||
|
||||
Parameters
|
||||
|
||||
type -- tag type
|
||||
|
||||
name -- short tag name
|
||||
|
||||
fullName -- full tag name (in dotted notation)
|
||||
|
||||
lineNumber -- line number on which the tag starts
|
||||
|
||||
indentLevel -- indentation level of the tag
|
||||
"""
|
||||
self.type = type
|
||||
self.name = name
|
||||
self.fullName = fullName
|
||||
self.lineNumber = lineNumber
|
||||
self.indentLevel = indentLevel
|
||||
|
||||
def __str__(self):
|
||||
"""Returns a string representation of the tag."""
|
||||
return "%s (%s) [%s, %u, %u]" % (self.name,
|
||||
PythonTag.TAG_TYPE_NAME[self.type],
|
||||
self.fullName,
|
||||
self.lineNumber,
|
||||
self.indentLevel,)
|
||||
|
||||
__repr__ = __str__
|
||||
|
||||
|
||||
class SimplePythonTagsParser(object):
|
||||
"""Provides a simple Python tag parser."""
|
||||
# how many chars a single tab represents (visually)
|
||||
TABSIZE = 8
|
||||
# regexp used to extract indentation and strip comments
|
||||
COMMENTS_INDENT_RE = re.compile('([ \t]*)([^\n#]*).*')
|
||||
# regexp used to extract a class name
|
||||
CLASS_RE = re.compile('class[ \t]+([^(:]+).*')
|
||||
# regexp used to extract a method or function name
|
||||
METHOD_RE = re.compile('def[ \t]+([^(]+).*')
|
||||
|
||||
def __init__(self, source):
|
||||
"""
|
||||
Initializes instances of SimplePythonTagsParser().
|
||||
|
||||
Parameters
|
||||
|
||||
source -- source for which the tags will be generated. It must
|
||||
be a generator.
|
||||
"""
|
||||
self.source = source
|
||||
|
||||
def getTags(self):
|
||||
"""
|
||||
Determines all the tags for the buffer. Returns a tuple in the format
|
||||
(tagLineNumbers, tags,).
|
||||
"""
|
||||
tagLineNumbers = []
|
||||
tags = {}
|
||||
tagsStack = []
|
||||
|
||||
import itertools
|
||||
# go through all the lines in the source and localize all Python tags
|
||||
# in it
|
||||
for (line, lineNumber) in zip(self.source, itertools.count(1)):
|
||||
|
||||
# extract the line's indentation characters and its content
|
||||
lineMatch = self.COMMENTS_INDENT_RE.match(line)
|
||||
lineContent = lineMatch.group(2)
|
||||
|
||||
# match for the class tag
|
||||
tagMatch = self.CLASS_RE.match(lineContent)
|
||||
|
||||
# if the class tag has been found, store some information on it
|
||||
if (tagMatch):
|
||||
currentTag = self.getPythonTag(tagsStack, lineNumber,
|
||||
lineMatch.group(1),
|
||||
tagMatch.group(1),
|
||||
self.tagClassTypeDecidingMethod)
|
||||
tagLineNumbers.append(lineNumber)
|
||||
tags[lineNumber] = currentTag
|
||||
|
||||
else:
|
||||
# match for the method/function tag
|
||||
tagMatch = self.METHOD_RE.match(lineContent)
|
||||
|
||||
# if the method/function tag has been found, store some
|
||||
# information on it
|
||||
if (tagMatch):
|
||||
currentTag = self.getPythonTag(tagsStack,
|
||||
lineNumber,
|
||||
lineMatch.group(1),
|
||||
tagMatch.group(1),
|
||||
self.tagFunctionTypeDecidingMethod)
|
||||
tagLineNumbers.append(lineNumber)
|
||||
tags[lineNumber] = currentTag
|
||||
|
||||
return (tagLineNumbers, tags,)
|
||||
|
||||
def getParentTag(self, tagsStack):
|
||||
"""
|
||||
Given a tag, returns its parent tag (instance of PythonTag()) from the
|
||||
specified tag list. If no such parent tag exists, returns None.
|
||||
|
||||
Parameters
|
||||
|
||||
tagsStack -- list (stack) of currently open PythonTag() instances
|
||||
"""
|
||||
if (len(tagsStack)):
|
||||
parentTag = tagsStack[-1]
|
||||
else:
|
||||
parentTag = None
|
||||
|
||||
return parentTag
|
||||
|
||||
def computeIndentationLevel(indentChars):
|
||||
"""
|
||||
Computes the indentation level from the specified string.
|
||||
|
||||
Parameters
|
||||
|
||||
indentChars -- white space before any other character on line
|
||||
"""
|
||||
indentLevel = 0
|
||||
|
||||
# compute the indentation level (expand tabs)
|
||||
for char in indentChars:
|
||||
if (char == '\t'):
|
||||
indentLevel += SimplePythonTagsParser.TABSIZE
|
||||
else:
|
||||
indentLevel += 1
|
||||
|
||||
return indentLevel
|
||||
|
||||
computeIndentationLevel = staticmethod(computeIndentationLevel)
|
||||
|
||||
def getPythonTag(self, tagsStack, lineNumber, indentChars, tagName, tagTypeDecidingMethod):
|
||||
"""
|
||||
Returns instance of PythonTag() based on the specified data.
|
||||
|
||||
Parameters
|
||||
|
||||
tagsStack -- list (stack) of tags currently active. Note: Modified
|
||||
in this method!
|
||||
|
||||
lineNumber -- current line number
|
||||
|
||||
indentChars -- characters making up the indentation level of the
|
||||
current tag
|
||||
|
||||
tagName -- short name of the current tag
|
||||
|
||||
tagTypeDecidingMethod -- reference to the method that is called to
|
||||
determine the type of the current tag
|
||||
"""
|
||||
indentLevel = self.computeIndentationLevel(indentChars)
|
||||
parentTag = self.getParentTag(tagsStack)
|
||||
|
||||
# handle enclosed tag
|
||||
while (parentTag):
|
||||
# if the indent level of the parent tag is greater than of the
|
||||
# current tag, use parent tag of the parent tag
|
||||
if (parentTag.indentLevel >= indentLevel):
|
||||
del tagsStack[-1]
|
||||
|
||||
# otherwise we have all information on the current tag and can
|
||||
# return it
|
||||
else:
|
||||
tag = PythonTag(tagTypeDecidingMethod(parentTag.type),
|
||||
tagName, "%s.%s" % (parentTag.fullName,
|
||||
tagName,),
|
||||
lineNumber, indentLevel)
|
||||
|
||||
break
|
||||
|
||||
# use the parent tag of the parent tag
|
||||
parentTag = self.getParentTag(tagsStack)
|
||||
|
||||
# handle a top-indent level tag
|
||||
else:
|
||||
tag = PythonTag(tagTypeDecidingMethod(None), tagName, tagName,
|
||||
lineNumber, indentLevel)
|
||||
|
||||
# add the tag to the list of tags
|
||||
tagsStack.append(tag)
|
||||
|
||||
return tag
|
||||
|
||||
def tagClassTypeDecidingMethod(self, parentTagType):
|
||||
"""
|
||||
Returns tag type of the current tag based on its previous tag (super
|
||||
tag) for classes.
|
||||
|
||||
Parameters
|
||||
|
||||
parentTagType -- type of the enclosing/parent tag
|
||||
"""
|
||||
return PythonTag.TT_CLASS
|
||||
|
||||
def tagFunctionTypeDecidingMethod(self, parentTagType):
|
||||
"""
|
||||
Returns tag type of the current tag based on its previous tag (super
|
||||
tag) for functions/methods.
|
||||
|
||||
Parameters
|
||||
|
||||
parentTagType -- type of the enclosing/parent tag
|
||||
"""
|
||||
if (parentTagType == PythonTag.TT_CLASS):
|
||||
return PythonTag.TT_METHOD
|
||||
else:
|
||||
return PythonTag.TT_FUNCTION
|
||||
|
||||
|
||||
def vimBufferIterator(vimBuffer):
|
||||
for line in vimBuffer:
|
||||
yield line + "\n"
|
||||
|
||||
|
||||
def getNearestLineIndex(row, tagLineNumbers):
|
||||
"""
|
||||
Returns the index of 'tagLineNumbers' that contains the line nearest to
|
||||
the specified cursor row.
|
||||
|
||||
Parameters
|
||||
|
||||
row -- current cursor row
|
||||
|
||||
tagLineNumbers -- list of tags' line numbers (ie. their position)
|
||||
"""
|
||||
nearestLineNumber = -1
|
||||
nearestLineIndex = -1
|
||||
|
||||
# go through all tag line numbers and find the one nearest to the
|
||||
# specified row
|
||||
for lineIndex, lineNumber in enumerate(tagLineNumbers):
|
||||
# if the current line is nearer the current cursor position, take it
|
||||
if (nearestLineNumber < lineNumber <= row):
|
||||
nearestLineNumber = lineNumber
|
||||
nearestLineIndex = lineIndex
|
||||
|
||||
# if we've come past the current cursor position, end the search
|
||||
if (lineNumber >= row):
|
||||
break
|
||||
|
||||
return nearestLineIndex
|
||||
|
||||
|
||||
def getTags(bufferNumber, changedTick):
|
||||
"""
|
||||
Reads the tags for the buffer specified by the number. Returns a tuple
|
||||
of the format (taglinenumber[buffer], tags[buffer],).
|
||||
|
||||
Parameters
|
||||
|
||||
bufferNumber -- number of the current buffer
|
||||
|
||||
changedTick -- always-increasing number used to indicate that the
|
||||
buffer has been modified since the last time
|
||||
"""
|
||||
global TAGLINENUMBERS, TAGS, BUFFERTICKS
|
||||
|
||||
# return immediately if there's no need to update the tags
|
||||
if (BUFFERTICKS.get(bufferNumber, None) == changedTick):
|
||||
return (TAGLINENUMBERS[bufferNumber], TAGS[bufferNumber])
|
||||
|
||||
# get the tags
|
||||
simpleTagsParser = SimplePythonTagsParser(vimBufferIterator(vim.current.buffer))
|
||||
tagLineNumbers, tags = simpleTagsParser.getTags()
|
||||
|
||||
# update the global variables
|
||||
TAGS[bufferNumber] = tags
|
||||
TAGLINENUMBERS[bufferNumber] = tagLineNumbers
|
||||
BUFFERTICKS[bufferNumber] = changedTick
|
||||
|
||||
return (tagLineNumbers, tags)
|
||||
|
||||
|
||||
def findTag(bufferNumber, changedTick):
|
||||
"""
|
||||
Tries to find the best tag for the current cursor position.
|
||||
|
||||
Parameters
|
||||
|
||||
bufferNumber -- number of the current buffer
|
||||
|
||||
changedTick -- always-increasing number used to indicate that the
|
||||
buffer has been modified since the last time
|
||||
"""
|
||||
try:
|
||||
# get the tag data for the current buffer
|
||||
tagLineNumbers, tags = getTags(bufferNumber, changedTick)
|
||||
|
||||
# link to Vim's internal data
|
||||
currentBuffer = vim.current.buffer
|
||||
currentWindow = vim.current.window
|
||||
row, col = currentWindow.cursor
|
||||
|
||||
# get the index of the nearest line
|
||||
nearestLineIndex = getNearestLineIndex(row, tagLineNumbers)
|
||||
|
||||
# if a line has been found, find out if the tag is correct {{{
|
||||
# E.g. the cursor might be below the last tag, but in code that has
|
||||
# nothing to do with the tag, which we know because the line is
|
||||
# indented differently. In such a case no applicable tag has been
|
||||
# found.
|
||||
while (nearestLineIndex > -1):
|
||||
# get the line number of the nearest tag
|
||||
nearestLineNumber = tagLineNumbers[nearestLineIndex]
|
||||
|
||||
# walk through all the lines in the range (nearestTagLine,
|
||||
# cursorRow)
|
||||
for lineNumber in xrange(nearestLineNumber + 1, row):
|
||||
# get the current line
|
||||
line = currentBuffer[lineNumber]
|
||||
|
||||
# count the indentation of the line, if it's lower than the
|
||||
# tag's, the tag is invalid
|
||||
if (len(line)):
|
||||
# initialize local auxiliary variables
|
||||
lineStart = 0
|
||||
i = 0
|
||||
|
||||
# compute the indentation of the line
|
||||
while ((i < len(line)) and (line[i].isspace())):
|
||||
# move the start of the line code
|
||||
if (line[i] == '\t'):
|
||||
lineStart += SimplePythonTagsParser.TABSIZE
|
||||
else:
|
||||
lineStart += 1
|
||||
|
||||
# go to the next character on the line
|
||||
i += 1
|
||||
|
||||
# if the line contains only spaces, skip it
|
||||
if (i == len(line)):
|
||||
continue
|
||||
|
||||
# if the next character is a '#' (python comment), skip
|
||||
# to the next line
|
||||
if (line[i] == '#'):
|
||||
continue
|
||||
|
||||
# if the line's indentation starts before or at the
|
||||
# nearest tag's, the tag is invalid
|
||||
if (lineStart <= tags[nearestLineNumber].indentLevel):
|
||||
nearestLineIndex -= 1
|
||||
break
|
||||
|
||||
# the tag is correct, so use it
|
||||
else:
|
||||
break
|
||||
|
||||
# no applicable tag has been found
|
||||
else:
|
||||
nearestLineNumber = -1
|
||||
|
||||
# describe the cursor position (what tag the cursor is on)
|
||||
# reset the description
|
||||
tagDescription = ""
|
||||
tagDescriptionTag = ""
|
||||
tagDescriptionType = ""
|
||||
|
||||
# if an applicable tag has been found, set the description accordingly
|
||||
if (nearestLineNumber > -1):
|
||||
tagInfo = tags[nearestLineNumber]
|
||||
tagDescriptionTag = tagInfo.fullName
|
||||
tagDescriptionType = PythonTag.TAG_TYPE_NAME[tagInfo.type]
|
||||
tagDescription = "%s (%s)" % (tagDescriptionTag,
|
||||
tagDescriptionType)
|
||||
|
||||
# update the variable for the status line so it get updated with the
|
||||
# new description
|
||||
vim.command("let w:PHStatusLine=\"%s\"" % (tagDescription,))
|
||||
vim.command("let w:PHStatusLineTag=\"%s\"" % (tagDescriptionTag,))
|
||||
vim.command("let w:PHStatusLineType=\"%s\"" % (tagDescriptionType,))
|
||||
|
||||
# handle possible exceptions
|
||||
except Exception:
|
||||
# FIXME: wrap try/except blocks around single sources of exceptions
|
||||
# ONLY. Break this try/except block into as many small ones as you
|
||||
# need, and only catch classes of exceptions that you have encountered.
|
||||
# Catching "Exception" is very, very bad style!
|
||||
# To the author: why is this clause here? There's no git log for why you
|
||||
# have added it. Can you please put in a comment of a specific situation
|
||||
# where you have encountered exceptions?
|
||||
# bury into the traceback
|
||||
ec, ei, tb = sys.exc_info()
|
||||
while (tb != None):
|
||||
if (tb.tb_next == None):
|
||||
break
|
||||
tb = tb.tb_next
|
||||
|
||||
# spit out the error
|
||||
print "ERROR: %s %s %s:%u" % (ec.__name__, ei,
|
||||
tb.tb_frame.f_code.co_filename,
|
||||
tb.tb_lineno)
|
||||
time.sleep(0.5)
|
||||
|
||||
|
||||
def deleteTags(bufferNumber):
|
||||
"""
|
||||
Removes tag data for the specified buffer number.
|
||||
|
||||
Parameters
|
||||
|
||||
bufferNumber -- number of the buffer
|
||||
"""
|
||||
global TAGS, TAGLINENUMBERS, BUFFERTICKS
|
||||
|
||||
# try to delete the tags for the buffer
|
||||
for o in (TAGS, TAGLINENUMBERS, BUFFERTICKS):
|
||||
try:
|
||||
del o[bufferNumber]
|
||||
except KeyError:
|
||||
pass
|
||||
@@ -1,7 +1,8 @@
|
||||
" File: pythonhelper.vim
|
||||
" Author: Michal Vitecek <fuf-at-mageo-dot-cz>
|
||||
" Version: 0.83
|
||||
" Last Modified: Jan 4, 2010
|
||||
" Author: Roman Dobosz <gryf@vimja.com>
|
||||
" Version: 0.84
|
||||
" Last Modified: 2016-05-18
|
||||
"
|
||||
" Overview
|
||||
" --------
|
||||
@@ -15,8 +16,8 @@
|
||||
" ------------
|
||||
" This script needs only VIM compiled with the Python interpreter. It doesn't
|
||||
" rely on the exuberant ctags utilities. You can determine whether your VIM
|
||||
" has Python support by issuing command :ver and looking for +python in the
|
||||
" list of features.
|
||||
" has Python support by issuing command :ver and looking for +python or
|
||||
" +python3 in the list of features.
|
||||
"
|
||||
" Installation
|
||||
" ------------
|
||||
@@ -29,455 +30,30 @@
|
||||
" use %{TagInStatusLineTag()} or %{TagInStatusLineType()} for just the tag
|
||||
" name or tag type respectively.
|
||||
" 4. Run Vim and open any Python file.
|
||||
"
|
||||
python << EOS
|
||||
import re
|
||||
import sys
|
||||
import time
|
||||
import traceback
|
||||
import vim
|
||||
|
||||
|
||||
# global dictionaries of tags and their line numbers, keys are buffer numbers
|
||||
TAGS = {}
|
||||
TAGLINENUMBERS = {}
|
||||
BUFFERTICKS = {}
|
||||
|
||||
|
||||
class PythonTag(object):
|
||||
"""A simple storage class representing a python tag."""
|
||||
# possible tag types
|
||||
TT_CLASS = 0
|
||||
TT_METHOD = 1
|
||||
TT_FUNCTION = 2
|
||||
|
||||
# tag type names
|
||||
TAG_TYPE_NAME = {TT_CLASS: "class",
|
||||
TT_METHOD: "method",
|
||||
TT_FUNCTION: "function"}
|
||||
|
||||
def __init__(self, type, name, fullName, lineNumber, indentLevel):
|
||||
"""
|
||||
Initializes instances of PythonTag().
|
||||
|
||||
Parameters
|
||||
|
||||
type -- tag type
|
||||
|
||||
name -- short tag name
|
||||
|
||||
fullName -- full tag name (in dotted notation)
|
||||
|
||||
lineNumber -- line number on which the tag starts
|
||||
|
||||
indentLevel -- indentation level of the tag
|
||||
"""
|
||||
self.type = type
|
||||
self.name = name
|
||||
self.fullName = fullName
|
||||
self.lineNumber = lineNumber
|
||||
self.indentLevel = indentLevel
|
||||
|
||||
def __str__(self):
|
||||
"""Returns a string representation of the tag."""
|
||||
return "%s (%s) [%s, %u, %u]" % (self.name,
|
||||
PythonTag.TAG_TYPE_NAME[self.type],
|
||||
self.fullName,
|
||||
self.lineNumber,
|
||||
self.indentLevel,)
|
||||
|
||||
__repr__ = __str__
|
||||
|
||||
|
||||
class SimplePythonTagsParser(object):
|
||||
"""Provides a simple Python tag parser."""
|
||||
# how many chars a single tab represents (visually)
|
||||
TABSIZE = 8
|
||||
# regexp used to extract indentation and strip comments
|
||||
COMMENTS_INDENT_RE = re.compile('([ \t]*)([^\n#]*).*')
|
||||
# regexp used to extract a class name
|
||||
CLASS_RE = re.compile('class[ \t]+([^(:]+).*')
|
||||
# regexp used to extract a method or function name
|
||||
METHOD_RE = re.compile('def[ \t]+([^(]+).*')
|
||||
|
||||
def __init__(self, source):
|
||||
"""
|
||||
Initializes instances of SimplePythonTagsParser().
|
||||
|
||||
Parameters
|
||||
|
||||
source -- source for which the tags will be generated. It must
|
||||
be a generator.
|
||||
"""
|
||||
self.source = source
|
||||
|
||||
def getTags(self):
|
||||
"""
|
||||
Determines all the tags for the buffer. Returns a tuple in the format
|
||||
(tagLineNumbers, tags,).
|
||||
"""
|
||||
tagLineNumbers = []
|
||||
tags = {}
|
||||
tagsStack = []
|
||||
|
||||
import itertools
|
||||
# go through all the lines in the source and localize all Python tags
|
||||
# in it
|
||||
for (line, lineNumber) in zip(self.source, itertools.count(1)):
|
||||
|
||||
# extract the line's indentation characters and its content
|
||||
lineMatch = self.COMMENTS_INDENT_RE.match(line)
|
||||
lineContent = lineMatch.group(2)
|
||||
|
||||
# match for the class tag
|
||||
tagMatch = self.CLASS_RE.match(lineContent)
|
||||
|
||||
# if the class tag has been found, store some information on it
|
||||
if (tagMatch):
|
||||
currentTag = self.getPythonTag(tagsStack, lineNumber,
|
||||
lineMatch.group(1),
|
||||
tagMatch.group(1),
|
||||
self.tagClassTypeDecidingMethod)
|
||||
tagLineNumbers.append(lineNumber)
|
||||
tags[lineNumber] = currentTag
|
||||
|
||||
else:
|
||||
# match for the method/function tag
|
||||
tagMatch = self.METHOD_RE.match(lineContent)
|
||||
|
||||
# if the method/function tag has been found, store some
|
||||
# information on it
|
||||
if (tagMatch):
|
||||
currentTag = self.getPythonTag(tagsStack,
|
||||
lineNumber,
|
||||
lineMatch.group(1),
|
||||
tagMatch.group(1),
|
||||
self.tagFunctionTypeDecidingMethod)
|
||||
tagLineNumbers.append(lineNumber)
|
||||
tags[lineNumber] = currentTag
|
||||
|
||||
return (tagLineNumbers, tags,)
|
||||
|
||||
def getParentTag(self, tagsStack):
|
||||
"""
|
||||
Given a tag, returns its parent tag (instance of PythonTag()) from the
|
||||
specified tag list. If no such parent tag exists, returns None.
|
||||
|
||||
Parameters
|
||||
|
||||
tagsStack -- list (stack) of currently open PythonTag() instances
|
||||
"""
|
||||
if (len(tagsStack)):
|
||||
parentTag = tagsStack[-1]
|
||||
else:
|
||||
parentTag = None
|
||||
|
||||
return parentTag
|
||||
|
||||
def computeIndentationLevel(indentChars):
|
||||
"""
|
||||
Computes the indentation level from the specified string.
|
||||
|
||||
Parameters
|
||||
|
||||
indentChars -- white space before any other character on line
|
||||
"""
|
||||
indentLevel = 0
|
||||
|
||||
# compute the indentation level (expand tabs)
|
||||
for char in indentChars:
|
||||
if (char == '\t'):
|
||||
indentLevel += SimplePythonTagsParser.TABSIZE
|
||||
else:
|
||||
indentLevel += 1
|
||||
|
||||
return indentLevel
|
||||
|
||||
computeIndentationLevel = staticmethod(computeIndentationLevel)
|
||||
|
||||
def getPythonTag(self, tagsStack, lineNumber, indentChars, tagName, tagTypeDecidingMethod):
|
||||
"""
|
||||
Returns instance of PythonTag() based on the specified data.
|
||||
|
||||
Parameters
|
||||
|
||||
tagsStack -- list (stack) of tags currently active. Note: Modified
|
||||
in this method!
|
||||
|
||||
lineNumber -- current line number
|
||||
|
||||
indentChars -- characters making up the indentation level of the
|
||||
current tag
|
||||
|
||||
tagName -- short name of the current tag
|
||||
|
||||
tagTypeDecidingMethod -- reference to the method that is called to
|
||||
determine the type of the current tag
|
||||
"""
|
||||
indentLevel = self.computeIndentationLevel(indentChars)
|
||||
parentTag = self.getParentTag(tagsStack)
|
||||
|
||||
# handle enclosed tag
|
||||
while (parentTag):
|
||||
# if the indent level of the parent tag is greater than of the
|
||||
# current tag, use parent tag of the parent tag
|
||||
if (parentTag.indentLevel >= indentLevel):
|
||||
del tagsStack[-1]
|
||||
|
||||
# otherwise we have all information on the current tag and can
|
||||
# return it
|
||||
else:
|
||||
tag = PythonTag(tagTypeDecidingMethod(parentTag.type),
|
||||
tagName, "%s.%s" % (parentTag.fullName,
|
||||
tagName,),
|
||||
lineNumber, indentLevel)
|
||||
|
||||
break
|
||||
|
||||
# use the parent tag of the parent tag
|
||||
parentTag = self.getParentTag(tagsStack)
|
||||
|
||||
# handle a top-indent level tag
|
||||
else:
|
||||
tag = PythonTag(tagTypeDecidingMethod(None), tagName, tagName,
|
||||
lineNumber, indentLevel)
|
||||
|
||||
# add the tag to the list of tags
|
||||
tagsStack.append(tag)
|
||||
|
||||
return tag
|
||||
|
||||
def tagClassTypeDecidingMethod(self, parentTagType):
|
||||
"""
|
||||
Returns tag type of the current tag based on its previous tag (super
|
||||
tag) for classes.
|
||||
|
||||
Parameters
|
||||
|
||||
parentTagType -- type of the enclosing/parent tag
|
||||
"""
|
||||
return PythonTag.TT_CLASS
|
||||
|
||||
def tagFunctionTypeDecidingMethod(self, parentTagType):
|
||||
"""
|
||||
Returns tag type of the current tag based on its previous tag (super
|
||||
tag) for functions/methods.
|
||||
|
||||
Parameters
|
||||
|
||||
parentTagType -- type of the enclosing/parent tag
|
||||
"""
|
||||
if (parentTagType == PythonTag.TT_CLASS):
|
||||
return PythonTag.TT_METHOD
|
||||
else:
|
||||
return PythonTag.TT_FUNCTION
|
||||
|
||||
|
||||
def vimBufferIterator(vimBuffer):
|
||||
for line in vimBuffer:
|
||||
yield line + "\n"
|
||||
|
||||
|
||||
def getNearestLineIndex(row, tagLineNumbers):
|
||||
"""
|
||||
Returns the index of 'tagLineNumbers' that contains the line nearest to
|
||||
the specified cursor row.
|
||||
|
||||
Parameters
|
||||
|
||||
row -- current cursor row
|
||||
|
||||
tagLineNumbers -- list of tags' line numbers (ie. their position)
|
||||
"""
|
||||
nearestLineNumber = -1
|
||||
nearestLineIndex = -1
|
||||
|
||||
# go through all tag line numbers and find the one nearest to the
|
||||
# specified row
|
||||
for lineIndex, lineNumber in enumerate(tagLineNumbers):
|
||||
# if the current line is nearer the current cursor position, take it
|
||||
if (nearestLineNumber < lineNumber <= row):
|
||||
nearestLineNumber = lineNumber
|
||||
nearestLineIndex = lineIndex
|
||||
|
||||
# if we've come past the current cursor position, end the search
|
||||
if (lineNumber >= row):
|
||||
break
|
||||
|
||||
return nearestLineIndex
|
||||
|
||||
|
||||
def getTags(bufferNumber, changedTick):
|
||||
"""
|
||||
Reads the tags for the buffer specified by the number. Returns a tuple
|
||||
of the format (taglinenumber[buffer], tags[buffer],).
|
||||
|
||||
Parameters
|
||||
|
||||
bufferNumber -- number of the current buffer
|
||||
|
||||
changedTick -- always-increasing number used to indicate that the
|
||||
buffer has been modified since the last time
|
||||
"""
|
||||
global TAGLINENUMBERS, TAGS, BUFFERTICKS
|
||||
|
||||
# return immediately if there's no need to update the tags
|
||||
if (BUFFERTICKS.get(bufferNumber, None) == changedTick):
|
||||
return (TAGLINENUMBERS[bufferNumber], TAGS[bufferNumber])
|
||||
|
||||
# get the tags
|
||||
simpleTagsParser = SimplePythonTagsParser(vimBufferIterator(vim.current.buffer))
|
||||
tagLineNumbers, tags = simpleTagsParser.getTags()
|
||||
|
||||
# update the global variables
|
||||
TAGS[bufferNumber] = tags
|
||||
TAGLINENUMBERS[bufferNumber] = tagLineNumbers
|
||||
BUFFERTICKS[bufferNumber] = changedTick
|
||||
|
||||
return (tagLineNumbers, tags)
|
||||
|
||||
|
||||
def findTag(bufferNumber, changedTick):
|
||||
"""
|
||||
Tries to find the best tag for the current cursor position.
|
||||
|
||||
Parameters
|
||||
|
||||
bufferNumber -- number of the current buffer
|
||||
|
||||
changedTick -- always-increasing number used to indicate that the
|
||||
buffer has been modified since the last time
|
||||
"""
|
||||
try:
|
||||
# get the tag data for the current buffer
|
||||
tagLineNumbers, tags = getTags(bufferNumber, changedTick)
|
||||
|
||||
# link to Vim's internal data
|
||||
currentBuffer = vim.current.buffer
|
||||
currentWindow = vim.current.window
|
||||
row, col = currentWindow.cursor
|
||||
|
||||
# get the index of the nearest line
|
||||
nearestLineIndex = getNearestLineIndex(row, tagLineNumbers)
|
||||
|
||||
# if a line has been found, find out if the tag is correct {{{
|
||||
# E.g. the cursor might be below the last tag, but in code that has
|
||||
# nothing to do with the tag, which we know because the line is
|
||||
# indented differently. In such a case no applicable tag has been
|
||||
# found.
|
||||
while (nearestLineIndex > -1):
|
||||
# get the line number of the nearest tag
|
||||
nearestLineNumber = tagLineNumbers[nearestLineIndex]
|
||||
|
||||
# walk through all the lines in the range (nearestTagLine,
|
||||
# cursorRow)
|
||||
for lineNumber in xrange(nearestLineNumber + 1, row):
|
||||
# get the current line
|
||||
line = currentBuffer[lineNumber]
|
||||
|
||||
# count the indentation of the line, if it's lower than the
|
||||
# tag's, the tag is invalid
|
||||
if (len(line)):
|
||||
# initialize local auxiliary variables
|
||||
lineStart = 0
|
||||
i = 0
|
||||
|
||||
# compute the indentation of the line
|
||||
while ((i < len(line)) and (line[i].isspace())):
|
||||
# move the start of the line code
|
||||
if (line[i] == '\t'):
|
||||
lineStart += SimplePythonTagsParser.TABSIZE
|
||||
else:
|
||||
lineStart += 1
|
||||
|
||||
# go to the next character on the line
|
||||
i += 1
|
||||
|
||||
# if the line contains only spaces, skip it
|
||||
if (i == len(line)):
|
||||
continue
|
||||
|
||||
# if the next character is a '#' (python comment), skip
|
||||
# to the next line
|
||||
if (line[i] == '#'):
|
||||
continue
|
||||
|
||||
# if the line's indentation starts before or at the
|
||||
# nearest tag's, the tag is invalid
|
||||
if (lineStart <= tags[nearestLineNumber].indentLevel):
|
||||
nearestLineIndex -= 1
|
||||
break
|
||||
|
||||
# the tag is correct, so use it
|
||||
else:
|
||||
break
|
||||
|
||||
# no applicable tag has been found
|
||||
else:
|
||||
nearestLineNumber = -1
|
||||
|
||||
# describe the cursor position (what tag the cursor is on)
|
||||
# reset the description
|
||||
tagDescription = ""
|
||||
tagDescriptionTag = ""
|
||||
tagDescriptionType = ""
|
||||
|
||||
# if an applicable tag has been found, set the description accordingly
|
||||
if (nearestLineNumber > -1):
|
||||
tagInfo = tags[nearestLineNumber]
|
||||
tagDescriptionTag = tagInfo.fullName
|
||||
tagDescriptionType = PythonTag.TAG_TYPE_NAME[tagInfo.type]
|
||||
tagDescription = "%s (%s)" % (tagDescriptionTag,
|
||||
tagDescriptionType)
|
||||
|
||||
# update the variable for the status line so it get updated with the
|
||||
# new description
|
||||
vim.command("let w:PHStatusLine=\"%s\"" % (tagDescription,))
|
||||
vim.command("let w:PHStatusLineTag=\"%s\"" % (tagDescriptionTag,))
|
||||
vim.command("let w:PHStatusLineType=\"%s\"" % (tagDescriptionType,))
|
||||
|
||||
# handle possible exceptions
|
||||
except Exception:
|
||||
# FIXME: wrap try/except blocks around single sources of exceptions
|
||||
# ONLY. Break this try/except block into as many small ones as you
|
||||
# need, and only catch classes of exceptions that you have encountered.
|
||||
# Catching "Exception" is very, very bad style!
|
||||
# To the author: why is this clause here? There's no git log for why you
|
||||
# have added it. Can you please put in a comment of a specific situation
|
||||
# where you have encountered exceptions?
|
||||
# bury into the traceback
|
||||
ec, ei, tb = sys.exc_info()
|
||||
while (tb != None):
|
||||
if (tb.tb_next == None):
|
||||
break
|
||||
tb = tb.tb_next
|
||||
|
||||
# spit out the error
|
||||
print "ERROR: %s %s %s:%u" % (ec.__name__, ei,
|
||||
tb.tb_frame.f_code.co_filename,
|
||||
tb.tb_lineno)
|
||||
time.sleep(0.5)
|
||||
|
||||
|
||||
def deleteTags(bufferNumber):
|
||||
"""
|
||||
Removes tag data for the specified buffer number.
|
||||
|
||||
Parameters
|
||||
|
||||
bufferNumber -- number of the buffer
|
||||
"""
|
||||
global TAGS, TAGLINENUMBERS, BUFFERTICKS
|
||||
|
||||
# try to delete the tags for the buffer
|
||||
for o in (TAGS, TAGLINENUMBERS, BUFFERTICKS):
|
||||
try:
|
||||
del o[bufferNumber]
|
||||
except KeyError:
|
||||
pass
|
||||
EOS
|
||||
|
||||
" VIM functions {{{
|
||||
let g:pythonhelper_python = 'python'
|
||||
function! s:PHLoader()
|
||||
let l:plugin_path = escape(expand('<sfile>:p:h'), '\')
|
||||
|
||||
if !exists('g:pythonhelper_py_loaded')
|
||||
if has('python')
|
||||
exe 'pyfile ' . escape(l:plugin_path, ' ') . '/pythonhelper.py'
|
||||
elseif has('python3')
|
||||
let g:pythonhelper_python = 'python3'
|
||||
exe 'py3file ' . escape(l:plugin_path, ' ') . '/pythonhelper.py'
|
||||
else
|
||||
echohl WarningMsg|echomsg
|
||||
\ "PythonHelper unavailable: "
|
||||
\ "requires Vim with Python support"|echohl None
|
||||
finish
|
||||
endif
|
||||
let g:pythonhelper_py_loaded = 1
|
||||
else
|
||||
echohl "already loaded"
|
||||
endif
|
||||
endfunction
|
||||
|
||||
|
||||
function! PHCursorHold()
|
||||
" only Python is supported {{{
|
||||
@@ -489,8 +65,10 @@ function! PHCursorHold()
|
||||
endif
|
||||
" }}}
|
||||
|
||||
" call Python function findTag() with the current buffer number and change status indicator
|
||||
execute 'python findTag(' . expand("<abuf>") . ', ' . b:changedtick . ')'
|
||||
" call Python function findTag() with the current buffer number and change
|
||||
" status indicator
|
||||
execute g:pythonhelper_python . ' findTag(' . expand("<abuf>") .
|
||||
\ ', ' . b:changedtick . ')'
|
||||
endfunction
|
||||
|
||||
|
||||
@@ -500,8 +78,9 @@ function! PHBufferDelete()
|
||||
let w:PHStatusLineTag = ''
|
||||
let w:PHStatusLineType = ''
|
||||
|
||||
" call Python function deleteTags() with the current buffer number and change status indicator
|
||||
execute 'python deleteTags(' . expand("<abuf>") . ')'
|
||||
" call Python function deleteTags() with the current buffer number and
|
||||
" change status indicator
|
||||
execute g:pythonhelper_python . ' deleteTags(' . expand("<abuf>") . ')'
|
||||
endfunction
|
||||
|
||||
|
||||
@@ -569,9 +148,11 @@ endfunction
|
||||
|
||||
" }}}
|
||||
|
||||
|
||||
" event binding, Vim customization {{{
|
||||
|
||||
" load Python code
|
||||
call s:PHLoader()
|
||||
|
||||
" autocommands
|
||||
autocmd CursorHold * call PHCursorHold()
|
||||
autocmd CursorHoldI * call PHCursorHold()
|
||||
|
||||
Reference in New Issue
Block a user