• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2016 The PDFium Authors
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_FPDFAPI_PAGE_CPDF_PAGEOBJECT_H_
8 #define CORE_FPDFAPI_PAGE_CPDF_PAGEOBJECT_H_
9 
10 #include <stdint.h>
11 
12 #include "core/fpdfapi/page/cpdf_contentmarks.h"
13 #include "core/fpdfapi/page/cpdf_graphicstates.h"
14 #include "core/fxcrt/bytestring.h"
15 #include "core/fxcrt/fx_coordinates.h"
16 
17 class CPDF_FormObject;
18 class CPDF_ImageObject;
19 class CPDF_PathObject;
20 class CPDF_ShadingObject;
21 class CPDF_TextObject;
22 
23 // Represents an object within the page, like a form or image. Not to be
24 // confused with the PDF spec's page object that lives in a page tree, which is
25 // represented by CPDF_Page.
26 class CPDF_PageObject : public CPDF_GraphicStates {
27  public:
28   // Values must match corresponding values in //public.
29   enum class Type {
30     kText = 1,
31     kPath,
32     kImage,
33     kShading,
34     kForm,
35   };
36 
37   static constexpr int32_t kNoContentStream = -1;
38 
39   explicit CPDF_PageObject(int32_t content_stream);
40   CPDF_PageObject(const CPDF_PageObject& src) = delete;
41   CPDF_PageObject& operator=(const CPDF_PageObject& src) = delete;
42   ~CPDF_PageObject() override;
43 
44   virtual Type GetType() const = 0;
45   virtual void Transform(const CFX_Matrix& matrix) = 0;
46   virtual bool IsText() const;
47   virtual bool IsPath() const;
48   virtual bool IsImage() const;
49   virtual bool IsShading() const;
50   virtual bool IsForm() const;
51   virtual CPDF_TextObject* AsText();
52   virtual const CPDF_TextObject* AsText() const;
53   virtual CPDF_PathObject* AsPath();
54   virtual const CPDF_PathObject* AsPath() const;
55   virtual CPDF_ImageObject* AsImage();
56   virtual const CPDF_ImageObject* AsImage() const;
57   virtual CPDF_ShadingObject* AsShading();
58   virtual const CPDF_ShadingObject* AsShading() const;
59   virtual CPDF_FormObject* AsForm();
60   virtual const CPDF_FormObject* AsForm() const;
61 
SetDirty(bool value)62   void SetDirty(bool value) { m_bDirty = value; }
IsDirty()63   bool IsDirty() const { return m_bDirty; }
64   void TransformClipPath(const CFX_Matrix& matrix);
65   void TransformGeneralState(const CFX_Matrix& matrix);
66 
SetOriginalRect(const CFX_FloatRect & rect)67   void SetOriginalRect(const CFX_FloatRect& rect) { m_OriginalRect = rect; }
GetOriginalRect()68   const CFX_FloatRect& GetOriginalRect() const { return m_OriginalRect; }
SetRect(const CFX_FloatRect & rect)69   void SetRect(const CFX_FloatRect& rect) { m_Rect = rect; }
GetRect()70   const CFX_FloatRect& GetRect() const { return m_Rect; }
71   FX_RECT GetBBox() const;
72   FX_RECT GetTransformedBBox(const CFX_Matrix& matrix) const;
73 
GetContentMarks()74   CPDF_ContentMarks* GetContentMarks() { return &m_ContentMarks; }
GetContentMarks()75   const CPDF_ContentMarks* GetContentMarks() const { return &m_ContentMarks; }
SetContentMarks(const CPDF_ContentMarks & marks)76   void SetContentMarks(const CPDF_ContentMarks& marks) {
77     m_ContentMarks = marks;
78   }
79 
80   // Get what content stream the object was parsed from in its page. This number
81   // is the index of the content stream in the "Contents" array, or 0 if there
82   // is a single content stream. If the object is newly created,
83   // |kNoContentStream| is returned.
84   //
85   // If the object is spread among more than one content stream, this is the
86   // index of the last stream.
GetContentStream()87   int32_t GetContentStream() const { return m_ContentStream; }
SetContentStream(int32_t new_content_stream)88   void SetContentStream(int32_t new_content_stream) {
89     m_ContentStream = new_content_stream;
90   }
91 
GetResourceName()92   const ByteString& GetResourceName() const { return m_ResourceName; }
SetResourceName(const ByteString & resource_name)93   void SetResourceName(const ByteString& resource_name) {
94     m_ResourceName = resource_name;
95   }
96 
GetGraphicsResourceName()97   const ByteString& GetGraphicsResourceName() const {
98     return m_GraphicsResourceName;
99   }
SetGraphicsResourceName(const ByteString & resource_name)100   void SetGraphicsResourceName(const ByteString& resource_name) {
101     m_GraphicsResourceName = resource_name;
102   }
103 
104  protected:
105   void CopyData(const CPDF_PageObject* pSrcObject);
106 
107  private:
108   CFX_FloatRect m_Rect;
109   CFX_FloatRect m_OriginalRect;
110   CPDF_ContentMarks m_ContentMarks;
111   bool m_bDirty = false;
112   int32_t m_ContentStream;
113   ByteString m_ResourceName;          // The resource name for this object.
114   ByteString m_GraphicsResourceName;  // Like `m_ResourceName` but for graphics.
115 };
116 
117 #endif  // CORE_FPDFAPI_PAGE_CPDF_PAGEOBJECT_H_
118