MingaEditor.Shell.Traditional.State (Minga v0.1.0)

Copy Markdown View Source

Presentation state for the traditional tab-based editor shell.

This value coordinates focused owners for sidebar, agent-surface, input, and existing independent transient lifecycles. Effects and Editor-root transitions remain in their focused workflows and handlers.

Summary

Types

git_status_panel()
git_status_tui_state()
t()
tab_bar_click_region()
tab_bar_command()

Functions

acknowledge_notice(state)

Acknowledges the current notice.

activate_inline_ask(state, ask)

Activates or replaces an inline ask.

activate_inline_edit(state, edit)

Activates or replaces an inline edit.

advance_nav_flash(state, generation)

Advances only the matching navigation flash generation.

advance_tool_prompt(state)

Advances to the next missing-tool prompt.

advance_yank_flash(state, generation)

Advances only the matching yank flash generation.

agent(state)

Returns the agent presentation cache.

agent_surfaces(state)

Returns the focused agent-surface owner.

begin_space_leader(state)

Begins a new space-leader generation.

begin_whichkey(state, node, prefix_keys)

Begins a hidden which-key lifecycle generation.

blur_bottom_panel(state)

Blurs the shell-owned bottom panel.

bottom_panel(state)

Returns the bottom panel state.

cancel_inline_ask(state, buffer_pid)

Cancels an inline ask and returns its session pid.

cancel_inline_edit(state, buffer_pid)

Cancels an inline edit and returns its session pid.

cancel_nav_flash(state)

Cancels only the navigation flash.

cancel_yank_flash(state)

Cancels only the yank flash.

click_regions(state)

Returns the renderer-authored click-region value.

close_git_status_panel(state)

Closes the Git status sidebar and its paired TUI state.

close_modal(state)

Closes a completed modal.

close_observatory(state)

Closes the BEAM Observatory sidebar.

complete_observatory_refresh(state, token, data, next_timer)

Completes a matching Observatory refresh and installs the next timer.

dismiss_git_toast(state)

Dismisses the current Git toast.

dismiss_git_toast(state, id)

Dismisses a Git toast only when its identity still matches.

dismiss_hover_popup(state)

Dismisses the hover popup.

dismiss_modal(state)

Dismisses a canceled modal.

dismiss_notice(state)

Dismisses the current notice.

dismiss_signature_help(state)

Dismisses signature help through its value owner.

dismiss_stale_modal_completion(state, active_tab_id)

Dismisses stale completion using the now-active tab id.

dismiss_whichkey(state)

Dismisses which-key through its value owner.

enqueue_tool_prompt(state, tool_name)

Queues a missing tool once.

expire_observatory_refresh(state, token)

Expires a matching Observatory refresh token.

expire_space_leader(state, generation)

Expires only the matching space-leader generation.

git_status_panel(state)

Returns the git status panel data, or nil.

git_status_tui_state(state)

Returns the TUI-only git status view state, or nil.

hover_popup(state)

Returns the hover popup state, or nil when not showing.

inline_asks(state)

Returns the inline ask store.

inline_edits(state)

Returns the inline edit store.

input(state)

Returns Traditional input state.

inspect_observatory(state, inspection)

Shows or dismisses the Observatory process inspection.

install_bottom_panel(state, panel)

Installs an exact bottom-panel value.

install_click_regions(state, regions)

Installs one already-correlated click-region value.

install_click_regions(state, modeline, tab_bar)

Installs both click-region sets from one render.

install_space_leader_timer(state, generation, timer)

Records the current space-leader timer.

install_tab_bar(state, tab_bar)

Installs an exact tab-bar value or clears it with nil.

install_tool_prompt_suppression(state, suppress?)

Installs the configured missing-tool prompt suppression policy.

modal(state)

Returns the active modal overlay value (:none when no modal is open).

modeline_command_at(state, col)

Returns the modeline command under a rendered column.

next_signature_help(state)

Cycles to the next signature through its value owner.

next_whichkey_page(state)

Moves which-key to the next page.

observatory(state)

Returns the BEAM Observatory lifecycle value.

observatory_visible?(state)

