xref: /arkcompiler/ets_frontend/es2panda/ir/base/methodDefinition.h

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

#ifndef ES2PANDA_PARSER_INCLUDE_AST_METHOD_DEFINITION_H
#define ES2PANDA_PARSER_INCLUDE_AST_METHOD_DEFINITION_H

#include <ir/statement.h>
#include <ir/expression.h>

namespace panda::es2panda::compiler {
class PandaGen;
}  // namespace panda::es2panda::compiler

namespace panda::es2panda::checker {
class Checker;
class Type;
}  // namespace panda::es2panda::checker

namespace panda::es2panda::ir {

class FunctionExpression;

enum class MethodDefinitionKind { CONSTRUCTOR, METHOD, GET, SET };

struct ParamDecorators {
    size_t paramIndex;
    ArenaVector<Decorator *> decorators;
};

class MethodDefinition : public Statement {
public:
    explicit MethodDefinition(MethodDefinitionKind kind, Expression *key, FunctionExpression *value,
                              ModifierFlags modifiers, ArenaAllocator *allocator, ArenaVector<Decorator *> &&decorators,
                              ArenaVector<Annotation *> &&annotations, ArenaVector<ParamDecorators> &&paramDecorators,
                              bool isComputed)
        : Statement(AstNodeType::METHOD_DEFINITION),
          kind_(kind),
          key_(key),
          value_(value),
          modifiers_(modifiers),
          overloads_(allocator->Adapter()),
          decorators_(std::move(decorators)),
          annotations_(std::move(annotations)),
          paramDecorators_(std::move(paramDecorators)),
          isComputed_(isComputed)
    {
    }

    MethodDefinitionKind Kind() const
    {
        return kind_;
    }

    ModifierFlags Modifiers() const
    {
        return modifiers_;
    }

    const Expression *Key() const
    {
        return key_;
    }

    Expression *Key()
    {
        return key_;
    }

    void SetKey(Expression *key)
    {
        key_ = key;
    }

    const FunctionExpression *Value() const
    {
        return value_;
    }

    bool Computed() const
    {
        return isComputed_;
    }

    bool IsAbstract() const
    {
        return (modifiers_ & ModifierFlags::ABSTRACT) != 0;
    }

    bool IsStatic() const
    {
        return (modifiers_ & ModifierFlags::STATIC) != 0;
    }

    bool IsAccessor() const
    {
        return (kind_ == MethodDefinitionKind::GET) || (kind_ == MethodDefinitionKind::SET);
    }

    bool IsOptional() const
    {
        return (modifiers_ & ModifierFlags::OPTIONAL) != 0;
    }

    bool IsPrivate() const
    {
        return key_->IsPrivateIdentifier();
    }

    const ArenaVector<MethodDefinition *> &Overloads() const
    {
        return overloads_;
    }

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

    const ArenaVector<Annotation *> &Annotations() const
    {
        return annotations_;
    }

    void SetAnnotations(ArenaVector<Annotation *> &&annotations)
    {
        annotations_ = std::move(annotations);
    }

    const ArenaVector<ParamDecorators> &GetParamDecorators() const
    {
        return paramDecorators_;
    }

    bool HasParamDecorators() const
    {
        return !paramDecorators_.empty();
    }

    bool HasDecorators() const
    {
        return !decorators_.empty();
    }

    void SetOverloads(ArenaVector<MethodDefinition *> &&overloads)
    {
        overloads_ = std::move(overloads);
    }

    void AddOverload(MethodDefinition *overload)
    {
        overloads_.push_back(overload);
    }

    void SetKeyReg(compiler::VReg keyReg)
    {
        keyReg_ = keyReg;
    }

    compiler::VReg KeyReg() const
    {
        return keyReg_;
    }

    const ScriptFunction *Function() const;

    ScriptFunction *Function();

    void Iterate(const NodeTraverser &cb) const override;
    void Dump(ir::AstDumper *dumper) const override;
    void Compile([[maybe_unused]] compiler::PandaGen *pg) const override;
    checker::Type *Check([[maybe_unused]] checker::Checker *checker) const override;
    void UpdateSelf(const NodeUpdater &cb, [[maybe_unused]] binder::Binder *binder) override;

private:
    MethodDefinitionKind kind_;
    Expression *key_;
    compiler::VReg keyReg_ {0};
    FunctionExpression *value_;
    ModifierFlags modifiers_;
    ArenaVector<MethodDefinition *> overloads_;
    ArenaVector<Decorator *> decorators_;
    ArenaVector<Annotation *> annotations_;
    ArenaVector<ParamDecorators> paramDecorators_;
    bool isComputed_;
};

}  // namespace panda::es2panda::ir

#endif