ast

type As struct {
	Mixin
	Text string `parser:"@'as'"`
}

type Backtick struct {
	Mixin
	Text string `parser:"@(RawString | RawStringEnd)"`
}

type BasicLit struct {
	Mixin
	Decimal    *int          `parser:"( @Decimal"`
	Numeric    *NumericLit   `parser:"| @Numeric"`
	Bool       *bool         `parser:"| @Bool"`
	Str        *StringLit    `parser:"| @@"`
	RawString  *RawStringLit `parser:"| @@"`
	Heredoc    *Heredoc      `parser:"| @@"`
	RawHeredoc *RawHeredoc   `parser:"| @@ )"`
}

type Bind struct {
	Mixin
	Field  *Field
	Source *Ident `parser:"@@"`
	Target *Ident `parser:"@@"`
}

type BindClause struct {
	Mixin
	Closure *FuncDecl
	Effects *FieldList
	As      *As       `parser:"@@"`
	Ident   *Ident    `parser:"( @@"`
	Binds   *BindList `parser:"| @@ )?"`
}

type BindList struct {
	Mixin
	Start     *OpenParen  `parser:"@@"`
	Stmts     []*BindStmt `parser:"@@*"`
	Terminate *CloseParen `parser:"@@"`
}

type BindStmt struct {
	Mixin
	Bind     *Bind         `parser:"( @@ Delimit?"`
	Newline  *Newline      `parser:"| @@"`
	Comments *CommentGroup `parser:"| @@ )"`
}

type Binding struct {
	Name  *Ident
	Bind  *BindClause
	Field *Field
}

type Binds struct {
	Mixin
	Text string `parser:"@'binds'"`
}

type BlockStmt struct {
	Mixin
	Scope     *Scope
	Type      *Type
	Closure   *FuncDecl
	Start     *OpenBrace  `parser:"@@"`
	List      []*Stmt     `parser:"@@*"`
	Terminate *CloseBrace `parser:"@@"`
}

type BuiltinDecl struct {
	*Module
	Name           string
	Kinds          []Kind
	FuncDeclByKind map[Kind]*FuncDecl
}

type CallExpr struct {
	Mixin
	Sig  []Kind
	Name *IdentExpr `parser:"@@"`
	List *ExprList  `parser:"@@?"`
}

type CallNode interface {
	Node
	Ident() *Ident
	Signature() []Kind
	Arguments() []*Expr
}

type CallStmt struct {
	Mixin
	Doc        *CommentGroup
	Sig        []Kind
	Name       *IdentExpr  `parser:"@@"`
	Args       []*Expr     `parser:"@@*"`
	WithClause *WithClause `parser:"@@?"`
	BindClause *BindClause `parser:"@@?"`
	Terminate  *StmtEnd    `parser:"@@?"`
}

type CloseBrace struct {
	Mixin
	Text string `parser:"@BlockEnd"`
}

type CloseParen struct {
	Mixin
	Text string `parser:"@ParenEnd"`
}

type Comment struct {
	Mixin
	Text string `parser:"@Comment"`
}

type CommentGroup struct {
	Mixin
	List []*Comment `parser:"( @@ )+"`
}

type Decl struct {
	Mixin
	Import   *ImportDecl   `parser:"( @@"`
	Export   *ExportDecl   `parser:"| @@"`
	Func     *FuncDecl     `parser:"| @@"`
	Newline  *Newline      `parser:"| @@"`
	Comments *CommentGroup `parser:"| @@ )"`
}

type DeprecatedImportDecl struct {
	Pos        lexer.Position
	Import     *Import     `parser:"@@"`
	Ident      *Ident      `parser:"@@"`
	ImportFunc *ImportFunc `parser:"( @@"`
	ImportPath *ImportPath `parser:"| @@ )"`
}

type Directory interface {
	Path() string

	Digest() digest.Digest

	Definition() *llb.Definition

	Open(filename string) (io.ReadCloser, error)

	Stat(filename string) (os.FileInfo, error)

	Close() error
}

type EffectsClause struct {
	Mixin
	Binds   *Binds     `parser:"@@"`
	Effects *FieldList `parser:"@@"`
}

type Export struct {
	Mixin
	Text string `parser:"@'export'"`
}