Returns true when the BEAM Observatory sidebar is visible.

open_modal(state, modal)

Opens an exact modal value through the conflict-sticky transition.

open_observatory(state, timer)

Opens and selects the BEAM Observatory sidebar.

previous_signature_help(state)

Cycles to the previous signature through its value owner.

previous_whichkey_page(state)

Moves which-key to the previous page.

progress_whichkey(state, node, prefix_keys)

Advances the which-key leader prefix.

publish_git_toast(state, message, level, action)

Publishes a protocol-independent Git toast.

publish_notice(state, message)

Applies the notice publish transition.

put_modal_completion_trigger(state, trigger, active_tab_id)

Records completion trigger lifecycle with explicit active-tab context.

record_git_toast_timer(state, id, timer)

Records a Git-toast timer for the matching identity.

record_nav_flash_timer(state, generation, timer)

Records only the matching navigation flash timer.

record_notice_timer(state, id, timer)

Records a notice timer for the matching notice identity.

record_whichkey_timer(state, generation, timer)

Records a which-key timer for the matching generation.

record_yank_flash_timer(state, generation, timer)

Records only the matching yank flash timer.

replace_agent(state, agent)

Replaces the agent presentation cache.

replace_git_status_panel(state, panel)

Replaces the Git status panel through the sidebar owner.

replace_git_status_tui_state(state, tui)

Replaces the TUI-only Git status view state.

replace_inline_ask(state, ask)

Replaces an inline ask after a leaf transition.

replace_inline_edit(state, edit)

Replaces an inline edit after a leaf transition.

replace_nav_flash(state, line)

Replaces only the navigation flash.

replace_observatory_data(state, data)

Replaces Observatory data without changing refresh correlation.

replace_tool_prompts(state, queue, declined)

Replaces tool-prompt decisions and pending queue atomically.

replace_yank_flash(state, buf, start_pos, end_pos, range_type)

Replaces only the yank flash.

reset_click_regions(state)

Resets all renderer-authored click regions.

reset_space_leader(state)

Resets the current space-leader window.

retire_buffer(state, buffer_pid)

Retires every exact reference to a dead buffer from the Traditional tab bar.

reveal_whichkey(state, generation)

Reveals only the matching which-key generation.

select_sidebar(state, id)

Selects the active native sidebar id.

show_hover_popup(state, popup)

Shows newly produced hover content, replacing prior content.

show_signature_help(state, signature_help)

Shows newly produced signature-help content.

sidebar_active_id(state)

Returns the active native sidebar id.

sidebars(state)

Returns the focused sidebar aggregate.

space_leader_pending?(state)

Returns whether the space-leader window is pending.

space_leader_timer(state)

Returns the current space-leader timer handle.

suppress_lower_transients(state)

Suppresses hover and signature help below a higher interactive surface.

tab_bar(state)

Returns the tab bar state, or nil.

tab_bar_command_at(state, row, col)

Returns the tab-bar command under a rendered cell.

timeout_git_toast(state, id)

Times out a matching auto-dismiss Git toast.

timeout_notice(state, id)

Applies a matching notice timeout.

tool_prompt_decided?(state, tool_name)

Returns whether a tool was declined or is already queued.

tool_prompts(state)

Returns the focused tool-prompt owner.

transition_modal(state, modal)

Transitions to an exact modal value unconditionally.

update_modal_completion(state, update)

Updates the active completion value.

whichkey(state)

Returns the which-key popup state.

Types

git_status_panel()

@type git_status_panel() :: MingaEditor.GitStatus.Panel.t()

git_status_tui_state()

@type git_status_tui_state() ::
  MingaEditor.Shell.Traditional.Sidebars.git_status_tui_state()

t()

