declaration

type Block struct {
	Parameters []types.Type
	// Return makes the block a value-producing control-flow boundary. The
	// final expression must be assignable to this type, and return or Result
	// propagation exits the block rather than the enclosing method.
	Return types.Type
	// Structured keeps the block in typed IR instead of lowering it to a
	// backend callback. Structured blocks may be assigned or returned while
	// preserving return, break, and next in their lexical owner.
	Structured bool
}

type Catalog struct {
	Types                          map[string]*Type
	Modules                        map[string]*Module
	FunctionBlockRules             []FunctionBlockRule
	FunctionArgumentReferenceRules []FunctionArgumentReferenceRule
	// RuntimeTypesByModule names compiler-owned value representations required
	// by generated declarations in a particular application module.
	RuntimeTypesByModule map[string][]types.Type
}

type DeclarationReference struct {
	ModulePath string
	Name       string
}

type FunctionArgumentReferenceRule struct {
	Package  string
	Function string
	Argument int
	Owner    DeclarationReference
	Targets  []DeclarationReference
}

type FunctionBlockRule struct {
	Package             string
	Function            string
	EnclosingSuperclass string
	TypeArgument        int
	ParameterTypeSuffix string
}

type Member struct {
	Name             string
	Kind             MemberKind
	Intrinsic        string
	Parameters       []Parameter
	MinimumArguments int
	MaximumArguments int
	Return           types.Type
	Fails            types.Type
	Variadic         bool
	Class            bool
	TypeParameters   []string
	Provider         string
	Alternatives     []Signature
	Block            *Block
}

type MemberKind string

type Module struct {
	Name            string
	InstanceMembers map[string]Member
}

type Parameter struct {
	Name                 string
	Type                 types.Type
	Keyword              bool
	Optional             bool
	LiteralValues        []string
	LiteralArrays        [][]string
	LiteralArrayElements []string
}

type Signature struct {
	Parameters []Parameter
	Return     types.Type
	Fails      types.Type
	Variadic   bool
}

type Type struct {
	Name           string
	TypeParameters []string
	Superclass     string
	// SourceModule identifies a provider declaration backed by a project
	// source type. Outside that module, ordinary source references still need
	// an explicit import even though provider members remain available after
	// the type flows through another declaration.
	SourceModule    string
	InstanceMembers map[string]Member
	ClassMembers    map[string]Member
}