xref: /arkcompiler/ets_frontend/es2panda/binder/binder.cpp (revision 3af6ab5f)

/**
 * Copyright (c) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "binder.h"

#include "binder/scope.h"
#include "binder/tsBinding.h"
#include "es2panda.h"
#include "ir/astNode.h"
#include "ir/base/annotation.h"
#include "ir/base/catchClause.h"
#include "ir/base/classDefinition.h"
#include "ir/base/classProperty.h"
#include "ir/base/methodDefinition.h"
#include "ir/base/property.h"
#include "ir/base/scriptFunction.h"
#include "ir/base/spreadElement.h"
#include "ir/expressions/arrayExpression.h"
#include "ir/expressions/assignmentExpression.h"
#include "ir/expressions/callExpression.h"
#include "ir/expressions/identifier.h"
#include "ir/expressions/objectExpression.h"
#include "ir/expressions/privateIdentifier.h"
#include "ir/expressions/literals/numberLiteral.h"
#include "ir/module/exportNamedDeclaration.h"
#include "ir/module/exportSpecifier.h"
#include "ir/statements/blockStatement.h"
#include "ir/statements/classDeclaration.h"
#include "ir/statements/doWhileStatement.h"
#include "ir/statements/forInStatement.h"
#include "ir/statements/forOfStatement.h"
#include "ir/statements/forUpdateStatement.h"
#include "ir/statements/ifStatement.h"
#include "ir/statements/switchCaseStatement.h"
#include "ir/statements/switchStatement.h"
#include "ir/statements/variableDeclaration.h"
#include "ir/statements/variableDeclarator.h"
#include "ir/statements/whileStatement.h"
#include "ir/ts/tsClassImplements.h"
#include "ir/ts/tsConstructorType.h"
#include "ir/ts/tsEnumDeclaration.h"
#include "ir/ts/tsFunctionType.h"
#include "ir/ts/tsIndexSignature.h"
#include "ir/ts/tsMethodSignature.h"
#include "ir/ts/tsModuleBlock.h"
#include "ir/ts/tsModuleDeclaration.h"
#include "ir/ts/tsSignatureDeclaration.h"
#include "ir/ts/tsTypeParameterDeclaration.h"
#include "ir/ts/tsTypeParameterInstantiation.h"
#include "util/concurrent.h"
#include "util/patchFix.h"

namespace panda::es2panda::binder {
void Binder::InitTopScope()
{
    if (program_->Kind() == parser::ScriptKind::MODULE) {
        topScope_ = Allocator()->New<ModuleScope>(Allocator(), program_);
    } else {
        topScope_ = Allocator()->New<GlobalScope>(Allocator());
    }

    scope_ = topScope_;
}

ParameterDecl *Binder::AddParamDecl(const ir::AstNode *param)
{
    ASSERT(scope_->IsFunctionParamScope() || scope_->IsCatchParamScope());
    auto [decl, node] = static_cast<ParamScope *>(scope_)->AddParamDecl(Allocator(), param);

    if (!node) {
        return decl;
    }

    ThrowRedeclaration(node->Start(), decl->Name());
}

void Binder::ThrowRedeclaration(const lexer::SourcePosition &pos, const util::StringView &name)
{
    lexer::LineIndex index(program_->SourceCode());
    lexer::SourceLocation loc = index.GetLocation(pos);

    std::stringstream ss;
    ss << "Variable '" << name << "' has already been declared.";
    throw Error(ErrorType::SYNTAX, ss.str(), loc.line, loc.col);
}

void Binder::ThrowUndeclaredExport(const lexer::SourcePosition &pos, const util::StringView &name)
{
    lexer::LineIndex index(program_->SourceCode());
    lexer::SourceLocation loc = index.GetLocation(pos);

    std::stringstream ss;
    ss << "Export name '" << name << "' is not defined.";
    throw Error(ErrorType::SYNTAX, ss.str(), loc.line, loc.col);
}

void Binder::ThrowInvalidDstrTarget(const lexer::SourcePosition &pos, const util::StringView &name)
{
    lexer::LineIndex index(program_->SourceCode());
    lexer::SourceLocation loc = index.GetLocation(pos);

    std::stringstream ss;
    ss << "Invalid destructuring assignment target: " << name;
    throw Error(ErrorType::SYNTAX, ss.str(), loc.line, loc.col);
}

void Binder::ThrowInvalidAnnotationDeclaration(const lexer::SourcePosition &pos, const util::StringView &name)
{
    lexer::LineIndex index(program_->SourceCode());
    lexer::SourceLocation loc = index.GetLocation(pos);

    std::stringstream ss;
    ss << "Invalid annotation declaration: " << name;
    throw Error(ErrorType::SYNTAX, ss.str(), loc.line, loc.col);
}

void Binder::CheckMandatoryArguments(const ir::Identifier *ident)
{
    const auto *iter = static_cast<const ir::AstNode *>(ident);
    bool isPatternMember = false;
    while (iter) {
        if (iter->IsArrayExpression() || iter->IsArrayPattern()) {
            isPatternMember = true;
            break;
        }

        if (iter->IsObjectExpression() || iter->IsObjectPattern()) {
            auto &properties = iter->IsObjectExpression() ? iter->AsObjectExpression()->Properties() :
                                                            iter->AsObjectPattern()->Properties();
            isPatternMember = util::Helpers::IsObjectPropertyValue(properties, ident);
            break;
        }
        iter = iter->Parent();
    }

    if (!isPatternMember) {
        return;
    }

    auto *patternNode = iter;

    while (iter) {
        if (iter->IsAssignmentExpression() || iter->IsVariableDeclarator() || iter->IsForInStatement() ||
            iter->IsForOfStatement()) {
            break;
        }

        iter = iter->Parent();
    }

    if (!iter) {
        return;
    }

    const ir::AstNode *potentialParent = iter;

    if (iter->IsAssignmentExpression()) {
        potentialParent = iter->AsAssignmentExpression()->Left();
    } else if (iter->IsVariableDeclarator()) {
        potentialParent = iter->AsVariableDeclarator()->Id();
    } else {
        potentialParent = iter->IsForInStatement() ? iter->AsForInStatement()->Left() :
                                                     iter->AsForOfStatement()->Left();
    }

    if (!util::Helpers::IsChild(potentialParent, patternNode)) {
        return;
    }

    ThrowInvalidDstrTarget(ident->Start(), ident->Name());
}

void Binder::AssignIndexToModuleVariable()
{
    ASSERT(program_->ModuleRecord());
    program_->ModuleRecord()->AssignIndexToModuleVariable(topScope_->AsModuleScope());
}

void Binder::IdentifierAnalysis(ResolveBindingFlags flags)
{
    ASSERT(program_->Ast());
    ASSERT(scope_ == topScope_);

    bindingFlags_ = flags;
    // Bind function main0 first to determine whether a lexical variable is in it or not under hot-reload mode
    if (bindingFlags_ & ResolveBindingFlags::TS_BEFORE_TRANSFORM) {
        BuildFunction(topScope_, MAIN_FUNC_NAME);
        ResolveReferences(program_->Ast());
    } else if (bindingFlags_ & ResolveBindingFlags::TS_AFTER_TRANSFORM) {
        // Basically same as js, except of function main0 will not be bound after transform
        ResolveReferences(program_->Ast());
        AddMandatoryParams();
        if (topScope_->IsModuleScope()) {
            AssignIndexToModuleVariable();
        }
    } else if (bindingFlags_ & ResolveBindingFlags::ALL) {
        BuildFunction(topScope_, MAIN_FUNC_NAME);
        ResolveReferences(program_->Ast());
        AddMandatoryParams();
        if (topScope_->IsModuleScope()) {
            AssignIndexToModuleVariable();
        }
    }
}

void Binder::ValidateExportDecl(const ir::ExportNamedDeclaration *exportDecl)
{
    if (exportDecl->Source() != nullptr || exportDecl->Decl() != nullptr || exportDecl->IsType()) {
        return;
    }

    ASSERT(topScope_->IsModuleScope());
    for (auto *it : exportDecl->Specifiers()) {
        if (it->AsExportSpecifier()->IsType()) {
            continue;
        }

        auto localName = it->AsExportSpecifier()->Local()->Name();
        if (scope_->IsTSModuleScope()) {
            auto currentScope = scope_;
            while (currentScope != nullptr) {
                if (currentScope->FindLocal(localName, ResolveBindingOptions::ALL) != nullptr ||
                    (currentScope->IsTSModuleScope() && (currentScope->InLocalTSBindings(localName) ||
                    currentScope->AsTSModuleScope()->InExportBindings(localName)))) {
                    break;
                }
                currentScope = currentScope->Parent();
            }
            if (currentScope != nullptr) {
                continue;
            }
            ThrowUndeclaredExport(it->AsExportSpecifier()->Local()->Start(), localName);
        }
        ASSERT(topScope_ == scope_);
        if (scope_->FindLocal(localName) == nullptr) {
            // The declaration of ts cannot correspond to the variables of ts before transform,
            // After the transform, they are all js variables. So it can return directly here.
            if (scope_->InLocalTSBindings(localName) ||
                scope_->FindLocal(localName, ResolveBindingOptions::INTERFACES)) {
                continue;
            }
            ThrowUndeclaredExport(it->AsExportSpecifier()->Local()->Start(), localName);
        }
        scope_->AsModuleScope()->ConvertLocalVariableToModuleVariable(Allocator(), localName);
    }
}

void Binder::LookupReference(const util::StringView &name)
{
    ScopeFindResult res = scope_->Find(name);
    if (res.level == 0) {
        return;
    }

    ASSERT(res.variable);
    res.variable->SetLexical(res.scope, program_->PatchFixHelper());
}

void Binder::InstantiateArguments()
{
    auto *iter = scope_;
    while (true) {
        Scope *scope = iter->IsFunctionParamScope() ? iter : iter->EnclosingVariableScope();
        CHECK_NOT_NULL(scope);

        const auto *node = scope->Node();

        if (scope->IsLoopScope()) {
            iter = scope->Parent();
            continue;
        }

        if (!node->IsScriptFunction()) {
            break;
        }

        if (!node->AsScriptFunction()->IsArrow()) {
            auto *argumentsVariable =
                scope->AddDecl<ConstDecl, LocalVariable>(Allocator(), FUNCTION_ARGUMENTS, VariableFlags::INITIALIZED);

            if (iter->IsFunctionParamScope()) {
                if (!argumentsVariable) {
                    break;
                }

                scope = iter->AsFunctionParamScope()->GetFunctionScope();
                scope->Bindings().insert({argumentsVariable->Name(), argumentsVariable});
            }

            scope->AsVariableScope()->AddFlag(VariableScopeFlags::USE_ARGS);

            break;
        }

        iter = scope->Parent();
    }
}

void Binder::LookupIdentReference(ir::Identifier *ident)
{
    if (ident->Name().Is(FUNCTION_ARGUMENTS)) {
        InstantiateArguments();
    }

    ScopeFindResult res;
    if (bindingFlags_ & ResolveBindingFlags::TS_BEFORE_TRANSFORM) {
        ident->SetTSVariables(FindIdentifierTSVariables(ident, scope_, res));
    } else {
        if (ident->Parent()->IsTSTypeReference()) {
            res = scope_->Find(ident->Name(), ResolveBindingOptions::ALL);
        } else {
            res = scope_->Find(ident->Name(), ResolveBindingOptions::BINDINGS);
        }
    }

    if (res.variable == nullptr) {
        return;
    }

    if (res.level != 0) {
        if (!res.variable->Declaration()->IsDeclare() && !ident->Parent()->IsTSTypeReference() &&
            !ident->Parent()->IsTSTypeQuery() && !(bindingFlags_ & ResolveBindingFlags::TS_BEFORE_TRANSFORM)) {
            util::Concurrent::ProcessConcurrent(Program()->GetLineIndex(), ident, res, program_);
            res.variable->SetLexical(res.scope, program_->PatchFixHelper());
        }
    }

    auto decl = res.variable->Declaration();
    if (decl->IsLetOrConstOrClassDecl() && !decl->HasFlag(DeclarationFlags::NAMESPACE_IMPORT) &&
        !res.variable->HasFlag(VariableFlags::INITIALIZED)) {
        ident->SetTdz();
    }
    // in release mode, replace const reference with its initialization
    if (!this->Program()->IsDebug() && decl->IsConstDecl()) {
        ReplaceConstReferenceWithInitialization(ident, decl);
    }

    ident->SetVariable(res.variable);
}

void Binder::StoreAndCheckSpecialFunctionName(std::string &internalNameStr, std::string recordName)
{
    if (program_->PatchFixHelper()) {
        if (program_->PatchFixHelper()->IsDumpSymbolTable()) {
            // anonymous, special-name and duplicate function index started from 1
            specialFuncNameIndexMap_.insert({internalNameStr, std::to_string(++globalIndexForSpecialFunc_)});
            return;
        }
        if (program_->PatchFixHelper()->IsHotFix()) {
            // Adding/removing anonymous, special or duplicate functions is supported for hotReload and coldFix mode,
            // but forbidden in hotFix mode
            program_->PatchFixHelper()->CheckAndRestoreSpecialFunctionName(++globalIndexForSpecialFunc_,
                internalNameStr, recordName);
            return;
        }
        // else: must be coldfix or hotreload mode or coldreload mode
        ASSERT(program_->PatchFixHelper()->IsColdFix() || program_->PatchFixHelper()->IsHotReload() ||
               program_->PatchFixHelper()->IsColdReload());
    }
}

void Binder::BuildFunction(FunctionScope *funcScope, util::StringView name, const ir::ScriptFunction *func)
{
    if (funcScope->InFunctionScopes()) {
        return;
    }
    functionScopes_.push_back(funcScope);
    funcScope->SetInFunctionScopes();
    if (!util::Helpers::IsDefaultApiVersion(Program()->TargetApiVersion(), Program()->GetTargetApiSubVersion())) {
        funcScope->SetSelfScopeName(name);
        auto recordName = program_->FormatedRecordName().Mutf8();
        funcScope->BindNameWithScopeInfo(name, util::UString(recordName, Allocator()).View());
        if (func && (name == ANONYMOUS_FUNC_NAME)) {
            anonymousFunctionNames_[func] = util::UString(funcScope->InternalName().Mutf8(), Allocator()).View();
        }
    } else {
        LegacyBuildFunction(funcScope, name, func);
    }
}

void Binder::LegacyBuildFunction(FunctionScope *funcScope, util::StringView name, const ir::ScriptFunction *func)
{
    bool funcNameWithoutDot = (name.Find(".") == std::string::npos);
    bool funcNameWithoutBackslash = (name.Find("\\") == std::string::npos);
    if (name != ANONYMOUS_FUNC_NAME && funcNameWithoutDot &&
        funcNameWithoutBackslash && !functionNames_.count(name)) {
        // function with normal name, and hasn't been recorded
        auto internalName = std::string(program_->FormatedRecordName()) + std::string(name);
        functionNames_.insert(name);
        funcScope->BindName(name, util::UString(internalName, Allocator()).View());
        return;
    }

    std::stringstream ss;
    ss << std::string(program_->FormatedRecordName());

    ASSERT(func != nullptr);

    // For anonymous, special-name and duplicate function, get its source and name, make hash code,
    // and make #hash_duplicateHashTime#name as its name;
    auto funcContentNameStr = func->SourceCode(this).Mutf8() + name.Mutf8();
    ss << ANONYMOUS_SPECIAL_DUPLICATE_FUNCTION_SPECIFIER << util::Helpers::GetHashString(funcContentNameStr);

    auto res = functionHashNames_.find(funcContentNameStr);
    if (res != functionHashNames_.end()) {
        ss << "_" << res->second++;
    } else {
        functionHashNames_.insert({funcContentNameStr, 1});
    }
    ss << ANONYMOUS_SPECIAL_DUPLICATE_FUNCTION_SPECIFIER;

    if (name == ANONYMOUS_FUNC_NAME) {
        anonymousFunctionNames_[func] = util::UString(ss.str(), Allocator()).View();
    }
    if (funcNameWithoutDot && funcNameWithoutBackslash) {
        ss << name;
    }
    std::string internalNameStr = ss.str();
    StoreAndCheckSpecialFunctionName(internalNameStr, program_->RecordName().Mutf8());
    funcScope->BindName(name, util::UString(internalNameStr, Allocator()).View());
}

void Binder::BuildScriptFunction(Scope *outerScope, const ir::ScriptFunction *scriptFunc)
{
    if (bindingFlags_ & ResolveBindingFlags::TS_BEFORE_TRANSFORM) {
        return;
    }

    auto *funcScope = scriptFunc->Scope();
    funcScope->ParamScope()->SetParent(outerScope);

    if (scriptFunc->IsArrow()) {
        const ir::ScriptFunction *ctor = util::Helpers::GetContainingConstructor(scriptFunc);
        if (ctor) {
            ctor->Scope()->AddFlag(VariableScopeFlags::INNER_ARROW);
        }
    }

    ASSERT(scope_->IsFunctionScope() || scope_->IsTSModuleScope() || scope_->IsTSEnumScope());
    BuildFunction(scope_->AsFunctionVariableScope(), util::Helpers::FunctionName(Allocator(), scriptFunc), scriptFunc);
}

void Binder::BuildVarDeclaratorId(const ir::AstNode *parent, ir::AstNode *childNode)
{
    childNode->SetParent(parent);

    switch (childNode->Type()) {
        case ir::AstNodeType::IDENTIFIER: {
            auto *ident = childNode->AsIdentifier();
            const auto &name = ident->Name();
            if (name.Is(FUNCTION_ARGUMENTS)) {
                CheckMandatoryArguments(ident);
            }

            if (util::Helpers::IsGlobalIdentifier(name)) {
                break;
            }

            auto *variable = scope_->FindLocal(name, ResolveBindingOptions::BINDINGS);

            if (Program()->Extension() == ScriptExtension::TS) {
                ident->SetVariable(variable);
                BuildTSSignatureDeclarationBaseParamsWithParent(ident, ident->TypeAnnotation());
            }

            variable->AddFlag(VariableFlags::INITIALIZED);
            break;
        }
        case ir::AstNodeType::OBJECT_PATTERN: {
            auto *objPattern = childNode->AsObjectPattern();

            for (auto *prop : objPattern->Properties()) {
                BuildVarDeclaratorId(childNode, prop);
            }

            BuildTSSignatureDeclarationBaseParamsWithParent(objPattern, objPattern->TypeAnnotation());
            break;
        }
        case ir::AstNodeType::ARRAY_PATTERN: {
            auto *arrayPattern = childNode->AsArrayPattern();

            for (auto *element : childNode->AsArrayPattern()->Elements()) {
                BuildVarDeclaratorId(childNode, element);
            }

            BuildTSSignatureDeclarationBaseParamsWithParent(arrayPattern, arrayPattern->TypeAnnotation());
            break;
        }
        case ir::AstNodeType::ASSIGNMENT_PATTERN: {
            ResolveReference(childNode, childNode->AsAssignmentPattern()->Right());
            BuildVarDeclaratorId(childNode, childNode->AsAssignmentPattern()->Left());
            break;
        }
        case ir::AstNodeType::PROPERTY: {
            ResolveReference(childNode, childNode->AsProperty()->Key());
            BuildVarDeclaratorId(childNode, childNode->AsProperty()->Value());
            break;
        }
        case ir::AstNodeType::REST_ELEMENT: {
            BuildVarDeclaratorId(childNode, childNode->AsRestElement()->Argument());
            break;
        }
        default:
            break;
    }
}

void Binder::BuildTSSignatureDeclarationBaseParamsWithParent(const ir::AstNode *parent, ir::AstNode *typeNode)
{
    if (!typeNode) {
        return;
    }
    typeNode->SetParent(parent);
    BuildTSSignatureDeclarationBaseParams(typeNode);
}

void Binder::BuildTSSignatureDeclarationBaseParams(const ir::AstNode *typeNode)
{
    ASSERT(typeNode != nullptr);

    Scope *scope = nullptr;

    switch (typeNode->Type()) {
        case ir::AstNodeType::TS_FUNCTION_TYPE: {
            scope = typeNode->AsTSFunctionType()->Scope();
            break;
        }
        case ir::AstNodeType::TS_CONSTRUCTOR_TYPE: {
            scope = typeNode->AsTSConstructorType()->Scope();
            break;
        }
        case ir::AstNodeType::TS_SIGNATURE_DECLARATION: {
            scope = typeNode->AsTSSignatureDeclaration()->Scope();
            break;
        }
        case ir::AstNodeType::TS_METHOD_SIGNATURE: {
            scope = typeNode->AsTSMethodSignature()->Scope();
            break;
        }
        default: {
            ResolveReferences(typeNode);
            return;
        }
    }

    ASSERT(scope && scope->IsFunctionParamScope());

    auto scopeCtx = LexicalScope<FunctionParamScope>::Enter(this, scope->AsFunctionParamScope());
    ResolveReferences(typeNode);
}

void Binder::BuildVarDeclarator(ir::VariableDeclarator *varDecl)
{
    if (varDecl->Parent()->AsVariableDeclaration()->Kind() == ir::VariableDeclaration::VariableDeclarationKind::VAR) {
        ResolveReferences(varDecl);
        return;
    }

    if (varDecl->Init()) {
        ResolveReference(varDecl, varDecl->Init());
    }

    BuildVarDeclaratorId(varDecl, varDecl->Id());
}

void Binder::BuildClassDefinition(ir::ClassDefinition *classDef)
{
    if (classDef->Parent()->IsClassDeclaration()) {
        util::StringView className = classDef->GetName();
        ASSERT(!className.Empty());
        ScopeFindResult res = scope_->Find(className);

        ASSERT(res.variable && (res.variable->Declaration()->IsClassDecl() ||
               (res.variable->Declaration()->IsFunctionDecl() &&
               res.variable->Declaration()->AsFunctionDecl()->GetDeclClass() != nullptr)));
        res.variable->AddFlag(VariableFlags::INITIALIZED);
    }

    auto scopeCtx = LexicalScope<ClassScope>::Enter(this, classDef->Scope());

    if (classDef->TypeParams()) {
        ResolveReference(classDef, classDef->TypeParams());
    }

    if (classDef->Super()) {
        ResolveReference(classDef, classDef->Super());
    }

    if (classDef->SuperTypeParams()) {
        ResolveReference(classDef, classDef->SuperTypeParams());
    }

    for (auto *iter : classDef->Implements()) {
        ResolveReference(classDef, iter);
    }

    // new class features in ecma2022 are only supported for api11 and above
    if (Program()->TargetApiVersion() > 10 && !(bindingFlags_ & ResolveBindingFlags::TS_BEFORE_TRANSFORM)) {
        classDef->BuildClassEnvironment(program_->UseDefineSemantic());
    }

    if (classDef->Ident()) {
        ScopeFindResult res = scope_->Find(classDef->Ident()->Name());

        ASSERT(res.variable && res.variable->Declaration()->IsConstDecl());
        res.variable->AddFlag(VariableFlags::INITIALIZED);

        classDef->Ident()->SetParent(classDef);
    }
    bool previousInSendableClass = inSendableClass_;

    if (!(classDef->Parent()->IsClassDeclaration() && classDef->Parent()->AsClassDeclaration()->IsAnnotationDecl())) {
        ResolveReference(classDef, classDef->Ctor());
    }

    if (classDef->NeedStaticInitializer()) {
        ResolveReference(classDef, classDef->StaticInitializer());
    }

    if (classDef->NeedInstanceInitializer()) {
        ResolveReference(classDef, classDef->InstanceInitializer());
    }

    for (auto *stmt : classDef->Body()) {
        ResolveReference(classDef, stmt);
    }

    for (auto *iter : classDef->IndexSignatures()) {
        ResolveReference(classDef, iter);
    }
    inSendableClass_ = previousInSendableClass;
}

void Binder::BuildForUpdateLoop(ir::ForUpdateStatement *forUpdateStmt)
{
    auto *loopScope = forUpdateStmt->Scope();

    auto loopCtx = LexicalScope<LoopScope>::Enter(this, loopScope);

    if (forUpdateStmt->Init()) {
        ResolveReference(forUpdateStmt, forUpdateStmt->Init());
    }

    if (forUpdateStmt->Update()) {
        ResolveReference(forUpdateStmt, forUpdateStmt->Update());
    }

    if (forUpdateStmt->Test()) {
        ResolveReference(forUpdateStmt, forUpdateStmt->Test());
    }

    ResolveReference(forUpdateStmt, forUpdateStmt->Body());

    loopCtx.GetScope()->InitVariable();
}

void Binder::BuildForInOfLoop(const ir::Statement *parent, binder::LoopScope *loopScope, ir::AstNode *left,
                              ir::Expression *right, ir::Statement *body)
{
    auto loopCtx = LexicalScope<LoopScope>::Enter(this, loopScope);

    ResolveReference(parent, right);
    ResolveReference(parent, left);

    ResolveReference(parent, body);
    loopCtx.GetScope()->InitVariable();
}

void Binder::BuildCatchClause(ir::CatchClause *catchClauseStmt)
{
    if (catchClauseStmt->Param()) {
        auto paramScopeCtx = LexicalScope<CatchParamScope>::Enter(this, catchClauseStmt->Scope()->ParamScope());
        ResolveReference(catchClauseStmt, catchClauseStmt->Param());
    }

    auto scopeCtx = LexicalScope<CatchScope>::Enter(this, catchClauseStmt->Scope());
    ResolveReference(catchClauseStmt, catchClauseStmt->Body());
}

void Binder::ResolveReference(const ir::AstNode *parent, ir::AstNode *childNode)
{
    childNode->SetParent(parent);

    ClassTdz classTdz(parent, childNode, scope_);

    switch (childNode->Type()) {
        case ir::AstNodeType::IDENTIFIER: {
            auto *ident = childNode->AsIdentifier();

            if (ident->Name().Is(FUNCTION_ARGUMENTS)) {
                CheckMandatoryArguments(ident);
            }

            if (ident->IsReference()) {
                LookupIdentReference(ident);
            }

            /* During ts to js transformation, a non-empty namespace in ts file will be transformed
               into a anonymous function while empty namespace will be removed. So the name for the
               namespace need to be stored before the transformation.*/
            if (scope_->Type() == ScopeType::TSMODULE) {
                scope_->SetSelfScopeName(ident->Name());
            }

            ResolveReferences(childNode);
            break;
        }
        case ir::AstNodeType::ANNOTATION: {
            auto *annotation = childNode->AsAnnotation();
            std::string annoName{annotation->Name()};
            ScopeFindResult res = scope_->Find(annotation->Name(), bindingOptions_);
            if (res.variable != nullptr) {
                if (res.variable->Declaration()->Node()->IsImportSpecifier()) {
                    annotation->SetIsImported();
                } else if (!res.variable->Declaration()->Node()->IsClassDefinition()) {
                    ThrowInvalidAnnotationDeclaration(annotation->Start(), annotation->Name());
                }
            } else if (annoName.find_first_of(".") != std::string::npos) {
                auto importName = annoName.substr(0, annoName.find_first_of("."));
                ScopeFindResult res = scope_->Find(util::StringView(importName), bindingOptions_);
                if (res.variable != nullptr && res.variable->Declaration()->Node()->IsImportNamespaceSpecifier()) {
                    annotation->SetIsImported();
                } else {
                    ThrowInvalidAnnotationDeclaration(annotation->Start(), annotation->Name());
                }
            } else {
                ThrowInvalidAnnotationDeclaration(annotation->Start(), annotation->Name());
            }
            ResolveReferences(childNode);
            break;
        }
        case ir::AstNodeType::PRIVATE_IDENTIFIER: {
            if (Program()->Extension() == ScriptExtension::JS) {
                CheckPrivateDeclaration(childNode->AsPrivateIdentifier());
            } else if (Program()->Extension() == ScriptExtension::TS &&
                       bindingFlags_ == ResolveBindingFlags::TS_AFTER_TRANSFORM) {
                CheckPrivateDeclaration(childNode->AsPrivateIdentifier());
            }
            break;
        }
        case ir::AstNodeType::SUPER_EXPRESSION: {
            VariableScope *varScope = scope_->EnclosingVariableScope();
            varScope->AddFlag(VariableScopeFlags::USE_SUPER);

            ResolveReferences(childNode);
            break;
        }
        case ir::AstNodeType::SCRIPT_FUNCTION: {
            bool previousInSendableFunction = inSendableFunction_;
            auto *scriptFunc = childNode->AsScriptFunction();
            // Static initializer only be executed once. Treat it as unshared method.
            if ((inSendableClass_ && !scriptFunc->IsStaticInitializer()) || inSendableFunction_) {
                scriptFunc->SetInSendable();
            }
            bool enableSendableClass = program_->TargetApiVersion() >=
                util::Helpers::SENDABLE_CLASS_MIN_SUPPORTED_API_VERSION;
            util::Helpers::ScanDirectives(const_cast<ir::ScriptFunction *>(scriptFunc), Program()->GetLineIndex(),
                enableSendableClass,
                !util::Helpers::IsDefaultApiVersion(program_->TargetApiVersion(), program_->GetTargetApiSubVersion()));

            if (scriptFunc->IsConstructor() && util::Helpers::GetClassDefiniton(scriptFunc)->IsSendable()) {
                scriptFunc->SetInSendable();
                inSendableClass_ = true;
            } else if (scriptFunc->IsSendable()) {
                scriptFunc->SetInSendable();
                inSendableFunction_ = true;
            }

            auto *funcScope = scriptFunc->Scope();

            auto *outerScope = scope_;

            if (scriptFunc->Id() != nullptr) {
                scriptFunc->Id()->SetParent(scriptFunc);
            }

            {
                auto paramScopeCtx = LexicalScope<FunctionParamScope>::Enter(this, funcScope->ParamScope());

                if (Program()->Extension() == ScriptExtension::TS) {
                    if (scriptFunc->TypeParams() != nullptr) {
                        ResolveReference(scriptFunc, scriptFunc->TypeParams());
                    }
                    if (scriptFunc->ThisParams() != nullptr) {
                        ResolveReference(scriptFunc, scriptFunc->ThisParams());
                    }
                }

                for (auto *param : scriptFunc->Params()) {
                    ResolveReference(scriptFunc, param);
                }
            }

            if (Program()->Extension() == ScriptExtension::TS) {
                if (scriptFunc->ReturnTypeAnnotation()) {
                    ResolveReference(scriptFunc, scriptFunc->ReturnTypeAnnotation());
                }

                if (scriptFunc->IsOverload() || scriptFunc->Declare()) {
                    break;
                }
            }

            auto scopeCtx = LexicalScope<FunctionScope>::Enter(this, funcScope);

            BuildScriptFunction(outerScope, scriptFunc);

            ResolveReference(scriptFunc, scriptFunc->Body());
            inSendableFunction_ = previousInSendableFunction;
            break;
        }
        case ir::AstNodeType::VARIABLE_DECLARATOR: {
            BuildVarDeclarator(childNode->AsVariableDeclarator());

            break;
        }
        case ir::AstNodeType::CLASS_DEFINITION: {
            auto *classScope = childNode->AsClassDefinition()->Scope();
            classScope->SetParent(scope_);
            BuildClassDefinition(childNode->AsClassDefinition());

            break;
        }
        case ir::AstNodeType::CLASS_PROPERTY: {
            /* for ts tranformer cases, all class properties are implemented by transformer in api10 and
             * only public instance class properties are implemented by transformer in api11*/
            auto *prop = childNode->AsClassProperty();
            if (Program()->Extension() == ScriptExtension::TS && (Program()->TargetApiVersion() < 11 ||
                (!prop->IsStatic() && !prop->IsPrivate()))) {
                const ir::ScriptFunction *ctor = util::Helpers::GetContainingConstructor(prop);
                auto scopeCtx = LexicalScope<FunctionScope>::Enter(this, ctor->Scope());
                ResolveReferences(childNode);
                break;
            }

            ResolveReference(prop, prop->Key());
            if (prop->Value() != nullptr) {
                ASSERT(parent->IsClassDefinition());
                const auto *classDef = parent->AsClassDefinition();
                const ir::MethodDefinition *method = prop->IsStatic() ? classDef->StaticInitializer() :
                                                     classDef->InstanceInitializer();
                auto scopeCtx = LexicalScope<FunctionScope>::Enter(this, method->Function()->Scope());
                ResolveReference(prop, prop->Value());
            }
            break;
        }
        case ir::AstNodeType::BLOCK_STATEMENT: {
            auto scope = childNode->AsBlockStatement()->Scope();
            auto scopeCtx = scope != nullptr ?
                LexicalScope<Scope>::Enter(this, scope) :
                LexicalScope<Scope>::Enter(this, GetScope());

            ResolveReferences(childNode);
            break;
        }
        case ir::AstNodeType::SWITCH_STATEMENT: {
            auto *switchStatement = childNode->AsSwitchStatement();
            ResolveReference(switchStatement, switchStatement->Discriminant());

            auto scopeCtx = LexicalScope<LocalScope>::Enter(this, childNode->AsSwitchStatement()->Scope());
            for (auto *it : switchStatement->Cases()) {
                ResolveReference(switchStatement, it);
            }
            break;
        }
        case ir::AstNodeType::DO_WHILE_STATEMENT: {
            auto *doWhileStatement = childNode->AsDoWhileStatement();

            {
                auto loopScopeCtx = LexicalScope<LoopScope>::Enter(this, doWhileStatement->Scope());
                ResolveReference(doWhileStatement, doWhileStatement->Body());
                loopScopeCtx.GetScope()->InitVariable();
            }

            ResolveReference(doWhileStatement, doWhileStatement->Test());
            break;
        }
        case ir::AstNodeType::WHILE_STATEMENT: {
            auto *whileStatement = childNode->AsWhileStatement();
            ResolveReference(whileStatement, whileStatement->Test());

            auto loopScopeCtx = LexicalScope<LoopScope>::Enter(this, whileStatement->Scope());
            ResolveReference(whileStatement, whileStatement->Body());
            loopScopeCtx.GetScope()->InitVariable();
            break;
        }
        case ir::AstNodeType::FOR_UPDATE_STATEMENT: {
            BuildForUpdateLoop(childNode->AsForUpdateStatement());
            break;
        }
        case ir::AstNodeType::FOR_IN_STATEMENT: {
            auto *forInStmt = childNode->AsForInStatement();
            BuildForInOfLoop(forInStmt, forInStmt->Scope(), forInStmt->Left(), forInStmt->Right(), forInStmt->Body());

            break;
        }
        case ir::AstNodeType::FOR_OF_STATEMENT: {
            auto *forOfStmt = childNode->AsForOfStatement();
            BuildForInOfLoop(forOfStmt, forOfStmt->Scope(), forOfStmt->Left(), forOfStmt->Right(), forOfStmt->Body());
            break;
        }
        case ir::AstNodeType::CATCH_CLAUSE: {
            BuildCatchClause(childNode->AsCatchClause());
            break;
        }
        case ir::AstNodeType::EXPORT_NAMED_DECLARATION: {
            ValidateExportDecl(childNode->AsExportNamedDeclaration());

            ResolveReferences(childNode);
            break;
        }
        // TypeScript specific part
        case ir::AstNodeType::TS_FUNCTION_TYPE:
        case ir::AstNodeType::TS_CONSTRUCTOR_TYPE:
        case ir::AstNodeType::TS_METHOD_SIGNATURE:
        case ir::AstNodeType::TS_SIGNATURE_DECLARATION: {
            BuildTSSignatureDeclarationBaseParams(childNode);
            break;
        }
        case ir::AstNodeType::TS_MODULE_DECLARATION: {
            auto scopeCtx = LexicalScope<Scope>::Enter(this, childNode->AsTSModuleDeclaration()->Scope());
            ResolveReferences(childNode);
            break;
        }
        case ir::AstNodeType::TS_ENUM_DECLARATION: {
            auto scopeCtx = LexicalScope<Scope>::Enter(this, childNode->AsTSEnumDeclaration()->Scope());
            ResolveReferences(childNode);
            break;
        }
        default: {
            ResolveReferences(childNode);
            break;
        }
    }
}
void Binder::ResolveReferences(const ir::AstNode *parent)
{
    parent->Iterate([this, parent](auto *childNode) { ResolveReference(parent, childNode); });
}

