pyIPCMI.ToolChain.GTKWave.py¶
Exceptions
GTKWaveException
: Base class for all tool specific exceptions
Classes
Configuration
: Base class for all tool Configuration classes.GTKWave
: Represent an executable.
Functions
GTKWaveFilter()
: Undocumented.
-
exception
pyIPCMI.ToolChain.GTKWave.
GTKWaveException
(message='')[source] Inheritance
Members
-
__init__
(message='') Exception initializer
Parameters: message (str) – The exception message.
-
__str__
() Returns the exception’s message text.
-
args
-
-
class
pyIPCMI.ToolChain.GTKWave.
Configuration
(host: pyIPCMI.Base.IHost)[source] Inheritance
Members
-
_vendor
= 'TonyBybell' The name of the tools vendor.
-
_toolName
= 'GTKWave' The name of the tool.
-
_section
= 'INSTALL.GTKWave' The name of the configuration section. Pattern:
INSTALL.Vendor.ToolName
.
-
_multiVersionSupport
= True GTKWave supports multiple versions installed on the same system.
-
_template
= {'Darwin': {'INSTALL.GTKWave': {'SectionName': ('%{PathWithRoot}#${Version}', None), 'Version': '3.3.80', 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '/usr/bin'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}')}}, 'Linux': {'INSTALL.GTKWave': {'SectionName': ('%{PathWithRoot}#${Version}', None), 'Version': '3.3.80', 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', '/usr/bin'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}')}}, 'Windows': {'INSTALL.GTKWave': {'SectionName': ('%{PathWithRoot}#${Version}', None), 'Version': '3.3.80', 'InstallationDirectory': ('${${SectionName}:InstallationDirectory}', 'C:/Program Files (x86)/GTKWave'), 'BinaryDirectory': ('${${SectionName}:BinaryDirectory}', '${InstallationDirectory}/bin')}}} The template for the configuration sections represented as nested dictionaries.
-
CheckDependency
()[source] Check if all vendor or tool dependencies are fulfilled to configure this tool.
-
ConfigureForAll
()[source] Start a generic (platform independent) configuration procedure.
Overwrite this method to implement a generic configuration routine for a (tool) Configuration class.
-
_GetDefaultInstallationDirectory
()[source] Return unresolved default installation directory (str) from template.
Overwrite function in sub-class for automatic search of 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.
-
classmethod
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__WriteGtkWaveSection
(binPath)
-
_ConfigureBinaryDirectory
() Updates section with value from
_template
and returns directory asPath
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.
-
_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
pyIPCMI.ToolChain.GTKWave.
GTKWave
(platform, dryrun, binaryDirectoryPath, version, logger=None)[source] Inheritance
Members
-
BinaryDirectoryPath
-
Version
-
class
Executable
[source]
-
class
SwitchDumpFile
[source] -
_name
= 'dump'
-
-
class
SwitchSaveFile
[source] -
_name
= 'save'
-
-
Parameters
= [<class 'pyIPCMI.ToolChain.GTKWave.GTKWave.Executable'>, <class 'pyIPCMI.ToolChain.GTKWave.GTKWave.SwitchDumpFile'>, <class 'pyIPCMI.ToolChain.GTKWave.GTKWave.SwitchSaveFile'>]
-
View
()[source]
-
GetReader
()
-
HasErrors
True if errors or fatals errors were found while processing the output stream.
-
HasWarnings
True if errors or fatals errors were found while processing the output stream.
-
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.
-
Path
-
ReadUntilBoundary
(indent=0)
-
Send
(line, end='\n')
-
SendBoundary
()
-
StartProcess
(parameterList)
-
Terminate
()
-
_TryLog
(*args, condition=True, **kwargs)
-
_pyIPCMI_BOUNDARY
= '====== pyIPCMI BOUNDARY ======'
-
Functions
-
pyIPCMI.ToolChain.GTKWave.
GTKWaveFilter
(gen)[source]