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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
|
/* 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 SCI_UTIL_H
#define SCI_UTIL_H
#include "common/span.h"
#include "common/endian.h"
#include "common/file.h"
#include "common/memstream.h"
#include "common/scummsys.h"
#include "common/str.h"
#include "common/textconsole.h"
namespace Sci {
// Wrappers for reading/writing 16-bit values in the endianness
// of the original game platform.
uint16 READ_SCIENDIAN_UINT16(const void *ptr);
void WRITE_SCIENDIAN_UINT16(void *ptr, uint16 val);
// Wrappers for reading integer values for SCI1.1+.
// Mac versions have big endian data for some fields.
uint16 READ_SCI11ENDIAN_UINT16(const void *ptr);
uint32 READ_SCI11ENDIAN_UINT32(const void *ptr);
void WRITE_SCI11ENDIAN_UINT16(void *ptr, uint16 val);
#ifdef ENABLE_SCI32
void WRITE_SCI11ENDIAN_UINT32(void *ptr, uint32 val);
#endif
// Wrappers for reading integer values in resources that are
// LE in SCI1.1 Mac, but BE in SCI32 Mac
uint16 READ_SCI32ENDIAN_UINT16(const void *ptr);
#pragma mark -
#pragma mark SciSpanImpl - SciSpanIterator
namespace SciSpanInternal {
template <typename Span, bool IsConst>
class SciSpanIterator : public Common::SpanInternal::SpanIterator<Span, IsConst> {
typedef typename Common::SpanInternal::SpanIterator<Span, IsConst> super_type;
typedef typename Span::value_type span_value_type;
typedef typename Common::Conditional<IsConst, const Span, Span>::type span_type;
public:
typedef typename Span::difference_type difference_type;
typedef typename Common::RemoveConst<span_value_type>::type value_type;
typedef typename Common::Conditional<IsConst, const span_value_type, span_value_type>::type *pointer;
typedef typename Common::Conditional<IsConst, const span_value_type, span_value_type>::type &reference;
inline SciSpanIterator() : super_type() {}
inline SciSpanIterator(span_type *span, const difference_type index) : super_type(span, index) {}
inline SciSpanIterator(const SciSpanIterator &other) : super_type(other) {}
inline SciSpanIterator &operator=(const SciSpanIterator &other) {
super_type::operator=(other);
return *this;
}
inline SciSpanIterator operator+(const difference_type delta) const {
SciSpanIterator it(*this);
it += delta;
return it;
}
inline SciSpanIterator operator-(const difference_type delta) const {
return operator+(-delta);
}
inline difference_type operator-(const SciSpanIterator &other) const {
assert(this->_span == other._span);
return this->_index - other._index;
}
inline int16 getInt16SE() const {
return this->_span->getInt16SEAt(this->_index);
}
inline uint16 getUint16SE() const {
return this->_span->getUint16SEAt(this->_index);
}
inline uint16 getUint16SE32() const {
return this->_span->getUint16SE32At(this->_index);
}
inline int32 getInt32SE() const {
return this->_span->getInt32SEAt(this->_index);
}
inline uint32 getUint32SE() const {
return this->_span->getUint32SEAt(this->_index);
}
inline void setUint16SE(uint16 value) const {
this->_span->setUint16SEAt(this->_index, value);
}
#ifdef ENABLE_SCI32
inline void setUint32SE(uint32 value) const {
this->_span->setUint32SEAt(this->_index, value);
}
#endif
};
} // End of namespace SciSpanInternal
/**
* Bounds-checked random access into a contiguous block of memory, with
* extra methods that automatically read and write using the correct endianness
* for the currently loaded game.
*/
template <typename ValueType, template <typename> class Derived>
class SciSpanImpl : public Common::NamedSpanImpl<ValueType, Derived> {
typedef Common::NamedSpanImpl<ValueType, Derived> super_type;
typedef Derived<ValueType> derived_type;
typedef typename Common::AddConst<Derived<ValueType> >::type const_derived_type;
typedef typename Common::RemoveConst<Derived<ValueType> >::type mutable_derived_type;
#if !defined(__GNUC__) || GCC_ATLEAST(3, 0)
template <typename T, template <typename> class U> friend class SciSpanImpl;
#endif
#if CXXTEST_RUNNING
friend class ::SpanTestSuite;
#endif
public:
typedef typename super_type::value_type value_type;
typedef typename super_type::difference_type difference_type;
typedef typename super_type::index_type index_type;
typedef typename super_type::size_type size_type;
typedef SciSpanInternal::SciSpanIterator<derived_type, true> const_iterator;
typedef SciSpanInternal::SciSpanIterator<derived_type, false> iterator;
typedef typename super_type::pointer pointer;
typedef typename super_type::const_pointer const_pointer;
typedef typename super_type::reference reference;
typedef typename super_type::const_reference const_reference;
inline SciSpanImpl() : super_type() {}
inline SciSpanImpl(const pointer data_,
const size_type size_,
const Common::String &name = Common::String(),
const size_type sourceByteOffset = 0) :
super_type(data_, size_, name, sourceByteOffset) {}
template <typename Other>
inline SciSpanImpl(const Other &other) :
super_type(other) {}
template <typename Other>
inline mutable_derived_type &operator=(const Other &other) {
super_type::operator=(other);
return this->impl();
}
inline ~SciSpanImpl() {}
inline const_iterator cbegin() const { return const_iterator(&this->impl(), 0); }
inline const_iterator cend() const { return const_iterator(&this->impl(), this->size()); }
inline const_iterator begin() const { return const_iterator(&this->impl(), 0); }
inline const_iterator end() const { return const_iterator(&this->impl(), this->size()); }
inline iterator begin() { return iterator(&this->impl(), 0); }
inline iterator end() { return iterator(&this->impl(), this->size()); }
#pragma mark -
#pragma mark SciSpan - Data access
public:
inline int16 getInt16SEAt(const size_type index) const {
return (int16)getUint16SEAt(index);
}
inline uint16 getUint16SEAt(const size_type index) const {
this->validate(index, sizeof(uint16));
return READ_SCI11ENDIAN_UINT16(this->data() + index);
}
inline uint16 getUint16SE32At(const size_type index) const {
this->validate(index, sizeof(uint16));
return READ_SCI32ENDIAN_UINT16(this->data() + index);
}
inline int32 getInt32SEAt(const size_type index) const {
return (int32)getUint32SEAt(index);
}
inline uint32 getUint32SEAt(const size_type index) const {
this->validate(index, sizeof(uint32));
return READ_SCI11ENDIAN_UINT32(this->data() + index);
}
inline void setUint16SEAt(const size_type index, uint16 value) {
this->validate(index, sizeof(uint16), Common::kValidateWrite);
WRITE_SCI11ENDIAN_UINT16(this->data() + index, value);
}
#ifdef ENABLE_SCI32
inline void setUint32SEAt(const size_type index, uint32 value) {
this->validate(index, sizeof(uint32), Common::kValidateWrite);
WRITE_SCI11ENDIAN_UINT32(this->data() + index, value);
}
#endif
#pragma mark -
#pragma mark SciSpanImpl - ForwardIterator
// Spans that are used as ForwardIterators must not be allowed inside of
// SpanOwner, since this will result in the wrong pointer to memory to be
// deleted
public:
inline const_reference operator*() const {
this->validate(0, sizeof(value_type));
return *this->_data;
}
inline reference operator*() {
this->validate(0, sizeof(value_type));
return *this->_data;
}
inline mutable_derived_type &operator+=(const difference_type delta) {
this->validate(0, delta * sizeof(value_type), Common::kValidateSeek);
this->_data += delta;
this->_size -= delta;
return this->impl();
}
inline mutable_derived_type &operator++() {
return operator+=(1);
}
inline mutable_derived_type operator++(int) {
mutable_derived_type span(this->impl());
operator+=(1);
return span;
}
inline mutable_derived_type operator+(const difference_type delta) const {
mutable_derived_type span(this->impl());
span += delta;
return span;
}
};
template <typename ValueType>
class SciSpan : public SciSpanImpl<ValueType, SciSpan> {
typedef SciSpanImpl<ValueType, ::Sci::SciSpan> super_type;
typedef typename Common::AddConst<SciSpan<ValueType> >::type const_derived_type;
typedef typename Common::RemoveConst<SciSpan<ValueType> >::type mutable_derived_type;
public:
typedef typename super_type::value_type value_type;
typedef typename super_type::difference_type difference_type;
typedef typename super_type::index_type index_type;
typedef typename super_type::size_type size_type;
typedef typename super_type::const_iterator const_iterator;
typedef typename super_type::iterator iterator;
typedef typename super_type::pointer pointer;
typedef typename super_type::const_pointer const_pointer;
typedef typename super_type::reference reference;
typedef typename super_type::const_reference const_reference;
inline SciSpan() : super_type() {}
inline SciSpan(const pointer data_,
const size_type size_,
const Common::String &name = Common::String(),
const size_type sourceByteOffset = 0) :
super_type(data_, size_, name, sourceByteOffset) {}
template <typename Other>
inline SciSpan(const Other &other) : super_type(other) {}
template <typename Other>
inline mutable_derived_type &operator=(const Other &other) {
super_type::operator=(other);
return this->impl();
}
~SciSpan() {}
};
} // End of namespace Sci
#endif
|