File: maploader.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (152 lines) | stat: -rw-r--r-- 3,513 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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