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
|
/*
* The Mana Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2012 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/>.
*/
#pragma once
#include "resources/resource.h"
#include <ctime>
#include <functional>
#include <map>
#include <string>
class Image;
class ImageSet;
class Music;
class SoundEffect;
class SpriteDef;
/**
* A class for loading and managing resources.
*/
class ResourceManager
{
friend class Resource;
public:
ResourceManager();
/**
* Destructor. Cleans up remaining resources, warning about resources
* that were still referenced.
*/
~ResourceManager();
/**
* 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.
*/
static bool addToSearchPath(const std::string &path, bool append);
/**
* Searches for zip files and adds them to the search path.
*/
static void searchAndAddArchives(const std::string &path,
const std::string &ext,
bool append);
/**
* 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.
*/
static std::string getPath(const std::string &file);
/**
* Loads the Image resource found at the given identifier path. The
* path can include a dye specification after a '|' character.
*/
ResourceRef<Image> getImage(const std::string &idPath);
/**
* Loads the Music resource found at the given path.
*/
ResourceRef<Music> getMusic(const std::string &path);
/**
* Loads the SoundEffect resource found at the given path.
*/
ResourceRef<SoundEffect> getSoundEffect(const std::string &path);
/**
* Loads a image set based on the image referenced by the given path
* and the supplied sprite sizes.
*/
ResourceRef<ImageSet> getImageSet(const std::string &imagePath, int w, int h);
/**
* Loads a SpriteDef based on a given path and the supplied variant.
*/
ResourceRef<SpriteDef> getSprite(const std::string &path, int variant = 0);
/**
* 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:
/**
* Looks up a resource, creating it with the generator function if it
* does not exist. Does not increment the reference count of the
* resource.
*
* @param idPath The resource identifier path.
* @param generator A function for generating the resource.
* @return A valid resource or <code>nullptr</code> if the resource could
* not be generated.
*/
Resource *get(const std::string &idPath,
const std::function<Resource *()> &generator);
/**
* Releases a resource, placing it in the set of orphaned resources.
* Only called from Resource::decRef,
*/
void release(Resource *);
/**
* Removes a resource from the list of resources managed by the
* resource manager. Only called from Resource::decRef,
*/
void remove(Resource *);
/**
* Deletes the resource after logging a cleanup message.
*/
static void cleanUp(Resource *resource);
void cleanOrphans();
static ResourceManager *instance;
std::map<std::string, Resource *> mResources;
std::map<std::string, Resource *> mOrphanedResources;
time_t mOldestOrphan = 0;
};
|
