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