From 4e16db01efd0b0c38eb28bcfa37e1ff32bf2193c Mon Sep 17 00:00:00 2001 From: Jeremiah Leary Date: Thu, 3 Dec 2020 16:54:57 -0600 Subject: [PATCH] Refactoring method get_interface_elements_between_tokens. 1) Moved from vsg.vhdlFile to vsg.vhdlFile.extract 2) Partially refactored to use token map 3) Refactored port_012 to new format --- vsg/rules/port/rule_012.py | 54 ++++++++----------- vsg/vhdlFile/extract/__init__.py | 1 + .../get_interface_elements_between_tokens.py | 49 +++++++++++++++++ vsg/vhdlFile/vhdlFile.py | 46 +--------------- 4 files changed, 72 insertions(+), 78 deletions(-) create mode 100644 vsg/vhdlFile/extract/get_interface_elements_between_tokens.py diff --git a/vsg/rules/port/rule_012.py b/vsg/rules/port/rule_012.py index 90a9f1b0..1b6d5eda 100644 --- a/vsg/rules/port/rule_012.py +++ b/vsg/rules/port/rule_012.py @@ -37,8 +37,10 @@ class rule_012(rule.Rule): self.oEnd = token.port_clause.close_parenthesis self.fixable = False - def analyze(self, oFile): - lToi = oFile.get_interface_elements_between_tokens(self.oStart, self.oEnd) + def _get_tokens_of_interest(self, oFile): + return oFile.get_interface_elements_between_tokens(self.oStart, self.oEnd) + + def _analyze(self, lToi): for oToi in lToi: lTokens = oToi.get_tokens() for iToken, oToken in enumerate(lTokens): @@ -54,34 +56,20 @@ class rule_012(rule.Rule): self.add_violation(oViolation) break - - def fix(self, oFile): - ''' - Applies fixes for any rule violations. - ''' - if self.fixable: - self.analyze(oFile) - self._print_debug_message('Fixing rule: ' + self.name + '_' + self.identifier) - self._fix_violation(oFile) - self.violations = [] - - def _fix_violation(self, oFile): - for oViolation in self.violations: - lTokens = oViolation.get_tokens() - dAction = oViolation.get_action() - for iIndex in range(dAction['index'], len(lTokens)): - if isinstance(lTokens[iIndex], parser.comment): - if isinstance(lTokens[iIndex - 1], parser.whitespace): - iEnd = iIndex - 1 - else: - iEnd = iIndex - break - else: - iEnd = iIndex - if iEnd + 1 == len(lTokens): - lNewTokens = lTokens[:dAction['index']] - else: - lNewTokens = lTokens[:dAction['index']] + lTokens[iEnd:] - oViolation.set_tokens(lNewTokens) - oFile.update(self.violations) - + def _fix_violation(self, oViolation): + lTokens = oViolation.get_tokens() + dAction = oViolation.get_action() + for iIndex in range(dAction['index'], len(lTokens)): + if isinstance(lTokens[iIndex], parser.comment): + if isinstance(lTokens[iIndex - 1], parser.whitespace): + iEnd = iIndex - 1 + else: + iEnd = iIndex + break + else: + iEnd = iIndex + if iEnd + 1 == len(lTokens): + lNewTokens = lTokens[:dAction['index']] + else: + lNewTokens = lTokens[:dAction['index']] + lTokens[iEnd:] + oViolation.set_tokens(lNewTokens) diff --git a/vsg/vhdlFile/extract/__init__.py b/vsg/vhdlFile/extract/__init__.py index 0dd9d2bc..3d6753d3 100644 --- a/vsg/vhdlFile/extract/__init__.py +++ b/vsg/vhdlFile/extract/__init__.py @@ -35,3 +35,4 @@ from .get_token_and_n_tokens_after_it import get_token_and_n_tokens_after_it from .get_token_and_n_tokens_after_it_when_between_tokens import get_token_and_n_tokens_after_it_when_between_tokens from .get_blank_lines_below_line_ending_with_token import get_blank_lines_below_line_ending_with_token from .get_association_elements_between_tokens import get_association_elements_between_tokens +from .get_interface_elements_between_tokens import get_interface_elements_between_tokens diff --git a/vsg/vhdlFile/extract/get_interface_elements_between_tokens.py b/vsg/vhdlFile/extract/get_interface_elements_between_tokens.py new file mode 100644 index 00000000..8bdf42b0 --- /dev/null +++ b/vsg/vhdlFile/extract/get_interface_elements_between_tokens.py @@ -0,0 +1,49 @@ + +from vsg import parser +from vsg import token + +from vsg.vhdlFile.extract import tokens + + +def get_interface_elements_between_tokens(oStart, oEnd, lAllTokens, oTokenMap): + lReturn = [] + lStartIndexes, lEndIndexes = oTokenMap.get_token_pair_indexes(oStart, oEnd) + + for iStart, iEnd in zip(lStartIndexes, lEndIndexes): + iLine = oTokenMap.get_line_number_of_index(iStart) + lToi = lAllTokens[iStart + 1:iEnd + 1] + + bStore = False + iLineNumber = None + lTemp = [] + for iIndex in range(0, len(lToi)): + oToken = lToi[iIndex] + if not isinstance(oToken, parser.whitespace) and not isinstance(oToken, parser.carriage_return) and not isinstance(oToken, parser.comment) and not bStore: + bStore = True + iStartIndex = iIndex + iStart + 1 + iLineNumber = iLine + + if bStore: + lTemp.append(lToi[iIndex]) + + if isinstance(oToken, token.interface_list.semicolon): + lTemp.pop() + lReturn.append(tokens.New(iStartIndex, iLineNumber, lTemp)) + lTemp = [] + bStore = False + + if isinstance(lToi[iIndex], parser.carriage_return): + iLine +=1 + else: + if len(lTemp) > 0: + lTemp.pop() + for i in range(1, 3): + if isinstance(lTemp[-1], parser.whitespace): + lTemp.pop() + continue + if isinstance(lTemp[-1], parser.carriage_return): + lTemp.pop() + continue + lReturn.append(tokens.New(iStartIndex, iLineNumber, lTemp)) + + return lReturn diff --git a/vsg/vhdlFile/vhdlFile.py b/vsg/vhdlFile/vhdlFile.py index 8ebc3ed1..8d94a6c0 100644 --- a/vsg/vhdlFile/vhdlFile.py +++ b/vsg/vhdlFile/vhdlFile.py @@ -222,51 +222,7 @@ class vhdlFile(): return extract.get_association_elements_between_tokens(oStart, oEnd, self.lAllObjects, self.oTokenMap) def get_interface_elements_between_tokens(self, oStart, oEnd, include_end_of_line_comments=False): - iLine = 1 - lReturn = [] - bSearch = False - bStore = False - lTemp = [] - iLineNumber = None - for iIndex in range(0, len(self.lAllObjects)): - oToken = self.lAllObjects[iIndex] - if isinstance(oToken, oStart): - bSearch = True - continue - if isinstance(oToken, oEnd): - bSearch = False - bStore = False - if len(lTemp) > 0: - for i in range(1, 3): - if isinstance(lTemp[-1], parser.whitespace): - lTemp.pop() - continue - if isinstance(lTemp[-1], parser.carriage_return): - lTemp.pop() - continue - break - lReturn.append(Tokens(iStart, iLineNumber, lTemp)) - lTemp = [] - continue - - if bSearch: - if not isinstance(oToken, parser.whitespace) and not isinstance(oToken, parser.carriage_return) and not isinstance(oToken, parser.comment) and not bStore: - bStore = True - iStart = iIndex - iLineNumber = iLine - - if isinstance(oToken, token.interface_list.semicolon): - lReturn.append(Tokens(iStart, iLineNumber, lTemp)) - lTemp = [] - bStore = False - - if bStore: - lTemp.append(oToken) - - if isinstance(oToken, parser.carriage_return): - iLine +=1 - - return lReturn + return extract.get_interface_elements_between_tokens(oStart, oEnd, self.lAllObjects, self.oTokenMap) def get_lines_with_length_that_exceed_column(self, iColumn): iLine = 1