core

type ArgDef struct {
	Name         string
	Flag         string // CLI flag name; when empty it is derived from Name
	Type         ArgType
	Value        any      // default value; for ArgOption this is the []string of choices
	DefaultIndex int      // for ArgOption: index of the default choice
	Min          *float64 // optional numeric lower bound
	Max          *float64 // optional numeric upper bound
	Integer      bool     // for ArgNumber: the value must be a whole number
	NonEmpty     bool     // for string arguments: the value may not be empty
	MaxLength    *int     // optional cap on the length of a string argument
	ToggleValues []string // modes for ArgToggleString
}

type ArgType string

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

type DishType string

type FlowOperation interface {
	Operation
	RunFlow(state *FlowState) error
}

type FlowState struct {
	// Steps is the recipe being executed. A flow operation may rewrite the
	// arguments of later steps; the slice is a copy made for this execution, so
	// doing so cannot affect the caller's recipe or a later run of it.
	Steps []RecipeOp
	// Progress is the index of the flow operation itself. Setting it moves
	// execution: the next step run is the one after the index left here, so
	// setting it to a step's own index resumes just after that step, and
	// setting it past the end stops the recipe.
	Progress int
	// Dish is the data as it stands. A flow operation that changes the data
	// (Fork, Subsection) replaces it.
	Dish *Dish
	// Args holds the coerced arguments of the step being run, so a flow
	// operation reads its own arguments the way an ordinary one does.
	Args []any
	// NumJumps counts jumps taken so far, shared by every jump in the recipe so
	// that a backwards jump terminates. It lasts for one execution only.
	NumJumps int
	// NumRegisters is how many registers earlier Register steps have claimed,
	// so that a second Register continues the numbering.
	NumRegisters int
	// Registry resolves step names, so a flow operation can run a sub-recipe.
	Registry *Registry
}

type NamedFile struct {
	Name string
	Data []byte
}

type OpMeta struct {
	Name        string
	Module      string
	Description string
	InfoURL     string
	InputType   DishType
	OutputType  DishType
}

type Operation interface {
	Meta() OpMeta
	Args() []ArgDef
	Run(in *Dish, args []any) (*Dish, error)
}

type Recipe []RecipeOp

type RecipeOp struct {
	Op         string `json:"op"`
	Args       []any  `json:"args,omitempty"`
	Disabled   bool   `json:"disabled,omitempty"`
	Breakpoint bool   `json:"breakpoint,omitempty"`
}

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

type ToggleString struct {
	Option string `json:"option"`
	Value  string `json:"string"`
}