object.go

package analysis

import (
	"cmp"
	"fmt"

	"github.com/ProCode-Software/klar/internal/klarerrs"
	"github.com/ProCode-Software/klar/internal/ranges"
)

// Object represents a declared Klar object.
type Object struct {
	Name    string       // Name of the object as declared in its module
	Context *Context     // Context in which the object was declared
	Range   ranges.Range // Position span of the object in the source code
	File    FileID       // File ID the object was declared in. If top level, o.File != o.Context.File
	Public  bool         // Whether the object is exported
	Module  *Module      // Module where the object was declared
	Type    ObjectKind   // Type of the object
	Order   uint32       // Order in which the object was declared in the module/block
	Flags   Flag         // Flags applied to the object
	attrs   *Attributes
	info    *DeclarationInfo
}

// NewObject returns a new [Object] without context information.
func NewObject(
	name string, fid FileID, rang ranges.Range, mod *Module, typ ObjectKind,
) *Object {
	return &Object{Name: name, Module: mod, Range: rang, File: fid, Type: typ}
}

// FileContext returns the context for the file in which the object was declared.
// The return value is not equal to [Object.Context], but is the context where
// imported objects (that the object could depend on) are declared.
func (obj *Object) FileContext() *Context { return obj.Module.fileContext[obj.File] }

// LookupContext returns the context in which imported objects (that the object
// could depend on) are declared. This is the object's file context, unless
// the object is declared in a nested scope (such as a function).
func (obj *Object) LookupContext() *Context {
	fctx := obj.FileContext()
	if obj.Context.File <= 0 {
		return fctx
	}
	return obj.Context
}

// Underlying is equivalent to obj.Type()
func (obj *Object) Underlying() Type { return obj.Type }

// Kind returns the kind of the object. Kind is equivalent to obj.Type().Kind().
func (obj *Object) Kind() Kind { return obj.Type.Kind() }

// String returns a human-readable representation of the object's type.
func (obj *Object) String() string {
	if obj.IsTypeName() {
		return obj.Name
	}
	return obj.Type.String()
}

// ObjectString returns a human-readable representation of the object.
func (obj *Object) ObjectString() string {
	declKind := "object"
	filePath := fmt.Sprintf(" (%s:%s)", obj.FilePath(), obj.Range)
	switch typ := obj.Type.(type) {
	case *Function:
		return typ.StringWithName(obj.Name) + filePath
	case *FunctionAlias:
	case *Variable:
		declKind = "var"
	case *Constant:
		declKind = "const"
	case *TypeName:
		switch inner := typ.Type.(type) {
		case *Struct:
			declKind = "struct"
		case *EnumItem:
			declKind = "enum item"
		case *Enum:
			declKind = "enum"
		case *Interface:
			declKind = "interface"
		case *Tag:
			return "type #" + obj.Name + filePath
		default: // Including type alias
			return fmt.Sprintf("type %s = %s%s", obj.Name, inner.String(), filePath)
		}
		return declKind + obj.Name + filePath
	}
	return fmt.Sprintf("%s %s: %s%s", declKind, obj.Name, obj.Type.String(), filePath)
}

// Path returns the name of the object with the full import path.
func (obj *Object) Path() string {
	return obj.Module.ImportPathString() + "/" + obj.Name
}

// TODO: If the object is top-level, these don't return a file. Find a solution

// FileName returns the base name of the file o was declared in.
func (o *Object) FileName() string { return o.Module.ResolveFile(o.File) }

// FileName returns the full path of the file o was declared in.
func (o *Object) FilePath() string { return o.Module.ResolveFilePath(o.File) }

// FileRange returns a [ranges.FileRange] representing the range of o's declaration
// and the base name of the containing file.
func (o *Object) FileRange() ranges.FileRange {
	return ranges.FileRange{o.Range, o.FileName()}
}

// FilePathRange returns a [ranges.FilePathRange] representing the range of o's
// declaration and the full path of the containing file.
func (o *Object) FilePathRange() ranges.FileRange {
	return ranges.FileRange{o.Range, o.FilePath()}
}

// IsTypeName reports whether o represents a type declaration.
func (o *Object) IsTypeName() bool {
	if o == nil {
		return false
	}
	_, ok := o.Type.(*TypeName)
	return ok
}

// TypeName returns o's Type() as a [*TypeName], or panics if
// o is not a type name.
func (o *Object) TypeName() *TypeName { return o.Type.(*TypeName) }

