ToolChain.Aldec.RivieraPRO¶

Exceptions

RivieraPROException: An RivieraPROException is raised if Riviera-PRO catches a system exception.

Classes

Configuration: Base class for all tool Configuration classes.
RivieraPRO: Factory for executable abstractions in Riviera-PRO.
VHDLLibraryTool: Abstraction layer of Riviera-PRO’s VHDL library management tool ‘vlib’.
VHDLCompiler: Abstraction layer of Riviera-PRO’s VHDL compiler ‘vcom’.
VHDLSimulator: Represent an executable.

Functions

VLibFilter(): A line based output stream filter for Riviera-PRO’s VHDL library management tool.
VComFilter(): A line based output stream filter for Riviera-PRO’s VHDL compiler.
VSimFilter(): A line based output stream filter for Riviera-PRO’s VHDL simulator.

exception ToolChain.Aldec.RivieraPRO.RivieraPROException(message='')[source]¶

An RivieraPROException is raised if Riviera-PRO catches a system exception.

Inheritance

Members

__init__(message='')¶

Exception initializer

Parameters:	message (str) – The exception message.

__str__()¶: Returns the exception’s message text.

args¶

class ToolChain.Aldec.RivieraPRO.Configuration(host: Base.IHost)[source]¶

Inheritance

Members

_vendor = 'Aldec'¶: The name of the tools vendor.

_toolName = 'Aldec Riviera-PRO'¶: The name of the tool.

_section = 'INSTALL.Aldec.RivieraPRO'¶: The name of the configuration section. Pattern: INSTALL.Vendor.ToolName.

_multiVersionSupport = True¶: Aldec Riviera-PRO supports multiple versions installed on the same system.