type ExportDecl struct {
	Mixin
	Export *Export `parser:"@@"`
	Name   *Ident  `parser:"@@"`
}

type Expr struct {
	Mixin
	FuncLit  *FuncLit  `parser:"( @@"`
	BasicLit *BasicLit `parser:"| @@"`
	CallExpr *CallExpr `parser:"| @@ )"`
}

type ExprField struct {
	Mixin
	Expr     *Expr         `parser:"( @@ Delimit?"`
	Newline  *Newline      `parser:"| @@"`
	Comments *CommentGroup `parser:"| @@ )"`
}

type ExprList struct {
	Mixin
	Start     *OpenParen   `parser:"@@"`
	Fields    []*ExprField `parser:"@@*"`
	Terminate *CloseParen  `parser:"@@"`
}

type ExprStmt struct {
	Mixin
	Expr      *Expr    `parser:"@@"`
	Terminate *StmtEnd `parser:"@@?"`
}

type Field struct {
	Mixin
	Modifier *Modifier `parser:"@@?"`
	Type     *Type     `parser:"@@"`
	Name     *Ident    `parser:"@@"`
}

type FieldList struct {
	Mixin
	Start     *OpenParen   `parser:"@@"`
	Stmts     []*FieldStmt `parser:"@@*"`
	Terminate *CloseParen  `parser:"@@"`
}

type FieldStmt struct {
	Mixin
	Field    *Field        `parser:"( @@ Delimit?"`
	Newline  *Newline      `parser:"| @@"`
	Comments *CommentGroup `parser:"| @@ )"`
}

type From struct {
	Mixin
	Text string `parser:"@'from'"`
}

type FuncDecl struct {
	Mixin
	Scope *Scope
	Doc   *CommentGroup
	Sig   *FuncSignature `parser:"@@"`
	Body  *BlockStmt     `parser:"@@?"`
}

type FuncLit struct {
	Mixin
	Type *Type      `parser:"@@"`
	Body *BlockStmt `parser:"@@"`
}

type FuncSignature struct {
	Mixin
	Type    *Type          `parser:"@@"`
	Name    *Ident         `parser:"@@"`
	Params  *FieldList     `parser:"@@"`
	Effects *EffectsClause `parser:"@@?"`
}

type Heredoc struct {
	Mixin
	Value     string
	Start     string             `parser:"@Heredoc"`
	Fragments []*HeredocFragment `parser:"@@*"`
	Terminate *HeredocEnd        `parser:"@@"`
}

type HeredocEnd struct {
	Mixin
	Text string `parser:"@(HeredocEnd | RawHeredocEnd)"`
}

type HeredocFragment struct {
	Mixin
	Spaces       *string       `parser:"( @Spaces"`
	Escaped      *string       `parser:"| @Escaped"`
	Interpolated *Interpolated `parser:"| @@"`
	Text         *string       `parser:"| @(Text | RawText) )"`
}

type Ident struct {
	Mixin
	Text string `parser:"@Ident"`
}

type IdentExpr struct {
	Mixin
	Ident     *Ident     `parser:"@@"`
	Reference *Reference `parser:"@@?"`
}

type Import struct {
	Mixin
	Text string `parser:"@'import'"`
}

type ImportDecl struct {
	Mixin
	Import         *Import    `parser:"@@"`
	Name           *Ident     `parser:"@@"`
	DeprecatedPath *StringLit `parser:"( @@"`
	From           *From      `parser:"| @@"`
	Expr           *Expr      `parser:"@@ )"`
}

type ImportFunc struct {
	Pos  lexer.Position
	From *From    `parser:"@@"`
	Func *FuncLit `parser:"@@"`
}

type ImportPath struct {
	Pos  lexer.Position
	Path *StringLit `parser:"@@"`
}

type Interpolated struct {
	Mixin
	Start     *OpenInterpolated `parser:"@@"`
	Expr      *Expr             `parser:"@@?"`
	Terminate *CloseBrace       `parser:"@@"`
}

type Introspector interface {
	// Path returns the full CST path including the current node.
	Path() []Node
}

type Kind string

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

