pyGHDL.dom._Utils

This module offers helper functions to read an IIR node’s kind, name, label, mode and documentation.

Functions

CheckForErrors(): Check if an error occurred in libghdl and raise an exception if so.
GetIirKindOfNode(): Return the kind of a node in the IIR tree.
GetNameOfNode(): Return the Python string from node node identifier.
GetLabelOfNode(): Return the Python string from node node’s optional label.
GetDocumentationOfNode(): Collects the doc-comment lines attached to an IIR node.
GetModeOfNode(): Return the mode of a node.

Functions

pyGHDL.dom._Utils.CheckForErrors()[source]

Check if an error occurred in libghdl and raise an exception if so.

Behavior:

read the error buffer and clear it afterwards.
convert it into a list of internal messages for a LibGHDLException.
raise a DOMException with a nested LibGHDLException as a __cause__.

Raises:: DOMException – If an error occurred in libghdl.
Return type:: None

pyGHDL.dom._Utils.GetIirKindOfNode(node)[source]

Return the kind of a node in the IIR tree.

Parameters:: node (TypeVar(Iir, bound= c_int)) – The IIR node to read the kind of.
Return type:: Iir_Kind
Returns:: The IIR kind of a node.
Raises:: ValueError – If parameter node is Null_Iir.

pyGHDL.dom._Utils.GetNameOfNode(node)[source]

Return the Python string from node node identifier.

Parameters:: node (TypeVar(Iir, bound= c_int)) – The IIR node to read the identifier of.
Return type:: str
Returns:: The node’s identifier as written in the source file.
Raises:: ValueError – If parameter node is Null_Iir.

pyGHDL.dom._Utils.GetLabelOfNode(node)[source]

Return the Python string from node node’s optional label.

A statement carries its label in Label, while a generate-statement body - the branch of an if-generate or case-generate statement - carries it in Alternative_Label. No node kind has both, so the field is chosen from the node’s kind.

Parameters:: node (TypeVar(Iir, bound= c_int)) – The IIR node to read the label of.
Return type:: str | None
Returns:: The label, or None if the node has no label field or no label was given in the source.
Raises:: ValueError – If parameter node is Null_Iir.

pyGHDL.dom._Utils.GetDocumentationOfNode(node)[source]

Collects the doc-comment lines attached to an IIR node.

libghdl only gathers comments if Flag_Gather_Comments was enabled before parsing, which Design does.

Parameters:: node (TypeVar(Iir, bound= c_int)) – The IIR node to read the comments of.
Return type:: str
Returns:: The comment lines joined by newlines, or an empty string if the node has no comment.

pyGHDL.dom._Utils.GetModeOfNode(node)[source]

Return the mode of a node.

Parameters:

node (TypeVar(Iir, bound= c_int)) – The IIR node to read the mode of.

Return type:

Mode

Returns:

The node’s mode as a pyVHDLModel enumeration value.

Raises:

ValueError – If parameter node is Null_Iir.
DOMException – If mode returned by libghdl is not known by __MODE_TRANSLATION.