schema

type BuiltinKind int

type BuiltinType struct {
	AST  ast.Expr
	Kind BuiltinKind
}

type Decl interface {
	Kind() DeclKind

	DeclaredIn() *pkginfo.File
	// PkgName reports the name if this is a package-level declaration.
	// Otherwise it reports None.
	PkgName() option.Option[string]

	// ASTNode returns the AST node that this declaration represents.
	// It's a *ast.FuncDecl or *ast.TypeSpec.
	ASTNode() ast.Node
	// String returns the shorthand name for this declaration,
	// in the form "pkgname.DeclName".
	String() string
	// TypeParameters are the type parameters on this declaration.
	TypeParameters() []DeclTypeParam
}

type DeclKind int

type DeclTypeParam struct {
	// AST is the AST node that this type param represents.
	// Note that multiple fields may share the same *ast.Field node,
	// in cases with multiple names, like "type Foo[A, B any]".
	AST *ast.Field

	Name string // the identifier given to the type parameter.
}

type FuncDecl struct {
	AST *ast.FuncDecl

	File *pkginfo.File            // the file declaring the type
	Name string                   // the name of the function
	Recv option.Option[*Receiver] // none if not a method
	Type FuncType                 // signature

	// TypeParams are any type parameters on this declaration.
	// (note: instantiated types used within this declaration would not be captured here)
	TypeParams []DeclTypeParam
}

type FuncType struct {
	AST     *ast.FuncType
	Params  []Param
	Results []Param
}

type InterfaceType struct {
	AST *ast.InterfaceType

	// EmbeddedIfaces are the interfaces this interface embeds.
	EmbeddedIfaces []Type

	// TODO change these out for more useful information.
	TypeLists []ast.Expr
	Methods   []*ast.Field
}

type ListType struct {
	AST  *ast.ArrayType
	Len  int // -1 for a slice
	Elem Type
}

type MapType struct {
	AST   *ast.MapType
	Key   Type
	Value Type
}

type NamedType struct {
	AST ast.Expr // *ast.Ident or *ast.SelectorExpr

	// DeclInfo is the declaration info for the declaration
	// this refers to.
	DeclInfo *pkginfo.PkgDeclInfo

	// TypeArgs are the type arguments used to instantiate this named type.
	TypeArgs []Type
	// contains filtered or unexported fields
}

type Param struct {
	AST  *ast.Field
	Name option.Option[string] // parameter name, or None if a type-only parameter.
	Type Type
}

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

type PointerType struct {
	AST  *ast.StarExpr
	Elem Type
}

type Receiver struct {
	AST *ast.FieldList
	// Name is the name of the receiver (e.g. "a" in "func (a *Foo) Bar()").
	// It's None if the receiver is unnamed (e.g. "func (*Foo) Bar()").
	Name option.Option[string]

	// Type is the type of the receiver.
	// It's either a NamedType or a NamedType wrapped in a PointerType.
	Type Type

	// Decl is the underlying type declaration the receiver points to.
	Decl *TypeDecl
}

type StructField struct {
	// AST is the AST node that this field represents.
	// Note that multiple fields may share the same *ast.Field node,
	// in cases with multiple names, like "Foo, Bar int".
	AST *ast.Field

	Name option.Option[string] // field name, or None if anonymous
	Type Type
	Doc  string
	Tag  structtag.Tags
}

type StructType struct {
	AST    *ast.StructType
	Fields []StructField
}

type Type interface {
	Family() TypeFamily
	ASTExpr() ast.Expr
	String() string // Resolve to a string representation of the type.
}

type TypeDecl struct {
	// AST is the AST node that this declaration represents.
	AST *ast.TypeSpec

	Info *pkginfo.PkgDeclInfo // the underlying declaration info
	File *pkginfo.File        // the file declaring the type
	Name string               // name of the type declaration
	Type Type                 // the declaration's underlying type

	// TypeParams are any type parameters on this declaration.
	// (note: instantiated types used within this declaration would not be captured here)
	TypeParams []DeclTypeParam
}

type TypeDeclRef struct {
	Decl     *TypeDecl
	TypeArgs []Type
	Pointers int
}

type TypeFamily int

type TypeParamRefType struct {
	AST *ast.Ident

	Decl  Decl // the declaration this type parameter is defined on
	Index int  // Index into the type parameter slice on the declaration
}