ScriptFormatter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 The V-Gears Team
 *
 * This file is part of V-Gears
 *
 * V-Gears is free software: you can redistribute it and/or modify it under
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, version 3.0 (GPLv3) of the License.
 *
 * V-Gears 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.
 */
 
#pragma once
 
#include <map>
#include <vector>
#include <string>
 
#include "DecompilerException.h"
 
class ScriptFormatter{
 
    public:
 
        virtual ~ScriptFormatter() = default;
 
        virtual std::string GetFriendlyVarName(unsigned int bank, unsigned int addr);
 
        virtual std::string GetFriendlyEntityName(const std::string& entity_name);
 
        virtual std::string GetFriendlyAnimationName(int animation_id, int id);
 
        virtual std::string GetFriendlyCharName(int char_id);
 
        virtual std::string GetFriendlyFunctionName(
          const std::string& entity_name, const std::string& function_name
        );
 
        virtual std::string GetFunctionComment(
          const std::string& entity_name, const std::string& function_name
        );
};