dukkha

type ConfigResolvingContext interface {
	Context

	ShellManager
	ToolManager
	TaskManager
	RendererManager

	// cache fs
	ToolCacheFS(t Tool) *fshelper.OSFS
	TaskCacheFS(t Task) *fshelper.OSFS
	RendererCacheFS(name string) *fshelper.OSFS
}

type Context interface {
	TaskExecContext

	SetRuntimeOptions(opts RuntimeOptions)
	RunTask(ToolKey, TaskKey) error
}

type Env []*EnvEntry

type EnvEntry struct {
	rs.BaseField `yaml:"-" json:"-"`

	// Name of the entry (in other words, key)
	Name string `yaml:"name"`

	// Value associated to the name
	Value string `yaml:"value"`
}

type EnvValues interface {
	GlobalEnvValues

	SetMatrixFilter(matrix.Filter)
	MatrixFilter() matrix.Filter

	MatrixArch() string
	MatrixKernel() string
	MatrixLibc() string

	AddEnv(override bool, env ...*EnvEntry)
	AddListEnv(env ...string)
}

type ExecSpecGetFunc func(toExec []string, isFilePath bool) (env Env, cmd []string, err error)

type ExecValues interface {
	SetOutputPrefix(s string)
	OutputPrefix() string

	SetTaskColors(prefixColor, outputColor termenv.Color)
	PrefixColor() termenv.Color
	OutputColor() termenv.Color

	CurrentTool() ToolKey
	CurrentTask() TaskKey

	SetTask(k ToolKey, tK TaskKey)

	TranslateANSIStream() bool
	RetainANSIStyle() bool
	ColorOutput() bool
	FailFast() bool
	ClaimWorkers(n int) int

	SetState(s TaskExecState)
	State() TaskExecState
}

type GlobalEnvSet [constant.GlobalEnv_Count]tlang.LazyValueType[string]

type GlobalEnvValues interface {
	WorkDir() string
	CacheDir() string

	GitBranch() string
	GitWorkTreeClean() bool
	GitTag() string
	GitDefaultBranch() string
	GitCommit() string
	GitValues() map[string]tlang.LazyValueType[string]

	HostKernel() string
	HostKernelVersion() string
	HostArch() string
	HostOS() string
	HostOSVersion() string
	HostValues() map[string]tlang.LazyValueType[string]
}

type IfaceFactory struct {
	Factories []*IfaceFactoryImpl
}

type IfaceFactoryFunc func(subMatches []string) interface{}

type IfaceFactoryImpl struct {
	// Name is the raw information about what instance we are creating
	// currently only used in json schema generation
	Name string

	Create IfaceFactoryFunc
	// contains filtered or unexported fields
}

type IfaceTypeKey struct {
	Typ reflect.Type
}

type Renderer interface {
	rs.Field

	// Init the renderer and add itself to the context
	Init(cacheFS *fshelper.OSFS) error

	Alias() string

	RenderYaml(rc RenderingContext, rawData interface{}, attributes []RendererAttribute) (result []byte, err error)
}

type RendererAttribute string

type RendererCreateFunc func(name string) Renderer

type RendererManager interface {
	AllRenderers() map[string]Renderer
	AddRenderer(name string, renderer Renderer)
}

type RenderingContext interface {
	context.Context
	expand.Environ
	rs.InterfaceTypeHandler
	rs.RenderingHandler
	EnvValues

	// FS returns the filesystem with cwd set to DUKKHA_WORKDIR
	FS() *fshelper.OSFS

	// AddValues will merge provided values into existing values
	AddValues(values map[string]any) error

	Env() map[string]tlang.LazyValueType[string]

	Values() map[string]any

	GlobalCacheFS(subdir string) *fshelper.OSFS

	Stdin() io.Reader
	Stdout() io.Writer
	Stderr() io.Writer
	SetStdIO(in io.Reader, out, err io.Writer)
}

type ReplaceEntries map[string]ReplaceEntry

type ReplaceEntry struct {
	Data []byte
	Err  error
}

type Resolvable interface {
	rs.Field

	// DoAfterFieldsResolved is a helper function to ensure no data race
	//
	// The implementation MUST be safe to be used concurrently
	DoAfterFieldsResolved(
		rc RenderingContext,
		depth int,
		resolveEnv bool,
		do func() error,
		tagNames ...string,
	) error
}

type RunTaskOrRunCmd interface{}

type RuntimeOptions struct {
	FailFast            bool
	ColorOutput         bool
	TranslateANSIStream bool
	RetainANSIStyle     bool
	Workers             int
}

type Shell interface {
	rs.Field

	GetExecSpec(toExec []string, isFilePath bool) (env Env, cmd []string, err error)
}

