Remove void* ctor from CPDF_Number.
[pdfium.git] / core / include / fpdfapi / fpdf_objects.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_FPDFAPI_FPDF_OBJECTS_H_
8 #define CORE_INCLUDE_FPDFAPI_FPDF_OBJECTS_H_
9
10 #include "../fxcrt/fx_coordinates.h"
11 #include "../fxcrt/fx_system.h"
12
13 class CPDF_Array;
14 class CPDF_Boolean;
15 class CPDF_CryptoHandler;
16 class CPDF_Dictionary;
17 class CPDF_Document;
18 class CPDF_IndirectObjects;
19 class CPDF_Null;
20 class CPDF_Number;
21 class CPDF_Parser;
22 class CPDF_Reference;
23 class CPDF_Stream;
24 class CPDF_StreamAcc;
25 class CPDF_StreamFilter;
26 class CPDF_String;
27 class IFX_FileRead;
28
29 #define PDFOBJ_INVALID 0
30 #define PDFOBJ_BOOLEAN 1
31 #define PDFOBJ_NUMBER 2
32 #define PDFOBJ_STRING 3
33 #define PDFOBJ_NAME 4
34 #define PDFOBJ_ARRAY 5
35 #define PDFOBJ_DICTIONARY 6
36 #define PDFOBJ_STREAM 7
37 #define PDFOBJ_NULL 8
38 #define PDFOBJ_REFERENCE 9
39
40 class CPDF_Object {
41  public:
42   int GetType() const { return m_Type; }
43
44   FX_DWORD GetObjNum() const { return m_ObjNum; }
45
46   FX_DWORD GetGenNum() const { return m_GenNum; }
47
48   FX_BOOL IsIdentical(CPDF_Object* pObj) const;
49
50   CPDF_Object* Clone(FX_BOOL bDirect = FALSE) const;
51
52   CPDF_Object* CloneRef(CPDF_IndirectObjects* pObjs) const;
53
54   CPDF_Object* GetDirect() const;
55
56   void Release();
57
58   CFX_ByteString GetString() const;
59
60   CFX_ByteStringC GetConstString() const;
61
62   CFX_WideString GetUnicodeText(CFX_CharMap* pCharMap = NULL) const;
63   FX_FLOAT GetNumber() const;
64
65   FX_FLOAT GetNumber16() const;
66
67   int GetInteger() const;
68
69   CPDF_Dictionary* GetDict() const;
70
71   CPDF_Array* GetArray() const;
72
73   void SetString(const CFX_ByteString& str);
74
75   void SetUnicodeText(const FX_WCHAR* pUnicodes, int len = -1);
76
77   int GetDirectType() const;
78
79   FX_BOOL IsModified() const { return FALSE; }
80
81   bool IsBoolean() const { return m_Type == PDFOBJ_BOOLEAN; }
82   bool IsDictionary() const { return m_Type == PDFOBJ_DICTIONARY; }
83
84   CPDF_Boolean* AsBoolean();
85   const CPDF_Boolean* AsBoolean() const;
86
87   CPDF_Dictionary* AsDictionary();
88   const CPDF_Dictionary* AsDictionary() const;
89
90  protected:
91   CPDF_Object(FX_DWORD type) : m_Type(type), m_ObjNum(0), m_GenNum(0) {}
92   ~CPDF_Object() {}
93   void Destroy();
94
95   static const int OBJECT_REF_MAX_DEPTH = 128;
96   static int s_nCurRefDepth;
97   FX_DWORD m_Type;
98   FX_DWORD m_ObjNum;
99   FX_DWORD m_GenNum;
100
101   friend class CPDF_IndirectObjects;
102   friend class CPDF_Parser;
103   friend class CPDF_SyntaxParser;
104
105  private:
106   CPDF_Object(const CPDF_Object& src) {}
107   CPDF_Object* CloneInternal(FX_BOOL bDirect, CFX_MapPtrToPtr* visited) const;
108 };
109 class CPDF_Boolean : public CPDF_Object {
110  public:
111   static CPDF_Boolean* Create(FX_BOOL value) { return new CPDF_Boolean(value); }
112
113   CPDF_Boolean() : CPDF_Object(PDFOBJ_BOOLEAN), m_bValue(false) {}
114   CPDF_Boolean(FX_BOOL value) : CPDF_Object(PDFOBJ_BOOLEAN), m_bValue(value) {}
115
116   FX_BOOL Identical(CPDF_Boolean* pOther) const {
117     return m_bValue == pOther->m_bValue;
118   }
119
120  protected:
121   FX_BOOL m_bValue;
122   friend class CPDF_Object;
123 };
124 inline CPDF_Boolean* ToBoolean(CPDF_Object* obj) {
125   return obj ? obj->AsBoolean() : nullptr;
126 }
127 inline const CPDF_Boolean* ToBoolean(const CPDF_Object* obj) {
128   return obj ? obj->AsBoolean() : nullptr;
129 }
130
131 class CPDF_Number : public CPDF_Object {
132  public:
133   static CPDF_Number* Create(int value) { return new CPDF_Number(value); }
134
135   static CPDF_Number* Create(FX_FLOAT value) { return new CPDF_Number(value); }
136
137   static CPDF_Number* Create(const CFX_ByteStringC& str) {
138     return new CPDF_Number(str);
139   }
140
141   CPDF_Number() : CPDF_Object(PDFOBJ_NUMBER), m_bInteger(TRUE), m_Integer(0) {}
142
143   CPDF_Number(int value);
144
145   CPDF_Number(FX_FLOAT value);
146
147   CPDF_Number(const CFX_ByteStringC& str);
148
149   FX_BOOL Identical(CPDF_Number* pOther) const;
150
151   CFX_ByteString GetString() const;
152
153   void SetString(const CFX_ByteStringC& str);
154
155   FX_BOOL IsInteger() const { return m_bInteger; }
156
157   int GetInteger() const { return m_bInteger ? m_Integer : (int)m_Float; }
158
159   FX_FLOAT GetNumber() const {
160     return m_bInteger ? (FX_FLOAT)m_Integer : m_Float;
161   }
162
163   void SetNumber(FX_FLOAT value);
164
165   FX_FLOAT GetNumber16() const { return GetNumber(); }
166
167   FX_FLOAT GetFloat() const {
168     return m_bInteger ? (FX_FLOAT)m_Integer : m_Float;
169   }
170
171  protected:
172   FX_BOOL m_bInteger;
173
174   union {
175     int m_Integer;
176
177     FX_FLOAT m_Float;
178   };
179   friend class CPDF_Object;
180 };
181 class CPDF_String : public CPDF_Object {
182  public:
183   static CPDF_String* Create(const CFX_ByteString& str, FX_BOOL bHex = FALSE) {
184     return new CPDF_String(str, bHex);
185   }
186
187   static CPDF_String* Create(const CFX_WideString& str) {
188     return new CPDF_String(str);
189   }
190
191   CPDF_String() : CPDF_Object(PDFOBJ_STRING), m_bHex(FALSE) {}
192
193   CPDF_String(const CFX_ByteString& str, FX_BOOL bHex = FALSE)
194       : CPDF_Object(PDFOBJ_STRING), m_String(str), m_bHex(bHex) {}
195
196   CPDF_String(const CFX_WideString& str);
197
198   CFX_ByteString& GetString() { return m_String; }
199
200   FX_BOOL Identical(CPDF_String* pOther) const {
201     return m_String == pOther->m_String;
202   }
203
204   FX_BOOL IsHex() const { return m_bHex; }
205
206  protected:
207   CFX_ByteString m_String;
208
209   FX_BOOL m_bHex;
210   friend class CPDF_Object;
211 };
212 class CPDF_Name : public CPDF_Object {
213  public:
214   static CPDF_Name* Create(const CFX_ByteString& str) {
215     return new CPDF_Name(str);
216   }
217
218   static CPDF_Name* Create(const CFX_ByteStringC& str) {
219     return new CPDF_Name(str);
220   }
221
222   static CPDF_Name* Create(const FX_CHAR* str) { return new CPDF_Name(str); }
223
224   CPDF_Name(const CFX_ByteString& str)
225       : CPDF_Object(PDFOBJ_NAME), m_Name(str) {}
226   CPDF_Name(const CFX_ByteStringC& str)
227       : CPDF_Object(PDFOBJ_NAME), m_Name(str) {}
228   CPDF_Name(const FX_CHAR* str) : CPDF_Object(PDFOBJ_NAME), m_Name(str) {}
229
230   CFX_ByteString& GetString() { return m_Name; }
231
232   FX_BOOL Identical(CPDF_Name* pOther) const {
233     return m_Name == pOther->m_Name;
234   }
235
236  protected:
237   CFX_ByteString m_Name;
238   friend class CPDF_Object;
239 };
240 class CPDF_Array : public CPDF_Object {
241  public:
242   static CPDF_Array* Create() { return new CPDF_Array(); }
243
244   CPDF_Array() : CPDF_Object(PDFOBJ_ARRAY) {}
245
246   FX_DWORD GetCount() const { return m_Objects.GetSize(); }
247
248   CPDF_Object* GetElement(FX_DWORD index) const;
249
250   CPDF_Object* GetElementValue(FX_DWORD index) const;
251
252   CFX_AffineMatrix GetMatrix();
253
254   CFX_FloatRect GetRect();
255
256   CFX_ByteString GetString(FX_DWORD index) const;
257
258   CFX_ByteStringC GetConstString(FX_DWORD index) const;
259
260   int GetInteger(FX_DWORD index) const;
261
262   FX_FLOAT GetNumber(FX_DWORD index) const;
263
264   CPDF_Dictionary* GetDict(FX_DWORD index) const;
265
266   CPDF_Stream* GetStream(FX_DWORD index) const;
267
268   CPDF_Array* GetArray(FX_DWORD index) const;
269
270   FX_FLOAT GetFloat(FX_DWORD index) const { return GetNumber(index); }
271
272   void SetAt(FX_DWORD index,
273              CPDF_Object* pObj,
274              CPDF_IndirectObjects* pObjs = NULL);
275
276   void InsertAt(FX_DWORD index,
277                 CPDF_Object* pObj,
278                 CPDF_IndirectObjects* pObjs = NULL);
279
280   void RemoveAt(FX_DWORD index);
281
282   void Add(CPDF_Object* pObj, CPDF_IndirectObjects* pObjs = NULL);
283
284   void AddNumber(FX_FLOAT f);
285
286   void AddInteger(int i);
287
288   void AddString(const CFX_ByteString& str);
289
290   void AddName(const CFX_ByteString& str);
291
292   void AddReference(CPDF_IndirectObjects* pDoc, FX_DWORD objnum);
293
294   void AddReference(CPDF_IndirectObjects* pDoc, CPDF_Object* obj) {
295     AddReference(pDoc, obj->GetObjNum());
296   }
297
298   FX_FLOAT GetNumber16(FX_DWORD index) const { return GetNumber(index); }
299
300   void AddNumber16(FX_FLOAT value) { AddNumber(value); }
301
302   FX_BOOL Identical(CPDF_Array* pOther) const;
303
304  protected:
305   ~CPDF_Array();
306
307   CFX_PtrArray m_Objects;
308   friend class CPDF_Object;
309 };
310 class CPDF_Dictionary : public CPDF_Object {
311  public:
312   static CPDF_Dictionary* Create() { return new CPDF_Dictionary(); }
313
314   CPDF_Dictionary() : CPDF_Object(PDFOBJ_DICTIONARY) {}
315
316   CPDF_Object* GetElement(const CFX_ByteStringC& key) const;
317
318   CPDF_Object* GetElementValue(const CFX_ByteStringC& key) const;
319
320   CFX_ByteString GetString(const CFX_ByteStringC& key) const;
321
322   CFX_ByteStringC GetConstString(const CFX_ByteStringC& key) const;
323
324   CFX_ByteString GetString(const CFX_ByteStringC& key,
325                            const CFX_ByteStringC& default_str) const;
326
327   CFX_ByteStringC GetConstString(const CFX_ByteStringC& key,
328                                  const CFX_ByteStringC& default_str) const;
329
330   CFX_WideString GetUnicodeText(const CFX_ByteStringC& key,
331                                 CFX_CharMap* pCharMap = NULL) const;
332
333   int GetInteger(const CFX_ByteStringC& key) const;
334
335   int GetInteger(const CFX_ByteStringC& key, int default_int) const;
336
337   FX_BOOL GetBoolean(const CFX_ByteStringC& key,
338                      FX_BOOL bDefault = FALSE) const;
339
340   FX_FLOAT GetNumber(const CFX_ByteStringC& key) const;
341
342   CPDF_Dictionary* GetDict(const CFX_ByteStringC& key) const;
343
344   CPDF_Stream* GetStream(const CFX_ByteStringC& key) const;
345
346   CPDF_Array* GetArray(const CFX_ByteStringC& key) const;
347
348   CFX_FloatRect GetRect(const CFX_ByteStringC& key) const;
349
350   CFX_AffineMatrix GetMatrix(const CFX_ByteStringC& key) const;
351
352   FX_FLOAT GetFloat(const CFX_ByteStringC& key) const { return GetNumber(key); }
353
354   FX_BOOL KeyExist(const CFX_ByteStringC& key) const;
355
356   FX_POSITION GetStartPos() const;
357
358   CPDF_Object* GetNextElement(FX_POSITION& pos, CFX_ByteString& key) const;
359
360   void SetAt(const CFX_ByteStringC& key,
361              CPDF_Object* pObj,
362              CPDF_IndirectObjects* pObjs = NULL);
363
364   void SetAtName(const CFX_ByteStringC& key, const CFX_ByteString& name);
365
366   void SetAtString(const CFX_ByteStringC& key, const CFX_ByteString& string);
367
368   void SetAtInteger(const CFX_ByteStringC& key, int i);
369
370   void SetAtNumber(const CFX_ByteStringC& key, FX_FLOAT f);
371
372   void SetAtReference(const CFX_ByteStringC& key,
373                       CPDF_IndirectObjects* pDoc,
374                       FX_DWORD objnum);
375
376   void SetAtReference(const CFX_ByteStringC& key,
377                       CPDF_IndirectObjects* pDoc,
378                       CPDF_Object* obj) {
379     SetAtReference(key, pDoc, obj->GetObjNum());
380   }
381
382   void AddReference(const CFX_ByteStringC& key,
383                     CPDF_IndirectObjects* pDoc,
384                     FX_DWORD objnum);
385
386   void AddReference(const CFX_ByteStringC& key,
387                     CPDF_IndirectObjects* pDoc,
388                     CPDF_Object* obj) {
389     AddReference(key, pDoc, obj->GetObjNum());
390   }
391
392   void SetAtRect(const CFX_ByteStringC& key, const CFX_FloatRect& rect);
393
394   void SetAtMatrix(const CFX_ByteStringC& key, const CFX_AffineMatrix& matrix);
395
396   void SetAtBoolean(const CFX_ByteStringC& key, FX_BOOL bValue);
397
398   void RemoveAt(const CFX_ByteStringC& key);
399
400   void ReplaceKey(const CFX_ByteStringC& oldkey, const CFX_ByteStringC& newkey);
401
402   FX_BOOL Identical(CPDF_Dictionary* pDict) const;
403
404   int GetCount() const { return m_Map.GetCount(); }
405
406   void AddValue(const CFX_ByteStringC& key, CPDF_Object* pObj);
407
408  protected:
409   ~CPDF_Dictionary();
410
411   CFX_CMapByteStringToPtr m_Map;
412
413   friend class CPDF_Object;
414 };
415 inline CPDF_Dictionary* ToDictionary(CPDF_Object* obj) {
416   return obj ? obj->AsDictionary() : nullptr;
417 }
418 inline const CPDF_Dictionary* ToDictionary(const CPDF_Object* obj) {
419   return obj ? obj->AsDictionary() : nullptr;
420 }
421
422 class CPDF_Stream : public CPDF_Object {
423  public:
424   static CPDF_Stream* Create(uint8_t* pData,
425                              FX_DWORD size,
426                              CPDF_Dictionary* pDict) {
427     return new CPDF_Stream(pData, size, pDict);
428   }
429
430   CPDF_Stream(uint8_t* pData, FX_DWORD size, CPDF_Dictionary* pDict);
431
432   CPDF_Dictionary* GetDict() const { return m_pDict; }
433
434   void SetData(const uint8_t* pData,
435                FX_DWORD size,
436                FX_BOOL bCompressed,
437                FX_BOOL bKeepBuf);
438
439   void InitStream(uint8_t* pData, FX_DWORD size, CPDF_Dictionary* pDict);
440
441   void InitStream(IFX_FileRead* pFile, CPDF_Dictionary* pDict);
442
443   FX_BOOL Identical(CPDF_Stream* pOther) const;
444
445   FX_DWORD GetRawSize() const { return m_dwSize; }
446
447   FX_BOOL ReadRawData(FX_FILESIZE start_pos,
448                       uint8_t* pBuf,
449                       FX_DWORD buf_size) const;
450
451   FX_BOOL IsMemoryBased() const { return m_GenNum == (FX_DWORD)-1; }
452
453  protected:
454   ~CPDF_Stream();
455
456   CPDF_Dictionary* m_pDict;
457
458   FX_DWORD m_dwSize;
459
460   FX_DWORD m_GenNum;
461
462   union {
463     uint8_t* m_pDataBuf;
464
465     IFX_FileRead* m_pFile;
466   };
467
468   FX_FILESIZE m_FileOffset;
469
470   CPDF_CryptoHandler* m_pCryptoHandler;
471
472   void InitStream(CPDF_Dictionary* pDict);
473   friend class CPDF_Object;
474   friend class CPDF_StreamAcc;
475   friend class CPDF_AttachmentAcc;
476 };
477 class CPDF_StreamAcc {
478  public:
479   CPDF_StreamAcc();
480
481   ~CPDF_StreamAcc();
482
483   void LoadAllData(const CPDF_Stream* pStream,
484                    FX_BOOL bRawAccess = FALSE,
485                    FX_DWORD estimated_size = 0,
486                    FX_BOOL bImageAcc = FALSE);
487
488   const CPDF_Stream* GetStream() const { return m_pStream; }
489
490   CPDF_Dictionary* GetDict() const {
491     return m_pStream ? m_pStream->GetDict() : NULL;
492   }
493
494   const uint8_t* GetData() const;
495
496   FX_DWORD GetSize() const;
497
498   uint8_t* DetachData();
499
500   const CFX_ByteString& GetImageDecoder() { return m_ImageDecoder; }
501
502   const CPDF_Dictionary* GetImageParam() { return m_pImageParam; }
503
504  protected:
505   uint8_t* m_pData;
506
507   FX_DWORD m_dwSize;
508
509   FX_BOOL m_bNewBuf;
510
511   CFX_ByteString m_ImageDecoder;
512
513   CPDF_Dictionary* m_pImageParam;
514
515   const CPDF_Stream* m_pStream;
516
517   uint8_t* m_pSrcData;
518 };
519
520 class CPDF_Null : public CPDF_Object {
521  public:
522   static CPDF_Null* Create() { return new CPDF_Null(); }
523
524   CPDF_Null() : CPDF_Object(PDFOBJ_NULL) {}
525 };
526 class CPDF_Reference : public CPDF_Object {
527  public:
528   CPDF_Reference(CPDF_IndirectObjects* pDoc, int objnum)
529       : CPDF_Object(PDFOBJ_REFERENCE), m_pObjList(pDoc), m_RefObjNum(objnum) {}
530
531   CPDF_IndirectObjects* GetObjList() const { return m_pObjList; }
532
533   FX_DWORD GetRefObjNum() const { return m_RefObjNum; }
534
535   void SetRef(CPDF_IndirectObjects* pDoc, FX_DWORD objnum);
536
537   FX_BOOL Identical(CPDF_Reference* pOther) const {
538     return m_RefObjNum == pOther->m_RefObjNum;
539   }
540
541  protected:
542   CPDF_IndirectObjects* m_pObjList;
543
544   FX_DWORD m_RefObjNum;
545   friend class CPDF_Object;
546 };
547 class CPDF_IndirectObjects {
548  public:
549   CPDF_IndirectObjects(CPDF_Parser* pParser);
550
551   ~CPDF_IndirectObjects();
552
553   CPDF_Object* GetIndirectObject(FX_DWORD objnum,
554                                  struct PARSE_CONTEXT* pContext = NULL);
555
556   int GetIndirectType(FX_DWORD objnum);
557
558   FX_DWORD AddIndirectObject(CPDF_Object* pObj);
559
560   void ReleaseIndirectObject(FX_DWORD objnum);
561
562   void InsertIndirectObject(FX_DWORD objnum, CPDF_Object* pObj);
563
564   FX_DWORD GetLastObjNum() const;
565
566   FX_POSITION GetStartPosition() const {
567     return m_IndirectObjs.GetStartPosition();
568   }
569
570   void GetNextAssoc(FX_POSITION& rPos,
571                     FX_DWORD& objnum,
572                     CPDF_Object*& pObject) const {
573     m_IndirectObjs.GetNextAssoc(rPos, (void*&)objnum, (void*&)pObject);
574   }
575
576  protected:
577   CFX_MapPtrToPtr m_IndirectObjs;
578
579   CPDF_Parser* m_pParser;
580
581   FX_DWORD m_LastObjNum;
582 };
583
584 #endif  // CORE_INCLUDE_FPDFAPI_FPDF_OBJECTS_H_