Elaztek Developer Hub
Blamite Game Engine - Guerilla (Library)  00390.07.02.23.1947.blamite
The tag editor for the Blamite Game Engine.
block.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <vector>
4 #include <string>
5 
6 #include "../fields.h"
7 
8 #ifdef GUERILLA_LIB_EXPORTS
9 #define GUERILLA_LIB_API __declspec(dllexport)
10 #else
11 #define GUERILLA_LIB_API __declspec(dllimport)
12 #endif
13 
18 {
19 public:
20  std::string name;
21  std::vector<BlamTagField*> fields;
22 
24 
33  BlamTagField* GetField(std::string field_id);
34 
44  BlamTagField* GetField(std::string field_id, BlamTagFieldType field_type);
45 
54  BlamTagBlockEntry* Copy();
55 };
56 
67 {
68 public:
69  int entry_size = 0;
70  std::vector<BlamPluginField*> fields;
71 
72  int c_entry_count = 0;
73  int c_entry_offset = 0;
74  int max_entry_count = -1;
75 
82 
84 
93  BlamPluginField* GetField(std::string id);
94 
104  BlamPluginField* GetField(std::string id, BlamTagFieldType type);
105 
106  void UpdateOffsetData(int new_offset) override;
107  std::string GenerateXMLString() override;
108  std::string GenerateCppStructString(std::string line_prefix = "", bool generate_doxygen_comments = true) override;
109  std::string GenerateCppStructString(std::string line_prefix = "", bool include_comments = true, bool generate_doxygen_comments = true, bool include_comment_descriptions = true);
110  std::string GenerateCppClassString(std::string line_prefix = "") override;
111  bool ParseXMLData(rapidxml::xml_node<>* field_node) override;
112  BlamTagField* GenerateTagField(BlamTag* tag, void* address) override;
113  BlamTagField* GenerateTagField(BlamTag* tag) override;
114 };
115 
126 {
127 public:
128  std::vector<BlamTagBlockEntry*> entries;
129 
136 
145  bool AddEntry(int offset = -1);
146 
154  bool DuplicateEntry(int index);
155 
163  bool DeleteEntry(int index);
164 
168  void DeleteAllEntries();
169 
179  BlamTagBlockEntry* CreateNewEntry();
180 
189  std::string GenerateXMLString(bool keep_unused, bool keep_invalid);
190 
196  std::vector<char> GetEntryDataAsBytes();
197 
198  std::string GenerateXMLString() override;
199  std::vector<char> GetValueAsBytes() override;
200 };
BlamTagField
Class representing a tag field.
Definition: fields.h:261
comment.h
block.h
BlamTagField::GetType
BlamTagFieldType GetType()
Retrieves the type of this field.
Definition: BlamTagField.cpp:19
BlamPluginField::GenerateTagField
virtual BlamTagField * GenerateTagField(BlamTag *tag)
Generates a new tag field from this plugin field.
Definition: BlamPluginField.cpp:41
bitfield.h
BlamPluginField_Block::entry_size
int entry_size
The size of a each block entry.
Definition: block.h:69
BlamTagBlockEntry::Copy
BlamTagBlockEntry * Copy()
Creates a copy of this block entry.
Definition: BlamTagBlockEntry.cpp:45
BlamPluginField_Bitfield::GenerateCppClassString
std::string GenerateCppClassString(std::string line_prefix="") override
Generates a string containing C++ code representing this plugin field.
Definition: BlamPluginField_Bitfield.cpp:54
BlamPluginField_Block::GetField
BlamPluginField * GetField(std::string id)
Locates a field within the entry template with a specified ID.
Definition: BlamPluginField_Block.cpp:25
BlamTagField_Bitfield::bits
std::vector< BlamBitfieldBitData > bits
The list of bits within this bitfield.
Definition: bitfield.h:67
tags.h
BlamTagField::GetPluginField
BlamPluginField * GetPluginField()
Retrieves the plugin data associated with this field, if available.
Definition: BlamTagField.cpp:29
BlamPluginField::GenerateXMLString
virtual std::string GenerateXMLString()
Generates a string representing this plugin field.
Definition: BlamPluginField.cpp:61
BlamTagField::GetTag
BlamTag * GetTag()
Retrieves the tag associated with this field.
Definition: BlamTagField.cpp:24
BlamTagFieldType::Block
@ Block
Indicates that the field is a tag block.
BlamPlugin::ParseField
BlamPluginField * ParseField(rapidxml::xml_node<> *field_node)
Attempts to parse an XML node as a plugin field.
Definition: BlamPlugin.cpp:65
BlamTagField_Block::entries
std::vector< BlamTagBlockEntry * > entries
The list of entries within this block.
Definition: block.h:128
BlamPluginField_Block::~BlamPluginField_Block
~BlamPluginField_Block()
Definition: BlamPluginField_Block.cpp:15
BlamPluginField_Block::GenerateCppStructString
std::string GenerateCppStructString(std::string line_prefix="", bool generate_doxygen_comments=true) override
Generates a string containing C++ code representing this plugin field.
Definition: BlamPluginField_Block.cpp:100
BlamPluginField_Bitfield::GenerateCppStructString
std::string GenerateCppStructString(std::string line_prefix="", bool generate_doxygen_comments=true) override
Generates a string containing C++ code representing this plugin field.
Definition: BlamPluginField_Bitfield.cpp:42
BlamPluginField::default_value
std::string default_value
The default text value for the field.
Definition: fields.h:116
BlamTagField::field_id
std::string field_id
The ID of this field.
Definition: fields.h:272
BlamPluginField_Bitfield::GenerateTagField
BlamTagField * GenerateTagField(BlamTag *tag, void *address) override
Generates a new tag field from this plugin field.
Definition: BlamPluginField_Bitfield.cpp:159
BlamPluginField::input_hint
std::string input_hint
An additional piece of short text that can be used to suggest valid input for a field.
Definition: fields.h:114
BlamPluginField::GetType
BlamTagFieldType GetType()
Retrieves the type of this field.
Definition: BlamPluginField.cpp:31
BlamPluginField_Bitfield::GenerateXMLString
std::string GenerateXMLString() override
Generates a string representing this plugin field.
Definition: BlamPluginField_Bitfield.cpp:23
BlamTagField_Block::GenerateXMLString
std::string GenerateXMLString(bool keep_unused, bool keep_invalid)
Generates a string with the field ID and value, ready to be written to an XML file.
Definition: BlamTagField_Block.cpp:133
BlamTagBlockEntry
Data structure representing a tag block entry.
Definition: block.h:17
BlamTagField_Block::DeleteAllEntries
void DeleteAllEntries()
Deletes all block entries from the field.
Definition: BlamTagField_Block.cpp:82
BlamTagField_Block::GetEntryDataAsBytes
std::vector< char > GetEntryDataAsBytes()
Compiles the entry data into a list of bytes.
Definition: BlamTagField_Block.cpp:211
BlamTagFieldType::Bitfield16
@ Bitfield16
Indicates that the field is a Bitfield16.
BlamTagFieldType
BlamTagFieldType
Enumerator containing all possible tag field types.
Definition: fields.h:65
BlamBitfieldBitInfo::index
int index
The bit's index.
Definition: bitfield.h:22
BlamPluginField_Block
Class representing a block plugin field.
Definition: block.h:66
BlamTagFieldType::Comment
@ Comment
Indicates that the field is a comment. These do not store any tag data.
BlamTagField::GenerateXMLString
virtual std::string GenerateXMLString()
Generates a string with the field ID and value, ready to be written to an XML file.
Definition: BlamTagField.cpp:9
Guerilla::Tags::Fields::GetFieldTypeName
GUERILLA_LIB_API std::string GetFieldTypeName(BlamTagFieldType type)
Generates a string name based on the provided tag field type.
Definition: fields.cpp:222
BlamPlugin::file_path
std::string file_path
The path to the plugin file.
Definition: tags.h:119
BlamPluginField::UpdateOffsetData
virtual void UpdateOffsetData(int new_offset)
Updates any offsets or lengths for the given field.
Definition: BlamPluginField.cpp:91
BlamBitfieldBitInfo::id
std::string id
The ID of the bit.
Definition: bitfield.h:20
BlamTagField_Block::DeleteEntry
bool DeleteEntry(int index)
Deletes a specific block entry from the field.
Definition: BlamTagField_Block.cpp:63
BlamPluginField::display_name
std::string display_name
The display name of the field.
Definition: fields.h:111
BlamTagField_Bitfield
Clas representing a bitfield tag field.
Definition: bitfield.h:64
BlamTagField_Block
Class representing a block tag field.
Definition: block.h:125
BlamTagBlockEntry::GetField
BlamTagField * GetField(std::string field_id)
Locates a field within the entry with a specified ID.
Definition: BlamTagBlockEntry.cpp:13
BlamPluginField
Class representing a plugin field.
Definition: fields.h:101
BlamPluginField_Comment
Class representing a comment plugin field.
Definition: comment.h:30
BlamTagField_Bitfield::BlamTagField_Bitfield
BlamTagField_Bitfield(BlamTag *_tag, BlamTagFieldType _type)
Constructs a new bitfield tag field.
Definition: BlamTagField_Bitfield.cpp:15
BlamTag
Class representing a Tag.
Definition: tags.h:277
BlamTagField_Block::GetValueAsBytes
std::vector< char > GetValueAsBytes() override
Retrieves the field value as a list of bytes.
Definition: BlamTagField_Block.cpp:185
BlamPluginField::BlamPluginField
BlamPluginField(BlamPlugin *_plugin, BlamTagFieldType _type)
Constructs a new plugin field.
Definition: BlamPluginField.cpp:9
BlamTagField_Block::BlamTagField_Block
BlamTagField_Block(BlamTag *_tag)
Constructs a new block tag field.
Definition: BlamTagField_Block.cpp:3
BlamPluginField_Block::GenerateXMLString
std::string GenerateXMLString() override
Generates a string representing this plugin field.
Definition: BlamPluginField_Block.cpp:84
GUERILLA_LIB_API
#define GUERILLA_LIB_API
Definition: block.h:11
BlamPluginField_Bitfield::BlamPluginField_Bitfield
BlamPluginField_Bitfield(BlamPluginField *base_field)
Constructs a new bitfield plugin field from an existing generic plugin field.
Definition: BlamPluginField_Bitfield.cpp:18
BlamPluginField::visible
bool visible
Whether or not the field is visible.
Definition: fields.h:110
BlamTagField::HasPluginField
bool HasPluginField()
Checks whether the field has plugin data available.
Definition: BlamTagField.cpp:34
BlamPluginField::ParseXMLData
virtual bool ParseXMLData(rapidxml::xml_node<> *field_node)
Populates data within the plugin field from an XML node.
Definition: BlamPluginField.cpp:106
BlamTagBlockEntry::fields
std::vector< BlamTagField * > fields
The list of fields within the entry.
Definition: block.h:21
BlamBitfieldBitInfo::name
std::string name
The display name of the bit.
Definition: bitfield.h:21
BlamTagBlockEntry::~BlamTagBlockEntry
~BlamTagBlockEntry()
Definition: BlamTagBlockEntry.cpp:3
BlamPlugin
Class representing a Plugin.
Definition: tags.h:79
BlamPluginField::field_id
std::string field_id
The ID of the field.
Definition: fields.h:113
BlamTagField_Block::CreateNewEntry
BlamTagBlockEntry * CreateNewEntry()
Creates a new block entry based on the plugin's entry template.
Definition: BlamTagField_Block.cpp:99
fields.h
BlamPluginField_Bitfield
Clas representing a bitfield plugin field.
Definition: bitfield.h:39
BlamPluginField::ChangeType
void ChangeType(BlamTagFieldType new_type)
Changes the type of a plugin field.
Definition: BlamPluginField.cpp:217
BlamPluginField_Bitfield::ParseXMLData
bool ParseXMLData(rapidxml::xml_node<> *field_node) override
Populates data within the plugin field from an XML node.
Definition: BlamPluginField_Bitfield.cpp:88
BlamTagFieldType::Bitfield8
@ Bitfield8
Indicates that the field is a Bitfield8.
BlamPluginField_Block::c_entry_count
int c_entry_count
The entry count. Used in tag decompilation.
Definition: block.h:72
BlamPluginField_Block::fields
std::vector< BlamPluginField * > fields
The list of fields within the tag block.
Definition: block.h:70
BlamTagField_Block::DuplicateEntry
bool DuplicateEntry(int index)
Copies a specific block entry within the field.
Definition: BlamTagField_Block.cpp:42
BlamPluginField_Block::UpdateOffsetData
void UpdateOffsetData(int new_offset) override
Updates any offsets or lengths for the given field.
Definition: BlamPluginField_Block.cpp:67
Guerilla::Tags::Fields::GetStandardFieldLength
GUERILLA_LIB_API int GetStandardFieldLength(BlamTagFieldType type)
Retrieves the length of a tag field.
Definition: fields.cpp:118
BlamPluginField_Block::GenerateTagField
BlamTagField * GenerateTagField(BlamTag *tag, void *address) override
Generates a new tag field from this plugin field.
Definition: BlamPluginField_Block.cpp:237
BlamTagField::plugin_field
BlamPluginField * plugin_field
The plugin data associated with this field, if any.
Definition: fields.h:271
BlamTagField::BlamTagField
BlamTagField(BlamTag *_tag, BlamTagFieldType _type)
Constructs a new tag field.
Definition: BlamTagField.cpp:3
GUERILLA_SET_BITFIELD_BIT
#define GUERILLA_SET_BITFIELD_BIT(index)
Definition: BlamTagField_Bitfield.cpp:6
BlamPluginField::description
std::string description
An optional description of the field.
Definition: fields.h:112
BlamTagFieldType::Unspecified
@ Unspecified
Indicates that the field's type is not specified. Fields with this type should be considered invalid.
BlamPluginField_Block::c_entry_offset
int c_entry_offset
The offset of the entry data. Used in tag decompilation.
Definition: block.h:73
BlamPluginField_Bitfield::bits
std::vector< BlamBitfieldBitInfo > bits
The list of bits within this bitfield.
Definition: bitfield.h:42
BlamPluginField_Block::GenerateCppClassString
std::string GenerateCppClassString(std::string line_prefix="") override
Generates a string containing C++ code representing this plugin field.
Definition: BlamPluginField_Block.cpp:143
BlamPluginField::GetPlugin
BlamPlugin * GetPlugin()
Retrieves the plugin this field is associated with.
Definition: BlamPluginField.cpp:36
BlamTagFieldType::Bitfield32
@ Bitfield32
Indicates that the field is a Bitfield32.
BlamPluginField::offset
int offset
The offset of the field data.
Definition: fields.h:108
BlamTagBlockEntry::name
std::string name
The name of the entry.
Definition: block.h:20
GUERILLA_BITFIELD_DECOMPILE_SET_BITFIELD_BIT
#define GUERILLA_BITFIELD_DECOMPILE_SET_BITFIELD_BIT(index)
Definition: BlamPluginField_Bitfield.cpp:9
BlamBitfieldBitData
Data structure containing data for a bitfield bit.
Definition: bitfield.h:28
BlamTagField_Bitfield::GenerateXMLString
std::string GenerateXMLString()
Generates a string with the field ID and value, ready to be written to an XML file.
Definition: BlamTagField_Bitfield.cpp:20
BlamPluginField::GenerateCppClassString
virtual std::string GenerateCppClassString(std::string line_prefix="")
Generates a string containing C++ code representing this plugin field.
Definition: BlamPluginField.cpp:101
BlamPluginField::length
int length
The length of the field data.
Definition: fields.h:109
BlamTagField_Bitfield::GetValueAsBytes
std::vector< char > GetValueAsBytes()
Retrieves the field value as a list of bytes.
Definition: BlamTagField_Bitfield.cpp:54
BlamTagField_Block::AddEntry
bool AddEntry(int offset=-1)
Adds a new entry to the field.
Definition: BlamTagField_Block.cpp:8
BlamPluginField::GenerateCppStructString
virtual std::string GenerateCppStructString(std::string line_prefix="", bool generate_doxygen_comments=true)
Generates a string containing C++ code representing this plugin field.
Definition: BlamPluginField.cpp:96
BlamTagField_Block::GenerateXMLString
std::string GenerateXMLString() override
Generates a string with the field ID and value, ready to be written to an XML file.
Definition: BlamTagField_Block.cpp:128
BlamTagField::GetValueAsBytes
virtual std::vector< char > GetValueAsBytes()
Retrieves the field value as a list of bytes.
Definition: BlamTagField.cpp:14
BlamPluginField_Block::max_entry_count
int max_entry_count
The maximum number of entries this block can contain.
Definition: block.h:74
BlamPluginField_Block::BlamPluginField_Block
BlamPluginField_Block(BlamPluginField *base_field)
Constructs a new block plugin field from an existing generic plugin field.
Definition: BlamPluginField_Block.cpp:10
BlamPluginField_Block::ParseXMLData
bool ParseXMLData(rapidxml::xml_node<> *field_node) override
Populates data within the plugin field from an XML node.
Definition: BlamPluginField_Block.cpp:167
BlamBitfieldBitInfo
Data structure containing extra data for a bitfield bit.
Definition: bitfield.h:18
BlamPluginField_Comment::GenerateCppStructString
std::string GenerateCppStructString(std::string line_prefix="", bool generate_doxygen_comments=true) override
Generates a string containing C++ code representing this plugin field.
Definition: BlamPluginField_Comment.cpp:51