Raxol.Core.Runtime.Lifecycle (Raxol v2.3.0)

Manages the application lifecycle, including startup, shutdown, and terminal interaction.

Orchestrates initialization of subsystems in order:

PluginManager -- loads and starts plugins
Dispatcher -- manages app model and event routing (TEA update/2 loop)
Terminal Driver -- raw terminal I/O (skipped for :liveview/:ssh environments)
Rendering Engine -- view -> layout -> buffer -> output pipeline

Uses a two-phase readiness pattern: rendering begins only after both dispatcher_ready and plugin_manager_ready flags are set. In dev mode, a CodeReloader is started to watch for source changes and trigger re-renders.

Sub-modules

Lifecycle.Initializer -- component startup sequence
Lifecycle.Shutdown -- stop_process, cleanup, registry management

Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get_app_name(app_module)

Gets the application name for a given module.

handle_cleanup(context)

handle_error(error, context)

initialize_environment(options)

Initializes the runtime environment. (Stub for test compatibility)

lookup_app(app_id)

Looks up a registered app by ID.

start_application(app, opts)

Starts a Raxol application (compatibility wrapper).

start_link(app_module, options \\ [])

Starts and links a new Raxol application lifecycle manager.

stop(pid_or_name)

Stops the Raxol application lifecycle manager.

stop_application(val)

Stops a Raxol application (compatibility wrapper).

terminate_manager(reason, state)

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

get_app_name(app_module)

@spec get_app_name(atom()) :: String.t()

Gets the application name for a given module.

handle_cleanup(context)

@spec handle_cleanup(map()) :: :ok | {:error, :cleanup_failed}

handle_error(error, context)

@spec handle_error(term(), term()) ::
  {:stop, :normal, map()}
  | {:ok, :continue | :reinitialize_resources | :restart_components}

initialize_environment(options)

@spec initialize_environment(keyword()) :: keyword()

Initializes the runtime environment. (Stub for test compatibility)

lookup_app(app_id)

@spec lookup_app(term()) :: {:ok, term()} | {:error, :not_found | :app_not_found}

Looks up a registered app by ID.

start_application(app, opts)

@spec start_application(
  module(),
  keyword()
) :: GenServer.on_start()

Starts a Raxol application (compatibility wrapper).

start_link(app_module, options \\ [])

Starts and links a new Raxol application lifecycle manager.

Options

:app_module - Required application module atom.
:name - Optional name for registering the GenServer.
:width - Terminal width (default: 80).
:height - Terminal height (default: 24).
:debug - Enable debug mode (default: false).
:initial_commands - A list of Raxol.Core.Runtime.Command structs to execute on startup.
:plugin_manager_opts - Options to pass to the PluginManager's start_link function.

stop(pid_or_name)

Stops the Raxol application lifecycle manager.

stop_application(val)

@spec stop_application(GenServer.server()) :: :ok

Stops a Raxol application (compatibility wrapper).

terminate_manager(reason, state)

@spec terminate_manager(term(), %Raxol.Core.Runtime.Lifecycle.State{
  app_module: term(),
  app_name: term(),
  code_reloader_pid: term(),
  command_registry_table: term(),
  cycle_profiler_pid: term(),
  debug_mode: term(),
  dispatcher_pid: term(),
  dispatcher_ready: term(),
  driver_pid: term(),
  height: term(),
  initial_commands: term(),
  model: term(),
  options: term(),
  plugin_manager: term(),
  plugin_manager_ready: term(),
  rendering_engine_pid: term(),
  time_travel_pid: term(),
  width: term()
}) :: :ok