Modulevortex-keymap-0.1.0Haskell2010

Vortex.Keymap.Tree

The keymap as a tree: prefix keys open sub-trees, leaves carry a program of the host's choosing. One structure drives dispatch (one key per step), the Helix-style infobox that lists what a prefix offers, and a help table of every binding.

2 types
5 values

Packagevortex-keymap-0.1.0
Exports7
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTree.hs

datadata KeyNode p

Constructors

KLeaf Text p
KNode Text (Map Key (KeyNode p))

Instances3Functor, Eq, Show

Functor KeyNodeDefined in vortex-keymap-0.1.0 · Vortex.Keymap.Tree
Eq p => Eq (KeyNode p)Defined in vortex-keymap-0.1.0 · Vortex.Keymap.Tree
Show p => Show (KeyNode p)Defined in vortex-keymap-0.1.0 · Vortex.Keymap.Tree

valuenodeName :: KeyNode p -> Text

valuelookupKey :: KeyNode p -> Key -> Maybe (KeyNode p)

valueinfoboxRows :: KeyNode p -> [(Text, Text)]

Rows for the infobox: key name and what it does. Sub-trees are marked with an ellipsis, as Helix does.

valueallLeaves :: KeyNode p -> [([Key], Text, p)]

Every binding reachable from a node, with its full key path.

datadata Step p

What one key does inside the node that is open.

Constructors

Run p
Descend [Key] (KeyNode p)
a prefix: the path so far and its sub-tree
Cancel
Escape where nothing is bound
Unbound [Key]
nothing bound at this path inside a prefix
Ignored
nothing bound at the root

Instances3Functor, Eq, Show

Functor StepDefined in vortex-keymap-0.1.0 · Vortex.Keymap.Tree
Eq p => Eq (Step p)Defined in vortex-keymap-0.1.0 · Vortex.Keymap.Tree
Show p => Show (Step p)Defined in vortex-keymap-0.1.0 · Vortex.Keymap.Tree

valuestep :: KeyNode p -> [Key] -> Key -> Step p

Dispatch one key: the node currently open, the path that opened it (empty at the root), and the key.