tree

Documentation

Index

• type BindScope
• type Binding
• type Group
  • func (m Group) Binds() *BindScope
  • func (g *Group) Children() []Node
  • func (m Group) Id() int32
  • func (m Group) Name() string
  • func (g *Group) NewCmd(ctx context.Context, options stream.CmdOptions, size geom.Vec2) (*Pane, error)
  • func (g *Group) NewGroup() *Group
  • func (g *Group) NewPane(ctx context.Context, stream mux.Stream, size geom.Vec2) *Pane
  • func (m Group) SetName(name string)
• type Node
• type NodeID
• type Pane
  • func (p *Pane) App() stream.Stream
  • func (m Pane) Binds() *BindScope
  • func (m Pane) Id() int32
  • func (m Pane) Name() string
  • func (p *Pane) Recorder() *sessions.Recorder
  • func (p *Pane) Resize(size geom.Vec2)
  • func (p *Pane) Screen() mux.Screen
  • func (m Pane) SetName(name string)
  • func (p *Pane) Write(data []byte) (n int, err error)
• type Tree
  • func NewTree() *Tree
  • func (t *Tree) GroupById(id NodeID) (*Group, bool)
  • func (t *Tree) Leaves() []Node
  • func (t *Tree) NodeById(id NodeID) (Node, bool)
  • func (t *Tree) PaneById(id NodeID) (*Pane, bool)
  • func (t *Tree) PathTo(node Node) []Node
  • func (t *Tree) Root() *Group

Types

type BindScope

type BindScope = trie.Trie[Binding]

type Binding

type Binding struct {
	Description string
	Callback    *janet.Function
}

type Group

type Group struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func (Group) Binds

func (m Group) Binds() *BindScope

func (*Group) Children

func (g *Group) Children() []Node

func (Group) Id

func (m Group) Id() int32

func (Group) Name

func (m Group) Name() string

func (*Group) NewCmd

func (g *Group) NewCmd(ctx context.Context, options stream.CmdOptions, size geom.Vec2) (*Pane, error)

func (*Group) NewGroup

func (g *Group) NewGroup() *Group

func (*Group) NewPane

func (g *Group) NewPane(
	ctx context.Context,
	stream mux.Stream,
	size geom.Vec2,
) *Pane

func (Group) SetName

func (m Group) SetName(name string)

type Node

type Node interface {
	Id() NodeID
	Name() string
	SetName(string)
	Binds() *BindScope
}

type NodeID

type NodeID = int32

type Pane

type Pane struct {
	util.Lifetime
	// contains filtered or unexported fields
}

func (*Pane) App

func (p *Pane) App() stream.Stream

func (Pane) Binds

func (m Pane) Binds() *BindScope

func (Pane) Id

func (m Pane) Id() int32

func (Pane) Name

func (m Pane) Name() string

func (*Pane) Recorder

func (p *Pane) Recorder() *sessions.Recorder

func (*Pane) Resize

func (p *Pane) Resize(size geom.Vec2)

func (*Pane) Screen

func (p *Pane) Screen() mux.Screen

func (Pane) SetName

func (m Pane) SetName(name string)

func (*Pane) Write

func (p *Pane) Write(data []byte) (n int, err error)

type Tree

type Tree struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func NewTree

func NewTree() *Tree

func (*Tree) GroupById

func (t *Tree) GroupById(id NodeID) (*Group, bool)

func (*Tree) Leaves

func (t *Tree) Leaves() []Node

func (*Tree) NodeById

func (t *Tree) NodeById(id NodeID) (Node, bool)

func (*Tree) PaneById

func (t *Tree) PaneById(id NodeID) (*Pane, bool)

func (*Tree) PathTo

func (t *Tree) PathTo(node Node) []Node

Get the path from the root node to the given node.

func (*Tree) Root

func (t *Tree) Root() *Group