Make In_IO_State function public

Closes #1155

CHANGELOG.md

@@ -72,6 +72,7 @@ Generator:
 - Add precondition `Uninitialized` to procedure `Initialize` (#788)
 - Add operators for `Length` and `Index` types (#1070)
 - Overwrite symlinks when creating files
+- Make `In_IO_State` session function public (#1155)
 
 PyRFLX:
 

rflx/generator/session.py

@@ -357,7 +357,8 @@ def is_global(identifier: ID) -> bool:
             unit += self._create_reset_messages_before_write_procedure(self._session, is_global)
 
         unit += self._create_tick_procedure(self._session, has_reads)
-        unit += self._create_run_procedure(self._session)
+        unit += self._create_in_io_state_function(self._session)
+        unit += self._create_run_procedure()
         unit += self._create_state_function()
 
         if has_writes:
@@ -1134,7 +1135,7 @@ def _create_tick_procedure(self, session: model.Session, has_writes: bool) -> Un
         )
 
     @staticmethod
-    def _create_run_procedure(session: model.Session) -> UnitPart:
+    def _create_in_io_state_function(session: model.Session) -> UnitPart:
         io_states = [
             state
             for state in session.states
@@ -1148,6 +1149,30 @@ def _create_run_procedure(session: model.Session) -> UnitPart:
                 )
             )
         ]
+        in_io_state_specification = FunctionSpecification(
+            "In_IO_State",
+            "Boolean",
+            [Parameter(["Ctx" if io_states else "Unused_Ctx"], "Context'Class")],
+        )
+        return UnitPart(
+            [
+                SubprogramDeclaration(in_io_state_specification),
+            ],
+            [
+                ExpressionFunctionDeclaration(
+                    in_io_state_specification,
+                    In(
+                        Variable("Ctx.P.Next_State"),
+                        ChoiceList(*[Variable(f"S_{state.identifier}") for state in io_states]),
+                    )
+                    if io_states
+                    else FALSE,
+                ),
+            ],
+        )
+
+    @staticmethod
+    def _create_run_procedure() -> UnitPart:
         specification = ProcedureSpecification("Run", [InOutParameter(["Ctx"], "Context'Class")])
         return UnitPart(
             [
@@ -1162,19 +1187,6 @@ def _create_run_procedure(session: model.Session) -> UnitPart:
                 Pragma("Warnings", [Variable("On"), String('subprogram "Run" has no effect')]),
             ],
             [
-                ExpressionFunctionDeclaration(
-                    FunctionSpecification(
-                        "In_IO_State",
-                        "Boolean",
-                        [Parameter(["Ctx" if io_states else "Unused_Ctx"], "Context'Class")],
-                    ),
-                    In(
-                        Variable("Ctx.P.Next_State"),
-                        ChoiceList(*[Variable(f"S_{state.identifier}") for state in io_states]),
-                    )
-                    if io_states
-                    else FALSE,
-                ),
                 SubprogramBody(
                     specification,
                     [],

tests/integration/messages_with_implict_size/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/messages_with_single_opaque_field/generated/rflx-test-session.ads

@@ -54,6 +54,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/parameterized_messages/generated/rflx-test-session.ads

@@ -54,6 +54,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_append_unconstrained/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_binding/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_case_expression_aggregate/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_case_expression_numeric/generated/rflx-test-session.ads

@@ -54,6 +54,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_channel_multiplexing/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_channels/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_comprehension_head/generated/rflx-test-session.ads

@@ -57,6 +57,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_comprehension_on_message_field/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_comprehension_on_sequence/generated/rflx-test-session.ads

@@ -56,6 +56,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_conversion/generated/rflx-test-session.ads

@@ -56,6 +56,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_endianness/generated/rflx-test-session.ads

@@ -57,6 +57,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_functions/generated/rflx-test-session.ads

@@ -64,6 +64,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_functions_opaque/generated/rflx-test-session.ads

@@ -49,6 +49,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Unused_Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_integration/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_integration_multiple/generated/rflx-b-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_integration_multiple/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_minimal/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_reuse_of_message/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_sequence_append/generated/rflx-test-session.ads

@@ -56,6 +56,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_sequence_append_head/generated/rflx-test-session.ads

@@ -57,6 +57,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_setting_of_message_fields/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_simple/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with

tests/integration/session_variable_initialization/generated/rflx-test-session.ads

@@ -55,6 +55,8 @@ is
 
    pragma Warnings (On, "subprogram ""Tick"" has no effect");
 
+   function In_IO_State (Ctx : Context'Class) return Boolean;
+
    pragma Warnings (Off, "subprogram ""Run"" has no effect");
 
    procedure Run (Ctx : in out Context'Class) with