OpenSimulator GForge > Projects > Hippo OpenSim Viewer > SVN

Annotation of /linden_release/linden/indra/llmessage/lldatapacker.h

1 :	mjm	57	/**
2 :			* @file lldatapacker.h
3 :			* @brief Data packer declaration for tightly storing binary data.
4 :			*
5 :			* $LicenseInfo:firstyear=2002&license=viewergpl$
6 :			*
7 :			* Copyright (c) 2002-2008, Linden Research, Inc.
8 :			*
9 :			* Second Life Viewer Source Code
10 :			* The source code in this file ("Source Code") is provided by Linden Lab
11 :			* to you under the terms of the GNU General Public License, version 2.0
12 :			* ("GPL"), unless you have obtained a separate licensing agreement
13 :			* ("Other License"), formally executed by you and Linden Lab. Terms of
14 :			* the GPL can be found in doc/GPL-license.txt in this distribution, or
15 :			* online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
16 :			*
17 :			* There are special exceptions to the terms and conditions of the GPL as
18 :			* it is applied to this Source Code. View the full text of the exception
19 :			* in the file doc/FLOSS-exception.txt in this software distribution, or
20 :			* online at http://secondlifegrid.net/programs/open_source/licensing/flossexception
21 :			*
22 :			* By copying, modifying or distributing this software, you acknowledge
23 :			* that you have read and understood your obligations described above,
24 :			* and agree to abide by those obligations.
25 :			*
26 :			* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
27 :			* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
28 :			* COMPLETENESS OR PERFORMANCE.
29 :			* $/LicenseInfo$
30 :			*/
31 :
32 :			#ifndef LL_LLDATAPACKER_H
33 :			#define LL_LLDATAPACKER_H
34 :
35 :			class LLColor4;
36 :			class LLColor4U;
37 :			class LLVector2;
38 :			class LLVector3;
39 :			class LLVector4;
40 :			class LLUUID;
41 :
42 :			class LLDataPacker
43 :			{
44 :			public:
45 :			virtual ~LLDataPacker() {}
46 :
47 :			virtual void reset() { llerrs << "Using unimplemented datapacker reset!" << llendl; };
48 :			virtual void dumpBufferToLog() { llerrs << "dumpBufferToLog not implemented for this type!" << llendl; }
49 :
50 :			virtual BOOL hasNext() const = 0;
51 :
52 :			virtual BOOL packString(const std::string& value, const char *name) = 0;
53 :			virtual BOOL unpackString(std::string& value, const char *name) = 0;
54 :
55 :			virtual BOOL packBinaryData(const U8 value, S32 size, const char name) = 0;
56 :			virtual BOOL unpackBinaryData(U8 value, S32 &size, const char name) = 0;
57 :
58 :			// Constant size binary data packing
59 :			virtual BOOL packBinaryDataFixed(const U8 value, S32 size, const char name) = 0;
60 :			virtual BOOL unpackBinaryDataFixed(U8 value, S32 size, const char name) = 0;
61 :
62 :			virtual BOOL packU8(const U8 value, const char *name) = 0;
63 :			virtual BOOL unpackU8(U8 &value, const char *name) = 0;
64 :
65 :			virtual BOOL packU16(const U16 value, const char *name) = 0;
66 :			virtual BOOL unpackU16(U16 &value, const char *name) = 0;
67 :
68 :			virtual BOOL packU32(const U32 value, const char *name) = 0;
69 :			virtual BOOL unpackU32(U32 &value, const char *name) = 0;
70 :
71 :			virtual BOOL packS32(const S32 value, const char *name) = 0;
72 :			virtual BOOL unpackS32(S32 &value, const char *name) = 0;
73 :
74 :			virtual BOOL packF32(const F32 value, const char *name) = 0;
75 :			virtual BOOL unpackF32(F32 &value, const char *name) = 0;
76 :
77 :			// Packs a float into an integer, using the given size
78 :			// and picks the right U* data type to pack into.
79 :			BOOL packFixed(const F32 value, const char *name,
80 :			const BOOL is_signed, const U32 int_bits, const U32 frac_bits);
81 :			BOOL unpackFixed(F32 &value, const char *name,
82 :			const BOOL is_signed, const U32 int_bits, const U32 frac_bits);
83 :
84 :			virtual BOOL packColor4(const LLColor4 &value, const char *name) = 0;
85 :			virtual BOOL unpackColor4(LLColor4 &value, const char *name) = 0;
86 :
87 :			virtual BOOL packColor4U(const LLColor4U &value, const char *name) = 0;
88 :			virtual BOOL unpackColor4U(LLColor4U &value, const char *name) = 0;
89 :
90 :			virtual BOOL packVector2(const LLVector2 &value, const char *name) = 0;
91 :			virtual BOOL unpackVector2(LLVector2 &value, const char *name) = 0;
92 :
93 :			virtual BOOL packVector3(const LLVector3 &value, const char *name) = 0;
94 :			virtual BOOL unpackVector3(LLVector3 &value, const char *name) = 0;
95 :
96 :			virtual BOOL packVector4(const LLVector4 &value, const char *name) = 0;
97 :			virtual BOOL unpackVector4(LLVector4 &value, const char *name) = 0;
98 :
99 :			virtual BOOL packUUID(const LLUUID &value, const char *name) = 0;
100 :			virtual BOOL unpackUUID(LLUUID &value, const char *name) = 0;
101 :			U32 getPassFlags() const { return mPassFlags; }
102 :			void setPassFlags(U32 flags) { mPassFlags = flags; }
103 :			protected:
104 :			LLDataPacker();
105 :			protected:
106 :			U32 mPassFlags;
107 :			BOOL mWriteEnabled; // disable this to do things like determine filesize without actually copying data
108 :			};
109 :
110 :			class LLDataPackerBinaryBuffer : public LLDataPacker
111 :			{
112 :			public:
113 :			LLDataPackerBinaryBuffer(U8 *bufferp, S32 size)
114 :			: LLDataPacker(),
115 :			mBufferp(bufferp),
116 :			mCurBufferp(bufferp),
117 :			mBufferSize(size)
118 :			{
119 :			mWriteEnabled = TRUE;
120 :			}
121 :
122 :			LLDataPackerBinaryBuffer()
123 :			: LLDataPacker(),
124 :			mBufferp(NULL),
125 :			mCurBufferp(NULL),
126 :			mBufferSize(0)
127 :			{
128 :			}
129 :
130 :			/virtual/ BOOL packString(const std::string& value, const char *name);
131 :			/virtual/ BOOL unpackString(std::string& value, const char *name);
132 :
133 :			/virtual/ BOOL packBinaryData(const U8 value, S32 size, const char name);
134 :			/virtual/ BOOL unpackBinaryData(U8 value, S32 &size, const char name);
135 :
136 :			// Constant size binary data packing
137 :			/virtual/ BOOL packBinaryDataFixed(const U8 value, S32 size, const char name);
138 :			/virtual/ BOOL unpackBinaryDataFixed(U8 value, S32 size, const char name);
139 :
140 :			/virtual/ BOOL packU8(const U8 value, const char *name);
141 :			/virtual/ BOOL unpackU8(U8 &value, const char *name);
142 :
143 :			/virtual/ BOOL packU16(const U16 value, const char *name);
144 :			/virtual/ BOOL unpackU16(U16 &value, const char *name);
145 :
146 :			/virtual/ BOOL packU32(const U32 value, const char *name);
147 :			/virtual/ BOOL unpackU32(U32 &value, const char *name);
148 :
149 :			/virtual/ BOOL packS32(const S32 value, const char *name);
150 :			/virtual/ BOOL unpackS32(S32 &value, const char *name);
151 :
152 :			/virtual/ BOOL packF32(const F32 value, const char *name);
153 :			/virtual/ BOOL unpackF32(F32 &value, const char *name);
154 :
155 :			/virtual/ BOOL packColor4(const LLColor4 &value, const char *name);
156 :			/virtual/ BOOL unpackColor4(LLColor4 &value, const char *name);
157 :
158 :			/virtual/ BOOL packColor4U(const LLColor4U &value, const char *name);
159 :			/virtual/ BOOL unpackColor4U(LLColor4U &value, const char *name);
160 :
161 :			/virtual/ BOOL packVector2(const LLVector2 &value, const char *name);
162 :			/virtual/ BOOL unpackVector2(LLVector2 &value, const char *name);
163 :
164 :			/virtual/ BOOL packVector3(const LLVector3 &value, const char *name);
165 :			/virtual/ BOOL unpackVector3(LLVector3 &value, const char *name);
166 :
167 :			/virtual/ BOOL packVector4(const LLVector4 &value, const char *name);
168 :			/virtual/ BOOL unpackVector4(LLVector4 &value, const char *name);
169 :
170 :			/virtual/ BOOL packUUID(const LLUUID &value, const char *name);
171 :			/virtual/ BOOL unpackUUID(LLUUID &value, const char *name);
172 :
173 :			S32 getCurrentSize() const { return (S32)(mCurBufferp - mBufferp); }
174 :			S32 getBufferSize() const { return mBufferSize; }
175 :			void reset() { mCurBufferp = mBufferp; mWriteEnabled = (mCurBufferp != NULL); }
176 :			void freeBuffer() { delete [] mBufferp; mBufferp = mCurBufferp = NULL; mBufferSize = 0; mWriteEnabled = FALSE; }
177 :			void assignBuffer(U8 *bufferp, S32 size)
178 :			{
179 :			mBufferp = bufferp;
180 :			mCurBufferp = bufferp;
181 :			mBufferSize = size;
182 :			mWriteEnabled = TRUE;
183 :			}
184 :			const LLDataPackerBinaryBuffer& operator=(const LLDataPackerBinaryBuffer &a);
185 :
186 :			/virtual/ BOOL hasNext() const { return getCurrentSize() < getBufferSize(); }
187 :
188 :			/virtual/ void dumpBufferToLog();
189 :			protected:
190 :			inline BOOL verifyLength(const S32 data_size, const char *name);
191 :
192 :			U8 *mBufferp;
193 :			U8 *mCurBufferp;
194 :			S32 mBufferSize;
195 :			};
196 :
197 :			inline BOOL LLDataPackerBinaryBuffer::verifyLength(const S32 data_size, const char *name)
198 :			{
199 :			if (mWriteEnabled && (mCurBufferp - mBufferp) > mBufferSize - data_size)
200 :			{
201 :			llwarns << "Buffer overflow in BinaryBuffer length verify, field name " << name << "!" << llendl;
202 :			llwarns << "Current pos: " << (int)(mCurBufferp - mBufferp) << " Buffer size: " << mBufferSize << " Data size: " << data_size << llendl;
203 :			return FALSE;
204 :			}
205 :
206 :			return TRUE;
207 :			}
208 :
209 :			class LLDataPackerAsciiBuffer : public LLDataPacker
210 :			{
211 :			public:
212 :			LLDataPackerAsciiBuffer(char* bufferp, S32 size)
213 :			{
214 :			mBufferp = bufferp;
215 :			mCurBufferp = bufferp;
216 :			mBufferSize = size;
217 :			mPassFlags = 0;
218 :			mIncludeNames = FALSE;
219 :			mWriteEnabled = TRUE;
220 :			}
221 :
222 :			LLDataPackerAsciiBuffer()
223 :			{
224 :			mBufferp = NULL;
225 :			mCurBufferp = NULL;
226 :			mBufferSize = 0;
227 :			mPassFlags = 0;
228 :			mIncludeNames = FALSE;
229 :			mWriteEnabled = FALSE;
230 :			}
231 :
232 :			/virtual/ BOOL packString(const std::string& value, const char *name);
233 :			/virtual/ BOOL unpackString(std::string& value, const char *name);
234 :
235 :			/virtual/ BOOL packBinaryData(const U8 value, S32 size, const char name);
236 :			/virtual/ BOOL unpackBinaryData(U8 value, S32 &size, const char name);
237 :
238 :			// Constant size binary data packing
239 :			/virtual/ BOOL packBinaryDataFixed(const U8 value, S32 size, const char name);
240 :			/virtual/ BOOL unpackBinaryDataFixed(U8 value, S32 size, const char name);
241 :
242 :			/virtual/ BOOL packU8(const U8 value, const char *name);
243 :			/virtual/ BOOL unpackU8(U8 &value, const char *name);
244 :
245 :			/virtual/ BOOL packU16(const U16 value, const char *name);
246 :			/virtual/ BOOL unpackU16(U16 &value, const char *name);
247 :
248 :			/virtual/ BOOL packU32(const U32 value, const char *name);
249 :			/virtual/ BOOL unpackU32(U32 &value, const char *name);
250 :
251 :			/virtual/ BOOL packS32(const S32 value, const char *name);
252 :			/virtual/ BOOL unpackS32(S32 &value, const char *name);
253 :
254 :			/virtual/ BOOL packF32(const F32 value, const char *name);
255 :			/virtual/ BOOL unpackF32(F32 &value, const char *name);
256 :
257 :			/virtual/ BOOL packColor4(const LLColor4 &value, const char *name);
258 :			/virtual/ BOOL unpackColor4(LLColor4 &value, const char *name);
259 :
260 :			/virtual/ BOOL packColor4U(const LLColor4U &value, const char *name);
261 :			/virtual/ BOOL unpackColor4U(LLColor4U &value, const char *name);
262 :
263 :			/virtual/ BOOL packVector2(const LLVector2 &value, const char *name);
264 :			/virtual/ BOOL unpackVector2(LLVector2 &value, const char *name);
265 :
266 :			/virtual/ BOOL packVector3(const LLVector3 &value, const char *name);
267 :			/virtual/ BOOL unpackVector3(LLVector3 &value, const char *name);
268 :
269 :			/virtual/ BOOL packVector4(const LLVector4 &value, const char *name);
270 :			/virtual/ BOOL unpackVector4(LLVector4 &value, const char *name);
271 :
272 :			/virtual/ BOOL packUUID(const LLUUID &value, const char *name);
273 :			/virtual/ BOOL unpackUUID(LLUUID &value, const char *name);
274 :
275 :			void setIncludeNames(BOOL b) { mIncludeNames = b; }
276 :
277 :			// Include the trailing NULL so it's always a valid string
278 :			S32 getCurrentSize() const { return (S32)(mCurBufferp - mBufferp) + 1; }
279 :
280 :			S32 getBufferSize() const { return mBufferSize; }
281 :			/virtual/ void reset() { mCurBufferp = mBufferp; mWriteEnabled = (mCurBufferp != NULL); }
282 :
283 :			/virtual/ BOOL hasNext() const { return getCurrentSize() < getBufferSize(); }
284 :
285 :			inline void freeBuffer();
286 :			inline void assignBuffer(char* bufferp, S32 size);
287 :			void dump();
288 :
289 :			protected:
290 :			void writeIndentedName(const char *name);
291 :			BOOL getValueStr(const char name, char out_value, const S32 value_len);
292 :
293 :			protected:
294 :			inline BOOL verifyLength(const S32 data_size, const char *name);
295 :
296 :			char *mBufferp;
297 :			char *mCurBufferp;
298 :			S32 mBufferSize;
299 :			BOOL mIncludeNames; // useful for debugging, print the name of each field
300 :			};
301 :
302 :			inline void LLDataPackerAsciiBuffer::freeBuffer()
303 :			{
304 :			delete [] mBufferp;
305 :			mBufferp = mCurBufferp = NULL;
306 :			mBufferSize = 0;
307 :			mWriteEnabled = FALSE;
308 :			}
309 :
310 :			inline void LLDataPackerAsciiBuffer::assignBuffer(char* bufferp, S32 size)
311 :			{
312 :			mBufferp = bufferp;
313 :			mCurBufferp = bufferp;
314 :			mBufferSize = size;
315 :			mWriteEnabled = TRUE;
316 :			}
317 :
318 :			inline BOOL LLDataPackerAsciiBuffer::verifyLength(const S32 data_size, const char *name)
319 :			{
320 :			if (mWriteEnabled && (mCurBufferp - mBufferp) > mBufferSize - data_size)
321 :			{
322 :			llwarns << "Buffer overflow in AsciiBuffer length verify, field name " << name << "!" << llendl;
323 :			llwarns << "Current pos: " << (int)(mCurBufferp - mBufferp) << " Buffer size: " << mBufferSize << " Data size: " << data_size << llendl;
324 :			return FALSE;
325 :			}
326 :
327 :			return TRUE;
328 :			}
329 :
330 :			class LLDataPackerAsciiFile : public LLDataPacker
331 :			{
332 :			public:
333 :			LLDataPackerAsciiFile(LLFILE *fp, const S32 indent = 2)
334 :			: LLDataPacker(),
335 :			mIndent(indent),
336 :			mFP(fp),
337 :			mOutputStream(NULL),
338 :			mInputStream(NULL)
339 :			{
340 :			}
341 :
342 :			LLDataPackerAsciiFile(std::ostream& output_stream, const S32 indent = 2)
343 :			: LLDataPacker(),
344 :			mIndent(indent),
345 :			mFP(NULL),
346 :			mOutputStream(&output_stream),
347 :			mInputStream(NULL)
348 :			{
349 :			mWriteEnabled = TRUE;
350 :			}
351 :
352 :			LLDataPackerAsciiFile(std::istream& input_stream, const S32 indent = 2)
353 :			: LLDataPacker(),
354 :			mIndent(indent),
355 :			mFP(NULL),
356 :			mOutputStream(NULL),
357 :			mInputStream(&input_stream)
358 :			{
359 :			}
360 :
361 :			/virtual/ BOOL packString(const std::string& value, const char *name);
362 :			/virtual/ BOOL unpackString(std::string& value, const char *name);
363 :
364 :			/virtual/ BOOL packBinaryData(const U8 value, S32 size, const char name);
365 :			/virtual/ BOOL unpackBinaryData(U8 value, S32 &size, const char name);
366 :
367 :			/virtual/ BOOL packBinaryDataFixed(const U8 value, S32 size, const char name);
368 :			/virtual/ BOOL unpackBinaryDataFixed(U8 value, S32 size, const char name);
369 :
370 :			/virtual/ BOOL packU8(const U8 value, const char *name);
371 :			/virtual/ BOOL unpackU8(U8 &value, const char *name);
372 :
373 :			/virtual/ BOOL packU16(const U16 value, const char *name);
374 :			/virtual/ BOOL unpackU16(U16 &value, const char *name);
375 :
376 :			/virtual/ BOOL packU32(const U32 value, const char *name);
377 :			/virtual/ BOOL unpackU32(U32 &value, const char *name);
378 :
379 :			/virtual/ BOOL packS32(const S32 value, const char *name);
380 :			/virtual/ BOOL unpackS32(S32 &value, const char *name);
381 :
382 :			/virtual/ BOOL packF32(const F32 value, const char *name);
383 :			/virtual/ BOOL unpackF32(F32 &value, const char *name);
384 :
385 :			/virtual/ BOOL packColor4(const LLColor4 &value, const char *name);
386 :			/virtual/ BOOL unpackColor4(LLColor4 &value, const char *name);
387 :
388 :			/virtual/ BOOL packColor4U(const LLColor4U &value, const char *name);
389 :			/virtual/ BOOL unpackColor4U(LLColor4U &value, const char *name);
390 :
391 :			/virtual/ BOOL packVector2(const LLVector2 &value, const char *name);
392 :			/virtual/ BOOL unpackVector2(LLVector2 &value, const char *name);
393 :
394 :			/virtual/ BOOL packVector3(const LLVector3 &value, const char *name);
395 :			/virtual/ BOOL unpackVector3(LLVector3 &value, const char *name);
396 :
397 :			/virtual/ BOOL packVector4(const LLVector4 &value, const char *name);
398 :			/virtual/ BOOL unpackVector4(LLVector4 &value, const char *name);
399 :
400 :			/virtual/ BOOL packUUID(const LLUUID &value, const char *name);
401 :			/virtual/ BOOL unpackUUID(LLUUID &value, const char *name);
402 :			protected:
403 :			void writeIndentedName(const char *name);
404 :			BOOL getValueStr(const char name, char out_value, const S32 value_len);
405 :
406 :			/virtual/ BOOL hasNext() const { return true; }
407 :
408 :			protected:
409 :			S32 mIndent;
410 :			LLFILE *mFP;
411 :			std::ostream* mOutputStream;
412 :			std::istream* mInputStream;
413 :			};
414 :
415 :			#endif // LL_LLDATAPACKER
416 :

	ViewVC Help
Powered by ViewVC 1.0.0

MyGforge Home

Hippo OpenSim Viewer

Annotation of /linden_release/linden/indra/llmessage/lldatapacker.h