@type t() :: %MingaEditor.Shell.Traditional.State{
  agent_surfaces: MingaEditor.Shell.Traditional.AgentSurfaces.t(),
  bottom_panel: MingaEditor.BottomPanel.t(),
  flashes: MingaEditor.Shell.Traditional.Flashes.t(),
  git_toast: MingaEditor.Shell.Traditional.GitToast.t(),
  hover_popup: MingaEditor.HoverPopup.t() | nil,
  input: MingaEditor.Shell.Traditional.InputState.t(),
  modal: MingaEditor.State.ModalOverlay.t(),
  notice: MingaEditor.Shell.Traditional.Notice.t(),
  sidebars: MingaEditor.Shell.Traditional.Sidebars.t(),
  signature_help: MingaEditor.SignatureHelp.t() | nil,
  tab_bar: MingaEditor.State.TabBar.t() | nil,
  tool_prompts: MingaEditor.Shell.Traditional.ToolPrompts.t(),
  whichkey: MingaEditor.State.WhichKey.t()
}

tab_bar_click_region()

@type tab_bar_click_region() ::
  MingaEditor.Shell.Traditional.ClickRegions.tab_bar_region()

tab_bar_command()

@type tab_bar_command() ::
  MingaEditor.Shell.Traditional.ClickRegions.tab_bar_command()

Functions

acknowledge_notice(state)

@spec acknowledge_notice(t()) :: t()

Acknowledges the current notice.

activate_inline_ask(state, ask)

@spec activate_inline_ask(t(), MingaEditor.State.InlineAsk.t()) :: t()

Activates or replaces an inline ask.

activate_inline_edit(state, edit)

@spec activate_inline_edit(t(), MingaEditor.State.InlineEdit.t()) :: t()

Activates or replaces an inline edit.

advance_nav_flash(state, generation)

@spec advance_nav_flash(t(), non_neg_integer()) :: {:continue | :done | :stale, t()}

Advances only the matching navigation flash generation.

advance_tool_prompt(state)

@spec advance_tool_prompt(t()) :: t()

Advances to the next missing-tool prompt.

advance_yank_flash(state, generation)

@spec advance_yank_flash(t(), non_neg_integer()) :: {:continue | :done | :stale, t()}

Advances only the matching yank flash generation.

agent(state)

@spec agent(t()) :: MingaEditor.State.Agent.t()

Returns the agent presentation cache.

agent_surfaces(state)

@spec agent_surfaces(t()) :: MingaEditor.Shell.Traditional.AgentSurfaces.t()

Returns the focused agent-surface owner.

begin_space_leader(state)

@spec begin_space_leader(t()) ::
  {MingaEditor.Shell.Traditional.SpaceLeader.generation(), t()}

Begins a new space-leader generation.

begin_whichkey(state, node, prefix_keys)

@spec begin_whichkey(t(), Minga.Keymap.Bindings.node_t(), [String.t()]) :: t()

Begins a hidden which-key lifecycle generation.

blur_bottom_panel(state)

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

Blurs the shell-owned bottom panel.

bottom_panel(state)

@spec bottom_panel(t()) :: MingaEditor.BottomPanel.t()

Returns the bottom panel state.

cancel_inline_ask(state, buffer_pid)

@spec cancel_inline_ask(t(), pid() | nil) :: {t(), pid() | nil}

Cancels an inline ask and returns its session pid.

cancel_inline_edit(state, buffer_pid)

@spec cancel_inline_edit(t(), pid() | nil) :: {t(), pid() | nil}

Cancels an inline edit and returns its session pid.

cancel_nav_flash(state)

@spec cancel_nav_flash(t()) :: t()

Cancels only the navigation flash.

cancel_yank_flash(state)

@spec cancel_yank_flash(t()) :: t()

Cancels only the yank flash.

click_regions(state)

@spec click_regions(t()) :: MingaEditor.Shell.Traditional.ClickRegions.t()

Returns the renderer-authored click-region value.

close_git_status_panel(state)

@spec close_git_status_panel(t()) :: t()

Closes the Git status sidebar and its paired TUI state.

close_modal(state)

@spec close_modal(t()) :: t()

Closes a completed modal.

close_observatory(state)

@spec close_observatory(t()) :: t()

Closes the BEAM Observatory sidebar.

complete_observatory_refresh(state, token, data, next_timer)

@spec complete_observatory_refresh(
  t(),
  reference(),
  MingaEditor.Observatory.Data.t(),
  MingaEditor.Shell.Traditional.Observatory.timer()
) :: {:accepted | :stale, t()}

