eqemu-server/common/emu_versions.h

/*	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  02111-1307  USA
*/

#ifndef COMMON_EMU_VERSIONS_H
#define COMMON_EMU_VERSIONS_H

#include "types.h"

#include <stdlib.h>


namespace EQEmu
{
	namespace versions {
		enum class ClientVersion : uint32 {
			Unknown = 0,
			Client62,	// Build: 'Aug  4 2005 15:40:59'
			Titanium,	// Build: 'Oct 31 2005 10:33:37'
			SoF,		// Build: 'Sep  7 2007 09:11:49'
			SoD,		// Build: 'Dec 19 2008 15:22:49'
			UF,			// Build: 'Jun  8 2010 16:44:32'
			RoF,		// Build: 'Dec 10 2012 17:35:44'
			RoF2		// Build: 'May 10 2013 23:30:08'
		};

		enum ClientVersionBitmask : uint32 {
			bitUnknown = 0x00000000,
			bitClient62 = 0x00000001, // unsupported (placeholder for scripts)
			bitTitanium = 0x00000002,
			bitSoF = 0x00000004,
			bitSoD = 0x00000008,
			bitUF = 0x00000010,
			bitRoF = 0x00000020,
			bitRoF2 = 0x00000040,
			maskUnknown = 0x00000000,
			maskTitaniumAndEarlier = 0x00000003,
			maskSoFAndEarlier = 0x00000007,
			maskSoDAndEarlier = 0x0000000F,
			maskUFAndEarlier = 0x0000001F,
			maskRoFAndEarlier = 0x0000003F,
			maskSoFAndLater = 0xFFFFFFFC,
			maskSoDAndLater = 0xFFFFFFF8,
			maskUFAndLater = 0xFFFFFFF0,
			maskRoFAndLater = 0xFFFFFFE0,
			maskRoF2AndLater = 0xFFFFFFC0,
			maskAllClients = 0xFFFFFFFF
		};

		const ClientVersion LastClientVersion = ClientVersion::RoF2;
		const size_t ClientVersionCount = (static_cast<size_t>(LastClientVersion) + 1);

		bool IsValidClientVersion(ClientVersion client_version);
		ClientVersion ValidateClientVersion(ClientVersion client_version);
		const char* ClientVersionName(ClientVersion client_version);
		uint32 ConvertClientVersionToClientVersionBit(ClientVersion client_version);
		ClientVersion ConvertClientVersionBitToClientVersion(uint32 client_version_bit);
		
		enum class MobVersion : uint32 {
			Unknown = 0,
			Client62,
			Titanium,
			SoF,
			SoD,
			UF,
			RoF,
			RoF2,
			NPC,
			NPCMerchant,
			Merc,
			Bot,
			ClientPet,
			NPCPet,
			MercPet,
			BotPet,
			OfflineTitanium,
			OfflineSoF,
			OfflineSoD,
			OfflineUF,
			OfflineRoF,
			OfflineRoF2
		};

		const MobVersion LastMobVersion = MobVersion::OfflineRoF2;
		const MobVersion LastPCMobVersion = MobVersion::RoF2;
		const MobVersion LastNonPCMobVersion = MobVersion::BotPet;
		const MobVersion LastOfflinePCMobVersion = MobVersion::OfflineRoF2;
		const size_t MobVersionCount = (static_cast<size_t>(LastMobVersion) + 1);

		bool IsValidMobVersion(MobVersion mob_version);
		bool IsValidPCMobVersion(MobVersion mob_version);
		bool IsValidNonPCMobVersion(MobVersion mob_version);
		bool IsValidOfflinePCMobVersion(MobVersion mob_version);

		MobVersion ValidateMobVersion(MobVersion mob_version);
		MobVersion ValidatePCMobVersion(MobVersion mob_version);
		MobVersion ValidateNonPCMobVersion(MobVersion mob_version);
		MobVersion ValidateOfflinePCMobVersion(MobVersion mob_version);

