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
|
/*
* The ManaPlus Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2020 The ManaPlus Developers
* Copyright (C) 2020-2023 The ManaVerse Developers
*
* This file is part of The ManaPlus Client.
*
* 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 2 of the License, or
* 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 RESOURCES_MAPREADER_H
#define RESOURCES_MAPREADER_H
#include "enums/resources/map/maplayertype.h"
#include "utils/xml.h"
class Map;
class MapHeights;
class MapLayer;
class Properties;
class Resource;
class Tileset;
/**
* Reader for XML map files (*.tmx)
*/
class MapReader final
{
public:
A_DELETE_COPY(MapReader)
/**
* Read an XML map from a file.
*/
static Map *readMap(const std::string &restrict filename,
const std::string &restrict realFilename)
A_WARN_UNUSED;
/**
* Read an XML map from a parsed XML tree. The path is used to find the
* location of referenced tileset images.
*/
static Map *readMap(XmlNodePtrConst node,
const std::string &path) A_WARN_UNUSED;
static Map *createEmptyMap(const std::string &restrict filename,
const std::string &restrict realFilename)
A_WARN_UNUSED;
/**
* Reads a map layer and adds it to the given map.
*/
static void readLayer(XmlNodeConstPtr node,
Map *const map) A_NONNULL(2);
#ifdef USE_OPENGL
static void loadEmptyAtlas();
static void unloadEmptyAtlas();
#endif // USE_OPENGL
private:
/**
* Reads the properties element.
*
* @param node The <code>properties</code> element.
* @param props The Properties instance to which the properties will
* be assigned.
*/
static void readProperties(XmlNodeConstPtrConst node,
Properties *const props) A_NONNULL(2);
static bool readBase64Layer(XmlNodeConstPtrConst childNode,
Map *const map,
MapLayer *const layer,
const MapLayerTypeT &layerType,
MapHeights *const heights,
const std::string &compression,
int &restrict x, int &restrict y,
const int w, const int h) A_NONNULL(2);
static bool readCsvLayer(XmlNodeConstPtrConst childNode,
Map *const map,
MapLayer *const layer,
const MapLayerTypeT &layerType,
MapHeights *const heights,
int &restrict x, int &restrict y,
const int w, const int h) A_NONNULL(2);
/**
* Reads a tile set.
*/
static Tileset *readTileset(XmlNodePtr node,
const std::string &path,
Map *const map) A_WARN_UNUSED A_NONNULL(3);
static void updateMusic(Map *const map) A_NONNULL(1);
static void addLayerToList(const std::string &fileName,
const SkipError skipError);
static void loadLayers(const std::string &path);
static void unloadTempLayers();
#ifdef USE_OPENGL
static Resource *mEmptyAtlas;
#endif // USE_OPENGL
};
#endif // RESOURCES_MAPREADER_H
|