statement.go

package analysis

import (
	"fmt"
	"maps"
	"strings"

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

type stmtContext struct {
	ctx        *Context
	returns    *[]returnStmt
	returnHint Type
	loopLabels map[string]*loopLabel
	flags      stmtFlags
	collector  *stmtCollector
}

type returnStmt struct {
	expr *Expr
	pos  ranges.Range
}

type loopLabel struct {
	pos  ranges.Range
	used bool
	node ast.Node // 'for', 'while', or 'when'
}

type stmtFlags uint8

const (
	allowReturn   stmtFlags = 1 << iota // Function body
	allowNextStop                       // Allow 'next' and 'stop' (for/while/when)
	finalWhenCase
	unreachableStmt // After an expr/stmt that doesn't return (return/stop/next/crashout)
	braceless       // Body of a braceless 'when' case
	allowForwardDecl
	whenStmt
)

func newStmtContext(ctx *Context, fid FileID, flags stmtFlags) *stmtContext {
	return &stmtContext{
		ctx:        ctx,
		flags:      flags,
		returns:    new([]returnStmt),
		loopLabels: make(map[string]*loopLabel),
		collector:  &stmtCollector{ctx: ctx, fid: fid},
	}
}

func newChildStmtContext(parentSctx *stmtContext,
	childCtx *Context, flags stmtFlags,
) *stmtContext {
	if parentSctx == nil {
		return newStmtContext(childCtx, childCtx.File, flags)
	}
	return &stmtContext{
		ctx:        childCtx,
		returns:    parentSctx.returns,
		loopLabels: maps.Clone(parentSctx.loopLabels),
		flags:      parentSctx.flags | flags,
		collector:  &stmtCollector{ctx: childCtx, fid: childCtx.File},
	}
}

func (sctx *stmtContext) fid() FileID { return sctx.ctx.File }
func (sctx *stmtContext) newChildContext() *Context {
	return NewContext(sctx.ctx, sctx.ctx.File)
}

// Reports an error if the label already exists
//
// Redeclared labels in the same function (not just block/context) defeat the entire
// purpose of labels:
//
//	for i in 1...10 :loop {
//		for j in 'a'...'z' :loop {
//			stop :loop // Which loop?
//		}
//	}
func (sctx *stmtContext) declareLabel(name string, r ranges.Range, node ast.Node) (err *klarerrs.Error) {
	if other, ok := sctx.loopLabels[name]; ok {
		err := klarerrs.Range(klarerrs.ErrRedeclaredLoopLabel, r)
		err.Label = "A loop label named " + quote(name) + " was already defined"
		// If this is the top-level context, don't call it a function
		if sctx.ctx.index > 0 {
			err.SetParam("isFunc", true)
			err.Label += " in this function"
		}
		err.AddDetail("It was already defined here", "", other.pos)
		return err
	}
	sctx.loopLabels[name] = &loopLabel{pos: r, node: node}
	return nil
}

func (c *Checker) checkBlock(stmts []ast.Statement, sctx *stmtContext) {
	defer func(oldFlags stmtFlags) { sctx.flags = oldFlags }(sctx.flags)
	sctx.flags |= allowForwardDecl

	// Declare functions and types first
	var normalStmts []ast.Statement
	for _, stmt := range stmts {
		if canForwardDeclareInFunc(stmt) {
			c.checkStmt(stmt, sctx) // Declare without checking them
		} else {
			normalStmts = append(normalStmts, stmt)
		}
	}
	if len(normalStmts) < len(stmts) {
		// Actually check the declarations. Similar to [Checker.Check]. Variables
		// are checked before these so functions can forward-reference them.
		c.checkDirectCycles(sctx.ctx)
		c.checkContextDecls(sctx.ctx, sctx.collector, sctx)
	}

	var unreachableReported bool
	// Check everything else in the block, including variable declarations.
	for i, stmt := range normalStmts {
		c.checkStmt(stmt, sctx)

		// Ensure there is no code after a return (always unreachable). We will
		// continue typechecking those unreachable statements, but don't report
		// another error. Never reported after TODO calls.
		if sctx.flags&unreachableStmt != 0 && !unreachableReported &&
			i < len(normalStmts)-1 {
			err := klarerrs.Slice(klarerrs.ErrAlwaysUnreachable, normalStmts[i+1:])
			err.SetParam("kind", terminatingStmtKind(stmt))
			if len(normalStmts[i+1:]) == 1 {
				err.Label = "This statement is unreachable"
			} else {
				err.Label = "These statements are unreachable"
			}
			c.fileError(err, sctx.ctx.File)
			unreachableReported = true
			// Remaining statements will still be checked
		}
	}
	// Queue this because lambdas are queued, and their bodies have to
	// be checked first.
	c.queue(func() { c.reportUnusedWarnings(sctx.ctx) }, false)
}

func (c *Checker) reportUnusedWarnings(ctx *Context) {
	for obj := range ctx.Unused {
		if obj.Module != c.Module {
			continue
		}
		warn := klarerrs.Range(klarerrs.WarnUnused, obj.Range).MarkWarning()
		warn.Name = obj.Name
		kind := kindOf(obj.Type)
		// Be more specific if the object is a function parameter
		if vr, ok := obj.Type.(*Variable); ok && vr.VarKind == FuncParamVar {
			kind = "parameter"
		} else if kind == "namespace" {
			kind = "imported module"
		}
		warn.SetParam("kind", kind)
		// TODO: Only recommend deleting or exporting if the value has no side effects
		var exportHint string
		if obj.Context == c.Module.Context {
			// Only recommend exporting if it's a top-level declaration
			exportHint = " export it,"
		}
		warn.Hintf(
			"Delete it,%s or prefix the name with an underscore (e.g. '_%s')",
			exportHint, obj.Name,
		)
		c.fileError(warn, obj.File)
	}
	ctx.setAttribute(unusedReported, true)
}

func canForwardDeclareInFunc(stmt ast.Statement) bool {
	switch stmt.(type) {
	case *ast.FunctionDeclaration, *ast.FuncAliasDeclaration, ast.TypeDeclaration:
		return true
	default:
		return false
	}
}

func terminatingStmtKind(stmt ast.Statement) string {
	switch stmt := stmt.(type) {
	case *ast.ReturnStatement:
		return "a 'return' statement"
	case *ast.StopStatement:
		return "a 'stop' statement"
	case *ast.NextStatement:
		return "a 'next' statement"
	case *ast.ExpressionStatement:
		if sym, ok := stmt.Expression.(*ast.Symbol); ok && sym.Identifier == "crashout" {
			return "a 'crashout()' call"
		}
	}
	return "an expression that crashouts"
}

func (c *Checker) checkStmt(stmt ast.Statement, sctx *stmtContext) {
	if c.debug() {
		c.logger.push(fmt.Sprintf(
			"%T statement at %s:%s",
			stmt, c.Module.ResolveFile(sctx.fid()), stmt.GetRange(),
		))
		defer c.logger.pop()
	}
	defer c.runDelayed(len(c.delayed))

	switch stmt := stmt.(type) {
	case *ast.ExpressionStatement:
		expr := c.checkExpr(stmt.Expression, sctx.newExpr(exprStmt))
		c.validateExprStmt(stmt, expr)
	case *ast.BadExpression:
		panic("checking invalid AST")

	// Declarations
	case ast.TypeDeclaration:
		c.declareType(stmt, sctx.collector, false, nil)
	case *ast.FunctionDeclaration:
		c.declareFunc(stmt, sctx.collector, false, nil)
	case *ast.FuncAliasDeclaration:
		c.declareFuncAlias(stmt, sctx.collector, false, nil)
	case *ast.VariableDeclaration:
		c.declareVars(stmt, sctx.collector, false, nil, sctx)
	case *ast.AssignmentStatement:
		c.checkAssignStmt(stmt, sctx)
	case ast.ModifierDeclaration:
		// TODO: Could a main.klar file reach a public statement at the top-level?
		panic("invalid AST: public declaration must be at top-level")

	// Loops
	case *ast.ForStatement:
		c.checkForStmt(stmt, sctx)
	case *ast.WhileStatement:
		c.checkWhileStmt(stmt, sctx)

	// Control
	case *ast.StopStatement:
		c.checkControlStmt(stmt, stmt.Label, sctx)
	case *ast.NextStatement:
		c.checkControlStmt(stmt, stmt.Label, sctx)
	case *ast.ReturnStatement:
		c.checkReturnStmt(stmt, sctx)
	default:
		panic(fmt.Sprintf("unhandled statement node: %T", stmt))
	}
	// If we're checking a single statement, forward declarations aren't
	// allowed, so we need to typecheck declarations immediately.
	if sctx.flags&allowForwardDecl == 0 && canForwardDeclareInFunc(stmt) {
		c.checkDirectCycles(sctx.ctx) // Only self-cycles are reachable here
		c.checkContextDecls(sctx.ctx, sctx.collector, sctx)
	}
}

func (c *Checker) validateExprStmt(stmt *ast.ExpressionStatement, expr *Expr) {
	sctx, fid := expr.stmtCtx, expr.FileID()
	addHints := func(err *klarerrs.Error) {
		// If we have something like `func x() -> Int { 2 }`, recommend
		// returning it if it's compatible
		if sctx.returnHint != nil && Compatible(expr.Type, sctx.returnHint) {
			hintWithDiff(
				err, "Did you mean to return this value?", klarerrs.AddedString{
					Pos:    stmt.Range.Start,
					String: lexer.Return.String() + " ",
				},
			)
		}
		hintWithDiff(
			err, "If you don't need this value, assign it to '_'",
			klarerrs.AddedString{Pos: stmt.Range.Start, String: "_ ="},
		)
	}
	switch {
	case (sctx.flags & braceless) != 0:
	case !isAllowedAsStmt(stmt.Expression):
		// Unused expression value
		err := klarerrs.Node(klarerrs.ErrUnusedValue, stmt)
		addHints(err)
		c.fileError(err, fid)
	case c.Options.CheckAllResults && expr.Kind() == KindResult:
		// Unchecked result. With CheckAllResults enabled, expressions
		// returning results can't be used as a statement or discarded.
		err := klarerrs.Node(klarerrs.ErrResultMustBeChecked, stmt)
		err.Name = quoteAka(expr.Type)
		c.fileError(err, fid)
	case c.Options.UseAllValues && expr.Kind() != NothingType &&
		expr.Kind() != InvalidType:
		// Expression returns something and isn't used. With the
		// UseAllValues build option enabled, there are no exceptions
		// for when expressions or functions unless they return Nothing.
		if expr.Kind() == KindTask {
			// Task<Nothing> is an exception
			task := As[*Task](expr.Type)
			if task.Result.Kind() == NothingType {
				break
			}
		}
		err := klarerrs.Node(klarerrs.ErrUnusedValue, stmt).
			SetParam("useAllValues", true)
		addHints(err)
		c.fileError(err, fid)
	default:
		return
	}
}

func (c *Checker) checkReturnStmt(stmt *ast.ReturnStatement, sctx *stmtContext) {
	if sctx == nil || sctx.flags&allowReturn == 0 {
		// TODO: hint if func () = when {...}
		err := klarerrs.Node(klarerrs.ErrReturnOutsideFunc, stmt)
		err.Label = "This 'return' statement is outside of a function"
		c.fileError(err, sctx.ctx.File)
	}
	e := sctx.newExpr().withHint(sctx.returnHint)
	var pos ranges.Range
	if stmt.Value == nil {
		e.Type = NothingType
		pos = stmt.Value.GetRange()
	} else {
		c.checkExpr(stmt.Value, e)
		pos = stmt.Value.GetRange()
	}
	sctx.flags |= unreachableStmt
	*sctx.returns = append(*sctx.returns, returnStmt{expr: e, pos: pos})
}

func (c *Checker) inferReturnType(returns []returnStmt) Type {
	if len(returns) == 0 {
		return NothingType
	}
	common := returns[0].expr.Type
	for i := 1; i < len(returns); i++ {
		ret := returns[i]
		prev := common
		if common = CommonType(common, ret.expr.Type); common == nil {
			err := klarerrs.Range(klarerrs.ErrUncommonReturnType, ret.pos)
			// Example: return 1; return;
			if prev.Kind() == NothingType || ret.expr.Kind() == NothingType {
				err.Code = klarerrs.ErrInvalidNothingRet
				err.Label = "A function must consistently return 'Nothing'"
			} else {
				err.Label = "This returned value has type " + quoteAka(ret.expr.Type)
			}
			err.AddHighlight(
				"The previous one returns "+quoteAka(ret.expr.Type), returns[i-1].pos,
			)
			c.fileError(err, ret.expr.FileID())
			common = prev
		}
	}
	return common
}

func (c *Checker) checkWhileStmt(stmt *ast.WhileStatement, sctx *stmtContext) {
	if stmt.Condition != nil {
		cond := c.checkExpr(stmt.Condition, sctx.newExpr())
		if typ := cond.Type; typ.Kind() != BoolType && typ.Kind() != InvalidType {
			gotType := typ.String()
			err := klarerrs.TypeError(
				klarerrs.ErrNonBoolWhileCond, stmt.Condition.GetRange(),
				BoolType.String(), gotType,
			)
			err.Label = "This has type " + quote(gotType)
			c.fileError(err, sctx.ctx.File)
		}
	}
	// Optional loop label
	if lb := stmt.Label; lb != nil {
		if err := sctx.declareLabel(lb.Name, lb.GetRange(), stmt); err != nil {
			c.fileError(err, sctx.ctx.File)
		}
	}
	// Body
	bodySctx := newChildStmtContext(sctx, sctx.newChildContext(), allowNextStop)
	c.recordBlock(stmt.Body, bodySctx)
	c.checkBlock(stmt.Body.Body, bodySctx)
}

func (c *Checker) checkControlStmt(stmt ast.Statement,
	label *ast.Identifier, sctx *stmtContext,
) {
	fid := sctx.ctx.File
	if (sctx.flags & allowNextStop) == 0 {
		c.fileError(klarerrs.Node(klarerrs.ErrMisplacedControlStmt, stmt), fid)
		return
	}
	sctx.flags |= unreachableStmt
	if label != nil {
		labelDef, ok := sctx.loopLabels[label.Name]
		if !ok {
			err := klarerrs.Node(klarerrs.ErrLoopLabelUndefined, label)
			err.Label = "Label :" + label.Name + " doesn't exist"
			if sctx.ctx.index > 0 {
				err.SetParam("isFunc", true)
				err.Label += " in this function"
			}
			c.fileError(err, fid)
			return
			// TODO: More specific error if the label is in an outside function
		}
		labelDef.used = true
	}
}

const MaxLoopVars = 2

func (c *Checker) checkForStmt(stmt *ast.ForStatement, sctx *stmtContext) {
	bodyCtx, _ := c.checkForVars(stmt.Variables, stmt.Iterator, sctx.ctx, sctx.newExpr)
	// Optional loop label
	if lb := stmt.Label; lb != nil {
		if err := sctx.declareLabel(lb.Name, lb.GetRange(), stmt); err != nil {
			c.fileError(err, sctx.ctx.File)
		}
	}
	// Body
	bodySctx := newChildStmtContext(sctx, bodyCtx, allowNextStop)
	c.recordBlock(stmt.Body, bodySctx)
	c.checkBlock(stmt.Body.Body, bodySctx)
}

func (c *Checker) checkForVars(vars []*ast.AssignableTypePair, iter ast.Expression,
	ctx *Context, newExpr func(...exprMode) *Expr,
) (bodyCtx *Context, iterKind Kind) {
	fid := ctx.File
	// For now, we don't actually care how many there actually are. We just need
	// to know whether there are 2 vs 1. We will report errors when there are more
	// than 2 when we declare the vars.
	var numVars int // Can be 0
	if numPairs := len(vars); numPairs > 1 {
		numVars = numPairs
	} else if numPairs > 0 {
		numVars = len(vars[0].Keys) + numPairs - 1
	}
	numVars = min(numVars, MaxLoopVars) // Will always be in range [0, MaxLoopVars]

	iterExpr := c.checkExpr(iter, newExpr())
	iterExpr.Type = c.toTyped(iterExpr.Type, nil, iter, fid)
	varTypes, err := c.isIterable(iterExpr.Type, numVars)
	if err != nil {
		err.Range = iter.GetRange()
		c.fileError(err, fid)
		iterKind = InvalidType
		// The loop variables will still be declared with types [InvalidType]
	}
	// When iterating over Int, only 1 variable is allowed (for i in 2)
	if iterExpr.Type.Kind() == IntType && numVars > 1 {
		err := klarerrs.Slice(klarerrs.ErrMultipleIntIterVars, vars)
		err.AddHighlight("The iterator has type Int", iter.GetRange())
		err.Label = "Multiple loop variables aren't allowed"
		c.fileError(err, fid)
	}
	var i int
	bodyCtx = NewContext(ctx, fid)
outer:
	for _, pair := range vars {
		// Use the user-provided type annotation, if any.
		//
		// TODO: Should we keep allowing users to declare explicit types for
		// loop variables? They are completely known without them, and an error
		// is raised if the annotation is incompatible. Annotations will only
		// be useful for downcasting `for i: Animal in [Cat](...)`
		var explicitType Type = InvalidType
		if pair.Type != nil {
			explicitType = c.parseType(pair.Type, ctx)
			// Check that the the actual loop type is compatible with the annotation.
			// We're doing it this way because an annotation is supposed to be a downcast.
			if i < MaxLoopVars && !Compatible(varTypes[i], explicitType) {
				// TODO: Show a "not compatible" error? What order should this be?
				c.fileError(
					typeMismatch(varTypes[i], explicitType, pair.Type.GetRange()),
					fid,
				)
			}
		}
		for _, key := range pair.Keys {
			if i >= MaxLoopVars {
				// Currently in the language, there will never be more than
				// 2 loop variables. Unless we add custom iterators to the language,
				// however it's unlikely because lists are enough.
				c.fileError(klarerrs.Node(klarerrs.ErrOver2LoopVars, key), fid)
				break outer
			}
			typ := varTypes[i] // Default type from the loop expression
			if explicitType != InvalidType {
				typ = explicitType
			}
			for sym, typ := range c.followDestructure(
				key, typ, ctx.File, iter.GetRange(), true,
			) {
				sym, ok := sym.(*ast.Symbol)
				if !ok {
					continue // Discard
				}
				vr := NewObject(sym.Identifier, fid, sym.GetRange(), c.Module, nil)
				_ = NewVariable(vr, LocalVar, typ)
				c.declare(bodyCtx, vr)
			}
			i++
		}
	}
	return bodyCtx, iterKind
}

func (c *Checker) isIterable(t Type, numVars int) (varTypes []Type, err *klarerrs.Error) {
	if numVars > 2 {
		panic(fmt.Sprintf("isIterable(_, numVars): expected numVars <= 2, got %d", numVars))
	}
	if numVars == 0 {
		// Still check if the type is iterable
		switch t.Kind() {
		case KindList, KindMap, StringType, IntType:
			return []Type{}, nil
		}
		// Fallthrough
	}
	switch t.Kind() {
	case KindList:
		t := Underlying(t).(*List)
		if numVars == 2 {
			return []Type{IntType, t.Elem}, nil
		}
		return []Type{t.Elem}, nil
	case KindMap:
		t := Underlying(t).(*Map)
		if numVars == 2 {
			return []Type{t.Key, t.Value}, nil
		}
		return []Type{t.Key}, nil
	case StringType:
		if numVars == 2 {
			return []Type{IntType, StringType}, nil
		}
		return []Type{StringType}, nil
	case IntType:
		if numVars == 2 {
			return []Type{IntType, InvalidType}, nil // Up to 1 loop variable is allowed
		}
		return []Type{IntType}, nil
	// TODO: Allow unions
	// If `a: String | [Any]` and `for i, v in a`, `(i, v)` is `(Int, String | Any)`

	// Not iterable, but if their underlying types are iterable, show a hint about unwrapping
	case KindResult:
		success := Underlying(t).(*Result).Success
		if varTypes, err = c.isIterable(success, numVars); err != nil {
			break // Underlying type isn't iterable
		}
		err = klarerrs.TypeError(klarerrs.ErrUnwrapRequired, ranges.Range{}, "", t.String())
		err.SetParam("kind", "Result")
		err.SetParam("before", "before it can be iterated over")
		return varTypes, err
	case KindOptional:
		concrete := Underlying(t).(*Optional).Elem
		if varTypes, err = c.isIterable(concrete, numVars); err != nil {
			break // Underlying type isn't iterable
		}
		err = klarerrs.TypeError(klarerrs.ErrUnwrapRequired, ranges.Range{}, "", t.String())
		err.SetParam("kind", "Optional")
		err.SetParam("before", "before it can be iterated over")
		return varTypes, err
	case InvalidType:
		return []Type{InvalidType, InvalidType}[:numVars], nil // Don't show an error
	}
	// Not iterable
	err = klarerrs.TypeError(klarerrs.ErrNotIterable, ranges.Range{}, "", t.String())
	err.Label = "This value isn't iterable"
	return []Type{InvalidType, InvalidType}[:numVars], err
}

// isAllowedAsStmt returns whether the given expression can be used as a statement.
func isAllowedAsStmt(expr ast.Expression) bool {
	switch expr.(type) {
	case *ast.WhenExpression, *ast.CallExpression, *ast.PipelineExpression,
		*ast.ObjectPipeline, *ast.GoExpression, *ast.AwaitExpression:
		return true
	case *ast.BadExpression:
		panic("typechecking invalid AST")
	default:
		return false
	}
}

func (c *Checker) checkAssignStmt(stmt *ast.AssignmentStatement, sctx *stmtContext) {
	var singleRHS *Expr
	var singleRHSNode ast.Expression
	if stmt.IsSingleRHS() {
		singleRHS = c.checkExpr(stmt.Values[0], sctx.newExpr())
		singleRHSNode = stmt.Values[0]
	}
	uc := stmt.Operator.Uncompound()
	for i, dest := range stmt.Assignee {
		rhs, rhsNode := singleRHS, singleRHSNode
		if singleRHS == nil {
			var hint Type
			if _, ok := dest.(*ast.Symbol); ok {
				// TODO: Don't check dest twice
				hint = c.checkExpr(dest, sctx.newExpr()).Type
			}
			rhs = c.checkExpr(stmt.Values[i], sctx.newExpr().withHint(hint))
			rhsNode = stmt.Values[i]
		}
		for dest, typ := range c.followDestructure(
			dest, rhs.Type, sctx.ctx.File, rhsNode.GetRange(), false,
		) {
			if _, ok := dest.(*ast.Discard); ok {
				continue // All operators and RHS types are allowed with discards
			}
			lhs := c.checkExpr(dest, sctx.newExpr())
			if typ.Kind() == InvalidType || lhs.Kind() == InvalidType {
				continue
			}
			c.checkAssignment(lhs.Type, typ, dest, rhsNode, uc, sctx.ctx.File)
		}
	}
}

func (c *Checker) checkAssignment(
	lhs, rhs Type, lhsNode, rhsNode ast.Expression,
	uc ast.Operator, fid FileID,
) {
	switch lhs := lhs.(type) {
	case *Constant:
		// Can't assign to a const
		err := klarerrs.Node(klarerrs.ErrAssignToConst, lhsNode)
		// TODO: Name and range of declaration
		c.fileError(err, fid)
		return
	case *Function, *Overload, *FunctionAlias:
		// Functions are readonly
	case *EnumRef:
	case *Variable:
		switch lhs.VarKind {
		case StructFieldVar:
			// TODO: Ensure it isn't readonly
		}
		// TODO: Other kinds
	}
	// String multiplication (`String * Int`) will be checked by checkBinaryOperation
	isStringMult := uc.Kind == lexer.Asterisk && lhs.Kind() == StringType
	if !Compatible(rhs, lhs) && !isStringMult {
		err := typeMismatch(lhs, rhs, rhsNode.GetRange())
		err.AddHighlight(
			"The assignee has type "+quote(lhs.String()),
			lhsNode.GetRange(),
		)
		err.Label = strings.Replace(err.Label, "This", "This value", 1)
		c.fileError(err, fid)
		return
	}
	// For compound assign operators (like '+='), check if `LHS + RHS` is supported
	if uc.Kind != lexer.Equal {
		c.checkBinaryOperation(
			uc, lhs, rhs,
			lhsNode, rhsNode, nil, fid,
		)
	}
}