void Binder::AddMandatoryParam(const std::string_view &name)
{
    ASSERT(scope_->IsFunctionVariableScope());

    auto *decl = Allocator()->New<ParameterDecl>(name);
    auto *param = Allocator()->New<LocalVariable>(decl, VariableFlags::VAR);

    auto &funcParams = scope_->AsFunctionVariableScope()->ParamScope()->Params();
    funcParams.insert(funcParams.begin(), param);
    scope_->AsFunctionVariableScope()->ParamScope()->Bindings().insert({decl->Name(), param});
    scope_->AsFunctionVariableScope()->Bindings().insert({decl->Name(), param});
}

void Binder::AddMandatoryParams()
{
    ASSERT(scope_ == topScope_);
    ASSERT(!functionScopes_.empty());
    auto iter = functionScopes_.begin();
    [[maybe_unused]] auto *funcScope = *iter++;

    ASSERT(funcScope->IsGlobalScope() || funcScope->IsModuleScope());

    if (program_->Kind() == parser::ScriptKind::COMMONJS) {
        AddMandatoryParams(CJS_MAINFUNC_MANDATORY_PARAMS);
    } else {
        AddMandatoryParams(FUNCTION_MANDATORY_PARAMS);
    }

    for (; iter != functionScopes_.end(); iter++) {
        funcScope = *iter;
        const auto *scriptFunc = funcScope->Node()->AsScriptFunction();

        auto scopeCtx = LexicalScope<FunctionScope>::Enter(this, funcScope);

        if (!scriptFunc->IsArrow()) {
            AddMandatoryParams(FUNCTION_MANDATORY_PARAMS);
            continue;
        }

        const ir::ScriptFunction *ctor = util::Helpers::GetContainingConstructor(scriptFunc);
        bool lexicalFunctionObject {};

        if (ctor && util::Helpers::GetClassDefiniton(ctor)->Super() &&
            funcScope->HasFlag(VariableScopeFlags::USE_SUPER)) {
            ASSERT(ctor->Scope()->HasFlag(VariableScopeFlags::INNER_ARROW));
            ctor->Scope()->AddFlag(VariableScopeFlags::SET_LEXICAL_FUNCTION);
            lexicalFunctionObject = true;
            AddMandatoryParams(CTOR_ARROW_MANDATORY_PARAMS);
        } else {
            AddMandatoryParams(ARROW_MANDATORY_PARAMS);
        }

        LookupReference(MANDATORY_PARAM_NEW_TARGET);
        LookupReference(MANDATORY_PARAM_THIS);

        if (funcScope->HasFlag(VariableScopeFlags::USE_ARGS)) {
            LookupReference(FUNCTION_ARGUMENTS);
        }

        if (lexicalFunctionObject) {
            LookupReference(MANDATORY_PARAM_FUNC);
        }
    }
}

