Initial commit

engines/ultima/ultima4/map/maploader.h

@@ -0,0 +1,152 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * 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, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; 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, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef ULTIMA4_MAP_MAPLOADER_H
+#define ULTIMA4_MAP_MAPLOADER_H
+
+#include "ultima/ultima4/map/map.h"
+#include "ultima/shared/std/containers.h"
+
+namespace Common {
+class SeekableReadStream;
+}
+
+namespace Ultima {
+namespace Ultima4 {
+
+class U4FILE;
+class Dungeon;
+
+struct MapType_Hash {
+	uint operator()(const Map::Type &v) const {
+		return (uint)v;
+	}
+};
+
+
+/**
+ * The generic map loader interface.  Map loaders should override the
+ * load method to load a map from the meta data already initialized in
+ * the map object passed in. They must also register themselves with
+ * registerLoader for one or more Map::Types.
+ *
+ * @todo
+ * <ul>
+ *      <li>
+ *          Instead of loading dungeon room data into a u4dos-style structure and converting it to
+ *          an xu4 Map when it's needed, convert it to an xu4 Map immediately upon loading it.
+ *      </li>
+ * </ul>
+ */
+class MapLoader {
+public:
+	virtual ~MapLoader() {}
+
+	virtual bool load(Map *map) = 0;
+
+protected:
+	/**
+	 * Registers a loader for the given map type.
+	 */
+	static MapLoader *registerLoader(MapLoader *loader, Map::Type type);
+
+	/**
+	 * Loads raw data from the given file.
+	 */
+	static bool loadData(Map *map, Common::SeekableReadStream &f);
+	static bool isChunkCompressed(Map *map, int chunk);
+
+private:
+	static Common::HashMap<Map::Type, MapLoader *, MapType_Hash> *loaderMap;
+};
+
+class CityMapLoader : public MapLoader {
+public:
+	/**
+	 * Load city data from 'ult' and 'tlk' files.
+	 */
+	virtual bool load(Map *map);
+};
+
+class ConMapLoader : public MapLoader {
+public:
+	/**
+	 * Loads a combat map from the 'con' file
+	 */
+	bool load(Map *map) override;
+};
+
+class DngMapLoader : public MapLoader {
+public:
+	/**
+	 * Loads a dungeon map from the 'dng' file
+	 */
+	bool load(Map *map) override;
+
+private:
+	/**
+	 * Loads a dungeon room into map->dungeon->room
+	 */
+	void initDungeonRoom(Dungeon *dng, int room);
+};
+
+class WorldMapLoader : public MapLoader {
+public:
+	/**
+	 * Loads the world map data in from the 'world' file.
+	 */
+	bool load(Map *map) override;
+};
+
+class XMLMapLoader : public MapLoader {
+private:
+	void split(const Common::String &text, Common::StringArray &values, char c);
+public:
+	/**
+	 * Loads the data for the map from the provided Xml
+	 */
+	bool load(Map *map) override;
+};
+
+class MapLoaders : public Common::HashMap<Map::Type, MapLoader *, MapType_Hash> {
+public:
+	/**
+	 * Constructor
+	 */
+	MapLoaders();
+
+	/**
+	 * Destructor
+	 */
+	~MapLoaders();
+
+	/**
+	 * Gets a map loader for the given map type.
+	 */
+	MapLoader *getLoader(Map::Type type);
+};
+
+extern MapLoaders *g_mapLoaders;
+
+} // End of namespace Ultima4
+} // End of namespace Ultima
+
+#endif