vhdl-style-guide/vsg/rules/function/rule_015.py

47 lines
1.5 KiB
Python

from vsg.rules import align_tokens_in_region_between_tokens_unless_between_tokens
from vsg import token
lAlign = []
lAlign.append(token.full_type_declaration.identifier)
lAlign.append(token.incomplete_type_declaration.identifier)
lAlign.append(token.file_declaration.identifier)
lAlign.append(token.signal_declaration.identifier)
lAlign.append(token.constant_declaration.identifier)
lAlign.append(token.subtype_declaration.identifier)
lAlign.append(token.variable_declaration.identifier)
lAlign.append(token.alias_declaration.alias_designator)
lUnless = []
lUnless.append([token.procedure_specification.procedure_keyword, token.subprogram_body.semicolon])
class rule_015(align_tokens_in_region_between_tokens_unless_between_tokens):
'''
This rule checks the identifiers for all declarations are aligned in the function declarative part.
|configuring_identifier_alignment_rules_link|
**Violation**
.. code-block:: vhdl
variable var1 : natural;
signal sig1 : natural;
constant c_period : time;
**Fix**
.. code-block:: vhdl
variable var1 : natural;
signal sig1 : natural;
constant c_period : time;
'''
def __init__(self):
align_tokens_in_region_between_tokens_unless_between_tokens.__init__(self, 'function', '015', lAlign, token.subprogram_body.is_keyword, token.subprogram_body.begin_keyword, lUnless)
self.solution = 'Align identifer.'
self.configuration_documentation_link = 'configuring_identifier_alignment_rules_link'