Completes a matching Observatory refresh and installs the next timer.

dismiss_git_toast(state)

@spec dismiss_git_toast(t()) :: t()

Dismisses the current Git toast.

dismiss_git_toast(state, id)

@spec dismiss_git_toast(t(), MingaEditor.Shell.Traditional.GitToast.id()) :: t()

Dismisses a Git toast only when its identity still matches.

dismiss_hover_popup(state)

@spec dismiss_hover_popup(t()) :: t()

Dismisses the hover popup.

dismiss_modal(state)

@spec dismiss_modal(t()) :: t()

Dismisses a canceled modal.

dismiss_notice(state)

@spec dismiss_notice(t()) :: t()

Dismisses the current notice.

dismiss_signature_help(state)

@spec dismiss_signature_help(t()) :: t()

Dismisses signature help through its value owner.

dismiss_stale_modal_completion(state, active_tab_id)

@spec dismiss_stale_modal_completion(t(), MingaEditor.State.Tab.id() | nil) :: t()

Dismisses stale completion using the now-active tab id.

dismiss_whichkey(state)

@spec dismiss_whichkey(t()) :: t()

Dismisses which-key through its value owner.

enqueue_tool_prompt(state, tool_name)

@spec enqueue_tool_prompt(t(), atom()) :: t()

Queues a missing tool once.

expire_observatory_refresh(state, token)

@spec expire_observatory_refresh(t(), reference()) :: {:collect | :stale, t()}

Expires a matching Observatory refresh token.

expire_space_leader(state, generation)

@spec expire_space_leader(t(), MingaEditor.Shell.Traditional.SpaceLeader.generation()) ::
  {:expired | :stale, t()}

Expires only the matching space-leader generation.

git_status_panel(state)

@spec git_status_panel(t()) :: git_status_panel() | nil

Returns the git status panel data, or nil.

git_status_tui_state(state)

@spec git_status_tui_state(t()) :: git_status_tui_state() | nil

Returns the TUI-only git status view state, or nil.

hover_popup(state)

@spec hover_popup(t()) :: MingaEditor.HoverPopup.t() | nil

Returns the hover popup state, or nil when not showing.

inline_asks(state)

@spec inline_asks(t()) :: MingaEditor.State.InlineAsk.store()

Returns the inline ask store.

inline_edits(state)

@spec inline_edits(t()) :: MingaEditor.State.InlineEdit.store()

Returns the inline edit store.

input(state)

@spec input(t()) :: MingaEditor.Shell.Traditional.InputState.t()

Returns Traditional input state.

inspect_observatory(state, inspection)

@spec inspect_observatory(t(), MingaEditor.Observatory.Inspection.t() | nil) :: t()

Shows or dismisses the Observatory process inspection.

install_bottom_panel(state, panel)

@spec install_bottom_panel(t(), MingaEditor.BottomPanel.t()) :: t()

Installs an exact bottom-panel value.

install_click_regions(state, regions)

@spec install_click_regions(t(), MingaEditor.Shell.Traditional.ClickRegions.t()) ::
  t()

Installs one already-correlated click-region value.

install_click_regions(state, modeline, tab_bar)

@spec install_click_regions(
  t(),
  [MingaEditor.Shell.Traditional.Modeline.click_region()],
  [
    MingaEditor.Shell.Traditional.ClickRegions.tab_bar_region()
  ]
) :: t()

Installs both click-region sets from one render.

install_space_leader_timer(state, generation, timer)

@spec install_space_leader_timer(
  t(),
  MingaEditor.Shell.Traditional.SpaceLeader.generation(),
  reference()
) :: t()

Records the current space-leader timer.

install_tab_bar(state, tab_bar)

@spec install_tab_bar(t(), MingaEditor.State.TabBar.t() | nil) :: t()

Installs an exact tab-bar value or clears it with nil.

install_tool_prompt_suppression(state, suppress?)

@spec install_tool_prompt_suppression(t(), boolean()) :: t()

Installs the configured missing-tool prompt suppression policy.

