V-Gears/V-Gears-Installer/include/decompiler/world/WorldCodeGenerator.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 "decompiler/decompiler_codegen.h"

namespace FF7{

    class WorldCodeGenerator : public CodeGenerator{

        public:

            /**
             * Constructor.
             *
             * @param engine[in] The engine.
             * @param output[out] The generated script.
             */
            WorldCodeGenerator(Engine *engine, std::ostream &output);

            /**
             * Finds the first function call.
             *
             * @return A pointer to the first call instruction.
             */
            const InstPtr FindFirstCall();

            /**
             * Finds the last function call.
             *
             * @return A pointer to the last call instruction.
             */
            const InstPtr FindLastCall();

            /**
             * Processes special metadata in an instruction.
             *
             * @param inst[in] The instruction to process.
             * @param c[in]
             * @param pos[in]
             * @todo understand and document.
             */
            virtual void ProcessSpecialMetadata(const InstPtr inst, char c, int pos);

        protected:

            /**
             * Constructs the function signature.
             *
             * The function signature is the LUA function declaration, and it
             * looks like this:
             *
             * <function_name> = function(self)
             *
             * @param function[in] The function to construct the signature for.
             * @return The function signature.
             */
            std::string ConstructFuncSignature(const Function &function);
    };
}