_template = {'Windows': {'INSTALL.Aldec.RivieraPRO': {'Version': '2016.10', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Aldec:InstallationDirectory}/Riviera-PRO'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/BIN'), 'Edition': ('${${SectionName}:Edition}', 'Riviera-PRO')}}, 'Linux': {'INSTALL.Aldec.RivieraPRO': {'Version': '2016.10', 'SectionName': ('%{PathWithRoot}#${Version}', None), 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '${INSTALL.Aldec:InstallationDirectory}/Riviera-PRO'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/BIN'), 'Edition': ('${${SectionName}:Edition}', 'Riviera-PRO')}}}¶: The template for the configuration sections represented as nested dictionaries.

CheckDependency()[source]¶: Check if general Aldec support is configured in PoC.

ConfigureForAll()[source]¶

Configuration routine for Aldec Riviera-PRO on all supported platforms.

Ask if Riviera-PRO is installed.

Pass → skip this configuration. Don’t change existing settings.

Yes → collect installation information for Riviera-PRO.

No → clear the Riviera-PRO configuration section.

Ask for Riviera-PRO’s version.
Ask for Riviera-PRO’s edition (normal, student).
Ask for Riviera-PRO’s installation directory.

ClearSection(writeWarnings=False)[source]¶: Clear the configuration section associated to this Configuration class.

ConfigureForDarwin()[source]¶

Start the configuration procedure for Darwin.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Darwin specific configuration routine.

ConfigureForLinux()[source]¶

Start the configuration procedure for Linux.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Linux specific configuration routine.

ConfigureForWindows()[source]¶

Start the configuration procedure for Windows.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Windows specific configuration routine.

GetSections(platform)[source]¶: Return all section names for this configuration.

Host¶: Return the hosting object.

IsConfigured()[source]¶: Return true if the configurations section is configured

IsSupportedPlatform()[source]¶: Return true if the given platform is supported by this configuration routine.

Log(entry, condition=True)¶: Write an entry to the local logger.

LogDebug(*args, condition=True, **kwargs)¶

LogDryRun(*args, condition=True, **kwargs)¶

LogError(*args, condition=True, **kwargs)¶

LogFatal(*args, condition=True, **kwargs)¶

LogInfo(*args, condition=True, **kwargs)¶

LogNormal(*args, condition=True, **kwargs)¶

LogQuiet(*args, condition=True, **kwargs)¶

LogVerbose(*args, condition=True, **kwargs)¶

LogWarning(*args, condition=True, **kwargs)¶

Logger¶: Return the local logger instance.

PrepareOptions(writeWarnings=True)[source]¶

PrepareSections(warningWasWritten, writeWarnings=True)[source]¶

PrepareVersionedSections(writeWarnings=False)¶

RunPostConfigurationTasks()[source]¶: Virtual method. Overwrite to execute post-configuration tasks.

SectionName¶: Return the configuration’s section name.

State¶: Return the configuration state.

_Ask(question, default, beforeDefault='', afterDefault='', indent=1)¶

_AskInstalled(question)[source]¶: Ask a Yes/No/Pass question.

_AskYes_NoPass(question, indent=1)¶: Ask a yes/NO/pass question.

_Ask_YesNoPass(question, indent=1)¶: Ask a YES/no/pass question.

_Configuration__CheckRivieraPROVersion(binPath, version)¶: Compare the given Riviera-PRO version with the tool’s version string.

_ConfigureBinaryDirectory()¶: Updates section with value from _template and returns directory as Path object.

_ConfigureEdition(editions, defaultEdition)¶

_ConfigureInstallationDirectory()[source]¶: Asks for installation directory and updates section. Checks if entered directory exists and returns Path object. If no installation directory was configured before, then _GetDefaultInstallationDir is called.

_ConfigureVersion()¶: If no version was configured before, then _GetDefaultVersion is called. Asks for version and updates section. Returns version as string.

_GetDefaultEdition()¶

Returns unresolved default edition (str) from template.

Overwrite this method in a sub-class for automatic search of editions.

_GetDefaultInstallationDirectory()[source]¶

Return unresolved default installation directory (str) from template.

Overwrite function in sub-class for automatic search of installation directory.

_GetDefaultOptionValue(optionName)[source]¶

_GetDefaultVersion()¶

Returns unresolved default version (str) from template.

Overwrite this method in a sub-class for automatic search of version.

_PrintAvailableEditions(editions, selectedEdition)¶: Print all available editions and return the selected index.

_TestDefaultInstallPath(defaults)[source]¶: Helper function for automatic search of installation directory.

_TryLog(*args, condition=True, **kwargs)¶

class ToolChain.Aldec.RivieraPRO.RivieraPRO(platform, dryrun, binaryDirectoryPath, version, logger=None)[source]¶

Factory for executable abstractions in Riviera-PRO.

Inheritance

Members

GetVHDLLibraryTool()[source]¶: Return an instance of Riviera-PRO’s VHDL library management tool ‘vlib’.

GetVHDLCompiler()[source]¶: Return an instance of Riviera-PRO’s VHDL compiler ‘vcom’.

GetSimulator()[source]¶: Return an instance of Riviera-PRO’s VHDL simulator ‘vsim’.

class ToolChain.Aldec.RivieraPRO.VHDLLibraryTool(toolchain: ToolChain.ToolMixIn)[source]¶

Abstraction layer of Riviera-PRO’s VHDL library management tool ‘vlib’.

Inheritance

Members

class Executable[source]¶

_value = None¶

class VHDLLibraryTool.SwitchLibraryName[source]¶

_value = None¶

VHDLLibraryTool.Parameters = [<class 'ToolChain.Aldec.RivieraPRO.VHDLLibraryTool.Executable'>, <class 'ToolChain.Aldec.RivieraPRO.VHDLLibraryTool.SwitchLibraryName'>]¶

VHDLLibraryTool.CreateLibrary()[source]¶

VHDLLibraryTool.GetReader()¶

VHDLLibraryTool.HasErrors¶: True if errors or fatals errors were found while processing the output stream.

VHDLLibraryTool.HasWarnings¶: True if errors or fatals errors were found while processing the output stream.

VHDLLibraryTool.Log(entry, condition=True)¶: Write an entry to the local logger.

VHDLLibraryTool.LogDebug(*args, condition=True, **kwargs)¶

VHDLLibraryTool.LogDryRun(*args, condition=True, **kwargs)¶

VHDLLibraryTool.LogError(*args, condition=True, **kwargs)¶

VHDLLibraryTool.LogFatal(*args, condition=True, **kwargs)¶

VHDLLibraryTool.LogInfo(*args, condition=True, **kwargs)¶

VHDLLibraryTool.LogNormal(*args, condition=True, **kwargs)¶

VHDLLibraryTool.LogQuiet(*args, condition=True, **kwargs)¶

VHDLLibraryTool.LogVerbose(*args, condition=True, **kwargs)¶

VHDLLibraryTool.LogWarning(*args, condition=True, **kwargs)¶

VHDLLibraryTool.Logger¶: Return the local logger instance.

VHDLLibraryTool.Path¶

VHDLLibraryTool.ReadUntilBoundary(indent=0)¶

VHDLLibraryTool.Send(line, end='\n')¶

VHDLLibraryTool.SendBoundary()¶

VHDLLibraryTool.StartProcess(parameterList)¶

VHDLLibraryTool.Terminate()¶

VHDLLibraryTool._POC_BOUNDARY = '====== POC BOUNDARY ======'¶

VHDLLibraryTool._TryLog(*args, condition=True, **kwargs)¶

class ToolChain.Aldec.RivieraPRO.VHDLCompiler(toolchain: ToolChain.ToolMixIn)[source]¶

Abstraction layer of Riviera-PRO’s VHDL compiler ‘vcom’.

Inheritance

Members

class Executable[source]¶

_value = None¶

class VHDLCompiler.SwitchVHDLVersion[source]¶

_pattern = '-{1}'¶

_name = ''¶

_value = None¶

class VHDLCompiler.SwitchVHDLLibrary[source]¶

_name = 'work'¶

_value = None¶

class VHDLCompiler.ArgSourceFile[source]¶

_value = None¶

VHDLCompiler.Parameters = [<class 'ToolChain.Aldec.RivieraPRO.VHDLCompiler.Executable'>, <class 'ToolChain.Aldec.RivieraPRO.VHDLCompiler.SwitchVHDLVersion'>, <class 'ToolChain.Aldec.RivieraPRO.VHDLCompiler.SwitchVHDLLibrary'>, <class 'ToolChain.Aldec.RivieraPRO.VHDLCompiler.ArgSourceFile'>]¶

VHDLCompiler.Compile()[source]¶

VHDLCompiler.GetReader()¶

VHDLCompiler.HasErrors¶: True if errors or fatals errors were found while processing the output stream.

VHDLCompiler.HasWarnings¶: True if errors or fatals errors were found while processing the output stream.

VHDLCompiler.Log(entry, condition=True)¶: Write an entry to the local logger.

VHDLCompiler.LogDebug(*args, condition=True, **kwargs)¶

VHDLCompiler.LogDryRun(*args, condition=True, **kwargs)¶

VHDLCompiler.LogError(*args, condition=True, **kwargs)¶

VHDLCompiler.LogFatal(*args, condition=True, **kwargs)¶

VHDLCompiler.LogInfo(*args, condition=True, **kwargs)¶

VHDLCompiler.LogNormal(*args, condition=True, **kwargs)¶

VHDLCompiler.LogQuiet(*args, condition=True, **kwargs)¶

VHDLCompiler.LogVerbose(*args, condition=True, **kwargs)¶

VHDLCompiler.LogWarning(*args, condition=True, **kwargs)¶

VHDLCompiler.Logger¶: Return the local logger instance.

VHDLCompiler.Path¶

VHDLCompiler.ReadUntilBoundary(indent=0)¶

VHDLCompiler.Send(line, end='\n')¶

VHDLCompiler.SendBoundary()¶

VHDLCompiler.StartProcess(parameterList)¶

VHDLCompiler.Terminate()¶

VHDLCompiler._POC_BOUNDARY = '====== POC BOUNDARY ======'¶

VHDLCompiler._TryLog(*args, condition=True, **kwargs)¶

class ToolChain.Aldec.RivieraPRO.VHDLSimulator(toolchain: ToolChain.ToolMixIn)[source]¶

Inheritance

Members

class Executable[source]¶

The executable to launch.

_value = None¶

class VHDLSimulator.SwitchBatchCommand[source]¶

Specify a Tcl batch script for the batch mode.

_name = 'do'¶

_value = None¶

class VHDLSimulator.FlagCommandLineMode[source]¶

Run simulation in command line mode.

_name = 'c'¶

_value = None¶

class VHDLSimulator.SwitchTimeResolution[source]¶

Set simulation time resolution.

_name = 't'¶

_value = None¶

class VHDLSimulator.SwitchTopLevel[source]¶

The top-level for simulation.

_value = None¶

VHDLSimulator.Parameters = [<class 'ToolChain.Aldec.RivieraPRO.VHDLSimulator.Executable'>, <class 'ToolChain.Aldec.RivieraPRO.VHDLSimulator.SwitchBatchCommand'>, <class 'ToolChain.Aldec.RivieraPRO.VHDLSimulator.FlagCommandLineMode'>, <class 'ToolChain.Aldec.RivieraPRO.VHDLSimulator.SwitchTimeResolution'>, <class 'ToolChain.Aldec.RivieraPRO.VHDLSimulator.SwitchTopLevel'>]¶: Specify all accepted command line arguments

VHDLSimulator.Simulate()[source]¶: Start a simulation.

VHDLSimulator.GetReader()¶

VHDLSimulator.HasErrors¶: True if errors or fatals errors were found while processing the output stream.

VHDLSimulator.HasWarnings¶: True if errors or fatals errors were found while processing the output stream.

VHDLSimulator.Log(entry, condition=True)¶: Write an entry to the local logger.

VHDLSimulator.LogDebug(*args, condition=True, **kwargs)¶

VHDLSimulator.LogDryRun(*args, condition=True, **kwargs)¶

VHDLSimulator.LogError(*args, condition=True, **kwargs)¶

VHDLSimulator.LogFatal(*args, condition=True, **kwargs)¶

VHDLSimulator.LogInfo(*args, condition=True, **kwargs)¶

VHDLSimulator.LogNormal(*args, condition=True, **kwargs)¶

VHDLSimulator.LogQuiet(*args, condition=True, **kwargs)¶

VHDLSimulator.LogVerbose(*args, condition=True, **kwargs)¶

VHDLSimulator.LogWarning(*args, condition=True, **kwargs)¶

VHDLSimulator.Logger¶: Return the local logger instance.

VHDLSimulator.Path¶

VHDLSimulator.ReadUntilBoundary(indent=0)¶

VHDLSimulator.Send(line, end='\n')¶

VHDLSimulator.SendBoundary()¶

VHDLSimulator.StartProcess(parameterList)¶

VHDLSimulator.Terminate()¶

VHDLSimulator._POC_BOUNDARY = '====== POC BOUNDARY ======'¶

VHDLSimulator._TryLog(*args, condition=True, **kwargs)¶

Functions

ToolChain.Aldec.RivieraPRO.VLibFilter(gen)[source]¶: A line based output stream filter for Riviera-PRO’s VHDL library management tool.

ToolChain.Aldec.RivieraPRO.VComFilter(gen)[source]¶: A line based output stream filter for Riviera-PRO’s VHDL compiler.

ToolChain.Aldec.RivieraPRO.VSimFilter(gen)[source]¶: A line based output stream filter for Riviera-PRO’s VHDL simulator.