MingaEditor.Shell.Runtime (Minga v0.1.0)

Copy Markdown View Source

Immutable owner of the editor's active shell runtime value.

A runtime contains one resolved registry entry, the state produced by that shell, and stashed states tied to exact registry identities. Registry lookup and every effectful policy decision stay outside this module. Callers resolve entries and initialize replacement states before invoking a transition.

Summary

Types

persistence_change()
shell_state()
stash()
t()

Functions

accept_persisted_state(runtime, entry, persisted_state)

Installs state returned by persistence for the exact active or stashed registration.

accept_rendered_state(runtime, shell_id, identity, rendered_state)

Installs shell state returned by a render for the exact active identity.

activate(runtime, target, initialized_state)

Activates a resolved entry, stashing the outgoing state and restoring only an exact identity match.

active_entry?(runtime, entry)

Returns true when a resolved entry is exactly the active registration.

active_session(runtime)

Returns the active session through the active shell contract.

active_tab(runtime)

Returns the active tab through the active shell contract.

active_tab_kind(runtime)

Returns the active tab kind through the active shell contract.

blur_bottom_panel(runtime)

Routes bottom-panel blur through the active shell contract.

default_entry()

Returns the deterministic built-in entry used by raw Editor state construction.

drop_extension_feature_state_sources(runtime, entries)

Drops extension feature state through active and exact-identity stashed shell callbacks.

drop_feature_state_source(runtime, entries, source)

Drops one feature-state source through active and exact-identity stashed callbacks.

entry(runtime)

Returns the resolved active entry.

fallback_from_removed(runtime, default_entry, initialized_state)

Falls back from a removed active registration without stashing its now-unresolvable value.

find_tab_by_buffer(runtime, pid)

Finds a tab through the active shell contract.

id(runtime)

Returns the active shell id.

identity(runtime)

Returns the exact identity of the active resolved entry.

install_traditional_state(runtime, state)

Installs a value produced by a named Traditional.State transition when Traditional is active.

matches_identity?(runtime, identity)

Returns true when an asynchronous identity belongs to the active entry.

module(runtime)

Returns the active shell contract module.

new(entry, state)

Builds a runtime from an already-resolved entry and initialized shell state.

owns_agent_session?(runtime, entries, session_pid)

Returns whether the active or an exact-identity stashed entry owns a session.

restorable?(runtime, entry)

Returns whether an exact-identity stashed value can restore the resolved entry.

retire_buffer(runtime, buffer_pid)

Retires a dead buffer from active and exact-identity stashed Traditional values.

route_agent_event(runtime, workspace, session_pid, event)

Routes an agent event through the active entry.

route_buffer_added(runtime, previous_workspace, workspace, metadata)

Routes workflow-prepared buffer metadata through the active shell outside root transitions.

route_buffer_died(runtime, workspace, dead_pid)

Routes buffer-removal lifecycle through the active shell.

route_buffer_switched(runtime, workspace)

Routes buffer-switch lifecycle through the active shell.

route_event(runtime, workspace, event)

Routes a shell event through the active entry's contract.

route_gui_action(runtime, workspace, action)

Routes a shell GUI action through the active entry's contract.

route_remote_session_disconnected(runtime, session_pid)

Routes a remote disconnect through the active entry.

route_session_down(runtime, session_pid, reason)

Routes an optional active session-down transition through the active entry.

route_session_restarted(runtime, entries, old_pid, new_pid, reason)

Routes a session restart through the active and exact-identity stashed entries.

route_stashed_agent_event(runtime, entries, workspace, session_pid, event)

Routes an agent event through exact-identity stashes using caller-resolved entries.

route_stashed_remote_session_disconnected(runtime, entries, session_pid)

Routes a remote disconnect through the first exact-identity stash that owns it.

route_stashed_session_down(runtime, entries, session_pid, reason)

Routes session-down through the first exact-identity stash that owns it.

set_tab_session(runtime, tab_id, session_pid)

Associates a session with a shell tab through the active contract.

stash(runtime)

Returns the identity-keyed shell-state stash.

state(runtime)

Returns the active shell state.

sync_agent_status(runtime, entries, session_pid, status)

Routes an optional agent status update through active and stashed entries.

track_agent_file(runtime, entries, session_pid, path)

Routes optional agent-file tracking through active and stashed entries.

validate_registration(runtime, resolved, initialized_state)

Accepts the currently resolved active entry or resets state when its registry identity changed.

Types

persistence_change()

