MingaEditor.InlineOverlay.Store (Minga v0.1.0)

Copy Markdown View Source

Shared per-buffer store for inline overlays (ask and edit).

Both variants key their ephemeral overlays by buffer_pid and track an optional session through a leaf-owner query. The lookup/insert/dismiss/session plumbing only touches those facts, so it lives here once and is reused by both MingaEditor.State.InlineAsk and MingaEditor.State.InlineEdit rather than being copied per variant.

Summary

Types

overlay()

An overlay struct carrying :buffer_pid.

session_pid_fun()
store()

A per-buffer overlay store.

Functions

active(store, buffer_pid, module)

Returns the active overlay for a buffer, or nil.

dismiss(store, buffer_pid, session_pid_fun)

Dismisses the overlay for a buffer.

put(store, overlay, module)

Opens or replaces an overlay for its buffer.

session?(store, session_pid, session_pid_fun)

Returns true when the given session pid belongs to an overlay in this store.

Types

overlay()

@type overlay() :: %{
  :__struct__ => module(),
  :buffer_pid => pid(),
  optional(atom()) => term()
}

An overlay struct carrying :buffer_pid.

session_pid_fun()

@type session_pid_fun() :: (overlay() -> pid() | nil)

store()

@type store() :: %{required(pid()) => overlay()}

A per-buffer overlay store.

Functions

active(store, buffer_pid, module)

@spec active(store(), pid() | nil, module()) :: overlay() | nil

Returns the active overlay for a buffer, or nil.

dismiss(store, buffer_pid, session_pid_fun)

@spec dismiss(store(), pid() | nil, session_pid_fun()) :: {store(), pid() | nil}

Dismisses the overlay for a buffer.

Returns {store, session_pid} where session_pid is the dismissed overlay's session pid (or nil when there was no overlay), so callers can stop the session.

put(store, overlay, module)

@spec put(store(), overlay(), module()) :: store()

Opens or replaces an overlay for its buffer.

session?(store, session_pid, session_pid_fun)

@spec session?(store(), pid(), session_pid_fun()) :: boolean()

Returns true when the given session pid belongs to an overlay in this store.