JHertz5
commented
3 months ago Hi @LarsAsplund
From your message, it's not clear to me exactly what you're looking for. Are you trying to allow for subtypes with the string FIELD, or with the prefix A_? I have some suggestions that may be helpful though.
The rule that checks subtype prefixes is called subtype_004. If you run vsg -rc subtype_004 you can see the default configuration of this rule.
$ vsg -rc subtype_004
{
"rule": {
"subtype_004": {
"indentStyle": "spaces",
"indentSize": 2,
"phase": 7,
"disable": true,
"fixable": false,
"severity": "Error",
"prefixes": [
"st_"
],
"exceptions": []
}
}
}Option 1: Exceptions
As you can see, there is an exceptions field. You can read about how to use this field here, but as you guessed, I don't think that it supports regexps. If you only need to exclude A_FIELD, you could use the following config
rule:
subtype_004:
disable: false
exceptions: ['A_FIELD']
subtype_501:
case: 'upper'When used on the following file
architecture rtl of test is
subtype T_ABC is integer range 7 downto 0;
subtype A_ABC is integer range 7 downto 0;
subtype A_FIELD is integer range 7 downto 0;
begin
end architecture rtl;This gives
$ vsg -f test.vhd -c test.yml
================================================================================
File: test.vhd
================================================================================
Phase 7 of 7... Reporting
Total Rules Checked: 736
Total Violations: 2
Error : 2
Warning : 0
----------------------------+------------+------------+--------------------------------------
Rule | severity | line(s) | Solution
----------------------------+------------+------------+--------------------------------------
subtype_004 | Error | 3 | Prefix T_ABC with one of the following: st_
subtype_004 | Error | 4 | Prefix A_ABC with one of the following: st_
----------------------------+------------+------------+--------------------------------------
NOTE: Refer to online documentation at https://vhdl-style-guide.readthedocs.io/en/latest/index.html for more information.Note that no warning is raised over A_FIELD.
Option 2: Additional valid prefixes
If you're trying to accept both a_ and t_ as valid prefixes, this is something that VSG can already handle. using the config
rule:
subtype_004:
disable: false
prefixes: ['t_', 'a_']with the file
architecture rtl of test is
subtype t_abc is integer range 7 downto 0;
subtype a_abc is integer range 7 downto 0;
subtype A_FIELD is integer range 7 downto 0;
begin
end architecture rtl;gives
$ vsg -f test.vhd -c test.yml -ap
================================================================================
File: test.vhd
================================================================================
Phase 7 of 7... Reporting
Total Rules Checked: 736
Total Violations: 1
Error : 1
Warning : 0
----------------------------+------------+------------+--------------------------------------
Rule | severity | line(s) | Solution
----------------------------+------------+------------+--------------------------------------
subtype_501 | Error | 6 | Change "A_FIELD" to "a_field"
----------------------------+------------+------------+--------------------------------------
NOTE: Refer to online documentation at https://vhdl-style-guide.readthedocs.io/en/latest/index.html for more information.The error is because this config does not allow for uppercase subtypes.
Do either of these options solve your problem?
LarsAsplund
jeremiah-c-leary
Hi,
I'm working in a project which has enabled the prefix rules for (sub)types. All (sub)types must be prefixed with
t_. That works well but there is an exception. When specifying a field in a register we use the following construct:subtype A_FIELD is integer range 7 downto 0;
While
A_FIELDis a subtype, it is not used as such and we would like to have an exception. From what I can tell, this the prefix rule for subtypes doesn't support exceptions and even if it did, does exceptions support regexps? Something like `exception = ['*FIELD']?As a workaround I can:
vsg_onandvsg_offt_and then have an alias for the subtype without the prefix.What I would like is a more direct way to deal with this in the VSG configuration