void Binder::AddDeclarationName(const util::StringView &name, DeclType type)
{
    if (extension_ != ScriptExtension::TS) {
        return;
    }
    variableNames_.insert(name);

    if (type == DeclType::ENUM) {
        return;
    }
    auto *scope = GetScope();
    while (scope != nullptr) {
        if (scope->IsTSModuleScope()) {
            scope->AsTSModuleScope()->AddDeclarationName(name);
        }
        if (scope->IsTSEnumScope()) {
            scope->AsTSEnumScope()->AddDeclarationName(name);
        }
        scope = scope->Parent();
    }
}

bool Binder::HasVariableName(const util::StringView &name) const
{
    return variableNames_.find(name) != variableNames_.end();
}

std::vector<Variable *> Binder::FindIdentifierTSVariables(const ir::Identifier *identifier, Scope *scope,
    ScopeFindResult &res)
{
    const auto &name = identifier->Name();
    std::vector<binder::Variable *> findRes;

    auto currentScope = scope;
    while (currentScope != nullptr) {
        // Find ts variables
        auto fn = [&findRes](Variable *variable) {
            if (variable != nullptr) {
                findRes.emplace_back(variable);
            }
        };

        fn(currentScope->FindLocalTSVariable<binder::TSBindingType::NAMESPACE>(name));
        fn(currentScope->FindLocalTSVariable<binder::TSBindingType::ENUMLITERAL>(name));
        fn(currentScope->FindLocalTSVariable<binder::TSBindingType::IMPORT_EQUALS>(name));
        if (currentScope->IsTSModuleScope()) {
            fn(currentScope->AsTSModuleScope()->FindExportTSVariable<binder::TSBindingType::NAMESPACE>(name));
            fn(currentScope->AsTSModuleScope()->FindExportTSVariable<binder::TSBindingType::ENUMLITERAL>(name));
            fn(currentScope->AsTSModuleScope()->FindExportTSVariable<binder::TSBindingType::IMPORT_EQUALS>(name));
        }

        // Find js variable
        if (currentScope->FindLocal(name, bindingOptions_) != nullptr) {
            res = scope->Find(name, bindingOptions_);
            break;
        }

        if (!findRes.empty()) {
            break;
        }

        currentScope = currentScope->Parent();
    }

    return findRes;
}

