Interface Declaration

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_Interface_Terminal_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.
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.
Subnature_Indication	Field5	Iir	owned	—
Nature	Field1	Iir	ref	—
Has_Identifier_List	Flag3	Boolean	owned	Layout flag for object declaration. If True, the identifier of this declaration is followed by an identifier (and separated by a comma). This flag is set on all but the last declarations. Eg: on ‘signal A, B, C : Bit’, the flag is set on A and B (but not C).
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.
Use_Flag	Flag6	Boolean	owned	For a declaration: true if the declaration is used somewhere.
Has_Mode	Flag10	Boolean	owned	Layout flag for object declaration. If True, the mode is present.
Has_Class	Flag11	Boolean	owned	Layout flag for object declaration. If True, the object class is present.
Has_Semicolon	Flag16	Boolean	owned	Layout flag for interface declaration. If True, ‘;’ is present after the interface. In case of multiple names separated with colon, it cannot be set with Has_Identifier_List.
Is_Ref	Flag12	Boolean	owned	Set to True if Maybe_Ref fields are references. This cannot be shared with Has_Identifier_List as: Is_Ref is set to True on all items but the first, while Has_Identifier_List is set to True on all items but the last. Furthermore Is_Ref appears in nodes where Has_Identifier_List is not present.
Name_Staticness	State2	Iir_Staticness	owned	Staticness of a name, according to rules of LRM 6.1

Iir_Kind_Interface_Type_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.
Interface_Type_Definition	Field5	Iir	owned	Owner of the interface type definition.
Type	Field1	Iir	ref	—
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.
Interface_Type_Subprograms	Field4	Iir	chain	Chain of extra interfaces for = and /=.
Has_Identifier_List	Flag3	Boolean	owned	Layout flag for object declaration. If True, the identifier of this declaration is followed by an identifier (and separated by a comma). This flag is set on all but the last declarations. Eg: on ‘signal A, B, C : Bit’, the flag is set on A and B (but not C).
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.
Use_Flag	Flag6	Boolean	owned	For a declaration: true if the declaration is used somewhere.
Is_Ref	Flag12	Boolean	owned	Set to True if Maybe_Ref fields are references. This cannot be shared with Has_Identifier_List as: Is_Ref is set to True on all items but the first, while Has_Identifier_List is set to True on all items but the last. Furthermore Is_Ref appears in nodes where Has_Identifier_List is not present.
Open_Flag	Flag7	Boolean	owned	This flag is set for a very short time during the check that no in port is unconnected.
Has_Semicolon	Flag16	Boolean	owned	Layout flag for interface declaration. If True, ‘;’ is present after the interface. In case of multiple names separated with colon, it cannot be set with Has_Identifier_List.
Name_Staticness	State2	Iir_Staticness	owned	Staticness of a name, according to rules of LRM 6.1

Iir_Kind_Interface_Package_Declaration

LRM08 6.5.5 Interface package declarations

interface_package_declaration ::=
   PACKAGE identifier IS NEW /uninstantiated_package/_name
      interface_package_generic_map_aspect

interface_package_generic_map_aspect ::=
     generic_map_aspect
   | GENERIC MAP ( <> )                  --  Represented by Null_Iir
   | GENERIC MAP ( DEFAULT )             --  Not yet implemented

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	Those fields are set only for the interface package in uninstantiated units.
Uninstantiated_Package_Decl	Field9	Iir	ref	—
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	—
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.
Associated_Package	Field4	Iir	ref	This field is set only for interface package that has been associated.
Chain	Field2	Iir	chain next	—
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.
Open_Flag	Flag7	Boolean	owned	This flag is set for a very short time during the check that no in port is unconnected.
Has_Semicolon	Flag16	Boolean	owned	Layout flag for interface declaration. If True, ‘;’ is present after the interface. In case of multiple names separated with colon, it cannot be set with Has_Identifier_List.

Iir_Kind_Interface_Function_Declaration

LRM08 6.5.4 Interface subprogram declarations

interface_subprogram_declaration ::=
   interface_subprogram_specification
     [ IS interface_subprogram_default ]

interface_subprogram_specification ::=
   interface_procedure_specification | interface_function_specification

interface_procedure_specification ::=
   PROCEDURE designator
      [ [ PARAMETER ] ( formal_parameter_list ) ]