		const char* MobVersionName(MobVersion mob_version);
		ClientVersion ConvertMobVersionToClientVersion(MobVersion mob_version);
		MobVersion ConvertClientVersionToMobVersion(ClientVersion client_version);
		MobVersion ConvertPCMobVersionToOfflinePCMobVersion(MobVersion mob_version);
		MobVersion ConvertOfflinePCMobVersionToPCMobVersion(MobVersion mob_version);
		ClientVersion ConvertOfflinePCMobVersionToClientVersion(MobVersion mob_version);
		MobVersion ConvertClientVersionToOfflinePCMobVersion(ClientVersion client_version);


		enum UCSVersion : char {
			ucsUnknown = '\0',
			ucsClient62Chat = 'A',
			ucsClient62Mail = 'a',
			ucsTitaniumChat = 'B',
			ucsTitaniumMail = 'b',
			ucsSoFCombined = 'C',
			ucsSoDCombined = 'D',
			ucsUFCombined = 'E',
			ucsRoFCombined = 'F',
			ucsRoF2Combined = 'G'
		};

	} /*versions*/

	namespace expansions {
		enum class Expansion : uint32 {
			EverQuest = 0,
			RoK,
			SoV,
			SoL,
			PoP,
			LoY,
			LDoN,
			GoD,
			OoW,
			DoN,
			DoD,
			PoR,
			TSS,
			TBS,
			SoF,
			SoD,
			UF,
			HoT,
			VoA,
			RoF,
			CotF
		};

		enum ExpansionBitmask : uint32 {
			bitEverQuest = 0x00000000,
			bitRoK = 0x00000001,
			bitSoV = 0x00000002,
			bitSoL = 0x00000004,
			bitPoP = 0x00000008,
			bitLoY = 0x00000010,
			bitLDoN = 0x00000020,
			bitGoD = 0x00000040,
			bitOoW = 0x00000080,
			bitDoN = 0x00000100,
			bitDoD = 0x00000200,
			bitPoR = 0x00000400,
			bitTSS = 0x00000800,
			bitTBS = 0x00001000,
			bitSoF = 0x00002000,
			bitSoD = 0x00004000,
			bitUF = 0x00008000,
			bitHoT = 0x00010000,
			bitVoA = 0x00020000,
			bitRoF = 0x00040000,
			bitCotF = 0x00080000,
			maskEverQuest = 0x00000000,
			maskRoK = 0x00000001,
			maskSoV = 0x00000003,
			maskSoL = 0x00000007,
			maskPoP = 0x0000000F,
			maskLoY = 0x0000001F,
			maskLDoN = 0x0000003F,
			maskGoD = 0x0000007F,
			maskOoW = 0x000000FF,
			maskDoN = 0x000001FF,
			maskDoD = 0x000003FF,
			maskPoR = 0x000007FF,
			maskTSS = 0x00000FFF,
			maskTBS = 0x00001FFF,
			maskSoF = 0x00003FFF,
			maskSoD = 0x00007FFF,
			maskUF = 0x0000FFFF,
			maskHoT = 0x0001FFFF,
			maskVoA = 0x0003FFFF,
			maskRoF = 0x0007FFFF,
			maskCotF = 0x000FFFFF
		};

		const char* ExpansionName(Expansion expansion);
		const char* ExpansionName(uint32 expansion_bit);
		uint32 ConvertExpansionToExpansionBit(Expansion expansion);
		Expansion ConvertExpansionBitToExpansion(uint32 expansion_bit);
		uint32 ConvertExpansionToExpansionsMask(Expansion expansion);
		Expansion ConvertClientVersionToExpansion(versions::ClientVersion client_version);
		uint32 ConvertClientVersionToExpansionBit(versions::ClientVersion client_version);
		uint32 ConvertClientVersionToExpansionsMask(versions::ClientVersion client_version);

	} /*expansions*/

} /*EQEmu*/

#endif /*COMMON_EMU_VERSIONS_H*/