type MatchOpts struct {
	// Filter is called to see if the node should be walked. If nil, then all
	// nodes are walked.
	Filter func(Node) bool

	// AllowDuplicates is enabled to allow duplicate CST structures between
	// arguments in the functions provided.
	//
	// For example, if a function is defined as `func(*FuncDecl, *CallStmt)`
	// sequences like `[*FuncDecl, ..., *CallStmt, ..., *CallStmt]` are not
	// matched by default. Allowing duplicates will match instead.
	AllowDuplicates bool
}

type Mixin struct {
	Pos    lexer.Position
	EndPos lexer.Position
}

type Modifier struct {
	Mixin
	Variadic *Variadic `parser:"@@"`
}

type Module struct {
	Mixin
	Scope     *Scope
	Directory Directory
	URI       string
	Doc       *CommentGroup
	Decls     []*Decl `parser:"@@*"`
}

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

type Newline struct {
	Mixin
	Text string `parser:"@Newline"`
}

type Node interface {
	// Stringer is implemented to unparse a node back into formatted HLB.
	fmt.Stringer

	Unparse(opts ...UnparseOption) string

	// Position returns position of the first character belonging to the node.
	Position() lexer.Position

	// End returns position of the first character immediately after the node.
	End() lexer.Position

	// WithError returns an error decorated with diagnostics for the node.
	WithError(err error, opts ...diagnostic.Option) error

	// Spanf returns an annotation for the node.
	Spanf(t diagnostic.Type, format string, a ...interface{}) diagnostic.Option
}

type NumericLit struct {
	Mixin
	Value int64
	Base  int
}

type ObjKind int

type Object struct {
	Kind     Kind
	Ident    *Ident
	Node     Node
	Data     interface{}
	Exported bool
}

type OpenBrace struct {
	Mixin
	Text string `parser:"@Block"`
}

type OpenInterpolated struct {
	Mixin
	Text string `parser:"@Interpolated"`
}

type OpenParen struct {
	Mixin
	Text string `parser:"@Paren"`
}

type Quote struct {
	Mixin
	Text string `parser:"@(String | StringEnd)"`
}

type RawHeredoc struct {
	Mixin
	Start     string             `parser:"@RawHeredoc"`
	Fragments []*HeredocFragment `parser:"@@*"`
	Terminate *HeredocEnd        `parser:"@@"`
}

type RawStringLit struct {
	Mixin
	Start     *Backtick `parser:"@@"`
	Text      string    `parser:"@RawChar"`
	Terminate *Backtick `parser:"@@"`
}

type Reference struct {
	Mixin
	Dot   string `parser:"@Dot"`
	Ident *Ident `parser:"@@"`
}

type Scope struct {
	Node
	Level   ScopeLevel
	Outer   *Scope
	Objects map[string]*Object
}

type ScopeLevel string

type SearchOption func(*searcher)

type Stmt struct {
	Mixin
	Call     *CallStmt     `parser:"( @@"`
	Expr     *ExprStmt     `parser:"| @@"`
	Newline  *Newline      `parser:"| @@"`
	Comments *CommentGroup `parser:"| @@ )"`
}

type StmtEnd struct {
	Mixin
	Semicolon *string  `parser:"( @';'"`
	Newline   *Newline `parser:"| @@"`
	Comment   *Comment `parser:"| @@ )"`
}

type StopNode interface {
	Node
	Subject() Node
}

type StringFragment struct {
	Mixin
	Escaped      *string       `parser:"( @Escaped"`
	Interpolated *Interpolated `parser:"| @@"`
	Text         *string       `parser:"| @Char )"`
}

type StringLit struct {
	Mixin
	Start     *Quote            `parser:"@@"`
	Fragments []*StringFragment `parser:"@@*"`
	Terminate *Quote            `parser:"@@"`
}

type Type struct {
	Mixin
	Kind Kind `parser:"@Ident"`
}

type UnparseInfo struct {
	Indent    int
	NoNewline bool
	NoStmtEnd bool
}

type UnparseOption func(*UnparseInfo)

type Variadic struct {
	Mixin
	Text string `parser:"@'variadic'"`
}

type Visitor interface {
	// Visit visits the current node.
	Visit(i Introspector, n Node) (w Visitor)
}

type With struct {
	Mixin
	Text string `parser:"@'with'"`
}

type WithClause struct {
	Mixin
	Closure *FuncDecl
	With    *With `parser:"@@"`
	Expr    *Expr `parser:"@@"`
}