interface_function_specification ::=
   [ PURE | IMPURE ] FUNCTION designator
      [ [ PARAMETER ] ( formal_parameter_list ) ] RETURN type_mark

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.
Return_Type	Field1	Iir	ref	—
Chain	Field2	Iir	chain next	—
Identifier	Field3	Name_Id	owned	For string, the identifier is the corresponding reserved word.
Subprogram_Hash	Field4	Iir_Int32	owned	Hash of a subprogram profile. This is used to speed up subprogram profile comparison, which is very often used by overload.
Interface_Declaration_Chain	Field5	Iir	chain	—
Return_Type_Mark	Field8	Iir	owned	—
Default_Subprogram	Field9	Iir	owned	A Reference_Name for <>.
Subprogram_Depth	Field10	Iir_Int32	owned	Depth of a subprogram. For a subprogram declared immediately within an entity, architecture, package, process, block, generate, the depth is 0. For a subprogram declared immediately within a subprogram of level N, the depth is N + 1. Depth is used with depth of impure objects to check purity rules.
Associated_Subprogram	Field6	Iir	ref	—
Seen_Flag	Flag1	Boolean	owned	Get/Set the seen flag. Used when the graph of callees is walked, to avoid infinite loops, since the graph is not a DAG (there may be cycles).
Pure_Flag	Flag14	Boolean	owned	Get/Set the pure flag of a function. TRUE if the function is declared pure. FALSE if the function is declared impure.
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.
Use_Flag	Flag6	Boolean	owned	For a declaration: true if the declaration is used somewhere.
Resolution_Function_Flag	Flag13	Boolean	owned	True if the function is used as a resolution function.
Has_Pure	Flag8	Boolean	owned	Layout flag: true if ‘pure’ or ‘impure’ is present.
Has_Parameter	Flag10	Boolean	owned	Layout flag: true if ‘parameter’ reserved identifier is present.
All_Sensitized_State	State3	Iir_All_Sensitized	owned	Get/Set whether the subprogram may be called by a sensitized process whose sensitivity list is ALL. FALSE if declared in a package unit and reads a signal that is not one of its interface, or if it calls such a subprogram. TRUE if it doesn’t call a subprogram whose state is False and either doesn’t read a signal or declared within an entity or architecture. UNKNOWN if the status is not yet known.
Open_Flag	Flag7	Boolean	owned	This flag is set for a very short time during the check that no in port is unconnected.
Has_Semicolon	Flag16	Boolean	owned	Layout flag for interface declaration. If True, ‘;’ is present after the interface. In case of multiple names separated with colon, it cannot be set with Has_Identifier_List.

Iir_Kind_Interface_Procedure_Declaration

LRM08 6.5.4 Interface subprogram declarations

interface_subprogram_declaration ::=
   interface_subprogram_specification
     [ IS interface_subprogram_default ]

interface_subprogram_specification ::=
   interface_procedure_specification | interface_function_specification

interface_procedure_specification ::=
   PROCEDURE designator
      [ [ PARAMETER ] ( formal_parameter_list ) ]

interface_function_specification ::=
   [ PURE | IMPURE ] FUNCTION designator
      [ [ PARAMETER ] ( formal_parameter_list ) ] RETURN type_mark

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	For string, the identifier is the corresponding reserved word.
Subprogram_Hash	Field4	Iir_Int32	owned	Hash of a subprogram profile. This is used to speed up subprogram profile comparison, which is very often used by overload.
Interface_Declaration_Chain	Field5	Iir	chain	—
Return_Type_Mark	Field8	Iir	owned	—
Default_Subprogram	Field9	Iir	owned	A Reference_Name for <>.
Subprogram_Depth	Field10	Iir_Int32	owned	Depth of a subprogram. For a subprogram declared immediately within an entity, architecture, package, process, block, generate, the depth is 0. For a subprogram declared immediately within a subprogram of level N, the depth is N + 1. Depth is used with depth of impure objects to check purity rules.
Associated_Subprogram	Field6	Iir	ref	—
Seen_Flag	Flag1	Boolean	owned	Get/Set the seen flag. Used when the graph of callees is walked, to avoid infinite loops, since the graph is not a DAG (there may be cycles).
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.
Use_Flag	Flag6	Boolean	owned	For a declaration: true if the declaration is used somewhere.
Has_Parameter	Flag10	Boolean	owned	Layout flag: true if ‘parameter’ reserved identifier is present.
Suspend_Flag	Flag11	Boolean	owned	Set on wait, procedure call and composite statements when there is a sub-statement that can suspend a procedure or a process. Also set on procedure declaration. Note that the flag is conservative: it must be true if the node contains directly or indirectly a wait statement, but need not to be false otherwise.
All_Sensitized_State	State3	Iir_All_Sensitized	owned	Get/Set whether the subprogram may be called by a sensitized process whose sensitivity list is ALL. FALSE if declared in a package unit and reads a signal that is not one of its interface, or if it calls such a subprogram. TRUE if it doesn’t call a subprogram whose state is False and either doesn’t read a signal or declared within an entity or architecture. UNKNOWN if the status is not yet known.
Open_Flag	Flag7	Boolean	owned	This flag is set for a very short time during the check that no in port is unconnected.
Has_Semicolon	Flag16	Boolean	owned	Layout flag for interface declaration. If True, ‘;’ is present after the interface. In case of multiple names separated with colon, it cannot be set with Has_Identifier_List.