[refactor] separate h3m reader from rest of mapservice

lib/CMakeLists.txt

@@ -18,6 +18,7 @@ set(lib_SRCS
 		Mapping/CMapEditManager.cpp
 		Mapping/CMapInfo.cpp
 		Mapping/CMapService.cpp
+		Mapping/MapFormatH3M.cpp
 		RMG/CMapGenOptions.cpp
 		RMG/CMapGenerator.cpp
 		BattleAction.cpp
@@ -54,6 +55,12 @@ set(lib_SRCS
 set(lib_HEADERS
 		Filesystem/CInputStream.h
 		Filesystem/ISimpleResourceLoader.h
+		Mapping/CCampaignHandler.h
+		Mapping/CMap.h
+		Mapping/CMapEditManager.h
+		Mapping/CMapInfo.h
+		Mapping/CMapService.h
+		Mapping/MapFormatH3M.h
 		AI_Base.h
 		CondSh.h
 		ConstTransitivePtr.h

lib/Mapping/CMapService.h

@@ -14,20 +14,9 @@
 class CMap;
 class CMapHeader;
 class CInputStream;
-class CGHeroInstance;
-class CArtifactInstance;
-class CGObjectInstance;
-class CGSeerHut;
-class IQuestObject;
-class CGTownInstance;
-class CCreatureSet;
-class CInputStream;
+
 class IMapLoader;
 
-#include "../vcmi_endian.h"
-#include "../int3.h"
-
-
 /**
  * The map service provides loading of VCMI/H3 map files. It can
  * be extended to save maps later as well.
@@ -126,290 +115,4 @@ public:
 	virtual std::unique_ptr<CMapHeader> loadMapHeader() = 0;
 };
 
-class DLL_LINKAGE CMapLoaderH3M : public IMapLoader
-{
-public:
-	/**
-	 * Default constructor.
-	 *
-	 * @param stream a stream containing the map data
-	 */
-	CMapLoaderH3M(CInputStream * stream);
 
-	/**
-	 * Destructor.
-	 */
-	~CMapLoaderH3M();
-
-	/**
-	 * Loads the VCMI/H3 map file.
-	 *
-	 * @return a unique ptr of the loaded map class
-	 */
-	std::unique_ptr<CMap> loadMap();
-
-	/**
-	 * Loads the VCMI/H3 map header.
-	 *
-	 * @return a unique ptr of the loaded map header class
-	 */
-	std::unique_ptr<CMapHeader> loadMapHeader();
-
-	/** true if you want to enable the map loader profiler to see how long a specific part took; default=false */
-	static const bool IS_PROFILING_ENABLED;
-
-private:
-	/**
-	 * Initializes the map object from parsing the input buffer.
-	 */
-	void init();
-
-	/**
-	 * Reads the map header.
-	 */
-	void readHeader();
-
-	/**
-	 * Reads player information.
-	 */
-	void readPlayerInfo();
-
-	/**
-	 * Reads victory/loss conditions.
-	 */
-	void readVictoryLossConditions();
-
-	/**
-	 * Reads team information.
-	 */
-	void readTeamInfo();
-
-	/**
-	 * Reads the list of allowed heroes.
-	 */
-	void readAllowedHeroes();
-
-	/**
-	 * Reads the list of disposed heroes.
-	 */
-	void readDisposedHeroes();
-
-	/**
-	 * Reads the list of allowed artifacts.
-	 */
-	void readAllowedArtifacts();
-
-	/**
-	 * Reads the list of allowed spells and abilities.
-	 */
-	void readAllowedSpellsAbilities();
-
-	/**
-	 * Loads artifacts of a hero.
-	 *
-	 * @param hero the hero which should hold those artifacts
-	 */
-	void loadArtifactsOfHero(CGHeroInstance * hero);
-
-	/**
-	 * Loads an artifact to the given slot of the specified hero.
-	 *
-	 * @param hero the hero which should hold that artifact
-	 * @param slot the artifact slot where to place that artifact
-	 * @return true if it loaded an artifact
-	 */
-	bool loadArtifactToSlot(CGHeroInstance * hero, int slot);
-
-	/**
-	 * Creates an artifact instance.
-	 *
-	 * @param aid the id of the artifact
-	 * @param spellID optional. the id of a spell if a spell scroll object should be created
-	 * @return the created artifact instance
-	 */
-	CArtifactInstance * createArtifact(int aid, int spellID = -1);
-
-	/**
-	 * Read rumors.
-	 */
-	void readRumors();
-
-	/**
-	 * Reads predefined heroes.
-	 */
-	void readPredefinedHeroes();
-
-	/**
-	 * Reads terrain data.
-	 */
-	void readTerrain();
-
-	/**
-	 * Reads custom(map) def information.
-	 */
-	void readDefInfo();
-
-	/**
-	 * Reads objects(towns, mines,...).
-	 */
-	void readObjects();
-
-	/**
-	 * Reads a creature set.
-	 *
-	 * @param out the loaded creature set
-	 * @param number the count of creatures to read
-	 * @param version true for > ROE maps
-	 */
-	void readCreatureSet(CCreatureSet * out, int number, bool version);
-
-	/**
-	 * Reads a hero.
-	 *
-	 * @param idToBeGiven the object id which should be set for the hero
-	 * @return a object instance
-	 */
-	CGObjectInstance * readHero(int idToBeGiven);
-
-	/**
-	 * Reads a seer hut.
-	 *
-	 * @return the initialized seer hut object
-	 */
-	CGSeerHut * readSeerHut();
-
-	/**
-	 * Reads a quest for the given quest guard.
-	 *
-	 * @param guard the quest guard where that quest should be applied to
-	 */
-	void readQuest(IQuestObject * guard);
-
-	/**
-	 * Reads a town.
-	 *
-	 * @param castleID the id of the castle type
-	 * @return the loaded town object
-	 */
-	CGTownInstance * readTown(int castleID);
-
-	/**
-	 * Converts buildings to the specified castle id.
-	 *
-	 * @param h3m the ids of the buildings
-	 * @param castleID the castle id
-	 * @param addAuxiliary true if the village hall should be added
-	 * @return the converted buildings
-	 */
-	std::set<si32> convertBuildings(const std::set<si32> h3m, int castleID, bool addAuxiliary = true);
-
-	/**
-	 * Reads events.
-	 */
-	void readEvents();
-
-	/**
-	 * Reverses the input argument.
-	 *
-	 * @param arg the input argument
-	 * @return the reversed 8-bit integer
-	 */
-	ui8 reverse(ui8 arg);
-
-
-
-	/**
-	* Helper to read ui8 from buffer
-	*/
-	inline ui8 readUI8()
-	{
-	   return buffer[pos++];
-	}
-
-	/**
-	* Helper to read si8 from buffer
-	*/
-	inline si8 readSI8()
-	{
-	   return static_cast<si8>(buffer[pos++]);
-	}
-
-	/**
-	* Helper to read ui16 from buffer
-	*/
-	inline ui16 readUI16()
-	{
-		ui16 ret = read_le_u16(buffer+pos);
-		pos +=2;
-		return ret;
-	}
-
-	/**
-	* Helper to read ui32 from buffer
-	*/
-	inline ui32 readUI32()
-	{
-		ui32 ret = read_le_u32(buffer+pos);
-		pos +=4;
-		return ret;
-	}
-
-	/**
-	* Helper to read 8bit flag from buffer
-	*/
-	inline bool readBool()
-	{
-		return readUI8() != 0;
-	}
-
-	/**
-	* Helper to read string from buffer
-	*/
-	inline std::string readString()
-	{
-		return ::readString(buffer,pos);
-	}
-
-	/**
-	* Helper to skip unused data inbuffer
-	*/
-	inline void skip(const int count)
-	{
-		pos += count;
-	}
-
-	inline int3 readInt3()
-	{
-		int3 p;
-		p.x = readUI8();
-		p.y = readUI8();
-		p.z = readUI8();
-		return p;
-	}
-
-	/**
-	 * Init buffer / size.
-	 *
-	 * @param stream the stream which serves as the data input
-	 */
-	void initBuffer(CInputStream * stream);
-
-	/** ptr to the map object which gets filled by data from the buffer */
-	CMap * map;
-
-	/**
-	 * ptr to the map header object which gets filled by data from the buffer.
-	 * (when loading a map then the mapHeader ptr points to the same object)
-	 */
-	std::unique_ptr<CMapHeader> mapHeader;
-
-	/** pointer to the array containing the map data;
-	 * TODO replace with CBinaryReader later (this makes pos & size redundant) */
-	ui8 * buffer;
-
-	/** current buffer reading position */
-	int pos;
-
-	/** size of the map in bytes */
-	int size;
-};

lib/Mapping/MapFormatH3M.h

@@ -0,0 +1,315 @@
+
+/*
+ * MapFormatH3M.h, part of VCMI engine
+ *
+ * Authors: listed in file AUTHORS in main folder
+ *
+ * License: GNU General Public License v2.0 or later
+ * Full text of license available in license.txt file, in main folder
+ *
+ */
+
+#pragma once
+
+#include "CMapService.h"
+
+#include "../vcmi_endian.h"
+#include "../int3.h"
+
+class CGHeroInstance;
+class CArtifactInstance;
+class CGObjectInstance;
+class CGSeerHut;
+class IQuestObject;
+class CGTownInstance;
+class CCreatureSet;
+class CInputStream;
+
+
+class DLL_LINKAGE CMapLoaderH3M : public IMapLoader
+{
+public:
+	/**
+	 * Default constructor.
+	 *
+	 * @param stream a stream containing the map data
+	 */
+	CMapLoaderH3M(CInputStream * stream);
+
+	/**
+	 * Destructor.
+	 */
+	~CMapLoaderH3M();
+
+	/**
+	 * Loads the VCMI/H3 map file.
+	 *
+	 * @return a unique ptr of the loaded map class
+	 */
+	std::unique_ptr<CMap> loadMap();
+
+	/**
+	 * Loads the VCMI/H3 map header.
+	 *
+	 * @return a unique ptr of the loaded map header class
+	 */
+	std::unique_ptr<CMapHeader> loadMapHeader();
+
+	/** true if you want to enable the map loader profiler to see how long a specific part took; default=false */
+	static const bool IS_PROFILING_ENABLED;
+
+private:
+	/**
+	 * Initializes the map object from parsing the input buffer.
+	 */
+	void init();
+
+	/**
+	 * Reads the map header.
+	 */
+	void readHeader();
+
+	/**
+	 * Reads player information.
+	 */
+	void readPlayerInfo();
+
+	/**
+	 * Reads victory/loss conditions.
+	 */
+	void readVictoryLossConditions();
+
+	/**
+	 * Reads team information.
+	 */
+	void readTeamInfo();
+
+	/**
+	 * Reads the list of allowed heroes.
+	 */
+	void readAllowedHeroes();
+
+	/**
+	 * Reads the list of disposed heroes.
+	 */
+	void readDisposedHeroes();
+
+	/**
+	 * Reads the list of allowed artifacts.
+	 */
+	void readAllowedArtifacts();
+
+	/**
+	 * Reads the list of allowed spells and abilities.
+	 */
+	void readAllowedSpellsAbilities();
+
+	/**
+	 * Loads artifacts of a hero.
+	 *
+	 * @param hero the hero which should hold those artifacts
+	 */
+	void loadArtifactsOfHero(CGHeroInstance * hero);
+
+	/**
+	 * Loads an artifact to the given slot of the specified hero.
+	 *
+	 * @param hero the hero which should hold that artifact
+	 * @param slot the artifact slot where to place that artifact
+	 * @return true if it loaded an artifact
+	 */
+	bool loadArtifactToSlot(CGHeroInstance * hero, int slot);
+
+	/**
+	 * Creates an artifact instance.
+	 *
+	 * @param aid the id of the artifact
+	 * @param spellID optional. the id of a spell if a spell scroll object should be created
+	 * @return the created artifact instance
+	 */
+	CArtifactInstance * createArtifact(int aid, int spellID = -1);
+
+	/**
+	 * Read rumors.
+	 */
+	void readRumors();
+
+	/**
+	 * Reads predefined heroes.
+	 */
+	void readPredefinedHeroes();
+
+	/**
+	 * Reads terrain data.
+	 */
+	void readTerrain();
+
+	/**
+	 * Reads custom(map) def information.
+	 */
+	void readDefInfo();
+
+	/**
+	 * Reads objects(towns, mines,...).
+	 */
+	void readObjects();
+
+	/**
+	 * Reads a creature set.
+	 *
+	 * @param out the loaded creature set
+	 * @param number the count of creatures to read
+	 * @param version true for > ROE maps
+	 */
+	void readCreatureSet(CCreatureSet * out, int number, bool version);
+
+	/**
+	 * Reads a hero.
+	 *
+	 * @param idToBeGiven the object id which should be set for the hero
+	 * @return a object instance
+	 */
+	CGObjectInstance * readHero(int idToBeGiven);
+
+	/**
+	 * Reads a seer hut.
+	 *
+	 * @return the initialized seer hut object
+	 */
+	CGSeerHut * readSeerHut();
+
+	/**
+	 * Reads a quest for the given quest guard.
+	 *
+	 * @param guard the quest guard where that quest should be applied to
+	 */
+	void readQuest(IQuestObject * guard);
+
+	/**
+	 * Reads a town.
+	 *
+	 * @param castleID the id of the castle type
+	 * @return the loaded town object
+	 */
+	CGTownInstance * readTown(int castleID);
+
+	/**
+	 * Converts buildings to the specified castle id.
+	 *
+	 * @param h3m the ids of the buildings
+	 * @param castleID the castle id
+	 * @param addAuxiliary true if the village hall should be added
+	 * @return the converted buildings
+	 */
+	std::set<si32> convertBuildings(const std::set<si32> h3m, int castleID, bool addAuxiliary = true);
+
+	/**
+	 * Reads events.
+	 */
+	void readEvents();
+
+	/**
+	 * Reverses the input argument.
+	 *
+	 * @param arg the input argument
+	 * @return the reversed 8-bit integer
+	 */
+	ui8 reverse(ui8 arg);
+
+
+
+	/**
+	* Helper to read ui8 from buffer
+	*/
+	inline ui8 readUI8()
+	{
+	   return buffer[pos++];
+	}
+
+	/**
+	* Helper to read si8 from buffer
+	*/
+	inline si8 readSI8()
+	{
+	   return static_cast<si8>(buffer[pos++]);
+	}
+
+	/**
+	* Helper to read ui16 from buffer
+	*/
+	inline ui16 readUI16()
+	{
+		ui16 ret = read_le_u16(buffer+pos);
+		pos +=2;
+		return ret;
+	}
+
+	/**
+	* Helper to read ui32 from buffer
+	*/
+	inline ui32 readUI32()
+	{
+		ui32 ret = read_le_u32(buffer+pos);
+		pos +=4;
+		return ret;
+	}
+
+	/**
+	* Helper to read 8bit flag from buffer
+	*/
+	inline bool readBool()
+	{
+		return readUI8() != 0;
+	}
+
+	/**
+	* Helper to read string from buffer
+	*/
+	inline std::string readString()
+	{
+		return ::readString(buffer,pos);
+	}
+
+	/**
+	* Helper to skip unused data inbuffer
+	*/
+	inline void skip(const int count)
+	{
+		pos += count;
+	}
+
+	inline int3 readInt3()
+	{
+		int3 p;
+		p.x = readUI8();
+		p.y = readUI8();
+		p.z = readUI8();
+		return p;
+	}
+
+	/**
+	 * Init buffer / size.
+	 *
+	 * @param stream the stream which serves as the data input
+	 */
+	void initBuffer(CInputStream * stream);
+
+	/** ptr to the map object which gets filled by data from the buffer */
+	CMap * map;
+
+	/**
+	 * ptr to the map header object which gets filled by data from the buffer.
+	 * (when loading a map then the mapHeader ptr points to the same object)
+	 */
+	std::unique_ptr<CMapHeader> mapHeader;
+
+	/** pointer to the array containing the map data;
+	 * TODO replace with CBinaryReader later (this makes pos & size redundant) */
+	ui8 * buffer;
+
+	/** current buffer reading position */
+	int pos;
+
+	/** size of the map in bytes */
+	int size;
+};

lib/VCMI_lib.cbp

@@ -151,6 +151,8 @@
 		<Unit filename="Mapping/CMapInfo.h" />
 		<Unit filename="Mapping/CMapService.cpp" />
 		<Unit filename="Mapping/CMapService.h" />
+		<Unit filename="Mapping/MapFormatH3M.cpp" />
+		<Unit filename="Mapping/MapFormatH3M.h" />
 		<Unit filename="NetPacks.h" />
 		<Unit filename="NetPacksLib.cpp" />
 		<Unit filename="RMG/CMapGenOptions.cpp" />