xref: /arkcompiler/ets_frontend/ets2panda/compiler/function/generatorFunctionBuilder.h

/*
 * Copyright (c) 2021 - 2023 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_COMPILER_FUNCTION_GENERATOR_FUNCTION_BUILDER_H
#define ES2PANDA_COMPILER_FUNCTION_GENERATOR_FUNCTION_BUILDER_H

#include "ir/irnode.h"
#include "compiler/function/functionBuilder.h"

namespace ark::es2panda::ir {
class YieldExpression;
}  // namespace ark::es2panda::ir

namespace ark::es2panda::compiler {
class PandaGen;

enum class GeneratorState {
    UNDEFINED = 0,
    SUSPENDED_START,
    SUSPENDED_YIELD,
    EXECUTING,
    COMPLETED,
    AWAITING_RETURN,
};

class GeneratorFunctionBuilder : public FunctionBuilder {
public:
    explicit GeneratorFunctionBuilder(PandaGen *pg, CatchTable *catchTable) : FunctionBuilder(pg, catchTable) {}

    ~GeneratorFunctionBuilder() override = default;
    NO_COPY_SEMANTIC(GeneratorFunctionBuilder);
    NO_MOVE_SEMANTIC(GeneratorFunctionBuilder);

    void Prepare(const ir::ScriptFunction *node) const override;
    void CleanUp(const ir::ScriptFunction *node) const override;

    void DirectReturn(const ir::AstNode *node) const override;
    void ImplicitReturn(const ir::AstNode *node) const override;

    void Yield(const ir::AstNode *node) override;

protected:
    BuilderType BuilderKind() const override
    {
        return BuilderType::GENERATOR;
    }
};
}  // namespace ark::es2panda::compiler

#endif