Library Unit

The diagrams below draw one box per node kind, with one port per field. The edge colours say how a link is held; they are listed in full on the Fields page.

Iir_Kind_Foreign_Module

Format: Medium

Accessor	Field	Type	Access	Description
Design_Unit	Field0	Iir	owned	Get the design unit in which the target is declared. For a library unit, this is to get the design unit node.
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Foreign_Node	Field1	Int32	owned	—
Generic_Chain	Field6	Iir	chain	—
Port_Chain	Field7	Iir	chain	—

Iir_Kind_Entity_Declaration

Format: Medium

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Generic_Chain	Field6	Iir	chain	—
Port_Chain	Field7	Iir	chain	—
Declaration_Chain	Field1	Iir	chain	—
Concurrent_Statement_Chain	Field4	Iir	chain	—
Attribute_Value_Chain	Field5	Iir	ref	Chain of attribute values for declared items. To be used with Get/Set_Value_Chain. There is no order, therefore, a new attribute value may be always prepended.
Bound_Vunit_Chain	Field8	Iir	chain	Chain of vunit declarations bound to an entity or an architecture.
Macro_Expand_Flag	Flag2	Boolean	owned	True if the entity has to be macro-expanded. Set when a generic interface is a type or a subprogram interface.
Visible_Flag	Flag4	Boolean	owned	Get/Set the visible flag of a declaration. The visible flag is true to make invalid the use of the identifier during its declaration. It is set to false when the identifier is added to the name table, and set to true when the declaration is finished.
Is_Within_Flag	Flag5	Boolean	owned	This flag is set is code being analyzed is textually within TARGET. This is used for selected by name rule.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.
Has_Begin	Flag10	Boolean	owned	Layout flag: true if ‘begin’ is present.

Iir_Kind_Configuration_Declaration

Format: Short

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Declaration_Chain	Field1	Iir	chain	—
Entity_Name	Field2	Iir	owned	Name of the entity of a configuration.
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Attribute_Value_Chain	Field5	Iir	ref	Chain of attribute values for declared items. To be used with Get/Set_Value_Chain. There is no order, therefore, a new attribute value may be always prepended.
Block_Configuration	Field4	Iir	owned	—
Visible_Flag	Flag4	Boolean	owned	Get/Set the visible flag of a declaration. The visible flag is true to make invalid the use of the identifier during its declaration. It is set to false when the identifier is added to the name table, and set to true when the declaration is finished.
Is_Within_Flag	Flag5	Boolean	owned	This flag is set is code being analyzed is textually within TARGET. This is used for selected by name rule.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.

Iir_Kind_Context_Declaration

Format: Short

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Context_Items	Field1	Iir	chain	Get the chain of context clause.
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Visible_Flag	Flag4	Boolean	owned	Get/Set the visible flag of a declaration. The visible flag is true to make invalid the use of the identifier during its declaration. It is set to false when the identifier is added to the name table, and set to true when the declaration is finished.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.

Iir_Kind_Package_Declaration

Format: Medium

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Package_Header	Field6	Iir	owned	—
Declaration_Chain	Field1	Iir	chain	—
Chain	Field2	Iir	chain next	For nested packages
Attribute_Value_Chain	Field5	Iir	ref	Chain of attribute values for declared items. To be used with Get/Set_Value_Chain. There is no order, therefore, a new attribute value may be always prepended.
Package_Body	Field4	Iir	forward ref	The package body (not the unit).
Package_Origin	Field7	Iir	owned	—
Need_Body	Flag1	Boolean	owned	If true, the package need a body.
Macro_Expand_Flag	Flag2	Boolean	owned	True for uninstantiated package that will be macro-expanded for simulation. The macro-expansion is done by canon, so controlled by back-end. The reason of macro-expansion is presence of interface type.
Need_Instance_Bodies	Flag3	Boolean	owned	True if the package declaration has least one package instantiation declaration whose uninstantiated declaration needs both a body and macro-expansion. In that case, the instantiation needs macro-expansion of their body.
Is_Within_Flag	Flag5	Boolean	owned	This flag is set is code being analyzed is textually within TARGET. This is used for selected by name rule.
Visible_Flag	Flag4	Boolean	owned	Get/Set the visible flag of a declaration. The visible flag is true to make invalid the use of the identifier during its declaration. It is set to false when the identifier is added to the name table, and set to true when the declaration is finished.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.

Iir_Kind_Package_Instantiation_Declaration

Format: Medium

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Uninstantiated_Package_Name	Field7	Iir	owned	The name of the uninstantiated package as it appear in the sources. May be Null_Iir.
Uninstantiated_Package_Decl	Field9	Iir	ref	The uninstantiated package declaration.
Instance_Source_File	Field10	Source_File_Entry	owned	The created pseudo-file for relocating the instantiated nodes (generics and declarations).
Generic_Chain	Field6	Iir	chain	—
Generic_Map_Aspect_Chain	Field8	Iir	chain	Generic map aspect list.
Declaration_Chain	Field1	Iir	chain	—
Chain	Field2	Iir	chain next	For nested packages
Attribute_Value_Chain	Field5	Iir	ref	Chain of attribute values for declared items. To be used with Get/Set_Value_Chain. There is no order, therefore, a new attribute value may be always prepended.
Owned_Instance_Package_Body	Field11	Iir	owned	For macro-expanded packages: the body, if owned. Set only iff Immediate_Body_Flag is true.
Instance_Package_Body	Field4	Iir	forward ref	For macro-expanded packages: the body.
Immediate_Body_Flag	Flag5	Boolean	owned	For macro-expanded packages: true if the body appears immediately after.
Visible_Flag	Flag4	Boolean	owned	Get/Set the visible flag of a declaration. The visible flag is true to make invalid the use of the identifier during its declaration. It is set to false when the identifier is added to the name table, and set to true when the declaration is finished.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.

