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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
|
/**
* @file lldatapacker.h
* @brief Data packer declaration for tightly storing binary data.
*
* $LicenseInfo:firstyear=2002&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, Linden Research, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License only.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
* $/LicenseInfo$
*/
#ifndef LL_LLDATAPACKER_H
#define LL_LLDATAPACKER_H
class LLColor4;
class LLColor4U;
class LLVector2;
class LLVector3;
class LLVector4;
class LLUUID;
class LLDataPacker
{
public:
virtual ~LLDataPacker() {}
// Not required to override, but error to call?
virtual void reset();
virtual void dumpBufferToLog();
virtual BOOL hasNext() const = 0;
virtual BOOL packString(const std::string& value, const char *name) = 0;
virtual BOOL unpackString(std::string& value, const char *name) = 0;
virtual BOOL packBinaryData(const U8 *value, S32 size, const char *name) = 0;
virtual BOOL unpackBinaryData(U8 *value, S32 &size, const char *name) = 0;
// Constant size binary data packing
virtual BOOL packBinaryDataFixed(const U8 *value, S32 size, const char *name) = 0;
virtual BOOL unpackBinaryDataFixed(U8 *value, S32 size, const char *name) = 0;
virtual BOOL packU8(const U8 value, const char *name) = 0;
virtual BOOL unpackU8(U8 &value, const char *name) = 0;
virtual BOOL packU16(const U16 value, const char *name) = 0;
virtual BOOL unpackU16(U16 &value, const char *name) = 0;
BOOL unpackU16s(U16 *value, S32 count, const char *name);
virtual BOOL packS16(const S16 value, const char *name) = 0;
virtual BOOL unpackS16(S16 &value, const char *name) = 0;
BOOL unpackS16s(S16 *value, S32 count, const char *name);
virtual BOOL packU32(const U32 value, const char *name) = 0;
virtual BOOL unpackU32(U32 &value, const char *name) = 0;
virtual BOOL packS32(const S32 value, const char *name) = 0;
virtual BOOL unpackS32(S32 &value, const char *name) = 0;
virtual BOOL packF32(const F32 value, const char *name) = 0;
virtual BOOL unpackF32(F32 &value, const char *name) = 0;
BOOL unpackF32s(F32 *values, S32 count, const char *name);
// Packs a float into an integer, using the given size
// and picks the right U* data type to pack into.
BOOL packFixed(const F32 value, const char *name,
const BOOL is_signed, const U32 int_bits, const U32 frac_bits);
BOOL unpackFixed(F32 &value, const char *name,
const BOOL is_signed, const U32 int_bits, const U32 frac_bits);
virtual BOOL packColor4(const LLColor4 &value, const char *name) = 0;
virtual BOOL unpackColor4(LLColor4 &value, const char *name) = 0;
virtual BOOL packColor4U(const LLColor4U &value, const char *name) = 0;
virtual BOOL unpackColor4U(LLColor4U &value, const char *name) = 0;
BOOL unpackColor4Us(LLColor4U *values, S32 count, const char *name);
virtual BOOL packVector2(const LLVector2 &value, const char *name) = 0;
virtual BOOL unpackVector2(LLVector2 &value, const char *name) = 0;
virtual BOOL packVector3(const LLVector3 &value, const char *name) = 0;
virtual BOOL unpackVector3(LLVector3 &value, const char *name) = 0;
virtual BOOL packVector4(const LLVector4 &value, const char *name) = 0;
virtual BOOL unpackVector4(LLVector4 &value, const char *name) = 0;
virtual BOOL packUUID(const LLUUID &value, const char *name) = 0;
virtual BOOL unpackUUID(LLUUID &value, const char *name) = 0;
BOOL unpackUUIDs(LLUUID *values, S32 count, const char *name);
U32 getPassFlags() const { return mPassFlags; }
void setPassFlags(U32 flags) { mPassFlags = flags; }
protected:
LLDataPacker();
protected:
U32 mPassFlags;
BOOL mWriteEnabled; // disable this to do things like determine filesize without actually copying data
};
class LLDataPackerBinaryBuffer : public LLDataPacker
{
public:
LLDataPackerBinaryBuffer(U8 *bufferp, S32 size)
: LLDataPacker(),
mBufferp(bufferp),
mCurBufferp(bufferp),
mBufferSize(size)
{
mWriteEnabled = TRUE;
}
LLDataPackerBinaryBuffer()
: LLDataPacker(),
mBufferp(NULL),
mCurBufferp(NULL),
mBufferSize(0)
{
}
/*virtual*/ BOOL packString(const std::string& value, const char *name);
/*virtual*/ BOOL unpackString(std::string& value, const char *name);
/*virtual*/ BOOL packBinaryData(const U8 *value, S32 size, const char *name);
/*virtual*/ BOOL unpackBinaryData(U8 *value, S32 &size, const char *name);
// Constant size binary data packing
/*virtual*/ BOOL packBinaryDataFixed(const U8 *value, S32 size, const char *name);
/*virtual*/ BOOL unpackBinaryDataFixed(U8 *value, S32 size, const char *name);
/*virtual*/ BOOL packU8(const U8 value, const char *name);
/*virtual*/ BOOL unpackU8(U8 &value, const char *name);
/*virtual*/ BOOL packU16(const U16 value, const char *name);
/*virtual*/ BOOL unpackU16(U16 &value, const char *name);
/*virtual*/ BOOL packS16(const S16 value, const char *name);
/*virtual*/ BOOL unpackS16(S16 &value, const char *name);
/*virtual*/ BOOL packU32(const U32 value, const char *name);
/*virtual*/ BOOL unpackU32(U32 &value, const char *name);
/*virtual*/ BOOL packS32(const S32 value, const char *name);
/*virtual*/ BOOL unpackS32(S32 &value, const char *name);
/*virtual*/ BOOL packF32(const F32 value, const char *name);
/*virtual*/ BOOL unpackF32(F32 &value, const char *name);
/*virtual*/ BOOL packColor4(const LLColor4 &value, const char *name);
/*virtual*/ BOOL unpackColor4(LLColor4 &value, const char *name);
/*virtual*/ BOOL packColor4U(const LLColor4U &value, const char *name);
/*virtual*/ BOOL unpackColor4U(LLColor4U &value, const char *name);
/*virtual*/ BOOL packVector2(const LLVector2 &value, const char *name);
/*virtual*/ BOOL unpackVector2(LLVector2 &value, const char *name);
/*virtual*/ BOOL packVector3(const LLVector3 &value, const char *name);
/*virtual*/ BOOL unpackVector3(LLVector3 &value, const char *name);
/*virtual*/ BOOL packVector4(const LLVector4 &value, const char *name);
/*virtual*/ BOOL unpackVector4(LLVector4 &value, const char *name);
/*virtual*/ BOOL packUUID(const LLUUID &value, const char *name);
/*virtual*/ BOOL unpackUUID(LLUUID &value, const char *name);
S32 getCurrentSize() const { return (S32)(mCurBufferp - mBufferp); }
S32 getBufferSize() const { return mBufferSize; }
const U8* getBuffer() const { return mBufferp; }
void reset() { mCurBufferp = mBufferp; mWriteEnabled = (mCurBufferp != NULL); }
void shift(S32 offset) { reset(); mCurBufferp += offset;}
void freeBuffer() { delete [] mBufferp; mBufferp = mCurBufferp = NULL; mBufferSize = 0; mWriteEnabled = FALSE; }
void assignBuffer(U8 *bufferp, S32 size)
{
if(mBufferp && mBufferp != bufferp)
{
freeBuffer() ;
}
mBufferp = bufferp;
mCurBufferp = bufferp;
mBufferSize = size;
mWriteEnabled = TRUE;
}
const LLDataPackerBinaryBuffer& operator=(const LLDataPackerBinaryBuffer &a);
/*virtual*/ BOOL hasNext() const { return getCurrentSize() < getBufferSize(); }
/*virtual*/ void dumpBufferToLog();
protected:
inline BOOL verifyLength(const S32 data_size, const char *name);
U8 *mBufferp;
U8 *mCurBufferp;
S32 mBufferSize;
};
inline BOOL LLDataPackerBinaryBuffer::verifyLength(const S32 data_size, const char *name)
{
if (mWriteEnabled && (mCurBufferp - mBufferp) > mBufferSize - data_size)
{
LL_WARNS() << "Buffer overflow in BinaryBuffer length verify, field name " << name << "!" << LL_ENDL;
LL_WARNS() << "Current pos: " << (int)(mCurBufferp - mBufferp) << " Buffer size: " << mBufferSize << " Data size: " << data_size << LL_ENDL;
return FALSE;
}
return TRUE;
}
class LLDataPackerAsciiBuffer : public LLDataPacker
{
public:
LLDataPackerAsciiBuffer(char* bufferp, S32 size)
{
mBufferp = bufferp;
mCurBufferp = bufferp;
mBufferSize = size;
mPassFlags = 0;
mIncludeNames = FALSE;
mWriteEnabled = TRUE;
}
LLDataPackerAsciiBuffer()
{
mBufferp = NULL;
mCurBufferp = NULL;
mBufferSize = 0;
mPassFlags = 0;
mIncludeNames = FALSE;
mWriteEnabled = FALSE;
}
/*virtual*/ BOOL packString(const std::string& value, const char *name);
/*virtual*/ BOOL unpackString(std::string& value, const char *name);
/*virtual*/ BOOL packBinaryData(const U8 *value, S32 size, const char *name);
/*virtual*/ BOOL unpackBinaryData(U8 *value, S32 &size, const char *name);
// Constant size binary data packing
/*virtual*/ BOOL packBinaryDataFixed(const U8 *value, S32 size, const char *name);
/*virtual*/ BOOL unpackBinaryDataFixed(U8 *value, S32 size, const char *name);
/*virtual*/ BOOL packU8(const U8 value, const char *name);
/*virtual*/ BOOL unpackU8(U8 &value, const char *name);
/*virtual*/ BOOL packU16(const U16 value, const char *name);
/*virtual*/ BOOL unpackU16(U16 &value, const char *name);
/*virtual*/ BOOL packS16(const S16 value, const char *name);
/*virtual*/ BOOL unpackS16(S16 &value, const char *name);
/*virtual*/ BOOL packU32(const U32 value, const char *name);
/*virtual*/ BOOL unpackU32(U32 &value, const char *name);
/*virtual*/ BOOL packS32(const S32 value, const char *name);
/*virtual*/ BOOL unpackS32(S32 &value, const char *name);
/*virtual*/ BOOL packF32(const F32 value, const char *name);
/*virtual*/ BOOL unpackF32(F32 &value, const char *name);
/*virtual*/ BOOL packColor4(const LLColor4 &value, const char *name);
/*virtual*/ BOOL unpackColor4(LLColor4 &value, const char *name);
/*virtual*/ BOOL packColor4U(const LLColor4U &value, const char *name);
/*virtual*/ BOOL unpackColor4U(LLColor4U &value, const char *name);
/*virtual*/ BOOL packVector2(const LLVector2 &value, const char *name);
/*virtual*/ BOOL unpackVector2(LLVector2 &value, const char *name);
/*virtual*/ BOOL packVector3(const LLVector3 &value, const char *name);
/*virtual*/ BOOL unpackVector3(LLVector3 &value, const char *name);
/*virtual*/ BOOL packVector4(const LLVector4 &value, const char *name);
/*virtual*/ BOOL unpackVector4(LLVector4 &value, const char *name);
/*virtual*/ BOOL packUUID(const LLUUID &value, const char *name);
/*virtual*/ BOOL unpackUUID(LLUUID &value, const char *name);
void setIncludeNames(BOOL b) { mIncludeNames = b; }
// Include the trailing NULL so it's always a valid string
S32 getCurrentSize() const { return (S32)(mCurBufferp - mBufferp) + 1; }
S32 getBufferSize() const { return mBufferSize; }
/*virtual*/ void reset() { mCurBufferp = mBufferp; mWriteEnabled = (mCurBufferp != NULL); }
/*virtual*/ BOOL hasNext() const { return getCurrentSize() < getBufferSize(); }
inline void freeBuffer();
inline void assignBuffer(char* bufferp, S32 size);
void dump();
protected:
void writeIndentedName(const char *name);
BOOL getValueStr(const char *name, char *out_value, const S32 value_len);
protected:
inline BOOL verifyLength(const S32 data_size, const char *name);
char *mBufferp;
char *mCurBufferp;
S32 mBufferSize;
BOOL mIncludeNames; // useful for debugging, print the name of each field
};
inline void LLDataPackerAsciiBuffer::freeBuffer()
{
delete [] mBufferp;
mBufferp = mCurBufferp = NULL;
mBufferSize = 0;
mWriteEnabled = FALSE;
}
inline void LLDataPackerAsciiBuffer::assignBuffer(char* bufferp, S32 size)
{
mBufferp = bufferp;
mCurBufferp = bufferp;
mBufferSize = size;
mWriteEnabled = TRUE;
}
inline BOOL LLDataPackerAsciiBuffer::verifyLength(const S32 data_size, const char *name)
{
if (mWriteEnabled && (mCurBufferp - mBufferp) > mBufferSize - data_size)
{
LL_WARNS() << "Buffer overflow in AsciiBuffer length verify, field name " << name << "!" << LL_ENDL;
LL_WARNS() << "Current pos: " << (int)(mCurBufferp - mBufferp) << " Buffer size: " << mBufferSize << " Data size: " << data_size << LL_ENDL;
return FALSE;
}
return TRUE;
}
class LLDataPackerAsciiFile : public LLDataPacker
{
public:
LLDataPackerAsciiFile(LLFILE *fp, const S32 indent = 2)
: LLDataPacker(),
mIndent(indent),
mFP(fp),
mOutputStream(NULL),
mInputStream(NULL)
{
}
LLDataPackerAsciiFile(std::ostream& output_stream, const S32 indent = 2)
: LLDataPacker(),
mIndent(indent),
mFP(NULL),
mOutputStream(&output_stream),
mInputStream(NULL)
{
mWriteEnabled = TRUE;
}
LLDataPackerAsciiFile(std::istream& input_stream, const S32 indent = 2)
: LLDataPacker(),
mIndent(indent),
mFP(NULL),
mOutputStream(NULL),
mInputStream(&input_stream)
{
}
/*virtual*/ BOOL packString(const std::string& value, const char *name);
/*virtual*/ BOOL unpackString(std::string& value, const char *name);
/*virtual*/ BOOL packBinaryData(const U8 *value, S32 size, const char *name);
/*virtual*/ BOOL unpackBinaryData(U8 *value, S32 &size, const char *name);
/*virtual*/ BOOL packBinaryDataFixed(const U8 *value, S32 size, const char *name);
/*virtual*/ BOOL unpackBinaryDataFixed(U8 *value, S32 size, const char *name);
/*virtual*/ BOOL packU8(const U8 value, const char *name);
/*virtual*/ BOOL unpackU8(U8 &value, const char *name);
/*virtual*/ BOOL packU16(const U16 value, const char *name);
/*virtual*/ BOOL unpackU16(U16 &value, const char *name);
/*virtual*/ BOOL packS16(const S16 value, const char *name);
/*virtual*/ BOOL unpackS16(S16 &value, const char *name);
/*virtual*/ BOOL packU32(const U32 value, const char *name);
/*virtual*/ BOOL unpackU32(U32 &value, const char *name);
/*virtual*/ BOOL packS32(const S32 value, const char *name);
/*virtual*/ BOOL unpackS32(S32 &value, const char *name);
/*virtual*/ BOOL packF32(const F32 value, const char *name);
/*virtual*/ BOOL unpackF32(F32 &value, const char *name);
/*virtual*/ BOOL packColor4(const LLColor4 &value, const char *name);
/*virtual*/ BOOL unpackColor4(LLColor4 &value, const char *name);
/*virtual*/ BOOL packColor4U(const LLColor4U &value, const char *name);
/*virtual*/ BOOL unpackColor4U(LLColor4U &value, const char *name);
/*virtual*/ BOOL packVector2(const LLVector2 &value, const char *name);
/*virtual*/ BOOL unpackVector2(LLVector2 &value, const char *name);
/*virtual*/ BOOL packVector3(const LLVector3 &value, const char *name);
/*virtual*/ BOOL unpackVector3(LLVector3 &value, const char *name);
/*virtual*/ BOOL packVector4(const LLVector4 &value, const char *name);
/*virtual*/ BOOL unpackVector4(LLVector4 &value, const char *name);
/*virtual*/ BOOL packUUID(const LLUUID &value, const char *name);
/*virtual*/ BOOL unpackUUID(LLUUID &value, const char *name);
protected:
void writeIndentedName(const char *name);
BOOL getValueStr(const char *name, char *out_value, const S32 value_len);
/*virtual*/ BOOL hasNext() const { return true; }
protected:
S32 mIndent;
LLFILE *mFP;
std::ostream* mOutputStream;
std::istream* mInputStream;
};
#endif // LL_LLDATAPACKER
|
