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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
/*
* The Mana Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
*
* This file is part of The Mana 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 RESOURCE_MANAGER_H
#define RESOURCE_MANAGER_H
#include <ctime>
#include <map>
#include <string>
#include <vector>
class Image;
class ImageSet;
class Music;
class Resource;
class SoundEffect;
class SpriteDef;
struct SDL_Surface;
/**
* A class for loading and managing resources.
*/
class ResourceManager
{
friend class Resource;
public:
typedef Resource *(*loader)(void *, unsigned);
typedef Resource *(*generator)(void *);
ResourceManager();
/**
* Destructor. Cleans up remaining resources, warning about resources
* that were still referenced.
*/
~ResourceManager();
/**
* Sets the write directory.
*
* @param path The path of the directory to be added.
* @return <code>true</code> on success, <code>false</code> otherwise.
*/
bool setWriteDir(const std::string &path);
/**
* Adds a directory or archive to the search path. If append is true
* then the directory is added to the end of the search path, otherwise
* it is added at the front.
*
* @return <code>true</code> on success, <code>false</code> otherwise.
*/
bool addToSearchPath(const std::string &path, bool append);
/**
* Searches for zip files and adds them to the search path.
*/
void searchAndAddArchives(const std::string &path,
const std::string &ext,
bool append);
/**
* Creates a directory in the write path
*/
bool mkdir(const std::string &path);
/**
* Checks whether the given file or directory exists in the search path
*/
bool exists(const std::string &path);
/**
* Checks whether the given path is a directory.
*/
bool isDirectory(const std::string &path);
/**
* Returns the real path to a file. Note that this method will always
* return a path, it does not check whether the file exists.
*
* @param file The file to get the real path to.
* @return The real path.
*/
std::string getPath(const std::string &file);
/**
* Creates a resource and adds it to the resource map.
*
* @param idPath The resource identifier path.
* @param fun A function for generating the resource.
* @param data Extra parameters for the generator.
* @return A valid resource or <code>NULL</code> if the resource could
* not be generated.
*/
Resource *get(const std::string &idPath, generator fun, void *data);
/**
* Loads a resource from a file and adds it to the resource map.
*
* @param path The file name.
* @param fun A function for parsing the file.
* @return A valid resource or <code>NULL</code> if the resource could
* not be loaded.
*/
Resource *load(const std::string &path, loader fun);
/**
* Adds a preformatted resource to the resource map.
*
* @param path The file name.
* @param Resource The Resource to add.
* @return true if successfull, false otherwise.
*/
bool addResource(const std::string &idPath, Resource* resource);
/**
* Copies a file from one place to another (useful for extracting
* raw files from a zip archive, for example)
*
* @param src Source file name
* @param dst Destination file name
* @return true on success, false on failure. An error message should be
* in the log file.
*/
bool copyFile(const std::string &src, const std::string &dst);
/**
* Convenience wrapper around ResourceManager::get for loading
* images.
*/
Image *getImage(const std::string &idPath);
/**
* Convenience wrapper around ResourceManager::get for loading
* songs.
*/
Music *getMusic(const std::string &idPath);
/**
* Convenience wrapper around ResourceManager::get for loading
* samples.
*/
SoundEffect *getSoundEffect(const std::string &idPath);
/**
* Creates a image set based on the image referenced by the given
* path and the supplied sprite sizes
*/
ImageSet *getImageSet(const std::string &imagePath, int w, int h);
/**
* Creates a sprite definition based on a given path and the supplied
* variant.
*/
SpriteDef *getSprite(const std::string &path, int variant = 0);
/**
* Releases a resource, placing it in the set of orphaned resources.
*/
void release(Resource *);
/**
* Allocates data into a buffer pointer for raw data loading. The
* returned data is expected to be freed using <code>free()</code>.
*
* @param fileName The name of the file to be loaded.
* @param fileSize The size of the file that was loaded.
*
* @return An allocated byte array containing the data that was loaded,
* or <code>NULL</code> on fail.
*/
void *loadFile(const std::string &fileName, int &fileSize);
/**
* Retrieves the contents of a text file.
*/
std::vector<std::string> loadTextFile(const std::string &fileName);
/**
* Loads the given filename as an SDL surface. The returned surface is
* expected to be freed by the caller using SDL_FreeSurface.
*/
SDL_Surface *loadSDLSurface(const std::string &filename);
/**
* Returns an instance of the class, creating one if it does not
* already exist.
*/
static ResourceManager *getInstance();
/**
* Deletes the class instance if it exists.
*/
static void deleteInstance();
private:
/**
* Deletes the resource after logging a cleanup message.
*/
static void cleanUp(Resource *resource);
void cleanOrphans();
static ResourceManager *instance;
typedef std::map<std::string, Resource*> Resources;
typedef Resources::iterator ResourceIterator;
Resources mResources;
Resources mOrphanedResources;
time_t mOldestOrphan;
};
#endif
|
