Configuring Uppercase and Lowercase Rules
There are several rules that enforce upper_or_lower, uppercase or lowercase.
There are several options to these rules:
Option |
Values |
Default Value |
Description |
---|---|---|---|
|
|
|
|
|
List of strings |
Empty list |
Enforce exception case on prefix if encountered. |
|
List of strings |
Empty list |
Enforce exception case on suffix if encountered. |
|
List of strings |
Empty list |
Enforce case for items in the list. |
|
String |
Empty String |
Enforce case based on regex string |
This is an example of how to configure these options.
rule :
architecture_004:
case: 'lower'
prefix_exceptions:
- 'G_'
suffix_exceptions:
- '_G'
case_exceptions:
- 'IEEE'
regex: ''
The following code snippet is used in the following examples:
constant c_DATA_width : positive := 32;
constant addr_WIDTH_c : positive := 8;
Note
The following examples use rule constant_004.
Example: case
set to lower
constant c_data_width : positive := 32;
constant addr_width_c : positive := 8;
Example: case
set to upper
constant C_DATA_WIDTH : positive := 32;
constant ADDR_WIDTH_C : positive := 8;
Example: case
set to upper_or_lower
This option will not perform any updates to the code as the case could be either upper or lower.
constant c_DATA_width : positive := 32;
constant addr_WIDTH_c : positive := 8;
Example: case
set to upper
and prefix_exceptions
set to c_
constant c_DATA_WIDTH : positive := 32;
constant ADDR_WIDTH_C : positive := 8;
Example: case
set to upper
and suffix_exceptions
set to _c
constant C_DATA_WIDTH : positive := 32;
constant ADDR_WIDTH_c : positive := 8;
Example: case
set to upper
and case_exceptions
set to addr_WIDTH_c
constant C_DATA_WIDTH : positive := 32;
constant addr_WIDTH_c : positive := 8;
Example: case
set to regex
and regex
set to [A-Z][A-Za-zd]*
The following constant identifiers would pass with the defined regular expression.
constant SPIAccess : std_logic;
constant ADCRegisters : std_logic;
Example: Changing Multiple Case Rules
If there are a lot of case rules you want to change, you can use the global option to reduce the size of the configuration. For example, if you want to uppercase everything except the entity name, you could write the following configuration:
rule :
global :
case : 'upper'
entity_008 :
case : 'lower'