Home | History | Annotate | Download | only in BulletFileLoader
      1 /*
      2 bParse
      3 Copyright (c) 2006-2009 Charlie C & Erwin Coumans  http://gamekit.googlecode.com
      4 
      5 This software is provided 'as-is', without any express or implied warranty.
      6 In no event will the authors be held liable for any damages arising from the use of this software.
      7 Permission is granted to anyone to use this software for any purpose,
      8 including commercial applications, and to alter it and redistribute it freely,
      9 subject to the following restrictions:
     10 
     11 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
     12 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
     13 3. This notice may not be removed or altered from any source distribution.
     14 */
     15 
     16 #ifndef __BFILE_H__
     17 #define __BFILE_H__
     18 
     19 #include "bCommon.h"
     20 #include "bChunk.h"
     21 #include <stdio.h>
     22 
     23 namespace bParse {
     24 
     25 	// ----------------------------------------------------- //
     26 	enum bFileFlags
     27 	{
     28 		FD_INVALID   =0,
     29 		FD_OK        =1,
     30 		FD_VOID_IS_8 =2,
     31 		FD_ENDIAN_SWAP      =4,
     32 		FD_FILE_64   =8,
     33 		FD_BITS_VARIES    =16,
     34 		FD_VERSION_VARIES = 32,
     35 		FD_DOUBLE_PRECISION =64,
     36 		FD_BROKEN_DNA = 128,
     37 		FD_FILEDNA_IS_MEMDNA = 256
     38 	};
     39 
     40 	enum bFileVerboseMode
     41 	{
     42 		FD_VERBOSE_EXPORT_XML = 1,
     43 		FD_VERBOSE_DUMP_DNA_TYPE_DEFINITIONS = 2,
     44 		FD_VERBOSE_DUMP_CHUNKS = 4,
     45 		FD_VERBOSE_DUMP_FILE_INFO=8,
     46 	};
     47 	// ----------------------------------------------------- //
     48 	class bFile
     49 	{
     50 	protected:
     51 
     52 		char				m_headerString[7];
     53 
     54 		bool				mOwnsBuffer;
     55 		char*				mFileBuffer;
     56 		int					mFileLen;
     57 		int					mVersion;
     58 
     59 
     60 		bPtrMap				mLibPointers;
     61 
     62 		int					mDataStart;
     63 		bDNA*				mFileDNA;
     64 		bDNA*				mMemoryDNA;
     65 
     66 		btAlignedObjectArray<char*>	m_pointerFixupArray;
     67 		btAlignedObjectArray<char*>	m_pointerPtrFixupArray;
     68 
     69 		btAlignedObjectArray<bChunkInd>	m_chunks;
     70         btHashMap<btHashPtr, bChunkInd> m_chunkPtrPtrMap;
     71 
     72         //
     73 
     74 		bPtrMap				mDataPointers;
     75 
     76 
     77 		int					mFlags;
     78 
     79 		// ////////////////////////////////////////////////////////////////////////////
     80 
     81 			// buffer offset util
     82 		int getNextBlock(bChunkInd *dataChunk,  const char *dataPtr, const int flags);
     83 		void safeSwapPtr(char *dst, const char *src);
     84 
     85 		virtual	void parseHeader();
     86 
     87 		virtual	void parseData() = 0;
     88 
     89 		void resolvePointersMismatch();
     90 		void resolvePointersChunk(const bChunkInd& dataChunk, int verboseMode);
     91 
     92 		int resolvePointersStructRecursive(char *strcPtr, int old_dna, int verboseMode, int recursion);
     93 		//void swapPtr(char *dst, char *src);
     94 
     95 		void parseStruct(char *strcPtr, char *dtPtr, int old_dna, int new_dna, bool fixupPointers);
     96 		void getMatchingFileDNA(short* old, const char* lookupName, const char* lookupType, char *strcData, char *data, bool fixupPointers);
     97 		char* getFileElement(short *firstStruct, char *lookupName, char *lookupType, char *data, short **foundPos);
     98 
     99 
    100 		void swap(char *head, class bChunkInd& ch, bool ignoreEndianFlag);
    101 		void swapData(char *data, short type, int arraySize, bool ignoreEndianFlag);
    102 		void swapStruct(int dna_nr, char *data, bool ignoreEndianFlag);
    103 		void swapLen(char *dataPtr);
    104 		void swapDNA(char* ptr);
    105 
    106 
    107 		char* readStruct(char *head, class bChunkInd& chunk);
    108 		char *getAsString(int code);
    109 
    110 		virtual void	parseInternal(int verboseMode, char* memDna,int memDnaLength);
    111 
    112 	public:
    113 		bFile(const char *filename, const char headerString[7]);
    114 
    115 		//todo: make memoryBuffer const char
    116 		//bFile( const char *memoryBuffer, int len);
    117 		bFile( char *memoryBuffer, int len, const char headerString[7]);
    118 		virtual ~bFile();
    119 
    120 		bDNA*				getFileDNA()
    121 		{
    122 			return mFileDNA;
    123 		}
    124 
    125 		virtual	void	addDataBlock(char* dataBlock) = 0;
    126 
    127 		int	getFlags() const
    128 		{
    129 			return mFlags;
    130 		}
    131 
    132 		void setFileDNAisMemoryDNA()
    133 		{
    134 			mFlags |= FD_FILEDNA_IS_MEMDNA;
    135 		}
    136 
    137 		bPtrMap&		getLibPointers()
    138 		{
    139 			return mLibPointers;
    140 		}
    141 
    142 		void* findLibPointer(void *ptr);
    143 
    144 		bool ok();
    145 
    146 		virtual	void parse(int verboseMode) = 0;
    147 
    148 		virtual	int	write(const char* fileName, bool fixupPointers=false) = 0;
    149 
    150 		virtual	void	writeChunks(FILE* fp, bool fixupPointers );
    151 
    152 		virtual	void	writeDNA(FILE* fp) = 0;
    153 
    154 		void	updateOldPointers();
    155 		void	resolvePointers(int verboseMode);
    156 
    157 		void	dumpChunks(bDNA* dna);
    158 
    159 		virtual void setFileDNA(int verboseMode, char* buffer, int len);
    160 
    161 		int		getVersion() const
    162 		{
    163 			return mVersion;
    164 		}
    165 		//pre-swap the endianness, so that data loaded on a target with different endianness doesn't need to be swapped
    166 		void preSwap();
    167 		void writeFile(const char* fileName);
    168 
    169 
    170 
    171 	};
    172 }
    173 
    174 
    175 #endif//__BFILE_H__
    176