xref: /arkcompiler/ets_frontend/ets2panda/ir/base/classDefinition.cpp

/**
 * Copyright (c) 2021-2024 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 "classDefinition.h"

#include "checker/TSchecker.h"
#include "checker/ETSchecker.h"
#include "compiler/core/ETSGen.h"
#include "compiler/core/pandagen.h"
#include "ir/astDump.h"
#include "ir/srcDump.h"
#include "ir/base/classStaticBlock.h"
#include "ir/base/methodDefinition.h"
#include "ir/base/scriptFunction.h"
#include "ir/expressions/identifier.h"
#include "ir/ts/tsClassImplements.h"

namespace ark::es2panda::ir {
const FunctionExpression *ClassDefinition::Ctor() const
{
    return ctor_ != nullptr ? ctor_->Value()->AsFunctionExpression() : nullptr;
}

bool ClassDefinition::HasPrivateMethod() const
{
    return std::any_of(body_.cbegin(), body_.cend(), [](auto *element) {
        return element->IsMethodDefinition() && element->AsClassElement()->IsPrivateElement();
    });
}

bool ClassDefinition::HasComputedInstanceField() const
{
    return std::any_of(body_.cbegin(), body_.cend(), [](auto *element) {
        return element->IsClassProperty() && element->AsClassElement()->IsComputed() &&
               !(element->AsClassElement()->Modifiers() & ir::ModifierFlags::STATIC);
    });
}

bool ClassDefinition::HasMatchingPrivateKey(const util::StringView &name) const
{
    return std::any_of(body_.cbegin(), body_.cend(), [&name](auto *element) {
        return element->AsClassElement()->IsPrivateElement() && element->AsClassElement()->Id()->Name() == name;
    });
}

void ClassDefinition::TransformChildren(const NodeTransformer &cb, std::string_view transformationName)
{
    if (ident_ != nullptr) {
        if (auto *transformedNode = cb(ident_); ident_ != transformedNode) {
            ident_->SetTransformedNode(transformationName, transformedNode);
            ident_ = transformedNode->AsIdentifier();
        }
    }

    if (typeParams_ != nullptr) {
        if (auto *transformedNode = cb(typeParams_); typeParams_ != transformedNode) {
            typeParams_->SetTransformedNode(transformationName, transformedNode);
            typeParams_ = transformedNode->AsTSTypeParameterDeclaration();
        }
    }

    if (superClass_ != nullptr) {
        if (auto *transformedNode = cb(superClass_); superClass_ != transformedNode) {
            superClass_->SetTransformedNode(transformationName, transformedNode);
            superClass_ = transformedNode->AsExpression();
        }
    }

    if (superTypeParams_ != nullptr) {
        if (auto *transformedNode = cb(superTypeParams_); superTypeParams_ != transformedNode) {
            superTypeParams_->SetTransformedNode(transformationName, transformedNode);
            superTypeParams_ = transformedNode->AsTSTypeParameterInstantiation();
        }
    }

    for (auto *&it : implements_) {
        if (auto *transformedNode = cb(it); it != transformedNode) {
            it->SetTransformedNode(transformationName, transformedNode);
            it = transformedNode->AsTSClassImplements();
        }
    }

    if (ctor_ != nullptr) {
        if (auto *transformedNode = cb(ctor_); ctor_ != transformedNode) {
            ctor_->SetTransformedNode(transformationName, transformedNode);
            ctor_ = transformedNode->AsMethodDefinition();
        }
    }

    for (auto *&it : body_) {
        if (auto *transformedNode = cb(it); it != transformedNode) {
            it->SetTransformedNode(transformationName, transformedNode);
            it = transformedNode;
        }
    }
}

void ClassDefinition::Iterate(const NodeTraverser &cb) const
{
    if (ident_ != nullptr) {
        cb(ident_);
    }

    if (typeParams_ != nullptr) {
        cb(typeParams_);
    }

    if (superClass_ != nullptr) {
        cb(superClass_);
    }

    if (superTypeParams_ != nullptr) {
        cb(superTypeParams_);
    }

    // Survives adding new elements to the end
    // NOLINTNEXTLINE(modernize-loop-convert)
    for (size_t ix = 0; ix < implements_.size(); ix++) {
        cb(implements_[ix]);
    }

    if (ctor_ != nullptr) {
        cb(ctor_);
    }

    // NOLINTNEXTLINE(modernize-loop-convert)
    for (size_t ix = 0; ix < body_.size(); ix++) {
        cb(body_[ix]);
    }
}

void ClassDefinition::SetIdent(ir::Identifier *ident) noexcept
{
    ident_ = ident;
    if (ident_ != nullptr) {
        ident_->SetParent(this);
    }
}

void ClassDefinition::Dump(ir::AstDumper *dumper) const
{
    auto propFilter = [](AstNode *prop) -> bool {
        return !prop->IsClassStaticBlock() || !prop->AsClassStaticBlock()->Function()->IsHidden();
    };
    dumper->Add({{"id", AstDumper::Nullish(ident_)},
                 {"typeParameters", AstDumper::Optional(typeParams_)},
                 {"superClass", AstDumper::Nullish(superClass_)},
                 {"superTypeParameters", AstDumper::Optional(superTypeParams_)},
                 {"implements", implements_},
                 {"constructor", AstDumper::Optional(ctor_)},
                 {"body", body_, propFilter}});
}

// This method is needed by OHOS CI code checker
void ClassDefinition::DumpBody(ir::SrcDumper *dumper) const
{
    dumper->Add(" {");
    if (!body_.empty()) {
        dumper->IncrIndent();
        dumper->Endl();
        for (auto elem : body_) {
            elem->Dump(dumper);
            if (elem == body_.back()) {
                dumper->DecrIndent();
            }
            dumper->Endl();
        }
    }
    dumper->Add("}");
}

void ClassDefinition::Dump(ir::SrcDumper *dumper) const
{
    ASSERT(ident_ != nullptr);

    if (IsExtern()) {
        dumper->Add("extern ");
    }

    if (IsExported()) {
        dumper->Add("export ");
    }

    if (IsDeclare()) {
        dumper->Add("declare ");
    }

    if (IsFinal()) {
        dumper->Add("final ");
    }

    if (IsAbstract()) {
        dumper->Add("abstract ");
    }

    dumper->Add("class ");
    ident_->Dump(dumper);

    if (typeParams_ != nullptr) {
        dumper->Add("<");
        typeParams_->Dump(dumper);
        dumper->Add("> ");
    }

    if (superClass_ != nullptr) {
        dumper->Add(" extends ");
        superClass_->Dump(dumper);
    }

    if (!implements_.empty()) {
        dumper->Add(" implements ");
        for (auto interface : implements_) {
            interface->Dump(dumper);
            if (interface != implements_.back()) {
                dumper->Add(", ");
            }
        }
    }

    if (!IsDeclare() || !body_.empty()) {
        DumpBody(dumper);
    }
    if (IsLocal()) {
        dumper->Add(";");
    }
    dumper->Endl();
}

void ClassDefinition::Compile(compiler::PandaGen *pg) const
{
    pg->GetAstCompiler()->Compile(this);
}

void ClassDefinition::Compile(compiler::ETSGen *etsg) const
{
    etsg->GetAstCompiler()->Compile(this);
}

checker::Type *ClassDefinition::Check(checker::TSChecker *checker)
{
    return checker->GetAnalyzer()->Check(this);
}

checker::Type *ClassDefinition::Check(checker::ETSChecker *checker)
{
    return checker->GetAnalyzer()->Check(this);
}

int ClassDefinition::classCounter_ = 0;

}  // namespace ark::es2panda::ir