vhdl-style-guide/vsg/line.py

335 lines
11 KiB
Python

try:
from vsg import utils
from vsg import tokens
from vsg import parser
except ImportError:
import utils
import tokens
import parser
class line():
'''
This class holds line contents and attributes associated with the content.
codeTags is an attribute represented by a dictionary.
The valid keys into the dictionary are:
vsg_off
vsg_on
If vsg_off and vsg_on are empty lists, then every rule is disabled.
codeTags['vsg_off'][]
otherwise individual rules are disabled:
codeTags['vsg_off']['library_008', 'process_002']
'''
def __init__(self, line):
self.line = line
self.lineLower = line.lower()
self.lineNoComment = utils.remove_comment(line)
self.tokens, self.separators = tokens.create(self.line)
self.objects = []
self.indentLevel = None
# Misc attributes
self.isBlank = False
# Comment attributes
self.isComment = False
self.hasComment = False
self.hasInlineComment = False
self.commentColumn = None
# Library attributes
self.isLibrary = False
self.isLibraryUse = False
# Entity attributes
self.insideEntity = False
self.isEntityDeclaration = False
self.isEndEntityDeclaration = False
# Port attributes
self.insidePortMap = False
self.isPortDeclaration = False
self.isPortKeyword = False
self.isEndPortMap = False
# Generic attributes
self.insideGenericMap = False
self.isGenericDeclaration = False
self.isGenericKeyword = False
self.isEndGenericMap = False
# Architecture attributes
self.insideArchitecture = False
self.isArchitectureBegin = False
self.isArchitectureKeyword = False
self.isEndArchitecture = False
self.insideArchitectureDeclarativeRegion = False
# Signal attributes
self.isSignal = False
self.insideSignal = False
self.isEndSignal = False
# Constant attributes
self.insideConstant = False
self.isConstant = False
self.isConstantEnd = False
self.isConstantArray = False
# Variable attributes
self.isVariable = False
# Process attributes
self.insideProcess = False
self.isProcessBegin = False
self.isProcessKeyword = False
self.isProcessLabel = False
self.isProcessEndLabel = False
self.isProcessDeclarative = False
self.isEndProcess = False
self.insideSensitivityList = False
self.isSensitivityListBegin = False
self.isSensitivityListEnd = False
self.isClockStatement = False
self.insideClockProcess = False
self.insideResetProcess = False
self.isProcessIs = False
# Concurrent attributes
self.insideConcurrent = False
self.isConcurrentBegin = False
self.isEndConcurrent = False
self.hasConcurrentLabel = False
# When attributes
self.insideWhen = False
self.isWhenKeyword = False
self.isWhenElseKeyword = False
self.isWhenEnd = False
# If attributes
self.insideIf = False
self.isElseKeyword = False
self.isElseIfKeyword = False
self.isEndIfKeyword = False
self.isIfEnd = False
self.isIfKeyword = False
self.isThenKeyword = False
self.isLastEndIf = False
self.isFirstIf = False
# Case attributes
self.insideCaseStatement = False
self.insideCase = False
self.insideCaseWhen = False
self.isCaseIsKeyword = False
self.isCaseKeyword = False
self.isCaseWhenEnd = False
self.isCaseWhenKeyword = False
self.isEndCaseKeyword = False
self.isCaseNull = False
self.hasCaseLabel = False
self.hasEndCaseLabel = False
# Sequential attributes
self.insideSequential = False
self.isSequentialEnd = False
self.isSequential = False
self.sequentialAlignmentColumn = None
# Component attributes
self.insideComponent = False
self.isComponentDeclaration = False
self.isComponentEnd = False
# Instantiation attributes
self.insideInstantiation = False
self.isInstantiationDeclaration = False
self.isDirectInstantiationDeclaration = False
self.insideInstantiationPortMap = False
self.isInstantiationPortKeyword = False
self.isInstantiationPortEnd = False
self.isInstantiationPortAssignment = False
self.insideInstantiationGenericMap = False
self.isInstantiationGenericKeyword = False
self.isInstantiationGenericEnd = False
self.isInstantiationGenericAssignment = False
# Package attributes
self.insidePackage = False
self.isPackageKeyword = False
self.isPackageEnd = False
# Package Body attributes
self.insidePackageBody = False
self.isPackageBodyKeyword = False
self.isPackageBodyEnd = False
# Generate attributes
self.insideGenerate = False
self.isGenerateBegin = False
self.isGenerateKeyword = False
self.isGenerateEnd = False
self.isGenerateLabel = False
self.isGenerateEndLabel = False
self.insideGenerateCase = False
self.insideGenerateCaseWhen = False
self.isGenerateCaseWhen = False
# Function attributes
self.insideFunction = False
self.insideFunctionDeclarative = False
self.isFunctionParameter = False
self.isFunctionParameterEnd = False
self.isFunctionBegin = False
self.isFunctionKeyword = False
self.isFunctionEnd = False
self.isFunctionReturn = False
self.hasFunctionReturnType = False
self.isFunctionReturnKeyword = False
self.hasFunctionIs = False
# For Loop attributes
self.insideForLoop = False
self.isForLoopKeyword = False
self.isForLoopEnd = False
self.isForLoopLabel = False
# While Loop attributes
self.insideWhileLoop = False
self.isWhileLoopKeyword = False
self.isWhileLoopEnd = False
# Type attributes
self.isTypeKeyword = False
self.isTypeEnd = False
# Subtype attributes
self.insideSubtype = False
self.isSubtypeKeyword = False
self.isSubtypeEnd = False
# Enumerated Type attributes
self.insideTypeEnumerated = False
self.isTypeEnumeratedKeyword = False
self.isTypeEnumeratedEnd = False
# Type Array attributes
self.insideTypeArray = False
self.isTypeArrayKeyword = False
self.isTypeArrayEnd = False
# Type Record attributes
self.insideTypeRecord = False
self.isTypeRecordKeyword = False
self.isTypeRecordEnd = False
# Variable Assignment attributes
self.insideVariableAssignment = False
self.isVariableAssignmentEnd = False
self.isVariableAssignment = False
self.variableAssignmentAlignmentColumn = None
# Assert attributes
self.isAssertKeyword = False
self.isAssertEnd = False
self.insideAssert = False
# With attributes
self.isWithKeyword = False
# Attribute attributes
self.isAttributeKeyword = False
self.isAttributeEnd = False
self.insideAttribute = False
# File attributes
self.isFileKeyword = False
self.isFileEnd = False
self.insideFile = False
# Procedure attributes
self.insideProcedure = False
self.insideProcedureDeclarative = False
self.isProcedureParameter = False
self.isProcedureParameterEnd = False
self.isProcedureBegin = False
self.isProcedureKeyword = False
self.isProcedureEnd = False
self.isProcedureReturn = False
self.isProcedureIs = False
# Block attributes
self.insideBlock = False
self.isBlockBegin = False
self.isBlockKeyword = False
self.isEndBlock = False
# Wait attributes
self.isWait = False
# Code tags
self.hasCodeTag = False
self.codeTags = {}
# After attributes
self.hasAfterKeyword = False
# Context attributes
self.hasContextKeyword = False
self.hasContextIdentifier = False
self.hasContextIs = False
self.hasContextEnd = False
self.hasContextEndKeyword = False
self.hasContextEndIdentifier = False
self.hasContextColon = False
self.insideContext = False
def update_line(self, sLine):
'''
This method updates the line, lineLower and lineNoComment attributes.
'''
self.line = sLine
self.lineLower = sLine.lower()
self.lineNoComment = utils.remove_comment(sLine)
self.tokens, self.separators = tokens.create(sLine)
def update_line_from_tokens(self):
'''
This method creates the line, lineLower and lineNoComment from the seperators and tokens list
'''
sLine = ''
for sSep, sTok in zip(self.separators, self.tokens):
sLine += sSep + sTok
self.line = sLine
self.lineLower = sLine.lower()
self.lineNoComment = utils.remove_comment(sLine)
def has_token(self, sString):
'''
This method checks for sString in the token list.
'''
for sTok in self.tokens:
if sString.lower() == sTok.lower():
return True
return False
def get_zipped_tokens(self):
lReturn = []
if len(self.tokens) > 0:
for i in range(len(self.tokens)):
try:
if not '' == self.separators[i]:
lReturn.append(self.separators[i])
except IndexError:
pass
lReturn.append(self.tokens[i])
return lReturn
def get_objects(self):
return self.objects
def get_object(self, iObject):
try:
return self.objects[iObject]
except IndexError:
return parser.none
def update_objects(self, lObjects):
'''
Takes a list of objects and updates the self.line, self.lineLower, self.lineNoComment, self.tokens and self.separators attributes.
'''
self.objects = lObjects
sLine = ''
for oObject in self.objects:
sLine += oObject.get_value()
self.update_line(sLine)
def is_blank(self):
return self.isBlank
def is_comment(self):
return self.isComment
def get_indent_level(self):
return self.indentLevel
class blank_line(line):
'''
This class provides a blank line version of the line class.
'''
def __init__(self):
line.__init__(self, '')
self.isBlank = True