macro

type Action struct {
	Func    string `json:"func,omitempty"`
	Args    []any  `json:"args,omitempty"` // string, int, bool or JSON
	Named   []Arg  `json:"named,omitempty"`
	Comment string `json:"comment,omitempty"`
}

type Arg struct {
	Name  string `json:"name"`
	Value any    `json:"value"`
}

type Env struct {
	Host Host
	// Do runs fn where Host may be used and returns once it has; nil
	// runs it directly. The UI hands calls to its own goroutine here, so
	// the script can run on another.
	Do func(fn func())
	// Print shows a line printed by the script; called inside Do.
	Print func(msg string)
	// MaxSteps bounds the run; 0 means DefaultMaxSteps.
	MaxSteps uint64
}

type Error struct {
	Pos    string // name:line:column, or "" when not at a place in the script
	Msg    string
	Cancel bool // the run was cancelled
	Limit  bool // the run hit its step limit
}

type Host interface {
	// Values returns the computed values of ref, row by row: nil for a
	// blank, float64, string, bool, or an error value's code as a string
	// ("#DIV/0!").
	Values(ref string) ([][]any, error)
	// Formulas returns what was typed in each cell of ref, row by row,
	// when it's a formula, and "" otherwise.
	Formulas(ref string) ([][]string, error)
	// SetInput enters input, as if typed, in every cell of ref.
	SetInput(ref, input string) error
	// SetInputs enters a block of inputs, as if typed, from ref's first
	// cell.
	SetInputs(ref string, rows [][]string) error
	// SetFormula enters formula in ref's first cell and fills it over the
	// rest, adjusting relative references as a copy does.
	SetFormula(ref, formula string) error
	// Clear erases the contents of ref, or of the selection when ref is "".
	Clear(ref string) error
	// NumberFormat is the number format of ref's first cell: its kind
	// ("auto", "number", "currency"...) and decimals.
	NumberFormat(ref string) (kind string, decimals int, err error)
	// SetNumberFormat formats ref; decimals < 0 keeps the kind's default,
	// and pattern is for the "custom" kind.
	SetNumberFormat(ref, kind string, decimals int, pattern string) error

	// Selection is the selected range and the active cell in it.
	Selection() (sel, active string)
	// Select selects ref, switching sheets if it names one, with active
	// as the active cell ("" for ref's first cell).
	Select(ref, active string) error
	// Move moves the active cell by cols and rows and drops the
	// selection.
	Move(cols, rows int) error
	// Extend selects from the active cell to cols and rows away from it;
	// whole is "", "columns" or "rows".
	Extend(cols, rows int, whole string) error
	// Jump moves as Ctrl+arrows, Home, Ctrl+Home or Ctrl+End do (see
	// JumpTargets), extending the selection when extend is set.
	Jump(to string, extend bool) error
	// Enter stores text in the active cell as if typed and accepted, or
	// in every selected cell, references adjusted, when fill is set. With
	// an origin, a formula is taken as typed there and moved to the
	// active cell, relative references following, as in a copy.
	Enter(text string, fill bool, origin string) error
	// PasteText pastes tab-separated text at the active cell, as pasting
	// from another program does.
	PasteText(text string) error

	// Sheets lists the sheet names in tab order.
	Sheets() []string
	// ActiveSheet names the sheet shown.
	ActiveSheet() string
	// ActivateSheet shows the named sheet.
	ActivateSheet(name string) error
	// AddSheet adds a sheet after the one shown and shows it, returning
	// its name; name "" picks the next free one.
	AddSheet(name string) (string, error)
	// MoveSheet moves the sheet shown to position pos, counting from 1.
	MoveSheet(pos int) error

	// Run runs a registered command by id. A command that asks a
	// question (a width, a name, a confirmation) gets answer, which is
	// required then; one that opens a dialog gets the dialog's choices
	// as JSON text, from a dict or list the script gave.
	Run(id string, answer *string) error
	// SetWidth sets the width of the columns cols, e.g. "B" or "B:D".
	SetWidth(cols string, width int) error
	// SetHeight sets the height of the rows rows, e.g. "3" or "3:5", in
	// lines; 0 fits them to their contents.
	SetHeight(rows string, height int) error
	// Fill fills from the selection as dragging the fill handle does: to
	// the range to, or by rows (down, or up when negative) or cols.
	Fill(to string, rows, cols int) error
}

type JSON string

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

type Stats struct {
	Steps uint64 // Starlark computation steps
	Calls int    // calls to the spreadsheet
}