cy

README

cy

Package cy contains cy's server and Janet API.

Documentation

Index

• 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(reason string) error
  • func (c *Client) Frame() *frames.Framer
  • func (c *Client) Get(key string) (value interface{}, ok bool)
  • func (c *Client) Margins() *screen.Margins
  • 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) Write(data []byte) (n int, err error)
• type ClientID
• type ClientOptions
• type Cy
  • func Start(ctx context.Context, options Options) (*Cy, error)
  • func (c *Cy) ExecuteJanet(path string) error
  • 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) Get(user interface{}, key *janet.Value) (interface{}, error)
  • func (c *CyModule) KillServer()
  • func (c *CyModule) Log(level *janet.Value, text string) error
  • func (c *CyModule) Paste(user interface{})
  • func (c *CyModule) ReloadConfig() error
  • func (c *CyModule) Replay(user interface{}, named *janet.Named[ReplayParams])
  • func (c *CyModule) Set(user interface{}, key *janet.Value, value *janet.Value) error
  • func (c *CyModule) Toast(context interface{}, level *janet.Value, message string) 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 ReplayParams
• 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)

Variables

var (
	KEYWORD_INFO  = janet.Keyword("info")
	KEYWORD_WARN  = janet.Keyword("warn")
	KEYWORD_ERROR = janet.Keyword("error")
)

var CY_BOOT_FILE []byte

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

func (*Client) Binds

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

func (*Client) Detach

func (c *Client) Detach(reason string) error

func (*Client) Frame

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

func (*Client) Get

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

func (*Client) Margins

func (c *Client) Margins() *screen.Margins

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) 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 Start

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

func (*Cy) ExecuteJanet

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

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) Get

func (c *CyModule) Get(user interface{}, key *janet.Value) (interface{}, error)

func (*CyModule) KillServer

func (c *CyModule) KillServer()

func (*CyModule) Log

func (c *CyModule) Log(level *janet.Value, text string) error

func (*CyModule) Paste

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

func (*CyModule) ReloadConfig

func (c *CyModule) ReloadConfig() error

func (*CyModule) Replay

func (c *CyModule) Replay(
	user interface{},
	named *janet.Named[ReplayParams],
)

func (*CyModule) Set

func (c *CyModule) Set(user interface{}, key *janet.Value, value *janet.Value) error

func (*CyModule) Toast

func (c *CyModule) Toast(context interface{}, level *janet.Value, message string) 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
}

type ReplayParams

type ReplayParams struct {
	Main     bool
	Copy     bool
	Location *geom.Vec2
}

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)