macros.h 3/5: Split various macros (#2512)

* split out various macros

* fix

* fix2

* fix dw

* libc path

* fix macro

* does this fix bss

* fix bss

12 files changed, 105 insertions, 83 deletions

diff --git a/include/avoid_ub.h b/include/avoid_ub.h
new file mode 100644
index 000000000..4706f50ec
--- /dev/null
+++ b/include/avoid_ub.h
@@ -0,0 +1,13 @@
+#ifndef AVOID_UB_H
+#define AVOID_UB_H
+
+/**
+ * This macro is used when the return type of a function is incorrect
+ */
+#ifndef AVOID_UB
+#define BAD_RETURN(type) type
+#else
+#define BAD_RETURN(type) void
+#endif
+
+#endif
diff --git a/include/color.h b/include/color.h
index 816d38349..73fa5d63a 100644
--- a/include/color.h
+++ b/include/color.h
@@ -33,4 +33,6 @@ typedef union Color_RGBA16 {
     u16 rgba;
 } Color_RGBA16;
 
+#define RGBA8(r, g, b, a) ((((r) & 0xFF) << 24) | (((g) & 0xFF) << 16) | (((b) & 0xFF) << 8) | (((a) & 0xFF) << 0))
+
 #endif
diff --git a/include/fault.h b/include/fault.h
index 7418246f4..af895927d 100644
--- a/include/fault.h
+++ b/include/fault.h
@@ -1,9 +1,10 @@
 #ifndef FAULT_H
 #define FAULT_H
 
-#include "ultra64.h"
-#include "attributes.h"
+#include "libu64/debug.h"
 #include "libu64/pad.h"
+#include "attributes.h"
+#include "ultra64.h"
 
 #if !PLATFORM_N64
 // These are the same as the 3-bit ansi color codes
@@ -50,6 +51,12 @@ void Fault_Init(void);
 NORETURN void Fault_AddHungupAndCrashImpl(const char* exp1, const char* exp2);
 NORETURN void Fault_AddHungupAndCrash(const char* file, int line);
 
+#if PLATFORM_N64 || DEBUG_FEATURES
+#define HUNGUP_AND_CRASH(file, line) Fault_AddHungupAndCrash(file, line)
+#else
+#define HUNGUP_AND_CRASH(file, line) LogUtils_HungupThread(file, line)
+#endif
+
 // Client Registration
 
 void Fault_AddClient(FaultClient* client, void* callback, void* arg0, void* arg1);
diff --git a/include/gfx.h b/include/gfx.h
index 290b63054..e53465596 100644
--- a/include/gfx.h
+++ b/include/gfx.h
@@ -7,6 +7,9 @@
 #include "thga.h"
 #include "versions.h"
 
+#define SCREEN_WIDTH  320
+#define SCREEN_HEIGHT 240
+
 // Texture memory size, 4 KiB
 #define TMEM_SIZE 0x1000
 
@@ -124,4 +127,39 @@ void Graph_ThreadEntry(void*);
 extern u64 gMojiFontTLUTs[4][4]; // original name: "moji_tlut"
 extern u64 gMojiFontTex[]; // original name: "font_ff"
 
+/**
+ * `x` vertex x
+ * `y` vertex y
+ * `z` vertex z
+ * `s` texture s coordinate
+ * `t` texture t coordinate
+ * `crnx` red component of color vertex, or x component of normal vertex
+ * `cgny` green component of color vertex, or y component of normal vertex
+ * `cbnz` blue component of color vertex, or z component of normal vertex
+ * `a` alpha
+ */
+#define VTX(x,y,z,s,t,crnx,cgny,cbnz,a) { { { x, y, z }, 0, { s, t }, { crnx, cgny, cbnz, a } } }
+
+#define VTX_T(x,y,z,s,t,cr,cg,cb,a) { { x, y, z }, 0, { s, t }, { cr, cg, cb, a } }
+
+#define gDPSetTileCustom(pkt, fmt, siz, uls, ult, lrs, lrt, pal,        \
+                         cms, cmt, masks, maskt, shifts, shiftt)        \
+_DW({                                                                   \
+    gDPPipeSync(pkt);                                                   \
+    gDPTileSync(pkt);                                                   \
+    gDPSetTile(pkt, fmt, siz,                                           \
+        (((((lrs) - (uls) + 1) * siz##_TILE_BYTES) + 7) >> 3), 0,       \
+        G_TX_LOADTILE, 0, cmt, maskt, shiftt, cms, masks,               \
+        shifts);                                                        \
+    gDPTileSync(pkt);                                                   \
+    gDPSetTile(pkt, fmt, siz,                                           \
+        (((((lrs) - (uls) + 1) * siz##_LINE_BYTES) + 7) >> 3), 0,       \
+        G_TX_RENDERTILE, pal, cmt, maskt, shiftt, cms, masks, shifts);  \
+    gDPSetTileSize(pkt, G_TX_RENDERTILE,                                \
+        (uls) << G_TEXTURE_IMAGE_FRAC,                                  \
+        (ult) << G_TEXTURE_IMAGE_FRAC,                                  \
+        (lrs) << G_TEXTURE_IMAGE_FRAC,                                  \
+        (lrt) << G_TEXTURE_IMAGE_FRAC);                                 \
+})
+
 #endif
diff --git a/include/language_array.h b/include/language_array.h
new file mode 100644
index 000000000..b93dbd4e0
--- /dev/null
+++ b/include/language_array.h
@@ -0,0 +1,12 @@
+#ifndef LANGUAGE_ARRAY_H
+#define LANGUAGE_ARRAY_H
+
+#include "versions.h"
+
+#if OOT_NTSC
+#define LANGUAGE_ARRAY(jpn, eng, ger, fra) { jpn, eng }
+#else
+#define LANGUAGE_ARRAY(jpn, eng, ger, fra) { eng, ger, fra }
+#endif
+
+#endif
diff --git a/include/macros.h b/include/macros.h
index d4fc7d9a9..7c964150e 100644
--- a/include/macros.h
+++ b/include/macros.h
@@ -1,87 +1,10 @@
 #ifndef MACROS_H
 #define MACROS_H
 
-#include "versions.h"
-
-#define SCREEN_WIDTH  320
-#define SCREEN_HEIGHT 240
-
-#ifndef AVOID_UB
-#define BAD_RETURN(type) type
-#else
-#define BAD_RETURN(type) void
-#endif
-
 #define ARRAY_COUNT(arr) (s32)(sizeof(arr) / sizeof(arr[0]))
 #define ARRAY_COUNTU(arr) (u32)(sizeof(arr) / sizeof(arr[0]))
 #define ARRAY_COUNT_2D(arr) (s32)(sizeof(arr) / sizeof(arr[0][0]))
 
-#define ABS(x) ((x) >= 0 ? (x) : -(x))
-#define DECR(x) ((x) == 0 ? 0 : --(x))
-#define CLAMP(x, min, max) ((x) < (min) ? (min) : (x) > (max) ? (max) : (x))
-#define CLAMP_MAX(x, max) ((x) > (max) ? (max) : (x))
-#define CLAMP_MIN(x, min) ((x) < (min) ? (min) : (x))
-
-#define SWAP(type, a, b)    \
-    {                       \
-        type _temp = (a);   \
-        (a) = (b);          \
-        (b) = _temp;        \
-    }                       \
-    (void)0
-
-#define RGBA8(r, g, b, a) ((((r) & 0xFF) << 24) | (((g) & 0xFF) << 16) | (((b) & 0xFF) << 8) | (((a) & 0xFF) << 0))
-
 #define CHECK_FLAG_ALL(flags, mask) (((flags) & (mask)) == (mask))
 
-#if PLATFORM_N64 || DEBUG_FEATURES
-#define HUNGUP_AND_CRASH(file, line) Fault_AddHungupAndCrash(file, line)
-#else
-#define HUNGUP_AND_CRASH(file, line) LogUtils_HungupThread(file, line)
-#endif
-
-#define MATRIX_FINALIZE_AND_LOAD(pkt, gfxCtx, file, line) \
-    gSPMatrix(pkt, MATRIX_FINALIZE(gfxCtx, file, line), G_MTX_NOPUSH | G_MTX_LOAD | G_MTX_MODELVIEW)
-
-#if OOT_NTSC
-#define LANGUAGE_ARRAY(jpn, eng, ger, fra) { jpn, eng }
-#else
-#define LANGUAGE_ARRAY(jpn, eng, ger, fra) { eng, ger, fra }
-#endif
-
-/**
- * `x` vertex x
- * `y` vertex y
- * `z` vertex z
- * `s` texture s coordinate
- * `t` texture t coordinate
- * `crnx` red component of color vertex, or x component of normal vertex
- * `cgny` green component of color vertex, or y component of normal vertex
- * `cbnz` blue component of color vertex, or z component of normal vertex
- * `a` alpha
- */
-#define VTX(x,y,z,s,t,crnx,cgny,cbnz,a) { { { x, y, z }, 0, { s, t }, { crnx, cgny, cbnz, a } } }
-
-#define VTX_T(x,y,z,s,t,cr,cg,cb,a) { { x, y, z }, 0, { s, t }, { cr, cg, cb, a } }
-
-#define gDPSetTileCustom(pkt, fmt, siz, uls, ult, lrs, lrt, pal,        \
-                         cms, cmt, masks, maskt, shifts, shiftt)        \
-_DW({                                                                   \
-    gDPPipeSync(pkt);                                                   \
-    gDPTileSync(pkt);                                                   \
-    gDPSetTile(pkt, fmt, siz,                                           \
-        (((((lrs) - (uls) + 1) * siz##_TILE_BYTES) + 7) >> 3), 0,       \
-        G_TX_LOADTILE, 0, cmt, maskt, shiftt, cms, masks,               \
-        shifts);                                                        \
-    gDPTileSync(pkt);                                                   \
-    gDPSetTile(pkt, fmt, siz,                                           \
-        (((((lrs) - (uls) + 1) * siz##_LINE_BYTES) + 7) >> 3), 0,       \
-        G_TX_RENDERTILE, pal, cmt, maskt, shiftt, cms, masks, shifts);  \
-    gDPSetTileSize(pkt, G_TX_RENDERTILE,                                \
-        (uls) << G_TEXTURE_IMAGE_FRAC,                                  \
-        (ult) << G_TEXTURE_IMAGE_FRAC,                                  \
-        (lrs) << G_TEXTURE_IMAGE_FRAC,                                  \
-        (lrt) << G_TEXTURE_IMAGE_FRAC);                                 \
-})
-
 #endif
diff --git a/include/sys_matrix.h b/include/sys_matrix.h
index 11d494c8c..2708af81e 100644
--- a/include/sys_matrix.h
+++ b/include/sys_matrix.h
@@ -64,6 +64,9 @@ Mtx* Matrix_Finalize(struct GraphicsContext* gfxCtx);
 
 #endif
 
+#define MATRIX_FINALIZE_AND_LOAD(pkt, gfxCtx, file, line) \
+    gSPMatrix(pkt, MATRIX_FINALIZE(gfxCtx, file, line), G_MTX_NOPUSH | G_MTX_LOAD | G_MTX_MODELVIEW)
+
 /* Vector operations */
 
 void Matrix_MultVec3f(Vec3f* src, Vec3f* dest);
diff --git a/include/z64.h b/include/z64.h
index 2560c745d..8a259e70f 100644
--- a/include/z64.h
+++ b/include/z64.h
@@ -4,6 +4,7 @@
 // TODO: This file still exists ONLY to provide neccesary headers to extracted assets.
 //       After assets are modified to include the headers they need directly, delete this file.
 
+#include "gfx.h"
 #include "sequence.h"
 #include "sys_matrix.h"
 #include "ultra64.h"
diff --git a/include/z64animation.h b/include/z64animation.h
index 17b42e1a0..9db7b260d 100644
--- a/include/z64animation.h
+++ b/include/z64animation.h
@@ -1,6 +1,7 @@
 #ifndef Z64_ANIMATION_H
 #define Z64_ANIMATION_H
 
+#include "avoid_ub.h"
 #include "ultra64.h"
 #include "z64dma.h"
 #include "z64math.h"
diff --git a/include/z64math.h b/include/z64math.h
index 95a494a69..187d95b25 100644
--- a/include/z64math.h
+++ b/include/z64math.h
@@ -1,11 +1,8 @@
 #ifndef Z64MATH_H
 #define Z64MATH_H
 
-#include "ultra64.h"
 #include "math.h"
-
-#define SQ(x) ((x)*(x))
-#define VEC_SET(V,X,Y,Z) (V).x=(X);(V).y=(Y);(V).z=(Z)
+#include "ultra64.h"
 
 typedef union FloatInt {
     f32 f;
@@ -95,6 +92,27 @@ typedef VecSphGeo VecSph;
 // Pitch is 0 along the xz-plane (horizon)
 typedef VecSphGeo VecGeo;
 
+/**
+ * Macros
+ */
+
+// General number macros
+#define SQ(x) ((x)*(x))
+#define ABS(x) ((x) >= 0 ? (x) : -(x))
+#define DECR(x) ((x) == 0 ? 0 : --(x))
+#define CLAMP(x, min, max) ((x) < (min) ? (min) : (x) > (max) ? (max) : (x))
+#define CLAMP_MAX(x, max) ((x) > (max) ? (max) : (x))
+#define CLAMP_MIN(x, min) ((x) < (min) ? (min) : (x))
+
+#define SWAP(type, a, b)    \
+    {                       \
+        type _temp = (a);   \
+        (a) = (b);          \
+        (b) = _temp;        \
+    }                       \
+    (void)0
+
+// LERP macros
 #define LERP(x, y, scale) (((y) - (x)) * (scale) + (x))
 #define LERP32(x, y, scale) ((s32)(((y) - (x)) * (scale)) + (x))
 #define LERP16(x, y, scale) ((s16)(((y) - (x)) * (scale)) + (x))
@@ -110,6 +128,7 @@ typedef VecSphGeo VecGeo;
     (dst)->z = (v0)->z + (((v1)->z - (v0)->z) * t); \
 }
 
+// Floating point macros
 #define IS_ZERO(f) (fabsf(f) < 0.008f)
 
 // Casting a float to an integer, when the float value is larger than what the integer type can hold,
@@ -145,6 +164,7 @@ typedef VecSphGeo VecGeo;
 #define CAM_BINANG_TO_DEG(binang) ((f32)(binang) * (360.0001525f / 65535.0f))
 
 // Vector macros
+#define VEC_SET(V,X,Y,Z) (V).x=(X);(V).y=(Y);(V).z=(Z)
 #define SQXZ(vec) ((vec).x * (vec).x + (vec).z * (vec).z)
 #define DOTXZ(vec1, vec2) ((vec1).x * (vec2).x + (vec1).z * (vec2).z)
 #define SQXYZ(vec) ((vec).x * (vec).x + (vec).y * (vec).y + (vec).z * (vec).z)
diff --git a/include/z64scene.h b/include/z64scene.h
index eacd62ed8..7453f48ba 100644
--- a/include/z64scene.h
+++ b/include/z64scene.h
@@ -1,6 +1,7 @@
 #ifndef Z64SCENE_H
 #define Z64SCENE_H
 
+#include "avoid_ub.h"
 #include "macros.h"
 #include "ultra64.h"
 #include "z64bgcheck.h"
diff --git a/include/z64view.h b/include/z64view.h
index 3832eb5f6..b007129f9 100644
--- a/include/z64view.h
+++ b/include/z64view.h
@@ -1,6 +1,7 @@
 #ifndef Z64VIEW_H
 #define Z64VIEW_H
 
+#include "avoid_ub.h"
 #include "macros.h"
 #include "ultra64.h"
 #include "z64math.h"