Separated class Inventory from item_instance files into inventory_profile files

changelog.txt

@@ -2,6 +2,7 @@ EQEMu Changelog (Started on Sept 24, 2003 15:50)
 -------------------------------------------------------
 == 10/17/2016 ==
 Uleat: Moved namespace ItemField from item_instance.h to shareddb.cpp - the only place it is used
+Uleat: Separated class Inventory from item_instance files into inventory_profile files
 
 == 10/16/2016 ==
 Uleat: Renamed struct EQEmu::ItemBase to EQEmu::ItemData and class ItemInst to EQEmu::ItemInstance

common/CMakeLists.txt

@@ -35,6 +35,7 @@ SET(common_sources
 	faction.cpp
 	guild_base.cpp
 	guilds.cpp
+	inventory_profile.cpp
 	inventory_slot.cpp
 	ipc_mutex.cpp
 	item_data.cpp
@@ -156,6 +157,7 @@ SET(common_headers
 	global_define.h
 	guild_base.h
 	guilds.h
+	inventory_profile.h
 	inventory_slot.h
 	ipc_mutex.h
 	item_data.h

common/extprofile.h

@@ -19,7 +19,7 @@
 #define EXTENDED_PROFILE_H
 
 #include "eq_packet_structs.h"
-#include "item_instance.h"
+#include "inventory_profile.h"
 
 #pragma pack(1)
 

common/inventory_profile.h

@@ -0,0 +1,228 @@
+/*	EQEMu: Everquest Server Emulator
+
+	Copyright (C) 2001-2016 EQEMu Development Team (http://eqemulator.net)
+
+	This program is free software; you can redistribute it and/or modify
+	it under the terms of the GNU General Public License as published by
+	the Free Software Foundation; version 2 of the License.
+
+	This program is distributed in the hope that it will be useful,
+	but WITHOUT ANY WARRANTY except by those people which sell it, which
+	are required to give you total support for your newly bought product;
+	without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+	A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+	You should have received a copy of the GNU General Public License
+	along with this program; if not, write to the Free Software
+	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  04111-1307  USA
+*/
+
+// @merth notes:
+// These classes could be optimized with database reads/writes by storing
+// a status flag indicating how object needs to interact with database
+
+#ifndef COMMON_INVENTORY_PROFILE_H
+#define COMMON_INVENTORY_PROFILE_H
+
+
+#include "item_instance.h"
+
+#include <list>
+
+
+//FatherNitwit: location bits for searching specific
+//places with HasItem() and HasItemByUse()
+enum {
+	invWhereWorn		= 0x01,
+	invWherePersonal	= 0x02,	//in the character's inventory
+	invWhereBank		= 0x04,
+	invWhereSharedBank	= 0x08,
+	invWhereTrading		= 0x10,
+	invWhereCursor		= 0x20
+};
+
+// ########################################
+// Class: Queue
+//	Queue that allows a read-only iterator
+class ItemInstQueue
+{
+public:
+	~ItemInstQueue();
+	/////////////////////////
+	// Public Methods
+	/////////////////////////
+
+	inline std::list<EQEmu::ItemInstance*>::const_iterator cbegin() { return m_list.cbegin(); }
+	inline std::list<EQEmu::ItemInstance*>::const_iterator cend() { return m_list.cend(); }
+
+	inline int size() { return static_cast<int>(m_list.size()); } // TODO: change to size_t
+	inline bool empty() { return m_list.empty(); }
+
+	void push(EQEmu::ItemInstance* inst);
+	void push_front(EQEmu::ItemInstance* inst);
+	EQEmu::ItemInstance* pop();
+	EQEmu::ItemInstance* pop_back();
+	EQEmu::ItemInstance* peek_front() const;
+
+protected:
+	/////////////////////////
+	// Protected Members
+	/////////////////////////
+
+	std::list<EQEmu::ItemInstance*> m_list;
+};
+
+// ########################################
+// Class: Inventory
+//	Character inventory
+class Inventory
+{
+	friend class EQEmu::ItemInstance;
+public:
+	///////////////////////////////
+	// Public Methods
+	///////////////////////////////
+	
+	Inventory() { m_inventory_version = EQEmu::versions::InventoryVersion::Unknown; m_inventory_version_set = false; }
+	~Inventory();
+
+	// inv2 creep
+	bool SetInventoryVersion(EQEmu::versions::InventoryVersion inventory_version) {
+		if (!m_inventory_version_set) {
+			m_inventory_version = EQEmu::versions::ValidateInventoryVersion(inventory_version);
+			return (m_inventory_version_set = true);
+		}
+		else {
+			return false;
+		}
+	}
+	bool SetInventoryVersion(EQEmu::versions::ClientVersion client_version) { return SetInventoryVersion(EQEmu::versions::ConvertClientVersionToInventoryVersion(client_version)); }
+
+	EQEmu::versions::InventoryVersion InventoryVersion() { return m_inventory_version; }
+
+	static void CleanDirty();
+	static void MarkDirty(EQEmu::ItemInstance *inst);
+
+	// Retrieve a writeable item at specified slot
+	EQEmu::ItemInstance* GetItem(int16 slot_id) const;
+	EQEmu::ItemInstance* GetItem(int16 slot_id, uint8 bagidx) const;
+
+	inline std::list<EQEmu::ItemInstance*>::const_iterator cursor_cbegin() { return m_cursor.cbegin(); }
+	inline std::list<EQEmu::ItemInstance*>::const_iterator cursor_cend() { return m_cursor.cend(); }
+
+	inline int CursorSize() { return m_cursor.size(); }
+	inline bool CursorEmpty() { return m_cursor.empty(); }
+
+	// Retrieve a read-only item from inventory
+	inline const EQEmu::ItemInstance* operator[](int16 slot_id) const { return GetItem(slot_id); }
+
+	// Add item to inventory
+	int16 PutItem(int16 slot_id, const EQEmu::ItemInstance& inst);
+
+	// Add item to cursor queue
+	int16 PushCursor(const EQEmu::ItemInstance& inst);
+
+	// Get cursor item in front of queue
+	EQEmu::ItemInstance* GetCursorItem();
+
+	// Swap items in inventory
+	bool SwapItem(int16 slot_a, int16 slot_b);
+
+	// Remove item from inventory
+	bool DeleteItem(int16 slot_id, uint8 quantity=0);
+
+	// Checks All items in a bag for No Drop
+	bool CheckNoDrop(int16 slot_id);
+
+	// Remove item from inventory (and take control of memory)
+	EQEmu::ItemInstance* PopItem(int16 slot_id);
+
+	// Check whether there is space for the specified number of the specified item.
+	bool HasSpaceForItem(const EQEmu::ItemData *ItemToTry, int16 Quantity);
+
+	// Check whether item exists in inventory
+	// where argument specifies OR'd list of invWhere constants to look
+	int16 HasItem(uint32 item_id, uint8 quantity = 0, uint8 where = 0xFF);
+
+	// Check whether item exists in inventory
+	// where argument specifies OR'd list of invWhere constants to look
+	int16 HasItemByUse(uint8 use, uint8 quantity=0, uint8 where=0xFF);
+
+	// Check whether item exists in inventory
+	// where argument specifies OR'd list of invWhere constants to look
+	int16 HasItemByLoreGroup(uint32 loregroup, uint8 where=0xFF);
+
+	// Locate an available inventory slot
+	int16 FindFreeSlot(bool for_bag, bool try_cursor, uint8 min_size = 0, bool is_arrow = false);
+	int16 FindFreeSlotForTradeItem(const EQEmu::ItemInstance* inst);
+
+	// Calculate slot_id for an item within a bag
+	static int16 CalcSlotId(int16 slot_id); // Calc parent bag's slot_id
+	static int16 CalcSlotId(int16 bagslot_id, uint8 bagidx); // Calc slot_id for item inside bag
+	static uint8 CalcBagIdx(int16 slot_id); // Calc bagidx for slot_id
+	static int16 CalcSlotFromMaterial(uint8 material);
+	static uint8 CalcMaterialFromSlot(int16 equipslot);
+
+	static bool CanItemFitInContainer(const EQEmu::ItemData *ItemToTry, const EQEmu::ItemData *Container);
+
+	//  Test for valid inventory casting slot
+	bool SupportsClickCasting(int16 slot_id);
+	bool SupportsPotionBeltCasting(int16 slot_id);
+
+	// Test whether a given slot can support a container item
+	static bool SupportsContainers(int16 slot_id);
+
+	int GetSlotByItemInst(EQEmu::ItemInstance *inst);
+
+	uint8 FindBrightestLightType();
+
+	void dumpEntireInventory();
+	void dumpWornItems();
+	void dumpInventory();
+	void dumpBankItems();
+	void dumpSharedBankItems();
+
+	void SetCustomItemData(uint32 character_id, int16 slot_id, std::string identifier, std::string value);
+	void SetCustomItemData(uint32 character_id, int16 slot_id, std::string identifier, int value);
+	void SetCustomItemData(uint32 character_id, int16 slot_id, std::string identifier, float value);
+	void SetCustomItemData(uint32 character_id, int16 slot_id, std::string identifier, bool value);
+	std::string GetCustomItemData(int16 slot_id, std::string identifier);
+protected:
+	///////////////////////////////
+	// Protected Methods
+	///////////////////////////////
+
+	int GetSlotByItemInstCollection(const std::map<int16, EQEmu::ItemInstance*> &collection, EQEmu::ItemInstance *inst);
+	void dumpItemCollection(const std::map<int16, EQEmu::ItemInstance*> &collection);
+	void dumpBagContents(EQEmu::ItemInstance *inst, std::map<int16, EQEmu::ItemInstance*>::const_iterator *it);
+
+	// Retrieves item within an inventory bucket
+	EQEmu::ItemInstance* _GetItem(const std::map<int16, EQEmu::ItemInstance*>& bucket, int16 slot_id) const;
+
+	// Private "put" item into bucket, without regard for what is currently in bucket
+	int16 _PutItem(int16 slot_id, EQEmu::ItemInstance* inst);
+
+	// Checks an inventory bucket for a particular item
+	int16 _HasItem(std::map<int16, EQEmu::ItemInstance*>& bucket, uint32 item_id, uint8 quantity);
+	int16 _HasItem(ItemInstQueue& iqueue, uint32 item_id, uint8 quantity);
+	int16 _HasItemByUse(std::map<int16, EQEmu::ItemInstance*>& bucket, uint8 use, uint8 quantity);
+	int16 _HasItemByUse(ItemInstQueue& iqueue, uint8 use, uint8 quantity);
+	int16 _HasItemByLoreGroup(std::map<int16, EQEmu::ItemInstance*>& bucket, uint32 loregroup);
+	int16 _HasItemByLoreGroup(ItemInstQueue& iqueue, uint32 loregroup);
+
+
+	// Player inventory
+	std::map<int16, EQEmu::ItemInstance*>	m_worn;		// Items worn by character
+	std::map<int16, EQEmu::ItemInstance*>	m_inv;		// Items in character personal inventory
+	std::map<int16, EQEmu::ItemInstance*>	m_bank;		// Items in character bank
+	std::map<int16, EQEmu::ItemInstance*>	m_shbank;	// Items in character shared bank
+	std::map<int16, EQEmu::ItemInstance*>	m_trade;	// Items in a trade session
+	ItemInstQueue				m_cursor;	// Items on cursor: FIFO
+
+private:
+	// Active inventory version
+	EQEmu::versions::InventoryVersion m_inventory_version;
+	bool m_inventory_version_set;
+};
+
+#endif /*COMMON_INVENTORY_PROFILE_H*/

common/item_instance.h

@@ -35,7 +35,6 @@ class EvolveInfo;			// Stores information about an evolving item family
 #include "../common/deity.h"
 #include "../common/memory_buffer.h"
 
-#include <list>
 #include <map>
 
 
@@ -52,208 +51,8 @@ typedef enum {
 	byFlagNotSet	//apply action if the flag is NOT set
 } byFlagSetting;
 
-
-//FatherNitwit: location bits for searching specific
-//places with HasItem() and HasItemByUse()
-enum {
-	invWhereWorn		= 0x01,
-	invWherePersonal	= 0x02,	//in the character's inventory
-	invWhereBank		= 0x04,
-	invWhereSharedBank	= 0x08,
-	invWhereTrading		= 0x10,
-	invWhereCursor		= 0x20
-};
-
-namespace EQEmu
-{
-	class ItemInstance;
-}
-
-// ########################################
-// Class: Queue
-//	Queue that allows a read-only iterator
-class ItemInstQueue
-{
-public:
-	~ItemInstQueue();
-	/////////////////////////
-	// Public Methods
-	/////////////////////////
-
-	inline std::list<EQEmu::ItemInstance*>::const_iterator cbegin() { return m_list.cbegin(); }
-	inline std::list<EQEmu::ItemInstance*>::const_iterator cend() { return m_list.cend(); }
-
-	inline int size() { return static_cast<int>(m_list.size()); } // TODO: change to size_t
-	inline bool empty() { return m_list.empty(); }
-
-	void push(EQEmu::ItemInstance* inst);
-	void push_front(EQEmu::ItemInstance* inst);
-	EQEmu::ItemInstance* pop();
-	EQEmu::ItemInstance* pop_back();
-	EQEmu::ItemInstance* peek_front() const;
-
-protected:
-	/////////////////////////
-	// Protected Members
-	/////////////////////////
-
-	std::list<EQEmu::ItemInstance*> m_list;
-};
-
-// ########################################
-// Class: Inventory
-//	Character inventory
-class Inventory
-{
-	friend class EQEmu::ItemInstance;
-public:
-	///////////////////////////////
-	// Public Methods
-	///////////////////////////////
-	
-	Inventory() { m_inventory_version = EQEmu::versions::InventoryVersion::Unknown; m_inventory_version_set = false; }
-	~Inventory();
-
-	// inv2 creep
-	bool SetInventoryVersion(EQEmu::versions::InventoryVersion inventory_version) {
-		if (!m_inventory_version_set) {
-			m_inventory_version = EQEmu::versions::ValidateInventoryVersion(inventory_version);
-			return (m_inventory_version_set = true);
-		}
-		else {
-			return false;
-		}
-	}
-	bool SetInventoryVersion(EQEmu::versions::ClientVersion client_version) { return SetInventoryVersion(EQEmu::versions::ConvertClientVersionToInventoryVersion(client_version)); }
-
-	EQEmu::versions::InventoryVersion InventoryVersion() { return m_inventory_version; }
-
-	static void CleanDirty();
-	static void MarkDirty(EQEmu::ItemInstance *inst);
-
-	// Retrieve a writeable item at specified slot
-	EQEmu::ItemInstance* GetItem(int16 slot_id) const;
-	EQEmu::ItemInstance* GetItem(int16 slot_id, uint8 bagidx) const;
-
-	inline std::list<EQEmu::ItemInstance*>::const_iterator cursor_cbegin() { return m_cursor.cbegin(); }
-	inline std::list<EQEmu::ItemInstance*>::const_iterator cursor_cend() { return m_cursor.cend(); }
-
-	inline int CursorSize() { return m_cursor.size(); }
-	inline bool CursorEmpty() { return m_cursor.empty(); }
-
-	// Retrieve a read-only item from inventory
-	inline const EQEmu::ItemInstance* operator[](int16 slot_id) const { return GetItem(slot_id); }
-
-	// Add item to inventory
-	int16 PutItem(int16 slot_id, const EQEmu::ItemInstance& inst);
-
-	// Add item to cursor queue
-	int16 PushCursor(const EQEmu::ItemInstance& inst);
-
-	// Get cursor item in front of queue
-	EQEmu::ItemInstance* GetCursorItem();
-
-	// Swap items in inventory
-	bool SwapItem(int16 slot_a, int16 slot_b);
-
-	// Remove item from inventory
-	bool DeleteItem(int16 slot_id, uint8 quantity=0);
-
-	// Checks All items in a bag for No Drop
-	bool CheckNoDrop(int16 slot_id);
-
-	// Remove item from inventory (and take control of memory)
-	EQEmu::ItemInstance* PopItem(int16 slot_id);
-
-	// Check whether there is space for the specified number of the specified item.
-	bool HasSpaceForItem(const EQEmu::ItemData *ItemToTry, int16 Quantity);
-
-	// Check whether item exists in inventory
-	// where argument specifies OR'd list of invWhere constants to look
-	int16 HasItem(uint32 item_id, uint8 quantity = 0, uint8 where = 0xFF);
-
-	// Check whether item exists in inventory
-	// where argument specifies OR'd list of invWhere constants to look
-	int16 HasItemByUse(uint8 use, uint8 quantity=0, uint8 where=0xFF);
-
-	// Check whether item exists in inventory
-	// where argument specifies OR'd list of invWhere constants to look
-	int16 HasItemByLoreGroup(uint32 loregroup, uint8 where=0xFF);
-
-	// Locate an available inventory slot
-	int16 FindFreeSlot(bool for_bag, bool try_cursor, uint8 min_size = 0, bool is_arrow = false);
-	int16 FindFreeSlotForTradeItem(const EQEmu::ItemInstance* inst);
-
-	// Calculate slot_id for an item within a bag
-	static int16 CalcSlotId(int16 slot_id); // Calc parent bag's slot_id
-	static int16 CalcSlotId(int16 bagslot_id, uint8 bagidx); // Calc slot_id for item inside bag
-	static uint8 CalcBagIdx(int16 slot_id); // Calc bagidx for slot_id
-	static int16 CalcSlotFromMaterial(uint8 material);
-	static uint8 CalcMaterialFromSlot(int16 equipslot);
-
-	static bool CanItemFitInContainer(const EQEmu::ItemData *ItemToTry, const EQEmu::ItemData *Container);
-
-	//  Test for valid inventory casting slot
-	bool SupportsClickCasting(int16 slot_id);
-	bool SupportsPotionBeltCasting(int16 slot_id);
-
-	// Test whether a given slot can support a container item
-	static bool SupportsContainers(int16 slot_id);
-
-	int GetSlotByItemInst(EQEmu::ItemInstance *inst);
-
-	uint8 FindBrightestLightType();
-
-	void dumpEntireInventory();
-	void dumpWornItems();
-	void dumpInventory();
-	void dumpBankItems();
-	void dumpSharedBankItems();
-
-	void SetCustomItemData(uint32 character_id, int16 slot_id, std::string identifier, std::string value);
-	void SetCustomItemData(uint32 character_id, int16 slot_id, std::string identifier, int value);
-	void SetCustomItemData(uint32 character_id, int16 slot_id, std::string identifier, float value);
-	void SetCustomItemData(uint32 character_id, int16 slot_id, std::string identifier, bool value);
-	std::string GetCustomItemData(int16 slot_id, std::string identifier);
-protected:
-	///////////////////////////////
-	// Protected Methods
-	///////////////////////////////
-
-	int GetSlotByItemInstCollection(const std::map<int16, EQEmu::ItemInstance*> &collection, EQEmu::ItemInstance *inst);
-	void dumpItemCollection(const std::map<int16, EQEmu::ItemInstance*> &collection);
-	void dumpBagContents(EQEmu::ItemInstance *inst, std::map<int16, EQEmu::ItemInstance*>::const_iterator *it);
-
-	// Retrieves item within an inventory bucket
-	EQEmu::ItemInstance* _GetItem(const std::map<int16, EQEmu::ItemInstance*>& bucket, int16 slot_id) const;
-
-	// Private "put" item into bucket, without regard for what is currently in bucket
-	int16 _PutItem(int16 slot_id, EQEmu::ItemInstance* inst);
-
-	// Checks an inventory bucket for a particular item
-	int16 _HasItem(std::map<int16, EQEmu::ItemInstance*>& bucket, uint32 item_id, uint8 quantity);
-	int16 _HasItem(ItemInstQueue& iqueue, uint32 item_id, uint8 quantity);
-	int16 _HasItemByUse(std::map<int16, EQEmu::ItemInstance*>& bucket, uint8 use, uint8 quantity);
-	int16 _HasItemByUse(ItemInstQueue& iqueue, uint8 use, uint8 quantity);
-	int16 _HasItemByLoreGroup(std::map<int16, EQEmu::ItemInstance*>& bucket, uint32 loregroup);
-	int16 _HasItemByLoreGroup(ItemInstQueue& iqueue, uint32 loregroup);
-
-
-	// Player inventory
-	std::map<int16, EQEmu::ItemInstance*>	m_worn;		// Items worn by character
-	std::map<int16, EQEmu::ItemInstance*>	m_inv;		// Items in character personal inventory
-	std::map<int16, EQEmu::ItemInstance*>	m_bank;		// Items in character bank
-	std::map<int16, EQEmu::ItemInstance*>	m_shbank;	// Items in character shared bank
-	std::map<int16, EQEmu::ItemInstance*>	m_trade;	// Items in a trade session
-	ItemInstQueue				m_cursor;	// Items on cursor: FIFO
-
-private:
-	// Active inventory version
-	EQEmu::versions::InventoryVersion m_inventory_version;
-	bool m_inventory_version_set;
-};
-
 class SharedDatabase;
+class Inventory;
 
 // ########################################
 // Class: EQEmu::ItemInstance

common/patches/rof.cpp

@@ -29,7 +29,7 @@
 #include "../eq_packet_structs.h"
 #include "../misc_functions.h"
 #include "../string_util.h"
-#include "../item_instance.h"
+#include "../inventory_profile.h"
 #include "rof_structs.h"
 #include "../rulesys.h"
 

common/patches/rof2.cpp

@@ -29,7 +29,7 @@
 #include "../eq_packet_structs.h"
 #include "../misc_functions.h"
 #include "../string_util.h"
-#include "../item_instance.h"
+#include "../inventory_profile.h"
 #include "rof2_structs.h"
 #include "../rulesys.h"
 

common/shareddb.cpp

@@ -29,7 +29,7 @@
 #include "faction.h"
 #include "features.h"
 #include "ipc_mutex.h"
-#include "item_instance.h"
+#include "inventory_profile.h"
 #include "loottable.h"
 #include "memory_mapped_file.h"
 #include "mysql.h"

world/client.cpp

@@ -25,7 +25,7 @@
 #include "../common/eq_packet_structs.h"
 #include "../common/packet_dump.h"
 #include "../common/eq_stream_intf.h"
-#include "../common/item_instance.h"
+#include "../common/inventory_profile.h"
 #include "../common/races.h"
 #include "../common/classes.h"
 #include "../common/languages.h"

world/worlddb.cpp

@@ -17,10 +17,9 @@
 */
 
 #include "worlddb.h"
-//#include "../common/item_instance.h"
 #include "../common/string_util.h"
 #include "../common/eq_packet_structs.h"
-#include "../common/item_instance.h"
+#include "../common/inventory_profile.h"
 #include "../common/rulesys.h"
 #include <iostream>
 #include <cstdlib>

zone/client.h

@@ -45,9 +45,9 @@ namespace EQEmu
 #include "../common/extprofile.h"
 #include "../common/races.h"
 #include "../common/seperator.h"
-#include "../common/item_instance.h"
+#include "../common/inventory_profile.h"
 #include "../common/guilds.h"
-#include "../common/item_data.h"
+//#include "../common/item_data.h"
 
 #include "common.h"
 #include "merc.h"

zone/zonedump.h

@@ -28,7 +28,7 @@ spawn2 mediumblob, npcs mediumblob, npc_loot mediumblob, gmspawntype mediumblob,
 #define ZONEDUMP_H
 #include "../common/faction.h"
 #include "../common/eq_packet_structs.h"
-#include "../common/item_instance.h"
+#include "../common/inventory_profile.h"
 
 #pragma pack(1)