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

52 lines
1.5 KiB
Python

from vsg.rules import token_indent_between_tokens
from vsg import token
lTokens = []
lTokens.append(token.interface_constant_declaration.constant_keyword)
lTokens.append(token.interface_signal_declaration.signal_keyword)
lTokens.append(token.interface_variable_declaration.variable_keyword)
lTokens.append(token.interface_file_declaration.file_keyword)
lTokens.append(token.interface_unknown_declaration.identifier)
lTokens.append(token.interface_incomplete_type_declaration.type_keyword)
lTokens.append(token.interface_procedure_specification.procedure_keyword)
lTokens.append(token.interface_function_specification.function_keyword)
lTokens.append(token.interface_package_declaration.package_keyword)
oStart = token.function_specification.open_parenthesis
oEnd = token.function_specification.close_parenthesis
class rule_008(token_indent_between_tokens):
'''
This rule checks the indent of function parameters on multiple lines.
**Violation**
.. code-block:: vhdl
function func_1 (a : integer; b : integer;
c : unsigned(3 downto 0);
d : std_logic_vector(7 downto 0);
e : std_logic) return integer is
begin
end;
**Fix**
.. code-block:: vhdl
function func_1 (a : integer; b : integer;
c : unsigned(3 downto 0);
d : std_logic_vector(7 downto 0);
e : std_logic) return integer is
begin
end;
'''
def __init__(self):
token_indent_between_tokens.__init__(self, 'function', '008', lTokens, oStart, oEnd)