scriggo

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

type BuildOptions struct {

	// AllowGoStmt, when true, allows the use of the go statement.
	AllowGoStmt bool

	// Packages is a package importer that makes native packages available
	// in programs and templates through the import statement.
	Packages native.Importer

	// TreeTransformer is a function that transforms a tree. If it is not nil,
	// it is called before the type checking.
	//
	// Used for templates only.
	TreeTransformer func(tree *ast.Tree) error

	// NoParseShortShowStmt, when true, don't parse the short show statements.
	//
	// Used for templates only.
	NoParseShortShowStmt bool

	// MarkdownConverter converts a Markdown source code to HTML.
	//
	// Used for templates only.
	MarkdownConverter Converter

	// Globals declares constants, types, variables, functions and packages
	// that are accessible from the code in the template.
	//
	// Used for templates only.
	Globals native.Declarations

	// EnableProfiling enables profiling instrumentation in the compiled template.
	// When true, the runtime will collect timing data for function calls,
	// macros, and includes during execution.
	//
	// Used for templates only.
	EnableProfiling bool
}

type CallKind int

type CallNode struct {
	// Call is the call record for this node (nil for the root node).
	Call *CallRecord
	// Children are the child calls.
	Children []*CallNode
}

type CallRecord struct {
	// ID is a unique identifier for this call.
	ID uint64
	// ParentID links to the parent call (0 for root calls).
	ParentID uint64

	// Name is the function or macro name.
	Name string
	// Package is the package path (empty for macros).
	Package string
	// File is the source file path.
	File string
	// Line is the source line number.
	Line int

	// Kind indicates the type of call.
	Kind CallKind

	// StartTime is when the call began.
	StartTime time.Time
	// Duration is how long the call took.
	Duration time.Duration
	// SelfDuration excludes time spent in child calls.
	SelfDuration time.Duration

	// TemplatePath is the template path for include calls.
	TemplatePath string
}

type Converter func(src []byte, out io.Writer) error

type ExitError struct {
	Code int
	Err  error
}

type Files map[string][]byte

type Format int

type FormatFS interface {
	fs.FS
	Format(name string) (Format, error)
}

type FunctionStats struct {
	// Name is the function or macro name.
	Name string
	// Package is the package path (empty for macros).
	Package string
	// CallCount is the number of times this function was called.
	CallCount int
	// TotalTime is the sum of all call durations.
	TotalTime time.Duration
	// SelfTime is the sum of all self durations.
	SelfTime time.Duration
	// MinTime is the minimum call duration.
	MinTime time.Duration
	// MaxTime is the maximum call duration.
	MaxTime time.Duration
}

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

type Position struct {
	Line   int // line starting from 1
	Column int // column in characters starting from 1
	Start  int // index of the first byte
	End    int // index of the last byte
}

type PrintFunc func(interface{})

type Profile struct {
	// StartTime is when execution began.
	StartTime time.Time
	// EndTime is when execution completed.
	EndTime time.Time
	// TotalDuration is the wall-clock execution time.
	TotalDuration time.Duration

	// Calls contains all recorded function/macro calls in order.
	Calls []*CallRecord
	// contains filtered or unexported fields
}

type ProfileStats struct {
	// TotalCalls is the total number of function/macro calls.
	TotalCalls int
	// NativeCalls is the count of native Go function calls.
	NativeCalls int
	// ScriggoCalls is the count of Scriggo function calls.
	ScriggoCalls int
	// MacroCalls is the count of macro invocations.
	MacroCalls int
	// ByFunction maps function key (pkg.name or name for macros) to stats.
	ByFunction map[string]*FunctionStats
}

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

type RunOptions struct {

	// Context is a context that can be read by native functions and methods
	// via the Context method of native.Env. Canceling the context, the
	// execution is terminated and the Run method returns Context.Err().
	Context context.Context

	// Print is called by the print and println builtins to print values.
	// If it is nil, the print and println builtins format their arguments as
	// expected and write the result to standard error.
	Print PrintFunc

	// Profile receives profiling data after execution completes.
	// Only populated if the template was built with EnableProfiling=true.
	// Caller must allocate: &scriggo.Profile{}
	//
	// Note: Native function calls executed as goroutines (via go statement)
	// are not included in the profile since their execution is asynchronous.
	//
	// Used for templates only. Ignored for programs.
	Profile *Profile

	// MaxParallelRenders limits the number of concurrent "go render" operations.
	// If zero or negative, defaults to 2*GOMAXPROCS.
	//
	// Used for templates only. Ignored for programs.
	MaxParallelRenders int
}

type StackFrame struct {
	Function string // Function name
	Path     string // File path
	Line     int    // Line number
}

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