void Binder::ReplaceConstReferenceWithInitialization(const ir::Identifier *ident, const Decl *decl)
{
    bool isValidAssignmentExpr = ident->Parent()->IsAssignmentExpression() &&
        ident->Parent()->AsAssignmentExpression()->Right() == ident;
    bool isBinaryExpr = ident->Parent()->IsBinaryExpression();
    bool isVariableDecl = ident->Parent()->IsVariableDeclarator() &&
        ident->Parent()->AsVariableDeclarator()->Init() == ident;
    if (!isValidAssignmentExpr && !isBinaryExpr && !isVariableDecl) {
        return;
    }

    if (decl->Node() == nullptr || decl->Node()->Parent() == nullptr ||
        !decl->Node()->Parent()->IsVariableDeclarator()) {
        return;
    }

    const ir::AstNode *initialization = static_cast<const ir::AstNode *>(
        decl->Node()->Parent()->AsVariableDeclarator()->Init());
    if (initialization == nullptr || !initialization->IsNumberLiteral()) {
        return;
    }

    auto newNode = Allocator()->New<ir::NumberLiteral>(initialization->AsNumberLiteral()->Number());
    if (newNode == nullptr) {
        throw Error(ErrorType::GENERIC, "Unsuccessful allocation during replacing const reference node");
    }
    // Make sure the new node get the correct line number
    // Column number may be incorrect, but it doesn't matter in release mode
    newNode->SetRange(ident->Range());

    auto *parentNode = const_cast<panda::es2panda::ir::AstNode *>(ident->Parent());
    // update the reference node with initialization node
    parentNode->UpdateSelf([=](auto *childNode) {
            if (childNode == ident) {
                return static_cast<ir::AstNode *>(newNode);
            }
            return childNode;
        }, this);
}

