[headers] z64inventory.h, move savectx/inventory macros to z64save.h (#2209)

* [headers] z64inventory.h

* move savectx/inventory macros to z64save.h

* commit the file

* bss

6 files changed, 102 insertions, 82 deletions

diff --git a/include/functions.h b/include/functions.h
index 903af90b6..bd20666ea 100644
--- a/include/functions.h
+++ b/include/functions.h
@@ -902,9 +902,7 @@ void Room_Draw(PlayState* play, Room* room, u32 flags);
 void Room_FinishRoomChange(PlayState* play, RoomContext* roomCtx);
 void Sample_Destroy(GameState* thisx);
 void Sample_Init(GameState* thisx);
-void Inventory_ChangeEquipment(s16 equipment, u16 value);
-u8 Inventory_DeleteEquipment(PlayState* play, s16 equipment);
-void Inventory_ChangeUpgrade(s16 upgrade, s16 value);
+
 void Object_InitContext(PlayState* play, ObjectContext* objectCtx);
 void Object_UpdateEntries(ObjectContext* objectCtx);
 s32 Object_GetSlot(ObjectContext* objectCtx, s16 objectId);
diff --git a/include/macros.h b/include/macros.h
index 10d328af6..f599adfd2 100644
--- a/include/macros.h
+++ b/include/macros.h
@@ -38,74 +38,6 @@
 
 #define RGBA8(r, g, b, a) ((((r) & 0xFF) << 24) | (((g) & 0xFF) << 16) | (((b) & 0xFF) << 8) | (((a) & 0xFF) << 0))
 
-#define LINK_IS_ADULT (gSaveContext.save.linkAge == LINK_AGE_ADULT)
-#define LINK_IS_CHILD (gSaveContext.save.linkAge == LINK_AGE_CHILD)
-
-#define YEARS_CHILD 5
-#define YEARS_ADULT 17
-#define LINK_AGE_IN_YEARS (!LINK_IS_ADULT ? YEARS_CHILD : YEARS_ADULT)
-
-#define CLOCK_TIME(hr, min) ((s32)(((hr) * 60 + (min)) * (f32)0x10000 / (24 * 60) + 0.5f))
-
-#define IS_DAY (gSaveContext.save.nightFlag == 0)
-#define IS_NIGHT (gSaveContext.save.nightFlag == 1)
-
-#define SLOT(item) gItemSlots[item]
-#define INV_CONTENT(item) gSaveContext.save.info.inventory.items[SLOT(item)]
-#define AMMO(item) gSaveContext.save.info.inventory.ammo[SLOT(item)]
-#define BEANS_BOUGHT AMMO(ITEM_MAGIC_BEAN + 1)
-
-#define ALL_EQUIP_VALUE(equip) ((s32)(gSaveContext.save.info.inventory.equipment & gEquipMasks[equip]) >> gEquipShifts[equip])
-#define CUR_EQUIP_VALUE(equip) ((s32)(gSaveContext.save.info.equips.equipment & gEquipMasks[equip]) >> gEquipShifts[equip])
-#define OWNED_EQUIP_FLAG(equip, value) (gBitFlags[value] << gEquipShifts[equip])
-#define OWNED_EQUIP_FLAG_ALT(equip, value) ((1 << (value)) << gEquipShifts[equip])
-#define CHECK_OWNED_EQUIP(equip, value) (OWNED_EQUIP_FLAG(equip, value) & gSaveContext.save.info.inventory.equipment)
-#define CHECK_OWNED_EQUIP_ALT(equip, value) (gBitFlags[(value) + (equip) * 4] & gSaveContext.save.info.inventory.equipment)
-
-#define SWORD_EQUIP_TO_PLAYER(swordEquip) (swordEquip)
-#define SHIELD_EQUIP_TO_PLAYER(shieldEquip) (shieldEquip)
-#define TUNIC_EQUIP_TO_PLAYER(tunicEquip) ((tunicEquip) - 1)
-#define BOOTS_EQUIP_TO_PLAYER(bootsEquip) ((bootsEquip) - 1)
-
-#define CUR_UPG_VALUE(upg) ((s32)(gSaveContext.save.info.inventory.upgrades & gUpgradeMasks[upg]) >> gUpgradeShifts[upg])
-#define CAPACITY(upg, value) gUpgradeCapacities[upg][value]
-#define CUR_CAPACITY(upg) CAPACITY(upg, CUR_UPG_VALUE(upg))
-
-#define CHECK_QUEST_ITEM(item) (gBitFlags[item] & gSaveContext.save.info.inventory.questItems)
-#define CHECK_DUNGEON_ITEM(item, dungeonIndex) (gSaveContext.save.info.inventory.dungeonItems[dungeonIndex] & gBitFlags[item])
-
-#define GET_GS_FLAGS(index) \
-    ((gSaveContext.save.info.gsFlags[(index) >> 2] & gGsFlagsMasks[(index) & 3]) >> gGsFlagsShifts[(index) & 3])
-#define SET_GS_FLAGS(index, value) \
-    (gSaveContext.save.info.gsFlags[(index) >> 2] |= (value) << gGsFlagsShifts[(index) & 3])
-
-#define HIGH_SCORE(score) (gSaveContext.save.info.highScores[score])
-
-#define GET_EVENTCHKINF(flag) (gSaveContext.save.info.eventChkInf[(flag) >> 4] & (1 << ((flag) & 0xF)))
-#define SET_EVENTCHKINF(flag) (gSaveContext.save.info.eventChkInf[(flag) >> 4] |= (1 << ((flag) & 0xF)))
-#define CLEAR_EVENTCHKINF(flag) (gSaveContext.save.info.eventChkInf[(flag) >> 4] &= ~(1 << ((flag) & 0xF)))
-
-#define GET_ITEMGETINF(flag) (gSaveContext.save.info.itemGetInf[(flag) >> 4] & (1 << ((flag) & 0xF)))
-#define SET_ITEMGETINF(flag) (gSaveContext.save.info.itemGetInf[(flag) >> 4] |= (1 << ((flag) & 0xF)))
-
-#define GET_INFTABLE(flag) (gSaveContext.save.info.infTable[(flag) >> 4] & (1 << ((flag) & 0xF)))
-#define SET_INFTABLE(flag) (gSaveContext.save.info.infTable[(flag) >> 4] |= (1 << ((flag) & 0xF)))
-#define CLEAR_INFTABLE(flag) (gSaveContext.save.info.infTable[(flag) >> 4] &= ~(1 << ((flag) & 0xF)))
-
-#define GET_EVENTINF(flag) (gSaveContext.eventInf[(flag) >> 4] & (1 << ((flag) & 0xF)))
-#define SET_EVENTINF(flag) (gSaveContext.eventInf[(flag) >> 4] |= (1 << ((flag) & 0xF)))
-#define CLEAR_EVENTINF(flag) (gSaveContext.eventInf[(flag) >> 4] &= ~(1 << ((flag) & 0xF)))
-
-#define B_BTN_ITEM ((gSaveContext.buttonStatus[0] == ITEM_NONE)                     \
-                        ? ITEM_NONE                                                 \
-                        : (gSaveContext.save.info.equips.buttonItems[0] == ITEM_GIANTS_KNIFE) \
-                            ? ITEM_SWORD_BIGGORON                                   \
-                            : gSaveContext.save.info.equips.buttonItems[0])
-
-#define C_BTN_ITEM(button) ((gSaveContext.buttonStatus[(button) + 1] != BTN_DISABLED) \
-                                ? gSaveContext.save.info.equips.buttonItems[(button) + 1]       \
-                                : ITEM_NONE)
-
 #define CHECK_FLAG_ALL(flags, mask) (((flags) & (mask)) == (mask))
 
 // IDO doesn't support variadic macros, but it merely throws a warning for the
