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 #include "core/fxcrt/span.h" 17 18 class CPDF_FormObject; 19 class CPDF_ImageObject; 20 class CPDF_PathObject; 21 class CPDF_ShadingObject; 22 class CPDF_TextObject; 23 24 // Represents an object within the page, like a form or image. Not to be 25 // confused with the PDF spec's page object that lives in a page tree, which is 26 // represented by CPDF_Page. 27 class CPDF_PageObject { 28 public: 29 // Values must match corresponding values in //public. 30 enum class Type { 31 kText = 1, 32 kPath, 33 kImage, 34 kShading, 35 kForm, 36 }; 37 38 static constexpr int32_t kNoContentStream = -1; 39 40 explicit CPDF_PageObject(int32_t content_stream); 41 CPDF_PageObject(const CPDF_PageObject& src) = delete; 42 CPDF_PageObject& operator=(const CPDF_PageObject& src) = delete; 43 virtual ~CPDF_PageObject(); 44 45 virtual Type GetType() const = 0; 46 virtual void Transform(const CFX_Matrix& matrix) = 0; 47 virtual bool IsText() const; 48 virtual bool IsPath() const; 49 virtual bool IsImage() const; 50 virtual bool IsShading() const; 51 virtual bool IsForm() const; 52 virtual CPDF_TextObject* AsText(); 53 virtual const CPDF_TextObject* AsText() const; 54 virtual CPDF_PathObject* AsPath(); 55 virtual const CPDF_PathObject* AsPath() const; 56 virtual CPDF_ImageObject* AsImage(); 57 virtual const CPDF_ImageObject* AsImage() const; 58 virtual CPDF_ShadingObject* AsShading(); 59 virtual const CPDF_ShadingObject* AsShading() const; 60 virtual CPDF_FormObject* AsForm(); 61 virtual const CPDF_FormObject* AsForm() const; 62 SetDirty(bool value)63 void SetDirty(bool value) { m_bDirty = value; } IsDirty()64 bool IsDirty() const { return m_bDirty; } 65 void SetIsActive(bool value); IsActive()66 bool IsActive() const { return m_bIsActive; } 67 void TransformClipPath(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 clip_path()101 const CPDF_ClipPath& clip_path() const { return m_GraphicStates.clip_path(); } mutable_clip_path()102 CPDF_ClipPath& mutable_clip_path() { 103 return m_GraphicStates.mutable_clip_path(); 104 } 105 graph_state()106 const CFX_GraphState& graph_state() const { 107 return m_GraphicStates.graph_state(); 108 } mutable_graph_state()109 CFX_GraphState& mutable_graph_state() { 110 return m_GraphicStates.mutable_graph_state(); 111 } 112 color_state()113 const CPDF_ColorState& color_state() const { 114 return m_GraphicStates.color_state(); 115 } mutable_color_state()116 CPDF_ColorState& mutable_color_state() { 117 return m_GraphicStates.mutable_color_state(); 118 } 119 text_state()120 const CPDF_TextState& text_state() const { 121 return m_GraphicStates.text_state(); 122 } mutable_text_state()123 CPDF_TextState& mutable_text_state() { 124 return m_GraphicStates.mutable_text_state(); 125 } 126 general_state()127 const CPDF_GeneralState& general_state() const { 128 return m_GraphicStates.general_state(); 129 } mutable_general_state()130 CPDF_GeneralState& mutable_general_state() { 131 return m_GraphicStates.mutable_general_state(); 132 } 133 graphic_states()134 const CPDF_GraphicStates& graphic_states() const { return m_GraphicStates; } 135 136 void SetDefaultStates(); 137 138 protected: 139 void CopyData(const CPDF_PageObject* pSrcObject); 140 141 private: 142 CPDF_GraphicStates m_GraphicStates; 143 CFX_FloatRect m_Rect; 144 CFX_FloatRect m_OriginalRect; 145 CPDF_ContentMarks m_ContentMarks; 146 // Modifying `m_bIsActive` automatically set `m_bDirty` to be true, but 147 // otherwise `m_bDirty` and `m_bIsActive` are independent. A 148 // `CPDF_PageObject` can remain dirty until page object processing completes 149 // and marks it no longer dirty. 150 bool m_bDirty = false; 151 bool m_bIsActive = true; 152 int32_t m_ContentStream; 153 // The resource name for this object. 154 ByteString m_ResourceName; 155 }; 156 157 #endif // CORE_FPDFAPI_PAGE_CPDF_PAGEOBJECT_H_ 158