type ShellManager interface {
	AddShell(name string, impl Shell)
}

type ShellUser interface {
	GetShell(name string) (Shell, bool)
	AllShells() map[string]Shell
}

type Task interface {
	Resolvable

	// ToolKind is the tool managing this task (e.g. docker)
	ToolKind() ToolKind

	// ToolName it the name of the tool this task belongs to
	ToolName() ToolName

	// Kind of the task (e.g. build)
	Kind() TaskKind

	// Name of the task (e.g. foo)
	Name() TaskName

	// Key is the composite key of task kind and name
	Key() TaskKey

	// Init this task
	Init(cacheFS *fshelper.OSFS) error

	// GetMatrixSpecs for matrix execution
	//
	// The implementation MUST be thread safe
	GetMatrixSpecs(rc RenderingContext) ([]matrix.Entry, error)

	// GetExecSpecs generate commands using current field values
	//
	// The implementation MUST be thread safe
	GetExecSpecs(rc TaskExecContext, options TaskMatrixExecOptions) ([]TaskExecSpec, error)

	// GetHookExecSpecs generate hook run target
	//
	// The implementation MUST be thread safe
	GetHookExecSpecs(rc TaskExecContext, state TaskExecStage) ([]TaskExecSpec, error)
}

type TaskCreateFunc func(toolName string) Task

type TaskExecContext interface {
	context.Context

	RenderingContext
	ShellUser
	ToolUser
	TaskUser

	DeriveNew() Context
	Cancel()

	// WithCustomParent divert from current context.Context
	// intended to be only used for defered `after` hooks
	WithCustomParent(parent context.Context) TaskExecContext

	ExecValues
}

type TaskExecOptions interface {
	NextMatrixExecOptions() TaskMatrixExecOptions
}

type TaskExecSpec struct {
	// StdoutAsReplace to replace same string in following TaskExecSpecs
	// use output to stdout of this exec
	StdoutAsReplace string

	// ShowStdout when StdoutAsReplace is set
	ShowStdout bool

	FixStdoutValueForReplace func(data []byte) []byte

	// StderrAsReplace to replace same string in following TaskExecSpecs
	// use output to stderr of this exec
	StderrAsReplace string

	// ShowStderr when StderrAsReplace is set
	ShowStderr bool

	FixStderrValueForReplace func(data []byte) []byte

	Chdir string

	// EnvSuggest to provide environment variables when not set by user
	EnvSuggest Env
	// EnvOverride to override existing environment variables
	EnvOverride Env

	Command []string

	AlterExecFunc func(
		replace ReplaceEntries,
		stdin io.Reader, stdout, stderr io.Writer,
	) (RunTaskOrRunCmd, error)

	Stdin io.Reader

	// IgnoreError to ignore error generated after running this spec
	// this option applies to all sub specs (as returned in AlterExecFunc)
	IgnoreError bool

	// UseShell if true, write command to local script cache
	// and execute with the target shell (as referenced by ShellName)
	UseShell bool

	// ShellName to reference a shell to execute command
	// when `UseShell` is true
	//
	// the availability of the shells denpends on `shells` in dukkha config
	// a special shell name is `embedded`, which will use the built-in shell
	// for command evaluation
	ShellName string
}

type TaskExecStage uint8

type TaskExecState int

type TaskKey struct {
	Kind TaskKind
	Name TaskName
}

type TaskKind string

type TaskManager interface {
	AddToolSpecificTasks(kind ToolKind, name ToolName, tasks []Task)
}

type TaskMatrixExecOptions interface {
	ID() int

	Total() int

	Seq() int

	IsLast() bool
}

type TaskName string

type TaskUser interface {
	GetToolSpecificTasks(k ToolKey) ([]Task, bool)
	AllToolSpecificTasks() map[ToolKey][]Task
}

type Tool interface {
	Resolvable

	// Kind of the tool, e.g. golang, docker
	Kind() ToolKind

	// Name of the tool, e.g. my-tool
	Name() ToolName

	// Key
	Key() ToolKey

	// GetCmd get cli command to run this tool
	GetCmd() []string

	GetTask(TaskKey) (Task, bool)

	AllTasks() map[TaskKey]Task

	Init(cacheFS *fshelper.OSFS) error

	AddTasks(tasks []Task) error

	// Run task
	Run(taskCtx TaskExecContext, tsk TaskKey) error
}

type ToolCreateFunc func() Tool

type ToolKey struct {
	Kind ToolKind
	Name ToolName
}

type ToolKind string

type ToolManager interface {
	AddTool(k ToolKey, t Tool)
}

type ToolName string

type ToolUser interface {
	AllTools() map[ToolKey]Tool
	GetTool(k ToolKey) (Tool, bool)
}

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