vhdl-style-guide/vsg/rules/comment.py

148 lines
6.3 KiB
Python

from vsg import rule
from vsg import line
import re
class comment_rule(rule.rule):
def __init__(self):
rule.rule.__init__(self)
self.name = 'comment'
class rule_001(comment_rule):
'''Case rule 001 checks for the proper alignment of comments.'''
def __init__(self):
comment_rule.__init__(self)
self.identifier = '001'
self.solution = 'Ensure proper indentation.'
self.phase = 4
self.correctCommentColumn = []
def analyze(self, oFile):
for iLineNumber, oLine in enumerate(oFile.lines):
if oLine.isComment:
if oFile.lines[iLineNumber - 1].hasComment:
if oFile.lines[iLineNumber - 1].isComment:
if not oLine.commentColumn == (oLine.indentLevel * self.indentSize):
self.add_violation(iLineNumber)
self.correctCommentColumn.append(oLine.indentLevel * self.indentSize)
else:
try:
if oFile.lines[iLineNumber + 1].isCaseWhenKeyword:
if not oLine.commentColumn == (oLine.indentLevel * self.indentSize) and not oLine.commentColumn == ((oLine.indentLevel - 1) * self.indentSize):
self.add_violation(iLineNumber)
self.correctCommentColumn.append(oLine.indentLevel * self.indentSize)
else:
if not oLine.commentColumn == (oLine.indentLevel * self.indentSize):
self.add_violation(iLineNumber)
self.correctCommentColumn.append(oLine.indentLevel * self.indentSize)
except IndexError:
pass
def _fix_violations(self, oFile):
for iViolationIndex, iLineNumber in enumerate(self.violations):
oLine = oFile.lines[iLineNumber]
oLine.line = ' ' * self.correctCommentColumn[iViolationIndex] + oLine.line.lstrip()
oLine.lineLower = oLine.line.lower()
oLine.commentColumn = self.correctCommentColumn[iViolationIndex]
self.correctCommentColumn = []
# class rule_002(comment_rule):
# '''Case rule 002 checks for the proper alignment of comments.'''
#
# def __init__(self):
# comment_rule.__init__(self)
# self.identifier = '002'
# self.solution = 'Ensure proper alignment of comment with previous line.'
# self.phase = 5
#
# def analyze(self, oFile):
# for iLineNumber, oLine in enumerate(oFile.lines):
# if iLineNumber > 0:
# oPreviousLine = oFile.lines[iLineNumber - 1]
# if not oLine.isComment and oLine.hasComment:
# if oLine.isCaseWhenKeyword:
# if not oPreviousLine.isComment and oPreviousLine.hasComment:
# if not oLine.commentColumn == oPreviousLine.commentColumn:
# self.add_violation(iLineNumber)
# if oPreviousLine.isComment:
# if not oPreviousLine.commentColumn == (oPreviousLine.indentLevel * self.indentSize) and \
# not oPreviousLine.commentColumn == ((oPreviousLine.indentLevel - 1) * self.indentSize):
# if not oLine.commentColumn == oPreviousLine.commentColumn:
# self.add_violation(iLineNumber)
# else:
# if not oPreviousLine.isComment and oPreviousLine.hasComment:
# if not oLine.commentColumn == oPreviousLine.commentColumn:
# self.add_violation(iLineNumber)
# if oPreviousLine.isComment:
# if not oPreviousLine.commentColumn == (oPreviousLine.indentLevel * self.indentSize):
# if not oLine.commentColumn == oPreviousLine.commentColumn:
# self.add_violation(iLineNumber)
# if oLine.isComment:
# if oPreviousLine.hasComment:
# if not oPreviousLine.isComment:
# if not oLine.commentColumn == oPreviousLine.commentColumn:
# if not oLine.commentColumn == (oLine.indentLevel * self.indentSize):
# self.add_violation(iLineNumber)
class rule_003(comment_rule):
'''Comment rule 003 ensures the alignment of "--" keywords between process "begin" and "end process" keywords.'''
def __init__(self):
comment_rule.__init__(self)
self.identifier = '003'
self.solution = 'Inconsistent alignment of comments within process.'
self.phase = 5
def analyze(self, oFile):
lGroup = []
fGroupFound = False
iStartGroupIndex = None
for iLineNumber, oLine in enumerate(oFile.lines):
if oLine.isProcessBegin and not fGroupFound:
fGroupFound = True
iStartGroupIndex = iLineNumber
if oLine.isEndProcess:
lGroup.append(oLine)
fGroupFound = False
self._check_keyword_alignment(iStartGroupIndex, '--', lGroup)
lGroup = []
iStartGroupIndex = None
if fGroupFound:
if oLine.isComment:
lGroup.append(line.line('Comment removed'))
else:
lGroup.append(oLine)
def _fix_violations(self, oFile):
self._fix_keyword_alignment(oFile)
class rule_004(comment_rule):
'''Comment rule 004 ensures there is at least one space before comments on a line with code.'''
def __init__(self):
comment_rule.__init__(self)
self.identifier = '004'
self.solution = 'Add a space before the comment --'
self.phase = 2
def analyze(self, oFile):
lGroup = []
fGroupFound = False
iStartGroupIndex = None
for iLineNumber, oLine in enumerate(oFile.lines):
if oLine.hasComment and not oLine.isComment:
if not re.match('^.*\s--', oLine.line):
self.add_violation(iLineNumber)
def _fix_violations(self, oFile):
for iLineNumber in self.violations:
self._enforce_one_space_before_word(oFile.lines[iLineNumber], '--')