luau/Analysis/src/TypeChecker2.cpp

1720 lines
58 KiB
C++
Raw Normal View History

2022-09-08 22:44:50 +01:00
// This file is part of the Luau programming language and is licensed under MIT License; see LICENSE.txt for details
2022-06-17 01:54:42 +01:00
#include "Luau/TypeChecker2.h"
#include "Luau/Ast.h"
#include "Luau/AstQuery.h"
#include "Luau/Clone.h"
2022-07-01 00:29:02 +01:00
#include "Luau/Instantiation.h"
2022-10-21 18:33:43 +01:00
#include "Luau/Metamethods.h"
2022-06-17 01:54:42 +01:00
#include "Luau/Normalize.h"
2022-08-18 22:04:33 +01:00
#include "Luau/ToString.h"
2022-07-01 00:29:02 +01:00
#include "Luau/TxnLog.h"
#include "Luau/TypeUtils.h"
2023-01-03 17:33:19 +00:00
#include "Luau/Type.h"
2022-06-24 02:44:07 +01:00
#include "Luau/Unifier.h"
2022-09-08 22:44:50 +01:00
#include "Luau/ToString.h"
#include "Luau/DcrLogger.h"
#include <algorithm>
LUAU_FASTFLAG(DebugLuauLogSolverToJson);
2022-09-29 23:11:54 +01:00
LUAU_FASTFLAG(DebugLuauMagicTypes);
2023-01-03 17:33:19 +00:00
LUAU_FASTFLAG(LuauNegatedClassTypes)
2022-06-17 01:54:42 +01:00
namespace Luau
{
2022-09-29 23:11:54 +01:00
// TypeInfer.h
// TODO move these
2022-10-13 23:59:53 +01:00
using PrintLineProc = void (*)(const std::string&);
2022-09-29 23:11:54 +01:00
extern PrintLineProc luauPrintLine;
2022-08-18 22:04:33 +01:00
/* Push a scope onto the end of a stack for the lifetime of the StackPusher instance.
* TypeChecker2 uses this to maintain knowledge about which scope encloses every
* given AstNode.
*/
struct StackPusher
{
std::vector<NotNull<Scope>>* stack;
NotNull<Scope> scope;
explicit StackPusher(std::vector<NotNull<Scope>>& stack, Scope* scope)
: stack(&stack)
, scope(scope)
{
stack.push_back(NotNull{scope});
}
~StackPusher()
{
if (stack)
{
LUAU_ASSERT(stack->back() == scope);
stack->pop_back();
}
}
StackPusher(const StackPusher&) = delete;
StackPusher&& operator=(const StackPusher&) = delete;
StackPusher(StackPusher&& other)
: stack(std::exchange(other.stack, nullptr))
, scope(other.scope)
{
}
};
2022-10-21 18:33:43 +01:00
static std::optional<std::string> getIdentifierOfBaseVar(AstExpr* node)
{
if (AstExprGlobal* expr = node->as<AstExprGlobal>())
return expr->name.value;
if (AstExprLocal* expr = node->as<AstExprLocal>())
return expr->local->name.value;
if (AstExprIndexExpr* expr = node->as<AstExprIndexExpr>())
return getIdentifierOfBaseVar(expr->expr);
if (AstExprIndexName* expr = node->as<AstExprIndexName>())
return getIdentifierOfBaseVar(expr->expr);
return std::nullopt;
}
2022-08-18 22:04:33 +01:00
struct TypeChecker2
2022-06-17 01:54:42 +01:00
{
2023-01-03 17:33:19 +00:00
NotNull<BuiltinTypes> builtinTypes;
2022-09-08 22:44:50 +01:00
DcrLogger* logger;
InternalErrorReporter ice; // FIXME accept a pointer from Frontend
2022-06-17 01:54:42 +01:00
const SourceModule* sourceModule;
Module* module;
2023-01-03 17:33:19 +00:00
TypeArena testArena;
2022-06-17 01:54:42 +01:00
2022-08-18 22:04:33 +01:00
std::vector<NotNull<Scope>> stack;
2022-12-09 18:07:25 +00:00
UnifierSharedState sharedState{&ice};
2023-01-03 17:33:19 +00:00
Normalizer normalizer{&testArena, builtinTypes, NotNull{&sharedState}};
2022-12-09 18:07:25 +00:00
2023-01-03 17:33:19 +00:00
TypeChecker2(NotNull<BuiltinTypes> builtinTypes, DcrLogger* logger, const SourceModule* sourceModule, Module* module)
: builtinTypes(builtinTypes)
2022-09-08 22:44:50 +01:00
, logger(logger)
, sourceModule(sourceModule)
2022-06-17 01:54:42 +01:00
, module(module)
{
2022-09-08 22:44:50 +01:00
if (FFlag::DebugLuauLogSolverToJson)
LUAU_ASSERT(logger);
2022-06-17 01:54:42 +01:00
}
2022-08-18 22:04:33 +01:00
std::optional<StackPusher> pushStack(AstNode* node)
{
if (Scope** scope = module->astScopes.find(node))
return StackPusher{stack, *scope};
else
return std::nullopt;
}
2022-06-17 01:54:42 +01:00
TypePackId lookupPack(AstExpr* expr)
{
2022-07-01 00:29:02 +01:00
// If a type isn't in the type graph, it probably means that a recursion limit was exceeded.
// We'll just return anyType in these cases. Typechecking against any is very fast and this
// allows us not to think about this very much in the actual typechecking logic.
2022-06-17 01:54:42 +01:00
TypePackId* tp = module->astTypePacks.find(expr);
2022-07-01 00:29:02 +01:00
if (tp)
return follow(*tp);
else
2023-01-03 17:33:19 +00:00
return builtinTypes->anyTypePack;
2022-06-17 01:54:42 +01:00
}
TypeId lookupType(AstExpr* expr)
{
2022-07-01 00:29:02 +01:00
// If a type isn't in the type graph, it probably means that a recursion limit was exceeded.
// We'll just return anyType in these cases. Typechecking against any is very fast and this
// allows us not to think about this very much in the actual typechecking logic.
2022-06-17 01:54:42 +01:00
TypeId* ty = module->astTypes.find(expr);
2022-07-01 00:29:02 +01:00
if (ty)
return follow(*ty);
TypePackId* tp = module->astTypePacks.find(expr);
if (tp)
return flattenPack(*tp);
2023-01-03 17:33:19 +00:00
return builtinTypes->anyType;
2022-06-17 01:54:42 +01:00
}
2022-06-24 02:44:07 +01:00
TypeId lookupAnnotation(AstType* annotation)
{
2022-09-29 23:11:54 +01:00
if (FFlag::DebugLuauMagicTypes)
{
if (auto ref = annotation->as<AstTypeReference>(); ref && ref->name == "_luau_print" && ref->parameters.size > 0)
{
if (auto ann = ref->parameters.data[0].type)
{
TypeId argTy = lookupAnnotation(ref->parameters.data[0].type);
2022-10-13 23:59:53 +01:00
luauPrintLine(format(
"_luau_print (%d, %d): %s\n", annotation->location.begin.line, annotation->location.begin.column, toString(argTy).c_str()));
2022-09-29 23:11:54 +01:00
return follow(argTy);
}
}
}
2022-06-24 02:44:07 +01:00
TypeId* ty = module->astResolvedTypes.find(annotation);
LUAU_ASSERT(ty);
return follow(*ty);
}
2022-08-04 22:27:28 +01:00
TypePackId lookupPackAnnotation(AstTypePack* annotation)
{
TypePackId* tp = module->astResolvedTypePacks.find(annotation);
LUAU_ASSERT(tp);
return follow(*tp);
}
2022-06-24 02:44:07 +01:00
TypePackId reconstructPack(AstArray<AstExpr*> exprs, TypeArena& arena)
{
2022-07-29 04:41:13 +01:00
if (exprs.size == 0)
return arena.addTypePack(TypePack{{}, std::nullopt});
2022-06-24 02:44:07 +01:00
std::vector<TypeId> head;
for (size_t i = 0; i < exprs.size - 1; ++i)
{
head.push_back(lookupType(exprs.data[i]));
}
TypePackId tail = lookupPack(exprs.data[exprs.size - 1]);
return arena.addTypePack(TypePack{head, tail});
}
2022-07-29 04:41:13 +01:00
Scope* findInnermostScope(Location location)
2022-06-24 02:44:07 +01:00
{
2022-07-29 04:41:13 +01:00
Scope* bestScope = module->getModuleScope().get();
Location bestLocation = module->scopes[0].first;
2022-06-24 02:44:07 +01:00
2022-07-29 04:41:13 +01:00
for (size_t i = 0; i < module->scopes.size(); ++i)
2022-06-24 02:44:07 +01:00
{
2022-07-29 04:41:13 +01:00
auto& [scopeBounds, scope] = module->scopes[i];
2022-06-24 02:44:07 +01:00
if (scopeBounds.encloses(location))
{
if (scopeBounds.begin > bestLocation.begin || scopeBounds.end < bestLocation.end)
{
bestScope = scope.get();
bestLocation = scopeBounds;
}
}
2022-07-01 00:29:02 +01:00
else if (scopeBounds.begin > location.end)
2022-06-24 02:44:07 +01:00
{
// TODO: Is this sound? This relies on the fact that scopes are inserted
// into the scope list in the order that they appear in the AST.
break;
}
}
return bestScope;
}
2022-08-18 22:04:33 +01:00
void visit(AstStat* stat)
{
auto pusher = pushStack(stat);
if (0)
2022-09-02 00:00:14 +01:00
{
}
2022-08-18 22:04:33 +01:00
else if (auto s = stat->as<AstStatBlock>())
return visit(s);
else if (auto s = stat->as<AstStatIf>())
return visit(s);
else if (auto s = stat->as<AstStatWhile>())
return visit(s);
else if (auto s = stat->as<AstStatRepeat>())
return visit(s);
else if (auto s = stat->as<AstStatBreak>())
return visit(s);
else if (auto s = stat->as<AstStatContinue>())
return visit(s);
else if (auto s = stat->as<AstStatReturn>())
return visit(s);
else if (auto s = stat->as<AstStatExpr>())
return visit(s);
else if (auto s = stat->as<AstStatLocal>())
return visit(s);
else if (auto s = stat->as<AstStatFor>())
return visit(s);
else if (auto s = stat->as<AstStatForIn>())
return visit(s);
else if (auto s = stat->as<AstStatAssign>())
return visit(s);
else if (auto s = stat->as<AstStatCompoundAssign>())
return visit(s);
else if (auto s = stat->as<AstStatFunction>())
return visit(s);
else if (auto s = stat->as<AstStatLocalFunction>())
return visit(s);
else if (auto s = stat->as<AstStatTypeAlias>())
return visit(s);
else if (auto s = stat->as<AstStatDeclareFunction>())
return visit(s);
else if (auto s = stat->as<AstStatDeclareGlobal>())
return visit(s);
else if (auto s = stat->as<AstStatDeclareClass>())
return visit(s);
else if (auto s = stat->as<AstStatError>())
return visit(s);
else
LUAU_ASSERT(!"TypeChecker2 encountered an unknown node type");
}
void visit(AstStatBlock* block)
{
auto StackPusher = pushStack(block);
for (AstStat* statement : block->body)
visit(statement);
}
void visit(AstStatIf* ifStatement)
{
visit(ifStatement->condition);
visit(ifStatement->thenbody);
if (ifStatement->elsebody)
visit(ifStatement->elsebody);
}
void visit(AstStatWhile* whileStatement)
{
visit(whileStatement->condition);
visit(whileStatement->body);
}
void visit(AstStatRepeat* repeatStatement)
{
visit(repeatStatement->body);
visit(repeatStatement->condition);
}
2022-09-02 00:00:14 +01:00
void visit(AstStatBreak*) {}
2022-08-18 22:04:33 +01:00
2022-09-02 00:00:14 +01:00
void visit(AstStatContinue*) {}
2022-08-18 22:04:33 +01:00
void visit(AstStatReturn* ret)
{
Scope* scope = findInnermostScope(ret->location);
TypePackId expectedRetType = scope->returnType;
2023-01-03 17:33:19 +00:00
TypeArena* arena = &testArena;
2022-12-02 10:46:05 +00:00
TypePackId actualRetType = reconstructPack(ret->list, *arena);
2022-08-18 22:04:33 +01:00
2022-10-07 00:55:58 +01:00
Unifier u{NotNull{&normalizer}, Mode::Strict, stack.back(), ret->location, Covariant};
2022-08-18 22:04:33 +01:00
u.tryUnify(actualRetType, expectedRetType);
const bool ok = u.errors.empty() && u.log.empty();
if (!ok)
{
for (const TypeError& e : u.errors)
reportError(e);
}
for (AstExpr* expr : ret->list)
visit(expr);
}
void visit(AstStatExpr* expr)
{
visit(expr->expr);
}
void visit(AstStatLocal* local)
2022-06-24 02:44:07 +01:00
{
2022-09-29 23:11:54 +01:00
size_t count = std::max(local->values.size, local->vars.size);
for (size_t i = 0; i < count; ++i)
2022-06-24 02:44:07 +01:00
{
2022-09-29 23:11:54 +01:00
AstExpr* value = i < local->values.size ? local->values.data[i] : nullptr;
2022-08-18 22:04:33 +01:00
2022-09-29 23:11:54 +01:00
if (value)
visit(value);
2022-08-18 22:04:33 +01:00
2022-11-04 17:02:37 +00:00
TypeId* maybeValueType = value ? module->astTypes.find(value) : nullptr;
if (i != local->values.size - 1 || maybeValueType)
2022-06-24 02:44:07 +01:00
{
2022-09-29 23:11:54 +01:00
AstLocal* var = i < local->vars.size ? local->vars.data[i] : nullptr;
2022-06-24 02:44:07 +01:00
2022-09-29 23:11:54 +01:00
if (var && var->annotation)
{
2022-11-04 17:02:37 +00:00
TypeId annotationType = lookupAnnotation(var->annotation);
2022-09-29 23:11:54 +01:00
TypeId valueType = value ? lookupType(value) : nullptr;
2022-11-04 17:02:37 +00:00
if (valueType)
{
ErrorVec errors = tryUnify(stack.back(), value->location, valueType, annotationType);
if (!errors.empty())
reportErrors(std::move(errors));
}
2023-01-03 17:33:19 +00:00
visit(var->annotation);
2022-06-24 02:44:07 +01:00
}
}
else
{
2022-09-29 23:11:54 +01:00
LUAU_ASSERT(value);
2022-06-24 02:44:07 +01:00
2022-09-29 23:11:54 +01:00
TypePackId valueTypes = lookupPack(value);
auto it = begin(valueTypes);
for (size_t j = i; j < local->vars.size; ++j)
2022-06-24 02:44:07 +01:00
{
2022-09-29 23:11:54 +01:00
if (it == end(valueTypes))
2022-06-24 02:44:07 +01:00
{
2022-09-29 23:11:54 +01:00
break;
}
AstLocal* var = local->vars.data[i];
if (var->annotation)
{
TypeId varType = lookupAnnotation(var->annotation);
ErrorVec errors = tryUnify(stack.back(), value->location, *it, varType);
if (!errors.empty())
reportErrors(std::move(errors));
2023-01-03 17:33:19 +00:00
visit(var->annotation);
2022-06-24 02:44:07 +01:00
}
2022-09-29 23:11:54 +01:00
++it;
2022-06-24 02:44:07 +01:00
}
}
}
2022-08-18 22:04:33 +01:00
}
void visit(AstStatFor* forStatement)
{
if (forStatement->var->annotation)
visit(forStatement->var->annotation);
visit(forStatement->from);
visit(forStatement->to);
if (forStatement->step)
visit(forStatement->step);
visit(forStatement->body);
}
void visit(AstStatForIn* forInStatement)
{
for (AstLocal* local : forInStatement->vars)
{
if (local->annotation)
visit(local->annotation);
}
for (AstExpr* expr : forInStatement->values)
visit(expr);
2022-06-24 02:44:07 +01:00
2022-08-18 22:04:33 +01:00
visit(forInStatement->body);
2022-09-02 00:00:14 +01:00
// Rule out crazy stuff. Maybe possible if the file is not syntactically valid.
if (!forInStatement->vars.size || !forInStatement->values.size)
return;
NotNull<Scope> scope = stack.back();
2023-01-03 17:33:19 +00:00
TypeArena& arena = testArena;
2022-09-02 00:00:14 +01:00
std::vector<TypeId> variableTypes;
for (AstLocal* var : forInStatement->vars)
{
std::optional<TypeId> ty = scope->lookup(var);
LUAU_ASSERT(ty);
variableTypes.emplace_back(*ty);
}
// ugh. There's nothing in the AST to hang a whole type pack on for the
// set of iteratees, so we have to piece it back together by hand.
std::vector<TypeId> valueTypes;
for (size_t i = 0; i < forInStatement->values.size - 1; ++i)
valueTypes.emplace_back(lookupType(forInStatement->values.data[i]));
TypePackId iteratorTail = lookupPack(forInStatement->values.data[forInStatement->values.size - 1]);
2022-09-15 23:13:58 +01:00
TypePackId iteratorPack = arena.addTypePack(valueTypes, iteratorTail);
2022-09-02 00:00:14 +01:00
// ... and then expand it out to 3 values (if possible)
2023-01-03 17:33:19 +00:00
TypePack iteratorTypes = extendTypePack(arena, builtinTypes, iteratorPack, 3);
2022-12-02 10:46:05 +00:00
if (iteratorTypes.head.empty())
2022-09-02 00:00:14 +01:00
{
reportError(GenericError{"for..in loops require at least one value to iterate over. Got zero"}, getLocation(forInStatement->values));
return;
}
2022-12-02 10:46:05 +00:00
TypeId iteratorTy = follow(iteratorTypes.head[0]);
2022-09-02 00:00:14 +01:00
2022-10-13 23:59:53 +01:00
auto checkFunction = [this, &arena, &scope, &forInStatement, &variableTypes](
2023-01-03 17:33:19 +00:00
const FunctionType* iterFtv, std::vector<TypeId> iterTys, bool isMm) {
2022-09-29 23:11:54 +01:00
if (iterTys.size() < 1 || iterTys.size() > 3)
{
if (isMm)
reportError(GenericError{"__iter metamethod must return (next[, table[, state]])"}, getLocation(forInStatement->values));
else
reportError(GenericError{"for..in loops must be passed (next[, table[, state]])"}, getLocation(forInStatement->values));
2022-09-02 00:00:14 +01:00
2022-09-29 23:11:54 +01:00
return;
}
2022-10-13 23:59:53 +01:00
2022-09-02 00:00:14 +01:00
// It is okay if there aren't enough iterators, but the iteratee must provide enough.
2023-01-03 17:33:19 +00:00
TypePack expectedVariableTypes = extendTypePack(arena, builtinTypes, iterFtv->retTypes, variableTypes.size());
2022-12-02 10:46:05 +00:00
if (expectedVariableTypes.head.size() < variableTypes.size())
2022-09-29 23:11:54 +01:00
{
if (isMm)
2022-10-13 23:59:53 +01:00
reportError(
GenericError{"__iter metamethod's next() function does not return enough values"}, getLocation(forInStatement->values));
2022-09-29 23:11:54 +01:00
else
reportError(GenericError{"next() does not return enough values"}, forInStatement->values.data[0]->location);
}
2022-09-02 00:00:14 +01:00
2022-12-02 10:46:05 +00:00
for (size_t i = 0; i < std::min(expectedVariableTypes.head.size(), variableTypes.size()); ++i)
reportErrors(tryUnify(scope, forInStatement->vars.data[i]->location, variableTypes[i], expectedVariableTypes.head[i]));
2022-10-13 23:59:53 +01:00
2022-09-02 00:00:14 +01:00
// nextFn is going to be invoked with (arrayTy, startIndexTy)
// It will be passed two arguments on every iteration save the
// first.
// It may be invoked with 0 or 1 argument on the first iteration.
// This depends on the types in iterateePack and therefore
// iteratorTypes.
// If iteratorTypes is too short to be a valid call to nextFn, we have to report a count mismatch error.
// If 2 is too short to be a valid call to nextFn, we have to report a count mismatch error.
// If 2 is too long to be a valid call to nextFn, we have to report a count mismatch error.
2022-09-29 23:11:54 +01:00
auto [minCount, maxCount] = getParameterExtents(TxnLog::empty(), iterFtv->argTypes, /*includeHiddenVariadics*/ true);
2022-09-02 00:00:14 +01:00
if (minCount > 2)
2022-09-15 23:13:58 +01:00
reportError(CountMismatch{2, std::nullopt, minCount, CountMismatch::Arg}, forInStatement->vars.data[0]->location);
2022-09-02 00:00:14 +01:00
if (maxCount && *maxCount < 2)
2022-09-15 23:13:58 +01:00
reportError(CountMismatch{2, std::nullopt, *maxCount, CountMismatch::Arg}, forInStatement->vars.data[0]->location);
2022-09-02 00:00:14 +01:00
2023-01-03 17:33:19 +00:00
TypePack flattenedArgTypes = extendTypePack(arena, builtinTypes, iterFtv->argTypes, 2);
2022-09-29 23:11:54 +01:00
size_t firstIterationArgCount = iterTys.empty() ? 0 : iterTys.size() - 1;
2022-12-02 10:46:05 +00:00
size_t actualArgCount = expectedVariableTypes.head.size();
2022-09-02 00:00:14 +01:00
if (firstIterationArgCount < minCount)
2022-09-15 23:13:58 +01:00
reportError(CountMismatch{2, std::nullopt, firstIterationArgCount, CountMismatch::Arg}, forInStatement->vars.data[0]->location);
2022-09-02 00:00:14 +01:00
else if (actualArgCount < minCount)
2022-09-15 23:13:58 +01:00
reportError(CountMismatch{2, std::nullopt, actualArgCount, CountMismatch::Arg}, forInStatement->vars.data[0]->location);
2022-09-02 00:00:14 +01:00
2022-12-02 10:46:05 +00:00
if (iterTys.size() >= 2 && flattenedArgTypes.head.size() > 0)
2022-09-02 00:00:14 +01:00
{
size_t valueIndex = forInStatement->values.size > 1 ? 1 : 0;
2022-12-02 10:46:05 +00:00
reportErrors(tryUnify(scope, forInStatement->values.data[valueIndex]->location, iterTys[1], flattenedArgTypes.head[0]));
2022-09-02 00:00:14 +01:00
}
2022-12-02 10:46:05 +00:00
if (iterTys.size() == 3 && flattenedArgTypes.head.size() > 1)
2022-09-02 00:00:14 +01:00
{
size_t valueIndex = forInStatement->values.size > 2 ? 2 : 0;
2022-12-02 10:46:05 +00:00
reportErrors(tryUnify(scope, forInStatement->values.data[valueIndex]->location, iterTys[2], flattenedArgTypes.head[1]));
2022-09-02 00:00:14 +01:00
}
2022-09-29 23:11:54 +01:00
};
/*
* If the first iterator argument is a function
* * There must be 1 to 3 iterator arguments. Name them (nextTy,
* arrayTy, startIndexTy)
* * The return type of nextTy() must correspond to the variables'
* types and counts. HOWEVER the first iterator will never be nil.
* * The first return value of nextTy must be compatible with
* startIndexTy.
* * The first argument to nextTy() must be compatible with arrayTy if
* present. nil if not.
* * The second argument to nextTy() must be compatible with
* startIndexTy if it is present. Else, it must be compatible with
* nil.
* * nextTy() must be callable with only 2 arguments.
*/
2023-01-03 17:33:19 +00:00
if (const FunctionType* nextFn = get<FunctionType>(iteratorTy))
2022-09-29 23:11:54 +01:00
{
2022-12-02 10:46:05 +00:00
checkFunction(nextFn, iteratorTypes.head, false);
2022-09-02 00:00:14 +01:00
}
2023-01-03 17:33:19 +00:00
else if (const TableType* ttv = get<TableType>(iteratorTy))
2022-09-02 00:00:14 +01:00
{
if ((forInStatement->vars.size == 1 || forInStatement->vars.size == 2) && ttv->indexer)
{
reportErrors(tryUnify(scope, forInStatement->vars.data[0]->location, variableTypes[0], ttv->indexer->indexType));
if (variableTypes.size() == 2)
reportErrors(tryUnify(scope, forInStatement->vars.data[1]->location, variableTypes[1], ttv->indexer->indexResultType));
}
else
reportError(GenericError{"Cannot iterate over a table without indexer"}, forInStatement->values.data[0]->location);
}
2023-01-03 17:33:19 +00:00
else if (get<AnyType>(iteratorTy) || get<ErrorType>(iteratorTy))
2022-09-02 00:00:14 +01:00
{
// nothing
}
2022-10-13 23:59:53 +01:00
else if (std::optional<TypeId> iterMmTy =
2023-01-03 17:33:19 +00:00
findMetatableEntry(builtinTypes, module->errors, iteratorTy, "__iter", forInStatement->values.data[0]->location))
2022-09-29 23:11:54 +01:00
{
Instantiation instantiation{TxnLog::empty(), &arena, TypeLevel{}, scope};
if (std::optional<TypeId> instantiatedIterMmTy = instantiation.substitute(*iterMmTy))
{
2023-01-03 17:33:19 +00:00
if (const FunctionType* iterMmFtv = get<FunctionType>(*instantiatedIterMmTy))
2022-09-29 23:11:54 +01:00
{
TypePackId argPack = arena.addTypePack({iteratorTy});
reportErrors(tryUnify(scope, forInStatement->values.data[0]->location, argPack, iterMmFtv->argTypes));
2023-01-03 17:33:19 +00:00
TypePack mmIteratorTypes = extendTypePack(arena, builtinTypes, iterMmFtv->retTypes, 3);
2022-09-29 23:11:54 +01:00
2022-12-02 10:46:05 +00:00
if (mmIteratorTypes.head.size() == 0)
2022-09-29 23:11:54 +01:00
{
reportError(GenericError{"__iter must return at least one value"}, forInStatement->values.data[0]->location);
return;
}
2022-12-02 10:46:05 +00:00
TypeId nextFn = follow(mmIteratorTypes.head[0]);
2022-09-29 23:11:54 +01:00
if (std::optional<TypeId> instantiatedNextFn = instantiation.substitute(nextFn))
{
2022-12-02 10:46:05 +00:00
std::vector<TypeId> instantiatedIteratorTypes = mmIteratorTypes.head;
2022-09-29 23:11:54 +01:00
instantiatedIteratorTypes[0] = *instantiatedNextFn;
2023-01-03 17:33:19 +00:00
if (const FunctionType* nextFtv = get<FunctionType>(*instantiatedNextFn))
2022-09-29 23:11:54 +01:00
{
checkFunction(nextFtv, instantiatedIteratorTypes, true);
}
else
{
reportError(CannotCallNonFunction{*instantiatedNextFn}, forInStatement->values.data[0]->location);
}
}
else
{
reportError(UnificationTooComplex{}, forInStatement->values.data[0]->location);
}
}
else
{
// TODO: This will not tell the user that this is because the
// metamethod isn't callable. This is not ideal, and we should
// improve this error message.
2022-10-13 23:59:53 +01:00
2022-09-29 23:11:54 +01:00
// TODO: This will also not handle intersections of functions or
// callable tables (which are supported by the runtime).
reportError(CannotCallNonFunction{*iterMmTy}, forInStatement->values.data[0]->location);
}
}
else
{
reportError(UnificationTooComplex{}, forInStatement->values.data[0]->location);
}
}
2022-09-02 00:00:14 +01:00
else
{
reportError(CannotCallNonFunction{iteratorTy}, forInStatement->values.data[0]->location);
}
2022-06-24 02:44:07 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstStatAssign* assign)
2022-06-17 01:54:42 +01:00
{
size_t count = std::min(assign->vars.size, assign->values.size);
for (size_t i = 0; i < count; ++i)
{
AstExpr* lhs = assign->vars.data[i];
2022-08-18 22:04:33 +01:00
visit(lhs);
2022-07-01 00:29:02 +01:00
TypeId lhsType = lookupType(lhs);
2022-06-17 01:54:42 +01:00
AstExpr* rhs = assign->values.data[i];
2022-08-18 22:04:33 +01:00
visit(rhs);
2022-07-01 00:29:02 +01:00
TypeId rhsType = lookupType(rhs);
2022-06-17 01:54:42 +01:00
2022-11-10 22:04:44 +00:00
if (!isSubtype(rhsType, lhsType, stack.back()))
2022-06-17 01:54:42 +01:00
{
2022-07-01 00:29:02 +01:00
reportError(TypeMismatch{lhsType, rhsType}, rhs->location);
2022-06-17 01:54:42 +01:00
}
}
2022-08-18 22:04:33 +01:00
}
2022-06-17 01:54:42 +01:00
2022-08-18 22:04:33 +01:00
void visit(AstStatCompoundAssign* stat)
{
visit(stat->var);
visit(stat->value);
2022-06-17 01:54:42 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstStatFunction* stat)
2022-06-24 02:44:07 +01:00
{
2022-08-18 22:04:33 +01:00
visit(stat->name);
visit(stat->func);
}
2022-06-24 02:44:07 +01:00
2022-08-18 22:04:33 +01:00
void visit(AstStatLocalFunction* stat)
{
visit(stat->func);
}
2022-06-24 02:44:07 +01:00
2022-08-18 22:04:33 +01:00
void visit(const AstTypeList* typeList)
{
for (AstType* ty : typeList->types)
visit(ty);
2022-06-24 02:44:07 +01:00
2022-08-18 22:04:33 +01:00
if (typeList->tailType)
visit(typeList->tailType);
}
2022-06-24 02:44:07 +01:00
2022-08-18 22:04:33 +01:00
void visit(AstStatTypeAlias* stat)
{
for (const AstGenericType& el : stat->generics)
2022-06-24 02:44:07 +01:00
{
2022-08-18 22:04:33 +01:00
if (el.defaultValue)
visit(el.defaultValue);
}
for (const AstGenericTypePack& el : stat->genericPacks)
{
if (el.defaultValue)
visit(el.defaultValue);
}
visit(stat->type);
}
void visit(AstTypeList types)
{
for (AstType* type : types.types)
visit(type);
if (types.tailType)
visit(types.tailType);
}
void visit(AstStatDeclareFunction* stat)
{
visit(stat->params);
visit(stat->retTypes);
}
void visit(AstStatDeclareGlobal* stat)
{
visit(stat->type);
}
void visit(AstStatDeclareClass* stat)
{
for (const AstDeclaredClassProp& prop : stat->props)
visit(prop.ty);
}
void visit(AstStatError* stat)
{
for (AstExpr* expr : stat->expressions)
visit(expr);
for (AstStat* s : stat->statements)
visit(s);
}
void visit(AstExpr* expr)
{
auto StackPusher = pushStack(expr);
if (0)
2022-09-02 00:00:14 +01:00
{
}
2022-08-18 22:04:33 +01:00
else if (auto e = expr->as<AstExprGroup>())
return visit(e);
else if (auto e = expr->as<AstExprConstantNil>())
return visit(e);
else if (auto e = expr->as<AstExprConstantBool>())
return visit(e);
else if (auto e = expr->as<AstExprConstantNumber>())
return visit(e);
else if (auto e = expr->as<AstExprConstantString>())
return visit(e);
else if (auto e = expr->as<AstExprLocal>())
return visit(e);
else if (auto e = expr->as<AstExprGlobal>())
return visit(e);
else if (auto e = expr->as<AstExprVarargs>())
return visit(e);
else if (auto e = expr->as<AstExprCall>())
return visit(e);
else if (auto e = expr->as<AstExprIndexName>())
return visit(e);
else if (auto e = expr->as<AstExprIndexExpr>())
return visit(e);
else if (auto e = expr->as<AstExprFunction>())
return visit(e);
else if (auto e = expr->as<AstExprTable>())
return visit(e);
else if (auto e = expr->as<AstExprUnary>())
return visit(e);
else if (auto e = expr->as<AstExprBinary>())
return visit(e);
else if (auto e = expr->as<AstExprTypeAssertion>())
return visit(e);
else if (auto e = expr->as<AstExprIfElse>())
return visit(e);
else if (auto e = expr->as<AstExprError>())
return visit(e);
else
LUAU_ASSERT(!"TypeChecker2 encountered an unknown expression type");
}
void visit(AstExprGroup* expr)
{
visit(expr->expr);
}
void visit(AstExprConstantNil* expr)
{
// TODO!
}
void visit(AstExprConstantBool* expr)
{
// TODO!
}
void visit(AstExprConstantNumber* number)
{
TypeId actualType = lookupType(number);
2023-01-03 17:33:19 +00:00
TypeId numberType = builtinTypes->numberType;
2022-08-18 22:04:33 +01:00
2022-11-10 22:04:44 +00:00
if (!isSubtype(numberType, actualType, stack.back()))
2022-08-18 22:04:33 +01:00
{
reportError(TypeMismatch{actualType, numberType}, number->location);
}
}
void visit(AstExprConstantString* string)
{
TypeId actualType = lookupType(string);
2023-01-03 17:33:19 +00:00
TypeId stringType = builtinTypes->stringType;
2022-08-18 22:04:33 +01:00
2022-11-10 22:04:44 +00:00
if (!isSubtype(actualType, stringType, stack.back()))
2022-08-18 22:04:33 +01:00
{
reportError(TypeMismatch{actualType, stringType}, string->location);
2022-06-24 02:44:07 +01:00
}
2022-08-18 22:04:33 +01:00
}
void visit(AstExprLocal* expr)
{
// TODO!
}
2022-06-24 02:44:07 +01:00
2022-08-18 22:04:33 +01:00
void visit(AstExprGlobal* expr)
{
// TODO!
}
void visit(AstExprVarargs* expr)
{
// TODO!
2022-06-24 02:44:07 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstExprCall* call)
2022-06-17 01:54:42 +01:00
{
2022-08-18 22:04:33 +01:00
visit(call->func);
for (AstExpr* arg : call->args)
visit(arg);
2023-01-03 17:33:19 +00:00
TypeArena* arena = &testArena;
2022-12-02 10:46:05 +00:00
Instantiation instantiation{TxnLog::empty(), arena, TypeLevel{}, stack.back()};
2022-07-01 00:29:02 +01:00
2022-06-17 01:54:42 +01:00
TypePackId expectedRetType = lookupPack(call);
TypeId functionType = lookupType(call->func);
2022-10-21 18:33:43 +01:00
TypeId testFunctionType = functionType;
TypePack args;
2022-06-17 01:54:42 +01:00
2023-01-03 17:33:19 +00:00
if (get<AnyType>(functionType) || get<ErrorType>(functionType))
2022-09-02 00:00:14 +01:00
return;
2023-01-03 17:33:19 +00:00
else if (std::optional<TypeId> callMm = findMetatableEntry(builtinTypes, module->errors, functionType, "__call", call->func->location))
2022-10-21 18:33:43 +01:00
{
2023-01-03 17:33:19 +00:00
if (get<FunctionType>(follow(*callMm)))
2022-10-21 18:33:43 +01:00
{
if (std::optional<TypeId> instantiatedCallMm = instantiation.substitute(*callMm))
{
args.head.push_back(functionType);
testFunctionType = follow(*instantiatedCallMm);
}
else
{
reportError(UnificationTooComplex{}, call->func->location);
return;
}
}
else
{
// TODO: This doesn't flag the __call metamethod as the problem
// very clearly.
reportError(CannotCallNonFunction{*callMm}, call->func->location);
return;
}
}
2023-01-03 17:33:19 +00:00
else if (get<FunctionType>(functionType))
2022-10-21 18:33:43 +01:00
{
if (std::optional<TypeId> instantiatedFunctionType = instantiation.substitute(functionType))
{
testFunctionType = *instantiatedFunctionType;
}
else
{
reportError(UnificationTooComplex{}, call->func->location);
return;
}
}
2023-01-03 17:33:19 +00:00
else if (auto utv = get<UnionType>(functionType))
2022-12-02 10:46:05 +00:00
{
// Sometimes it's okay to call a union of functions, but only if all of the functions are the same.
std::optional<TypeId> fst;
for (TypeId ty : utv)
{
if (!fst)
fst = follow(ty);
else if (fst != follow(ty))
{
reportError(CannotCallNonFunction{functionType}, call->func->location);
return;
}
}
if (!fst)
2023-01-03 17:33:19 +00:00
ice.ice("UnionType had no elements, so fst is nullopt?");
2022-12-02 10:46:05 +00:00
if (std::optional<TypeId> instantiatedFunctionType = instantiation.substitute(*fst))
{
testFunctionType = *instantiatedFunctionType;
}
else
{
reportError(UnificationTooComplex{}, call->func->location);
return;
}
}
2022-10-21 18:33:43 +01:00
else
2022-09-02 00:00:14 +01:00
{
reportError(CannotCallNonFunction{functionType}, call->func->location);
return;
}
2022-11-18 18:45:14 +00:00
if (call->self)
{
AstExprIndexName* indexExpr = call->func->as<AstExprIndexName>();
if (!indexExpr)
ice.ice("method call expression has no 'self'");
2022-12-02 10:46:05 +00:00
args.head.push_back(lookupType(indexExpr->expr));
}
for (size_t i = 0; i < call->args.size; ++i)
{
AstExpr* arg = call->args.data[i];
TypeId* argTy = module->astTypes.find(arg);
if (argTy)
args.head.push_back(*argTy);
else if (i == call->args.size - 1)
{
TypePackId* argTail = module->astTypePacks.find(arg);
if (argTail)
args.tail = *argTail;
else
2023-01-03 17:33:19 +00:00
args.tail = builtinTypes->anyTypePack;
2022-12-02 10:46:05 +00:00
}
else
2023-01-03 17:33:19 +00:00
args.head.push_back(builtinTypes->anyType);
2022-11-18 18:45:14 +00:00
}
2022-12-02 10:46:05 +00:00
TypePackId argsTp = arena->addTypePack(args);
2023-01-03 17:33:19 +00:00
FunctionType ftv{argsTp, expectedRetType};
2022-12-02 10:46:05 +00:00
TypeId expectedType = arena->addType(ftv);
2022-09-02 00:00:14 +01:00
2022-11-10 22:04:44 +00:00
if (!isSubtype(testFunctionType, expectedType, stack.back()))
2022-06-17 01:54:42 +01:00
{
CloneState cloneState;
2023-01-03 17:33:19 +00:00
expectedType = clone(expectedType, testArena, cloneState);
2022-06-17 01:54:42 +01:00
reportError(TypeMismatch{expectedType, functionType}, call->location);
}
2022-08-18 22:04:33 +01:00
}
void visit(AstExprIndexName* indexName)
{
TypeId leftType = lookupType(indexName->expr);
2022-12-09 18:07:25 +00:00
const NormalizedType* norm = normalizer.normalize(leftType);
if (!norm)
reportError(NormalizationTooComplex{}, indexName->indexLocation);
checkIndexTypeFromType(leftType, *norm, indexName->index.value, indexName->location);
2022-08-18 22:04:33 +01:00
}
2022-06-17 01:54:42 +01:00
2022-08-18 22:04:33 +01:00
void visit(AstExprIndexExpr* indexExpr)
{
// TODO!
visit(indexExpr->expr);
visit(indexExpr->index);
2022-06-17 01:54:42 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstExprFunction* fn)
2022-06-24 02:44:07 +01:00
{
2022-08-18 22:04:33 +01:00
auto StackPusher = pushStack(fn);
2022-06-24 02:44:07 +01:00
TypeId inferredFnTy = lookupType(fn);
2023-01-03 17:33:19 +00:00
const FunctionType* inferredFtv = get<FunctionType>(inferredFnTy);
2022-06-24 02:44:07 +01:00
LUAU_ASSERT(inferredFtv);
auto argIt = begin(inferredFtv->argTypes);
for (const auto& arg : fn->args)
{
if (argIt == end(inferredFtv->argTypes))
break;
if (arg->annotation)
{
TypeId inferredArgTy = *argIt;
TypeId annotatedArgTy = lookupAnnotation(arg->annotation);
2022-11-10 22:04:44 +00:00
if (!isSubtype(annotatedArgTy, inferredArgTy, stack.back()))
2022-06-24 02:44:07 +01:00
{
reportError(TypeMismatch{annotatedArgTy, inferredArgTy}, arg->location);
}
}
++argIt;
}
2022-08-18 22:04:33 +01:00
visit(fn->body);
2022-06-24 02:44:07 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstExprTable* expr)
2022-06-17 01:54:42 +01:00
{
2022-08-18 22:04:33 +01:00
// TODO!
for (const AstExprTable::Item& item : expr->items)
2022-06-17 01:54:42 +01:00
{
2022-08-18 22:04:33 +01:00
if (item.key)
visit(item.key);
visit(item.value);
2022-06-17 01:54:42 +01:00
}
}
2022-08-18 22:04:33 +01:00
void visit(AstExprUnary* expr)
2022-06-17 01:54:42 +01:00
{
2022-08-18 22:04:33 +01:00
visit(expr->expr);
2022-10-27 23:22:49 +01:00
NotNull<Scope> scope = stack.back();
TypeId operandType = lookupType(expr->expr);
2023-01-03 17:33:19 +00:00
if (get<AnyType>(operandType) || get<ErrorType>(operandType) || get<NeverType>(operandType))
2022-10-27 23:22:49 +01:00
return;
if (auto it = kUnaryOpMetamethods.find(expr->op); it != kUnaryOpMetamethods.end())
{
2023-01-03 17:33:19 +00:00
std::optional<TypeId> mm = findMetatableEntry(builtinTypes, module->errors, operandType, it->second, expr->location);
2022-10-27 23:22:49 +01:00
if (mm)
{
2023-01-03 17:33:19 +00:00
if (const FunctionType* ftv = get<FunctionType>(follow(*mm)))
2022-10-27 23:22:49 +01:00
{
2023-01-03 17:33:19 +00:00
TypePackId expectedArgs = testArena.addTypePack({operandType});
2022-11-10 22:04:44 +00:00
reportErrors(tryUnify(scope, expr->location, expectedArgs, ftv->argTypes));
2022-10-27 23:22:49 +01:00
if (std::optional<TypeId> ret = first(ftv->retTypes))
{
if (expr->op == AstExprUnary::Op::Len)
{
2023-01-03 17:33:19 +00:00
reportErrors(tryUnify(scope, expr->location, follow(*ret), builtinTypes->numberType));
2022-10-27 23:22:49 +01:00
}
}
else
{
reportError(GenericError{format("Metamethod '%s' must return a value", it->second)}, expr->location);
}
}
return;
}
}
if (expr->op == AstExprUnary::Op::Len)
{
DenseHashSet<TypeId> seen{nullptr};
int recursionCount = 0;
if (!hasLength(operandType, seen, &recursionCount))
{
reportError(NotATable{operandType}, expr->location);
}
}
else if (expr->op == AstExprUnary::Op::Minus)
{
2023-01-03 17:33:19 +00:00
reportErrors(tryUnify(scope, expr->location, operandType, builtinTypes->numberType));
2022-10-27 23:22:49 +01:00
}
else if (expr->op == AstExprUnary::Op::Not)
{
}
else
{
LUAU_ASSERT(!"Unhandled unary operator");
}
2022-06-17 01:54:42 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstExprBinary* expr)
2022-06-17 01:54:42 +01:00
{
2022-08-18 22:04:33 +01:00
visit(expr->left);
visit(expr->right);
2022-10-21 18:33:43 +01:00
NotNull<Scope> scope = stack.back();
bool isEquality = expr->op == AstExprBinary::Op::CompareEq || expr->op == AstExprBinary::Op::CompareNe;
bool isComparison = expr->op >= AstExprBinary::Op::CompareEq && expr->op <= AstExprBinary::Op::CompareGe;
bool isLogical = expr->op == AstExprBinary::Op::And || expr->op == AstExprBinary::Op::Or;
TypeId leftType = lookupType(expr->left);
TypeId rightType = lookupType(expr->right);
if (expr->op == AstExprBinary::Op::Or)
{
2023-01-03 17:33:19 +00:00
leftType = stripNil(builtinTypes, testArena, leftType);
2022-10-21 18:33:43 +01:00
}
bool isStringOperation = isString(leftType) && isString(rightType);
2023-01-03 17:33:19 +00:00
if (get<AnyType>(leftType) || get<ErrorType>(leftType) || get<AnyType>(rightType) || get<ErrorType>(rightType))
2022-10-21 18:33:43 +01:00
return;
2023-01-03 17:33:19 +00:00
if ((get<BlockedType>(leftType) || get<FreeType>(leftType)) && !isEquality && !isLogical)
2022-10-21 18:33:43 +01:00
{
auto name = getIdentifierOfBaseVar(expr->left);
reportError(CannotInferBinaryOperation{expr->op, name,
isComparison ? CannotInferBinaryOperation::OpKind::Comparison : CannotInferBinaryOperation::OpKind::Operation},
expr->location);
return;
}
if (auto it = kBinaryOpMetamethods.find(expr->op); it != kBinaryOpMetamethods.end())
{
2023-01-03 17:33:19 +00:00
std::optional<TypeId> leftMt = getMetatable(leftType, builtinTypes);
std::optional<TypeId> rightMt = getMetatable(rightType, builtinTypes);
2022-10-21 18:33:43 +01:00
bool matches = leftMt == rightMt;
if (isEquality && !matches)
{
2023-01-03 17:33:19 +00:00
auto testUnion = [&matches, builtinTypes = this->builtinTypes](const UnionType* utv, std::optional<TypeId> otherMt) {
2022-10-21 18:33:43 +01:00
for (TypeId option : utv)
{
2023-01-03 17:33:19 +00:00
if (getMetatable(follow(option), builtinTypes) == otherMt)
2022-10-21 18:33:43 +01:00
{
matches = true;
break;
}
}
};
2023-01-03 17:33:19 +00:00
if (const UnionType* utv = get<UnionType>(leftType); utv && rightMt)
2022-10-21 18:33:43 +01:00
{
testUnion(utv, rightMt);
}
2023-01-03 17:33:19 +00:00
if (const UnionType* utv = get<UnionType>(rightType); utv && leftMt && !matches)
2022-10-21 18:33:43 +01:00
{
testUnion(utv, leftMt);
}
}
if (!matches && isComparison)
{
reportError(GenericError{format("Types %s and %s cannot be compared with %s because they do not have the same metatable",
toString(leftType).c_str(), toString(rightType).c_str(), toString(expr->op).c_str())},
expr->location);
return;
}
std::optional<TypeId> mm;
2023-01-03 17:33:19 +00:00
if (std::optional<TypeId> leftMm = findMetatableEntry(builtinTypes, module->errors, leftType, it->second, expr->left->location))
2022-10-21 18:33:43 +01:00
mm = leftMm;
2023-01-03 17:33:19 +00:00
else if (std::optional<TypeId> rightMm = findMetatableEntry(builtinTypes, module->errors, rightType, it->second, expr->right->location))
2022-12-09 18:07:25 +00:00
{
2022-10-21 18:33:43 +01:00
mm = rightMm;
2022-12-09 18:07:25 +00:00
std::swap(leftType, rightType);
}
2022-10-21 18:33:43 +01:00
if (mm)
{
2022-12-09 18:07:25 +00:00
TypeId instantiatedMm = module->astOverloadResolvedTypes[expr];
if (!instantiatedMm)
reportError(CodeTooComplex{}, expr->location);
2023-01-03 17:33:19 +00:00
else if (const FunctionType* ftv = get<FunctionType>(follow(instantiatedMm)))
2022-10-21 18:33:43 +01:00
{
TypePackId expectedArgs;
// For >= and > we invoke __lt and __le respectively with
// swapped argument ordering.
if (expr->op == AstExprBinary::Op::CompareGe || expr->op == AstExprBinary::Op::CompareGt)
{
2023-01-03 17:33:19 +00:00
expectedArgs = testArena.addTypePack({rightType, leftType});
2022-10-21 18:33:43 +01:00
}
else
{
2023-01-03 17:33:19 +00:00
expectedArgs = testArena.addTypePack({leftType, rightType});
2022-10-21 18:33:43 +01:00
}
reportErrors(tryUnify(scope, expr->location, ftv->argTypes, expectedArgs));
if (expr->op == AstExprBinary::CompareEq || expr->op == AstExprBinary::CompareNe || expr->op == AstExprBinary::CompareGe ||
expr->op == AstExprBinary::CompareGt || expr->op == AstExprBinary::Op::CompareLe || expr->op == AstExprBinary::Op::CompareLt)
{
2023-01-03 17:33:19 +00:00
TypePackId expectedRets = testArena.addTypePack({builtinTypes->booleanType});
2022-11-10 22:04:44 +00:00
if (!isSubtype(ftv->retTypes, expectedRets, scope))
2022-10-21 18:33:43 +01:00
{
reportError(GenericError{format("Metamethod '%s' must return type 'boolean'", it->second)}, expr->location);
}
}
else if (!first(ftv->retTypes))
{
reportError(GenericError{format("Metamethod '%s' must return a value", it->second)}, expr->location);
}
}
else
{
reportError(CannotCallNonFunction{*mm}, expr->location);
}
return;
}
// If this is a string comparison, or a concatenation of strings, we
// want to fall through to primitive behavior.
else if (!isEquality && !(isStringOperation && (expr->op == AstExprBinary::Op::Concat || isComparison)))
{
if (leftMt || rightMt)
{
if (isComparison)
{
reportError(GenericError{format(
"Types '%s' and '%s' cannot be compared with %s because neither type's metatable has a '%s' metamethod",
toString(leftType).c_str(), toString(rightType).c_str(), toString(expr->op).c_str(), it->second)},
expr->location);
}
else
{
reportError(GenericError{format(
"Operator %s is not applicable for '%s' and '%s' because neither type's metatable has a '%s' metamethod",
toString(expr->op).c_str(), toString(leftType).c_str(), toString(rightType).c_str(), it->second)},
expr->location);
}
return;
}
2023-01-03 17:33:19 +00:00
else if (!leftMt && !rightMt && (get<TableType>(leftType) || get<TableType>(rightType)))
2022-10-21 18:33:43 +01:00
{
if (isComparison)
{
reportError(GenericError{format("Types '%s' and '%s' cannot be compared with %s because neither type has a metatable",
toString(leftType).c_str(), toString(rightType).c_str(), toString(expr->op).c_str())},
expr->location);
}
else
{
reportError(GenericError{format("Operator %s is not applicable for '%s' and '%s' because neither type has a metatable",
toString(expr->op).c_str(), toString(leftType).c_str(), toString(rightType).c_str())},
expr->location);
}
return;
}
}
}
switch (expr->op)
{
case AstExprBinary::Op::Add:
case AstExprBinary::Op::Sub:
case AstExprBinary::Op::Mul:
case AstExprBinary::Op::Div:
case AstExprBinary::Op::Pow:
case AstExprBinary::Op::Mod:
2023-01-03 17:33:19 +00:00
reportErrors(tryUnify(scope, expr->left->location, leftType, builtinTypes->numberType));
reportErrors(tryUnify(scope, expr->right->location, rightType, builtinTypes->numberType));
2022-10-21 18:33:43 +01:00
break;
case AstExprBinary::Op::Concat:
2023-01-03 17:33:19 +00:00
reportErrors(tryUnify(scope, expr->left->location, leftType, builtinTypes->stringType));
reportErrors(tryUnify(scope, expr->right->location, rightType, builtinTypes->stringType));
2022-10-21 18:33:43 +01:00
break;
case AstExprBinary::Op::CompareGe:
case AstExprBinary::Op::CompareGt:
case AstExprBinary::Op::CompareLe:
case AstExprBinary::Op::CompareLt:
if (isNumber(leftType))
2023-01-03 17:33:19 +00:00
reportErrors(tryUnify(scope, expr->right->location, rightType, builtinTypes->numberType));
2022-10-21 18:33:43 +01:00
else if (isString(leftType))
2023-01-03 17:33:19 +00:00
reportErrors(tryUnify(scope, expr->right->location, rightType, builtinTypes->stringType));
2022-10-21 18:33:43 +01:00
else
reportError(GenericError{format("Types '%s' and '%s' cannot be compared with relational operator %s", toString(leftType).c_str(),
toString(rightType).c_str(), toString(expr->op).c_str())},
expr->location);
break;
case AstExprBinary::Op::And:
case AstExprBinary::Op::Or:
case AstExprBinary::Op::CompareEq:
case AstExprBinary::Op::CompareNe:
break;
default:
// Unhandled AstExprBinary::Op possibility.
LUAU_ASSERT(false);
}
2022-06-17 01:54:42 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstExprTypeAssertion* expr)
2022-08-11 21:42:54 +01:00
{
2022-08-18 22:04:33 +01:00
visit(expr->expr);
visit(expr->annotation);
2022-08-11 21:42:54 +01:00
TypeId annotationType = lookupAnnotation(expr->annotation);
TypeId computedType = lookupType(expr->expr);
// Note: As an optimization, we try 'number <: number | string' first, as that is the more likely case.
2022-11-10 22:04:44 +00:00
if (isSubtype(annotationType, computedType, stack.back()))
2022-08-18 22:04:33 +01:00
return;
2022-08-11 21:42:54 +01:00
2022-11-10 22:04:44 +00:00
if (isSubtype(computedType, annotationType, stack.back()))
2022-08-18 22:04:33 +01:00
return;
2022-08-11 21:42:54 +01:00
reportError(TypesAreUnrelated{computedType, annotationType}, expr->location);
2022-08-18 22:04:33 +01:00
}
void visit(AstExprIfElse* expr)
{
// TODO!
visit(expr->condition);
visit(expr->trueExpr);
visit(expr->falseExpr);
}
void visit(AstExprError* expr)
{
// TODO!
for (AstExpr* e : expr->expressions)
visit(e);
2022-08-11 21:42:54 +01:00
}
2022-07-01 00:29:02 +01:00
/** Extract a TypeId for the first type of the provided pack.
*
* Note that this may require modifying some types. I hope this doesn't cause problems!
*/
TypeId flattenPack(TypePackId pack)
{
pack = follow(pack);
2022-07-14 23:39:35 +01:00
while (true)
2022-07-01 00:29:02 +01:00
{
2022-07-14 23:39:35 +01:00
auto tp = get<TypePack>(pack);
if (tp && tp->head.empty() && tp->tail)
2022-07-01 00:29:02 +01:00
pack = *tp->tail;
2022-07-14 23:39:35 +01:00
else
break;
2022-07-01 00:29:02 +01:00
}
if (auto ty = first(pack))
return *ty;
else if (auto vtp = get<VariadicTypePack>(pack))
return vtp->ty;
else if (auto ftp = get<FreeTypePack>(pack))
{
2023-01-03 17:33:19 +00:00
TypeId result = testArena.addType(FreeType{ftp->scope});
TypePackId freeTail = testArena.addTypePack(FreeTypePack{ftp->scope});
2022-07-01 00:29:02 +01:00
TypePack& resultPack = asMutable(pack)->ty.emplace<TypePack>();
resultPack.head.assign(1, result);
resultPack.tail = freeTail;
return result;
}
else if (get<Unifiable::Error>(pack))
2023-01-03 17:33:19 +00:00
return builtinTypes->errorRecoveryType();
2022-07-01 00:29:02 +01:00
else
ice.ice("flattenPack got a weird pack!");
}
2022-08-18 22:04:33 +01:00
void visit(AstType* ty)
2022-06-24 02:44:07 +01:00
{
2022-08-18 22:04:33 +01:00
if (auto t = ty->as<AstTypeReference>())
return visit(t);
else if (auto t = ty->as<AstTypeTable>())
return visit(t);
else if (auto t = ty->as<AstTypeFunction>())
return visit(t);
else if (auto t = ty->as<AstTypeTypeof>())
return visit(t);
else if (auto t = ty->as<AstTypeUnion>())
return visit(t);
else if (auto t = ty->as<AstTypeIntersection>())
return visit(t);
2022-06-24 02:44:07 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstTypeReference* ty)
2022-06-24 02:44:07 +01:00
{
2023-01-03 17:33:19 +00:00
// No further validation is necessary in this case. The main logic for
// _luau_print is contained in lookupAnnotation.
if (FFlag::DebugLuauMagicTypes && ty->name == "_luau_print" && ty->parameters.size > 0)
return;
2022-08-18 22:04:33 +01:00
for (const AstTypeOrPack& param : ty->parameters)
{
if (param.type)
visit(param.type);
else
visit(param.typePack);
}
2022-07-29 04:41:13 +01:00
Scope* scope = findInnermostScope(ty->location);
2022-08-04 22:27:28 +01:00
LUAU_ASSERT(scope);
2022-06-24 02:44:07 +01:00
2022-10-27 23:22:49 +01:00
std::optional<TypeFun> alias =
(ty->prefix) ? scope->lookupImportedType(ty->prefix->value, ty->name.value) : scope->lookupType(ty->name.value);
2022-08-04 22:27:28 +01:00
if (alias.has_value())
{
size_t typesRequired = alias->typeParams.size();
size_t packsRequired = alias->typePackParams.size();
bool hasDefaultTypes = std::any_of(alias->typeParams.begin(), alias->typeParams.end(), [](auto&& el) {
return el.defaultValue.has_value();
});
bool hasDefaultPacks = std::any_of(alias->typePackParams.begin(), alias->typePackParams.end(), [](auto&& el) {
return el.defaultValue.has_value();
});
if (!ty->hasParameterList)
{
if ((!alias->typeParams.empty() && !hasDefaultTypes) || (!alias->typePackParams.empty() && !hasDefaultPacks))
{
reportError(GenericError{"Type parameter list is required"}, ty->location);
}
}
size_t typesProvided = 0;
size_t extraTypes = 0;
size_t packsProvided = 0;
for (const AstTypeOrPack& p : ty->parameters)
{
if (p.type)
{
if (packsProvided != 0)
{
reportError(GenericError{"Type parameters must come before type pack parameters"}, ty->location);
}
if (typesProvided < typesRequired)
{
typesProvided += 1;
}
else
{
extraTypes += 1;
}
}
else if (p.typePack)
{
TypePackId tp = lookupPackAnnotation(p.typePack);
if (typesProvided < typesRequired && size(tp) == 1 && finite(tp) && first(tp))
{
typesProvided += 1;
}
else
{
packsProvided += 1;
}
}
}
if (extraTypes != 0 && packsProvided == 0)
{
packsProvided += 1;
}
for (size_t i = typesProvided; i < typesRequired; ++i)
{
if (alias->typeParams[i].defaultValue)
{
typesProvided += 1;
}
}
for (size_t i = packsProvided; i < packsProvided; ++i)
{
if (alias->typePackParams[i].defaultValue)
{
packsProvided += 1;
}
}
if (extraTypes == 0 && packsProvided + 1 == packsRequired)
{
packsProvided += 1;
}
if (typesProvided != typesRequired || packsProvided != packsRequired)
{
reportError(IncorrectGenericParameterCount{
/* name */ ty->name.value,
/* typeFun */ *alias,
/* actualParameters */ typesProvided,
/* actualPackParameters */ packsProvided,
},
ty->location);
}
}
else
{
2022-08-11 21:42:54 +01:00
if (scope->lookupPack(ty->name.value))
2022-08-04 22:27:28 +01:00
{
reportError(
SwappedGenericTypeParameter{
ty->name.value,
SwappedGenericTypeParameter::Kind::Type,
},
ty->location);
}
else
{
reportError(UnknownSymbol{ty->name.value, UnknownSymbol::Context::Type}, ty->location);
}
}
2022-08-18 22:04:33 +01:00
}
void visit(AstTypeTable* table)
{
// TODO!
for (const AstTableProp& prop : table->props)
visit(prop.type);
if (table->indexer)
{
visit(table->indexer->indexType);
visit(table->indexer->resultType);
}
}
void visit(AstTypeFunction* ty)
{
// TODO!
visit(ty->argTypes);
visit(ty->returnTypes);
}
void visit(AstTypeTypeof* ty)
{
visit(ty->expr);
}
void visit(AstTypeUnion* ty)
{
// TODO!
for (AstType* type : ty->types)
visit(type);
}
void visit(AstTypeIntersection* ty)
{
// TODO!
for (AstType* type : ty->types)
visit(type);
}
void visit(AstTypePack* pack)
{
if (auto p = pack->as<AstTypePackExplicit>())
return visit(p);
else if (auto p = pack->as<AstTypePackVariadic>())
return visit(p);
else if (auto p = pack->as<AstTypePackGeneric>())
return visit(p);
}
void visit(AstTypePackExplicit* tp)
{
// TODO!
for (AstType* type : tp->typeList.types)
visit(type);
2022-08-04 22:27:28 +01:00
2022-08-18 22:04:33 +01:00
if (tp->typeList.tailType)
visit(tp->typeList.tailType);
2022-08-04 22:27:28 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstTypePackVariadic* tp)
2022-08-04 22:27:28 +01:00
{
2022-08-18 22:04:33 +01:00
// TODO!
visit(tp->variadicType);
2022-08-04 22:27:28 +01:00
}
2022-08-18 22:04:33 +01:00
void visit(AstTypePackGeneric* tp)
2022-08-04 22:27:28 +01:00
{
Scope* scope = findInnermostScope(tp->location);
LUAU_ASSERT(scope);
2022-08-11 21:42:54 +01:00
std::optional<TypePackId> alias = scope->lookupPack(tp->genericName.value);
2022-08-04 22:27:28 +01:00
if (!alias.has_value())
2022-06-24 02:44:07 +01:00
{
2022-08-11 21:42:54 +01:00
if (scope->lookupType(tp->genericName.value))
2022-08-04 22:27:28 +01:00
{
reportError(
SwappedGenericTypeParameter{
tp->genericName.value,
SwappedGenericTypeParameter::Kind::Pack,
},
tp->location);
}
else
{
reportError(UnknownSymbol{tp->genericName.value, UnknownSymbol::Context::Type}, tp->location);
}
2022-06-24 02:44:07 +01:00
}
}
2022-11-10 22:04:44 +00:00
template<typename TID>
bool isSubtype(TID subTy, TID superTy, NotNull<Scope> scope)
{
TypeArena arena;
Unifier u{NotNull{&normalizer}, Mode::Strict, scope, Location{}, Covariant};
u.useScopes = true;
u.tryUnify(subTy, superTy);
const bool ok = u.errors.empty() && u.log.empty();
return ok;
}
2022-09-02 00:00:14 +01:00
template<typename TID>
ErrorVec tryUnify(NotNull<Scope> scope, const Location& location, TID subTy, TID superTy)
{
2022-10-07 00:55:58 +01:00
Unifier u{NotNull{&normalizer}, Mode::Strict, scope, location, Covariant};
2022-11-10 22:04:44 +00:00
u.useScopes = true;
2022-09-02 00:00:14 +01:00
u.tryUnify(subTy, superTy);
return std::move(u.errors);
}
void reportError(TypeErrorData data, const Location& location)
2022-06-17 01:54:42 +01:00
{
module->errors.emplace_back(location, sourceModule->name, std::move(data));
2022-09-08 22:44:50 +01:00
if (FFlag::DebugLuauLogSolverToJson)
logger->captureTypeCheckError(module->errors.back());
2022-06-17 01:54:42 +01:00
}
2022-07-01 00:29:02 +01:00
void reportError(TypeError e)
{
2022-09-02 00:00:14 +01:00
reportError(std::move(e.data), e.location);
}
void reportErrors(ErrorVec errors)
{
for (TypeError e : errors)
reportError(std::move(e));
2022-07-01 00:29:02 +01:00
}
2022-08-11 21:42:54 +01:00
2022-12-09 18:07:25 +00:00
void checkIndexTypeFromType(TypeId denormalizedTy, const NormalizedType& norm, const std::string& prop, const Location& location)
2022-08-11 21:42:54 +01:00
{
2022-12-09 18:07:25 +00:00
bool foundOneProp = false;
std::vector<TypeId> typesMissingTheProp;
auto fetch = [&](TypeId ty) {
if (!normalizer.isInhabited(ty))
return;
bool found = hasIndexTypeFromType(ty, prop, location);
foundOneProp |= found;
if (!found)
typesMissingTheProp.push_back(ty);
};
fetch(norm.tops);
fetch(norm.booleans);
2023-01-03 17:33:19 +00:00
if (FFlag::LuauNegatedClassTypes)
{
for (const auto& [ty, _negations] : norm.classes.classes)
{
fetch(ty);
}
}
else
{
for (TypeId ty : norm.DEPRECATED_classes)
fetch(ty);
}
2022-12-09 18:07:25 +00:00
fetch(norm.errors);
fetch(norm.nils);
fetch(norm.numbers);
if (!norm.strings.isNever())
2023-01-03 17:33:19 +00:00
fetch(builtinTypes->stringType);
2022-12-09 18:07:25 +00:00
fetch(norm.threads);
for (TypeId ty : norm.tables)
fetch(ty);
if (norm.functions.isTop)
2023-01-03 17:33:19 +00:00
fetch(builtinTypes->functionType);
2022-12-09 18:07:25 +00:00
else if (!norm.functions.isNever())
{
if (norm.functions.parts->size() == 1)
fetch(norm.functions.parts->front());
else
{
std::vector<TypeId> parts;
parts.insert(parts.end(), norm.functions.parts->begin(), norm.functions.parts->end());
2023-01-03 17:33:19 +00:00
fetch(testArena.addType(IntersectionType{std::move(parts)}));
2022-12-09 18:07:25 +00:00
}
}
for (const auto& [tyvar, intersect] : norm.tyvars)
{
2023-01-03 17:33:19 +00:00
if (get<NeverType>(intersect->tops))
2022-12-09 18:07:25 +00:00
{
TypeId ty = normalizer.typeFromNormal(*intersect);
2023-01-03 17:33:19 +00:00
fetch(testArena.addType(IntersectionType{{tyvar, ty}}));
2022-12-09 18:07:25 +00:00
}
else
fetch(tyvar);
}
if (!typesMissingTheProp.empty())
{
if (foundOneProp)
reportError(TypeError{location, MissingUnionProperty{denormalizedTy, typesMissingTheProp, prop}});
else
reportError(TypeError{location, UnknownProperty{denormalizedTy, prop}});
}
}
bool hasIndexTypeFromType(TypeId ty, const std::string& prop, const Location& location)
{
2023-01-03 17:33:19 +00:00
if (get<ErrorType>(ty) || get<AnyType>(ty) || get<NeverType>(ty))
2022-12-09 18:07:25 +00:00
return true;
if (isString(ty))
{
2023-01-03 17:33:19 +00:00
std::optional<TypeId> mtIndex = Luau::findMetatableEntry(builtinTypes, module->errors, builtinTypes->stringType, "__index", location);
2022-12-09 18:07:25 +00:00
LUAU_ASSERT(mtIndex);
ty = *mtIndex;
}
if (getTableType(ty))
2023-01-03 17:33:19 +00:00
return bool(findTablePropertyRespectingMeta(builtinTypes, module->errors, ty, prop, location));
else if (const ClassType* cls = get<ClassType>(ty))
2022-12-09 18:07:25 +00:00
return bool(lookupClassProp(cls, prop));
2023-01-03 17:33:19 +00:00
else if (const UnionType* utv = get<UnionType>(ty))
ice.ice("getIndexTypeFromTypeHelper cannot take a UnionType");
else if (const IntersectionType* itv = get<IntersectionType>(ty))
2022-12-09 18:07:25 +00:00
return std::any_of(begin(itv), end(itv), [&](TypeId part) {
return hasIndexTypeFromType(part, prop, location);
});
else
return false;
2022-08-11 21:42:54 +01:00
}
2022-06-17 01:54:42 +01:00
};
2023-01-03 17:33:19 +00:00
void check(NotNull<BuiltinTypes> builtinTypes, DcrLogger* logger, const SourceModule& sourceModule, Module* module)
2022-06-17 01:54:42 +01:00
{
2023-01-03 17:33:19 +00:00
TypeChecker2 typeChecker{builtinTypes, logger, &sourceModule, module};
2022-06-17 01:54:42 +01:00
2022-08-18 22:04:33 +01:00
typeChecker.visit(sourceModule.root);
2023-01-03 17:33:19 +00:00
unfreeze(module->interfaceTypes);
copyErrors(module->errors, module->interfaceTypes);
freeze(module->interfaceTypes);
2022-06-17 01:54:42 +01:00
}
} // namespace Luau