dispatch

type Continuation ¶

type Continuation struct {
	Key    string
	Desc   string
	Action bindings.Action
	IsLeaf bool
}

Continuation describes possible next keys while in sequence mode.

type Dispatcher ¶

type Dispatcher struct {
	// contains filtered or unexported fields
}

Dispatcher resolves key presses against active scopes and bindings.

func NewDispatcher(availableBindings []bindings.Binding) (*Dispatcher, error)

func (d *Dispatcher) ResetSequence()

func (d *Dispatcher) Resolve(msg tea.KeyMsg, scopes []Scope) ResolveResult

type LeakPolicy ¶ added in v0.10.3

type LeakPolicy int

const (
	LeakAll LeakPolicy = iota
	LeakGlobal
	LeakNone
)

type ResolveResult ¶

type ResolveResult struct {
	Action        bindings.Action
	Scope         bindings.ScopeName
	Args          map[string]any
	Pending       bool
	Consumed      bool
	Continuations []Continuation
}

ResolveResult is the outcome of resolving a key press.

type Resolver ¶

type Resolver struct {
	// contains filtered or unexported fields
}

Resolver wraps a Dispatcher and extends the pipeline to resolve keys all the way to intents and scopes.

func NewResolver(d *Dispatcher) *Resolver

func (r *Resolver) ResetSequence()

func (r *Resolver) ResolveAction(action keybindings.Action, args map[string]any) Result

func (r *Resolver) ResolveBuiltInAction(action keybindings.Action, args map[string]any) Result

func (r *Resolver) ResolveKey(msg tea.KeyMsg, scopes []Scope) Result

type Result ¶

type Result struct {
	Intent        intents.Intent
	Scope         string
	Args          map[string]any
	LuaScript     string
	Pending       bool
	Consumed      bool
	Continuations []Continuation
}

Result is the outcome of full dispatch resolution.

type Scope ¶ added in v0.10.3

type Scope struct {
	Name    keybindings.ScopeName
	Leak    LeakPolicy
	Global  bool
	Handler ScopeHandler
}

Scope represents one routing layer in the intent dispatch chain. Scopes are ordered from innermost (highest priority) to outermost.

func VisibleScopes(scopes []Scope) []Scope

type ScopeHandler ¶ added in v0.10.3

type ScopeHandler interface {
	HandleIntent(intent intents.Intent) (tea.Cmd, bool)
	Update(msg tea.Msg) tea.Cmd
}

type ScopeProvider ¶ added in v0.10.3

type ScopeProvider interface {
	Scopes() []Scope
}