func (o *Object) Clone(mod *Module, fid FileID, rang ranges.Range) *Object {
	cloned := new(*o)
	cloned.Range = rang
	cloned.File = fid
	if mod != nil {
		cloned.Module = mod
	}
	return cloned
}

type ObjectKind interface {
	Type
	objKind()
	Underlying() Type
}

type InvalidObject struct{}

func (o *InvalidObject) Kind() Kind       { return InvalidType }
func (o *InvalidObject) String() string   { return o.Kind().String() }
func (o *InvalidObject) Underlying() Type { return o.Kind() }
func (o *InvalidObject) objKind()         {}

// Type Kinds
// ============

// Kind represents the kind of an object.
type Kind int

const (
	// Kinds that can be used as standalone [Type]s.
	InvalidType Kind = iota
	IntType
	StringType
	BoolType
	FloatType
	AnyType
	ErrorType
	NothingType
	RegExType

	KindList
	KindMap
	KindResult
	KindFunction
	KindUnion
	KindOptional
	KindTuple
	KindTask

	KindEnum
	KindStruct
	KindInterface
	KindTag
	KindNamespace

	KindGeneric
)

// Kind returns the receiver. It panics if the receiver isn't a primitive.
func (k Kind) Kind() Kind {
	if !k.IsPrimitive() {
		panic(fmt.Sprintf("kind %d is not a primitive", k))
	}
	return k
}

func (k Kind) IsPrimitive() bool {
	switch k {
	case InvalidType, IntType, StringType, BoolType, FloatType,
		AnyType, ErrorType, NothingType, RegExType:
		return true
	default:
		return false
	}
}

// String returns the kind of the type as a human-readable string. If k is a
// primitive, the name of the Klar type is returned.
func (k Kind) String() string {
	return [...]string{
		// Primitives
		IntType:     "Int",
		StringType:  "String",
		BoolType:    "Bool",
		FloatType:   "Float",
		AnyType:     "Any",
		ErrorType:   "Error",
		NothingType: "Nothing",
		RegExType:   "RegEx",

		InvalidType:   "invalid type",
		KindList:      "list",
		KindMap:       "map",
		KindResult:    "Result",
		KindFunction:  "function",
		KindUnion:     "union",
		KindOptional:  "optional",
		KindTuple:     "tuple",
		KindTask:      "Task",
		KindEnum:      "enum",
		KindStruct:    "struct",
		KindInterface: "interface",
		KindTag:       "tag",
		KindNamespace: "module",
		KindGeneric:   "generic",
	}[k]
}

func (k Kind) Index(i string, t *Expr) *klarerrs.Error {
	if !k.IsPrimitive() {
		panic("cannot Index non-primitive type")
	}
	return indexBuiltin(k.String(), i, t)
}

func (k Kind) IndexComputed(i Type, t *Expr) *klarerrs.Error {
	switch {
	case !k.IsPrimitive():
		panic("cannot Index non-primitive type")
	case k != StringType:
		// String is the only primitive that allows computed indexing
		return indexError(klarerrs.ErrInvalidComputedIndex, i, "")
	case i.Kind() != IntType:
		return indexTypeMismatchError(
			klarerrs.ErrNonNumericIndex,
			StringType, i, "Can't index String using type "+i.String(),
		)
	default:
		// TODO: constant analysis (negative index, out of range index)
		t.Type = &Optional{StringType}
		return nil
	}
}

// Types can be indexed via `obj[index]`.
// ComputedIndexer is implemented by the following types:
//   - [Map] when index is type [Map.Key]
//   - [List] when index is [IntType]
//   - [StringType] when index is [IntType]
//   - [Tuple] when index is a constant [IntType]
type ComputedIndexer interface {
	IndexComputed(index Type, t *Expr) *klarerrs.Error
}

// Per the spec
var (
	_ = [...]ComputedIndexer{&Map{}, &List{}, StringType, &Tuple{}}
	_ = [...]Indexer{
		&Map{}, &List{}, &Struct{}, &Enum{}, &Interface{}, &Task{},
		StringType, IntType, FloatType, ErrorType,
	}
)

// The result of a function call that doesn't return. Statements
// following this are unreachable.
type NoReturn struct{ Type }

func (nr *NoReturn) IsTODO() bool    { return nr.Type == nil }
func (u *NoReturn) Underlying() Type { return cmp.Or[Type](u.Type, u /* is a TODO */) }