Updates for issue #224
Adding case consistency checks for variable names: 1) Added documentation 2) Added tests 3) Added rule variable_011
This commit is contained in:
parent
080be8ae3c
commit
aae2fc9a4e
|
|
@ -178,3 +178,61 @@ This rule checks the variable type is lowercase.
|
|||
|
||||
variable count : integer;
|
||||
|
||||
variable_011
|
||||
############
|
||||
|
||||
This rule checks for consistent capitalization of variable names.
|
||||
|
||||
**Violation**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
architecture RTL of ENTITY1 is
|
||||
|
||||
shared variable var1 : std_logic;
|
||||
shared variable var2 : std_logic;
|
||||
|
||||
begin
|
||||
|
||||
PROC_NAME : process () is
|
||||
|
||||
variable var3 : std_logic;
|
||||
variable var4 : std_logic;
|
||||
|
||||
begin
|
||||
|
||||
Var1 <= '0';
|
||||
|
||||
if (VAR2 = '0') then
|
||||
vaR3 <= '1';
|
||||
elisif (var2 = '1') then
|
||||
VAR4 <= '0';
|
||||
end if;
|
||||
|
||||
end process PROC_NAME;
|
||||
|
||||
end architecture RTL;
|
||||
|
||||
**Fix**
|
||||
|
||||
.. code-block:: vhdl
|
||||
|
||||
PROC_NAME : process () is
|
||||
|
||||
variable var1 : std_logic;
|
||||
variable var2 : std_logic;
|
||||
variable var3 : std_logic;
|
||||
variable var4 : std_logic;
|
||||
|
||||
begin
|
||||
|
||||
var1 <= '0';
|
||||
|
||||
if (var2 = '0') then
|
||||
var3 <= '1';
|
||||
elisif (var2 = '1') then
|
||||
var4 <= '0';
|
||||
end if;
|
||||
|
||||
end process PROC_NAME;
|
||||
|
||||
|
|
|
|||
|
|
@ -9,3 +9,4 @@ from .rule_007 import rule_007
|
|||
|
||||
from .rule_009 import rule_009
|
||||
from .rule_010 import rule_010
|
||||
from .rule_011 import rule_011
|
||||
|
|
|
|||
|
|
@ -0,0 +1,68 @@
|
|||
|
||||
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 not sWord 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
|
||||
|
|
@ -133,9 +133,9 @@ begin
|
|||
|
||||
begin
|
||||
|
||||
SAX := SA(4 downto 3);
|
||||
sax := SA(4 downto 3);
|
||||
|
||||
case SAX is
|
||||
case sax is
|
||||
|
||||
when SA_43_I16 =>
|
||||
adr_x <= IMM;
|
||||
|
|
@ -154,9 +154,9 @@ begin
|
|||
|
||||
begin
|
||||
|
||||
SAZ := SA(2 downto 1);
|
||||
saz := SA(2 downto 1);
|
||||
|
||||
case SAZ is
|
||||
case saz is
|
||||
|
||||
when SA_21_0 =>
|
||||
adr_z <= X"0000";
|
||||
|
|
|
|||
|
|
@ -0,0 +1,27 @@
|
|||
|
||||
architecture RTL of ENTITY1 is
|
||||
|
||||
|
||||
begin
|
||||
|
||||
PROC_NAME : process () is
|
||||
|
||||
variable var1 : std_logic;
|
||||
variable var2 : std_logic;
|
||||
variable var3 : std_logic;
|
||||
variable var4 : std_logic;
|
||||
|
||||
begin
|
||||
|
||||
Var1 <= '0';
|
||||
|
||||
if (VAR2 = '0') then
|
||||
vaR3 <= '1';
|
||||
elsif (var2 = '1') then
|
||||
VAR4 <= '0';
|
||||
end if;
|
||||
|
||||
end process PROC_NAME;
|
||||
|
||||
end architecture RTL;
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
import os
|
||||
|
||||
import unittest
|
||||
import sys
|
||||
sys.path.append('vsg')
|
||||
|
||||
from vsg.rules import variable
|
||||
from vsg import vhdlFile
|
||||
from vsg.tests import utils
|
||||
|
||||
|
||||
class testConsistentCase(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
# Read in test file used for all tests
|
||||
lFile = utils.read_vhdlfile(os.path.join(os.path.dirname(__file__),'consistent_case_test_input.vhd'))
|
||||
self.oFile = vhdlFile.vhdlFile(lFile)
|
||||
|
||||
def test_rule_011(self):
|
||||
oRule = variable.rule_011()
|
||||
self.assertTrue(oRule)
|
||||
self.assertEqual(oRule.name, 'variable')
|
||||
self.assertEqual(oRule.identifier, '011')
|
||||
dExpected = [16, 18, 19, 21]
|
||||
oRule.analyze(self.oFile)
|
||||
self.assertEqual(oRule.violations, dExpected)
|
||||
|
||||
def test_fix_rule_011(self):
|
||||
oRule = variable.rule_011()
|
||||
oRule.fix(self.oFile)
|
||||
oRule.analyze(self.oFile)
|
||||
|
||||
self.assertEqual(self.oFile.lines[16].line, ' var1 <= \'0\';')
|
||||
self.assertEqual(self.oFile.lines[18].line, ' if (var2 = \'0\') then')
|
||||
self.assertEqual(self.oFile.lines[19].line, ' var3 <= \'1\';')
|
||||
self.assertEqual(self.oFile.lines[21].line, ' var4 <= \'0\';')
|
||||
|
||||
self.assertEqual(oRule.violations, [])
|
||||
14
vsg/utils.py
14
vsg/utils.py
|
|
@ -569,3 +569,17 @@ def extract_type_name(oLine):
|
|||
'''
|
||||
sLine = oLine.line.split(':')[0]
|
||||
return sLine.split()[1]
|
||||
|
||||
|
||||
def extract_variable_name(oLine):
|
||||
'''
|
||||
Returns the name of a variable in a variable declaration.
|
||||
|
||||
Parameters:
|
||||
|
||||
oLine: (line object)
|
||||
|
||||
Returns: (string)
|
||||
'''
|
||||
sLine = oLine.line.split(':')[0]
|
||||
return sLine.split()[1]
|
||||
|
|
|
|||
Loading…
Reference in New Issue