vhdl-style-guide/vsg/rules/conditional_waveforms/rule_001.py

109 lines
3.7 KiB
Python

# -*- coding: utf-8 -*-
from vsg import parser, token, violation
from vsg.rule_group import structure
from vsg.vhdlFile import utils
lSplitTokens = []
lSplitTokens.append(token.conditional_waveforms.else_keyword)
lTokenPairs = []
lTokenPairs.append([token.concurrent_conditional_signal_assignment.assignment, token.concurrent_conditional_signal_assignment.semicolon])
class rule_001(structure.Rule):
"""
This rule checks for code after the **else** keyword.
.. NOTE:: There is a configuration option :code:`allow_single_line` which allows single line concurrent statements.
:code:`allow_single_line` set to :code:`no` (Default)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Violation**
.. code-block:: vhdl
wr_en <= '0' when overflow = '0' else '1';
wr_en <= '0' when overflow = '0' else '1' when underflow = '1' else sig_a;
**Fix**
.. code-block:: vhdl
wr_en <= '0' when overflow = '0' else
'1';
wr_en <= '0' when overflow = '0' else
'1' when underflow = '1' else
sig_a;
:code:`allow_single_line` set to :code:`yes`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Violation**
.. code-block:: vhdl
wr_en <= '0' when overflow = '0' else '1';
wr_en <= '0' when overflow = '0' else '1' when underflow = '1' else sig_a;
**Fix**
.. code-block:: vhdl
wr_en <= '0' when overflow = '0' else '1';
wr_en <= '0' when overflow = '0' else
'1' when underflow = '1' else
sig_a;
"""
def __init__(self):
super().__init__()
self.solution = "move code after else to next line."
self.subphase = 2
self.lSplitTokens = lSplitTokens
self.lTokenPairs = lTokenPairs
self.allow_single_line = "no"
self.configuration.append("allow_single_line")
self.configuration_documentation_link = None
def _get_tokens_of_interest(self, oFile):
lToi = []
for lTokenPair in lTokenPairs:
aToi = oFile.get_tokens_bounded_by(lTokenPair[0], lTokenPair[1])
lToi = utils.combine_two_token_class_lists(lToi, aToi)
return lToi
def _analyze(self, lToi):
self.allow_single_line = utils.convert_yes_no_option_to_boolean(self.allow_single_line)
for oToi in lToi:
lTokens = oToi.get_tokens()
if utils.find_carriage_return(lTokens) is None and self.allow_single_line:
for oSplitToken in self.lSplitTokens:
if utils.count_token_types_in_list_of_tokens(oSplitToken, lTokens) > 1:
break
else:
continue
iLine = oToi.get_line_number()
for iToken, oToken in enumerate(lTokens):
iLine = utils.increment_line_number(iLine, oToken)
for oSplitToken in self.lSplitTokens:
if isinstance(oToken, oSplitToken):
if utils.are_next_consecutive_token_types([parser.whitespace, parser.comment], iToken + 1, lTokens):
continue
if utils.are_next_consecutive_token_types([parser.comment], iToken + 1, lTokens):
continue
if utils.are_next_consecutive_token_types([parser.carriage_return], iToken + 1, lTokens):
continue
oViolation = violation.New(iLine, oToi.extract_tokens(iToken, iToken), self.solution)
self.add_violation(oViolation)
break
def _fix_violation(self, oViolation):
lTokens = oViolation.get_tokens()
lTokens.append(parser.carriage_return())
oViolation.set_tokens(lTokens)