void Binder::CheckPrivateDeclaration(const ir::PrivateIdentifier *privateIdent)
{
    auto name = privateIdent->Name();
    auto scope = scope_;
    while (scope != nullptr) {
        if (scope->Type() == ScopeType::CLASS) {
            const auto *classScope = scope->AsClassScope();
            if (classScope->HasPrivateName(name)) {
                return;
            }
        }
        scope = scope->Parent();
    }

    auto pos = privateIdent->Start();
    lexer::LineIndex index(program_->SourceCode());
    lexer::SourceLocation loc = index.GetLocation(pos);

    throw Error{ErrorType::SYNTAX, "Use private property before declaration", loc.line, loc.col};
}

ClassTdz::ClassTdz(const ir::AstNode *parent, const ir::AstNode *childNode, Scope *scope)
{
    /* In ES2022, class element name's evaluation is before class's initialization.
     * So a computed property name can not access class object which leads to a reference error.
     * For example:
     * class A {
     *   [A]
     * }
     */
    bool isClassTdz = (parent->IsClassProperty() && childNode == parent->AsClassProperty()->Key()) ||
        (parent->IsMethodDefinition() && childNode == parent->AsMethodDefinition()->Key());
    if (!isClassTdz) {
        return;
    }

    ASSERT(parent->Parent()->IsClassDefinition());
    auto classDef = parent->Parent()->AsClassDefinition();
    if (!classDef->Ident()) {
        return;
    }

    ScopeFindResult res = scope->Find(classDef->Ident()->Name());
    ASSERT(res.variable && res.variable->Declaration()->IsConstDecl());
    variable_ = res.variable;
    variable_->RemoveFlag(VariableFlags::INITIALIZED);
}

}  // namespace panda::es2panda::binder