Skip to content

Commit 1247327

Browse files
authored
Issue#1389: Whitespace rules for case-generate statements (#1390)
* Issue#1389: Expanded on case rules to check that they don't affect case-generates. * Issue#1389: Added new case generate rules. * Issue#1389: Added tests for new case generate rules. * Issue#1389: Added documentation for new case generate rules. * Issue#1389: Corrected test file reference. * Issue#1389: Corrected code snippet. * Issue#1389: Corrected code snippet. * Issue#1389: Connected code snippets * Issue#1389: Corrected code snippet. * Issue#1389: Corrected code snippet * Issue#1389: Updated rules to use simpler base rules where possible. * Issue#1389: Updated rules to use simpler base rules where possible. * Issue#1389: Corrected mistake in case_004.
1 parent 009cb1b commit 1247327

33 files changed

+950
-18
lines changed

docs/case_generate_alternative_rules.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,56 @@
33
Case Generate Alternative Rules
44
-------------------------------
55

6+
case_generate_alternative_100
7+
#############################
8+
9+
|phase_2| |error| |whitespace|
10+
11+
This rule checks for a single space after the **when** keyword.
12+
13+
|configuring_whitespace_rules_link|
14+
15+
**Violation**
16+
17+
.. code-block:: vhdl
18+
19+
case data generate
20+
21+
when 3 =>
22+
23+
**Fix**
24+
25+
.. code-block:: vhdl
26+
27+
case data generate
28+
29+
when 3 =>
30+
31+
case_generate_alternative_101
32+
#############################
33+
34+
|phase_2| |error| |whitespace|
35+
36+
This rule checks for a single space before the **=>** operator.
37+
38+
|configuring_whitespace_rules_link|
39+
40+
**Violation**
41+
42+
.. code-block:: vhdl
43+
44+
case data generate
45+
46+
when 3 =>
47+
48+
**Fix**
49+
50+
.. code-block:: vhdl
51+
52+
case data generate
53+
54+
when 3 =>
55+
656
case_generate_alternative_300
757
#############################
858

docs/case_generate_statement_rules.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,49 @@
33
Case Generate Statement Rules
44
-----------------------------
55

6+
case_generate_statement_100
7+
###########################
8+
9+
|phase_2| |error| |whitespace|
10+
11+
This rule checks for a single space after the **case** keyword.
12+
13+
|configuring_whitespace_rules_link|
14+
15+
**Violation**
16+
17+
.. code-block:: vhdl
18+
19+
case data generate
20+
21+
22+
**Fix**
23+
24+
.. code-block:: vhdl
25+
26+
case data generate
27+
28+
case_generate_statement_101
29+
###########################
30+
31+
|phase_2| |error| |whitespace|
32+
33+
This rule checks for a single space before the **generate** keyword.
34+
35+
|configuring_whitespace_rules_link|
36+
37+
**Violation**
38+
39+
.. code-block:: vhdl
40+
41+
case data generate
42+
43+
**Fix**
44+
45+
.. code-block:: vhdl
46+
47+
case data generate
48+
649
case_generate_statement_400
750
###########################
851

docs/configuring_whitespace_rules.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,10 @@ Rules Enforcing Whitespace
136136
* `case_004 <case_rules.html#case-004>`_
137137
* `case_005 <case_rules.html#case-005>`_
138138
* `case_006 <case_rules.html#case-006>`_
139+
* `case_generate_alternative_100 <case_generate_alternative_rules.html#case-generate-alternative-100>`_
140+
* `case_generate_alternative_101 <case_generate_alternative_rules.html#case-generate-alternative-101>`_
141+
* `case_generate_statement_100 <case_generate_statement_rules.html#case-generate-statement-100>`_
142+
* `case_generate_statement_101 <case_generate_statement_rules.html#case-generate-statement-101>`_
139143
* `comment_004 <comment_rules.html#comment-004>`_
140144
* `component_002 <component_rules.html#component-002>`_
141145
* `component_007 <component_rules.html#component-007>`_

docs/rule_groups/whitespace_rule_group.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ Rules Enforcing Whitespace Rule Group
2929
* `case_004 <../case_rules.html#case-004>`_
3030
* `case_005 <../case_rules.html#case-005>`_
3131
* `case_006 <../case_rules.html#case-006>`_
32+
* `case_generate_alternative_100 <../case_generate_alternative_rules.html#case-generate-alternative-100>`_
33+
* `case_generate_alternative_101 <../case_generate_alternative_rules.html#case-generate-alternative-101>`_
34+
* `case_generate_statement_100 <../case_generate_statement_rules.html#case-generate-statement-100>`_
35+
* `case_generate_statement_101 <../case_generate_statement_rules.html#case-generate-statement-101>`_
3236
* `comment_004 <../comment_rules.html#comment-004>`_
3337
* `comment_100 <../comment_rules.html#comment-100>`_
3438
* `component_002 <../component_rules.html#component-002>`_

tests/case/rule_002_test_input.fixed.vhd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,14 @@ begin
3333

3434
end process PROC_2;
3535

36+
gen_label : case boolean_1 generate
37+
38+
when STATE_1 =>
39+
40+
a <= b;
41+
b <= c;
42+
c <= d;
43+
44+
end generate;
45+
3646
end architecture ARCH;

tests/case/rule_002_test_input.vhd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,14 @@ begin
3333

3434
end process PROC_2;
3535

36+
gen_label : case boolean_1 generate
37+
38+
when STATE_1 =>
39+
40+
a <= b;
41+
b <= c;
42+
c <= d;
43+
44+
end generate;
45+
3646
end architecture ARCH;

tests/case/rule_003_test_input.fixed.vhd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,14 @@ begin
3333

3434
end process PROC_2;
3535

36+
gen_label : case boolean_1 generate
37+
38+
when STATE_1 =>
39+
40+
a <= b;
41+
b <= c;
42+
c <= d;
43+
44+
end generate;
45+
3646
end architecture ARCH;

tests/case/rule_003_test_input.vhd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,14 @@ begin
3333

3434
end process PROC_2;
3535

36+
gen_label : case boolean_1 generate
37+
38+
when STATE_1 =>
39+
40+
a <= b;
41+
b <= c;
42+
c <= d;
43+
44+
end generate;
45+
3646
end architecture ARCH;

tests/case/rule_004_test_input.fixed.vhd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,14 @@ begin
3333

3434
end process PROC_2;
3535

36+
gen_label : case boolean_1 generate
37+
38+
when STATE_1 =>
39+
40+
a <= b;
41+
b <= c;
42+
c <= d;
43+
44+
end generate;
45+
3646
end architecture ARCH;

tests/case/rule_004_test_input.vhd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,14 @@ begin
3333

3434
end process PROC_2;
3535

36+
gen_label : case boolean_1 generate
37+
38+
when STATE_1 =>
39+
40+
a <= b;
41+
b <= c;
42+
c <= d;
43+
44+
end generate;
45+
3646
end architecture ARCH;

0 commit comments

Comments
 (0)