2020-03-11 18:27:43 +00:00
|
|
|
/*
|
2021-05-29 10:38:28 +00:00
|
|
|
* Copyright (c) 2020, Stephan Unverwerth <s.unverwerth@serenityos.org>
|
2020-03-11 18:27:43 +00:00
|
|
|
*
|
2021-04-22 08:24:48 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
2020-03-11 18:27:43 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2020-10-08 17:49:08 +00:00
|
|
|
#include <AK/HashTable.h>
|
2020-03-18 10:23:53 +00:00
|
|
|
#include <AK/NonnullRefPtr.h>
|
2020-05-26 11:57:50 +00:00
|
|
|
#include <AK/StringBuilder.h>
|
2020-05-28 05:22:08 +00:00
|
|
|
#include <LibJS/AST.h>
|
|
|
|
#include <LibJS/Lexer.h>
|
2020-12-28 17:15:22 +00:00
|
|
|
#include <LibJS/SourceRange.h>
|
2020-05-14 15:26:01 +00:00
|
|
|
#include <stdio.h>
|
2020-03-11 18:27:43 +00:00
|
|
|
|
|
|
|
namespace JS {
|
2020-03-12 22:02:41 +00:00
|
|
|
|
|
|
|
enum class Associativity {
|
|
|
|
Left,
|
|
|
|
Right
|
|
|
|
};
|
|
|
|
|
2020-10-20 16:56:49 +00:00
|
|
|
struct FunctionNodeParseOptions {
|
|
|
|
enum {
|
|
|
|
CheckForFunctionAndName = 1 << 0,
|
|
|
|
AllowSuperPropertyLookup = 1 << 1,
|
|
|
|
AllowSuperConstructorCall = 1 << 2,
|
2020-10-20 17:32:51 +00:00
|
|
|
IsGetterFunction = 1 << 3,
|
|
|
|
IsSetterFunction = 1 << 4,
|
2020-10-25 11:14:04 +00:00
|
|
|
IsArrowFunction = 1 << 5,
|
2021-06-14 10:22:59 +00:00
|
|
|
IsGeneratorFunction = 1 << 6,
|
2020-10-20 16:56:49 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
2020-03-11 18:27:43 +00:00
|
|
|
class Parser {
|
|
|
|
public:
|
2021-08-14 15:30:37 +00:00
|
|
|
explicit Parser(Lexer lexer, Program::Type program_type = Program::Type::Script);
|
2020-03-11 18:27:43 +00:00
|
|
|
|
2021-06-20 03:13:53 +00:00
|
|
|
NonnullRefPtr<Program> parse_program(bool starts_in_strict_mode = false);
|
2020-03-11 18:27:43 +00:00
|
|
|
|
2020-03-19 10:52:56 +00:00
|
|
|
template<typename FunctionNodeType>
|
2020-10-20 16:56:49 +00:00
|
|
|
NonnullRefPtr<FunctionNodeType> parse_function_node(u8 parse_options = FunctionNodeParseOptions::CheckForFunctionAndName);
|
2021-05-29 11:33:19 +00:00
|
|
|
Vector<FunctionNode::Parameter> parse_formal_parameters(int& function_length, u8 parse_options = 0);
|
2021-07-28 23:49:25 +00:00
|
|
|
RefPtr<BindingPattern> parse_binding_pattern(bool strict_checks = false);
|
2020-03-19 10:52:56 +00:00
|
|
|
|
2021-06-14 11:16:41 +00:00
|
|
|
struct PrimaryExpressionParseResult {
|
|
|
|
NonnullRefPtr<Expression> result;
|
|
|
|
bool should_continue_parsing_as_expression { true };
|
|
|
|
};
|
|
|
|
|
2020-10-22 22:30:07 +00:00
|
|
|
NonnullRefPtr<Declaration> parse_declaration();
|
2021-07-24 23:01:22 +00:00
|
|
|
|
|
|
|
enum class AllowLabelledFunction {
|
|
|
|
No,
|
|
|
|
Yes
|
|
|
|
};
|
|
|
|
|
|
|
|
NonnullRefPtr<Statement> parse_statement(AllowLabelledFunction allow_labelled_function = AllowLabelledFunction::No);
|
2020-03-18 10:23:53 +00:00
|
|
|
NonnullRefPtr<BlockStatement> parse_block_statement();
|
2021-08-28 15:04:37 +00:00
|
|
|
NonnullRefPtr<BlockStatement> parse_block_statement(bool& is_strict, bool function_with_non_simple_parameter_list = false);
|
2020-03-18 10:23:53 +00:00
|
|
|
NonnullRefPtr<ReturnStatement> parse_return_statement();
|
2020-10-30 19:08:45 +00:00
|
|
|
NonnullRefPtr<VariableDeclaration> parse_variable_declaration(bool for_loop_variable_declaration = false);
|
2020-04-21 18:21:26 +00:00
|
|
|
NonnullRefPtr<Statement> parse_for_statement();
|
|
|
|
NonnullRefPtr<Statement> parse_for_in_of_statement(NonnullRefPtr<ASTNode> lhs);
|
2020-03-21 17:40:17 +00:00
|
|
|
NonnullRefPtr<IfStatement> parse_if_statement();
|
2020-03-24 21:03:50 +00:00
|
|
|
NonnullRefPtr<ThrowStatement> parse_throw_statement();
|
2020-03-24 13:03:55 +00:00
|
|
|
NonnullRefPtr<TryStatement> parse_try_statement();
|
|
|
|
NonnullRefPtr<CatchClause> parse_catch_clause();
|
2020-03-29 11:09:54 +00:00
|
|
|
NonnullRefPtr<SwitchStatement> parse_switch_statement();
|
|
|
|
NonnullRefPtr<SwitchCase> parse_switch_case();
|
|
|
|
NonnullRefPtr<BreakStatement> parse_break_statement();
|
2020-04-04 22:22:42 +00:00
|
|
|
NonnullRefPtr<ContinueStatement> parse_continue_statement();
|
2020-04-04 19:29:23 +00:00
|
|
|
NonnullRefPtr<DoWhileStatement> parse_do_while_statement();
|
2020-04-21 18:27:57 +00:00
|
|
|
NonnullRefPtr<WhileStatement> parse_while_statement();
|
2020-11-28 14:05:57 +00:00
|
|
|
NonnullRefPtr<WithStatement> parse_with_statement();
|
2020-04-30 16:26:27 +00:00
|
|
|
NonnullRefPtr<DebuggerStatement> parse_debugger_statement();
|
2020-04-03 10:14:28 +00:00
|
|
|
NonnullRefPtr<ConditionalExpression> parse_conditional_expression(NonnullRefPtr<Expression> test);
|
2021-02-24 08:58:24 +00:00
|
|
|
NonnullRefPtr<Expression> parse_expression(int min_precedence, Associativity associate = Associativity::Right, const Vector<TokenType>& forbidden = {});
|
2021-06-14 11:16:41 +00:00
|
|
|
PrimaryExpressionParseResult parse_primary_expression();
|
2020-03-18 10:23:53 +00:00
|
|
|
NonnullRefPtr<Expression> parse_unary_prefixed_expression();
|
2020-06-03 23:05:49 +00:00
|
|
|
NonnullRefPtr<RegExpLiteral> parse_regexp_literal();
|
2020-03-18 10:23:53 +00:00
|
|
|
NonnullRefPtr<ObjectExpression> parse_object_expression();
|
2020-03-20 19:29:57 +00:00
|
|
|
NonnullRefPtr<ArrayExpression> parse_array_expression();
|
2021-02-24 08:58:24 +00:00
|
|
|
NonnullRefPtr<StringLiteral> parse_string_literal(const Token& token, bool in_template_literal = false);
|
2020-05-06 23:34:14 +00:00
|
|
|
NonnullRefPtr<TemplateLiteral> parse_template_literal(bool is_tagged);
|
2020-03-18 10:23:53 +00:00
|
|
|
NonnullRefPtr<Expression> parse_secondary_expression(NonnullRefPtr<Expression>, int min_precedence, Associativity associate = Associativity::Right);
|
|
|
|
NonnullRefPtr<CallExpression> parse_call_expression(NonnullRefPtr<Expression>);
|
2020-03-28 15:33:52 +00:00
|
|
|
NonnullRefPtr<NewExpression> parse_new_expression();
|
2020-06-08 18:31:21 +00:00
|
|
|
NonnullRefPtr<ClassDeclaration> parse_class_declaration();
|
|
|
|
NonnullRefPtr<ClassExpression> parse_class_expression(bool expect_class_name);
|
2021-06-10 21:08:30 +00:00
|
|
|
NonnullRefPtr<YieldExpression> parse_yield_expression();
|
2020-06-08 18:31:21 +00:00
|
|
|
NonnullRefPtr<Expression> parse_property_key();
|
2020-10-04 22:58:57 +00:00
|
|
|
NonnullRefPtr<AssignmentExpression> parse_assignment_expression(AssignmentOp, NonnullRefPtr<Expression> lhs, int min_precedence, Associativity);
|
2021-06-13 01:04:28 +00:00
|
|
|
NonnullRefPtr<Identifier> parse_identifier();
|
2021-08-14 15:42:30 +00:00
|
|
|
NonnullRefPtr<ImportStatement> parse_import_statement(Program& program);
|
|
|
|
NonnullRefPtr<ExportStatement> parse_export_statement(Program& program);
|
2020-03-11 18:27:43 +00:00
|
|
|
|
2020-11-02 21:27:42 +00:00
|
|
|
RefPtr<FunctionExpression> try_parse_arrow_function_expression(bool expect_parens);
|
2021-07-24 23:01:22 +00:00
|
|
|
RefPtr<Statement> try_parse_labelled_statement(AllowLabelledFunction allow_function);
|
2020-11-02 21:27:42 +00:00
|
|
|
RefPtr<MetaProperty> try_parse_new_target_expression();
|
|
|
|
|
2020-11-02 21:03:19 +00:00
|
|
|
struct Error {
|
|
|
|
String message;
|
|
|
|
Optional<Position> position;
|
2020-05-14 15:26:01 +00:00
|
|
|
|
|
|
|
String to_string() const
|
|
|
|
{
|
2020-11-02 21:03:19 +00:00
|
|
|
if (!position.has_value())
|
2020-05-14 15:26:01 +00:00
|
|
|
return message;
|
2020-11-02 21:03:19 +00:00
|
|
|
return String::formatted("{} (line: {}, column: {})", message, position.value().line, position.value().column);
|
2020-05-14 15:26:01 +00:00
|
|
|
}
|
2020-05-26 11:57:50 +00:00
|
|
|
|
|
|
|
String source_location_hint(const StringView& source, const char spacer = ' ', const char indicator = '^') const
|
|
|
|
{
|
2020-11-02 21:03:19 +00:00
|
|
|
if (!position.has_value())
|
2020-05-26 11:57:50 +00:00
|
|
|
return {};
|
2021-07-20 16:53:48 +00:00
|
|
|
// We need to modify the source to match what the lexer considers one line - normalizing
|
|
|
|
// line terminators to \n is easier than splitting using all different LT characters.
|
2021-07-19 15:56:21 +00:00
|
|
|
String source_string { source };
|
2021-07-20 16:53:48 +00:00
|
|
|
source_string.replace("\r\n", "\n");
|
|
|
|
source_string.replace("\r", "\n");
|
2021-08-14 15:07:47 +00:00
|
|
|
source_string.replace(LINE_SEPARATOR_STRING, "\n");
|
|
|
|
source_string.replace(PARAGRAPH_SEPARATOR_STRING, "\n");
|
2021-07-20 16:53:48 +00:00
|
|
|
StringBuilder builder;
|
|
|
|
builder.append(source_string.split_view('\n', true)[position.value().line - 1]);
|
2020-05-26 11:57:50 +00:00
|
|
|
builder.append('\n');
|
2020-11-02 21:03:19 +00:00
|
|
|
for (size_t i = 0; i < position.value().column - 1; ++i)
|
2020-05-26 11:57:50 +00:00
|
|
|
builder.append(spacer);
|
|
|
|
builder.append(indicator);
|
|
|
|
return builder.build();
|
|
|
|
}
|
2020-05-14 15:26:01 +00:00
|
|
|
};
|
|
|
|
|
2021-06-19 12:43:09 +00:00
|
|
|
bool has_errors() const { return m_state.errors.size(); }
|
|
|
|
const Vector<Error>& errors() const { return m_state.errors; }
|
2021-07-19 15:56:21 +00:00
|
|
|
void print_errors(bool print_hint = true) const
|
2020-05-14 15:26:01 +00:00
|
|
|
{
|
2021-06-19 12:43:09 +00:00
|
|
|
for (auto& error : m_state.errors) {
|
2021-07-19 15:56:21 +00:00
|
|
|
if (print_hint) {
|
|
|
|
auto hint = error.source_location_hint(m_state.lexer.source());
|
|
|
|
if (!hint.is_empty())
|
|
|
|
warnln("{}", hint);
|
|
|
|
}
|
2020-12-06 14:50:39 +00:00
|
|
|
warnln("SyntaxError: {}", error.to_string());
|
|
|
|
}
|
2020-05-14 15:26:01 +00:00
|
|
|
}
|
2020-03-11 18:27:43 +00:00
|
|
|
|
2021-04-11 20:41:51 +00:00
|
|
|
struct TokenMemoization {
|
|
|
|
bool try_parse_arrow_function_expression_failed;
|
|
|
|
};
|
|
|
|
|
2020-03-11 18:27:43 +00:00
|
|
|
private:
|
2020-04-13 14:42:54 +00:00
|
|
|
friend class ScopePusher;
|
|
|
|
|
2020-03-12 22:02:41 +00:00
|
|
|
Associativity operator_associativity(TokenType) const;
|
2020-03-11 18:27:43 +00:00
|
|
|
bool match_expression() const;
|
2020-03-14 18:45:51 +00:00
|
|
|
bool match_unary_prefixed_expression() const;
|
2021-02-24 08:58:24 +00:00
|
|
|
bool match_secondary_expression(const Vector<TokenType>& forbidden = {}) const;
|
2020-03-11 18:27:43 +00:00
|
|
|
bool match_statement() const;
|
2021-08-14 15:42:30 +00:00
|
|
|
bool match_export_or_import() const;
|
2021-07-29 00:03:16 +00:00
|
|
|
bool match_declaration();
|
|
|
|
bool try_match_let_declaration();
|
|
|
|
bool match_variable_declaration();
|
2021-07-11 11:04:55 +00:00
|
|
|
bool match_identifier() const;
|
2020-04-18 18:31:27 +00:00
|
|
|
bool match_identifier_name() const;
|
2020-06-08 18:31:21 +00:00
|
|
|
bool match_property_key() const;
|
2020-03-11 18:27:43 +00:00
|
|
|
bool match(TokenType type) const;
|
|
|
|
bool done() const;
|
|
|
|
void expected(const char* what);
|
2020-11-02 21:03:19 +00:00
|
|
|
void syntax_error(const String& message, Optional<Position> = {});
|
2020-03-11 18:27:43 +00:00
|
|
|
Token consume();
|
2021-07-11 11:04:55 +00:00
|
|
|
Token consume_identifier();
|
|
|
|
Token consume_identifier_reference();
|
2020-03-11 18:27:43 +00:00
|
|
|
Token consume(TokenType type);
|
2020-10-19 17:01:28 +00:00
|
|
|
Token consume_and_validate_numeric_literal();
|
2020-04-17 13:05:58 +00:00
|
|
|
void consume_or_insert_semicolon();
|
2020-03-30 13:24:43 +00:00
|
|
|
void save_state();
|
|
|
|
void load_state();
|
2020-12-29 13:17:39 +00:00
|
|
|
void discard_saved_state();
|
2020-11-02 21:03:19 +00:00
|
|
|
Position position() const;
|
2020-03-11 18:27:43 +00:00
|
|
|
|
2021-08-28 15:04:37 +00:00
|
|
|
Token next_token();
|
|
|
|
|
2021-07-11 23:27:35 +00:00
|
|
|
void check_identifier_name_for_assignment_validity(StringView, bool force_strict = false);
|
2021-07-11 11:04:55 +00:00
|
|
|
|
2021-04-11 20:41:51 +00:00
|
|
|
bool try_parse_arrow_function_expression_failed_at_position(const Position&) const;
|
|
|
|
void set_try_parse_arrow_function_expression_failed_at_position(const Position&, bool);
|
|
|
|
|
2020-12-28 17:15:22 +00:00
|
|
|
struct RulePosition {
|
2020-12-29 05:12:02 +00:00
|
|
|
AK_MAKE_NONCOPYABLE(RulePosition);
|
|
|
|
AK_MAKE_NONMOVABLE(RulePosition);
|
|
|
|
|
|
|
|
public:
|
2020-12-28 17:15:22 +00:00
|
|
|
RulePosition(Parser& parser, Position position)
|
|
|
|
: m_parser(parser)
|
|
|
|
, m_position(position)
|
|
|
|
{
|
2020-12-29 13:17:39 +00:00
|
|
|
m_parser.m_rule_starts.append(position);
|
2020-12-28 17:15:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
~RulePosition()
|
|
|
|
{
|
2020-12-29 13:17:39 +00:00
|
|
|
auto last = m_parser.m_rule_starts.take_last();
|
2021-02-23 19:42:32 +00:00
|
|
|
VERIFY(last.line == m_position.line);
|
|
|
|
VERIFY(last.column == m_position.column);
|
2020-12-28 17:15:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
const Position& position() const { return m_position; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
Parser& m_parser;
|
|
|
|
Position m_position;
|
|
|
|
};
|
|
|
|
|
|
|
|
[[nodiscard]] RulePosition push_start() { return { *this, position() }; }
|
|
|
|
|
2021-07-04 01:15:52 +00:00
|
|
|
struct Scope : public RefCounted<Scope> {
|
|
|
|
enum Type {
|
|
|
|
Function,
|
|
|
|
Block,
|
|
|
|
};
|
2021-07-05 19:45:34 +00:00
|
|
|
struct HoistableDeclaration {
|
|
|
|
NonnullRefPtr<FunctionDeclaration> declaration;
|
|
|
|
NonnullRefPtr<Scope> scope; // where it is actually declared
|
|
|
|
};
|
2021-07-04 01:15:52 +00:00
|
|
|
|
|
|
|
Type type;
|
|
|
|
RefPtr<Scope> parent;
|
|
|
|
|
|
|
|
NonnullRefPtrVector<FunctionDeclaration> function_declarations;
|
2021-07-05 19:45:34 +00:00
|
|
|
Vector<HoistableDeclaration> hoisted_function_declarations;
|
|
|
|
|
|
|
|
HashTable<FlyString> lexical_declarations;
|
2021-07-04 01:15:52 +00:00
|
|
|
|
|
|
|
explicit Scope(Type, RefPtr<Scope>);
|
|
|
|
RefPtr<Scope> get_current_function_scope();
|
|
|
|
};
|
|
|
|
|
2020-03-30 13:24:43 +00:00
|
|
|
struct ParserState {
|
2021-06-19 12:43:09 +00:00
|
|
|
Lexer lexer;
|
|
|
|
Token current_token;
|
|
|
|
Vector<Error> errors;
|
|
|
|
Vector<NonnullRefPtrVector<VariableDeclaration>> var_scopes;
|
|
|
|
Vector<NonnullRefPtrVector<VariableDeclaration>> let_scopes;
|
2021-07-04 01:15:52 +00:00
|
|
|
RefPtr<Scope> current_scope;
|
2021-06-14 07:30:43 +00:00
|
|
|
|
|
|
|
Vector<Vector<FunctionNode::Parameter>&> function_parameters;
|
|
|
|
|
2021-08-28 15:04:37 +00:00
|
|
|
HashMap<StringView, bool> labels_in_scope;
|
2021-06-19 12:43:09 +00:00
|
|
|
bool strict_mode { false };
|
|
|
|
bool allow_super_property_lookup { false };
|
|
|
|
bool allow_super_constructor_call { false };
|
|
|
|
bool in_function_context { false };
|
2021-08-21 09:31:36 +00:00
|
|
|
bool in_formal_parameter_context { false };
|
2021-06-19 12:43:09 +00:00
|
|
|
bool in_generator_function_context { false };
|
|
|
|
bool in_arrow_function_context { false };
|
|
|
|
bool in_break_context { false };
|
|
|
|
bool in_continue_context { false };
|
|
|
|
bool string_legacy_octal_escape_sequence_in_scope { false };
|
2021-08-28 15:11:05 +00:00
|
|
|
bool in_class_field_initializer { false };
|
2020-03-30 13:24:43 +00:00
|
|
|
|
2021-08-14 15:30:37 +00:00
|
|
|
ParserState(Lexer, Program::Type);
|
2020-03-30 13:24:43 +00:00
|
|
|
};
|
|
|
|
|
2021-04-11 20:41:51 +00:00
|
|
|
class PositionKeyTraits {
|
|
|
|
public:
|
|
|
|
static int hash(const Position& position)
|
|
|
|
{
|
|
|
|
return int_hash(position.line) ^ int_hash(position.column);
|
|
|
|
}
|
|
|
|
|
|
|
|
static bool equals(const Position& a, const Position& b)
|
|
|
|
{
|
|
|
|
return a.column == b.column && a.line == b.line;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2020-12-29 13:17:39 +00:00
|
|
|
Vector<Position> m_rule_starts;
|
2021-06-19 12:43:09 +00:00
|
|
|
ParserState m_state;
|
2021-02-28 09:42:34 +00:00
|
|
|
FlyString m_filename;
|
2020-05-02 18:46:39 +00:00
|
|
|
Vector<ParserState> m_saved_state;
|
2021-04-11 20:41:51 +00:00
|
|
|
HashMap<Position, TokenMemoization, PositionKeyTraits> m_token_memoizations;
|
2021-08-14 15:30:37 +00:00
|
|
|
Program::Type m_program_type;
|
2020-03-11 18:27:43 +00:00
|
|
|
};
|
|
|
|
}
|