cy

README

cy

Package cy contains cy's server and Janet API.

Documentation

Index

• Constants
• Variables
• func FindConfig() string
• func FindDataDir() string
• type Client
  • func (c *Client) Attach(node tree.Node) error
  • func (c *Client) Binds() (binds []api.Binding)
  • func (c *Client) Detach()
  • func (c *Client) Frame() *frames.Framer
  • func (c *Client) Get(key string) (value interface{}, ok bool)
  • func (c *Client) GetLayout() layout.Layout
  • func (c *Client) HistoryBackward() error
  • func (c *Client) HistoryForward() error
  • func (c *Client) Kill()
  • func (c *Client) Node() tree.Node
  • func (c *Client) OuterLayers() *screen.Layers
  • func (c *Client) Params() *params.Parameters
  • func (c *Client) Read(p []byte) (n int, err error)
  • func (c *Client) Resize(size geom.Vec2) error
  • func (c *Client) SetLayout(l layout.Layout) error
  • func (c *Client) Toast(toast toasts.Toast)
  • func (c *Client) Write(data []byte) (n int, err error)
• type ClientID
• type ClientOptions
• type Cy
  • func NewTestServer() (*Cy, func(geom.Size) (*Client, error), error)
  • func Start(ctx context.Context, options Options) (*Cy, error)
  • func (c *Cy) ExecuteJanet(path string) error
  • func (c *Cy) Log(level zerolog.Level, message string)
  • func (c *Cy) NewClient(ctx context.Context, options ClientOptions) (*Client, error)
  • func (c *Cy) Shutdown() error
• type CyModule
  • func (c *CyModule) Detach(user interface{})
  • func (i *CyModule) Documentation() string
  • func (c *CyModule) KillServer()
  • func (c *CyModule) Paste(user interface{})
  • func (c *CyModule) ReloadConfig() error
• type Environment
  • func (e Environment) Default(key string, defaultValue string) string
  • func (e Environment) Get(key string) (string, bool)
  • func (e Environment) IsSet(key string) bool
• type Options
• type ToastLogger
  • func NewToastLogger(send func(toasts.Toast)) *ToastLogger
  • func (t *ToastLogger) Error(msg string)
  • func (t *ToastLogger) Info(msg string)
  • func (t *ToastLogger) Send(toast toasts.Toast)
  • func (t *ToastLogger) Warn(msg string)

Constants

const (
	REPLAY_PROMPT = "\033Pcy\033\\\033[0;31m▸▸cy▹\033[0m \033[0;31m\033[0m\033[00m"
)

Variables

var CY_BOOT embed.FS

var DOCS_CY string

Functions

func FindConfig

func FindConfig() string

func FindDataDir

func FindDataDir() string

Types

type Client

type Client struct {
	deadlock.RWMutex
	util.Lifetime
	// contains filtered or unexported fields
}

func (*Client) Attach

func (c *Client) Attach(node tree.Node) error

Attach attaches to the given node and (as distinct from attach()) adds an entry to the client's node history.

func (*Client) Binds

func (c *Client) Binds() (binds []api.Binding)

func (*Client) Detach

func (c *Client) Detach()

func (*Client) Frame

func (c *Client) Frame() *frames.Framer

func (*Client) Get

func (c *Client) Get(key string) (value interface{}, ok bool)

func (*Client) GetLayout

func (c *Client) GetLayout() layout.Layout

func (*Client) HistoryBackward

func (c *Client) HistoryBackward() error

HistoryForward moves backward in the client's node history and attaches to the node they were attached to before the current one.

func (*Client) HistoryForward

func (c *Client) HistoryForward() error

HistoryForward moves forward in the client's node history. This has no effect if they are already at the latest entry.

func (*Client) Kill

func (c *Client) Kill()

func (*Client) Node

func (c *Client) Node() tree.Node

func (*Client) OuterLayers

func (c *Client) OuterLayers() *screen.Layers

func (*Client) Params

func (c *Client) Params() *params.Parameters

func (*Client) Read

func (c *Client) Read(p []byte) (n int, err error)

func (*Client) Resize

func (c *Client) Resize(size geom.Vec2) error

func (*Client) SetLayout

func (c *Client) SetLayout(l layout.Layout) error

SetLayout sets the layout in the client's LayoutEngine to the one provided. If the tree node the client is attached to in the layout exists, SetLayout also updates the client's bindings and params to point to that node. If it does not exist, the client uses the bindings and parameters of the root node.

func (*Client) Toast

func (c *Client) Toast(toast toasts.Toast)

func (*Client) Write

func (c *Client) Write(data []byte) (n int, err error)

type ClientID

type ClientID = int32

type ClientOptions

type ClientOptions = P.HandshakeMessage

type Cy

type Cy struct {
	util.Lifetime
	deadlock.RWMutex
	*janet.VM
	// contains filtered or unexported fields
}

func NewTestServer

func NewTestServer() (*Cy, func(geom.Size) (*Client, error), error)

func Start

func Start(ctx context.Context, options Options) (*Cy, error)

func (*Cy) ExecuteJanet

func (c *Cy) ExecuteJanet(path string) error

func (*Cy) Log

func (c *Cy) Log(level zerolog.Level, message string)

func (*Cy) NewClient

func (c *Cy) NewClient(ctx context.Context, options ClientOptions) (*Client, error)

func (*Cy) Shutdown

func (c *Cy) Shutdown() error

type CyModule

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

func (*CyModule) Detach

func (c *CyModule) Detach(user interface{})

func (*CyModule) Documentation

func (i *CyModule) Documentation() string

func (*CyModule) KillServer

func (c *CyModule) KillServer()

func (*CyModule) Paste

func (c *CyModule) Paste(user interface{})

func (*CyModule) ReloadConfig

func (c *CyModule) ReloadConfig() error

type Environment

type Environment map[string]string

func (Environment) Default

func (e Environment) Default(key string, defaultValue string) string

func (Environment) Get

func (e Environment) Get(key string) (string, bool)

func (Environment) IsSet

func (e Environment) IsSet(key string) bool

type Options

type Options struct {
	// The initial Janet script, typically ~/.cyrc.janet.
	Config string
	// The default directory in which to store data (e.g. recorded
	// sessions).
	DataDir string
	// The default shell
	Shell string
	// Whether to show the splash screen on client join
	HideSplash bool
	// Whether to skip blocking (input/*) API calls. Just for testing.
	SkipInput bool
}

type ToastLogger

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

func NewToastLogger

func NewToastLogger(send func(toasts.Toast)) *ToastLogger

func (*ToastLogger) Error

func (t *ToastLogger) Error(msg string)

func (*ToastLogger) Info

func (t *ToastLogger) Info(msg string)

func (*ToastLogger) Send

func (t *ToastLogger) Send(toast toasts.Toast)

func (*ToastLogger) Warn

func (t *ToastLogger) Warn(msg string)