MingaEditor.CompletionTrigger (Minga v0.1.0)

Manages LSP completion request lifecycle.

Summary

Types

phase()

Exclusive completion trigger phase tracked in the Editor.

position()

Cursor position captured when completion was triggered.

response_role()

Role assigned to a completion request reference within a batch.

t()

Completion bridge state tracked in the Editor.

tracking_fact()

Request tracking fact returned to the Editor-global LSP owner.

Functions

accept_batch(bridge, batch)

Accepts one identity-checked provider batch into the active session.

begin_resolve(bridge, item, timer)

Starts resolve ownership for the currently selected stable item.

dismiss(bridge)

Dismisses any active completion state and cancels debounce timer ownership.

flush_debounce(bridge, gen)

Called when the debounce timer fires.

generation(completion_trigger)

Returns the latest-wins request generation.

get_typed_since_trigger(buffer_pid, trigger_position)

Returns the text typed since the trigger position (for prefix filtering).

maybe_retrigger(bridge, char, buffer_pid, context)

Continues an active session, refreshing only incomplete providers for identifier input.

maybe_trigger(bridge, char, buffer_pid, context)

Checks whether the given character should trigger completion.

new()

Returns initial completion bridge state.

put_session(bridge, session)

Installs an updated pure session transition.

retrigger_incomplete(bridge, context)

Retriggers only incomplete providers with LSP trigger kind 3.

retriggerable?(completion_trigger)

Returns whether an active session has provider work that must refresh after input.

session(completion_trigger)

Returns the stable completion session, when one is active.

sync_selection(bridge, completion)

Synchronizes session selection after a user navigation transition.

track_resolve(bridge, identity, ref)

Records the request reference for an exact resolve identity.

Types

phase()

@type phase() ::
  :idle
  | {:debounced, reference(), [pid()], pid(), non_neg_integer(), position()}
  | {:pending, position()}

Exclusive completion trigger phase tracked in the Editor.

position()

@type position() :: {non_neg_integer(), non_neg_integer()}

Cursor position captured when completion was triggered.

response_role()

@type response_role() :: :primary | :secondary

Role assigned to a completion request reference within a batch.

t()

@type t() :: %MingaEditor.CompletionTrigger{
  gen: non_neg_integer(),
  phase: phase(),
  session: Minga.Editing.Completion.Session.t() | nil
}

Completion bridge state tracked in the Editor.

tracking_fact()

@type tracking_fact() ::
  {reference(), response_role(), Minga.Editing.Completion.Item.provider_id(),
   pid(), pid(), non_neg_integer(), reference(), non_neg_integer(), position()}

Request tracking fact returned to the Editor-global LSP owner.

Functions

accept_batch(bridge, batch)

@spec accept_batch(t(), Minga.Editing.Completion.ProviderBatch.t()) ::
  {:ok, t()} | :stale

Accepts one identity-checked provider batch into the active session.

begin_resolve(bridge, item, timer)

@spec begin_resolve(t(), Minga.Editing.Completion.Item.t(), reference() | nil) ::
  {:ok, t(), Minga.Editing.Completion.Session.resolve_identity()} | :stale

Starts resolve ownership for the currently selected stable item.

dismiss(bridge)

@spec dismiss(t()) :: t()

Dismisses any active completion state and cancels debounce timer ownership.

flush_debounce(bridge, gen)

@spec flush_debounce(t(), non_neg_integer()) :: {t(), [tracking_fact()]}

Called when the debounce timer fires.

generation(completion_trigger)

@spec generation(t()) :: non_neg_integer()

Returns the latest-wins request generation.

get_typed_since_trigger(buffer_pid, trigger_position)

@spec get_typed_since_trigger(pid() | Minga.Buffer.CursorContext.t(), position()) ::
  String.t()

Returns the text typed since the trigger position (for prefix filtering).

maybe_retrigger(bridge, char, buffer_pid, context)

@spec maybe_retrigger(t(), String.t(), pid(), Minga.Buffer.CursorContext.t()) ::
  {t(), [tracking_fact()]}

Continues an active session, refreshing only incomplete providers for identifier input.

maybe_trigger(bridge, char, buffer_pid, context)

@spec maybe_trigger(t(), String.t(), pid(), Minga.Buffer.CursorContext.t()) ::
  {t(), [tracking_fact()]}

Checks whether the given character should trigger completion.

new()

@spec new() :: t()

Returns initial completion bridge state.

put_session(bridge, session)

@spec put_session(t(), Minga.Editing.Completion.Session.t()) :: t()

Installs an updated pure session transition.

retrigger_incomplete(bridge, context)

@spec retrigger_incomplete(t(), Minga.Buffer.CursorContext.t()) ::
  {t(), [tracking_fact()]}

Retriggers only incomplete providers with LSP trigger kind 3.

retriggerable?(completion_trigger)

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

Returns whether an active session has provider work that must refresh after input.

session(completion_trigger)

@spec session(t()) :: Minga.Editing.Completion.Session.t() | nil

Returns the stable completion session, when one is active.

sync_selection(bridge, completion)

@spec sync_selection(t(), Minga.Editing.Completion.t()) :: t()

Synchronizes session selection after a user navigation transition.

track_resolve(bridge, identity, ref)

@spec track_resolve(
  t(),
  Minga.Editing.Completion.Session.resolve_identity(),
  reference()
) ::
  {:ok, t()} | :stale

Records the request reference for an exact resolve identity.