vhdl-style-guide/docs/constant_rules.rst

338 lines
5.6 KiB
ReStructuredText

Constant Rules
--------------
constant_001
############
This rule checks the indent of a constant declaration.
**Violation**
.. code-block:: vhdl
architecture RTL of FIFO is
constant size : integer := 1;
constant width : integer := 32
**Fix**
.. code-block:: vhdl
architecture RTL of FIFO is
constant size : integer := 1;
constant width : integer := 32
constant_002
############
This rule checks the **constant** keyword is has proper case.
.. NOTE:: The default is lowercase.
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring_case.html>`_ for information on changing the default case.
**Violation**
.. code-block:: vhdl
CONSTANT size : integer := 1;
**Fix**
.. code-block:: vhdl
constant size : integer := 1;
constant_003
############
This rule checks for spaces after the **constant** keyword.
**Violation**
.. code-block:: vhdl
constant size : integeri := 1;
**Fix**
.. code-block:: vhdl
constant size : integer := 1;
.. NOTE:: The number of spaces after the **constant** keyword is configurable.
Use the following YAML file example to change the default number of spaces.
.. code-block:: yaml
rule:
constant_003:
spaces: 3
constant_004
############
This rule checks the constant name is lower case.
**Violation**
.. code-block:: vhdl
constant SIZE : integer := 1;
**Fix**
.. code-block:: vhdl
constant size : integer := 1;
constant_005
############
This rule checks for a single space after the :.
**Violation**
.. code-block:: vhdl
constant size :integer := 1;
constant wdith : integer := 32;
**Fix**
.. code-block:: vhdl
constant size : integer := 1;
constant width : integer := 32;
constant_006
############
This rule checks for at least a single space before the :.
**Violation**
.. code-block:: vhdl
constant size: integer := 1;
constant width : integer := 32;
**Fix**
.. code-block:: vhdl
constant size : integer := 1;
constant width : integer := 32;
constant_007
############
This rule checks the **:=** is on the same line at the **constant** keyword.
**Violation**
.. code-block:: vhdl
constant size : integer
:= 1;
**Fix**
.. code-block:: vhdl
constant size : integer := 1;
constant_009
############
This rule checks the :'s are in the same column for all constants in the architecture declarative region.
**Violation**
.. code-block:: vhdl
constant size : integer := 1;
constant width : integer := 32
**Fix**
.. code-block:: vhdl
constant size : integer := 1;
constant width : integer := 32
constant_010
############
This rule checks for a single space before the := keyword in constant declarations.
Having a space makes it clearer where the assignment occurs on the line.
**Violation**
.. code-block:: vhdl
constant size : integer:= 1;
constant width : integer := 10;
**Fix**
.. code-block:: vhdl
constant size : integer := 1;
constant width : integer := 10;
constant_011
############
This rule checks the constant type has proper case.
.. NOTE:: The default is lowercase.
Refer to the section `Configuring Uppercase and Lowercase Rules <configuring_case.html>`_ for information on changing the default case.
**Violation**
.. code-block:: vhdl
constant size : INTEGER := 1;
**Fix**
.. code-block:: vhdl
constant size : integer := 1;
constant_012
############
This rule checks the indent of multiline constants that contain arrays.
**Violation**
.. code-block:: vhdl
constant rom : romq_type :=
(
0,
65535,
32768
);
**Fix**
.. code-block:: vhdl
constant rom : romq_type :=
(
0,
65535,
32768
);
constant_013
############
This rule checks for consistent capitalization of constant names.
**Violation**
.. code-block:: vhdl
architecture RTL of ENTITY1 is
constant c_size : integer := 5;
constant c_ones : std_logic_vector(c_size - 1 downto 0) := (others => '1');
constant c_zeros : std_logic_vector(c_size - 1 downto 0) := (others => '0');
signal data : std_logic_vector(c_size - 1 downto 0);
begin
data <= C_ONES;
PROC_NAME : process () is
begin
data <= C_ones;
if (sig2 = '0') then
data <= c_Zeros;
end if;
end process PROC_NAME;
end architecture RTL;
**Fix**
.. code-block:: vhdl
architecture RTL of ENTITY1 is
constant c_size : integer := 5;
constant c_ones : std_logic_vector(c_size - 1 downto 0) := (others => '1');
constant c_zeros : std_logic_vector(c_size - 1 downto 0) := (others => '0');
signal data : std_logic_vector(c_size - 1 downto 0);
begin
data <= c_ones;
PROC_NAME : process () is
begin
data <= c_ones;
if (sig2 = '0') then
data <= c_zeros;
end if;
end process PROC_NAME;
end architecture RTL;
constant_014
############
This rule checks the indent of multiline constants that do not contain arrays.
**Violation**
.. code-block:: vhdl
constant width : integer := a + b +
c + d;
**Fix**
.. code-block:: vhdl
constant width : integer := a + b +
c + d;
constant_015
############
This rule checks for valid prefixes on constant identifiers.
.. NOTE:: The default constant prefix is "c\_".
Refer to the section `Configuring Prefix and Suffix Rules <configuring_prefix_suffix.html>`_ for information on changing the allowed prefixes.
**Violation**
.. code-block:: vhdl
constant my_const : integer;
**Fix**
.. code-block:: vhdl
constant c_my_const : integer;