xref: /arkcompiler/ets_frontend/ets2panda/ir/expressions/objectExpression.h

/**
 * 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.
 */

#ifndef ES2PANDA_IR_EXPRESSION_OBJECT_EXPRESSION_H
#define ES2PANDA_IR_EXPRESSION_OBJECT_EXPRESSION_H

#include "varbinder/variable.h"
#include "ir/expression.h"
#include "ir/validationInfo.h"
namespace ark::es2panda::checker {
class ETSAnalyzer;
}  // namespace ark::es2panda::checker
namespace ark::es2panda::util {
class BitSet;
}  // namespace ark::es2panda::util

namespace ark::es2panda::ir {
class ObjectExpression : public AnnotatedExpression {
private:
    struct Tag {};

public:
    ObjectExpression() = delete;
    ~ObjectExpression() override = default;

    NO_COPY_SEMANTIC(ObjectExpression);
    NO_MOVE_SEMANTIC(ObjectExpression);

    explicit ObjectExpression(AstNodeType nodeType, ArenaAllocator *allocator, ArenaVector<Expression *> &&properties,
                              bool trailingComma)
        : AnnotatedExpression(nodeType),
          decorators_(allocator->Adapter()),
          properties_(std::move(properties)),
          trailingComma_(trailingComma)
    {
    }
    explicit ObjectExpression(Tag tag, ObjectExpression const &other, ArenaAllocator *allocator);

    // NOTE (vivienvoros): these friend relationships can be removed once there are getters for private fields
    friend class checker::ETSAnalyzer;

    [[nodiscard]] const ArenaVector<Expression *> &Properties() const noexcept
    {
        return properties_;
    }

    [[nodiscard]] bool IsDeclaration() const noexcept
    {
        return isDeclaration_;
    }

    [[nodiscard]] bool IsOptional() const noexcept
    {
        return optional_;
    }

    void SetPreferredType(checker::Type *const preferredType) noexcept
    {
        preferredType_ = preferredType;
    }

    [[nodiscard]] checker::Type *PreferredType() const noexcept
    {
        return preferredType_;
    }

    [[nodiscard]] const ArenaVector<Decorator *> &Decorators() const noexcept
    {
        return decorators_;
    }

    const ArenaVector<Decorator *> *DecoratorsPtr() const override
    {
        return &Decorators();
    }

    void AddDecorators([[maybe_unused]] ArenaVector<ir::Decorator *> &&decorators) override
    {
        decorators_ = std::move(decorators);
    }

    bool CanHaveDecorator([[maybe_unused]] bool inTs) const override
    {
        return true;
    }

    [[nodiscard]] ObjectExpression *Clone(ArenaAllocator *allocator, AstNode *parent) override;

    [[nodiscard]] ValidationInfo ValidateExpression();
    [[nodiscard]] bool ConvertibleToObjectPattern();
    void SetDeclaration();
    void SetOptional(bool optional);
    void TransformChildren(const NodeTransformer &cb, std::string_view transformationName) override;
    void Iterate(const NodeTraverser &cb) const override;
    void Dump(ir::AstDumper *dumper) const override;
    void Dump(ir::SrcDumper *dumper) const override;
    void Compile(compiler::PandaGen *pg) const override;
    void Compile(compiler::ETSGen *etsg) const override;
    checker::Type *Check(checker::TSChecker *checker) override;
    checker::Type *Check(checker::ETSChecker *checker) override;
    checker::Type *CheckPattern(checker::TSChecker *checker);

    bool CheckAssignmentPattern(Property *prop, varbinder::Variable *&bindingVar, checker::Type *&patternParamType,
                                checker::TSChecker *checker, varbinder::LocalVariable *foundVar);

    void Accept(ASTVisitorT *v) override
    {
        v->Accept(this);
    }

private:
    ArenaVector<Decorator *> decorators_;
    ArenaVector<Expression *> properties_;
    checker::Type *preferredType_ {};
    bool isDeclaration_ {};
    bool trailingComma_ {};
    bool optional_ {};
};
}  // namespace ark::es2panda::ir

#endif