vhdl-style-guide/vsg/rules/prefix_rule.py

55 lines
1.4 KiB
Python

from vsg import rule
from vsg import check
from abc import abstractmethod
class prefix_rule(rule.rule):
'''
Checks for identifiers prefixes. This rule can not fix!
Parameters
----------
name : string
The group the rule belongs to.
identifier : string
unique identifier. Usually in the form of 00N.
sTrigger : string
The line attribute the rule applies to.
Attribute
----------
self.phase : integer = 7
Sets the phase the rule will run in.
self.solution : string = None
Instructions on how to fix the violation.
'''
def __init__(self, name=None, identifier=None, sTrigger=None):
rule.rule.__init__(self, name, identifier)
self.phase = 7
self.solution = None
self.sTrigger = sTrigger
self.prefixes = None
self.fixable = False # The user will have to fix any desired prefixes.
self.disable = True
self.configuration.append('prefixes')
@abstractmethod
def _extract(self, oLine):
pass
def _analyze(self, oFile, oLine, iLineNumber):
if oLine.__dict__[self.sTrigger]:
words = self._extract(oLine)
check.has_prefix(self, self.prefixes, words, iLineNumber)
def _get_solution(self, iLineNumber):
return self.solution + ' should start with one of ' + str(self.prefixes) + ' prefixes.'