Updates for issue #235:

Refactored code to improve readability.
This commit is contained in:
Jeremiah C Leary 2019-12-04 08:51:16 -06:00
parent 8309e4a670
commit 5a98adb4b7
4 changed files with 57 additions and 62 deletions

View File

@ -17,5 +17,6 @@ from .is_single_space_before import *
from .is_uppercase import *
from .keyword_alignment import *
from .multiline_alignment import *
from .multiline_alignment_with_parenthesis import *
from .has_prefix import *
from .has_suffix import *

View File

@ -5,7 +5,7 @@ This module contains functions for rules to perform their checks.
import re
def multiline_alignment(self, iColumn, oLine, iLineNumber, dParenthesis=None):
def multiline_alignment(self, iColumn, oLine, iLineNumber):
'''
Checks the alignment of multiline statements.
@ -18,63 +18,8 @@ def multiline_alignment(self, iColumn, oLine, iLineNumber, dParenthesis=None):
oLine: (line object)
iLineNumber: (integer)
dParenthesis: (dictionary)
'''
if dParenthesis is None:
if not re.match('\s{' + str(iColumn) + '}\S', oLine.line):
self.add_violation(iLineNumber)
self.dFix['violations'][iLineNumber] = {}
self.dFix['violations'][iLineNumber]['column'] = iColumn
else:
# print(dParenthesis)
iTotalOpenParenthesis = 0
iTotalCloseParenthesis = 0
for iIndex in range(dParenthesis[iLineNumber]['begin'], iLineNumber):
iTotalOpenParenthesis = iTotalOpenParenthesis + len(dParenthesis[iIndex]['open'])
iTotalCloseParenthesis = iTotalCloseParenthesis + len(dParenthesis[iIndex]['closed'])
sDebug = '[LineNumber]' + str(iIndex)
sDebug += '[TotalOpenParenthesis]' + str(iTotalOpenParenthesis)
sDebug += '[TotalCloseParenthesis]' + str(iTotalCloseParenthesis)
# print(sDebug)
if iTotalOpenParenthesis == iTotalCloseParenthesis:
if not dParenthesis[iLineNumber]['character'] == iColumn:
self.add_violation(iLineNumber)
self.dFix['violations'][iLineNumber] = {}
self.dFix['violations'][iLineNumber]['column'] = iColumn
else:
iParenthesisColumn = find_right_most_open_parenthesis(dParenthesis, iLineNumber)
# print('[iPrenthesisColumn]' + str(iParenthesisColumn))
if iParenthesisColumn is None:
if not dParenthesis[iLineNumber]['character'] == iColumn:
self.add_violation(iLineNumber)
self.dFix['violations'][iLineNumber] = {}
self.dFix['violations'][iLineNumber]['column'] = iColumn
else:
if not dParenthesis[iLineNumber]['character'] == iParenthesisColumn + 1:
self.add_violation(iLineNumber)
self.dFix['violations'][iLineNumber] = {}
self.dFix['violations'][iLineNumber]['column'] = iParenthesisColumn + 1
def find_right_most_open_parenthesis(dParenthesis, iLineNumber):
# print('[Entering find_right_most_open_parenthesis]')
lOpenParenthesis = []
# print('[iLineNumber]' + str(iLineNumber))
# print(dParenthesis[iLineNumber]['begin'])
for iIndex in range(dParenthesis[iLineNumber]['begin'], iLineNumber):
# print('[iIndex]' + str(iIndex))
for iOpenParenthesis in dParenthesis[iIndex]['open']:
lOpenParenthesis.insert(0, iOpenParenthesis)
# print('lOpenParenthesis before pop')
# print(lOpenParenthesis)
for iCloseParenthesis in dParenthesis[iIndex]['closed']:
lOpenParenthesis.pop(0)
# print('lOpenParenthesis after pop')
# print(lOpenParenthesis)
# print('[Exiting find_right_most_open_parenthesis]')
if not len(lOpenParenthesis) == 0:
return lOpenParenthesis[0]
return None
if not re.match('\s{' + str(iColumn) + '}\S', oLine.line):
self.add_violation(iLineNumber)
self.dFix['violations'][iLineNumber] = {}
self.dFix['violations'][iLineNumber]['column'] = iColumn

View File

@ -0,0 +1,49 @@
'''
This module contains functions for rules to perform their checks.
'''
import re
def multiline_alignment_with_parenthesis(self, iColumn, oLine, iLineNumber, dParenthesis):
'''
Checks the alignment of multiline statements taking parenthesis into account.
Parameters:
self: (rule object)
iColumn: (integer)
oLine: (line object)
iLineNumber: (integer)
dParenthesis: (dictionary)
'''
for iIndex in range(dParenthesis[iLineNumber]['begin'], iLineNumber):
iParenthesisColumn = _find_right_most_open_parenthesis(dParenthesis, iLineNumber)
if iParenthesisColumn is None:
if not dParenthesis[iLineNumber]['character'] == iColumn:
self.add_violation(iLineNumber)
self.dFix['violations'][iLineNumber] = {}
self.dFix['violations'][iLineNumber]['column'] = iColumn
else:
if not dParenthesis[iLineNumber]['character'] == iParenthesisColumn + 1:
self.add_violation(iLineNumber)
self.dFix['violations'][iLineNumber] = {}
self.dFix['violations'][iLineNumber]['column'] = iParenthesisColumn + 1
def _find_right_most_open_parenthesis(dParenthesis, iLineNumber):
lOpenParenthesis = []
for iIndex in range(dParenthesis[iLineNumber]['begin'], iLineNumber):
for iOpenParenthesis in dParenthesis[iIndex]['open']:
lOpenParenthesis.insert(0, iOpenParenthesis)
for iCloseParenthesis in dParenthesis[iIndex]['closed']:
lOpenParenthesis.pop(0)
if not len(lOpenParenthesis) == 0:
return lOpenParenthesis[0]
return None

View File

@ -14,7 +14,7 @@ class rule_003(rule.rule):
rule.rule.__init__(self)
self.name = 'concurrent'
self.identifier = '003'
self.solution = 'Align first character in row to the column of text one space after the <=.'
self.solution = 'Align first character in row to the column of text one space after the <= or to the open parenthesis in the line above.'
self.phase = 6
def _pre_analyze(self):
@ -35,7 +35,7 @@ class rule_003(rule.rule):
else:
self.dParenthesis[iLineNumber]['begin'] = self.dParenthesis[iLineNumber - 1]['begin']
self.dParenthesis[iLineNumber]['align'] = self.dParenthesis[iLineNumber - 1]['align']
check.multiline_alignment(self, self.iAlignmentColumn, oLine, iLineNumber, self.dParenthesis)
check.multiline_alignment_with_parenthesis(self, self.iAlignmentColumn, oLine, iLineNumber, self.dParenthesis)
clear_parenthesis_dictionary(self, oLine)