Changes from decomp (#24)

Breaking:
- Create include_cpp folder (an old decision I'm probably about to revert)

Other:
- Remove the now-unused SKIP_PPCDIS
- STRIPPED macro for functions that deadstripped outside of decomp
- Correct types for decomp in common.h
- Expand fadedrv.h
- Expand spmario_snd.h
- Expand gx.h
- Expand mem.h
- Expand/correct mtx.h
- Create msl exception.h and new.h
- Create some nw4r headders

Author: SeekyCt

README.md

@@ -19,19 +19,19 @@ It is recommended to use this with [git subrepo](https://github.com/ingydotnet/g
 
 ## Decomp
 
-For use in decomp, the `include` and `decomp` folders should be added to the include path, and the preprocessor define `DECOMP` should be used.
+For use in decomp, the `include`, `include_cpp` and `decomp` folders should be added to the include path, and the preprocessor define `DECOMP` should be used.
 
-### Testing
+## Mods
 
-The `SKIP_PPCDIS` preprocessor define will stop `ppcdis.h` being included.
+For use in mods, the `include`, `include_cpp` and `mod` folder should be added to the include path and an lst from `linker` should be used. Mods should include their compiler's standard library headers (do not use `-nostdinc`), though linking it is not required (so `-nostdlib` is fine).
 
-## Mods
+## C
 
-For use in mods, the `include` and `mod` folder should be added to the include path and an lst from `linker` should be used. Mods should include their compiler's standard library headers (do not use `-nostdinc`), though linking it is not required (so `-nostdlib` is fine).
+For the cases where C is required (such as m2c or maybe some niche modding cases), omitting the `include_cpp` folder should be all that's neccessary.
 
 # Licensing
 
-All code originally written for this project (everything under the `include`, `decomp` and `linker` directories) is available under the MIT license.
+All code originally written for this project (everything under the `include`, `include_cpp`, `decomp` and `linker` directories) is available under the MIT license.
 
 Everything under the `mod` folder is available under the GPLv3 license as it's derived from other GPL code.
 

configure.py

@@ -240,7 +240,7 @@ def test_mod_ctx(regions: List[str]):
 def test_decomp_ctx(regions: List[str]):
     assert args.codewarrior, "Error: decomp_ctx test requires --codewarrior"
     compile_regions(os.path.join("$builddir", "{region}", "decomp.o"), "$decomp_source", regions,
-                    DECOMP_INCLUDES, ["DECOMP", "SKIP_PPCDIS"], True)
+                    DECOMP_INCLUDES, ["DECOMP"], True)
 
 # Test shuffled include orders
 def test_mod_ctx_shuffle(regions: List[str]):

include/common.h

@@ -1,12 +1,7 @@
 #pragma once
 
-#if (defined DECOMP) && !(defined SKIP_PPCDIS)
-// Decomp should include ppcdis.h in all files
-#include <ppcdis.h>
-#else
-// Unknown function is useful outside of decomp too
+// Unknown function declaration
 #define UNKNOWN_FUNCTION(name) void name(void)
-#endif
 
 // Intellisense doesn't like asm compiler extensions
 #ifdef __INTELLISENSE__ 
@@ -50,6 +45,13 @@
     #define DECOMP_STATIC(expr) extern expr;
 #endif
 
+// Macro for something that is deadstripped outside of decomp
+#ifdef DECOMP
+    #define STRIPPED(expr) expr;
+#else
+    #define STRIPPED(expr)
+#endif
+
 // Use extern "C" in C++, use namespacing in mods
 #ifdef __cplusplus
     #ifndef DECOMP
@@ -139,12 +141,10 @@ typedef int BOOL;
     #else
         #define offsetof(type, member) ((u32)&((type *)0)->member)
     #endif
-    #define bool char
 
     #define true 1
     #define false 0
 
-    #define wchar_t s16
     typedef wchar_t wchar16_t;
 
     typedef s32 ptrdiff_t;

include/spm/camdrv.h

@@ -11,6 +11,7 @@
 
 CPP_WRAPPER(spm::camdrv)
 
+USING(wii::gx::GXProjectionType)
 USING(wii::mtx::Vec3)
 USING(wii::mtx::Mtx34)
 USING(wii::mtx::Mtx44)
@@ -63,7 +64,7 @@ typedef struct _CamEntry
 /* 0x0F8 */ f32 left;
 /* 0x0FC */ f32 right;
 /* 0x100 */ u8 unknown_0x100[0x158 - 0x100];
-/* 0x158 */ s32 isOrtho;
+/* 0x158 */ GXProjectionType projectionType;
 /* 0x15C */ Vec3 pos;
 /* 0x168 */ Vec3 target;
 /* 0x174 */ Vec3 up;

include/spm/evtmgr_cmd.h

@@ -351,7 +351,7 @@ f32 evtSetFloat(EvtEntry * entry, EvtVar variable, f32 value);
     Returns a pointer to the instruction after the specified label
     in an entry's script
 */
-EvtScriptCode * evtSearchLabel(EvtEntry * entry, s32 id); // inlined
+STRIPPED(EvtScriptCode * evtSearchLabel(EvtEntry * entry, s32 id))
 
 /*
     Returns a pointer to the instruction after the next else on the

include/spm/fadedrv.h

@@ -1,11 +1,14 @@
 #pragma once
 
 #include <common.h>
+#include <wii/gx.h>
 
 CPP_WRAPPER(spm::fadedrv)
 
+USING(wii::gx::GXColor)
+
 void fadeInit();
-UNKNOWN_FUNCTION(fadeEntry);
+void fadeEntry(u32 transitionType, s32 param_2, GXColor colour);
 UNKNOWN_FUNCTION(func_80066558);
 void fadeMain();
 UNKNOWN_FUNCTION(func_80066e4c);

include/spm/hud.h

@@ -28,7 +28,7 @@ UNKNOWN_FUNCTION(hudDisp);
 void func_8019af88();
 void hudTurnOffFlipTimeBox(s32 idx);
 UNKNOWN_FUNCTION(func_8019b0dc);
-UNKNOWN_FUNCTION(func_8019be84);
+void func_8019be84();
 UNKNOWN_FUNCTION(func_8019bea8);
 
 CPP_WRAPPER_END()

include/spm/mario_pouch.h

@@ -118,14 +118,14 @@ DECOMP_STATIC(MarioPouchWork mario_pouch_work2)
     Returns a pointer to the MarioPouchWork / MarioPouchWork2 instance
 */
 MarioPouchWork * pouchGetPtr();
-MarioPouchWork2 * pouch2GetPtr(); // inlined
+STRIPPED(MarioPouchWork2 * pouch2GetPtr())
 
 /*
     Initialise data used by pouch functions
     Overwritten later once a save is loaded
 */
 void pouchInit();
-void pouch2Init(); // inlined
+STRIPPED(void pouch2Init())
 void pouchReInit();
 
 /*
@@ -169,7 +169,7 @@ s32 pouchGetMaxHp();
 /*
     Get/add to the player's xp
 */
-void pouchSetXp(s32 xp); // inlined
+STRIPPED(void pouchSetXp(s32 xp))
 s32 pouchGetXp();
 void pouchAddXp(s32 increase);
 
@@ -178,7 +178,7 @@ void pouchAddXp(s32 increase);
 */
 void pouchSetCoin(s32 coins);
 s32 pouchGetCoin();
-void pouchAddTotalCoin(s32 increase); // inlined
+STRIPPED(void pouchAddTotalCoin(s32 increase))
 void pouchAddCoin(s32 increase); // increases totalCoinsCollected
 
 /*

include/spm/seq_title.h

@@ -13,11 +13,11 @@ UNKNOWN_FUNCTION(spsndPause);
 UNKNOWN_FUNCTION(spsndUnpause);
 UNKNOWN_FUNCTION(func_8023872c);
 UNKNOWN_FUNCTION(spsndSetPosDirListener);
-UNKNOWN_FUNCTION(spsndSetSFXReverbMode);
+void spsndSetSFXReverbMode(u8 mode);
 UNKNOWN_FUNCTION(func_80238804);
 UNKNOWN_FUNCTION(func_80238868);
 UNKNOWN_FUNCTION(spsndSetFlag);
-UNKNOWN_FUNCTION(spsndClearFlag);
+void spsndClearFlag(u16 flags);
 UNKNOWN_FUNCTION(spsndGetFlag);
 UNKNOWN_FUNCTION(func_802388f4);
 UNKNOWN_FUNCTION(func_80238b04);
@@ -29,7 +29,7 @@ UNKNOWN_FUNCTION(spsndSFXOn_UnkEffect);
 UNKNOWN_FUNCTION(_spsndSFXOn);
 UNKNOWN_FUNCTION(spsndSFXOn_3D);
 UNKNOWN_FUNCTION(spsndSFXOff);
-UNKNOWN_FUNCTION(func_8023b38c);
+void func_8023b38c(u32 param_1, u32 param_2);
 UNKNOWN_FUNCTION(spsndSetSfxPlayerPos);
 UNKNOWN_FUNCTION(spsndSFX_vol);
 UNKNOWN_FUNCTION(spsndSFX_pit);
@@ -50,13 +50,13 @@ bool spsndBGMOn(u32 flags, const char * name);
 UNKNOWN_FUNCTION(spsndBGMOn_f_d_alt);
 bool spsndBGMOff_f_d(s32 player, u32 fadeoutTime);
 UNKNOWN_FUNCTION(spsndBGMOff);
-UNKNOWN_FUNCTION(spsndBGMOff_f_d_alt);
+bool spsndBGMOff_f_d_alt(s32 player, s32 fadeoutTime);
 UNKNOWN_FUNCTION(func_8023cab4);
 UNKNOWN_FUNCTION(func_8023cc90);
 UNKNOWN_FUNCTION(func_8023cc98);
 UNKNOWN_FUNCTION(func_8023cc9c);
 UNKNOWN_FUNCTION(func_8023ce1c);
-UNKNOWN_FUNCTION(func_8023ce20);
+void func_8023ce20(s32 player, s32 param_2, s32 param_3);
 UNKNOWN_FUNCTION(func_8023cf14);
 UNKNOWN_FUNCTION(func_8023cfe8);
 UNKNOWN_FUNCTION(func_8023d0dc);
@@ -68,9 +68,9 @@ UNKNOWN_FUNCTION(func_8023d2b8);
 UNKNOWN_FUNCTION(spsndENVMain);
 UNKNOWN_FUNCTION(spsndENVOn_f_d);
 UNKNOWN_FUNCTION(spsndENVOn);
-UNKNOWN_FUNCTION(func_8023db5c);
+bool func_8023db5c(s32 param_1, s32 param_2);
 UNKNOWN_FUNCTION(func_8023dc88);
-UNKNOWN_FUNCTION(func_8023dc90);
+bool func_8023dc90(s32 param_1, s32 param_2);
 UNKNOWN_FUNCTION(func_8023dc94);
 UNKNOWN_FUNCTION(func_8023dda4);
 UNKNOWN_FUNCTION(func_8023de90);

include/spm/spmario_snd.h

@@ -89,9 +89,8 @@ s32 NORETURN ATTRIBUTE_FORMAT(printf, 4, 5) __assert2(
 
 /*
     Rounds a float to an int
-    Deadstripped, always inlined
 */
-s32 roundi(f32 x);
+STRIPPED(s32 roundi(f32 x))
 
 /*
     Adjusts an angle to be 0 <= x < 360
@@ -144,9 +143,8 @@ void sysRandInit();
 
 /*
     Gets the current screen draw token
-    Deadstripped, always inlined
 */
-u16 sysGetToken();
+STRIPPED(u16 sysGetToken())
 
 /*
     Waits until the next screen draw, or max 100ms

include/spm/system.h

@@ -16,6 +16,13 @@ typedef struct
 {
     u8 r, g, b, a;
 } GXColor;
+SIZE_ASSERT(GXColor, 0x4)
+
+typedef struct
+{
+    s16 r, g, b, a;
+} GXColorS10;
+SIZE_ASSERT(GXColorS10, 0x8)
 
 typedef struct
 {
@@ -29,6 +36,13 @@ typedef struct
 } GXTexObj;
 SIZE_ASSERT(GXTexObj, 0x20)
 
+
+typedef enum
+{
+/* 0x0 */ GX_PERSPECTIVE,
+/* 0x1 */ GX_ORTHOGRAPHIC
+} GXProjectionType;
+
 // Parameters from libogc's gx.h
 
 UNKNOWN_FUNCTION(__GXDefaultTexRegionCallback);
@@ -200,7 +214,7 @@ UNKNOWN_FUNCTION(GXEndDisplayList);
 UNKNOWN_FUNCTION(GXCallDisplayList);
 UNKNOWN_FUNCTION(GXProject);
 UNKNOWN_FUNCTION(__GXSetProjection);
-void GXSetProjection(Mtx44 * mtx, u32 type);
+void GXSetProjection(Mtx44 mtx, GXProjectionType type);
 UNKNOWN_FUNCTION(GXSetProjectionv);
 UNKNOWN_FUNCTION(GXGetProjectionv);
 void GXLoadPosMtxImm(Mtx34 * mtx, u32 pnidx);

include/wii/gx.h

@@ -35,6 +35,22 @@ typedef struct _MEMEXPHeap
 } MEMEXPHeap;
 SIZE_ASSERT(MEMEXPHeap, 0x50)
 
