Issue#1273: Added rules to enforce `in` keywords in for loops/generates (#1274)

* Issue#1273: Added rules for_generate_statement_502 and iteration_scheme_502.

* Issue#1273: Added tests for rules for_generate_statement_502 and iteration_scheme_502.

* Issue#1273: Added documentation for rules for_generate_statement_502 and iteration_scheme_502.
This commit is contained in:
JHertz5 2024-10-20 15:03:37 +01:00 committed by GitHub
parent 32ff55eb6a
commit d57c9c186b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
18 changed files with 349 additions and 0 deletions

View File

@ -324,6 +324,7 @@ Rules Enforcing Case
* `for_generate_statement_500 <for_generate_statement_rules.html#for-generate-statement-500>`_
* `for_generate_statement_501 <for_generate_statement_rules.html#for-generate-statement-501>`_
* `for_generate_statement_502 <for_generate_statement_rules.html#for-generate-statement-502>`_
* `function_004 <function_rules.html#function-004>`_
* `function_005 <function_rules.html#function-005>`_
@ -370,6 +371,7 @@ Rules Enforcing Case
* `iteration_scheme_500 <iteration_scheme_rules.html#iteration-scheme-500>`_
* `iteration_scheme_501 <iteration_scheme_rules.html#iteration-scheme-501>`_
* `iteration_scheme_502 <iteration_scheme_rules.html#iteration-scheme-502>`_
* `library_004 <library_rules.html#library-004>`_
* `library_005 <library_rules.html#library-005>`_

View File

@ -44,3 +44,24 @@ This rule checks the *generate* keyword has proper case.
.. code-block:: vhdl
for x in range (3 downto 0) generate
for_generate_statement_502
##########################
|phase_6| |error| |case| |case_keyword|
This rule checks the **in** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
gen_label : for lv_thing IN t_thing generate
**Fix**
.. code-block:: vhdl
gen_label : for lv_thing in t_thing generate

View File

@ -151,3 +151,24 @@ This rule checks the **for** keyword has proper case.
.. code-block:: vhdl
for x in (31 downto 0) loop
iteration_scheme_502
####################
|phase_6| |error| |case| |case_keyword|
This rule checks the **in** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
for lv_thing IN t_thing loop
**Fix**
.. code-block:: vhdl
for lv_thing in t_thing loop

View File

@ -63,6 +63,7 @@ Rules Enforcing Case::Keyword Rule Group
* `file_002 <../file_rules.html#file-002>`_
* `for_generate_statement_500 <../for_generate_statement_rules.html#for-generate-statement-500>`_
* `for_generate_statement_501 <../for_generate_statement_rules.html#for-generate-statement-501>`_
* `for_generate_statement_502 <../for_generate_statement_rules.html#for-generate-statement-502>`_
* `function_004 <../function_rules.html#function-004>`_
* `function_005 <../function_rules.html#function-005>`_
* `function_013 <../function_rules.html#function-013>`_
@ -91,6 +92,7 @@ Rules Enforcing Case::Keyword Rule Group
* `instantiation_031 <../instantiation_rules.html#instantiation-031>`_
* `iteration_scheme_500 <../iteration_scheme_rules.html#iteration-scheme-500>`_
* `iteration_scheme_501 <../iteration_scheme_rules.html#iteration-scheme-501>`_
* `iteration_scheme_502 <../iteration_scheme_rules.html#iteration-scheme-502>`_
* `library_004 <../library_rules.html#library-004>`_
* `library_005 <../library_rules.html#library-005>`_
* `logical_operator_500 <../logical_operator_rules.html#logical-operator-500>`_

View File

