Skip to content

Commit b4861c5

Browse files
JHertz5JHertz5
authored
Merge pull request #1516 from JHertz5/issue-1512
Issue#1512: Added rule to align assignment operators in variable declaration arrays
2 parents 938d464 + b748bf4 commit b4861c5

13 files changed

+1096
-0
lines changed

‎docs/configuring_keyword_alignment_rules.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -992,3 +992,4 @@ Rules Enforcing Keyword Alignment
992992
* `subprogram_body_400 <subprogram_body_rules.html#subprogram-body-400>`_
993993
* `subprogram_body_401 <subprogram_body_rules.html#subprogram-body-401>`_
994994
* `type_400 <type_rules.html#type-400>`_
995+
* `variable_401 <variable_rules.html#variable-401>`_

‎docs/rule_groups/alignment_rule_group.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ Rules Enforcing Alignment Rule Group
7979
* `subprogram_body_401 <../subprogram_body_rules.html#subprogram-body-401>`_
8080
* `type_400 <../type_rules.html#type-400>`_
8181
* `variable_400 <../variable_rules.html#variable-400>`_
82+
* `variable_401 <../variable_rules.html#variable-401>`_
8283
* `variable_assignment_004 <../variable_assignment_rules.html#variable-assignment-004>`_
8384
* `variable_assignment_400 <../variable_assignment_rules.html#variable-assignment-400>`_
8485
* `variable_assignment_401 <../variable_assignment_rules.html#variable-assignment-401>`_

‎docs/variable_rules.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,35 @@ This rule checks alignment of multiline constraints in variable declarations.
443443
element2(3 downto 0)
444444
);
445445
446+
variable_401
447+
############
448+
449+
|phase_5| |error| |alignment|
450+
451+
This rule checks the alignment of assignment keywords in variable declarations.
452+
453+
|configuring_keyword_alignment_rules_link|
454+
455+
**Violation**
456+
457+
.. code-block:: vhdl
458+
459+
variable v_default_values : t_address_en := (
460+
c_address_control => false,
461+
c_address_data => true,
462+
others => false
463+
);
464+
465+
**Fix**
466+
467+
.. code-block:: vhdl
468+
469+
variable v_default_values : t_address_en := (
470+
c_address_control => false,
471+
c_address_data => true,
472+
others => false
473+
);
474+
446475
variable_500
447476
############
448477

‎tests/variable/rule_401_test_input.fixed_no_no_no_no_no.vhd‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
architecture rtl of fifo is
2+
3+
begin
4+
5+
process
6+
variable v_my_rec : t_my_rec :=
7+
(
8+
signal_one => '0',
9+
signal_onetwo => '0',
10+
11+
signal_onetwothree => '0',
12+
signal_onetwothreefour => '0',
13+
-- Comment
14+
signal_onetwothreefourfive => '0',
15+
signal_onetwothreefourfivesix => '0'
16+
);
17+
18+
variable v_default_values : t_address_en := (
19+
C_ADDRESS_CONTROL_A => false,
20+
C_ADDRESS_DATA_A => true,
21+
others => false
22+
23+
C_ADDRESS_CONTROL_B => false,
24+
C_ADDRESS_DATA_B => true,
25+
others => false
26+
-- Comment
27+
C_ADDRESS_CONTROL_C => false,
28+
C_ADDRESS_DATA_C => true,
29+
others => false
30+
);
31+
32+
variable v_my_rec : t_my_rec :=
33+
(
34+
signal_one => '0',
35+
signal_onetwo => '0',
36+
37+
signal_onetwothree => '0',
38+
signal_onetwothreefour => '0',
39+
-- Comment
40+
signal_onetwothreefourfive => '0',
41+
signal_onetwothreefourfivesix => '0'
42+
);
43+
44+
variable v_default_values : t_address_en := (
45+
C_ADDRESS_CONTROL_A => false,
46+
C_ADDRESS_DATA_A => true,
47+
others => false
48+
49+
C_ADDRESS_CONTROL_B => false,
50+
C_ADDRESS_DATA_B => true,
51+
others => false
52+
-- Comment
53+
C_ADDRESS_CONTROL_C => false,
54+
C_ADDRESS_DATA_C => true,
55+
others => false
56+
);
57+
58+
-- Test hierarchical assignments
59+
-- Desired alignment
60+
variable v_my_var : my_type := (
61+
ENUM_1 => (
62+
A => 1,
63+
B => 2,
64+
C => 3
65+
),
66+
ENUM_224 => (
67+
AA => 1,
68+
BB => 2,
69+
CC => 3
70+
)
71+
);
72+
73+
-- Invalid alignment
74+
variable v_my_var : my_type := (
75+
ENUM_1 => (
76+
A => 1,
77+
B => 2,
78+
C => 3
79+
),
80+
ENUM_224 => (
81+
AA => 1,
82+
BB => 2,
83+
CC => 3
84+
)
85+
);
86+
87+
-- Test single line aggregates
88+
variable v_my_var : my_type := (
89+
ENUM_1 => (
90+
A => 1,
91+
B => 2,
92+
C => 3
93+
),
94+
ENUM_2 => (
95+
AA => 1,
96+
BBBBBBB => ((others => '0')),
97+
CC => 3 -- Not aligned!
98+
)
99+
);
100+
101+
begin
102+
103+
end process;
104+
105+
end architecture rtl;