modal(state)

@spec modal(t()) :: MingaEditor.State.ModalOverlay.t()

Returns the active modal overlay value (:none when no modal is open).

modeline_command_at(state, col)

@spec modeline_command_at(t(), non_neg_integer()) :: atom() | nil

Returns the modeline command under a rendered column.

next_signature_help(state)

@spec next_signature_help(t()) :: t()

Cycles to the next signature through its value owner.

next_whichkey_page(state)

@spec next_whichkey_page(t()) :: t()

Moves which-key to the next page.

observatory(state)

@spec observatory(t()) :: MingaEditor.Shell.Traditional.Observatory.t()

Returns the BEAM Observatory lifecycle value.

observatory_visible?(state)

@spec observatory_visible?(t()) :: boolean()

Returns true when the BEAM Observatory sidebar is visible.

open_modal(state, modal)

@spec open_modal(t(), MingaEditor.State.ModalOverlay.active()) :: t()

Opens an exact modal value through the conflict-sticky transition.

open_observatory(state, timer)

@spec open_observatory(t(), MingaEditor.Shell.Traditional.Observatory.timer() | nil) ::
  t()

Opens and selects the BEAM Observatory sidebar.

previous_signature_help(state)

@spec previous_signature_help(t()) :: t()

Cycles to the previous signature through its value owner.

previous_whichkey_page(state)

@spec previous_whichkey_page(t()) :: t()

Moves which-key to the previous page.

progress_whichkey(state, node, prefix_keys)

@spec progress_whichkey(t(), Minga.Keymap.Bindings.node_t(), [String.t()]) :: t()

Advances the which-key leader prefix.

publish_git_toast(state, message, level, action)

@spec publish_git_toast(
  t(),
  String.t(),
  MingaEditor.Shell.Traditional.GitToast.level(),
  MingaEditor.Shell.Traditional.GitToast.action()
) :: t()

Publishes a protocol-independent Git toast.

publish_notice(state, message)

@spec publish_notice(t(), String.t()) :: t()

Applies the notice publish transition.

put_modal_completion_trigger(state, trigger, active_tab_id)

@spec put_modal_completion_trigger(
  t(),
  MingaEditor.CompletionTrigger.t(),
  MingaEditor.State.Tab.id() | nil
) :: t()

Records completion trigger lifecycle with explicit active-tab context.

record_git_toast_timer(state, id, timer)

@spec record_git_toast_timer(
  t(),
  MingaEditor.Shell.Traditional.GitToast.id(),
  reference()
) :: t()

Records a Git-toast timer for the matching identity.

record_nav_flash_timer(state, generation, timer)

@spec record_nav_flash_timer(t(), non_neg_integer(), reference()) :: t()

Records only the matching navigation flash timer.

record_notice_timer(state, id, timer)

@spec record_notice_timer(t(), MingaEditor.Shell.Traditional.Notice.id(), reference()) ::
  t()

Records a notice timer for the matching notice identity.

record_whichkey_timer(state, generation, timer)

@spec record_whichkey_timer(t(), MingaEditor.State.WhichKey.generation(), reference()) ::
  t()

Records a which-key timer for the matching generation.

record_yank_flash_timer(state, generation, timer)

@spec record_yank_flash_timer(t(), non_neg_integer(), reference()) :: t()

Records only the matching yank flash timer.

replace_agent(state, agent)

@spec replace_agent(t(), MingaEditor.State.Agent.t()) :: t()

Replaces the agent presentation cache.

replace_git_status_panel(state, panel)

@spec replace_git_status_panel(t(), git_status_panel() | nil) :: t()

Replaces the Git status panel through the sidebar owner.

replace_git_status_tui_state(state, tui)

@spec replace_git_status_tui_state(t(), git_status_tui_state() | nil) :: t()

Replaces the TUI-only Git status view state.

replace_inline_ask(state, ask)

@spec replace_inline_ask(t(), MingaEditor.State.InlineAsk.t()) :: t()

Replaces an inline ask after a leaf transition.

replace_inline_edit(state, edit)

