mirror of
https://github.com/luau-lang/luau.git
synced 2024-11-15 14:25:44 +08:00
fd6250cf9d
### What's Changed - Improve readability of unions and intersections by limiting the number of elements of those types that can be presented on a single line (gated under `FFlag::LuauToStringSimpleCompositeTypesSingleLine`) - Adds a new option to the compiler `--record-stats` to record and output compilation statistics - `if...then...else` expressions are now optimized into `AND/OR` form when possible. ### VM - Add a new `buffer` type to Luau based on the [buffer RFC](https://github.com/Roblox/luau/pull/739) and additional C API functions to work with it; this release does not include the library. - Internal C API to work with string buffers has been updated to align with Lua version more closely ### Native Codegen - Added support for new X64 instruction (rev) and new A64 instruction (bswap) in the assembler - Simplified the way numerical loop condition is translated to IR ### New Type Solver - Operator inference now handled by type families - Created a new system called `Type Paths` to explain why subtyping tests fail in order to improve the quality of error messages. - Systematic changes to implement Data Flow analysis in the new solver (`Breadcrumb` removed and replaced with `RefinementKey`) --- Co-authored-by: Aaron Weiss <aaronweiss@roblox.com> Co-authored-by: Alexander McCord <amccord@roblox.com> Co-authored-by: Andy Friesen <afriesen@roblox.com> Co-authored-by: Aviral Goel <agoel@roblox.com> Co-authored-by: Lily Brown <lbrown@roblox.com> Co-authored-by: Vighnesh Vijay <vvijay@roblox.com> Co-authored-by: Vyacheslav Egorov <vegorov@roblox.com> --------- Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com> Co-authored-by: Vyacheslav Egorov <vegorov@roblox.com> Co-authored-by: Andy Friesen <afriesen@roblox.com> Co-authored-by: Lily Brown <lbrown@roblox.com> Co-authored-by: Aaron Weiss <aaronweiss@roblox.com> Co-authored-by: Alexander McCord <amccord@roblox.com> Co-authored-by: Aviral Goel <agoel@roblox.com>
487 lines
10 KiB
C++
487 lines
10 KiB
C++
// This file is part of the Luau programming language and is licensed under MIT License; see LICENSE.txt for details
|
|
#pragma once
|
|
|
|
#include "Luau/Location.h"
|
|
#include "Luau/NotNull.h"
|
|
#include "Luau/Type.h"
|
|
#include "Luau/Variant.h"
|
|
#include "Luau/Ast.h"
|
|
|
|
#include <set>
|
|
|
|
namespace Luau
|
|
{
|
|
|
|
struct FileResolver;
|
|
struct TypeArena;
|
|
struct TypeError;
|
|
|
|
struct TypeMismatch
|
|
{
|
|
enum Context
|
|
{
|
|
CovariantContext,
|
|
InvariantContext
|
|
};
|
|
|
|
TypeMismatch() = default;
|
|
TypeMismatch(TypeId wantedType, TypeId givenType);
|
|
TypeMismatch(TypeId wantedType, TypeId givenType, std::string reason);
|
|
TypeMismatch(TypeId wantedType, TypeId givenType, std::string reason, std::optional<TypeError> error);
|
|
|
|
TypeMismatch(TypeId wantedType, TypeId givenType, Context context);
|
|
TypeMismatch(TypeId wantedType, TypeId givenType, std::string reason, Context context);
|
|
TypeMismatch(TypeId wantedType, TypeId givenType, std::string reason, std::optional<TypeError> error, Context context);
|
|
|
|
TypeId wantedType = nullptr;
|
|
TypeId givenType = nullptr;
|
|
Context context = CovariantContext;
|
|
|
|
std::string reason;
|
|
std::shared_ptr<TypeError> error;
|
|
|
|
bool operator==(const TypeMismatch& rhs) const;
|
|
};
|
|
|
|
struct UnknownSymbol
|
|
{
|
|
enum Context
|
|
{
|
|
Binding,
|
|
Type,
|
|
};
|
|
Name name;
|
|
Context context;
|
|
|
|
bool operator==(const UnknownSymbol& rhs) const;
|
|
};
|
|
|
|
struct UnknownProperty
|
|
{
|
|
TypeId table;
|
|
Name key;
|
|
|
|
bool operator==(const UnknownProperty& rhs) const;
|
|
};
|
|
|
|
struct NotATable
|
|
{
|
|
TypeId ty;
|
|
|
|
bool operator==(const NotATable& rhs) const;
|
|
};
|
|
|
|
struct CannotExtendTable
|
|
{
|
|
enum Context
|
|
{
|
|
Property,
|
|
Indexer,
|
|
Metatable
|
|
};
|
|
TypeId tableType;
|
|
Context context;
|
|
Name prop;
|
|
|
|
bool operator==(const CannotExtendTable& rhs) const;
|
|
};
|
|
|
|
struct OnlyTablesCanHaveMethods
|
|
{
|
|
TypeId tableType;
|
|
|
|
bool operator==(const OnlyTablesCanHaveMethods& rhs) const;
|
|
};
|
|
|
|
struct DuplicateTypeDefinition
|
|
{
|
|
Name name;
|
|
std::optional<Location> previousLocation;
|
|
|
|
bool operator==(const DuplicateTypeDefinition& rhs) const;
|
|
};
|
|
|
|
struct CountMismatch
|
|
{
|
|
enum Context
|
|
{
|
|
Arg,
|
|
FunctionResult,
|
|
ExprListResult,
|
|
Return,
|
|
};
|
|
size_t expected;
|
|
std::optional<size_t> maximum;
|
|
size_t actual;
|
|
Context context = Arg;
|
|
bool isVariadic = false;
|
|
std::string function;
|
|
|
|
bool operator==(const CountMismatch& rhs) const;
|
|
};
|
|
|
|
struct FunctionDoesNotTakeSelf
|
|
{
|
|
bool operator==(const FunctionDoesNotTakeSelf& rhs) const;
|
|
};
|
|
|
|
struct FunctionRequiresSelf
|
|
{
|
|
bool operator==(const FunctionRequiresSelf& rhs) const;
|
|
};
|
|
|
|
struct OccursCheckFailed
|
|
{
|
|
bool operator==(const OccursCheckFailed& rhs) const;
|
|
};
|
|
|
|
struct UnknownRequire
|
|
{
|
|
std::string modulePath;
|
|
|
|
bool operator==(const UnknownRequire& rhs) const;
|
|
};
|
|
|
|
struct IncorrectGenericParameterCount
|
|
{
|
|
Name name;
|
|
TypeFun typeFun;
|
|
size_t actualParameters;
|
|
size_t actualPackParameters;
|
|
|
|
bool operator==(const IncorrectGenericParameterCount& rhs) const;
|
|
};
|
|
|
|
struct SyntaxError
|
|
{
|
|
std::string message;
|
|
|
|
bool operator==(const SyntaxError& rhs) const;
|
|
};
|
|
|
|
struct CodeTooComplex
|
|
{
|
|
bool operator==(const CodeTooComplex&) const;
|
|
};
|
|
|
|
struct UnificationTooComplex
|
|
{
|
|
bool operator==(const UnificationTooComplex&) const;
|
|
};
|
|
|
|
// Could easily be folded into UnknownProperty with an extra field, std::set<Name> candidates.
|
|
// But for telemetry purposes, we want to have this be a distinct variant.
|
|
struct UnknownPropButFoundLikeProp
|
|
{
|
|
TypeId table;
|
|
Name key;
|
|
std::set<Name> candidates;
|
|
|
|
bool operator==(const UnknownPropButFoundLikeProp& rhs) const;
|
|
};
|
|
|
|
struct GenericError
|
|
{
|
|
std::string message;
|
|
|
|
bool operator==(const GenericError& rhs) const;
|
|
};
|
|
|
|
struct InternalError
|
|
{
|
|
std::string message;
|
|
|
|
bool operator==(const InternalError& rhs) const;
|
|
};
|
|
|
|
struct CannotCallNonFunction
|
|
{
|
|
TypeId ty;
|
|
|
|
bool operator==(const CannotCallNonFunction& rhs) const;
|
|
};
|
|
|
|
struct ExtraInformation
|
|
{
|
|
std::string message;
|
|
bool operator==(const ExtraInformation& rhs) const;
|
|
};
|
|
|
|
struct DeprecatedApiUsed
|
|
{
|
|
std::string symbol;
|
|
std::string useInstead;
|
|
bool operator==(const DeprecatedApiUsed& rhs) const;
|
|
};
|
|
|
|
struct ModuleHasCyclicDependency
|
|
{
|
|
std::vector<ModuleName> cycle;
|
|
bool operator==(const ModuleHasCyclicDependency& rhs) const;
|
|
};
|
|
|
|
struct FunctionExitsWithoutReturning
|
|
{
|
|
TypePackId expectedReturnType;
|
|
bool operator==(const FunctionExitsWithoutReturning& rhs) const;
|
|
};
|
|
|
|
struct IllegalRequire
|
|
{
|
|
std::string moduleName;
|
|
std::string reason;
|
|
|
|
bool operator==(const IllegalRequire& rhs) const;
|
|
};
|
|
|
|
struct MissingProperties
|
|
{
|
|
enum Context
|
|
{
|
|
Missing,
|
|
Extra
|
|
};
|
|
TypeId superType;
|
|
TypeId subType;
|
|
std::vector<Name> properties;
|
|
Context context = Missing;
|
|
|
|
bool operator==(const MissingProperties& rhs) const;
|
|
};
|
|
|
|
struct DuplicateGenericParameter
|
|
{
|
|
std::string parameterName;
|
|
|
|
bool operator==(const DuplicateGenericParameter& rhs) const;
|
|
};
|
|
|
|
struct CannotInferBinaryOperation
|
|
{
|
|
enum OpKind
|
|
{
|
|
Operation,
|
|
Comparison,
|
|
};
|
|
|
|
AstExprBinary::Op op;
|
|
std::optional<std::string> suggestedToAnnotate;
|
|
OpKind kind;
|
|
|
|
bool operator==(const CannotInferBinaryOperation& rhs) const;
|
|
};
|
|
|
|
struct SwappedGenericTypeParameter
|
|
{
|
|
enum Kind
|
|
{
|
|
Type,
|
|
Pack,
|
|
};
|
|
|
|
std::string name;
|
|
// What was `name` being used as?
|
|
Kind kind;
|
|
|
|
bool operator==(const SwappedGenericTypeParameter& rhs) const;
|
|
};
|
|
|
|
struct OptionalValueAccess
|
|
{
|
|
TypeId optional;
|
|
|
|
bool operator==(const OptionalValueAccess& rhs) const;
|
|
};
|
|
|
|
struct MissingUnionProperty
|
|
{
|
|
TypeId type;
|
|
std::vector<TypeId> missing;
|
|
Name key;
|
|
|
|
bool operator==(const MissingUnionProperty& rhs) const;
|
|
};
|
|
|
|
struct TypesAreUnrelated
|
|
{
|
|
TypeId left;
|
|
TypeId right;
|
|
|
|
bool operator==(const TypesAreUnrelated& rhs) const;
|
|
};
|
|
|
|
struct NormalizationTooComplex
|
|
{
|
|
bool operator==(const NormalizationTooComplex&) const
|
|
{
|
|
return true;
|
|
}
|
|
};
|
|
|
|
struct TypePackMismatch
|
|
{
|
|
TypePackId wantedTp;
|
|
TypePackId givenTp;
|
|
|
|
bool operator==(const TypePackMismatch& rhs) const;
|
|
};
|
|
|
|
struct DynamicPropertyLookupOnClassesUnsafe
|
|
{
|
|
TypeId ty;
|
|
|
|
bool operator==(const DynamicPropertyLookupOnClassesUnsafe& rhs) const;
|
|
};
|
|
|
|
struct UninhabitedTypeFamily
|
|
{
|
|
TypeId ty;
|
|
|
|
bool operator==(const UninhabitedTypeFamily& rhs) const;
|
|
};
|
|
|
|
struct UninhabitedTypePackFamily
|
|
{
|
|
TypePackId tp;
|
|
|
|
bool operator==(const UninhabitedTypePackFamily& rhs) const;
|
|
};
|
|
|
|
struct WhereClauseNeeded
|
|
{
|
|
TypeId ty;
|
|
|
|
bool operator==(const WhereClauseNeeded& rhs) const;
|
|
};
|
|
|
|
struct PackWhereClauseNeeded
|
|
{
|
|
TypePackId tp;
|
|
|
|
bool operator==(const PackWhereClauseNeeded& rhs) const;
|
|
};
|
|
|
|
struct CheckedFunctionCallError
|
|
{
|
|
TypeId expected;
|
|
TypeId passed;
|
|
std::string checkedFunctionName;
|
|
// TODO: make this a vector<argumentIndices>
|
|
size_t argumentIndex;
|
|
bool operator==(const CheckedFunctionCallError& rhs) const;
|
|
};
|
|
|
|
using TypeErrorData = Variant<TypeMismatch, UnknownSymbol, UnknownProperty, NotATable, CannotExtendTable, OnlyTablesCanHaveMethods,
|
|
DuplicateTypeDefinition, CountMismatch, FunctionDoesNotTakeSelf, FunctionRequiresSelf, OccursCheckFailed, UnknownRequire,
|
|
IncorrectGenericParameterCount, SyntaxError, CodeTooComplex, UnificationTooComplex, UnknownPropButFoundLikeProp, GenericError, InternalError,
|
|
CannotCallNonFunction, ExtraInformation, DeprecatedApiUsed, ModuleHasCyclicDependency, IllegalRequire, FunctionExitsWithoutReturning,
|
|
DuplicateGenericParameter, CannotInferBinaryOperation, MissingProperties, SwappedGenericTypeParameter, OptionalValueAccess, MissingUnionProperty,
|
|
TypesAreUnrelated, NormalizationTooComplex, TypePackMismatch, DynamicPropertyLookupOnClassesUnsafe, UninhabitedTypeFamily,
|
|
UninhabitedTypePackFamily, WhereClauseNeeded, PackWhereClauseNeeded, CheckedFunctionCallError>;
|
|
|
|
struct TypeErrorSummary
|
|
{
|
|
Location location;
|
|
ModuleName moduleName;
|
|
int code;
|
|
|
|
TypeErrorSummary(const Location& location, const ModuleName& moduleName, int code)
|
|
: location(location)
|
|
, moduleName(moduleName)
|
|
, code(code)
|
|
{
|
|
}
|
|
};
|
|
|
|
struct TypeError
|
|
{
|
|
Location location;
|
|
ModuleName moduleName;
|
|
TypeErrorData data;
|
|
|
|
static int minCode();
|
|
int code() const;
|
|
|
|
TypeError() = default;
|
|
|
|
TypeError(const Location& location, const ModuleName& moduleName, const TypeErrorData& data)
|
|
: location(location)
|
|
, moduleName(moduleName)
|
|
, data(data)
|
|
{
|
|
}
|
|
|
|
TypeError(const Location& location, const TypeErrorData& data)
|
|
: TypeError(location, {}, data)
|
|
{
|
|
}
|
|
|
|
bool operator==(const TypeError& rhs) const;
|
|
|
|
TypeErrorSummary summary() const;
|
|
};
|
|
|
|
template<typename T>
|
|
const T* get(const TypeError& e)
|
|
{
|
|
return get_if<T>(&e.data);
|
|
}
|
|
|
|
template<typename T>
|
|
T* get(TypeError& e)
|
|
{
|
|
return get_if<T>(&e.data);
|
|
}
|
|
|
|
using ErrorVec = std::vector<TypeError>;
|
|
|
|
struct TypeErrorToStringOptions
|
|
{
|
|
FileResolver* fileResolver = nullptr;
|
|
};
|
|
|
|
std::string toString(const TypeError& error);
|
|
std::string toString(const TypeError& error, TypeErrorToStringOptions options);
|
|
|
|
bool containsParseErrorName(const TypeError& error);
|
|
|
|
// Copy any types named in the error into destArena.
|
|
void copyErrors(ErrorVec& errors, struct TypeArena& destArena, NotNull<BuiltinTypes> builtinTypes);
|
|
|
|
// Internal Compiler Error
|
|
struct InternalErrorReporter
|
|
{
|
|
std::function<void(const char*)> onInternalError;
|
|
std::string moduleName;
|
|
|
|
[[noreturn]] void ice(const std::string& message, const Location& location) const;
|
|
[[noreturn]] void ice(const std::string& message) const;
|
|
};
|
|
|
|
class InternalCompilerError : public std::exception
|
|
{
|
|
public:
|
|
explicit InternalCompilerError(const std::string& message)
|
|
: message(message)
|
|
{
|
|
}
|
|
explicit InternalCompilerError(const std::string& message, const std::string& moduleName)
|
|
: message(message)
|
|
, moduleName(moduleName)
|
|
{
|
|
}
|
|
explicit InternalCompilerError(const std::string& message, const std::string& moduleName, const Location& location)
|
|
: message(message)
|
|
, moduleName(moduleName)
|
|
, location(location)
|
|
{
|
|
}
|
|
virtual const char* what() const throw();
|
|
|
|
const std::string message;
|
|
const std::optional<std::string> moduleName;
|
|
const std::optional<Location> location;
|
|
};
|
|
|
|
} // namespace Luau
|