Adding rule interface_incomplete_type_declaration_600.

Author: jeremiah-c-leary

docs/configuring_disabled_rules.rst

@@ -59,6 +59,9 @@ Rules Disabled by Default
 * `generic_map_601 <generic_map_rules.html#generic-map-601>`_
 * `instantiation_600 <instantiation_rules.html#instantiation-600>`_
 * `instantiation_601 <instantiation_rules.html#instantiation-601>`_
+
+* `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
+
 * `loop_statement_006 <loop_statement_rules.html#loop-statement-006>`_
 * `loop_statement_007 <loop_statement_rules.html#loop-statement-007>`_
 * `loop_statement_600 <loop_statement_rules.html#loop-statement-600>`_

docs/configuring_prefix_and_suffix_rules.rst

@@ -48,3 +48,28 @@ This rule checks the type name has proper case.
 
    generic (
      type generic_data_type
+
+interface_incomplete_type_declaration_600
+#########################################
+
+|phase_7| |disabled| |error| |unfixable| |naming|
+
+This rule checks for valid prefixes of type names.
+
+.. NOTE::  The default prefix is *gt_*.
+
+|configuring_prefix_and_suffix_rules_link|
+
+**Violation**
+
+.. code-block:: vhdl
+
+   generic (
+     type generic_data_type
+
+**Fix**
+
+.. code-block:: vhdl
+
+   generic (
+     type gt_generic_data_type

docs/interface_incomplete_type_declaration_rules.rst

@@ -24,6 +24,9 @@ Rules Enforcing Naming Rule Group
 * `generic_map_601 <../generic_map_rules.html#generic-map-601>`_
 * `instantiation_600 <../instantiation_rules.html#instantiation-600>`_
 * `instantiation_601 <../instantiation_rules.html#instantiation-601>`_
+
+* `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
+
 * `loop_statement_600 <../loop_statement_rules.html#loop-statement-600>`_
 * `loop_statement_601 <../loop_statement_rules.html#loop-statement-601>`_
 * `loop_statement_602 <../loop_statement_rules.html#loop-statement-602>`_

docs/rule_groups/naming_rule_group.rst

@@ -103,6 +103,9 @@ With multiple options available, the user is required to make the decision.
 * `generic_map_601 <generic_map_rules.html#generic-map-601>`_
 * `instantiation_600 <instantiation_rules.html#instantiation-600>`_
 * `instantiation_601 <instantiation_rules.html#instantiation-601>`_
+
+* `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
+
 * `loop_statement_600 <loop_statement_rules.html#loop-statement-600>`_
 * `loop_statement_601 <loop_statement_rules.html#loop-statement-601>`_
 * `loop_statement_602 <loop_statement_rules.html#loop-statement-602>`_

docs/unfixable_rules.rst

@@ -0,0 +1,36 @@
+
+entity fifo is
+  generic (
+    type gt_generic_data_type;
+    type generic_data_type;
+    type t_generic_data_type
+  );
+  port (
+    data_in : generic_data_type
+  );
+end entity fifo;
+
+architecture rtl of fifo is
+
+  component buffer is
+    generic (
+      type gt_generic_data_type;
+      type generic_data_type;
+      type t_generic_data_type
+    );
+    port (
+        data_in : generic_data_type
+    );
+  end component buffer;
+
+begin
+
+  buf1 : buffer
+    generic map (
+        generic_data_type => std_logic
+    )
+    port map (
+        data_in => '0'
+    );
+
+end architecture rtl;

tests/interface_incomplete_type_declaration/rule_600_test_input.vhd

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+
+import os
+import unittest
+
+from tests import utils
+from vsg import vhdlFile
+from vsg.rules import interface_incomplete_type_declaration
+
+sTestDir = os.path.dirname(__file__)
+
+lFile, eError = vhdlFile.utils.read_vhdlfile(os.path.join(sTestDir, "rule_600_test_input.vhd"))
+
+
+class test_rule(unittest.TestCase):
+    def setUp(self):
+        self.oFile = vhdlFile.vhdlFile(lFile)
+        self.assertIsNone(eError)
+
+    def test_rule_600(self):
+        oRule = interface_incomplete_type_declaration.rule_600()
+        self.assertTrue(oRule)
+        self.assertEqual(oRule.name, "interface_incomplete_type_declaration")
+        self.assertEqual(oRule.identifier, "600")
+
+        lExpected = [5, 6, 18, 19]
+
+        oRule.analyze(self.oFile)
+        self.assertEqual(lExpected, utils.extract_violation_lines_from_violation_object(oRule.violations))

tests/interface_incomplete_type_declaration/test_rule_600.py

@@ -2,3 +2,5 @@
 
 from .rule_500 import rule_500
 from .rule_501 import rule_501
+
+from .rule_600 import rule_600

vsg/rules/interface_incomplete_type_declaration/__init__.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+from vsg import token
+from vsg.rules import token_prefix
+
+lTokens = []
+lTokens.append(token.interface_incomplete_type_declaration.identifier)
+
+
+class rule_600(token_prefix):
+    """
+    This rule checks for valid prefixes of type names.
+
+    .. NOTE::  The default prefix is *gt_*.
+
+    |configuring_prefix_and_suffix_rules_link|
+
+    **Violation**
+
+    .. code-block:: vhdl
+
+       generic (
+         type generic_data_type
+
+    **Fix**
+
+    .. code-block:: vhdl
+
+       generic (
+         type gt_generic_data_type
+    """
+
+    def __init__(self):
+        super().__init__(lTokens)
+        self.prefixes = ["gt_"]
+        self.solution = "Type identifiers"