开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 游戏 > 游戏引擎 > 查看源码
lldatapacker.h
资源名称：snowglobe-src-viewer-2.0.0-r0.tar.gz　[点击查看]
上传用户：king477883
上传日期：2021-03-01
资源大小：9553k
文件大小：14k
源码类别：

游戏引擎

开发平台：

C++ Builder

lldatapacker.h：源码内容
  1. /** 
  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-2010, 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
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  33. #ifndef LL_LLDATAPACKER_H 
  34. #define LL_LLDATAPACKER_H
  36. class LLColor4;
  37. class LLColor4U;
  38. class LLVector2;
  39. class LLVector3;
  40. class LLVector4;
  41. class LLUUID;
  43. class LLDataPacker
  44. {
  45. public:
  46. virtual ~LLDataPacker() {}
  48. // Not required to override, but error to call?
  49. virtual void reset();
  50. virtual void dumpBufferToLog();
  52. virtual BOOL hasNext() const = 0;
  54. virtual BOOL packString(const std::string& value, const char *name) = 0;
  55. virtual BOOL unpackString(std::string& value, const char *name) = 0;
  57. virtual BOOL packBinaryData(const U8 *value, S32 size, const char *name) = 0;
  58. virtual BOOL unpackBinaryData(U8 *value, S32 &size, const char *name) = 0;
  60. // Constant size binary data packing
  61. virtual BOOL packBinaryDataFixed(const U8 *value, S32 size, const char *name) = 0;
  62. virtual BOOL unpackBinaryDataFixed(U8 *value, S32 size, const char *name) = 0;
  64. virtual BOOL packU8(const U8 value, const char *name) = 0;
  65. virtual BOOL unpackU8(U8 &value, const char *name) = 0;
  67. virtual BOOL packU16(const U16 value, const char *name) = 0;
  68. virtual BOOL unpackU16(U16 &value, const char *name) = 0;
  70. virtual BOOL packU32(const U32 value, const char *name) = 0;
  71. virtual BOOL unpackU32(U32 &value, const char *name) = 0;
  73. virtual BOOL packS32(const S32 value, const char *name) = 0;
  74. virtual BOOL unpackS32(S32 &value, const char *name) = 0;
  76. virtual BOOL packF32(const F32 value, const char *name) = 0;
  77. virtual BOOL unpackF32(F32 &value, const char *name) = 0;
  79. // Packs a float into an integer, using the given size
  80. // and picks the right U* data type to pack into.
  81. BOOL packFixed(const F32 value, const char *name,
  82. const BOOL is_signed, const U32 int_bits, const U32 frac_bits);
  83. BOOL unpackFixed(F32 &value, const char *name,
  84. const BOOL is_signed, const U32 int_bits, const U32 frac_bits);
  86. virtual BOOL packColor4(const LLColor4 &value, const char *name) = 0;
  87. virtual BOOL unpackColor4(LLColor4 &value, const char *name) = 0;
  89. virtual BOOL packColor4U(const LLColor4U &value, const char *name) = 0;
  90. virtual BOOL unpackColor4U(LLColor4U &value, const char *name) = 0;
  92. virtual BOOL packVector2(const LLVector2 &value, const char *name) = 0;
  93. virtual BOOL unpackVector2(LLVector2 &value, const char *name) = 0;
  95. virtual BOOL packVector3(const LLVector3 &value, const char *name) = 0;
  96. virtual BOOL unpackVector3(LLVector3 &value, const char *name) = 0;
  98. virtual BOOL packVector4(const LLVector4 &value, const char *name) = 0;
  99. virtual BOOL unpackVector4(LLVector4 &value, const char *name) = 0;
  101. virtual BOOL packUUID(const LLUUID &value, const char *name) = 0;
  102. virtual BOOL unpackUUID(LLUUID &value, const char *name) = 0;
  103. U32 getPassFlags() const { return mPassFlags; }
  104. void setPassFlags(U32 flags) { mPassFlags = flags; }
  105. protected:
  106. LLDataPacker();
  107. protected:
  108. U32 mPassFlags;
  109. BOOL mWriteEnabled; // disable this to do things like determine filesize without actually copying data
  110. };
  112. class LLDataPackerBinaryBuffer : public LLDataPacker
  113. {
  114. public:
  115. LLDataPackerBinaryBuffer(U8 *bufferp, S32 size)
  116. : LLDataPacker(),
  117. mBufferp(bufferp),
  118. mCurBufferp(bufferp),
  119. mBufferSize(size)
  120. {
  121. mWriteEnabled = TRUE;
  122. }
  124. LLDataPackerBinaryBuffer()
  125. : LLDataPacker(),
  126. mBufferp(NULL),
  127. mCurBufferp(NULL),
  128. mBufferSize(0)
  129. {
  130. }
  132. /*virtual*/ BOOL packString(const std::string& value, const char *name);
  133. /*virtual*/ BOOL unpackString(std::string& value, const char *name);
  135. /*virtual*/ BOOL packBinaryData(const U8 *value, S32 size, const char *name);
  136. /*virtual*/ BOOL unpackBinaryData(U8 *value, S32 &size, const char *name);
  138. // Constant size binary data packing
  139. /*virtual*/ BOOL packBinaryDataFixed(const U8 *value, S32 size, const char *name);
  140. /*virtual*/ BOOL unpackBinaryDataFixed(U8 *value, S32 size, const char *name);
  142. /*virtual*/ BOOL packU8(const U8 value, const char *name);
  143. /*virtual*/ BOOL unpackU8(U8 &value, const char *name);
  145. /*virtual*/ BOOL packU16(const U16 value, const char *name);
  146. /*virtual*/ BOOL unpackU16(U16 &value, const char *name);
  148. /*virtual*/ BOOL packU32(const U32 value, const char *name);
  149. /*virtual*/ BOOL unpackU32(U32 &value, const char *name);
  151. /*virtual*/ BOOL packS32(const S32 value, const char *name);
  152. /*virtual*/ BOOL unpackS32(S32 &value, const char *name);
  154. /*virtual*/ BOOL packF32(const F32 value, const char *name);
  155. /*virtual*/ BOOL unpackF32(F32 &value, const char *name);
  157. /*virtual*/ BOOL packColor4(const LLColor4 &value, const char *name);
  158. /*virtual*/ BOOL unpackColor4(LLColor4 &value, const char *name);
  160. /*virtual*/ BOOL packColor4U(const LLColor4U &value, const char *name);
  161. /*virtual*/ BOOL unpackColor4U(LLColor4U &value, const char *name);
  163. /*virtual*/ BOOL packVector2(const LLVector2 &value, const char *name);
  164. /*virtual*/ BOOL unpackVector2(LLVector2 &value, const char *name);
  166. /*virtual*/ BOOL packVector3(const LLVector3 &value, const char *name);
  167. /*virtual*/ BOOL unpackVector3(LLVector3 &value, const char *name);
  169. /*virtual*/ BOOL packVector4(const LLVector4 &value, const char *name);
  170. /*virtual*/ BOOL unpackVector4(LLVector4 &value, const char *name);
  172. /*virtual*/ BOOL packUUID(const LLUUID &value, const char *name);
  173. /*virtual*/ BOOL unpackUUID(LLUUID &value, const char *name);
  175. S32 getCurrentSize() const { return (S32)(mCurBufferp - mBufferp); }
  176. S32 getBufferSize() const { return mBufferSize; }
  177. void reset() { mCurBufferp = mBufferp; mWriteEnabled = (mCurBufferp != NULL); }
  178. void freeBuffer() { delete [] mBufferp; mBufferp = mCurBufferp = NULL; mBufferSize = 0; mWriteEnabled = FALSE; }
  179. void assignBuffer(U8 *bufferp, S32 size)
  180. {
  181. mBufferp = bufferp;
  182. mCurBufferp = bufferp;
  183. mBufferSize = size;
  184. mWriteEnabled = TRUE;
  185. }
  186. const LLDataPackerBinaryBuffer& operator=(const LLDataPackerBinaryBuffer &a);
  188. /*virtual*/ BOOL hasNext() const { return getCurrentSize() < getBufferSize(); }
  190. /*virtual*/ void dumpBufferToLog();
  191. protected:
  192. inline BOOL verifyLength(const S32 data_size, const char *name);
  194. U8 *mBufferp;
  195. U8 *mCurBufferp;
  196. S32 mBufferSize;
  197. };
  199. inline BOOL LLDataPackerBinaryBuffer::verifyLength(const S32 data_size, const char *name)
  200. {
  201. if (mWriteEnabled && (mCurBufferp - mBufferp) > mBufferSize - data_size)
  202. {
  203. llwarns << "Buffer overflow in BinaryBuffer length verify, field name " << name << "!" << llendl;
  204. llwarns << "Current pos: " << (int)(mCurBufferp - mBufferp) << " Buffer size: " << mBufferSize << " Data size: " << data_size << llendl;
  205. return FALSE;
  206. }
  208. return TRUE;
  209. }
  211. class LLDataPackerAsciiBuffer : public LLDataPacker
  212. {
  213. public:
  214. LLDataPackerAsciiBuffer(char* bufferp, S32 size)
  215. {
  216. mBufferp = bufferp;
  217. mCurBufferp = bufferp;
  218. mBufferSize = size;
  219. mPassFlags = 0;
  220. mIncludeNames = FALSE;
  221. mWriteEnabled = TRUE;
  222. }
  224. LLDataPackerAsciiBuffer()
  225. {
  226. mBufferp = NULL;
  227. mCurBufferp = NULL;
  228. mBufferSize = 0;
  229. mPassFlags = 0;
  230. mIncludeNames = FALSE;
  231. mWriteEnabled = FALSE;
  232. }
  234. /*virtual*/ BOOL packString(const std::string& value, const char *name);
  235. /*virtual*/ BOOL unpackString(std::string& value, const char *name);
  237. /*virtual*/ BOOL packBinaryData(const U8 *value, S32 size, const char *name);
  238. /*virtual*/ BOOL unpackBinaryData(U8 *value, S32 &size, const char *name);
  240. // Constant size binary data packing
  241. /*virtual*/ BOOL packBinaryDataFixed(const U8 *value, S32 size, const char *name);
  242. /*virtual*/ BOOL unpackBinaryDataFixed(U8 *value, S32 size, const char *name);
  244. /*virtual*/ BOOL packU8(const U8 value, const char *name);
  245. /*virtual*/ BOOL unpackU8(U8 &value, const char *name);
  247. /*virtual*/ BOOL packU16(const U16 value, const char *name);
  248. /*virtual*/ BOOL unpackU16(U16 &value, const char *name);
  250. /*virtual*/ BOOL packU32(const U32 value, const char *name);
  251. /*virtual*/ BOOL unpackU32(U32 &value, const char *name);
  253. /*virtual*/ BOOL packS32(const S32 value, const char *name);
  254. /*virtual*/ BOOL unpackS32(S32 &value, const char *name);
  256. /*virtual*/ BOOL packF32(const F32 value, const char *name);
  257. /*virtual*/ BOOL unpackF32(F32 &value, const char *name);
  259. /*virtual*/ BOOL packColor4(const LLColor4 &value, const char *name);
  260. /*virtual*/ BOOL unpackColor4(LLColor4 &value, const char *name);
  262. /*virtual*/ BOOL packColor4U(const LLColor4U &value, const char *name);
  263. /*virtual*/ BOOL unpackColor4U(LLColor4U &value, const char *name);
  265. /*virtual*/ BOOL packVector2(const LLVector2 &value, const char *name);
  266. /*virtual*/ BOOL unpackVector2(LLVector2 &value, const char *name);
  268. /*virtual*/ BOOL packVector3(const LLVector3 &value, const char *name);
  269. /*virtual*/ BOOL unpackVector3(LLVector3 &value, const char *name);
  271. /*virtual*/ BOOL packVector4(const LLVector4 &value, const char *name);
  272. /*virtual*/ BOOL unpackVector4(LLVector4 &value, const char *name);
  274. /*virtual*/ BOOL packUUID(const LLUUID &value, const char *name);
  275. /*virtual*/ BOOL unpackUUID(LLUUID &value, const char *name);
  277. void setIncludeNames(BOOL b) { mIncludeNames = b; }
  279. // Include the trailing NULL so it's always a valid string
  280. S32 getCurrentSize() const { return (S32)(mCurBufferp - mBufferp) + 1; }
  282. S32 getBufferSize() const { return mBufferSize; }
  283. /*virtual*/ void reset() { mCurBufferp = mBufferp; mWriteEnabled = (mCurBufferp != NULL); }
  285. /*virtual*/ BOOL hasNext() const { return getCurrentSize() < getBufferSize(); }
  287. inline void freeBuffer();
  288. inline void assignBuffer(char* bufferp, S32 size);
  289. void dump();
  291. protected:
  292. void writeIndentedName(const char *name);
  293. BOOL getValueStr(const char *name, char *out_value, const S32 value_len);
  295. protected:
  296. inline BOOL verifyLength(const S32 data_size, const char *name);
  298. char *mBufferp;
  299. char *mCurBufferp;
  300. S32 mBufferSize;
  301. BOOL mIncludeNames; // useful for debugging, print the name of each field
  302. };
  304. inline void LLDataPackerAsciiBuffer::freeBuffer()
  305. {
  306. delete [] mBufferp; 
  307. mBufferp = mCurBufferp = NULL; 
  308. mBufferSize = 0;
  309. mWriteEnabled = FALSE;
  310. }
  312. inline void LLDataPackerAsciiBuffer::assignBuffer(char* bufferp, S32 size)
  313. {
  314. mBufferp = bufferp;
  315. mCurBufferp = bufferp;
  316. mBufferSize = size;
  317. mWriteEnabled = TRUE;
  318. }
  320. inline BOOL LLDataPackerAsciiBuffer::verifyLength(const S32 data_size, const char *name)
  321. {
  322. if (mWriteEnabled && (mCurBufferp - mBufferp) > mBufferSize - data_size)
  323. {
  324. llwarns << "Buffer overflow in AsciiBuffer length verify, field name " << name << "!" << llendl;
  325. llwarns << "Current pos: " << (int)(mCurBufferp - mBufferp) << " Buffer size: " << mBufferSize << " Data size: " << data_size << llendl;
  326. return FALSE;
  327. }
  329. return TRUE;
  330. }
  332. class LLDataPackerAsciiFile : public LLDataPacker
  333. {
  334. public:
  335. LLDataPackerAsciiFile(LLFILE *fp, const S32 indent = 2)
  336. :  LLDataPacker(),
  337. mIndent(indent),
  338. mFP(fp),
  339. mOutputStream(NULL),
  340. mInputStream(NULL)
  341. {
  342. }
  344. LLDataPackerAsciiFile(std::ostream& output_stream, const S32 indent = 2)
  345. :  LLDataPacker(),
  346. mIndent(indent),
  347. mFP(NULL),
  348. mOutputStream(&output_stream),
  349. mInputStream(NULL)
  350. {
  351. mWriteEnabled = TRUE;
  352. }
  354. LLDataPackerAsciiFile(std::istream& input_stream, const S32 indent = 2)
  355. :  LLDataPacker(),
  356. mIndent(indent),
  357. mFP(NULL),
  358. mOutputStream(NULL),
  359. mInputStream(&input_stream)
  360. {
  361. }
  363. /*virtual*/ BOOL packString(const std::string& value, const char *name);
  364. /*virtual*/ BOOL unpackString(std::string& value, const char *name);
  366. /*virtual*/ BOOL packBinaryData(const U8 *value, S32 size, const char *name);
  367. /*virtual*/ BOOL unpackBinaryData(U8 *value, S32 &size, const char *name);
  369. /*virtual*/ BOOL packBinaryDataFixed(const U8 *value, S32 size, const char *name);
  370. /*virtual*/ BOOL unpackBinaryDataFixed(U8 *value, S32 size, const char *name);
  372. /*virtual*/ BOOL packU8(const U8 value, const char *name);
  373. /*virtual*/ BOOL unpackU8(U8 &value, const char *name);
  375. /*virtual*/ BOOL packU16(const U16 value, const char *name);
  376. /*virtual*/ BOOL unpackU16(U16 &value, const char *name);
  378. /*virtual*/ BOOL packU32(const U32 value, const char *name);
  379. /*virtual*/ BOOL unpackU32(U32 &value, const char *name);
  381. /*virtual*/ BOOL packS32(const S32 value, const char *name);
  382. /*virtual*/ BOOL unpackS32(S32 &value, const char *name);
  384. /*virtual*/ BOOL packF32(const F32 value, const char *name);
  385. /*virtual*/ BOOL unpackF32(F32 &value, const char *name);
  387. /*virtual*/ BOOL packColor4(const LLColor4 &value, const char *name);
  388. /*virtual*/ BOOL unpackColor4(LLColor4 &value, const char *name);
  390. /*virtual*/ BOOL packColor4U(const LLColor4U &value, const char *name);
  391. /*virtual*/ BOOL unpackColor4U(LLColor4U &value, const char *name);
  393. /*virtual*/ BOOL packVector2(const LLVector2 &value, const char *name);
  394. /*virtual*/ BOOL unpackVector2(LLVector2 &value, const char *name);
  396. /*virtual*/ BOOL packVector3(const LLVector3 &value, const char *name);
  397. /*virtual*/ BOOL unpackVector3(LLVector3 &value, const char *name);
  399. /*virtual*/ BOOL packVector4(const LLVector4 &value, const char *name);
  400. /*virtual*/ BOOL unpackVector4(LLVector4 &value, const char *name);
  402. /*virtual*/ BOOL packUUID(const LLUUID &value, const char *name);
  403. /*virtual*/ BOOL unpackUUID(LLUUID &value, const char *name);
  404. protected:
  405. void writeIndentedName(const char *name);
  406. BOOL getValueStr(const char *name, char *out_value, const S32 value_len);
  408. /*virtual*/ BOOL hasNext() const { return true; }
  410. protected:
  411. S32 mIndent;
  412. LLFILE *mFP;
  413. std::ostream* mOutputStream;
  414. std::istream* mInputStream;
  415. };
  417. #endif // LL_LLDATAPACKER