@type persistence_change() ::
  {MingaEditor.Shell.Entry.t(), shell_state(), shell_state()}

shell_state()

@type shell_state() :: MingaEditor.Shell.shell_state()

stash()

@type stash() :: %{
  required(MingaEditor.Shell.Identity.t()) => MingaEditor.Shell.StateStash.t()
}

t()

@type t() :: %MingaEditor.Shell.Runtime{
  entry: MingaEditor.Shell.Entry.t(),
  stash: stash(),
  state: shell_state()
}

Functions

accept_persisted_state(runtime, entry, persisted_state)

@spec accept_persisted_state(t(), MingaEditor.Shell.Entry.t(), shell_state()) :: t()

Installs state returned by persistence for the exact active or stashed registration.

accept_rendered_state(runtime, shell_id, identity, rendered_state)

@spec accept_rendered_state(
  t(),
  atom(),
  MingaEditor.Shell.Identity.t(),
  shell_state()
) :: t()

Installs shell state returned by a render for the exact active identity.

activate(runtime, target, initialized_state)

@spec activate(t(), MingaEditor.Shell.Entry.t(), shell_state()) :: t()

Activates a resolved entry, stashing the outgoing state and restoring only an exact identity match.

active_entry?(runtime, entry)

@spec active_entry?(t(), MingaEditor.Shell.Entry.t()) :: boolean()

Returns true when a resolved entry is exactly the active registration.

active_session(runtime)

@spec active_session(t()) :: pid() | nil

Returns the active session through the active shell contract.

active_tab(runtime)

@spec active_tab(t()) :: MingaEditor.State.Tab.t() | nil

Returns the active tab through the active shell contract.

active_tab_kind(runtime)

@spec active_tab_kind(t()) :: atom()

Returns the active tab kind through the active shell contract.

blur_bottom_panel(runtime)

@spec blur_bottom_panel(t()) :: t()

Routes bottom-panel blur through the active shell contract.

default_entry()

@spec default_entry() :: MingaEditor.Shell.Entry.t()

Returns the deterministic built-in entry used by raw Editor state construction.

drop_extension_feature_state_sources(runtime, entries)

@spec drop_extension_feature_state_sources(t(), [MingaEditor.Shell.Entry.t()]) :: t()

Drops extension feature state through active and exact-identity stashed shell callbacks.

drop_feature_state_source(runtime, entries, source)

@spec drop_feature_state_source(
  t(),
  [MingaEditor.Shell.Entry.t()],
  MingaEditor.FeatureState.source()
) ::
  t()

Drops one feature-state source through active and exact-identity stashed callbacks.

entry(runtime)

@spec entry(t()) :: MingaEditor.Shell.Entry.t()

Returns the resolved active entry.

fallback_from_removed(runtime, default_entry, initialized_state)

@spec fallback_from_removed(t(), MingaEditor.Shell.Entry.t(), shell_state()) :: t()

Falls back from a removed active registration without stashing its now-unresolvable value.

find_tab_by_buffer(runtime, pid)

@spec find_tab_by_buffer(t(), pid()) :: MingaEditor.State.Tab.t() | nil

Finds a tab through the active shell contract.

id(runtime)

@spec id(t()) :: atom()

Returns the active shell id.

identity(runtime)

@spec identity(t()) :: MingaEditor.Shell.Identity.t()

Returns the exact identity of the active resolved entry.

install_traditional_state(runtime, state)

@spec install_traditional_state(t(), MingaEditor.Shell.Traditional.State.t()) :: t()

Installs a value produced by a named Traditional.State transition when Traditional is active.

matches_identity?(runtime, identity)

@spec matches_identity?(t(), MingaEditor.Shell.Identity.t()) :: boolean()

Returns true when an asynchronous identity belongs to the active entry.

module(runtime)

@spec module(t()) :: module()

Returns the active shell contract module.

new(entry, state)

@spec new(MingaEditor.Shell.Entry.t(), shell_state()) :: t()

Builds a runtime from an already-resolved entry and initialized shell state.

owns_agent_session?(runtime, entries, session_pid)

@spec owns_agent_session?(t(), [MingaEditor.Shell.Entry.t()], pid()) :: boolean()

Returns whether the active or an exact-identity stashed entry owns a session.

restorable?(runtime, entry)

@spec restorable?(t(), MingaEditor.Shell.Entry.t()) :: boolean()

Returns whether an exact-identity stashed value can restore the resolved entry.

retire_buffer(runtime, buffer_pid)

@spec retire_buffer(t(), pid()) :: t()

