vhdl-style-guide/vsg/vhdlFile/extract/utils.py

166 lines
5.3 KiB
Python

# -*- coding: utf-8 -*-
from vsg import parser, token
from vsg.vhdlFile.extract import tokens
def is_token_at_start_of_line(iIndex, oTokenMap):
if oTokenMap.is_token_at_index(parser.carriage_return, iIndex - 1):
return True
if oTokenMap.is_token_at_index(parser.carriage_return, iIndex - 2) and is_token_at_index_whitespace(oTokenMap, iIndex - 1):
return True
return False
def is_token_at_end_of_line(iIndex, oTokenMap):
if oTokenMap.is_token_at_index(parser.carriage_return, iIndex + 1):
return True
if oTokenMap.is_token_at_index(parser.comment, iIndex + 1):
return True
if oTokenMap.is_token_at_index(parser.whitespace, iIndex + 1):
if oTokenMap.is_token_at_index(parser.carriage_return, iIndex + 2):
return True
if oTokenMap.is_token_at_index(parser.comment, iIndex + 2):
return True
return False
def get_indexes_of_token_list(lTokens, oTokenMap):
lReturn = []
for oToken in lTokens:
lReturn.extend(oTokenMap.get_token_indexes(oToken))
lReturn.sort()
return lReturn
def get_indexes_of_token_pairs(lPairs, oTokenMap):
lReturn = []
for lPair in lPairs:
lStart, lEnd = oTokenMap.get_token_pair_indexes(lPair[0], lPair[1])
for iStart, iEnd in zip(lStart, lEnd):
lReturn.append([iStart, iEnd])
return lReturn
def get_line_numbers_of_indexes_in_list(lIndexes, oTokenMap):
lReturn = []
for iIndex in lIndexes:
lReturn.append(oTokenMap.get_line_number_of_index(iIndex))
lReturn.sort()
return lReturn
def is_index_between_indexes(iIndex, lStart, lEnd, bInclusive=False):
for iStart, iEnd in zip(lStart, lEnd):
if bInclusive:
if iStart <= iIndex and iIndex <= iEnd:
return True
else:
if iStart < iIndex and iIndex < iEnd:
return True
return False
def filter_tokens_which_start_a_line(oToken, oTokenMap):
lIndexes = oTokenMap.get_token_indexes(oToken)
return filter_indexes_which_start_a_line(lIndexes, oTokenMap)
def filter_indexes_which_start_a_line(lIndexes, oTokenMap):
lReturn = []
for iIndex in lIndexes:
if is_token_at_start_of_line(iIndex, oTokenMap):
lReturn.append(iIndex)
return lReturn
def filter_tokens_between_tokens(lTokens, oStart, oEnd, oTokenMap):
lStart = oTokenMap.get_token_indexes(oStart)
lEnd = oTokenMap.get_token_indexes(oEnd)
lReturn = []
for oToken in lTokens:
for iStart, iEnd in zip(lStart, lEnd):
lReturn.extend(oTokenMap.get_token_indexes_between_indexes(oToken, iStart, iEnd))
return lReturn
def filter_tokens_between_tokens_unless_token_exists_between_them(lTokens, oStart, oEnd, oStop, oTokenMap):
lStart = oTokenMap.get_token_indexes(oStart)
lEnd = oTokenMap.get_token_indexes(oEnd)
lStop = oTokenMap.get_token_indexes(oStop)
lReturn = []
for oToken in lTokens:
for iStart in lStart:
for iEnd in lEnd:
if iEnd > iStart:
for iStop in lStop:
if iStart < iStop < iEnd:
break
else:
lReturn.extend(oTokenMap.get_token_indexes_between_indexes(oToken, iStart, iEnd))
break
return lReturn
def get_indexes_of_tokens_between(lStartToken, lEndTokens, oTokenMap):
"""
This function will take a list of start tokens and a list of end tokens.
It will return a list of indexes of either a start token or an end token.
A start token index will be returned if another start token was found before an end token.
An end token index will be returned if the next token index is a start token.
"""
lReturn = []
lStartIndexes = oTokenMap.get_token_indexes(lStartToken)
lEndIndexes = get_indexes_of_token_list(lEndTokens, oTokenMap)
for iStartIndex, iStart in enumerate(lStartIndexes):
try:
iNextStart = lStartIndexes[iStartIndex + 1]
except IndexError:
try:
iNextStart = lEndIndexes[-1] + 1
except IndexError:
lReturn.append(iStartIndex)
return lReturn
iEndIndex = iStart
for iEnd in lEndIndexes:
if iEnd > iStart and iEnd < iNextStart:
iEndIndex = iEnd
if iEnd > iNextStart:
break
lReturn.append(iEndIndex)
return lReturn
def get_all_blank_lines_above_indexes(lIndexes, lAllTokens, oTokenMap):
lReturn = []
for iIndex in lIndexes:
iLine = oTokenMap.get_line_number_of_index(iIndex)
iEnd = oTokenMap.get_index_of_carriage_return_before_index(iIndex)
iStart = oTokenMap.get_index_of_previous_non_whitespace_token_before_index(iEnd)
if iStart is None:
continue
iStart = oTokenMap.get_index_of_carriage_return_after_index(iStart)
if iStart != iEnd:
lReturn.append(tokens.New(iStart, iLine, lAllTokens[iStart:iEnd]))
return lReturn
def is_token_at_index_whitespace(oTokenMap, iIndex):
if oTokenMap.is_token_at_index(parser.whitespace, iIndex):
return True
return False
def is_token_at_index_carriage_return(oTokenMap, iIndex):
if oTokenMap.is_token_at_index(parser.carriage_return, iIndex):
return True
return False