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