‎tests/variable/rule_401_test_input.fixed_yes_no_no_no_no.vhd‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
architecture rtl of fifo is
2+
3+
begin
4+
5+
process
6+
variable v_my_rec : t_my_rec :=
7+
(
8+
signal_one => '0',
9+
signal_onetwo => '0',
10+
11+
signal_onetwothree => '0',
12+
signal_onetwothreefour => '0',
13+
-- Comment
14+
signal_onetwothreefourfive => '0',
15+
signal_onetwothreefourfivesix => '0'
16+
);
17+
18+
variable v_default_values : t_address_en := (
19+
C_ADDRESS_CONTROL_A => false,
20+
C_ADDRESS_DATA_A => true,
21+
others => false
22+
23+
C_ADDRESS_CONTROL_B => false,
24+
C_ADDRESS_DATA_B => true,
25+
others => false
26+
-- Comment
27+
C_ADDRESS_CONTROL_C => false,
28+
C_ADDRESS_DATA_C => true,
29+
others => false
30+
);
31+
32+
variable v_my_rec : t_my_rec :=
33+
(
34+
signal_one => '0',
35+
signal_onetwo => '0',
36+
37+
signal_onetwothree => '0',
38+
signal_onetwothreefour => '0',
39+
-- Comment
40+
signal_onetwothreefourfive => '0',
41+
signal_onetwothreefourfivesix => '0'
42+
);
43+
44+
variable v_default_values : t_address_en := (
45+
C_ADDRESS_CONTROL_A => false,
46+
C_ADDRESS_DATA_A => true,
47+
others => false
48+
49+
C_ADDRESS_CONTROL_B => false,
50+
C_ADDRESS_DATA_B => true,
51+
others => false
52+
-- Comment
53+
C_ADDRESS_CONTROL_C => false,
54+
C_ADDRESS_DATA_C => true,
55+
others => false
56+
);
57+
58+
-- Test hierarchical assignments
59+
-- Desired alignment
60+
variable v_my_var : my_type := (
61+
ENUM_1 => (
62+
A => 1,
63+
B => 2,
64+
C => 3
65+
),
66+
ENUM_224 => (
67+
AA => 1,
68+
BB => 2,
69+
CC => 3
70+
)
71+
);
72+
73+
-- Invalid alignment
74+
variable v_my_var : my_type := (
75+
ENUM_1 => (
76+
A => 1,
77+
B => 2,
78+
C => 3
79+
),
80+
ENUM_224 => (
81+
AA => 1,
82+
BB => 2,
83+
CC => 3
84+
)
85+
);
86+
87+
-- Test single line aggregates
88+
variable v_my_var : my_type := (
89+
ENUM_1 => (
90+
A => 1,
91+
B => 2,
92+
C => 3
93+
),
94+
ENUM_2 => (
95+
AA => 1,
96+
BBBBBBB => ((others => '0')),
97+
CC => 3 -- Not aligned!
98+
)
99+
);
100+
101+
begin
102+
103+
end process;
104+
105+
end architecture rtl;

‎tests/variable/rule_401_test_input.fixed_yes_no_yes_no_no.vhd‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
architecture rtl of fifo is
2+
3+
begin
4+
5+
process
6+
variable v_my_rec : t_my_rec :=
7+
(
8+
signal_one => '0',
9+
signal_onetwo => '0',
10+
11+
signal_onetwothree => '0',
12+
signal_onetwothreefour => '0',
13+
-- Comment
14+
signal_onetwothreefourfive => '0',
15+
signal_onetwothreefourfivesix => '0'
16+
);
17+
18+
variable v_default_values : t_address_en := (
19+
C_ADDRESS_CONTROL_A => false,
20+
C_ADDRESS_DATA_A => true,
21+
others => false
22+
23+
C_ADDRESS_CONTROL_B => false,
24+
C_ADDRESS_DATA_B => true,
25+
others => false
26+
-- Comment
27+
C_ADDRESS_CONTROL_C => false,
28+
C_ADDRESS_DATA_C => true,
29+
others => false
30+
);
31+
32+
variable v_my_rec : t_my_rec :=
33+
(
34+
signal_one => '0',
35+
signal_onetwo => '0',
36+
37+
signal_onetwothree => '0',
38+
signal_onetwothreefour => '0',
39+
-- Comment
40+
signal_onetwothreefourfive => '0',
41+
signal_onetwothreefourfivesix => '0'
42+
);
43+
44+
variable v_default_values : t_address_en := (
45+
C_ADDRESS_CONTROL_A => false,
46+
C_ADDRESS_DATA_A => true,
47+
others => false
48+
49+
C_ADDRESS_CONTROL_B => false,
50+
C_ADDRESS_DATA_B => true,
51+
others => false
52+
-- Comment
53+
C_ADDRESS_CONTROL_C => false,
54+
C_ADDRESS_DATA_C => true,
55+
others => false
56+
);
57+
58+
-- Test hierarchical assignments
59+
-- Desired alignment
60+
variable v_my_var : my_type := (
61+
ENUM_1 => (
62+
A => 1,
63+
B => 2,
64+
C => 3
65+
),
66+
ENUM_224 => (
67+
AA => 1,
68+
BB => 2,
69+
CC => 3
70+
)
71+
);
72+
73+
-- Invalid alignment
74+
variable v_my_var : my_type := (
75+
ENUM_1 => (
76+
A => 1,
77+
B => 2,
78+
C => 3
79+
),
80+
ENUM_224 => (
81+
AA => 1,
82+
BB => 2,
83+
CC => 3
84+
)
85+
);
86+
87+
-- Test single line aggregates
88+
variable v_my_var : my_type := (
89+
ENUM_1 => (
90+
A => 1,
91+
B => 2,
92+
C => 3
93+
),
94+
ENUM_2 => (
95+
AA => 1,
96+
BBBBBBB => ((others => '0')),
97+
CC => 3 -- Not aligned!
98+
)
99+
);
100+
101+
begin
102+
103+
end process;
104+
105+
end architecture rtl;

0 commit comments

Comments
 (0)