+typedef struct
+{
+/* 0x0 */ void * alloc;
+/* 0x4 */ void * free;
+} MEMAllocatorFunc;
+SIZE_ASSERT(MEMAllocatorFunc, 8)
+
+typedef struct
+{
+/* 0x0 */ MEMAllocatorFunc * func;
+/* 0x4 */ void * heap;
+/* 0x8 */ u32 heapP0;
+/* 0x8 */ u32 heapP1;
+} MEMAllocator;
+SIZE_ASSERT(MEMAllocator, 0x10)
+
 #define MEM_FLAG_FILL_0 (1 << 0) // initialise allocated memory as 0
 #define MEM_FLAG_THREAD_CONTROL (1 << 2) // use mutexes for access when handling heap
 
@@ -63,9 +79,9 @@ UNKNOWN_FUNCTION(AllocatorAllocForExpHeap_);
 UNKNOWN_FUNCTION(AllocatorFreeForExpHeap_);
 UNKNOWN_FUNCTION(AllocatorAllocForFrmHeap_);
 UNKNOWN_FUNCTION(AllocatorFreeForFrmHeap_);
-UNKNOWN_FUNCTION(MEMAllocFromAllocator);
+void * MEMAllocFromAllocator(MEMAllocator * allocator, size_t size);
 UNKNOWN_FUNCTION(MEMFreeToAllocator);