@ -89,6 +89,7 @@ Rules Enforcing Case Rule Group
* `file_002 <../file_rules.html#file-002>`_
* `for_generate_statement_500 <../for_generate_statement_rules.html#for-generate-statement-500>`_
* `for_generate_statement_501 <../for_generate_statement_rules.html#for-generate-statement-501>`_
* `for_generate_statement_502 <../for_generate_statement_rules.html#for-generate-statement-502>`_
* `function_004 <../function_rules.html#function-004>`_
* `function_005 <../function_rules.html#function-005>`_
* `function_010 <../function_rules.html#function-010>`_
@ -127,6 +128,7 @@ Rules Enforcing Case Rule Group
* `instantiation_031 <../instantiation_rules.html#instantiation-031>`_
* `iteration_scheme_500 <../iteration_scheme_rules.html#iteration-scheme-500>`_
* `iteration_scheme_501 <../iteration_scheme_rules.html#iteration-scheme-501>`_
* `iteration_scheme_502 <../iteration_scheme_rules.html#iteration-scheme-502>`_
* `library_004 <../library_rules.html#library-004>`_
* `library_005 <../library_rules.html#library-005>`_
* `library_500 <../library_rules.html#library-500>`_

View File

View File

@ -0,0 +1,14 @@
architecture rtl of fifo is
begin
gen_label : for x in range (3 downto 0) generate
end generate;
gen_label : for x in range (3 downto 0) generate
end generate;
end architecture;

View File

@ -0,0 +1,14 @@
architecture rtl of fifo is
begin
gen_label : for x IN range (3 downto 0) generate
end generate;
gen_label : for x IN range (3 downto 0) generate
end generate;
end architecture;

View File

@ -0,0 +1,14 @@
architecture rtl of fifo is
begin
gen_label : for x in range (3 downto 0) generate
end generate;
gen_label : for x IN range (3 downto 0) generate
end generate;
end architecture;

View File

@ -0,0 +1,73 @@
# -*- coding: utf-8 -*-
import os
import unittest
from tests import utils
from vsg import vhdlFile
from vsg.rules import for_generate_statement
sTestDir = os.path.dirname(__file__)
lFile, eError = vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir, "rule_502_test_input.vhd"))
lExpected_lower = []
lExpected_lower.append("")
utils.read_file(os.path.join(sTestDir, "rule_502_test_input.fixed_lower.vhd"), lExpected_lower)
lExpected_upper = []
lExpected_upper.append("")
utils.read_file(os.path.join(sTestDir, "rule_502_test_input.fixed_upper.vhd"), lExpected_upper)
class test_for_generate_statement_rule(unittest.TestCase):
def setUp(self):
self.oFile = vhdlFile.vhdlFile(lFile)
self.assertIsNone(eError)
def test_rule_502_lower(self):
oRule = for_generate_statement.rule_502()
self.assertTrue(oRule)
self.assertEqual(oRule.name, "for_generate_statement")
self.assertEqual(oRule.identifier, "502")
lExpected = [10]
oRule.analyze(self.oFile)
self.assertEqual(utils.extract_violation_lines_from_violation_object(oRule.violations), lExpected)
def test_rule_502_upper(self):
oRule = for_generate_statement.rule_502()
oRule.case = "upper"
self.assertTrue(oRule)
self.assertEqual(oRule.name, "for_generate_statement")
self.assertEqual(oRule.identifier, "502")
lExpected = [6]
oRule.analyze(self.oFile)
self.assertEqual(utils.extract_violation_lines_from_violation_object(oRule.violations), lExpected)
def test_fix_rule_502_lower(self):
oRule = for_generate_statement.rule_502()
oRule.fix(self.oFile)
lActual = self.oFile.get_lines()
self.assertEqual(lExpected_lower, lActual)
oRule.analyze(self.oFile)
self.assertEqual(oRule.violations, [])
def test_fix_rule_502_upper(self):
oRule = for_generate_statement.rule_502()
oRule.case = "upper"
oRule.fix(self.oFile)
lActual = self.oFile.get_lines()
self.assertEqual(lExpected_upper, lActual)
oRule.analyze(self.oFile)
self.assertEqual(oRule.violations, [])

View File

@ -0,0 +1,14 @@
architecture rtl of fifo is
begin
process begin
for x in (31 downto 0) loop end loop;
for x in (31 downto 0) loop end loop;
end process;
end;

View File

@ -0,0 +1,14 @@
architecture rtl of fifo is
begin
process begin
for x IN (31 downto 0) loop end loop;
for x IN (31 downto 0) loop end loop;
end process;
end;

View File

@ -0,0 +1,14 @@
architecture rtl of fifo is
begin
process begin
for x in (31 downto 0) loop end loop;
for x IN (31 downto 0) loop end loop;
end process;
end;

View File

