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
|
/* ResidualVM - A 3D game interpreter
*
* ResidualVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the AUTHORS
* 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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef STARK_SERVICES_ARCHIVE_LOADER_H
#define STARK_SERVICES_ARCHIVE_LOADER_H
#include "common/list.h"
#include "common/str.h"
#include "common/substream.h"
#include "common/util.h"
#include "math/quat.h"
#include "math/vector3d.h"
#include "engines/stark/formats/xarc.h"
#include "engines/stark/resources/object.h"
namespace Stark {
namespace Resources {
class Level;
class Location;
}
/**
* A read stream with helper functions to read usual data types
*/
class ArchiveReadStream : public Common::SeekableSubReadStream {
public:
ArchiveReadStream(Common::SeekableReadStream *parentStream, DisposeAfterUse::Flag disposeParentStream = DisposeAfterUse::YES);
virtual ~ArchiveReadStream();
Common::String readString();
Common::String readString16();
Math::Vector3d readVector3();
Math::Quaternion readQuaternion();
float readFloat();
};
/**
* XARC Archive loader.
*
* Maintains a list of opened archive files.
* Loads the resources from the XRC tree.
*/
class ArchiveLoader {
public:
~ArchiveLoader();
/** Load a Xarc archive, and add it to the managed archives list */
bool load(const Common::String &archiveName);
/** Unload all the unused Xarc archives */
void unloadUnused();
/** Retrieve a file from a specified archive */
ArchiveReadStream *getFile(const Common::String &fileName, const Common::String &archiveName);
/** Get the resource tree root for an archive, and increment the archive use count */
template <class T>
T *useRoot(const Common::String &archiveName);
/** Decrement the root's archive use count */
bool returnRoot(const Common::String &archiveName);
/** Build the archive filename for a level or a location */
Common::String buildArchiveName(Resources::Level *level, Resources::Location *location = nullptr);
/** Retrieve a file relative to a specified archive */
Common::SeekableReadStream *getExternalFile(const Common::String &fileName, const Common::String &archiveName);
private:
class LoadedArchive {
public:
LoadedArchive(const Common::String &archiveName);
~LoadedArchive();
Common::String &getFilename() { return _filename; }
Formats::XARCArchive &getXArc() { return _xarc; }
Resources::Object *getRoot() { return _root; }
void importResources();
bool isInUse() { return _useCount > 0; }
void incUsage() { _useCount++; }
void decUsage() { _useCount = MAX<int>(_useCount - 1, 0); }
private:
uint _useCount;
Common::String _filename;
Formats::XARCArchive _xarc;
Resources::Object *_root;
};
typedef Common::List<LoadedArchive *> LoadedArchiveList;
bool hasArchive(const Common::String &archiveName);
LoadedArchive *findArchive(const Common::String &archiveName);
LoadedArchiveList _archives;
};
template <class T>
T *ArchiveLoader::useRoot(const Common::String &archiveName) {
LoadedArchive *archive = findArchive(archiveName);
archive->incUsage();
return Resources::Object::cast<T>(archive->getRoot());
}
} // End of namespace Stark
#endif // STARK_SERVICES_ARCHIVE_LOADER_H
|
