z_message_PAL, message_data_static and surrounding doc (#996)

* Initial progress on z_message_PAL, very messy

* Fix merge

* Some more progress

* Fix merge

* More z_message_PAL

* Small progress

* More small progress

* message_data_static files OK

* Prepare z_message_tables

* Matched another function, small updates

* Attempt to use asm-processor static-symbols branch

* Refactor text id declarations

* Begin large text codes parser function

* Fix merge

* Refactor done

* Build OK, add color and highscore names

* Remove encoded text headers and automatically encode during build

* Fix kanfont

* Various cleanups

* DISP macros

* Another match aside data

* Further progress

* Small improvements

* Deduplicate magic values for text control codes, small improvements

* Tiny progress

* Minor cleanups

* Clean up z_message_PAL comment

* Progress on large functions

* Further progress on large functions

* Changes to mkldscript to link .data in the .rodata section

* data OK

* Few improvements

* Use gDPLoadTextureBlock macros where appropriate

* rm z_message_tables, progress on large functions

* 2 more matches

* Improvements

* Small progress

* More progress on big function

* progress

* match func_80107980

* match Message_Update

* match func_8010BED8

* done

* Progress on remaining large functions

* Small progress on largest function

* Another match, extract text and move to assets, improve text build system

* Small nonmatchings improvements

* docs wip

* Largest function maybe equivalent

* Fix merge

* Document do_action values, largest function is almost instruction-matching

* Rename NAVI do_action to NONE, as that appears to be how that value is used in practice

* Fix merge

* one match

* Last function is instruction-matching

* Fix

* Improvements thanks to engineer124

* Stack matched thanks to petrie911, now just a/v/low t regalloc issues, some cleanup

* More variables labeled, use text state enum everywhere

* More labels and names

* Fix

* Actor_IsTalking -> Actor_TalkRequested

* Match func_8010C39C and remove unused asm

* More docs

* Mostly ocarina related docs

* All msgModes named

* Fix assetclean

* Cleanup

* Extraction fixes and headers

* Suggestions

* Review suggestions

* Change text extraction again, only extract if the headers do not already exist

* Fix

* Use ast for charmap, fix assetclean for real this time

* Review suggestions

* BGM ids and ran formatter

* Review comments

* rename include_readonly to include_data_with_rodata

* Remove leading 0s in number directives

* Review suggestions for message_data_static

* textbox pos enum comments, rename several enum names from Message to TextBox

Co-authored-by: Thar0 <maximilianc64@gmail.com>
Co-authored-by: Zelllll <56516451+Zelllll@users.noreply.github.com>
Co-authored-by: petrie911 <pmontag@DESKTOP-LG8A167.localdomain>
Co-authored-by: Roman971 <romanlasnier@hotmail.com>

assets/.gitignore

@@ -1,5 +1,6 @@
 *.bin
 *.c
+!text/*.c
 *.h
 *.cfg
 *.vtx.inc

assets/text/charmap.txt

@@ -0,0 +1,50 @@
+{
+    '\n' : 0x01,
+
+    '‾' : 0x7F,
+    'À' : 0x80,
+    'î' : 0x81,
+    'Â' : 0x82,
+    'Ä' : 0x83,
+    'Ç' : 0x84,
+    'È' : 0x85,
+    'É' : 0x86,
+    'Ê' : 0x87,
+    'Ë' : 0x88,
+    'Ï' : 0x89,
+    'Ô' : 0x8A,
+    'Ö' : 0x8B,
+    'Ù' : 0x8C,
+    'Û' : 0x8D,
+    'Ü' : 0x8E,
+    'ß' : 0x8F,
+    'à' : 0x90,
+    'á' : 0x91,
+    'â' : 0x92,
+    'ä' : 0x93,
+    'ç' : 0x94,
+    'è' : 0x95,
+    'é' : 0x96,
+    'ê' : 0x97,
+    'ë' : 0x98,
+    'ï' : 0x99,
+    'ô' : 0x9A,
+    'ö' : 0x9B,
+    'ù' : 0x9C,
+    'û' : 0x9D,
+    'ü' : 0x9E,
+
+    '[A]' : 0x9F,
+    '[B]' : 0xA0,
+    '[C]' : 0xA1,
+    '[L]' : 0xA2,
+    '[R]' : 0xA3,
+    '[Z]' : 0xA4,
+    '[C-Up]' : 0xA5,
+    '[C-Down]' : 0xA6,
+    '[C-Left]' : 0xA7,
+    '[C-Right]' : 0xA8,
+    '▼' : 0xA9,
+    '[Control-Pad]' : 0xAA,
+    '[D-Pad]' : 0xAB,
+}

assets/text/fra_message_data_static.c

@@ -0,0 +1,8 @@
+#define MESSAGE_DATA_STATIC
+
+#include "message_data_fmt.h"
+
+#define DEFINE_MESSAGE(textId, type, yPos, nesMessage, gerMessage, fraMessage) \
+    const char _message_##textId##_fra[sizeof(fraMessage)] = { fraMessage END };
+
+#include "assets/text/message_data.enc.h"

assets/text/ger_message_data_static.c

@@ -0,0 +1,8 @@
+#define MESSAGE_DATA_STATIC
+
+#include "message_data_fmt.h"
+
+#define DEFINE_MESSAGE(textId, type, yPos, nesMessage, gerMessage, fraMessage) \
+    const char _message_##textId##_ger[sizeof(gerMessage)] = { gerMessage END };
+
+#include "assets/text/message_data.enc.h"

assets/text/nes_message_data_static.c

@@ -0,0 +1,12 @@
+#define MESSAGE_DATA_STATIC
+
+#include "message_data_fmt.h"
+
+#define DEFINE_MESSAGE(textId, type, yPos, nesMessage, gerMessage, fraMessage) \
+    const char _message_##textId##_nes[sizeof(nesMessage)] = { nesMessage END };
+
+#define DEFINE_MESSAGE_FFFC
+
+#include "assets/text/message_data.enc.h"
+
+#undef DEFINE_MESSAGE_FFFC

assets/text/staff_message_data_static.c

@@ -0,0 +1,8 @@
+#define MESSAGE_DATA_STATIC
+
+#include "message_data_fmt.h"
+
+#define DEFINE_MESSAGE(textId, type, yPos, staffMessage) \
+    const char _message_##textId##_staff[sizeof(staffMessage)] = { staffMessage END };
+
+#include "assets/text/message_data_staff.enc.h"

assets/xml/code/fbdemo_circle.xml

@@ -10,4 +10,4 @@
         <!-- ZAPD isn't finding symbols correctly, instead finding them much later in `code`-->
         <!--<DList Name="sCircleWipeDL" Offset="0x10FF68"/>-->
     </File>
-</Root>
+</Root>

assets/xml/code/fbdemo_triforce.xml

@@ -5,4 +5,4 @@
             <Vtx/>
         </Array>
     </File>
-</Root>
+</Root>

assets/xml/code/fbdemo_wipe1.xml

@@ -7,4 +7,4 @@
         <Texture Name="sWipe1Tex" Format="i4" Width="64" Height="64" Offset="0x10E430"/>
        <!-- <DList Name="sWipe1DL" Offset="0x10EC30"/>-->
     </File>
-</Root>
+</Root>

assets/xml/overlays/ovl_En_Sth.xml

@@ -12,4 +12,4 @@
         <Animation Name="sChildDanceAnim" Offset="0x3620"/>
         <Animation Name="sParentDanceAnim" Offset="0x3EB4"/>
     </File>
-</Root>
+</Root>