vhdl-style-guide/vsg/rules/variable/rule_011.py

73 lines
2.2 KiB
Python

from vsg import rule
from vsg import utils
class rule_011(rule.rule):
'''
General rule 011 checks capitalization consistency of variable names.
'''
def __init__(self):
rule.rule.__init__(self, 'variable', '011')
self.fixable = True
self.solution = 'Inconsistent capitalization of word'
self.phase = 6
self.lLowerCaseWords = []
self.lCaseWords = []
self.dDatabase = create_database()
def _analyze(self, oFile, oLine, iLineNumber):
if oLine.isVariable:
self.dDatabase['variable'].append(utils.extract_variable_name(oLine))
if oLine.insideProcess:
lWords = extract_word_list(oLine)
check_violations(self, lWords, iLineNumber)
def _fix_violations(self, oFile):
for iLineNumber in self.violations:
for sWord in self.dFix['violations'][iLineNumber]:
sReplacementWord = get_replacement_word(self, sWord)
utils.change_word(oFile.lines[iLineNumber], sWord, sReplacementWord, 20)
def _get_solution(self, iLineNumber):
if len(self.dFix['violations'][iLineNumber]) > 1:
sSolution = self.solution + 's: ' + ', '.join(self.dFix['violations'][iLineNumber])
else:
sSolution = self.solution + ': ' + ', '.join(self.dFix['violations'][iLineNumber])
return sSolution
def create_database():
dDatabase = {}
dDatabase['variable'] = []
return dDatabase
def extract_word_list(oLine):
sLine = oLine.line
return utils.extract_non_keywords(sLine)
def check_violations(self, lWords, iLineNumber):
for sWord in lWords:
if sWord.lower() in map(str.lower, self.dDatabase['variable']):
if sWord not in self.dDatabase['variable']:
self.add_violation(iLineNumber)
try:
self.dFix['violations'][iLineNumber].append(sWord)
except KeyError:
self.dFix['violations'][iLineNumber] = []
self.dFix['violations'][iLineNumber].append(sWord)
def get_replacement_word(self, sWord):
for sNewWord in self.dDatabase['variable']:
if sNewWord.lower() == sWord.lower():
return sNewWord