Retires a dead buffer from active and exact-identity stashed Traditional values.

route_agent_event(runtime, workspace, session_pid, event)

@spec route_agent_event(t(), MingaEditor.Shell.workspace(), pid(), term()) ::
  {t(), MingaEditor.Shell.workspace(), persistence_change() | nil}

Routes an agent event through the active entry.

route_buffer_added(runtime, previous_workspace, workspace, metadata)

@spec route_buffer_added(
  t(),
  MingaEditor.Shell.workspace(),
  MingaEditor.Shell.workspace(),
  MingaEditor.Shell.BufferMetadata.t()
) :: {t(), MingaEditor.Shell.workspace()}

Routes workflow-prepared buffer metadata through the active shell outside root transitions.

route_buffer_died(runtime, workspace, dead_pid)

@spec route_buffer_died(t(), MingaEditor.Shell.workspace(), pid()) ::
  {t(), MingaEditor.Shell.workspace()}

Routes buffer-removal lifecycle through the active shell.

route_buffer_switched(runtime, workspace)

@spec route_buffer_switched(t(), MingaEditor.Shell.workspace()) ::
  {t(), MingaEditor.Shell.workspace()}

Routes buffer-switch lifecycle through the active shell.

route_event(runtime, workspace, event)

@spec route_event(t(), MingaEditor.Shell.workspace(), term()) ::
  {t(), MingaEditor.Shell.workspace()}

Routes a shell event through the active entry's contract.

route_gui_action(runtime, workspace, action)

@spec route_gui_action(t(), MingaEditor.Shell.workspace(), term()) ::
  {t(), MingaEditor.Shell.workspace()}

Routes a shell GUI action through the active entry's contract.

route_remote_session_disconnected(runtime, session_pid)

@spec route_remote_session_disconnected(t(), pid()) ::
  {t(), boolean(), persistence_change() | nil}

Routes a remote disconnect through the active entry.

route_session_down(runtime, session_pid, reason)

@spec route_session_down(t(), pid(), term()) ::
  {t(), boolean(), persistence_change() | nil}

Routes an optional active session-down transition through the active entry.

route_session_restarted(runtime, entries, old_pid, new_pid, reason)

@spec route_session_restarted(
  t(),
  [MingaEditor.Shell.Entry.t()],
  pid(),
  pid(),
  term()
) ::
  {t(), boolean(), [persistence_change()]}

Routes a session restart through the active and exact-identity stashed entries.

route_stashed_agent_event(runtime, entries, workspace, session_pid, event)

@spec route_stashed_agent_event(
  t(),
  [MingaEditor.Shell.Entry.t()],
  MingaEditor.Shell.workspace(),
  pid(),
  term()
) :: {t(), MingaEditor.Shell.workspace(), [persistence_change()]}

Routes an agent event through exact-identity stashes using caller-resolved entries.

route_stashed_remote_session_disconnected(runtime, entries, session_pid)

@spec route_stashed_remote_session_disconnected(
  t(),
  [MingaEditor.Shell.Entry.t()],
  pid()
) ::
  {t(), boolean(), [persistence_change()]}

Routes a remote disconnect through the first exact-identity stash that owns it.

route_stashed_session_down(runtime, entries, session_pid, reason)

@spec route_stashed_session_down(t(), [MingaEditor.Shell.Entry.t()], pid(), term()) ::
  {t(), boolean(), [persistence_change()]}

Routes session-down through the first exact-identity stash that owns it.

set_tab_session(runtime, tab_id, session_pid)

@spec set_tab_session(t(), term(), pid() | nil) :: t()

Associates a session with a shell tab through the active contract.

stash(runtime)

@spec stash(t()) :: stash()

Returns the identity-keyed shell-state stash.

state(runtime)

@spec state(t()) :: shell_state()

Returns the active shell state.

sync_agent_status(runtime, entries, session_pid, status)

@spec sync_agent_status(t(), [MingaEditor.Shell.Entry.t()], pid(), term()) :: t()

Routes an optional agent status update through active and stashed entries.

track_agent_file(runtime, entries, session_pid, path)

@spec track_agent_file(t(), [MingaEditor.Shell.Entry.t()], pid(), String.t()) :: t()

Routes optional agent-file tracking through active and stashed entries.

validate_registration(runtime, resolved, initialized_state)

@spec validate_registration(t(), MingaEditor.Shell.Entry.t(), shell_state()) ::
  {t(), :current | :reset}

Accepts the currently resolved active entry or resets state when its registry identity changed.