Skip to content

Commit 54405d9

Browse files
Issue 1402 (#1406)
* Issue#1402: Adding rule interface_incomplete_type_declaration_500 * Adding rule interface_incomplete_type_declaration_501. * Adding rule interface_incomplete_type_declaration_600. * Adding rule interface_incomplete_type_declaration_601. * Fixing style issues.
1 parent d6422f7 commit 54405d9

35 files changed

+1009
-62
lines changed

docs/configuring_disabled_rules.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ Rules Disabled by Default
5959
* `generic_map_601 <generic_map_rules.html#generic-map-601>`_
6060
* `instantiation_600 <instantiation_rules.html#instantiation-600>`_
6161
* `instantiation_601 <instantiation_rules.html#instantiation-601>`_
62+
63+
* `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
64+
* `interface_incomplete_type_declaration_601 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-601>`_
65+
6266
* `loop_statement_006 <loop_statement_rules.html#loop-statement-006>`_
6367
* `loop_statement_007 <loop_statement_rules.html#loop-statement-007>`_
6468
* `loop_statement_600 <loop_statement_rules.html#loop-statement-600>`_

docs/configuring_prefix_and_suffix_rules.rst

Lines changed: 41 additions & 39 deletions
Large diffs are not rendered by default.

docs/configuring_uppercase_and_lowercase_rules.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,9 @@ Rules Enforcing Case
416416
* `instantiation_031 <instantiation_rules.html#instantiation-031>`_
417417
* `instantiation_500 <instantiation_rules.html#instantiation-500>`_
418418

419+
* `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
420+
* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
421+
419422
* `iteration_scheme_500 <iteration_scheme_rules.html#iteration-scheme-500>`_
420423
* `iteration_scheme_501 <iteration_scheme_rules.html#iteration-scheme-501>`_
421424

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
.. include:: includes.rst
2+
3+
Interface Incomplete Type Declaration Rules
4+
-------------------------------------------
5+
6+
interface_incomplete_type_declaration_500
7+
#########################################
8+
9+
|phase_6| |error| |case| |case_keyword|
10+
11+
This rule checks the **type** keyword has proper case.
12+
13+
|configuring_uppercase_and_lowercase_rules_link|
14+
15+
**Violation**
16+
17+
.. code-block:: vhdl
18+
19+
generic (
20+
TYPE generic_data_type
21+
22+
**Fix**
23+
24+
.. code-block:: vhdl
25+
26+
generic (
27+
type generic_data_type
28+
29+
interface_incomplete_type_declaration_501
30+
#########################################
31+
32+
|phase_6| |error| |case| |case_name|
33+
34+
This rule checks the type name has proper case.
35+
36+
|configuring_uppercase_and_lowercase_rules_link|
37+
38+
**Violation**
39+
40+
.. code-block:: vhdl
41+
42+
generic (
43+
type GENERIC_DATA_TYPE
44+
45+
**Fix**
46+
47+
.. code-block:: vhdl
48+
49+
generic (
50+
type generic_data_type
51+
52+
interface_incomplete_type_declaration_600
53+
#########################################
54+
55+
|phase_7| |disabled| |error| |unfixable| |naming|
56+
57+
This rule checks for valid prefixes of type names.
58+
59+
.. NOTE:: The default prefix is *gt_*.
60+
61+
|configuring_prefix_and_suffix_rules_link|
62+
63+
**Violation**
64+
65+
.. code-block:: vhdl
66+
67+
generic (
68+
type generic_data_type
69+
70+
**Fix**
71+
72+
.. code-block:: vhdl
73+
74+
generic (
75+
type gt_generic_data_type
76+
77+
interface_incomplete_type_declaration_601
78+
#########################################
79+
80+
|phase_7| |disabled| |error| |unfixable| |naming|
81+
82+
This rule checks for valid suffixes of type names.
83+
84+
.. NOTE:: The default prefix is *_gt*.
85+
86+
|configuring_prefix_and_suffix_rules_link|
87+
88+
**Violation**
89+
90+
.. code-block:: vhdl
91+
92+
generic (
93+
type generic_data_type
94+
95+
**Fix**
96+
97+
.. code-block:: vhdl
98+
99+
generic (
100+
type generic_data_type_gt

docs/rule_groups/case_keyword_rule_group.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ Rules Enforcing Case::Keyword Rule Group
105105
* `index_subtype_definition_500 <../index_subtype_definition_rules.html#index-subtype-definition-500>`_
106106
* `instantiation_027 <../instantiation_rules.html#instantiation-027>`_
107107
* `instantiation_031 <../instantiation_rules.html#instantiation-031>`_
108+
* `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
108109
* `iteration_scheme_500 <../iteration_scheme_rules.html#iteration-scheme-500>`_
109110
* `iteration_scheme_501 <../iteration_scheme_rules.html#iteration-scheme-501>`_
110111
* `library_004 <../library_rules.html#library-004>`_

docs/rule_groups/case_name_rule_group.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ Rules Enforcing Case::Name Rule Group
3232
* `instantiation_009 <../instantiation_rules.html#instantiation-009>`_
3333
* `instantiation_028 <../instantiation_rules.html#instantiation-028>`_
3434
* `instantiation_500 <../instantiation_rules.html#instantiation-500>`_
35+
36+
* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
37+
3538
* `library_500 <../library_rules.html#library-500>`_
3639
* `package_008 <../package_rules.html#package-008>`_
3740
* `package_010 <../package_rules.html#package-010>`_

docs/rule_groups/case_rule_group.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@ Rules Enforcing Case Rule Group
145145
* `instantiation_028 <../instantiation_rules.html#instantiation-028>`_
146146
* `instantiation_031 <../instantiation_rules.html#instantiation-031>`_
147147
* `instantiation_500 <../instantiation_rules.html#instantiation-500>`_
148+
149+
* `interface_incomplete_type_declaration_500 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-500>`_
150+
* `interface_incomplete_type_declaration_501 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-501>`_
151+
148152
* `iteration_scheme_500 <../iteration_scheme_rules.html#iteration-scheme-500>`_
149153
* `iteration_scheme_501 <../iteration_scheme_rules.html#iteration-scheme-501>`_
150154
* `library_004 <../library_rules.html#library-004>`_

docs/rule_groups/naming_rule_group.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ Rules Enforcing Naming Rule Group
2424
* `generic_map_601 <../generic_map_rules.html#generic-map-601>`_
2525
* `instantiation_600 <../instantiation_rules.html#instantiation-600>`_
2626
* `instantiation_601 <../instantiation_rules.html#instantiation-601>`_
27+
28+
* `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
29+
* `interface_incomplete_type_declaration_601 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-601>`_
30+
2731
* `loop_statement_600 <../loop_statement_rules.html#loop-statement-600>`_
2832
* `loop_statement_601 <../loop_statement_rules.html#loop-statement-601>`_
2933
* `loop_statement_602 <../loop_statement_rules.html#loop-statement-602>`_

docs/rules.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ The rules are divided into categories depending on the part of the VHDL code bei
5555
if_generate_statement_rules.rst
5656
index_subtype_definition_rules.rst
5757
instantiation_rules.rst
58+
interface_incomplete_type_declaration_rules.rst
5859
iteration_scheme_rules.rst
5960
length_rules.rst
6061
library_rules.rst

docs/unfixable_rules.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,10 @@ With multiple options available, the user is required to make the decision.
103103
* `generic_map_601 <generic_map_rules.html#generic-map-601>`_
104104
* `instantiation_600 <instantiation_rules.html#instantiation-600>`_
105105
* `instantiation_601 <instantiation_rules.html#instantiation-601>`_
106+
107+
* `interface_incomplete_type_declaration_600 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-600>`_
108+
* `interface_incomplete_type_declaration_601 <../interface_incomplete_type_declaration_rules.html#interface-incomplete-type-declaration-601>`_
109+
106110
* `loop_statement_600 <loop_statement_rules.html#loop-statement-600>`_
107111
* `loop_statement_601 <loop_statement_rules.html#loop-statement-601>`_
108112
* `loop_statement_602 <loop_statement_rules.html#loop-statement-602>`_

0 commit comments

Comments
 (0)