Iir_Kind_Vmode_Declaration

Format: Medium

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Chain	Field2	Iir	chain next	—
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Hierarchical_Name	Field1	Iir	owned	—
Attribute_Value_Chain	Field5	Iir	ref	Chain of attribute values for declared items. To be used with Get/Set_Value_Chain. There is no order, therefore, a new attribute value may be always prepended.
Vunit_Item_Chain	Field6	Iir	chain	—
Verification_Block_Configuration	Field4	Iir	owned	—
Visible_Flag	Flag4	Boolean	owned	Get/Set the visible flag of a declaration. The visible flag is true to make invalid the use of the identifier during its declaration. It is set to false when the identifier is added to the name table, and set to true when the declaration is finished.
Is_Within_Flag	Flag5	Boolean	owned	This flag is set is code being analyzed is textually within TARGET. This is used for selected by name rule.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.
Has_Begin	Flag10	Boolean	owned	Layout flag: true if ‘begin’ is present.

Iir_Kind_Vprop_Declaration

Format: Medium

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Chain	Field2	Iir	chain next	—
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Hierarchical_Name	Field1	Iir	owned	—
Attribute_Value_Chain	Field5	Iir	ref	Chain of attribute values for declared items. To be used with Get/Set_Value_Chain. There is no order, therefore, a new attribute value may be always prepended.
Vunit_Item_Chain	Field6	Iir	chain	—
Verification_Block_Configuration	Field4	Iir	owned	—
Visible_Flag	Flag4	Boolean	owned	Get/Set the visible flag of a declaration. The visible flag is true to make invalid the use of the identifier during its declaration. It is set to false when the identifier is added to the name table, and set to true when the declaration is finished.
Is_Within_Flag	Flag5	Boolean	owned	This flag is set is code being analyzed is textually within TARGET. This is used for selected by name rule.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.
Has_Begin	Flag10	Boolean	owned	Layout flag: true if ‘begin’ is present.

Iir_Kind_Vunit_Declaration

Format: Medium

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Chain	Field2	Iir	chain next	—
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Hierarchical_Name	Field1	Iir	owned	—
Attribute_Value_Chain	Field5	Iir	ref	Chain of attribute values for declared items. To be used with Get/Set_Value_Chain. There is no order, therefore, a new attribute value may be always prepended.
Vunit_Item_Chain	Field6	Iir	chain	—
Verification_Block_Configuration	Field4	Iir	owned	—
Bound_Vunit_Chain	Field8	Iir	chain	Chain of vunit declarations bound to an entity or an architecture.
Visible_Flag	Flag4	Boolean	owned	Get/Set the visible flag of a declaration. The visible flag is true to make invalid the use of the identifier during its declaration. It is set to false when the identifier is added to the name table, and set to true when the declaration is finished.
Is_Within_Flag	Flag5	Boolean	owned	This flag is set is code being analyzed is textually within TARGET. This is used for selected by name rule.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.
Has_Begin	Flag10	Boolean	owned	Layout flag: true if ‘begin’ is present.

Iir_Kind_Package_Body

Note: a body is not a declaration, that’s the reason why there is no _declaration suffix in the name. Note: Package_Instantiation_Body represent the place of the body when it is not immediately after the instantiation.

Format: Short

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Declaration_Chain	Field1	Iir	chain	—
Chain	Field2	Iir	chain next	For nested packages.
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Attribute_Value_Chain	Field5	Iir	ref	Chain of attribute values for declared items. To be used with Get/Set_Value_Chain. There is no order, therefore, a new attribute value may be always prepended.
Package	Field4	Iir	ref	The corresponding package declaration.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.

Iir_Kind_Architecture_Body

Format: Medium

Accessor	Field	Type	Access	Description
Parent	Field0	Iir	ref	Get/Set the statement in which TARGET appears. This is used to check if next/exit is in a loop.
Entity_Name	Field2	Iir	owned	Name of the entity declaration for the architecture.
Declaration_Chain	Field1	Iir	chain	—
Identifier	Field3	Name_Id	owned	Get/Set the identifier of a declaration. Can also be used instead of get/set_label.
Concurrent_Statement_Chain	Field4	Iir	chain	—
Attribute_Value_Chain	Field5	Iir	ref	Chain of attribute values for declared items. To be used with Get/Set_Value_Chain. There is no order, therefore, a new attribute value may be always prepended.
Default_Configuration_Declaration	Field6	Iir	owned	The default configuration created by canon. This is a design unit.
Bound_Vunit_Chain	Field8	Iir	chain	Chain of vunit declarations bound to an entity or an architecture.
Macro_Expand_Flag	Flag2	Boolean	owned	Inherited from the entity.
Foreign_Flag	Flag3	Boolean	owned	Get/Set the foreign flag of a declaration. TRUE if the declaration was decorated with the std.foreign attribute.
Visible_Flag	Flag4	Boolean	owned	Get/Set the visible flag of a declaration. The visible flag is true to make invalid the use of the identifier during its declaration. It is set to false when the identifier is added to the name table, and set to true when the declaration is finished.
Is_Within_Flag	Flag5	Boolean	owned	This flag is set is code being analyzed is textually within TARGET. This is used for selected by name rule.
End_Has_Reserved_Id	Flag8	Boolean	owned	Layout flag: true if ‘end’ is followed by the reserved identifier.
End_Has_Identifier	Flag9	Boolean	owned	Layout flag: true if ‘end’ is followed by the identifier.