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