-UNKNOWN_FUNCTION(MEMInitAllocatorForExpHeap);
+void MEMInitAllocatorForExpHeap(MEMAllocator * allocator, MEMHeapHandle heap, u32 alignment);
 UNKNOWN_FUNCTION(MEMInitAllocatorForFrmHeap);
 UNKNOWN_FUNCTION(MEMInitList);
 UNKNOWN_FUNCTION(MEMAppendListObject);

include/wii/mem.h

@@ -33,19 +33,19 @@ typedef struct
 typedef f32 Mtx34[3][4];
 typedef f32 Mtx44[4][4];
 
-void PSMTXIdentity(Mtx34 * dest);
-UNKNOWN_FUNCTION(PSMTXCopy);
+void PSMTXIdentity(Mtx34 dest);
+void PSMTXCopy(const Mtx34 src, Mtx34 dest);
 UNKNOWN_FUNCTION(PSMTXConcat);
 UNKNOWN_FUNCTION(PSMTXInverse);
 UNKNOWN_FUNCTION(PSMTXInvXpose);
 UNKNOWN_FUNCTION(PSMTXRotRad);
 UNKNOWN_FUNCTION(PSMTXRotTrig);
 UNKNOWN_FUNCTION(__PSMTXRotAxisRadInternal);
 UNKNOWN_FUNCTION(PSMTXRotAxisRad);
