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
|
/*
* The Mana World
* Copyright 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* The Mana World 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.
*
* The Mana World 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 The Mana World; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* $Id$
*/
#ifndef _TMW_RESOURCE_MANAGER_H
#define _TMW_RESOURCE_MANAGER_H
#include <map>
#include <string>
#include "resource.h"
#include "image.h"
#include "music.h"
#include "soundeffect.h"
/**
* A resource entry descriptor.
*/
struct ResourceEntry
{
ResourceEntry();
Resource *resource;
std::string filePath;
};
/**
* A class for loading and managing resources.
*/
class ResourceManager
{
public:
/**
* An enumeration of resource types.
*/
enum E_RESOURCE_TYPE
{
MAP,
MUSIC,
IMAGE,
SCRIPT,
TILESET,
SOUND_EFFECT
};
/**
* Constructor.
*/
ResourceManager();
/**
* Destructor.
*/
~ResourceManager();
/**
* Creates a resource and adds it to the resource map. The idPath is
* converted into the appropriate path for the current operating system
* and the resource is loaded.
*
* @param type The type of resource to load.
* @param idPath The resource identifier path.
* @param flags Flags to control the loading of certain resources.
* @return A valid resource or <code>NULL</code> if the resource could
* not be loaded.
*/
Resource *get(
const E_RESOURCE_TYPE &type,
const std::string &idPath,
int flags = 0);
/**
* Convenience wrapper around ResourceManager::create for loading
* images.
*/
Image *getImage(const std::string &idPath, int flags = 0);
/**
* Convenience wrapper around ResourceManager::create for loading
* songs.
*/
Music *getMusic(const std::string &idPath);
/**
* Convenience wrapper around ResourceManager::create for loading
* samples.
*/
SoundEffect *getSoundEffect(const std::string &idPath);
/**
* 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);
/**
* 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:
/**
* Searches for zip files and adds them to the PhysicsFS search path.
*/
void searchAndAddZipFiles();
static ResourceManager *instance;
std::map<std::string, ResourceEntry> resources;
};
#endif
|
