FX_CMapDwordToDword considered harmful.
[pdfium.git] / core / include / fxcrt / fx_basic.h
1 // Copyright 2014 PDFium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #ifndef CORE_INCLUDE_FXCRT_FX_BASIC_H_
8 #define CORE_INCLUDE_FXCRT_FX_BASIC_H_
9
10 #include "fx_memory.h"
11 #include "fx_stream.h"
12 #include "fx_string.h"
13 #include "fx_system.h"
14
15 // The FX_ArraySize(arr) macro returns the # of elements in an array arr.
16 // The expression is a compile-time constant, and therefore can be
17 // used in defining new arrays, for example.  If you use FX_ArraySize on
18 // a pointer by mistake, you will get a compile-time error.
19 //
20 // One caveat is that FX_ArraySize() doesn't accept any array of an
21 // anonymous type or a type defined inside a function.
22 #define FX_ArraySize(array) (sizeof(ArraySizeHelper(array)))
23
24 // This template function declaration is used in defining FX_ArraySize.
25 // Note that the function doesn't need an implementation, as we only
26 // use its type.
27 template <typename T, size_t N>
28 char(&ArraySizeHelper(T(&array)[N]))[N];
29
30 class CFX_BinaryBuf {
31  public:
32   CFX_BinaryBuf();
33   CFX_BinaryBuf(FX_STRSIZE size);
34
35   ~CFX_BinaryBuf();
36
37   void Clear();
38
39   void EstimateSize(FX_STRSIZE size, FX_STRSIZE alloc_step = 0);
40
41   void AppendBlock(const void* pBuf, FX_STRSIZE size);
42
43   void AppendFill(uint8_t byte, FX_STRSIZE count);
44
45   void AppendString(const CFX_ByteStringC& str) {
46     AppendBlock(str.GetPtr(), str.GetLength());
47   }
48
49   inline void AppendByte(uint8_t byte) {
50     if (m_AllocSize <= m_DataSize) {
51       ExpandBuf(1);
52     }
53     m_pBuffer[m_DataSize++] = byte;
54   }
55
56   void InsertBlock(FX_STRSIZE pos, const void* pBuf, FX_STRSIZE size);
57
58   void AttachData(void* pBuf, FX_STRSIZE size);
59
60   void CopyData(const void* pBuf, FX_STRSIZE size);
61
62   void TakeOver(CFX_BinaryBuf& other);
63
64   void Delete(int start_index, int count);
65
66   uint8_t* GetBuffer() const { return m_pBuffer; }
67
68   FX_STRSIZE GetSize() const { return m_DataSize; }
69
70   CFX_ByteStringC GetByteString() const;
71
72   void DetachBuffer();
73
74  protected:
75   FX_STRSIZE m_AllocStep;
76
77   uint8_t* m_pBuffer;
78
79   FX_STRSIZE m_DataSize;
80
81   FX_STRSIZE m_AllocSize;
82
83   void ExpandBuf(FX_STRSIZE size);
84 };
85 class CFX_ByteTextBuf : public CFX_BinaryBuf {
86  public:
87   void operator=(const CFX_ByteStringC& str);
88
89   void AppendChar(int ch) { AppendByte((uint8_t)ch); }
90
91   CFX_ByteTextBuf& operator<<(int i);
92
93   CFX_ByteTextBuf& operator<<(FX_DWORD i);
94
95   CFX_ByteTextBuf& operator<<(double f);
96
97   CFX_ByteTextBuf& operator<<(const CFX_ByteStringC& lpsz);
98
99   CFX_ByteTextBuf& operator<<(const CFX_ByteTextBuf& buf);
100
101   FX_STRSIZE GetLength() const { return m_DataSize; }
102 };
103 class CFX_WideTextBuf : public CFX_BinaryBuf {
104  public:
105   void operator=(const FX_WCHAR* lpsz);
106
107   void operator=(const CFX_WideStringC& str);
108
109   void AppendChar(FX_WCHAR wch);
110
111   CFX_WideTextBuf& operator<<(int i);
112
113   CFX_WideTextBuf& operator<<(double f);
114
115   CFX_WideTextBuf& operator<<(const FX_WCHAR* lpsz);
116
117   CFX_WideTextBuf& operator<<(const CFX_WideStringC& str);
118   CFX_WideTextBuf& operator<<(const CFX_WideString& str);
119
120   CFX_WideTextBuf& operator<<(const CFX_WideTextBuf& buf);
121
122   FX_STRSIZE GetLength() const { return m_DataSize / sizeof(FX_WCHAR); }
123
124   FX_WCHAR* GetBuffer() const { return (FX_WCHAR*)m_pBuffer; }
125
126   void Delete(int start_index, int count) {
127     CFX_BinaryBuf::Delete(start_index * sizeof(FX_WCHAR),
128                           count * sizeof(FX_WCHAR));
129   }
130
131   CFX_WideStringC GetWideString() const;
132 };
133
134 class IFX_BufferArchive {
135  public:
136   IFX_BufferArchive(FX_STRSIZE size);
137   virtual ~IFX_BufferArchive() {}
138
139   virtual void Clear();
140
141   FX_BOOL Flush();
142
143   int32_t AppendBlock(const void* pBuf, size_t size);
144
145   int32_t AppendByte(uint8_t byte);
146
147   int32_t AppendDWord(FX_DWORD i);
148
149   int32_t AppendString(const CFX_ByteStringC& lpsz);
150
151  protected:
152   virtual FX_BOOL DoWork(const void* pBuf, size_t size) = 0;
153
154   FX_STRSIZE m_BufSize;
155
156   uint8_t* m_pBuffer;
157
158   FX_STRSIZE m_Length;
159 };
160
161 class CFX_FileBufferArchive : public IFX_BufferArchive {
162  public:
163   CFX_FileBufferArchive(FX_STRSIZE size = 32768);
164   ~CFX_FileBufferArchive() override;
165
166   void Clear() override;
167   FX_BOOL AttachFile(IFX_StreamWrite* pFile, FX_BOOL bTakeover = FALSE);
168
169  private:
170   FX_BOOL DoWork(const void* pBuf, size_t size) override;
171
172   IFX_StreamWrite* m_pFile;
173   FX_BOOL m_bTakeover;
174 };
175
176 struct CFX_CharMap {
177   static CFX_CharMap* GetDefaultMapper(int32_t codepage = 0);
178
179   CFX_WideString (*m_GetWideString)(CFX_CharMap* pMap,
180                                     const CFX_ByteString& bstr);
181
182   CFX_ByteString (*m_GetByteString)(CFX_CharMap* pMap,
183                                     const CFX_WideString& wstr);
184
185   int32_t (*m_GetCodePage)();
186 };
187 class CFX_UTF8Decoder {
188  public:
189   CFX_UTF8Decoder() { m_PendingBytes = 0; }
190
191   void Clear();
192
193   void Input(uint8_t byte);
194
195   void AppendChar(FX_DWORD ch);
196
197   void ClearStatus() { m_PendingBytes = 0; }
198
199   CFX_WideStringC GetResult() const { return m_Buffer.GetWideString(); }
200
201  protected:
202   int m_PendingBytes;
203
204   FX_DWORD m_PendingChar;
205
206   CFX_WideTextBuf m_Buffer;
207 };
208
209 class CFX_UTF8Encoder {
210  public:
211   CFX_UTF8Encoder() {}
212
213   void Input(FX_WCHAR unicode);
214   void AppendStr(const CFX_ByteStringC& str) { m_Buffer << str; }
215   CFX_ByteStringC GetResult() const { return m_Buffer.GetByteString(); }
216
217  protected:
218   CFX_ByteTextBuf m_Buffer;
219 };
220
221 class CFX_BasicArray {
222  protected:
223   CFX_BasicArray(int unit_size);
224
225   ~CFX_BasicArray();
226
227   FX_BOOL SetSize(int nNewSize);
228
229   FX_BOOL Append(const CFX_BasicArray& src);
230
231   FX_BOOL Copy(const CFX_BasicArray& src);
232
233   uint8_t* InsertSpaceAt(int nIndex, int nCount);
234
235   FX_BOOL RemoveAt(int nIndex, int nCount);
236
237   FX_BOOL InsertAt(int nStartIndex, const CFX_BasicArray* pNewArray);
238
239   const void* GetDataPtr(int index) const;
240
241  protected:
242   uint8_t* m_pData;
243
244   int m_nSize;
245
246   int m_nMaxSize;
247
248   int m_nUnitSize;
249 };
250 template <class TYPE>
251 class CFX_ArrayTemplate : public CFX_BasicArray {
252  public:
253   CFX_ArrayTemplate() : CFX_BasicArray(sizeof(TYPE)) {}
254
255   int GetSize() const { return m_nSize; }
256
257   int GetUpperBound() const { return m_nSize - 1; }
258
259   FX_BOOL SetSize(int nNewSize) { return CFX_BasicArray::SetSize(nNewSize); }
260
261   void RemoveAll() { SetSize(0); }
262
263   const TYPE GetAt(int nIndex) const {
264     if (nIndex < 0 || nIndex >= m_nSize) {
265       return (const TYPE&)(*(volatile const TYPE*)NULL);
266     }
267     return ((const TYPE*)m_pData)[nIndex];
268   }
269
270   FX_BOOL SetAt(int nIndex, TYPE newElement) {
271     if (nIndex < 0 || nIndex >= m_nSize) {
272       return FALSE;
273     }
274     ((TYPE*)m_pData)[nIndex] = newElement;
275     return TRUE;
276   }
277
278   TYPE& ElementAt(int nIndex) {
279     if (nIndex < 0 || nIndex >= m_nSize) {
280       return *(TYPE*)NULL;
281     }
282     return ((TYPE*)m_pData)[nIndex];
283   }
284
285   const TYPE* GetData() const { return (const TYPE*)m_pData; }
286
287   TYPE* GetData() { return (TYPE*)m_pData; }
288
289   FX_BOOL SetAtGrow(int nIndex, TYPE newElement) {
290     if (nIndex < 0) {
291       return FALSE;
292     }
293     if (nIndex >= m_nSize)
294       if (!SetSize(nIndex + 1)) {
295         return FALSE;
296       }
297     ((TYPE*)m_pData)[nIndex] = newElement;
298     return TRUE;
299   }
300
301   FX_BOOL Add(TYPE newElement) {
302     if (m_nSize < m_nMaxSize) {
303       m_nSize++;
304     } else if (!SetSize(m_nSize + 1)) {
305       return FALSE;
306     }
307     ((TYPE*)m_pData)[m_nSize - 1] = newElement;
308     return TRUE;
309   }
310
311   FX_BOOL Append(const CFX_ArrayTemplate& src) {
312     return CFX_BasicArray::Append(src);
313   }
314
315   FX_BOOL Copy(const CFX_ArrayTemplate& src) {
316     return CFX_BasicArray::Copy(src);
317   }
318
319   TYPE* GetDataPtr(int index) {
320     return (TYPE*)CFX_BasicArray::GetDataPtr(index);
321   }
322
323   TYPE* AddSpace() { return (TYPE*)CFX_BasicArray::InsertSpaceAt(m_nSize, 1); }
324
325   TYPE* InsertSpaceAt(int nIndex, int nCount) {
326     return (TYPE*)CFX_BasicArray::InsertSpaceAt(nIndex, nCount);
327   }
328
329   const TYPE operator[](int nIndex) const {
330     if (nIndex < 0 || nIndex >= m_nSize) {
331       *(volatile char*)0 = '\0';
332     }
333     return ((const TYPE*)m_pData)[nIndex];
334   }
335
336   TYPE& operator[](int nIndex) {
337     if (nIndex < 0 || nIndex >= m_nSize) {
338       *(volatile char*)0 = '\0';
339     }
340     return ((TYPE*)m_pData)[nIndex];
341   }
342
343   FX_BOOL InsertAt(int nIndex, TYPE newElement, int nCount = 1) {
344     if (!InsertSpaceAt(nIndex, nCount)) {
345       return FALSE;
346     }
347     while (nCount--) {
348       ((TYPE*)m_pData)[nIndex++] = newElement;
349     }
350     return TRUE;
351   }
352
353   FX_BOOL RemoveAt(int nIndex, int nCount = 1) {
354     return CFX_BasicArray::RemoveAt(nIndex, nCount);
355   }
356
357   FX_BOOL InsertAt(int nStartIndex, const CFX_BasicArray* pNewArray) {
358     return CFX_BasicArray::InsertAt(nStartIndex, pNewArray);
359   }
360
361   int Find(TYPE data, int iStart = 0) const {
362     if (iStart < 0) {
363       return -1;
364     }
365     for (; iStart < (int)m_nSize; iStart++)
366       if (((TYPE*)m_pData)[iStart] == data) {
367         return iStart;
368       }
369     return -1;
370   }
371 };
372 typedef CFX_ArrayTemplate<uint8_t> CFX_ByteArray;
373 typedef CFX_ArrayTemplate<FX_WORD> CFX_WordArray;
374 typedef CFX_ArrayTemplate<FX_DWORD> CFX_DWordArray;
375 typedef CFX_ArrayTemplate<void*> CFX_PtrArray;
376 typedef CFX_ArrayTemplate<FX_FILESIZE> CFX_FileSizeArray;
377
378 template <class ObjectClass>
379 class CFX_ObjectArray : public CFX_BasicArray {
380  public:
381   CFX_ObjectArray() : CFX_BasicArray(sizeof(ObjectClass)) {}
382
383   ~CFX_ObjectArray() { RemoveAll(); }
384
385   void Add(const ObjectClass& data) {
386     new ((void*)InsertSpaceAt(m_nSize, 1)) ObjectClass(data);
387   }
388
389   ObjectClass& Add() {
390     return *(ObjectClass*)new ((void*)InsertSpaceAt(m_nSize, 1)) ObjectClass();
391   }
392
393   void* AddSpace() { return InsertSpaceAt(m_nSize, 1); }
394
395   int32_t Append(const CFX_ObjectArray& src,
396                  int32_t nStart = 0,
397                  int32_t nCount = -1) {
398     if (nCount == 0) {
399       return 0;
400     }
401     int32_t nSize = src.GetSize();
402     if (!nSize) {
403       return 0;
404     }
405     FXSYS_assert(nStart > -1 && nStart < nSize);
406     if (nCount < 0) {
407       nCount = nSize;
408     }
409     if (nStart + nCount > nSize) {
410       nCount = nSize - nStart;
411     }
412     if (nCount < 1) {
413       return 0;
414     }
415     nSize = m_nSize;
416     InsertSpaceAt(m_nSize, nCount);
417     ObjectClass* pStartObj = (ObjectClass*)GetDataPtr(nSize);
418     nSize = nStart + nCount;
419     for (int32_t i = nStart; i < nSize; i++, pStartObj++) {
420       new ((void*)pStartObj) ObjectClass(src[i]);
421     }
422     return nCount;
423   }
424
425   int32_t Copy(const CFX_ObjectArray& src,
426                int32_t nStart = 0,
427                int32_t nCount = -1) {
428     if (nCount == 0) {
429       return 0;
430     }
431     int32_t nSize = src.GetSize();
432     if (!nSize) {
433       return 0;
434     }
435     FXSYS_assert(nStart > -1 && nStart < nSize);
436     if (nCount < 0) {
437       nCount = nSize;
438     }
439     if (nStart + nCount > nSize) {
440       nCount = nSize - nStart;
441     }
442     if (nCount < 1) {
443       return 0;
444     }
445     RemoveAll();
446     SetSize(nCount);
447     ObjectClass* pStartObj = (ObjectClass*)m_pData;
448     nSize = nStart + nCount;
449     for (int32_t i = nStart; i < nSize; i++, pStartObj++) {
450       new ((void*)pStartObj) ObjectClass(src[i]);
451     }
452     return nCount;
453   }
454
455   int GetSize() const { return m_nSize; }
456
457   ObjectClass& operator[](int index) const {
458     FXSYS_assert(index < m_nSize);
459     return *(ObjectClass*)CFX_BasicArray::GetDataPtr(index);
460   }
461
462   ObjectClass* GetDataPtr(int index) {
463     return (ObjectClass*)CFX_BasicArray::GetDataPtr(index);
464   }
465
466   void RemoveAt(int index) {
467     FXSYS_assert(index < m_nSize);
468     ((ObjectClass*)GetDataPtr(index))->~ObjectClass();
469     CFX_BasicArray::RemoveAt(index, 1);
470   }
471
472   void RemoveAll() {
473     for (int i = 0; i < m_nSize; i++) {
474       ((ObjectClass*)GetDataPtr(i))->~ObjectClass();
475     }
476     CFX_BasicArray::SetSize(0);
477   }
478 };
479 typedef CFX_ObjectArray<CFX_ByteString> CFX_ByteStringArray;
480 typedef CFX_ObjectArray<CFX_WideString> CFX_WideStringArray;
481 class CFX_BaseSegmentedArray {
482  public:
483   CFX_BaseSegmentedArray(int unit_size = 1,
484                          int segment_units = 512,
485                          int index_size = 8);
486
487   ~CFX_BaseSegmentedArray();
488
489   void SetUnitSize(int unit_size, int segment_units, int index_size = 8);
490
491   void* Add();
492
493   void* GetAt(int index) const;
494
495   void RemoveAll();
496
497   void Delete(int index, int count = 1);
498
499   int GetSize() const { return m_DataSize; }
500
501   int GetSegmentSize() const { return m_SegmentSize; }
502
503   int GetUnitSize() const { return m_UnitSize; }
504
505   void* Iterate(FX_BOOL (*callback)(void* param, void* pData),
506                 void* param) const;
507
508  private:
509   int m_UnitSize;
510
511   short m_SegmentSize;
512
513   uint8_t m_IndexSize;
514
515   uint8_t m_IndexDepth;
516
517   int m_DataSize;
518
519   void* m_pIndex;
520   void** GetIndex(int seg_index) const;
521   void* IterateIndex(int level,
522                      int& start,
523                      void** pIndex,
524                      FX_BOOL (*callback)(void* param, void* pData),
525                      void* param) const;
526   void* IterateSegment(const uint8_t* pSegment,
527                        int count,
528                        FX_BOOL (*callback)(void* param, void* pData),
529                        void* param) const;
530 };
531 template <class ElementType>
532 class CFX_SegmentedArray : public CFX_BaseSegmentedArray {
533  public:
534   CFX_SegmentedArray(int segment_units, int index_size = 8)
535       : CFX_BaseSegmentedArray(sizeof(ElementType), segment_units, index_size) {
536   }
537
538   void Add(ElementType data) {
539     *(ElementType*)CFX_BaseSegmentedArray::Add() = data;
540   }
541
542   ElementType& operator[](int index) {
543     return *(ElementType*)CFX_BaseSegmentedArray::GetAt(index);
544   }
545 };
546 template <class DataType, int FixedSize>
547 class CFX_FixedBufGrow {
548  public:
549   CFX_FixedBufGrow() : m_pData(NULL) {}
550   CFX_FixedBufGrow(int data_size) : m_pData(NULL) {
551     if (data_size > FixedSize) {
552       m_pData = FX_Alloc(DataType, data_size);
553     } else {
554       FXSYS_memset(m_Data, 0, sizeof(DataType) * FixedSize);
555     }
556   }
557   void SetDataSize(int data_size) {
558     FX_Free(m_pData);
559     m_pData = NULL;
560     if (data_size > FixedSize) {
561       m_pData = FX_Alloc(DataType, data_size);
562     } else {
563       FXSYS_memset(m_Data, 0, sizeof(DataType) * FixedSize);
564     }
565   }
566   ~CFX_FixedBufGrow() { FX_Free(m_pData); }
567   operator DataType*() { return m_pData ? m_pData : m_Data; }
568
569  private:
570   DataType m_Data[FixedSize];
571   DataType* m_pData;
572 };
573 class CFX_MapPtrToPtr {
574  protected:
575   struct CAssoc {
576     CAssoc* pNext;
577
578     void* key;
579
580     void* value;
581   };
582
583  public:
584   CFX_MapPtrToPtr(int nBlockSize = 10);
585
586   ~CFX_MapPtrToPtr();
587
588   int GetCount() const { return m_nCount; }
589
590   FX_BOOL IsEmpty() const { return m_nCount == 0; }
591
592   FX_BOOL Lookup(void* key, void*& rValue) const;
593
594   void* GetValueAt(void* key) const;
595
596   void*& operator[](void* key);
597
598   void SetAt(void* key, void* newValue) { (*this)[key] = newValue; }
599
600   FX_BOOL RemoveKey(void* key);
601
602   void RemoveAll();
603
604   FX_POSITION GetStartPosition() const {
605     return (m_nCount == 0) ? NULL : (FX_POSITION)-1;
606   }
607
608   void GetNextAssoc(FX_POSITION& rNextPosition,
609                     void*& rKey,
610                     void*& rValue) const;
611
612   FX_DWORD GetHashTableSize() const { return m_nHashTableSize; }
613
614   void InitHashTable(FX_DWORD hashSize, FX_BOOL bAllocNow = TRUE);
615
616  protected:
617   CAssoc** m_pHashTable;
618
619   FX_DWORD m_nHashTableSize;
620
621   int m_nCount;
622
623   CAssoc* m_pFreeList;
624
625   struct CFX_Plex* m_pBlocks;
626
627   int m_nBlockSize;
628
629   FX_DWORD HashKey(void* key) const;
630
631   CAssoc* NewAssoc();
632
633   void FreeAssoc(CAssoc* pAssoc);
634
635   CAssoc* GetAssocAt(void* key, FX_DWORD& hash) const;
636 };
637
638 class CFX_CMapByteStringToPtr {
639  public:
640   CFX_CMapByteStringToPtr();
641
642   ~CFX_CMapByteStringToPtr();
643
644   void RemoveAll();
645
646   FX_POSITION GetStartPosition() const;
647
648   void GetNextAssoc(FX_POSITION& rNextPosition,
649                     CFX_ByteString& rKey,
650                     void*& rValue) const;
651
652   void* GetNextValue(FX_POSITION& rNextPosition) const;
653
654   FX_BOOL Lookup(const CFX_ByteStringC& key, void*& rValue) const;
655
656   void SetAt(const CFX_ByteStringC& key, void* value);
657
658   void RemoveKey(const CFX_ByteStringC& key);
659
660   int GetCount() const;
661
662   void AddValue(const CFX_ByteStringC& key, void* pValue);
663
664  private:
665   CFX_BaseSegmentedArray m_Buffer;
666 };
667 class CFX_PtrList {
668  protected:
669   struct CNode {
670     CNode* pNext;
671
672     CNode* pPrev;
673
674     void* data;
675   };
676
677  public:
678   CFX_PtrList(int nBlockSize = 10);
679
680   FX_POSITION GetHeadPosition() const { return (FX_POSITION)m_pNodeHead; }
681
682   FX_POSITION GetTailPosition() const { return (FX_POSITION)m_pNodeTail; }
683
684   void* GetNext(FX_POSITION& rPosition) const {
685     CNode* pNode = (CNode*)rPosition;
686     rPosition = (FX_POSITION)pNode->pNext;
687     return pNode->data;
688   }
689
690   void* GetPrev(FX_POSITION& rPosition) const {
691     CNode* pNode = (CNode*)rPosition;
692     rPosition = (FX_POSITION)pNode->pPrev;
693     return pNode->data;
694   }
695
696   FX_POSITION GetNextPosition(FX_POSITION pos) const {
697     return ((CNode*)pos)->pNext;
698   }
699
700   FX_POSITION GetPrevPosition(FX_POSITION pos) const {
701     return ((CNode*)pos)->pPrev;
702   }
703
704   void* GetAt(FX_POSITION rPosition) const {
705     CNode* pNode = (CNode*)rPosition;
706     return pNode->data;
707   }
708
709   int GetCount() const { return m_nCount; }
710
711   FX_POSITION AddTail(void* newElement);
712
713   FX_POSITION AddHead(void* newElement);
714
715   void SetAt(FX_POSITION pos, void* newElement) {
716     CNode* pNode = (CNode*)pos;
717     pNode->data = newElement;
718   }
719
720   FX_POSITION InsertAfter(FX_POSITION pos, void* newElement);
721
722   FX_POSITION Find(void* searchValue, FX_POSITION startAfter = NULL) const;
723
724   FX_POSITION FindIndex(int index) const;
725
726   void RemoveAt(FX_POSITION pos);
727
728   void RemoveAll();
729
730  protected:
731   CNode* m_pNodeHead;
732
733   CNode* m_pNodeTail;
734
735   int m_nCount;
736
737   CNode* m_pNodeFree;
738
739   struct CFX_Plex* m_pBlocks;
740
741   int m_nBlockSize;
742
743   CNode* NewNode(CNode* pPrev, CNode* pNext);
744
745   void FreeNode(CNode* pNode);
746
747  public:
748   ~CFX_PtrList();
749 };
750 typedef void (*PD_CALLBACK_FREEDATA)(void* pData);
751 struct FX_PRIVATEDATA {
752   void FreeData();
753
754   void* m_pModuleId;
755
756   void* m_pData;
757
758   PD_CALLBACK_FREEDATA m_pCallback;
759
760   FX_BOOL m_bSelfDestruct;
761 };
762 class CFX_PrivateData {
763  public:
764   ~CFX_PrivateData();
765
766   void ClearAll();
767
768   void SetPrivateData(void* module_id,
769                       void* pData,
770                       PD_CALLBACK_FREEDATA callback);
771
772   void SetPrivateObj(void* module_id, CFX_DestructObject* pObj);
773
774   void* GetPrivateData(void* module_id);
775
776   FX_BOOL LookupPrivateData(void* module_id, void*& pData) const {
777     if (!module_id) {
778       return FALSE;
779     }
780     FX_DWORD nCount = m_DataList.GetSize();
781     for (FX_DWORD n = 0; n < nCount; n++) {
782       if (m_DataList[n].m_pModuleId == module_id) {
783         pData = m_DataList[n].m_pData;
784         return TRUE;
785       }
786     }
787     return FALSE;
788   }
789
790   FX_BOOL RemovePrivateData(void* module_id);
791
792  protected:
793   CFX_ArrayTemplate<FX_PRIVATEDATA> m_DataList;
794
795   void AddData(void* module_id,
796                void* pData,
797                PD_CALLBACK_FREEDATA callback,
798                FX_BOOL bSelfDestruct);
799 };
800 class CFX_BitStream {
801  public:
802   void Init(const uint8_t* pData, FX_DWORD dwSize);
803
804   FX_DWORD GetBits(FX_DWORD nBits);
805
806   void ByteAlign();
807
808   FX_BOOL IsEOF() { return m_BitPos >= m_BitSize; }
809
810   void SkipBits(FX_DWORD nBits) { m_BitPos += nBits; }
811
812   void Rewind() { m_BitPos = 0; }
813
814  protected:
815   FX_DWORD m_BitPos;
816
817   FX_DWORD m_BitSize;
818
819   const uint8_t* m_pData;
820 };
821 template <class ObjClass>
822 class CFX_CountRef {
823  public:
824   typedef CFX_CountRef<ObjClass> Ref;
825
826   class CountedObj : public ObjClass {
827    public:
828     CountedObj() {}
829
830     CountedObj(const CountedObj& src) : ObjClass(src) {}
831
832     int m_RefCount;
833   };
834
835   CFX_CountRef() { m_pObject = NULL; }
836
837   CFX_CountRef(const Ref& ref) {
838     m_pObject = ref.m_pObject;
839     if (m_pObject) {
840       m_pObject->m_RefCount++;
841     }
842   }
843
844   ~CFX_CountRef() {
845     if (!m_pObject) {
846       return;
847     }
848     m_pObject->m_RefCount--;
849     if (m_pObject->m_RefCount <= 0) {
850       delete m_pObject;
851     }
852   }
853
854   ObjClass* New() {
855     if (m_pObject) {
856       m_pObject->m_RefCount--;
857       if (m_pObject->m_RefCount <= 0) {
858         delete m_pObject;
859       }
860     }
861     m_pObject = new CountedObj;
862     m_pObject->m_RefCount = 1;
863     return m_pObject;
864   }
865
866   void operator=(const Ref& ref) {
867     if (ref.m_pObject) {
868       ref.m_pObject->m_RefCount++;
869     }
870     if (m_pObject) {
871       m_pObject->m_RefCount--;
872       if (m_pObject->m_RefCount <= 0) {
873         delete m_pObject;
874       }
875     }
876     m_pObject = ref.m_pObject;
877   }
878
879   void operator=(void* p) {
880     FXSYS_assert(p == 0);
881     if (m_pObject == NULL) {
882       return;
883     }
884     m_pObject->m_RefCount--;
885     if (m_pObject->m_RefCount <= 0) {
886       delete m_pObject;
887     }
888     m_pObject = NULL;
889   }
890
891   const ObjClass* GetObject() const { return m_pObject; }
892
893   operator const ObjClass*() const { return m_pObject; }
894
895   FX_BOOL IsNull() const { return m_pObject == NULL; }
896
897   FX_BOOL NotNull() const { return m_pObject != NULL; }
898
899   ObjClass* GetModify() {
900     if (m_pObject == NULL) {
901       m_pObject = new CountedObj;
902       m_pObject->m_RefCount = 1;
903     } else if (m_pObject->m_RefCount > 1) {
904       m_pObject->m_RefCount--;
905       CountedObj* pOldObject = m_pObject;
906       m_pObject = new CountedObj(*pOldObject);
907       m_pObject->m_RefCount = 1;
908     }
909     return m_pObject;
910   }
911
912   void SetNull() {
913     if (m_pObject == NULL) {
914       return;
915     }
916     m_pObject->m_RefCount--;
917     if (m_pObject->m_RefCount <= 0) {
918       delete m_pObject;
919     }
920     m_pObject = NULL;
921   }
922
923   FX_BOOL operator==(const Ref& ref) const {
924     return m_pObject == ref.m_pObject;
925   }
926
927  protected:
928   CountedObj* m_pObject;
929 };
930 class IFX_Pause {
931  public:
932   virtual ~IFX_Pause() {}
933   virtual FX_BOOL NeedToPauseNow() = 0;
934 };
935
936 template <typename T>
937 class CFX_AutoRestorer {
938  public:
939   explicit CFX_AutoRestorer(T* location) {
940     m_Location = location;
941     m_OldValue = *location;
942   }
943   ~CFX_AutoRestorer() { *m_Location = m_OldValue; }
944
945  private:
946   T* m_Location;
947   T m_OldValue;
948 };
949
950 template <class T>
951 class CFX_SmartPointer {
952  public:
953   CFX_SmartPointer(T* pObj) : m_pObj(pObj) {}
954   ~CFX_SmartPointer() { m_pObj->Release(); }
955   T* Get(void) { return m_pObj; }
956   T& operator*(void) { return *m_pObj; }
957   T* operator->(void) { return m_pObj; }
958
959  protected:
960   T* m_pObj;
961 };
962 #define FX_DATALIST_LENGTH 1024
963 template <size_t unit>
964 class CFX_SortListArray {
965  protected:
966   struct DataList {
967     int32_t start;
968
969     int32_t count;
970     uint8_t* data;
971   };
972
973  public:
974   CFX_SortListArray() : m_CurList(0) {}
975
976   ~CFX_SortListArray() { Clear(); }
977
978   void Clear() {
979     for (int32_t i = m_DataLists.GetUpperBound(); i >= 0; i--) {
980       DataList list = m_DataLists.ElementAt(i);
981       FX_Free(list.data);
982     }
983     m_DataLists.RemoveAll();
984     m_CurList = 0;
985   }
986
987   void Append(int32_t nStart, int32_t nCount) {
988     if (nStart < 0) {
989       return;
990     }
991     while (nCount > 0) {
992       int32_t temp_count = FX_MIN(nCount, FX_DATALIST_LENGTH);
993       DataList list;
994       list.data = FX_Alloc2D(uint8_t, temp_count, unit);
995       list.start = nStart;
996       list.count = temp_count;
997       Append(list);
998       nCount -= temp_count;
999       nStart += temp_count;
1000     }
1001   }
1002
1003   uint8_t* GetAt(int32_t nIndex) {
1004     if (nIndex < 0) {
1005       return NULL;
1006     }
1007     if (m_CurList < 0 || m_CurList >= m_DataLists.GetSize()) {
1008       return NULL;
1009     }
1010     DataList* pCurList = m_DataLists.GetDataPtr(m_CurList);
1011     if (!pCurList || nIndex < pCurList->start ||
1012         nIndex >= pCurList->start + pCurList->count) {
1013       pCurList = NULL;
1014       int32_t iStart = 0;
1015       int32_t iEnd = m_DataLists.GetUpperBound();
1016       int32_t iMid = 0;
1017       while (iStart <= iEnd) {
1018         iMid = (iStart + iEnd) / 2;
1019         DataList* list = m_DataLists.GetDataPtr(iMid);
1020         if (nIndex < list->start) {
1021           iEnd = iMid - 1;
1022         } else if (nIndex >= list->start + list->count) {
1023           iStart = iMid + 1;
1024         } else {
1025           pCurList = list;
1026           m_CurList = iMid;
1027           break;
1028         }
1029       }
1030     }
1031     return pCurList ? pCurList->data + (nIndex - pCurList->start) * unit : NULL;
1032   }
1033
1034  protected:
1035   void Append(const DataList& list) {
1036     int32_t iStart = 0;
1037     int32_t iEnd = m_DataLists.GetUpperBound();
1038     int32_t iFind = 0;
1039     while (iStart <= iEnd) {
1040       int32_t iMid = (iStart + iEnd) / 2;
1041       DataList* cur_list = m_DataLists.GetDataPtr(iMid);
1042       if (list.start < cur_list->start + cur_list->count) {
1043         iEnd = iMid - 1;
1044       } else {
1045         if (iMid == iEnd) {
1046           iFind = iMid + 1;
1047           break;
1048         }
1049         DataList* next_list = m_DataLists.GetDataPtr(iMid + 1);
1050         if (list.start < next_list->start) {
1051           iFind = iMid + 1;
1052           break;
1053         } else {
1054           iStart = iMid + 1;
1055         }
1056       }
1057     }
1058     m_DataLists.InsertAt(iFind, list);
1059   }
1060   int32_t m_CurList;
1061   CFX_ArrayTemplate<DataList> m_DataLists;
1062 };
1063 template <typename T1, typename T2>
1064 class CFX_ListArrayTemplate {
1065  public:
1066   void Clear() { m_Data.Clear(); }
1067
1068   void Add(int32_t nStart, int32_t nCount) { m_Data.Append(nStart, nCount); }
1069
1070   T2& operator[](int32_t nIndex) {
1071     uint8_t* data = m_Data.GetAt(nIndex);
1072     FXSYS_assert(data != NULL);
1073     return (T2&)(*(volatile T2*)data);
1074   }
1075
1076   T2* GetPtrAt(int32_t nIndex) { return (T2*)m_Data.GetAt(nIndex); }
1077
1078  protected:
1079   T1 m_Data;
1080 };
1081 typedef CFX_ListArrayTemplate<CFX_SortListArray<sizeof(FX_FILESIZE)>,
1082                               FX_FILESIZE> CFX_FileSizeListArray;
1083 typedef CFX_ListArrayTemplate<CFX_SortListArray<sizeof(FX_DWORD)>, FX_DWORD>
1084     CFX_DWordListArray;
1085 typedef enum {
1086   Ready,
1087   ToBeContinued,
1088   Found,
1089   NotFound,
1090   Failed,
1091   Done
1092 } FX_ProgressiveStatus;
1093 #define ProgressiveStatus FX_ProgressiveStatus
1094 #define FX_NAMESPACE_DECLARE(namespace, type) namespace ::type
1095
1096 class CFX_Vector_3by1 {
1097  public:
1098   CFX_Vector_3by1() : a(0.0f), b(0.0f), c(0.0f) {}
1099
1100   CFX_Vector_3by1(FX_FLOAT a1, FX_FLOAT b1, FX_FLOAT c1)
1101       : a(a1), b(b1), c(c1) {}
1102
1103   FX_FLOAT a;
1104   FX_FLOAT b;
1105   FX_FLOAT c;
1106 };
1107 class CFX_Matrix_3by3 {
1108  public:
1109   CFX_Matrix_3by3()
1110       : a(0.0f),
1111         b(0.0f),
1112         c(0.0f),
1113         d(0.0f),
1114         e(0.0f),
1115         f(0.0f),
1116         g(0.0f),
1117         h(0.0f),
1118         i(0.0f) {}
1119
1120   CFX_Matrix_3by3(FX_FLOAT a1,
1121                   FX_FLOAT b1,
1122                   FX_FLOAT c1,
1123                   FX_FLOAT d1,
1124                   FX_FLOAT e1,
1125                   FX_FLOAT f1,
1126                   FX_FLOAT g1,
1127                   FX_FLOAT h1,
1128                   FX_FLOAT i1)
1129       : a(a1), b(b1), c(c1), d(d1), e(e1), f(f1), g(g1), h(h1), i(i1) {}
1130
1131   CFX_Matrix_3by3 Inverse();
1132
1133   CFX_Matrix_3by3 Multiply(const CFX_Matrix_3by3& m);
1134
1135   CFX_Vector_3by1 TransformVector(const CFX_Vector_3by1& v);
1136
1137   FX_FLOAT a;
1138   FX_FLOAT b;
1139   FX_FLOAT c;
1140   FX_FLOAT d;
1141   FX_FLOAT e;
1142   FX_FLOAT f;
1143   FX_FLOAT g;
1144   FX_FLOAT h;
1145   FX_FLOAT i;
1146 };
1147
1148 #endif  // CORE_INCLUDE_FXCRT_FX_BASIC_H_