gotosl

type CommentedNode struct {
	Node     any // *ast.File, or ast.Expr, ast.Decl, ast.Spec, or ast.Stmt
	Comments []*ast.CommentGroup
}

type Config struct {

	// Output is the output directory for shader code,
	// relative to where gosl is invoked; must not be an empty string.
	Output string `flag:"out" default:"shaders"`

	// Exclude is a comma-separated list of names of functions to exclude from exporting to WGSL.
	Exclude string `default:"Update,Defaults"`

	// Keep keeps temporary converted versions of the source files, for debugging.
	Keep bool

	// Debug enables debugging messages while running.
	Debug bool
}

type File struct {
	Name  string
	Lines [][]byte
}

type Function struct {
	Name    string
	Funcs   map[string]*Function
	Atomics map[string]*Var // variables that have atomic operations in this function
}

type GetGlobalVar struct {
	// global variable
	Var *Var

	// name of temporary variable
	TmpVar string

	// index passed to the Get function
	IdxExpr ast.Expr

	// rw override
	ReadWrite bool
}

type Group struct {
	Name string

	// comment docs about this group
	Doc string

	// Uniform indicates a uniform group; else default is Storage.
	Uniform bool

	Vars []*Var
}

type Kernel struct {
	Name string

	Args string

	// Filename is the name of the kernel shader file, e.g., shaders/Compute.wgsl
	Filename string

	// function code
	FuncCode string

	// Lines is full shader code
	Lines [][]byte

	// ReadWriteVars are variables marked as read-write for current kernel.
	ReadWriteVars map[string]bool
}

type Mode uint

type PrintConfig struct {
	Mode     Mode   // default: 0
	Tabwidth int    // default: 8
	Indent   int    // default: 0 (all code is indented at least by this much)
	GoToSL   *State // gosl:

	ExcludeFunctions map[string]bool
}

type Replace struct {
	From, To []byte
}

type State struct {
	// Config options.
	Config *Config

	// path to shaders/imports directory.
	ImportsDir string

	// name of the package
	Package string

	// GoFiles are all the files with gosl content in current directory.
	GoFiles map[string]*File

	// GoVarsFiles are all the files with gosl:vars content in current directory.
	// These must be processed first!  they are moved from GoFiles to here.
	GoVarsFiles map[string]*File

	// GoImports has all the imported files.
	GoImports map[string]map[string]*File

	// ImportPackages has short package names, to remove from go code
	// so everything lives in same main package.
	ImportPackages map[string]bool

	// Systems has the kernels and variables for each system.
	// There is an initial "Default" system when system is not specified.
	Systems map[string]*System

	// GetFuncs is a map of GetVar, SetVar function names for global vars.
	GetFuncs map[string]*Var

	// SLImportFiles are all the extracted and translated WGSL files in shaders/imports,
	// which are copied into the generated shader kernel files.
	SLImportFiles []*File

	// generated Go GPU gosl.go file contents
	GPUFile File

	// ExcludeMap is the compiled map of functions to exclude in Go -> WGSL translation.
	ExcludeMap map[string]bool

	// GetVarStack is a stack per function definition of GetVar variables
	// that need to be set at the end.
	GetVarStack stack.Stack[map[string]*GetGlobalVar]

	// GetFuncGraph is true if getting the function graph (first pass).
	GetFuncGraph bool

	// CurKernel is the current Kernel for second pass processing.
	CurKernel *Kernel

	// KernelFuncs are the list of functions to include for current kernel.
	KernelFuncs map[string]*Function

	// FuncGraph is the call graph of functions, for dead code elimination
	FuncGraph map[string]*Function
}

type System struct {
	Name string

	// Kernels are the kernels using this compute system.
	Kernels map[string]*Kernel

	// Groups are the variables for this compute system.
	Groups []*Group

	// NTensors is the number of tensor vars.
	NTensors int
}

type Var struct {
	Name string

	// comment docs about this var.
	Doc string

	// Type of variable: either []Type or F32, U32 for tensors
	Type string

	// ReadOnly indicates that this variable is never read back from GPU,
	// specified by the gosl:read-only property in the variable comments.
	// It is important to optimize GPU memory usage to indicate this.
	ReadOnly bool

	// ReadOrWrite indicates that this variable defaults to ReadOnly
	// but is also flagged as read-write in some cases. It is registered
	// as read_write in the gpu ComputeSystem, but processed as ReadOnly
	// by default except for kernels that declare it as read-write.
	ReadOrWrite bool

	// True if a tensor type
	Tensor bool

	// Number of dimensions
	TensorDims int

	// data kind of the tensor
	TensorKind reflect.Kind

	// index of tensor in list of tensor variables, for indexing.
	TensorIndex int
}