added signal suffix rule

This commit is contained in:
imd 2021-05-01 21:02:55 +01:00
parent d84b6e1346
commit 71c030a254
6 changed files with 95 additions and 1 deletions

View File

@ -65,7 +65,7 @@ Rules Enforcing Prefixes and Suffixes
+-------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Process Label | `process_036 <process_rules.html#process-036>`_ | `process_600 <process_rules.html#process-600>`_ |
+-------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Signal Identifier | `signal_008 <signal_rules.html#signal-008>`_ | NA |
| Signal Identifier | `signal_008 <signal_rules.html#signal-008>`_ | `signal_600 <signal_rules.html#signal-600>`_ |
+-------------------------+----------------------------------------------------------------+----------------------------------------------------------------+
| Subtype Identifier | `subtype_004 <subtype_rules.html#subtype-004>`_ | NA |
+-------------------------+----------------------------------------------------------------+----------------------------------------------------------------+

View File

@ -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 <configuring.html#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;

View File

@ -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

View File

@ -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'

View File

@ -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;

View File

@ -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))