xref: /arkcompiler/ets_frontend/ets2panda/ir/base/tsIndexSignature.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_PARSER_INCLUDE_AST_TS_INDEX_SIGNATURE_H
#define ES2PANDA_PARSER_INCLUDE_AST_TS_INDEX_SIGNATURE_H

#include "ir/typeNode.h"

namespace ark::es2panda::checker {
class TSAnalyzer;
}  // namespace ark::es2panda::checker

namespace ark::es2panda::ir {
class TSIndexSignature : public TypedAstNode {
public:
    enum class TSIndexSignatureKind { NUMBER, STRING };

    TSIndexSignature() = delete;
    ~TSIndexSignature() override = default;

    NO_COPY_SEMANTIC(TSIndexSignature);
    NO_MOVE_SEMANTIC(TSIndexSignature);

    explicit TSIndexSignature(Expression *const param, TypeNode *const typeAnnotation, bool const readonly)
        : TypedAstNode(AstNodeType::TS_INDEX_SIGNATURE),
          param_(param),
          typeAnnotation_(typeAnnotation),
          readonly_(readonly)
    {
    }
    // NOTE (csabahurton): friend relationship can be removed once there are getters for private fields
    friend class checker::TSAnalyzer;

    [[nodiscard]] const Expression *Param() const noexcept
    {
        return param_;
    }

    [[nodiscard]] const TypeNode *TypeAnnotation() const noexcept
    {
        return typeAnnotation_;
    }

    [[nodiscard]] bool Readonly() const noexcept
    {
        return readonly_;
    }

    [[nodiscard]] TSIndexSignatureKind Kind() const noexcept;

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

    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;

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

private:
    Expression *param_;
    TypeNode *typeAnnotation_;
    bool readonly_;
};
}  // namespace ark::es2panda::ir

#endif /* TS_INDEX_SIGNATURE_H */