Extract Kanji + some adjacent docs (#1536)

* XML + docs

* PR

* newline

* newline pt2

* named textures in kanji.xml

* Kick Jenkins

---------

Co-authored-by: emilybrooks <emilybrooksemilybrooks@gmail.com>

include/functions.h

@@ -764,8 +764,6 @@ s32 SysFlashrom_IsBusy(void);
 s32 SysFlashrom_AwaitResult(void);
 void SysFlashrom_WriteDataSync(void* addr, u32 pageNum, u32 pageCount);
 
-s32 func_80185F90(u32 arg0);
-
 Acmd* AudioSynth_Update(Acmd* abiCmdStart, s32* numAbiCmds, s16* aiBufStart, s32 numSamplesPerFrame);
 
 AudioTask* AudioThread_Update(void);

include/kanread.h

@@ -0,0 +1,26 @@
+#ifndef KANREAD_H
+#define KANREAD_H
+
+#include "PR/ultratypes.h"
+
+/**
+ * s32 Kanji_OffsetFromShiftJIS(s32 sjis);
+ *
+ * Returns the offset of the glyph texture data in the file `kanji` corresponding
+ * to a given 2-byte Shift-JIS codepoint. No range validity check is carried out.
+ *
+ * A nice Shift-JIS codepoint table: https://uic.io/en/charset/show/shift_jis/
+ * The file `kanji` contains the 'Level 1' kanji (0x889F-0x9872), and a reworked
+ * version of the non-kanji section that includes extra English and Hylian glyphs.
+ *
+ * @note This function assumes that its argument is a valid Shift-JIS codepoint;
+ * there is no range protection at all.
+ *
+ * @param sjis Shift-JIS Codepoint of glyph.
+ * @return s32 offset into `kanji` file.
+ *
+ * @remark Original name: "LeoGetKadr"
+ */
+s32 Kanji_OffsetFromShiftJIS(s32 sjis);
+
+#endif

include/variables.h

@@ -6,8 +6,6 @@
 #include "macros.h"
 
 // data
-// extern UNK_TYPE1 D_80186028;
-
 extern u8 sDropTable[DROP_TABLE_SIZE * DROP_TABLE_NUMBER];
 extern u8 sDropTableAmounts[DROP_TABLE_SIZE * DROP_TABLE_NUMBER];
 extern s32 D_801AE194[32];

spec

@@ -268,7 +268,7 @@ endseg
 
 beginseg
     name "kanji"
-    include "build/baserom/kanji.o"
+    include "build/assets/interface/kanji/kanji.o"
 endseg
 
 beginseg
@@ -584,7 +584,7 @@ beginseg
     include "build/src/code/c_keyframe.o"
     include "build/src/code/sys_slowly.o"
     include "build/src/code/sys_flashrom.o"
-    include "build/asm/code/code_80185F90.text.o" // handwritten
+    include "build/asm/code/kanread.text.o" // handwritten
     include "build/src/code/osFlash.o"
     pad_text
     pad_text

tools/disasm/files.txt

@@ -481,7 +481,7 @@
             0x801830A0 : "c_keyframe",
             0x80185660 : "sys_slowly",
             0x801857C0 : "sys_flashrom",
-            0x80185F90 : "", # handwritten
+            0x80185F90 : "kanread", # handwritten
             0x80186A70 : "osFlash",
             0x801877A0 : "[PADDING]",
             0x801877D0 : "audio_synthesis",

tools/disasm/functions.txt

@@ -3462,7 +3462,7 @@
     0x80185EC4:("SysFlashrom_IsBusy",),
     0x80185F04:("SysFlashrom_AwaitResult",),
     0x80185F64:("SysFlashrom_WriteDataSync",),
-    0x80185F90:("func_80185F90",),
+    0x80185F90:("Kanji_OffsetFromShiftJIS",),
     0x80186A70:("osFlashGetAddr",),
     0x80186AB8:("osFlashReInit",),
     0x80186B38:("osFlashChange",),

tools/disasm/variables.txt

@@ -362,7 +362,7 @@
     0x8009F888:("viCounterMsg","OSIoMesg","",0x18),
     0x8009F8A0:("viRetrace","u16","",0x2),
     0x8009F8B0:("dmadata","DmaEntry","[1568]",0x6200),
-    0x80186028:("D_80186028","s16","[1316]",0xa48),
+    0x80186028:("sNonKanjiIndices","s16","[1316]",0xa48),
     0x801AAAB0:("aspMainTextStart","UNK_TYPE1","",0x1),
     0x801ABAB0:("gspS2DEX2_fifoTextStart","UNK_TYPE1","",0x1),
     0x801AD370:("njpgdspMainTextStart","UNK_TYPE1","",0x1),

tools/sizes/code_functions.csv

@@ -2977,7 +2977,7 @@ asm/non_matchings/code/sys_flashrom/SysFlashrom_WriteDataAsync.s,SysFlashrom_Wri
 asm/non_matchings/code/sys_flashrom/SysFlashrom_IsBusy.s,SysFlashrom_IsBusy,0x80185EC4,0x10
 asm/non_matchings/code/sys_flashrom/SysFlashrom_AwaitResult.s,SysFlashrom_AwaitResult,0x80185F04,0x18
 asm/non_matchings/code/sys_flashrom/SysFlashrom_WriteDataSync.s,SysFlashrom_WriteDataSync,0x80185F64,0xB
-asm/non_matchings/code/code_80185F90/func_80185F90.s,func_80185F90,0x80185F90,0x26
+asm/non_matchings/code/kanread/Kanji_OffsetFromShiftJIS.s,Kanji_OffsetFromShiftJIS,0x80185F90,0x26
 asm/non_matchings/code/osFlash/func_80186A70.s,func_80186A70,0x80186A70,0x12
 asm/non_matchings/code/osFlash/func_80186AB8.s,func_80186AB8,0x80186AB8,0x1C
 asm/non_matchings/code/osFlash/func_80186B28.s,func_80186B28,0x80186B28,0x2