pyGHDL.dom._Utils

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(): Undocumented.

• GetModeOfNode(): Return the mode of a node.

---

Functions

pyGHDL.dom._Utils.CheckForErrors()

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

Behavior:

1. read the error buffer and clear it afterwards.

2. convert it into a list of internal messages for a LibGHDLException.

3. 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)

Return the kind of a node in the IIR tree.

Return type:

Iir_Kind

Returns:

The IIR kind of a node.

Raises:

ValueError – If parameter node is Null_Iir.

Parameters:

node (Iir)

pyGHDL.dom._Utils.GetNameOfNode(node)

Return the Python string from node node identifier.

Raises:

ValueError – If parameter node is Null_Iir.

Return type:

str

Parameters:

node (Iir)

pyGHDL.dom._Utils.GetLabelOfNode(node)

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.

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.

Parameters:

node (Iir)

pyGHDL.dom._Utils.GetDocumentationOfNode(node)

Return type:

str

Parameters:

node (Iir)

pyGHDL.dom._Utils.GetModeOfNode(node)

Return the mode of a node.

Raises:

• ValueError – If parameter node is Null_Iir.

• DOMException – If mode returned by libghdl is not known by __MODE_TRANSLATION.

Return type:

Mode

Parameters:

node (Iir)