notebook

type Caps struct{ Cell, Total int }

type Cell struct {
	// ID identifies the cell for as long as the workbook is open: its
	// output is kept by it. It isn't saved.
	ID     int
	Kind   Kind
	Source string
}

type Kind uint8

type Output struct {
	// NUON is what the pipeline printed, as NUON; nil when it failed or
	// its output wasn't saved.
	NUON []byte
	// Err is nu's message when the run failed, and Detail the rest of
	// what it said (its help line).
	Err, Detail string
	// Note says what was left out.
	Note string
	// Count is the run's number in this session, [3]; 0 for an output
	// read from the file.
	Count int
	// Seq identifies the output among the workbook's, for telling
	// whether what a cell read has changed since.
	Seq int
	// Vars are the values, as NUON, of the variables the cell assigns
	// other than its output, which later cells read by name. A file
	// doesn't keep them: a cell reading one runs its cell first.
	Vars map[string][]byte
	// Took is how long the run took.
	Took time.Duration
	// Source is the cell's source when it ran.
	Source string
	// Reads are the Seqs of the outputs the run read, by name.
	Reads map[string]int
	// Selection is the range the run read as $selection, "Sheet1!A1:C9".
	Selection string
	// Unsaved is set on an output the file didn't keep, being larger
	// than the caps allowed: there's nothing to show until it runs.
	Unsaved bool
}

type Run struct {
	// Command is what nu runs (Source.Command), and Exports the
	// variables it hands back beside the output.
	Command string
	Exports []string
	// Stream is what nu runs to stream the cell (Source.StreamCommand).
	Stream string
	// Tables are the other cells' outputs and variables it reads, by
	// name, as NUON, and Reads the Seqs of the outputs they came from.
	Tables map[string][]byte
	Reads  map[string]int
	// Others are the names it reads that no cell gives: linked files,
	// or nothing nu will say so of.
	Others []string
	// Ranges are the ranges of sheets it reads, and Selection whether it
	// reads $selection.
	Ranges    []SheetRef
	Selection bool
}

type SheetRef struct {
	// Ref is the range as written after $sheet.: "A1:C9", "Sales!A1:C9".
	Ref string
	// Var is the variable it's read as once renamed: __sheet1.
	Var string
}

type Source struct {
	Text string
	// Stmts are its statements, in order.
	Stmts []Stmt
	// Comments are its comments' bytes, # to the end of the line, and
	// Strings its strings', quotes included.
	Comments, Strings [][2]int
	// Ranges are where it reads ranges of sheets, each $sheet.A1:C9
	// whole.
	Ranges [][2]int
	// contains filtered or unexported fields
}

type Stmt struct {
	// From and To are its bytes, without the spaces and comments around.
	From, To int
	// Body is where what it runs starts: after `name =`, or From.
	Body int
	// Name is what `name = pipeline` assigns, or "".
	Name string
	// Local is the variable `let name = ...` or `mut name = ...` binds,
	// which only the cell's later statements read, or "".
	Local string
}