xref: /arkcompiler/ets_frontend/ets2panda/compiler/lowering/ets/topLevelStmts/globalClassHandler.h

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

#ifndef PANDA_GLOBALCLASSHANDLER_H
#define PANDA_GLOBALCLASSHANDLER_H

#include "parser/program/program.h"
#include "public/public.h"
#include "ir/astNode.h"

namespace ark::es2panda::compiler {

class GlobalClassHandler {
public:
    using ModuleDependencies = ArenaUnorderedSet<parser::Program *>;

    struct GlobalStmts {
        parser::Program *program;
        ArenaVector<ir::Statement *> statements;
    };
    explicit GlobalClassHandler(parser::ETSParser *parser, ArenaAllocator *allocator)
        : parser_(parser), allocator_(allocator) {};

    /**
     * Each "Module" has it's own global class, which contains all top level statements across "module"
     * Result - creation of global class and _$init$_ method
     * @param programs - vector of files in module
     */
    void SetupGlobalClass(const ArenaVector<parser::Program *> &programs, const ModuleDependencies *moduleDependencies);

private:
    /**
     * Move top level statements to _$init$_ and
     * @param program program of module
     * @param init_statements statements which should be executed
     */
    void SetupGlobalMethods(parser::Program *program, ArenaVector<ir::Statement *> &&statements,
                            bool mainExists = false, bool topLevelStatementsExist = false);

    ir::ClassDeclaration *CreateGlobalClass();
    ir::ClassStaticBlock *CreateStaticBlock(ir::ClassDefinition *classDef);
    ir::MethodDefinition *CreateGlobalMethod(const std::string_view name, ArenaVector<ir::Statement *> &&statements);
    void AddInitCallFromStaticBlock(ir::ClassDefinition *globalClass, ir::MethodDefinition *initMethod);

    ArenaVector<ir::Statement *> FormInitMethodStatements(parser::Program *program,
                                                          const ModuleDependencies *moduleDependencies,
                                                          ArenaVector<GlobalStmts> &&initStatements);

    void FormDependentInitTriggers(ArenaVector<ir::Statement *> &statements,
                                   const ModuleDependencies *moduleDependencies);

    /**
     *
     * @param program leave only declarations here
     * @param class_def add new properties such as methods and fields
     * @param addInitializer $init$ should contain global variable initializers
     * @return Statements, which should be executed before the start
     */
    ArenaVector<ir::Statement *> CollectProgramGlobalStatements(parser::Program *program, ir::ClassDefinition *classDef,
                                                                bool addInitializer);

    ir::Identifier *RefIdent(const util::StringView &name);
    util::UString ReplaceSpecialCharacters(util::UString *word) const;

    parser::ETSParser *const parser_;
    ArenaAllocator *const allocator_;
};
}  // namespace ark::es2panda::compiler

#endif  // PANDA_GLOBALCLASSHANDLER_H