xref: /arkcompiler/ets_frontend/ets2panda/ir/ets/etsTuple.cpp

/**
 * Copyright (c) 2023-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 "etsTuple.h"

#include "checker/ETSchecker.h"
#include "checker/types/ets/etsTupleType.h"
#include "ir/astDump.h"

namespace panda::es2panda::ir {

void ETSTuple::TransformChildren([[maybe_unused]] const NodeTransformer &cb)
{
    for (auto *&it : GetTupleTypeAnnotationsList()) {
        it = static_cast<TypeNode *>(cb(it));
    }

    if (HasSpreadType()) {
        cb(spreadType_);
    }
}

void ETSTuple::Iterate([[maybe_unused]] const NodeTraverser &cb) const
{
    for (auto *const it : GetTupleTypeAnnotationsList()) {
        cb(it);
    }

    if (HasSpreadType()) {
        cb(spreadType_);
    }
}

void ETSTuple::Dump(ir::AstDumper *const dumper) const
{
    dumper->Add({{"type", "ETSTuple"},
                 {"types", AstDumper::Optional(typeAnnotationList_)},
                 {"spreadType", AstDumper::Nullish(spreadType_)}});
}

void ETSTuple::Dump(ir::SrcDumper *const dumper) const
{
    dumper->Add("[");
    for (const auto *const typeAnnot : typeAnnotationList_) {
        typeAnnot->Dump(dumper);
        if ((typeAnnot != typeAnnotationList_.back()) || (spreadType_ != nullptr)) {
            dumper->Add(", ");
        }
    }
    if (spreadType_ != nullptr) {
        dumper->Add("...");
        spreadType_->Dump(dumper);
    }
    dumper->Add("]");
}

void ETSTuple::Compile([[maybe_unused]] compiler::PandaGen *const pg) const {}
void ETSTuple::Compile([[maybe_unused]] compiler::ETSGen *const etsg) const {}

checker::Type *ETSTuple::Check([[maybe_unused]] checker::TSChecker *const checker)
{
    return nullptr;
}

checker::Type *ETSTuple::Check([[maybe_unused]] checker::ETSChecker *const checker)
{
    return GetType(checker);
}

void ETSTuple::SetNullUndefinedFlags(std::pair<bool, bool> &containsNullOrUndefined, const checker::Type *const type)
{
    if (type->HasTypeFlag(checker::TypeFlag::NULLISH)) {
        containsNullOrUndefined.first = true;
    }

    if (type->HasTypeFlag(checker::TypeFlag::UNDEFINED)) {
        containsNullOrUndefined.second = true;
    }
}

checker::Type *ETSTuple::CalculateLUBForTuple(checker::ETSChecker *const checker,
                                              ArenaVector<checker::Type *> &typeList, checker::Type *const spreadType)
{
    if (typeList.empty()) {
        return spreadType == nullptr ? checker->GlobalETSObjectType() : spreadType;
    }

    std::pair<bool, bool> containsNullOrUndefined = {false, false};

    bool allElementsAreSame =
        std::all_of(typeList.begin(), typeList.end(),
                    [this, &checker, &typeList, &containsNullOrUndefined](checker::Type *const element) {
                        SetNullUndefinedFlags(containsNullOrUndefined, element);
                        return checker->Relation()->IsIdenticalTo(typeList[0], element);
                    });

    if (spreadType != nullptr) {
        SetNullUndefinedFlags(containsNullOrUndefined, spreadType);
        allElementsAreSame = allElementsAreSame && checker->Relation()->IsIdenticalTo(typeList[0], spreadType);
    }

    // If only one type present in the tuple, that will be the holder array type. If any two not identical types
    // present, primitives will be boxed, and LUB is calculated for all of them.
    // That makes it possible to assign eg. `[int, int, ...int[]]` tuple type to `int[]` array type. Because a `short[]`
    // array already isn't assignable to `int[]` array, that preserve that the `[int, short, ...int[]]` tuple type's
    // element type will be calculated to `Object[]`, which is not assignable to `int[]` array either.
    if (allElementsAreSame) {
        return typeList[0];
    }

    auto *const savedRelationNode = checker->Relation()->GetNode();
    checker->Relation()->SetNode(this);

    auto getBoxedTypeOrType = [&checker](checker::Type *const type) {
        auto *const boxedType = checker->PrimitiveTypeAsETSBuiltinType(type);
        return boxedType == nullptr ? type : boxedType;
    };

    checker::Type *lubType = getBoxedTypeOrType(typeList[0]);

    for (std::size_t idx = 1; idx < typeList.size(); ++idx) {
        lubType = checker->FindLeastUpperBound(lubType, getBoxedTypeOrType(typeList[idx]));
    }

    if (spreadType != nullptr) {
        lubType = checker->FindLeastUpperBound(lubType, getBoxedTypeOrType(spreadType));
    }

    const auto nullishUndefinedFlags =
        (containsNullOrUndefined.first ? checker::TypeFlag::NULLISH | checker::TypeFlag::NULL_TYPE
                                       : checker::TypeFlag::NONE) |
        (containsNullOrUndefined.second ? checker::TypeFlag::UNDEFINED : checker::TypeFlag::NONE);

    if (nullishUndefinedFlags != checker::TypeFlag::NONE) {
        lubType = checker->CreateNullishType(lubType, nullishUndefinedFlags, checker->Allocator(), checker->Relation(),
                                             checker->GetGlobalTypesHolder());
    }

    checker->Relation()->SetNode(savedRelationNode);

    return lubType;
}

checker::Type *ETSTuple::GetType(checker::ETSChecker *const checker)
{
    if (TsType() != nullptr) {
        return TsType();
    }

    ArenaVector<checker::Type *> typeList(checker->Allocator()->Adapter());

    for (auto *const typeAnnotation : GetTupleTypeAnnotationsList()) {
        auto *const checkedType = checker->GetTypeFromTypeAnnotation(typeAnnotation);
        typeList.emplace_back(checkedType);
    }

    if (HasSpreadType()) {
        ASSERT(spreadType_->IsTSArrayType());
        auto *const arrayType = spreadType_->GetType(checker);
        ASSERT(arrayType->IsETSArrayType());
        spreadType_->SetTsType(arrayType->AsETSArrayType()->ElementType());
    }

    auto *const spreadElementType = spreadType_ != nullptr ? spreadType_->TsType() : nullptr;

    auto *const tupleType = checker->Allocator()->New<checker::ETSTupleType>(
        typeList, CalculateLUBForTuple(checker, typeList, spreadElementType), spreadElementType);

    SetTsType(tupleType);
    return TsType();
}

}  // namespace panda::es2panda::ir