diff --git a/include/variables.h b/include/variables.h
index 2f96222d5..f4e15f736 100644
--- a/include/variables.h
+++ b/include/variables.h
@@ -73,17 +73,7 @@ extern Gfx* gPlayerLeftHandBoomerangDLs[];
 extern Gfx gCullBackDList[];
 extern Gfx gCullFrontDList[];
 extern Gfx gEmptyDL[];
-extern u32 gBitFlags[32];
-extern u16 gEquipMasks[EQUIP_TYPE_MAX];
-extern u16 gEquipNegMasks[EQUIP_TYPE_MAX];
-extern u32 gUpgradeMasks[UPG_MAX];
-extern u8 gEquipShifts[EQUIP_TYPE_MAX];
-extern u8 gUpgradeShifts[UPG_MAX];
-extern u16 gUpgradeCapacities[UPG_MAX][4];
-extern u32 gGsFlagsMasks[4];
-extern u32 gGsFlagsShifts[4];
-extern void* gItemIcons[0x82];
-extern u8 gItemSlots[56];
+
 extern SceneCmdHandlerFunc gSceneCmdHandlers[SCENE_CMD_ID_MAX];
 extern s16 gLinkObjectIds[2];
 extern u32 gObjectTableSize;
diff --git a/include/z64.h b/include/z64.h
index 2d36ccd43..c7a0a1ea2 100644
--- a/include/z64.h
+++ b/include/z64.h
@@ -23,6 +23,7 @@
 #include "z64scene.h"
 #include "z64effect.h"
 #include "z64game_over.h"