-void PSMTXTrans(Mtx34 * dest, f32 x, f32 y, f32 z);
-void PSMTXTransApply(Mtx34 * src, Mtx34 * dest, f32 x, f32 y, f32 z);
-void PSMTXScale(Mtx34 * dest, f32 x, f32 y, f32 z);
-void PSMTXScaleApply(Mtx34 * src, Mtx34 * dest, f32 x, f32 y, f32 z);
+void PSMTXTrans(Mtx34 dest, f32 x, f32 y, f32 z);
+void PSMTXTransApply(const Mtx34 src, Mtx34 dest, f32 x, f32 y, f32 z);
+void PSMTXScale(Mtx34 dest, f32 x, f32 y, f32 z);
+void PSMTXScaleApply(const Mtx34 src, Mtx34 dest, f32 x, f32 y, f32 z);
 UNKNOWN_FUNCTION(PSMTXQuat);
 UNKNOWN_FUNCTION(C_MTXLookAt);
 UNKNOWN_FUNCTION(C_MTXLightFrustum);
@@ -56,18 +56,18 @@ UNKNOWN_FUNCTION(PSMTXMultVecArray);
 UNKNOWN_FUNCTION(PSMTXMultVecSR);
 UNKNOWN_FUNCTION(C_MTXFrustum);
 UNKNOWN_FUNCTION(C_MTXPerspective);
