Bullet Collision Detection & Physics Library
bFile.h
Go to the documentation of this file.
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 // ----------------------------------------------------- //
27 {
29  FD_OK = 1,
38 };
39 
41 {
46 };
47 // ----------------------------------------------------- //
48 class bFile
49 {
50 protected:
51  char m_headerString[7];
52 
54  char* mFileBuffer;
55  int mFileLen;
56  int mVersion;
57 
59 
63 
66 
69 
70  //
71 
73 
74  int mFlags;
75 
76  // ////////////////////////////////////////////////////////////////////////////
77 
78  // buffer offset util
79  int getNextBlock(bChunkInd* dataChunk, const char* dataPtr, const int flags);
80  void safeSwapPtr(char* dst, const char* src);
81 
82  virtual void parseHeader();
83 
84  virtual void parseData() = 0;
85 
87  void resolvePointersChunk(const bChunkInd& dataChunk, int verboseMode);
88 
89  int resolvePointersStructRecursive(char* strcPtr, int old_dna, int verboseMode, int recursion);
90  //void swapPtr(char *dst, char *src);
91 
92  void parseStruct(char* strcPtr, char* dtPtr, int old_dna, int new_dna, bool fixupPointers);
93  void getMatchingFileDNA(short* old, const char* lookupName, const char* lookupType, char* strcData, char* data, bool fixupPointers);
94  char* getFileElement(short* firstStruct, char* lookupName, char* lookupType, char* data, short** foundPos);
95 
96  void swap(char* head, class bChunkInd& ch, bool ignoreEndianFlag);
97  void swapData(char* data, short type, int arraySize, bool ignoreEndianFlag);
98  void swapStruct(int dna_nr, char* data, bool ignoreEndianFlag);
99  void swapLen(char* dataPtr);
100  void swapDNA(char* ptr);
101 
102  char* readStruct(char* head, class bChunkInd& chunk);
103  char* getAsString(int code);
104 
105  virtual void parseInternal(int verboseMode, char* memDna, int memDnaLength);
106 
107 public:
108  bFile(const char* filename, const char headerString[7]);
109 
110  //todo: make memoryBuffer const char
111  //bFile( const char *memoryBuffer, int len);
112  bFile(char* memoryBuffer, int len, const char headerString[7]);
113  virtual ~bFile();
114 
116  {
117  return mFileDNA;
118  }
119 
120  virtual void addDataBlock(char* dataBlock) = 0;
121 
122  int getFlags() const
123  {
124  return mFlags;
125  }
126 
128  {
130  }
131 
133  {
134  return mLibPointers;
135  }
136 
137  void* findLibPointer(void* ptr);
138 
139  bool ok();
140 
141  virtual void parse(int verboseMode) = 0;
142 
143  virtual int write(const char* fileName, bool fixupPointers = false) = 0;
144 
145  virtual void writeChunks(FILE* fp, bool fixupPointers);
146 
147  virtual void writeDNA(FILE* fp) = 0;
148 
149  void updateOldPointers();
150  void resolvePointers(int verboseMode);
151 
152  void dumpChunks(bDNA* dna);
153 
154  virtual void setFileDNA(int verboseMode, char* buffer, int len);
155 
156  int getVersion() const
157  {
158  return mVersion;
159  }
160  //pre-swap the endianness, so that data loaded on a target with different endianness doesn't need to be swapped
161  void preSwap();
162  void writeFile(const char* fileName);
163 };
164 } // namespace bParse
165 
166 #endif //__BFILE_H__
bFile(const char *filename, const char headerString[7])
Definition: bFile.cpp:55
bPtrMap mDataPointers
Definition: bFile.h:72
int mFileLen
Definition: bFile.h:55
bDNA * mMemoryDNA
Definition: bFile.h:62
virtual ~bFile()
Definition: bFile.cpp:110
virtual void addDataBlock(char *dataBlock)=0
char * getAsString(int code)
void swap(char *head, class bChunkInd &ch, bool ignoreEndianFlag)
Definition: bFile.cpp:307
btAlignedObjectArray< char * > m_pointerFixupArray
Definition: bFile.h:64
void resolvePointersChunk(const bChunkInd &dataChunk, int verboseMode)
this loop only works fine if the Blender DNA structure of the file matches the headerfiles
Definition: bFile.cpp:1165
virtual void parseInternal(int verboseMode, char *memDna, int memDnaLength)
Definition: bFile.cpp:194
void writeFile(const char *fileName)
Definition: bFile.cpp:537
virtual void parseData()=0
btAlignedObjectArray< char * > m_pointerPtrFixupArray
Definition: bFile.h:65
virtual void setFileDNA(int verboseMode, char *buffer, int len)
Definition: bFile.cpp:182
virtual void parseHeader()
Definition: bFile.cpp:123
btAlignedObjectArray< bChunkInd > m_chunks
Definition: bFile.h:67
int mDataStart
Definition: bFile.h:60
void parseStruct(char *strcPtr, char *dtPtr, int old_dna, int new_dna, bool fixupPointers)
Definition: bFile.cpp:733
btHashMap< btHashPtr, bChunkInd > m_chunkPtrPtrMap
Definition: bFile.h:68
void dumpChunks(bDNA *dna)
Definition: bFile.cpp:1457
int mVersion
Definition: bFile.h:56
void resolvePointers(int verboseMode)
Resolve pointers replaces the original pointers in structures, and linked lists by the new in-memory ...
Definition: bFile.cpp:1390
char * readStruct(char *head, class bChunkInd &chunk)
Definition: bFile.cpp:618
bPtrMap mLibPointers
Definition: bFile.h:58
virtual void writeChunks(FILE *fp, bool fixupPointers)
Definition: bFile.cpp:1498
char * mFileBuffer
Definition: bFile.h:54
void updateOldPointers()
Definition: bFile.cpp:1447
void swapLen(char *dataPtr)
Definition: bFile.cpp:333
void setFileDNAisMemoryDNA()
Definition: bFile.h:127
int getNextBlock(bChunkInd *dataChunk, const char *dataPtr, const int flags)
Definition: bFile.cpp:1558
int getFlags() const
Definition: bFile.h:122
virtual void parse(int verboseMode)=0
void safeSwapPtr(char *dst, const char *src)
Definition: bFile.cpp:884
char * getFileElement(short *firstStruct, char *lookupName, char *lookupType, char *data, short **foundPos)
Definition: bFile.cpp:1023
int resolvePointersStructRecursive(char *strcPtr, int old_dna, int verboseMode, int recursion)
Definition: bFile.cpp:1181
char m_headerString[7]
Definition: bFile.h:51
bDNA * getFileDNA()
Definition: bFile.h:115
bool mOwnsBuffer
Definition: bFile.h:53
void resolvePointersMismatch()
Definition: bFile.cpp:1099
int getVersion() const
Definition: bFile.h:156
virtual int write(const char *fileName, bool fixupPointers=false)=0
void swapStruct(int dna_nr, char *data, bool ignoreEndianFlag)
Definition: bFile.cpp:1051
void swapData(char *data, short type, int arraySize, bool ignoreEndianFlag)
Definition: bFile.cpp:853
int mFlags
Definition: bFile.h:74
void swapDNA(char *ptr)
Definition: bFile.cpp:381
void * findLibPointer(void *ptr)
Definition: bFile.cpp:1439
bool ok()
Definition: bFile.cpp:177
bDNA * mFileDNA
Definition: bFile.h:61
virtual void writeDNA(FILE *fp)=0
bPtrMap & getLibPointers()
Definition: bFile.h:132
void preSwap()
Definition: bFile.cpp:544
void getMatchingFileDNA(short *old, const char *lookupName, const char *lookupType, char *strcData, char *data, bool fixupPointers)
Definition: bFile.cpp:940
bFileFlags
Definition: bFile.h:27
@ FD_ENDIAN_SWAP
Definition: bFile.h:31
@ FD_FILE_64
Definition: bFile.h:32
@ FD_VERSION_VARIES
Definition: bFile.h:34
@ FD_FILEDNA_IS_MEMDNA
Definition: bFile.h:37
@ FD_INVALID
Definition: bFile.h:28
@ FD_BROKEN_DNA
Definition: bFile.h:36
@ FD_OK
Definition: bFile.h:29
@ FD_VOID_IS_8
Definition: bFile.h:30
@ FD_BITS_VARIES
Definition: bFile.h:33
@ FD_DOUBLE_PRECISION
Definition: bFile.h:35
bFileVerboseMode
Definition: bFile.h:41
@ FD_VERBOSE_DUMP_DNA_TYPE_DEFINITIONS
Definition: bFile.h:43
@ FD_VERBOSE_DUMP_CHUNKS
Definition: bFile.h:44
@ FD_VERBOSE_DUMP_FILE_INFO
Definition: bFile.h:45
@ FD_VERBOSE_EXPORT_XML
Definition: bFile.h:42