+#include "z64inventory.h"
 #include "z64item.h"
 #include "z64animation.h"
 #include "z64animation_legacy.h"
diff --git a/include/z64inventory.h b/include/z64inventory.h
new file mode 100644
index 000000000..9a8133b3d
--- /dev/null
+++ b/include/z64inventory.h
@@ -0,0 +1,26 @@
+#ifndef Z64INVENTORY_H
+#define Z64INVENTORY_H
+
+#include "ultra64.h"
+#include "z64item.h"
+#include "z64save.h"
+
+struct PlayState;
+
+void Inventory_ChangeEquipment(s16 equipment, u16 value);
+u8 Inventory_DeleteEquipment(struct PlayState* play, s16 equipment);
+void Inventory_ChangeUpgrade(s16 upgrade, s16 value);
+
+extern u32 gBitFlags[32];
+extern u16 gEquipMasks[EQUIP_TYPE_MAX];
+extern u16 gEquipNegMasks[EQUIP_TYPE_MAX];
+extern u32 gUpgradeMasks[UPG_MAX];
+extern u8 gEquipShifts[EQUIP_TYPE_MAX];
+extern u8 gUpgradeShifts[UPG_MAX];
+extern u16 gUpgradeCapacities[UPG_MAX][4];
+extern u32 gGsFlagsMasks[4];
+extern u32 gGsFlagsShifts[4];
+extern void* gItemIcons[0x82];
+extern u8 gItemSlots[56];
+
+#endif
diff --git a/include/z64save.h b/include/z64save.h
index 4b7513e53..2c10d76bc 100644
--- a/include/z64save.h
+++ b/include/z64save.h
@@ -3,6 +3,7 @@
 
 #include "ultra64.h"
 #include "versions.h"