@ -0,0 +1,74 @@
# -*- coding: utf-8 -*-
import os
import unittest
from tests import utils
from vsg import vhdlFile
from vsg.rules import iteration_scheme
sTestDir = os.path.dirname(__file__)
lFile, eError = vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir, "rule_502_test_input.vhd"))
lExpected_lower = []
lExpected_lower.append("")
utils.read_file(os.path.join(sTestDir, "rule_502_test_input.fixed_lower.vhd"), lExpected_lower)
lExpected_upper = []
lExpected_upper.append("")
utils.read_file(os.path.join(sTestDir, "rule_502_test_input.fixed_upper.vhd"), lExpected_upper)
class test_iteration_scheme_rule(unittest.TestCase):
def setUp(self):
self.oFile = vhdlFile.vhdlFile(lFile)
self.assertIsNone(eError)
def test_rule_502_lower(self):
oRule = iteration_scheme.rule_502()
self.assertTrue(oRule)
self.assertEqual(oRule.name, "iteration_scheme")
self.assertEqual(oRule.identifier, "502")
self.assertEqual(oRule.groups, ["case", "case::keyword"])
lExpected = [10]
oRule.analyze(self.oFile)
self.assertEqual(utils.extract_violation_lines_from_violation_object(oRule.violations), lExpected)
def test_rule_502_upper(self):
oRule = iteration_scheme.rule_502()
oRule.case = "upper"
self.assertTrue(oRule)
self.assertEqual(oRule.name, "iteration_scheme")
self.assertEqual(oRule.identifier, "502")
lExpected = [8]
oRule.analyze(self.oFile)
self.assertEqual(utils.extract_violation_lines_from_violation_object(oRule.violations), lExpected)
def test_fix_rule_502_lower(self):
oRule = iteration_scheme.rule_502()
oRule.fix(self.oFile)
lActual = self.oFile.get_lines()
self.assertEqual(lExpected_lower, lActual)
oRule.analyze(self.oFile)
self.assertEqual(oRule.violations, [])
def test_fix_rule_502_upper(self):
oRule = iteration_scheme.rule_502()
oRule.case = "upper"
oRule.fix(self.oFile)
lActual = self.oFile.get_lines()
self.assertEqual(lExpected_upper, lActual)
oRule.analyze(self.oFile)
self.assertEqual(oRule.violations, [])

View File

@ -2,3 +2,4 @@
from .rule_500 import rule_500
from .rule_501 import rule_501
from .rule_502 import rule_502

View File

@ -0,0 +1,34 @@
# -*- coding: utf-8 -*-
from vsg import token
from vsg.rules import token_case_in_range_bounded_by_tokens
lTokens = []
lTokens.append(token.parameter_specification.in_keyword)
oStartToken = token.for_generate_statement.for_keyword
oEndToken = token.for_generate_statement.generate_keyword
class rule_502(token_case_in_range_bounded_by_tokens):
"""
This rule checks the **in** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
gen_label : for lv_thing IN t_thing generate
**Fix**
.. code-block:: vhdl
gen_label : for lv_thing in t_thing generate
"""
def __init__(self):
super().__init__(lTokens, oStartToken, oEndToken)
self.groups.append("case::keyword")

View File

@ -6,3 +6,4 @@ from .rule_300 import rule_300
from .rule_301 import rule_301
from .rule_500 import rule_500
from .rule_501 import rule_501
from .rule_502 import rule_502

View File

@ -0,0 +1,34 @@
# -*- coding: utf-8 -*-
from vsg import token
from vsg.rules import token_case_in_range_bounded_by_tokens
lTokens = []
lTokens.append(token.parameter_specification.in_keyword)
oStartToken = token.iteration_scheme.for_keyword
oEndToken = token.loop_statement.loop_keyword
class rule_502(token_case_in_range_bounded_by_tokens):
"""
This rule checks the **in** keyword has proper case.
|configuring_uppercase_and_lowercase_rules_link|
**Violation**
.. code-block:: vhdl
for lv_thing IN t_thing loop
**Fix**
.. code-block:: vhdl
for lv_thing in t_thing loop
"""
def __init__(self):
super().__init__(lTokens, oStartToken, oEndToken)
self.groups.append("case::keyword")