V-Gears/V-Gears-Installer/include/decompiler/world/WorldEngine.h

/*
 * V-Gears
 * Copyright (C) 2022 V-Gears Team
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <string>
#include <vector>
#include "decompiler/decompiler_engine.h"

namespace FF7{

    /**
     * Represents the FF7 world map engine.
     */
    class WorldEngine : public Engine{

        public:

            /**
             * A bank value.
             *
             * @todo Understand and document.
             */
            class BankValue : public VarValue{

                public:

                    /**
                     * Constructor.
                     *
                     * @param name[in] Variable name.
                     */
                    BankValue(std::string name);
            };

            /**
             * Constructor.
             *
             * @param script_number[in] The script number.
             */
            WorldEngine(int script_number);

            /**
             * Retrieves the disassembler.
             *
             * @param insts[in] List of instructions.
             * @return Pointer to the disassembler.
             */
            std::unique_ptr<Disassembler> GetDisassembler(InstVec &insts) override;

            /**
             * Retrieves the code generator.
             *
             * @param insts[in] List of instructions. Unused.
             * @param output[in] Pointer to the output (file, stream...).
             * @return Pointer to the generator.
             */
            std::unique_ptr<CodeGenerator> GetCodeGenerator(
              const InstVec& insts, std::ostream &output
            ) override;

            /**
             * Post-processing actions to apply to the scripts.
             *
             * It actually does nothing. CFG stands for control flow group.
             *
             * @param insts[in] Instruction list.
             * @param graph[in] Code graph.
             */
            virtual void PostCFG(InstVec &insts, Graph graph) override;

            /**
             * Retrieves the variants.
             *
             * @todo Variants of what? What is this supposed to do?
             */
            virtual void GetVariants(std::vector<std::string> &variants) const override;

            /**
             * Indicates if instructions are purely grouped.
             *
             * @return True if instructions are purely grouped. Always false.
             * @todo What is pure grouping?
             */
            virtual bool UsePureGrouping() const override;

        private:

            /**
             * The script number.
             */
            int script_number_;

            /**
             * Container for strings from the TEXT chunk.
             */
            std::vector<std::string> text_strings_;
    };

}