engine_t Derived Type

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module subroutine add_state_engine(this, name, prompt, stat, errmsg)

Arguments

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module subroutine add_command_engine(this, state, spec, kind, target, proc, help, args, stat, errmsg)

Arguments

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module subroutine add_include_engine(this, state, included, stat, errmsg)

Arguments

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module subroutine set_on_enter_engine(this, state, proc, stat, errmsg)

Arguments

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module subroutine finalize_engine(this, initial, stat, errmsg)

Arguments

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module subroutine run_engine(this)

Arguments

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module function run_file_engine(this, path, echo, stat, errmsg, line) result(ok)

Arguments

Return Value logical

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module subroutine reset_engine(this, stat, errmsg)

Arguments

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module function dispatch_engine(this, line) result(rc)

Arguments

Return Value integer

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module subroutine set_io_units_engine(this, input_unit, output_unit, error_unit)

Arguments

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module function current_state_engine(this) result(name)

Arguments

Return Value character(len=:), allocatable

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module function current_context_engine(this) result(ctx)

Arguments

Return Value character(len=:), allocatable

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module function is_running_engine(this) result(b)

Arguments

Return Value logical

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module function available_commands_engine(this) result(cmds)

Arguments

Return Value type(command_info_t), allocatable, (:)

interface

Add a concrete state (has a prompt) or abstract state (mix-in, no prompt). Add a command edge to state. Build an integer arg_spec_t. Build a real arg_spec_t. Build a character arg_spec_t. Build a rest arg_spec_t (verbatim remainder of the line; must be last). Return n copies of an integer spec (fixed-size tuple, e.g. a 2D point). Return n copies of a real spec. Successful result, optionally carrying a DoGoto context string. Error result, optionally with a message written to the error channel. Merge all commands from abstract state included into state. The state's own commands override included ones with the same spec. Register a hook called after every successful transition into state. Validate the graph and set the initial state. Sets stat non-zero if a cycle is detected in goto/do_goto edges or if any state reference is unresolved. Run an interactive loop reading from the configured input stream. Execute commands from path, stopping at the first error. Returns .true. if the file ran to completion (or ended with quit). Rewind to the initial state without rebuilding the graph. Clears the stack, contexts, last_message, and last_error. Redirect I/O channels. Pass QUIET_UNIT to suppress a channel. Default: stdin / stdout / stderr. Dispatch one line of input. Performs prefix matching, arg validation, and edge traversal. Name of the active state. Context of the active state. Returns .false. after Quit or stack exhausted. Commands visible in the current state (own + included, help/? excluded). Result depends only on the state name; safe to cache keyed by state name. State names on the stack, bottom-first.

private module function state_path_engine(this) result(names)

Arguments

Return Value character(len=:), allocatable, (:)