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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* 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 SHERLOCK_RESOURCES_H
#define SHERLOCK_RESOURCES_H
#include "common/array.h"
#include "common/file.h"
#include "common/hashmap.h"
#include "common/hash-str.h"
#include "common/rect.h"
#include "common/str.h"
#include "common/str-array.h"
#include "common/stream.h"
#include "graphics/surface.h"
namespace Sherlock {
typedef Common::Array<byte> CacheEntry;
typedef Common::HashMap<Common::String, CacheEntry, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> CacheHash;
struct LibraryEntry {
uint32 _offset, _size;
int _index;
LibraryEntry() : _index(0), _offset(0), _size(0) {}
LibraryEntry(int index, uint32 offset, uint32 size) :
_index(index), _offset(offset), _size(size) {}
};
typedef Common::HashMap<Common::String, LibraryEntry, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> LibraryIndex;
typedef Common::HashMap<Common::String, LibraryIndex, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> LibraryIndexes;
class SherlockEngine;
class Cache {
private:
SherlockEngine *_vm;
CacheHash _resources;
public:
Cache(SherlockEngine *_vm);
/**
* Returns true if a given file is currently being cached
*/
bool isCached(const Common::String &filename) const;
/**
* Loads a file into the cache if it's not already present, and returns it.
* If the file is LZW compressed, automatically decompresses it and loads
* the uncompressed version into memory
*/
void load(const Common::String &name);
/**
* Load a cache entry based on a passed stream
*/
void load(const Common::String &name, Common::SeekableReadStream &stream);
/**
* Get a file from the cache
*/
Common::SeekableReadStream *get(const Common::String &filename) const;
};
class Resources {
private:
SherlockEngine *_vm;
Cache _cache;
LibraryIndexes _indexes;
int _resourceIndex;
/**
* Reads in the index from a library file, and caches its index for later use
*/
void loadLibraryIndex(const Common::String &libFilename, Common::SeekableReadStream *stream, bool isNewStyle);
public:
Resources(SherlockEngine *vm);
/**
* Adds the specified file to the cache. If it's a library file, takes care of
* loading its index for future use
*/
void addToCache(const Common::String &filename);
/**
* Adds a resource from a library file to the cache
*/
void addToCache(const Common::String &filename, const Common::String &libFilename);
/**
* Adds a given stream to the cache under the given name
*/
void addToCache(const Common::String &filename, Common::SeekableReadStream &stream);
bool isInCache(const Common::String &filename) const { return _cache.isCached(filename); }
/**
* Checks the passed stream, and if is compressed, deletes it and replaces it with its uncompressed data
*/
void decompressIfNecessary(Common::SeekableReadStream *&stream);
/**
* Returns a stream for a given file
*/
Common::SeekableReadStream *load(const Common::String &filename);
/**
* Loads a specific resource from a given library file
*/
Common::SeekableReadStream *load(const Common::String &filename, const Common::String &libraryFile, bool suppressErrors = false);
/**
* Returns true if the given file exists on disk or in the cache
*/
bool exists(const Common::String &filename) const;
/**
* Returns the index of the last loaded resource in its given library file.
* This will be used primarily when loading talk files, so the engine can
* update the given conversation number in the journal
*/
int resourceIndex() const;
/**
* Produces a list of all resource names within a file. Used by the debugger.
*/
void getResourceNames(const Common::String &libraryFile, Common::StringArray &names);
/**
* Decompresses LZW compressed data
*/
Common::SeekableReadStream *decompress(Common::SeekableReadStream &source);
/**
* Decompresses LZW compressed data
*/
Common::SeekableReadStream *decompress(Common::SeekableReadStream &source, uint32 outSize);
/**
* Decompresses LZW compressed data
*/
void decompress(Common::SeekableReadStream &source, byte *buffer, uint32 outSize);
/**
* Decompresses LZW compressed data
*/
static Common::SeekableReadStream *decompressLZ(Common::SeekableReadStream &source, uint32 outSize);
/**
* Decompresses LZW compressed data
*/
static void decompressLZ(Common::SeekableReadStream &source, byte *outBuffer, int32 outSize, int32 inSize);
};
} // End of namespace Sherlock
#endif
|