-void C_MTXOrtho(Mtx44 * dest, f32 top, f32 bottom, f32 left, f32 right, f32 near, f32 far);
+void C_MTXOrtho(Mtx44 dest, f32 top, f32 bottom, f32 left, f32 right, f32 near, f32 far);
 UNKNOWN_FUNCTION(PSMTX44Copy);
 UNKNOWN_FUNCTION(PSMTX44MultVec);
 UNKNOWN_FUNCTION(PSMTX44MultVecArray);
 UNKNOWN_FUNCTION(PSVECAdd);
-void PSVECSubtract(Vec3 * src1, Vec3 * src2, Vec3 * dest);
-void PSVECScale(Vec3 * src, Vec3 * dest, f32 scale);
-void PSVECNormalize(Vec3 * src, Vec3 * dest);
-f32 PSVecSquareMag(Vec3 * src);
-f32 PSVecMag(Vec3 * src);
-f32 PSVECDotProduct(Vec3 * src1, Vec3 * src2);
-void PSVECCrossProduct(Vec3 * src1, Vec3 * src2, Vec3 * dest);
+void PSVECSubtract(const Vec3 * src1, const Vec3 * src2, Vec3 * dest);
+void PSVECScale(const Vec3 * src, Vec3 * dest, f32 scale);
+void PSVECNormalize(const Vec3 * src, Vec3 * dest);
+f32 PSVecSquareMag(const Vec3 * src);
+f32 PSVecMag(const Vec3 * src);
+f32 PSVECDotProduct(const Vec3 * src1, const Vec3 * src2);
+void PSVECCrossProduct(const Vec3 * src1, const Vec3 * src2, Vec3 * dest);
 UNKNOWN_FUNCTION(VECHalfAngle);
 UNKNOWN_FUNCTION(VECReflect);
 UNKNOWN_FUNCTION(PSVECSquareDistance);