Issue #482: Refactoring rule concurrent_009 to improve readability.

This commit is contained in:
Jeremiah Leary 2020-11-26 19:21:42 -06:00
parent c7c0911824
commit fe646bbc71
1 changed files with 20 additions and 58 deletions

View File

@ -14,23 +14,10 @@ lTokenPairs.append([token.concurrent_conditional_signal_assignment.assignment, t
class rule_009(rule.Rule):
'''
Checks the alignment of multiline concurrent conditional signal assignments.
Parameters
----------
name : string
The group the rule belongs to.
identifier : string
unique identifier. Usually in the form of 00N.
trigger : parser object type
object type to apply the case check against
'''
def __init__(self):
rule.Rule.__init__(self, 'concurrent', '009')
self.solution = 'Align with open parenthesis on previous line.'
self.phase = 5
self.subphase = 2
self.lTokenPairs = lTokenPairs
@ -41,50 +28,33 @@ class rule_009(rule.Rule):
for oToi in lToi:
iLine, lTokens = utils.get_toi_parameters(oToi)
# print('> ' + str(iLine) + ' <' + '-'*80)
iStartColumn = calculate_start_column(oFile, oToi)
lColumn = []
lColumn.append(iStartColumn)
iFirstColumn = oFile.get_column_of_token_index(oToi.get_start_index())
iColumn = iFirstColumn
iColumn = oFile.get_column_of_token_index(oToi.get_start_index())
iIndent = 0
bWaveform = True
bCondition = False
iWhenColumn = 0
iPreviousColumn = 0
# print('-'*80)
for iToken, oToken in enumerate(lTokens):
iLine = utils.increment_line_number(iLine, oToken)
if isinstance(oToken, parser.carriage_return):
# print(f'--> Line Number | {iLine} <' + '-'*80)
iPreviousColumn = lColumn[-1]
iColumn = 0
iIndent = calculate_indent(iToken, lTokens)
oNextToken = lTokens[iToken + 1]
if bWaveform:
iAdjustIndex = -1
if isinstance(oNextToken, parser.whitespace):
if len(oNextToken.get_value()) != iStartColumn:
dAction = {}
dAction['line'] = iLine
dAction['column'] = iStartColumn
dAction['action'] = 'adjust'
dAction['previous'] = iPreviousColumn
sSolution = 'Adjust indent to column ' + str(iIndent + lColumn[-1])
oViolation = violation.New(iLine, oToi.extract_tokens(iToken + 1, iToken + 1), sSolution)
oViolation.set_action(dAction)
oViolation = build_violation(iLine, iStartColumn, 'adjust', oToi, iToken)
self.add_violation(oViolation)
else:
dAction = {}
dAction['line'] = iLine
dAction['column'] = iStartColumn
dAction['action'] = 'insert'
dAction['previous'] = iPreviousColumn
sSolution = 'Adjust indent to column ' + str(iStartColumn)
oViolation = violation.New(iLine, oToi.extract_tokens(iToken + 1, iToken + 1), sSolution)
oViolation.set_action(dAction)
oViolation = build_violation(iLine, iStartColumn, 'insert', oToi, iToken)
self.add_violation(oViolation)
if bCondition:
if isinstance(oNextToken, parser.whitespace):
@ -94,31 +64,16 @@ class rule_009(rule.Rule):
else:
iAdjustIndex = -1
if len(oNextToken.get_value()) != lColumn[iAdjustIndex]:
dAction = {}
dAction['line'] = iLine
dAction['column'] = lColumn[-1]
dAction['action'] = 'adjust'
dAction['previous'] = iPreviousColumn
sSolution = 'Adjust indent to column ' + str(iIndent + lColumn[iAdjustIndex])
oViolation = violation.New(iLine, oToi.extract_tokens(iToken + 1, iToken + 1), sSolution)
oViolation.set_action(dAction)
oViolation = build_violation(iLine, lColumn[iAdjustIndex], 'adjust', oToi, iToken)
self.add_violation(oViolation)
else:
if isinstance(oNextToken, parser.close_parenthesis):
iAdjustIndex = -2
else:
iAdjustIndex = -1
dAction = {}
dAction['line'] = iLine
dAction['column'] = lColumn[iAdjustIndex]
dAction['action'] = 'insert'
dAction['previous'] = iPreviousColumn
sSolution = 'Adjust indent to column ' + str(lColumn[iAdjustIndex])
oViolation = violation.New(iLine, oToi.extract_tokens(iToken + 1, iToken + 1), sSolution)
oViolation.set_action(dAction)
oViolation = build_violation(iLine, lColumn[iAdjustIndex], 'insert', oToi, iToken)
self.add_violation(oViolation)
# print(f'{iLine} | {iIndent} | {bWaveform} | {bCondition} | {lColumn} | {iPreviousColumn}')
continue
iColumn += len(oToken.get_value())
@ -126,17 +81,14 @@ class rule_009(rule.Rule):
if isinstance(oToken, token.conditional_waveforms.when_keyword):
bWaveform = False
bCondition = True
iWhenColumn = iColumn + 1
lColumn.append(iWhenColumn)
lColumn.append(iColumn + 1)
if isinstance(oToken, token.conditional_waveforms.else_keyword):
bWaveform = True
bCondition = False
# lColumn.pop()
if isinstance(oToken, parser.open_parenthesis):
# print(f'== {iColumn} + {iPreviousColumn} - {iIndent} = {iColumn + iPreviousColumn - iIndent}')
lColumn.append(iColumn + iPreviousColumn - iIndent)
# lColumn.append(iPreviousColumn - iColumn + iIndent)
if isinstance(oToken, parser.close_parenthesis):
lColumn.pop()
@ -144,7 +96,6 @@ class rule_009(rule.Rule):
def _fix_violation(self, oViolation):
lTokens = oViolation.get_tokens()
dAction = oViolation.get_action()
# print(dAction)
if dAction['action'] == 'adjust':
lTokens[0].set_value(' '*dAction['column'])
else:
@ -166,3 +117,14 @@ def calculate_indent(iToken, lTokens):
else:
iIndent = 0
return iIndent
def build_violation(iLine, iColumn, sAction, oToi, iToken):
dAction = {}
dAction['line'] = iLine
dAction['column'] = iColumn
dAction['action'] = sAction
sSolution = 'Adjust indent to column ' + str(iColumn)
oViolation = violation.New(iLine, oToi.extract_tokens(iToken + 1, iToken + 1), sSolution)
oViolation.set_action(dAction)
return oViolation