fields.h

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <vector>
#include <blam/api/v1/types/tags.h>
#include <Strings/components/3rdparty/rapidxml/rapidxml.hpp>
 
#ifndef GUERILLA_LIB_INTERNAL
#define GUERILLA_LIB_INTERNAL
#endif
 
#ifdef GUERILLA_LIB_EXPORTS
#define GUERILLA_LIB_API __declspec(dllexport) 
#else
#define GUERILLA_LIB_API __declspec(dllimport) 
#endif
 
class BlamTag;
class BlamPlugin;
 
struct BlamPluginExportOptions
{
    bool include_comments = true; 
    bool generate_doxygen_comments = true; 
 
    bool export_legacy_bitfields = false;
 
    bool export_comment_descriptions = true; 
};
 
enum class BlamDatarefValueHintType
{
    ASM,  
    BASH, 
    C,    
    CPP,  
    CMK,  
    CS,   
    CSS,  
    GO,   
    HSC,  
    HTML, 
    INI,  
    JS,   
    JAVA, 
    JSON, 
    LUA,  
    MAKE, 
    PHP,  
    PY,   
    QML,  
    RUST, 
    SQL,  
    TEXT, 
    TS,   
    V,    
    VEX,  
    XML,  
    YAML, 
    NONE  
};
 
class BlamTagField;
 
class GUERILLA_LIB_API BlamPluginField
{
private:
    BlamTagFieldType type = BlamTagFieldType::Unspecified; 
    BlamPlugin* plugin = nullptr; 
 
public:
    int offset = 0x0;    
    int length = 0x0;    
    bool visible = true; 
    std::string display_name = ""; 
    std::string description = "";  
    std::string field_id = "";     
    std::string input_hint = "";   
    bool require_unused_visible = false; 
    std::string default_value = ""; 
 
    BlamPluginField(BlamPlugin* _plugin, BlamTagFieldType _type);
 
    BlamPluginField(BlamPluginField* _old_field);
 
    BlamTagFieldType GetType();
 
    BlamPlugin* GetPlugin();
 
    virtual BlamTagField* GenerateTagField(BlamTag* tag);
 
    virtual BlamTagField* GenerateTagField(BlamTagField* existing_tag_field);
 
    virtual BlamTagField* GenerateTagField(BlamTag* tag, void* address);
 
    virtual std::string GenerateXMLString();
 
    virtual void UpdateOffsetData(int new_offset);
 
    virtual std::string GenerateCppStructString(std::string line_prefix = "", BlamPluginExportOptions options = BlamPluginExportOptions());
 
    virtual std::string GenerateCppClassString(std::string line_prefix = "");
 
    virtual bool ParseXMLData(rapidxml::xml_node<>* field_node);
 
    virtual BlamPluginField* Copy(BlamPlugin* new_plugin);
 
    void ChangeType(BlamTagFieldType new_type);
};
 
class GUERILLA_LIB_API BlamTagField
{
private:
    BlamTagFieldType type = BlamTagFieldType::Unspecified; 
    BlamTag* tag = nullptr; 
 
public:
    int c_entry_index = 0; 
    int c_entry_size = 0;  
    int c_file_offset = 0; 
 
    BlamPluginField* plugin_field = nullptr; 
    std::string field_id = ""; 
 
    BlamTagField(BlamTag* _tag, BlamTagFieldType _type);
 
    virtual std::string GenerateXMLString();
 
    virtual std::vector<char> GetValueAsBytes();
    
    BlamTagFieldType GetType();
 
    BlamTag* GetTag();
 
    BlamPluginField* GetPluginField();
 
    bool HasPluginField();
};
 
namespace Guerilla::Tags::Fields
{
    GUERILLA_LIB_API int GetStandardFieldLength(BlamTagFieldType type);
 
    GUERILLA_LIB_API BlamTagFieldType DetermineFieldType(std::string node_name);
 
    GUERILLA_LIB_API std::string GetFieldTypeName(BlamTagFieldType type);
 
    GUERILLA_LIB_API BlamPluginField* ConfigurePluginField(BlamPluginField* field, BlamTagFieldType field_type, bool* configured = nullptr);
 
    GUERILLA_LIB_API std::string GetDatarefValueHintString(BlamDatarefValueHintType value_hint);
 
    GUERILLA_LIB_API BlamDatarefValueHintType ParseDatarefValueHint(std::string value_hint_str);
 
    GUERILLA_LIB_API std::vector<BlamDatarefValueHintType> GetDatarefValueHintTypeList();
    GUERILLA_LIB_API std::vector<BlamPluginField*> GetGlobalEnums(std::vector<BlamPluginField*> field_list, bool get_global_parents);
}