+#include "z64inventory.h"
 #include "z64math.h"
 
 typedef enum Language {
@@ -398,6 +399,59 @@ typedef enum LinkAge {
 } LinkAge;
 
 
+#define LINK_IS_ADULT (gSaveContext.save.linkAge == LINK_AGE_ADULT)
+#define LINK_IS_CHILD (gSaveContext.save.linkAge == LINK_AGE_CHILD)
+
+#define YEARS_CHILD 5
+#define YEARS_ADULT 17
+#define LINK_AGE_IN_YEARS (!LINK_IS_ADULT ? YEARS_CHILD : YEARS_ADULT)
+
+#define CLOCK_TIME(hr, min) ((s32)(((hr) * 60 + (min)) * (f32)0x10000 / (24 * 60) + 0.5f))
+
+#define IS_DAY (gSaveContext.save.nightFlag == 0)
+#define IS_NIGHT (gSaveContext.save.nightFlag == 1)
+
+#define SLOT(item) gItemSlots[item]
+#define INV_CONTENT(item) gSaveContext.save.info.inventory.items[SLOT(item)]
+#define AMMO(item) gSaveContext.save.info.inventory.ammo[SLOT(item)]
+#define BEANS_BOUGHT AMMO(ITEM_MAGIC_BEAN + 1)
+
+#define ALL_EQUIP_VALUE(equip) ((s32)(gSaveContext.save.info.inventory.equipment & gEquipMasks[equip]) >> gEquipShifts[equip])
+#define CUR_EQUIP_VALUE(equip) ((s32)(gSaveContext.save.info.equips.equipment & gEquipMasks[equip]) >> gEquipShifts[equip])
+#define OWNED_EQUIP_FLAG(equip, value) (gBitFlags[value] << gEquipShifts[equip])
+#define OWNED_EQUIP_FLAG_ALT(equip, value) ((1 << (value)) << gEquipShifts[equip])
+#define CHECK_OWNED_EQUIP(equip, value) (OWNED_EQUIP_FLAG(equip, value) & gSaveContext.save.info.inventory.equipment)
+#define CHECK_OWNED_EQUIP_ALT(equip, value) (gBitFlags[(value) + (equip) * 4] & gSaveContext.save.info.inventory.equipment)
+
+#define SWORD_EQUIP_TO_PLAYER(swordEquip) (swordEquip)
+#define SHIELD_EQUIP_TO_PLAYER(shieldEquip) (shieldEquip)
+#define TUNIC_EQUIP_TO_PLAYER(tunicEquip) ((tunicEquip) - 1)
+#define BOOTS_EQUIP_TO_PLAYER(bootsEquip) ((bootsEquip) - 1)
+
+#define CUR_UPG_VALUE(upg) ((s32)(gSaveContext.save.info.inventory.upgrades & gUpgradeMasks[upg]) >> gUpgradeShifts[upg])
+#define CAPACITY(upg, value) gUpgradeCapacities[upg][value]
+#define CUR_CAPACITY(upg) CAPACITY(upg, CUR_UPG_VALUE(upg))
+
+#define CHECK_QUEST_ITEM(item) (gBitFlags[item] & gSaveContext.save.info.inventory.questItems)
+#define CHECK_DUNGEON_ITEM(item, dungeonIndex) (gSaveContext.save.info.inventory.dungeonItems[dungeonIndex] & gBitFlags[item])
+
+#define GET_GS_FLAGS(index) \
+    ((gSaveContext.save.info.gsFlags[(index) >> 2] & gGsFlagsMasks[(index) & 3]) >> gGsFlagsShifts[(index) & 3])
+#define SET_GS_FLAGS(index, value) \
+    (gSaveContext.save.info.gsFlags[(index) >> 2] |= (value) << gGsFlagsShifts[(index) & 3])
+
+#define HIGH_SCORE(score) (gSaveContext.save.info.highScores[score])
+
+#define B_BTN_ITEM ((gSaveContext.buttonStatus[0] == ITEM_NONE)                     \
+                        ? ITEM_NONE                                                 \
+                        : (gSaveContext.save.info.equips.buttonItems[0] == ITEM_GIANTS_KNIFE) \
+                            ? ITEM_SWORD_BIGGORON                                   \
+                            : gSaveContext.save.info.equips.buttonItems[0])
+
+#define C_BTN_ITEM(button) ((gSaveContext.buttonStatus[(button) + 1] != BTN_DISABLED) \
+                                ? gSaveContext.save.info.equips.buttonItems[(button) + 1]       \
+                                : ITEM_NONE)
+
 
 /*
  *
@@ -599,6 +653,11 @@ typedef enum LinkAge {
 #define EVENTCHKINF_DE_MASK (1 << 14)
 
 
+#define GET_EVENTCHKINF(flag) (gSaveContext.save.info.eventChkInf[(flag) >> 4] & (1 << ((flag) & 0xF)))
+#define SET_EVENTCHKINF(flag) (gSaveContext.save.info.eventChkInf[(flag) >> 4] |= (1 << ((flag) & 0xF)))
+#define CLEAR_EVENTCHKINF(flag) (gSaveContext.save.info.eventChkInf[(flag) >> 4] &= ~(1 << ((flag) & 0xF)))
+
+
 /*
  * SaveContext.itemGetInf
  */
@@ -658,6 +717,10 @@ typedef enum LinkAge {
 #define ITEMGETINF_3F 0x3F
 
 
+#define GET_ITEMGETINF(flag) (gSaveContext.save.info.itemGetInf[(flag) >> 4] & (1 << ((flag) & 0xF)))
+#define SET_ITEMGETINF(flag) (gSaveContext.save.info.itemGetInf[(flag) >> 4] |= (1 << ((flag) & 0xF)))
+
+
 /*
  * SaveContext.infTable
  */
@@ -818,6 +881,11 @@ typedef enum LinkAge {
 #define INFTABLE_1DX_INDEX 29
 
 
+#define GET_INFTABLE(flag) (gSaveContext.save.info.infTable[(flag) >> 4] & (1 << ((flag) & 0xF)))
+#define SET_INFTABLE(flag) (gSaveContext.save.info.infTable[(flag) >> 4] |= (1 << ((flag) & 0xF)))
+#define CLEAR_INFTABLE(flag) (gSaveContext.save.info.infTable[(flag) >> 4] &= ~(1 << ((flag) & 0xF)))
+
+
 /*
  * SaveContext.eventInf
  */
@@ -892,6 +960,11 @@ typedef enum EventInfHorsesState {
 #define EVENTINF_30 0x30
 
 
+#define GET_EVENTINF(flag) (gSaveContext.eventInf[(flag) >> 4] & (1 << ((flag) & 0xF)))
+#define SET_EVENTINF(flag) (gSaveContext.eventInf[(flag) >> 4] |= (1 << ((flag) & 0xF)))
+#define CLEAR_EVENTINF(flag) (gSaveContext.eventInf[(flag) >> 4] &= ~(1 << ((flag) & 0xF)))
+
+
 extern SaveContext gSaveContext;
 
 #endif