@spec replace_inline_edit(t(), MingaEditor.State.InlineEdit.t()) :: t()

Replaces an inline edit after a leaf transition.

replace_nav_flash(state, line)

@spec replace_nav_flash(t(), non_neg_integer()) :: t()

Replaces only the navigation flash.

replace_observatory_data(state, data)

@spec replace_observatory_data(t(), MingaEditor.Observatory.Data.t() | nil) :: t()

Replaces Observatory data without changing refresh correlation.

replace_tool_prompts(state, queue, declined)

@spec replace_tool_prompts(t(), [atom()], MapSet.t(atom())) :: t()

Replaces tool-prompt decisions and pending queue atomically.

replace_yank_flash(state, buf, start_pos, end_pos, range_type)

@spec replace_yank_flash(
  t(),
  pid(),
  MingaEditor.Shell.Traditional.YankFlash.position(),
  MingaEditor.Shell.Traditional.YankFlash.position(),
  MingaEditor.Shell.Traditional.YankFlash.range_type()
) :: t()

Replaces only the yank flash.

reset_click_regions(state)

@spec reset_click_regions(t()) :: t()

Resets all renderer-authored click regions.

reset_space_leader(state)

@spec reset_space_leader(t()) :: t()

Resets the current space-leader window.

retire_buffer(state, buffer_pid)

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

Retires every exact reference to a dead buffer from the Traditional tab bar.

reveal_whichkey(state, generation)

@spec reveal_whichkey(t(), MingaEditor.State.WhichKey.generation()) :: t()

Reveals only the matching which-key generation.

select_sidebar(state, id)

@spec select_sidebar(t(), String.t() | nil) :: t()

Selects the active native sidebar id.

show_hover_popup(state, popup)

@spec show_hover_popup(t(), MingaEditor.HoverPopup.t()) :: t()

Shows newly produced hover content, replacing prior content.

show_signature_help(state, signature_help)

@spec show_signature_help(t(), MingaEditor.SignatureHelp.t()) :: t()

Shows newly produced signature-help content.

sidebars(state)

@spec sidebars(t()) :: MingaEditor.Shell.Traditional.Sidebars.t()

Returns the focused sidebar aggregate.

space_leader_pending?(state)

@spec space_leader_pending?(t()) :: boolean()

Returns whether the space-leader window is pending.

space_leader_timer(state)

@spec space_leader_timer(t()) :: reference() | nil

Returns the current space-leader timer handle.

suppress_lower_transients(state)

@spec suppress_lower_transients(t()) :: t()

Suppresses hover and signature help below a higher interactive surface.

tab_bar(state)

@spec tab_bar(t()) :: MingaEditor.State.TabBar.t() | nil

Returns the tab bar state, or nil.

tab_bar_command_at(state, row, col)

@spec tab_bar_command_at(t(), non_neg_integer(), non_neg_integer()) ::
  tab_bar_command() | nil

Returns the tab-bar command under a rendered cell.

timeout_git_toast(state, id)

@spec timeout_git_toast(t(), MingaEditor.Shell.Traditional.GitToast.id()) :: t()

Times out a matching auto-dismiss Git toast.

timeout_notice(state, id)

@spec timeout_notice(t(), MingaEditor.Shell.Traditional.Notice.id()) :: t()

Applies a matching notice timeout.

tool_prompt_decided?(state, tool_name)

@spec tool_prompt_decided?(t(), atom()) :: boolean()

Returns whether a tool was declined or is already queued.

tool_prompts(state)

@spec tool_prompts(t()) :: MingaEditor.Shell.Traditional.ToolPrompts.t()

Returns the focused tool-prompt owner.

transition_modal(state, modal)

@spec transition_modal(t(), MingaEditor.State.ModalOverlay.active()) :: t()

Transitions to an exact modal value unconditionally.

update_modal_completion(state, update)

@spec update_modal_completion(t(), (Minga.Editing.Completion.t() ->
                                Minga.Editing.Completion.t())) ::
  t()

Updates the active completion value.

whichkey(state)

@spec whichkey(t()) :: MingaEditor.State.WhichKey.t()

Returns the which-key popup state.