diff --git a/docs/configuring_prefix_suffix_rules.rst b/docs/configuring_prefix_suffix_rules.rst index f40ca917..0bc39b2f 100644 --- a/docs/configuring_prefix_suffix_rules.rst +++ b/docs/configuring_prefix_suffix_rules.rst @@ -65,7 +65,7 @@ Rules Enforcing Prefixes and Suffixes +-------------------------+----------------------------------------------------------------+----------------------------------------------------------------+ | Process Label | `process_036 `_ | `process_600 `_ | +-------------------------+----------------------------------------------------------------+----------------------------------------------------------------+ -| Signal Identifier | `signal_008 `_ | NA | +| Signal Identifier | `signal_008 `_ | `signal_600 `_ | +-------------------------+----------------------------------------------------------------+----------------------------------------------------------------+ | Subtype Identifier | `subtype_004 `_ | NA | +-------------------------+----------------------------------------------------------------+----------------------------------------------------------------+ diff --git a/docs/signal_rules.rst b/docs/signal_rules.rst index 9f3e1fac..db119d37 100644 --- a/docs/signal_rules.rst +++ b/docs/signal_rules.rst @@ -354,3 +354,33 @@ This rule checks the signal declaration is on a single line. signal sig1 : std_logic; signal sig2 : std_logic; + +Naming Convention Rules (600 - 699) +################################### + +signal_600 +########## + +|phase_7| |disabled| |error| + +This rule checks for valid suffixes on signal identifiers. +Default signal suffix is *\_s*. + +Refer to the section `Configuring Prefix and Suffix Rules `_ for information on changing the allowed suffixes. + +**Violation** + +.. code-block:: vhdl + + signal wr_en : std_logic; + signal rd_en : std_logic; + +**Fix** + +.. code-block:: vhdl + + signal wr_en_s : std_logic; + signal rd_en_s : std_logic; + + + diff --git a/vsg/rules/signal/__init__.py b/vsg/rules/signal/__init__.py index 12f4f03a..3415e0b3 100644 --- a/vsg/rules/signal/__init__.py +++ b/vsg/rules/signal/__init__.py @@ -13,3 +13,5 @@ from .rule_012 import rule_012 from .rule_014 import rule_014 from .rule_015 import rule_015 from .rule_016 import rule_016 + +from .rule_600 import rule_600 diff --git a/vsg/rules/signal/rule_600.py b/vsg/rules/signal/rule_600.py new file mode 100644 index 00000000..fcdf6a93 --- /dev/null +++ b/vsg/rules/signal/rule_600.py @@ -0,0 +1,18 @@ + +from vsg.rules import token_suffix + +from vsg import token + +lTokens = [] +lTokens.append(token.signal_declaration.identifier) + + +class rule_600(token_suffix): + ''' + Constant rule 600 checks for suffixes in signal identifiers. + ''' + + def __init__(self): + token_suffix.__init__(self, 'signal', '600', lTokens) + self.suffixes = ['_s'] + self.solution = 'Signal identifiers' diff --git a/vsg/tests/signal/rule_600_test_input.vhd b/vsg/tests/signal/rule_600_test_input.vhd new file mode 100644 index 00000000..2e1bceb2 --- /dev/null +++ b/vsg/tests/signal/rule_600_test_input.vhd @@ -0,0 +1,15 @@ + +architecture RTL of FIFO is + + signal sig1_s : std_logic; + signal sig2_s : std_logic; + + -- Violations below + + signal sig1 : std_logic; + signal sig2 : std_logic; + + +begin + +end architecture RTL; diff --git a/vsg/tests/signal/test_rule_600.py b/vsg/tests/signal/test_rule_600.py new file mode 100644 index 00000000..249055c4 --- /dev/null +++ b/vsg/tests/signal/test_rule_600.py @@ -0,0 +1,29 @@ + +import os +import unittest + +from vsg.rules import signal +from vsg import vhdlFile +from vsg.tests import utils + +sTestDir = os.path.dirname(__file__) + +lFile, eError =vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir,'rule_600_test_input.vhd')) + + +class test_signal_rule(unittest.TestCase): + + def setUp(self): + self.oFile = vhdlFile.vhdlFile(lFile) + self.assertIsNone(eError) + + def test_rule_600(self): + oRule = signal.rule_600() + self.assertTrue(oRule) + self.assertEqual(oRule.name, 'signal') + self.assertEqual(oRule.identifier, '600') + + lExpected = [9, 10] + + oRule.analyze(self.oFile) + self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))