hkArray.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:14k
源码类别:

其他游戏

开发平台:

Visual C++

  1. /* 
  2.  * 
  3.  * Confidential Information of Telekinesys Research Limited (t/a Havok). Not for disclosure or distribution without Havok's
  4.  * prior written consent. This software contains code, techniques and know-how which is confidential and proprietary to Havok.
  5.  * Level 2 and Level 3 source code contains trade secrets of Havok. Havok Software (C) Copyright 1999-2009 Telekinesys Research Limited t/a Havok. All Rights Reserved. Use of this software is subject to the terms of an end user license agreement.
  6.  * 
  7.  */
  8. #ifndef HKBASE_HKARRAY_H
  9. #define HKBASE_HKARRAY_H
  10. #ifndef hkArrayAllocator
  11. # define hkArrayAllocator hkThreadMemory::getInstance()
  12. #endif
  13. /// Common functionality for all hkArray types.
  14. /// These are out of line functions to avoid code bloat.
  15. namespace hkArrayUtil
  16. {
  17. void HK_CALL _reserve(void*, int numElem, int sizeElem);
  18. void HK_CALL _reserveMore(void* array, int sizeElem);
  19. void HK_CALL _reduce(void* array, int sizeElem, char* inplaceMem, int requestedCapacity);
  20. }
  21. template <typename T> class hkObjectArray;
  22. /// The default Havok array.
  23. /// Note that, for performance reasons, order may not be preserved when deleting elements.<br>
  24. /// <br>
  25. /// This is <i>not</i> a complete replacement for the STL array,
  26. /// and should be used only with plain old data types
  27. /// (or objects that have a trivial constructor, destructor,
  28. /// copy constructor and assignment operator that are equivalent
  29. /// to memcpy), as constructors, destructors, etc. are not called.
  30. /// If you need to create an array of objects, you should use an hkObjectArray.
  31. template <typename T>
  32. class hkArray
  33. {
  34. friend void HK_CALL hkArrayUtil::_reserve(void*, int numElem, int sizeElem);
  35. friend void HK_CALL hkArrayUtil::_reserveMore(void* array, int sizeElem);
  36. friend void HK_CALL hkArrayUtil::_reduce(void* array, int sizeElem, char* inplaceMem, int requestedCapacity);
  37. friend class hkObjectArray< hkArray<T> >;
  38. friend class hkArraySpu;
  39. public:
  40. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR(HK_MEMORY_CLASS_ARRAY, hkArray<T>);
  41. /// Creates a zero length array.
  42. HK_FORCE_INLINE hkArray();
  43. /// Creates an array of size n. All elements are uninitialized.
  44. explicit HK_FORCE_INLINE hkArray(int size);
  45. /// Creates an array of n elements initialized to 'fill'.
  46. HK_FORCE_INLINE hkArray(int size, const T& fill);
  47. /// Noncopying initialization from an existing external buffer.
  48. /// This does not copy the array but uses it in place until its capacity
  49. /// is exceeded at which point a reallocation occurs and the array behaves
  50. /// like a normal hkArray.
  51. /// The caller must ensure that the buffer is valid for the lifetime
  52. /// of this array and for deallocation of the buffer.
  53. HK_FORCE_INLINE hkArray(T* buffer, int size, int capacity);
  54. private:
  55. /// Not publicly accessible, too easy to call accidentally.
  56. hkArray(const hkArray& a);
  57. public:
  58. /// Use a user supplied array as storage.
  59. /// The external array must be valid for the lifetime of this array.
  60. void useExternalArray(T*, int numElements);
  61. /// Use a user supplied buffer as storage.
  62. /// The external buffer must be valid for the lifetime of this array.
  63. void useExternalBuffer(void*, int numBytes);
  64. /// Copies the array a.
  65. hkArray& operator= (const hkArray& a);
  66. /// Deallocates array memory.
  67. HK_FORCE_INLINE ~hkArray();
  68. /// Read/write access to the i'th element.
  69. HK_FORCE_INLINE T& operator[] (int i);
  70. /// Read only access to the i'th element.
  71. HK_FORCE_INLINE const T& operator[] (int i) const;
  72. /// Read/write access to the last element.
  73. HK_FORCE_INLINE T& back();
  74. /// Read only access to the last element.
  75. HK_FORCE_INLINE const T& back() const;
  76. /// Returns the size.
  77. HK_FORCE_INLINE int getSize() const;
  78. /// Returns the capacity.
  79. HK_FORCE_INLINE int getCapacity() const;
  80. /// Checks if the size is zero.
  81. HK_FORCE_INLINE hkBool isEmpty() const;
  82. /// Sets the size to zero.
  83. HK_FORCE_INLINE void clear();
  84. /// Sets the size to zero and deallocates storage.
  85. void clearAndDeallocate();
  86. /// Tries to reduce the capacity to avoid wasting storage. If shrinkExact is true the resulting capacity
  87. /// is size+numElementsLeft
  88. HK_FORCE_INLINE void optimizeCapacity( int numFreeElemsLeft, hkBool32 shrinkExact=false );
  89. /// Removes the element at the specified index. The last array element is used to replace the removed element, and the size is reduced by 1.
  90. /// This is very fast, but note that the order of elements is changed.
  91. void removeAt(int index);
  92. /// Removes the element at the specified index, copying elements down one slot as in the STL array.
  93. /// Slower than removeAt(), but the order is unchanged.
  94. void removeAtAndCopy(int index);
  95. /// Removes several elements at the specified index, copying elements down as in the STL array.
  96. void removeAtAndCopy(int index, int numToRemove);
  97. /// Returns the index of the first occurrence of t, or -1 if not found.
  98. int indexOf(const T& t, int start=0, int end=-1) const;
  99. /// Returns index of the last occurrence of t, or -1 if not found.
  100. int lastIndexOf(const T& t) const;
  101. /// Removes the last element.
  102. HK_FORCE_INLINE void popBack( int numElemsToRemove = 1 );
  103. /// Returns the specified subarray of this array.
  104. ///
  105. /// begin and end are inclusive and exclusive respectively.
  106. /// i.e. {0,1,2,3}.getSubarray(1,3) == { 1, 2 }
  107. hkArray<T> getSubarray(int begin, int end);
  108. /// Adds an element to the end.
  109. HK_FORCE_INLINE void pushBack(const T& e);
  110. /// Adds an element to the end. No check for resize.
  111. HK_FORCE_INLINE void pushBackUnchecked(const T& e);
  112. /// Ensures no reallocation occurs until at least size n.
  113. HK_FORCE_INLINE void reserve(int n);
  114. /// Ensures no reallocation occurs until size n.
  115. HK_FORCE_INLINE void reserveExactly(int n);
  116. /// Sets the size.
  117. /// If the array is expanded, new elements are uninitialized.
  118. HK_FORCE_INLINE void setSize(int size);
  119. /// Sets the size to n.
  120. /// If the array is expanded, new elements initialized with 'fill'.
  121. void setSize(int n, const T& fill);
  122. /// Sets the size assuming the capacity to be sufficient.
  123. /// If the array is expanded, new elements are uninitialized.
  124. HK_FORCE_INLINE void setSizeUnchecked(int size);
  125. /// Checks if the locked flag is set.
  126. /// If an array is locked, the storage has come from file
  127. /// (so the do not deallocate flag is set) but it also
  128. /// means that the destructor will never be called so if you resize
  129. /// the array you will have to make sure and call clearAndDeallocate()
  130. /// yourself.
  131. HK_FORCE_INLINE hkBool isLocked();
  132. /// Overrides the lock state. If you unlock and then resize
  133. /// the array then the destructor will never be called, so
  134. /// you will have to make sure and call clearAndDeallocate()
  135. /// yourself.
  136. HK_FORCE_INLINE void setLocked( bool locked );
  137. /// Increments the size by 1 and returns a reference to the first element created.
  138. HK_FORCE_INLINE T& expandOne( );
  139. /// Increments the size by n and returns a pointer to the first element created.
  140. HK_FORCE_INLINE T* expandBy( int n );
  141. /// Increments the size by n and returns a pointer to the first element created.  No check for resize!
  142. HK_FORCE_INLINE T* expandByUnchecked( int n );
  143. /// Expands the array by numToInsert at the specified index.
  144. /// See also getSubarray() and the constructor which uses an existing
  145. /// C style array in place.
  146. HK_FORCE_INLINE T* expandAt( int index, int numToInsert );
  147. /// Inserts the array a at index i.
  148. /// See also getSubarray() and the constructor, which uses an existing
  149. /// C style array in place.
  150. void insertAt(int i, const T* p, int numElems );
  151. /// Replaces elements [i,i+ndel) with the supplied array.
  152. /// This method avoids redundant copying associated with separate remove & insert steps.
  153. void spliceInto(int i, int ndel, const T* p, int numElems );
  154. /// Inserts t at index i.
  155. /// Elements from i to the end are copied up one place.
  156. void insertAt(int i, const T& t);
  157. /// Swaps this array's internal storage with 'a'.
  158. void swap(hkArray<T>& a);
  159. ///
  160. typedef T* iterator;
  161. ///
  162. typedef const T* const_iterator;
  163. /// Returns an STL-like iterator to the first element.
  164. HK_FORCE_INLINE iterator begin();
  165. /// Returns an STL-like iterator to the 'one past the last' element.
  166. HK_FORCE_INLINE iterator end();
  167. /// Returns an STL-like const iterator to the first element.
  168. HK_FORCE_INLINE const_iterator begin() const;
  169. /// Returns an STL-like const iterator to the 'one past the last' element.
  170. HK_FORCE_INLINE const_iterator end() const;
  171. static void HK_CALL copy(T* dst, const T* src, int n);
  172. static void HK_CALL copyBackwards(T* dst, const T* src, int n);
  173. /// Advanced use only.
  174. HK_FORCE_INLINE void setOwnedData(T* ptr, int size, int capacity);
  175.             /// Get the capacity and the flags - advanced use
  176.         HK_FORCE_INLINE int getCapacityAndFlags() const;
  177. public:
  178. // Public so that the serialization can access it.
  179. enum
  180. {
  181. CAPACITY_MASK = int(0x3FFFFFFF),
  182. FLAG_MASK = int(0xC0000000),
  183. DONT_DEALLOCATE_FLAG = int(0x80000000), // Indicates that the storage is not the array's to delete
  184. LOCKED_FLAG = int(0x40000000),  // Indicates that the array will never have its dtor called (read in from packfile for instance)
  185. FORCE_SIGNED = -1
  186. };
  187. protected:
  188. friend class hkStatisticsCollector;
  189. void releaseMemory();
  190. T* m_data;
  191. int m_size;
  192. int m_capacityAndFlags; // highest 2 bits indicate any special considerations about the allocation for the array
  193. public:
  194. /// For serialization, we want to initialize the vtables
  195. /// in classes post data load, and NOT call the default constructor
  196. /// for the arrays (as the data has already been set).
  197. hkArray(hkFinishLoadedObjectFlag f) { }
  198. };
  199. /// Array that has an internal storage capacity within the class itself.
  200. /// Originally hkArray::m_data points to hkInplaceArray::m_storage.
  201. /// It is safe to expand the capacity beyond the internal capacity. In this
  202. /// case the array behaves like a normal hkArray (i.e. m_data points to heap
  203. /// memory instead of to &m_storage[0]).
  204. /// Note that once the builtin capacity has been exceeded,
  205. /// the inplace elements are unused even if subsequently resized smaller
  206. /// than the original capacity.
  207. template <typename T, unsigned N>
  208. class hkInplaceArray : public hkArray<T>
  209. {
  210. public:
  211. typedef hkInplaceArray<T,N> mytype;
  212. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR(HK_MEMORY_CLASS_ARRAY, mytype );
  213. /// Creates an array with the specified initial size.
  214. HK_FORCE_INLINE hkInplaceArray(int size = 0);
  215. HK_FORCE_INLINE hkInplaceArray(const hkInplaceArray<T,N>& a);
  216. HK_FORCE_INLINE ~hkInplaceArray(){}
  217. /// Copies the array a.
  218. hkArray<T>& operator= (const hkArray<T>& a);
  219. /// Copies the array a.
  220. hkArray<T>& operator= (const hkInplaceArray<T,N>& a);
  221. /// Tries to reduce the capacity to avoid wasting storage
  222. HK_FORCE_INLINE void optimizeCapacity( int numFreeElemsLeft, hkBool32 shrinkExact=false );
  223. inline hkBool wasReallocated() const;
  224. /// returns true if the array is still using its inplace buffer.
  225. /// This check is done using only the mask field, so do not use
  226. /// this function for arrays which can be serialized
  227. inline int stillInplaceUsingMask() const;
  228. public:
  229. T m_storage[N];
  230. public:
  231. /// For serialization, we want to initialize the vtables
  232. /// in classes post data load, and NOT call the default constructor
  233. /// for the arrays (as the data has already been set).
  234. hkInplaceArray(hkFinishLoadedObjectFlag f) : hkArray<T>(f) { }
  235. };
  236. /// An array that has a small internal storage capacity, aligned to 16 bytes within the class itself.
  237. template <typename T, unsigned N>
  238. class hkInplaceArrayAligned16 : public hkArray<T>
  239. {
  240. public:
  241. typedef hkInplaceArray<T,N> mytype;
  242. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR(HK_MEMORY_CLASS_ARRAY, mytype);
  243. /// Creates an array with the specified initial size.
  244. HK_FORCE_INLINE hkInplaceArrayAligned16(int size = 0);
  245. HK_FORCE_INLINE ~hkInplaceArrayAligned16(){}
  246. /// Copies the array a.
  247. hkArray<T>& operator= (const hkArray<T>& a);
  248. /// Copies the array a.
  249. hkArray<T>& operator= (const hkInplaceArrayAligned16<T,N>& a);
  250. inline hkBool wasReallocated() const;
  251. protected:
  252. int m_padding; // sizeof(base class) + padding == 16 bytes
  253. HK_ALIGN16( hkUint8 m_storage[sizeof(T) * N] );
  254. public:
  255. /// For serialization, we want to initialize the vtables
  256. /// in classes post data load, and NOT call the default constructor
  257. /// for the arrays (as the data has already been set).
  258. hkInplaceArrayAligned16(hkFinishLoadedObjectFlag f) : hkArray<T>(f) { }
  259. };
  260. #include <Common/Base/Container/Array/hkArray.inl>
  261. #undef hkArrayAllocator
  262. #endif // HKBASE_HKARRAY_H
  263. /*
  264. * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
  265. * Confidential Information of Havok.  (C) Copyright 1999-2009
  266. * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
  267. * Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
  268. * rights, and intellectual property rights in the Havok software remain in
  269. * Havok and/or its suppliers.
  270. * Use of this software for evaluation purposes is subject to and indicates
  271. * acceptance of the End User licence Agreement for this product. A copy of
  272. * the license is included with this software and is also available at www.havok.com/tryhavok.
  273. */