cleanup/doc JMessage / d_msg_class (#2484)

* jmessage cleanup pass

* more JMessage cleanup

* d_msg_class cleanup
This commit is contained in:
TakaRikka
2025-06-13 05:33:33 -07:00
committed by GitHub
parent 7f6be99616
commit bf8a906790
24 changed files with 3660 additions and 3302 deletions
+129 -116
View File
@@ -2,7 +2,8 @@
#define JMESSAGE_PROCESSOR_H
#include "JSystem/JMessage/resource.h"
#include "algorithm.h"
#include <algorithm.h>
#include "global.h"
namespace JMessage {
struct TResource;
@@ -18,15 +19,15 @@ struct TReference {
/* 802A7AF8 */ virtual ~TReference();
/* 802A7B40 */ virtual const char* do_word(u32) const;
int on_parseCharacter(const char** string) const { return pcResource_->parseCharacter(string); }
int on_parseCharacter(const char** ppszText) const {
JUT_ASSERT(97, pcResource_!=0);
return pcResource_->parseCharacter(ppszText);
}
const char* on_word(u32 param_0) const { return do_word(param_0); }
TResource* getResource_groupID(u16 groupID) const {
if (pcResource_ == NULL) {
return NULL;
}
return pcResource_->getResource_groupID(groupID);
TResource* getResource_groupID(u16 u16GroupID) const {
return pcResource_ == NULL ? NULL : pcResource_->getResource_groupID(u16GroupID);
}
TResourceContainer* getResourceContainer() const { return pcResource_; }
@@ -40,8 +41,13 @@ struct TReference {
*
*/
struct TProcessor {
TProcessor(const TReference* reference)
: pReference_(reference), pResourceCache_(NULL), pszCurrent_(NULL) {}
TProcessor(const TReference* pReference)
: pReference_(pReference),
pResourceCache_(NULL),
pszCurrent_(NULL)
{
JUT_ASSERT(584, pReference_!=0);
}
typedef bool (*pfnProcess_func)(TProcessor*);
@@ -55,14 +61,25 @@ struct TProcessor {
u32 max_size() const { return 4; }
u32 size() const { return upsz_; }
const char* top() const { return stack[upsz_ - 1]; }
const char* top() const {
JUT_ASSERT(181, upsz_>0);
return stack[upsz_ - 1];
}
void push(const char* string) {
stack[upsz_] = string;
void push(const char* pszText) {
JUT_ASSERT(186, IsPushable());
stack[upsz_] = pszText;
upsz_++;
}
void pop() { upsz_--; }
void pop() {
JUT_ASSERT(192, upsz_>0);
upsz_--;
#if PLATFORM_SHIELD
stack[upsz_] = NULL;
#endif
}
TStack_& operator=(const TStack_& other) {
upsz_ = other.upsz_;
@@ -79,11 +96,11 @@ struct TProcessor {
struct TProcess_ {
TProcess_() { reset_normal(); }
void reset_normal() { pfnProcess_CharacterEnd = process_onCharacterEnd_normal_; }
void reset_select() { pfnProcess_CharacterEnd = process_onCharacterEnd_select_; }
void reset_normal() { pfnProcess_onCharacterEnd = process_onCharacterEnd_normal_; }
void reset_select() { pfnProcess_onCharacterEnd = process_onCharacterEnd_select_; }
/* 0x0 */ pfnProcess_func pfnProcess_CharacterEnd;
struct {
/* 0x0 */ pfnProcess_func pfnProcess_onCharacterEnd;
struct rdata {
/* 0x0 */ const char* (*pfn)(TProcessor*);
/* 0x4 */ const char* pcBase;
/* 0x8 */ const void* pOffset;
@@ -93,51 +110,50 @@ struct TProcessor {
}; // Size: 0x14
/* 802A7B90 */ void reset();
/* 802A7BF8 */ void stack_pushCurrent(char const*);
/* 802A7BF8 */ void stack_pushCurrent(char const* pszText);
/* 802A7C30 */ void stack_popCurrent();
/* 802A7C54 */ const TResource* getResource_groupID(u16) const;
/* 802A7CD4 */ u32 toMessageCode_messageID(u32, u32, bool*) const;
/* 802A7E38 */ void on_select_begin(char const* (*)(JMessage::TProcessor*), void const*,
char const*, u32);
/* 802A7C54 */ const TResource* getResource_groupID(u16 u16GroupID) const;
/* 802A7CD4 */ u32 toMessageCode_messageID(u32 uMsgID, u32, bool* pbValid) const;
/* 802A7E38 */ void on_select_begin(char const* (*pfn)(JMessage::TProcessor*), void const* pOffset,
char const* pcBase, u32 uNumber);
/* 802A7EDC */ void on_select_end();
/* 802A7F34 */ void on_select_separate();
/* 802A7FE4 */ void on_tag_();
/* 802A8090 */ // void do_tag_(u32, void const*, u32);
/* 802A81EC */ bool process_character_();
/* 802A828C */ static bool process_onCharacterEnd_normal_(JMessage::TProcessor*);
/* 802A82F4 */ static bool process_onCharacterEnd_select_(JMessage::TProcessor*);
/* 802A833C */ static const char* process_onSelect_limited_(JMessage::TProcessor*);
/* 802A8358 */ static const char* process_onSelect_(JMessage::TProcessor*);
/* 802A8C24 */ const char* on_message(u32 param_0) const { return getMessageText_messageCode(param_0); }
/* 802A8C44 */ const char* getMessageText_messageCode(u32 param_0) const {
return getMessageText_messageCode(param_0 >> 0x10, param_0 & 0xFFFF);
/* 802A828C */ static bool process_onCharacterEnd_normal_(JMessage::TProcessor* pThis);
/* 802A82F4 */ static bool process_onCharacterEnd_select_(JMessage::TProcessor* pThis);
/* 802A833C */ static const char* process_onSelect_limited_(JMessage::TProcessor* pThis);
/* 802A8358 */ static const char* process_onSelect_(JMessage::TProcessor* pThis);
/* 802A8C24 */ const char* on_message(u32 uCode) const { return getMessageText_messageCode(uCode); }
/* 802A8C44 */ const char* getMessageText_messageCode(u32 uCode) const {
return getMessageText_messageCode(uCode >> 16, uCode & 0xFFFF);
}
/* 802A7B48 */ virtual ~TProcessor();
/* 802A7FC0 */ virtual void do_reset();
/* 802A7FC4 */ virtual void do_begin(void const*, char const*);
/* 802A7FC4 */ virtual void do_begin(void const* pEntry, char const* pszText);
/* 802A7FC8 */ virtual void do_end();
/* 802A7FCC */ virtual void do_character(int);
/* 802A7FD0 */ virtual bool do_tag(u32, void const*, u32);
/* 802A7FD8 */ virtual void do_select_begin(u32);
/* 802A7FCC */ virtual void do_character(int iCharacter);
/* 802A7FD0 */ virtual bool do_tag(u32 uTag, void const* pData, u32 uSize);
/* 802A7FD8 */ virtual void do_select_begin(u32 uNumber);
/* 802A7FDC */ virtual void do_select_end();
/* 802A7FE0 */ virtual void do_select_separate();
/* 802A8084 */ virtual void do_resetStatus_(char const*);
/* 802A8084 */ virtual void do_resetStatus_(char const* pszText);
/* 802A8088 */ virtual bool do_setBegin_isReady_() const;
virtual void do_begin_(void const*, char const*) = 0;
virtual void do_begin_(void const* pEntry, char const* pszText) = 0;
virtual void do_end_() = 0;
virtual void do_tag_(u32, void const*, u32) = 0;
virtual void do_tag_(u32 uTag, void const* pData, u32 uSize) = 0;
void on_resetStatus_(const char* param_0) {
pszCurrent_ = param_0;
void on_resetStatus_(const char* pszText) {
pszCurrent_ = pszText;
oStack_.clear();
oProcess_.reset_normal();
do_resetStatus_(param_0);
do_resetStatus_(pszText);
}
void on_begin(const void* entry, const char* param_1) {
do_begin_(entry, param_1);
do_begin(entry, param_1);
void on_begin(const void* pEntry, const char* pszText) {
do_begin_(pEntry, pszText);
do_begin(pEntry, pszText);
}
void on_end() {
@@ -145,49 +161,52 @@ struct TProcessor {
do_end();
}
void on_tag(u32 param_0, const void* param_1, u32 param_2) {
if (!do_tag(param_0, param_1, param_2)) {
do_tag_(param_0, param_1, param_2);
void on_tag(u32 uTag, const void* pData, u32 uSize) {
if (!do_tag(uTag, pData, uSize)) {
do_tag_(uTag, pData, uSize);
}
}
const char* on_word(u32 param_0) const { return pReference_->on_word(param_0); }
int on_parseCharacter(const char** string) const {
return pReference_->on_parseCharacter(string);
int on_parseCharacter(const char** ppszText) const {
return pReference_->on_parseCharacter(ppszText);
}
void on_character(int character) { do_character(character); }
void on_character(int iCharacter) { do_character(iCharacter); }
const char* on_message_limited(u16 messageIndex) const {
return pResourceCache_->getMessageText_messageIndex(messageIndex);
const char* on_message_limited(u16 u16Index) const {
JUT_ASSERT(482, pResourceCache_!=0);
return pResourceCache_->getMessageText_messageIndex(u16Index);
}
int setBegin_messageEntryText(const TResource* resource, const void* entry,
const char* param_2) {
pResourceCache_ = resource;
on_resetStatus_(param_2);
on_begin(entry, param_2);
bool on_setBegin_isReady_() const { return do_setBegin_isReady_(); }
int setBegin_messageEntryText(const TResource* pResource, const void* pEntry, const char* pszText) {
JUT_ASSERT(297, on_setBegin_isReady_());
pResourceCache_ = pResource;
on_resetStatus_(pszText);
on_begin(pEntry, pszText);
return 1;
}
int setBegin_messageEntryText(const TProcessor* processor, const void* entry,
const char* param_2) {
setBegin_messageEntryText(processor->getResourceCache(), entry, param_2);
int setBegin_messageEntryText(const TProcessor* pProcessor, const void* pEntry, const char* pszText) {
JUT_ASSERT(306, pProcessor!=0);
setBegin_messageEntryText(pProcessor->getResourceCache(), pEntry, pszText);
return 1;
}
void* getMessageEntry_messageCode(u16 messageCode, u16 messageIndex) const {
const TResource* pResource = getResource_groupID(messageCode);
void* getMessageEntry_messageCode(u16 u16Code, u16 u16Index) const {
const TResource* pResource = getResource_groupID(u16Code);
if (pResource == NULL) {
return NULL;
}
return pResource->getMessageEntry_messageIndex(messageIndex);
return pResource->getMessageEntry_messageIndex(u16Index);
}
const char* getMessageText_messageCode(u16 messageCode, u16 messageIndex) const {
void* pEntry = getMessageEntry_messageCode(messageCode, messageIndex);
const char* getMessageText_messageCode(u16 u16Code, u16 u16Index) const {
void* pEntry = getMessageEntry_messageCode(u16Code, u16Index);
if (pEntry == NULL) {
return NULL;
@@ -196,9 +215,9 @@ struct TProcessor {
return pResourceCache_->getMessageText_messageEntry(pEntry);
}
void stack_pushCurrent_(const char* string) {
void stack_pushCurrent_(const char* pszText) {
oStack_.push(getCurrent());
pszCurrent_ = string;
pszCurrent_ = pszText;
}
void stack_popCurrent_() {
@@ -212,27 +231,23 @@ struct TProcessor {
const char* getCurrent() const { return pszCurrent_; }
const TReference* getReference() const { return pReference_; }
const TResource* getResource_groupID_uncached(u16 groupID) const {
return pReference_->getResource_groupID(groupID);
const TResource* getResource_groupID_uncached(u16 u16GroupID) const {
return pReference_->getResource_groupID(u16GroupID);
}
bool isResourceCache_groupID(u16 groupID) const {
return pResourceCache_ != NULL && groupID == pResourceCache_->getGroupID();
bool isResourceCache_groupID(u16 u16GroupID) const {
return pResourceCache_ != NULL && u16GroupID == pResourceCache_->getGroupID();
}
TResourceContainer* getResourceContainer() const {
if (pReference_ == NULL) {
return NULL;
}
return pReference_->getResourceContainer();
return pReference_ == NULL ? NULL : pReference_->getResourceContainer();
}
void setResourceCache(TResource* cache) { pResourceCache_ = cache; }
void setResourceCache(TResource* pResource) { pResourceCache_ = pResource; }
void resetResourceCache() { setResourceCache(NULL); }
/* 0x04 */ const TReference* pReference_;
/* 0x08 */ const TResource* pResourceCache_;
/* 0x08 */ const mutable TResource* pResourceCache_;
/* 0x0C */ const char* pszCurrent_;
/* 0x10 */ TStack_ oStack_;
/* 0x24 */ TProcess_ oProcess_;
@@ -253,13 +268,13 @@ struct TSequenceProcessor : public TProcessor {
void reset() {}
union {
struct {
union processData {
struct branchData {
/* 0x0 */ branchPfn branchFn;
/* 0x4 */ const void* pTarget;
/* 0x8 */ u32 uTarget;
} branch_process;
struct {
struct jumpData {
/* 0x0 */ jumpPfn jumpFn;
/* 0x4 */ u32 u32Target;
} jump_process;
@@ -275,48 +290,45 @@ struct TSequenceProcessor : public TProcessor {
STATUS_BRANCH,
};
/* 802A8374 */ TSequenceProcessor(JMessage::TReference const*, JMessage::TControl*);
/* 802A8418 */ const char* process(char const*);
/* 802A8374 */ TSequenceProcessor(JMessage::TReference const* pReference, JMessage::TControl* pControl);
/* 802A8418 */ const char* process(char const* pszText);
/* 802A85A4 */ bool on_isReady();
/* 802A85D0 */ void on_jump_register(void const* (*)(JMessage::TSequenceProcessor const*), u32);
/* 802A85D0 */ void on_jump_register(jumpPfn pfn, u32 u32Target);
/* 802A85E4 */ bool on_jump_isReady();
/* 802A8610 */ void on_jump(void const*, char const*);
/* 802A8690 */ void
on_branch_register(void const* (*)(JMessage::TSequenceProcessor const*, u32), void const*, u32);
/* 802A86A0 */ void on_branch_query(u32);
/* 802A8610 */ void on_jump(void const* pEntry, char const* pszText);
/* 802A8690 */ void on_branch_register(branchPfn pfn, void const* pTarget, u32 uTarget);
/* 802A86A0 */ void on_branch_query(u32 uCode);
/* 802A86D4 */ u32 on_branch_queryResult();
/* 802A8700 */ void on_branch(void const*, char const*);
/* 802A892C */ static void process_setMessageIndex_reserved_(u16);
/* 802A8944 */ static void* process_setMessageCode_(JMessage::TSequenceProcessor const*, u16,
u16);
/* 802A89B8 */ static const void* process_onJump_limited_(JMessage::TSequenceProcessor const*);
/* 802A89EC */ static const void* process_onJump_(JMessage::TSequenceProcessor const*);
/* 802A8A18 */ static const void* process_onBranch_limited_(JMessage::TSequenceProcessor const*,
u32);
/* 802A8A50 */ static const void* process_onBranch_(JMessage::TSequenceProcessor const*, u32);
/* 802A8700 */ void on_branch(void const* pEntry, char const* pszText);
/* 802A892C */ static void process_setMessageIndex_reserved_(u16 u16Index);
/* 802A8944 */ static void* process_setMessageCode_(TSequenceProcessor const* pProcessor, u16 u16GroupID, u16 u16Index);
/* 802A89B8 */ static const void* process_onJump_limited_(TSequenceProcessor const* pProcessor);
/* 802A89EC */ static const void* process_onJump_(TSequenceProcessor const* pProcessor);
/* 802A8A18 */ static const void* process_onBranch_limited_(TSequenceProcessor const* pProcessor, u32 uTargetIndex);
/* 802A8A50 */ static const void* process_onBranch_(TSequenceProcessor const* pProcessor, u32 uTargetIndex);
/* 802A83B8 */ virtual ~TSequenceProcessor();
/* 802A87A4 */ virtual void do_resetStatus_(char const*);
/* 802A87A4 */ virtual void do_resetStatus_(char const* pszText);
/* 802A87C0 */ virtual bool do_setBegin_isReady_() const;
/* 802A87D0 */ virtual void do_begin_(void const*, char const*);
/* 802A87D0 */ virtual void do_begin_(void const* pEntry, char const* pszText);
/* 802A87D4 */ virtual void do_end_();
/* 802A87E0 */ virtual void do_tag_(u32, void const*, u32);
/* 802A87E0 */ virtual void do_tag_(u32 uTag, void const* pData, u32 uSize);
/* 802A8780 */ virtual bool do_isReady();
/* 802A8788 */ virtual bool do_jump_isReady();
/* 802A8790 */ virtual void do_jump(void const*, char const*);
/* 802A8794 */ virtual void do_branch_query(u32);
/* 802A8790 */ virtual void do_jump(void const* pEntry, char const* pszText);
/* 802A8794 */ virtual void do_branch_query(u32 uCode);
/* 802A8798 */ virtual s32 do_branch_queryResult();
/* 802A87A0 */ virtual void do_branch(void const*, char const*);
/* 802A87A0 */ virtual void do_branch(void const* pEntry, char const* pszText);
TControl* getControl() const { return pControl_; }
static const void* process_setMessageIndex_(const TSequenceProcessor* pProcessor, u16 param_1) {
static const void* process_setMessageIndex_(const TSequenceProcessor* pProcessor, u16 u16Index) {
return process_setMessageCode_(pProcessor, pProcessor->getResourceCache()->getGroupID(),
param_1);
u16Index);
}
static const void* process_setMessageCode_(const TSequenceProcessor* pProcessor, u32 param_1) {
return process_setMessageCode_(pProcessor, param_1 >> 0x10, param_1 & 0xFFFF);
static const void* process_setMessageCode_(const TSequenceProcessor* pProcessor, u32 uCode) {
return process_setMessageCode_(pProcessor, uCode >> 16, uCode & 0xFFFF);
}
/* 0x38 */ TControl* pControl_;
@@ -329,20 +341,21 @@ struct TSequenceProcessor : public TProcessor {
*
*/
struct TRenderingProcessor : public TProcessor {
/* 802A8A84 */ TRenderingProcessor(JMessage::TReference const*);
/* 802A8B20 */ int process(char const*);
/* 802A8A84 */ TRenderingProcessor(JMessage::TReference const* pReference);
/* 802A8B20 */ int process(char const* pszText);
/* 802A8AC0 */ virtual ~TRenderingProcessor();
/* 802A8BA4 */ virtual void do_begin_(void const*, char const*);
/* 802A8BA4 */ virtual void do_begin_(void const* pEntry, char const* pszText);
/* 802A8BA8 */ virtual void do_end_();
/* 802A8BAC */ virtual void do_tag_(u32, void const*, u32);
/* 802A8BAC */ virtual void do_tag_(u32 uTag, void const* pData, u32 uSize);
bool process_messageEntryText(TProcessor *param_0,void const*param_1,const char *param_2) {
int rv = TProcessor::setBegin_messageEntryText(param_0, param_1, param_2);
if (rv != 0) {
process(NULL);
bool process_messageEntryText(const TProcessor* pProcessor, void const* pEntry, const char* pszText) {
if (!TProcessor::setBegin_messageEntryText(pProcessor, pEntry, pszText)) {
return false;
}
return rv != 0;
process(NULL);
return true;
}
};
}; // namespace JMessage