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_PARSER_CPDF_ARRAY_H_
8 #define CORE_FPDFAPI_PARSER_CPDF_ARRAY_H_
9
10 #include <stddef.h>
11
12 #include <optional>
13 #include <set>
14 #include <type_traits>
15 #include <utility>
16 #include <vector>
17
18 #include "core/fpdfapi/parser/cpdf_indirect_object_holder.h"
19 #include "core/fpdfapi/parser/cpdf_object.h"
20 #include "core/fxcrt/check.h"
21 #include "core/fxcrt/fx_coordinates.h"
22 #include "core/fxcrt/retain_ptr.h"
23
24 // Arrays never contain nullptrs for objects within bounds, but some of the
25 // methods will tolerate out-of-bounds indices and return nullptr for those
26 // cases.
27 class CPDF_Array final : public CPDF_Object {
28 public:
29 using const_iterator = std::vector<RetainPtr<CPDF_Object>>::const_iterator;
30
31 CONSTRUCT_VIA_MAKE_RETAIN;
32
33 // CPDF_Object:
34 Type GetType() const override;
35 RetainPtr<CPDF_Object> Clone() const override;
36 CPDF_Array* AsMutableArray() override;
37 bool WriteTo(IFX_ArchiveStream* archive,
38 const CPDF_Encryptor* encryptor) const override;
39
IsEmpty()40 bool IsEmpty() const { return m_Objects.empty(); }
size()41 size_t size() const { return m_Objects.size(); }
42
43 // The Get*ObjectAt() methods tolerate out-of-bounds indices and return
44 // nullptr in those cases. Otherwise, for in-bound indices, the result
45 // is never nullptr.
46 RetainPtr<CPDF_Object> GetMutableObjectAt(size_t index);
47 RetainPtr<const CPDF_Object> GetObjectAt(size_t index) const;
48
49 // The Get*DirectObjectAt() methods tolerate out-of-bounds indices and
50 // return nullptr in those cases. Furthermore, for reference objects that
51 // do not correspond to a valid indirect object, nullptr is returned.
52 RetainPtr<CPDF_Object> GetMutableDirectObjectAt(size_t index);
53 RetainPtr<const CPDF_Object> GetDirectObjectAt(size_t index) const;
54
55 // The Get*At() methods tolerate out-of-bounds indices and return nullptr
56 // in those cases. Furthermore, these safely coerce to the sub-class,
57 // returning nullptr if the object at the location is of a different type.
58 ByteString GetByteStringAt(size_t index) const;
59 WideString GetUnicodeTextAt(size_t index) const;
60 bool GetBooleanAt(size_t index, bool bDefault) const;
61 int GetIntegerAt(size_t index) const;
62 float GetFloatAt(size_t index) const;
63 RetainPtr<CPDF_Dictionary> GetMutableDictAt(size_t index);
64 RetainPtr<const CPDF_Dictionary> GetDictAt(size_t index) const;
65 RetainPtr<CPDF_Stream> GetMutableStreamAt(size_t index);
66 RetainPtr<const CPDF_Stream> GetStreamAt(size_t index) const;
67 RetainPtr<CPDF_Array> GetMutableArrayAt(size_t index);
68 RetainPtr<const CPDF_Array> GetArrayAt(size_t index) const;
69 RetainPtr<const CPDF_Number> GetNumberAt(size_t index) const;
70 RetainPtr<const CPDF_String> GetStringAt(size_t index) const;
71
72 CFX_FloatRect GetRect() const;
73 CFX_Matrix GetMatrix() const;
74
75 std::optional<size_t> Find(const CPDF_Object* pThat) const;
76 bool Contains(const CPDF_Object* pThat) const;
77
78 // Creates object owned by the array, and returns a retained pointer to it.
79 // We have special cases for objects that can intern strings from
80 // a ByteStringPool. Prefer using these templates over direct calls
81 // to Append()/SetAt()/InsertAt() since by creating a new object with no
82 // previous references, they ensure cycles can not be introduced.
83 template <typename T, typename... Args>
84 typename std::enable_if<!CanInternStrings<T>::value, RetainPtr<T>>::type
AppendNew(Args &&...args)85 AppendNew(Args&&... args) {
86 static_assert(!std::is_same<T, CPDF_Stream>::value,
87 "Cannot append a CPDF_Stream directly. Add it indirectly as "
88 "a `CPDF_Reference` instead.");
89 return pdfium::WrapRetain(static_cast<T*>(
90 AppendInternal(pdfium::MakeRetain<T>(std::forward<Args>(args)...))));
91 }
92 template <typename T, typename... Args>
93 typename std::enable_if<CanInternStrings<T>::value, RetainPtr<T>>::type
AppendNew(Args &&...args)94 AppendNew(Args&&... args) {
95 return pdfium::WrapRetain(static_cast<T*>(AppendInternal(
96 pdfium::MakeRetain<T>(m_pPool, std::forward<Args>(args)...))));
97 }
98 template <typename T, typename... Args>
99 typename std::enable_if<!CanInternStrings<T>::value, RetainPtr<T>>::type
SetNewAt(size_t index,Args &&...args)100 SetNewAt(size_t index, Args&&... args) {
101 static_assert(!std::is_same<T, CPDF_Stream>::value,
102 "Cannot set a CPDF_Stream directly. Add it indirectly as a "
103 "`CPDF_Reference` instead.");
104 return pdfium::WrapRetain(static_cast<T*>(SetAtInternal(
105 index, pdfium::MakeRetain<T>(std::forward<Args>(args)...))));
106 }
107 template <typename T, typename... Args>
108 typename std::enable_if<CanInternStrings<T>::value, RetainPtr<T>>::type
SetNewAt(size_t index,Args &&...args)109 SetNewAt(size_t index, Args&&... args) {
110 return pdfium::WrapRetain(static_cast<T*>(SetAtInternal(
111 index, pdfium::MakeRetain<T>(m_pPool, std::forward<Args>(args)...))));
112 }
113 template <typename T, typename... Args>
114 typename std::enable_if<!CanInternStrings<T>::value, RetainPtr<T>>::type
InsertNewAt(size_t index,Args &&...args)115 InsertNewAt(size_t index, Args&&... args) {
116 static_assert(!std::is_same<T, CPDF_Stream>::value,
117 "Cannot insert a CPDF_Stream directly. Add it indirectly as "
118 "a `CPDF_Reference` instead.");
119 return pdfium::WrapRetain(static_cast<T*>(InsertAtInternal(
120 index, pdfium::MakeRetain<T>(std::forward<Args>(args)...))));
121 }
122 template <typename T, typename... Args>
123 typename std::enable_if<CanInternStrings<T>::value, RetainPtr<T>>::type
InsertNewAt(size_t index,Args &&...args)124 InsertNewAt(size_t index, Args&&... args) {
125 return pdfium::WrapRetain(static_cast<T*>(InsertAtInternal(
126 index, pdfium::MakeRetain<T>(m_pPool, std::forward<Args>(args)...))));
127 }
128
129 // Adds non-null `object` to the end of the array, growing as appropriate.
130 void Append(RetainPtr<CPDF_Object> object);
131 void Append(RetainPtr<CPDF_Stream> stream) = delete;
132
133 // Overwrites the object at `index` with non-null `object`, if it is
134 // in bounds. Otherwise, `index` is out of bounds, and `object` is
135 // not stored.
136 void SetAt(size_t index, RetainPtr<CPDF_Object> object);
137 void SetAt(size_t index, RetainPtr<CPDF_Stream> stream) = delete;
138
139 // Inserts non-null `object` at `index` and shifts by one position all of the
140 // objects beyond it like std::vector::insert(), if `index` is less than or
141 // equal to the current array size. Otherwise, `index` is out of bounds,
142 // and `object` is not stored.
143 void InsertAt(size_t index, RetainPtr<CPDF_Object> object);
144 void InsertAt(size_t index, RetainPtr<CPDF_Stream> stream) = delete;
145
146 void Clear();
147 void RemoveAt(size_t index);
148 void ConvertToIndirectObjectAt(size_t index,
149 CPDF_IndirectObjectHolder* pHolder);
IsLocked()150 bool IsLocked() const { return !!m_LockCount; }
151
152 private:
153 friend class CPDF_ArrayLocker;
154
155 CPDF_Array();
156 explicit CPDF_Array(const WeakPtr<ByteStringPool>& pPool);
157 ~CPDF_Array() override;
158
159 // No guarantees about result lifetime, use with caution.
160 const CPDF_Object* GetObjectAtInternal(size_t index) const;
161 CPDF_Object* GetMutableObjectAtInternal(size_t index);
162 CPDF_Object* AppendInternal(RetainPtr<CPDF_Object> pObj);
163 CPDF_Object* SetAtInternal(size_t index, RetainPtr<CPDF_Object> pObj);
164 CPDF_Object* InsertAtInternal(size_t index, RetainPtr<CPDF_Object> pObj);
165
166 RetainPtr<CPDF_Object> CloneNonCyclic(
167 bool bDirect,
168 std::set<const CPDF_Object*>* pVisited) const override;
169
170 std::vector<RetainPtr<CPDF_Object>> m_Objects;
171 WeakPtr<ByteStringPool> m_pPool;
172 mutable uint32_t m_LockCount = 0;
173 };
174
175 class CPDF_ArrayLocker {
176 public:
177 FX_STACK_ALLOCATED();
178 using const_iterator = CPDF_Array::const_iterator;
179
180 explicit CPDF_ArrayLocker(const CPDF_Array* pArray);
181 explicit CPDF_ArrayLocker(RetainPtr<CPDF_Array> pArray);
182 explicit CPDF_ArrayLocker(RetainPtr<const CPDF_Array> pArray);
183 ~CPDF_ArrayLocker();
184
begin()185 const_iterator begin() const {
186 CHECK(m_pArray->IsLocked());
187 return m_pArray->m_Objects.begin();
188 }
end()189 const_iterator end() const {
190 CHECK(m_pArray->IsLocked());
191 return m_pArray->m_Objects.end();
192 }
193
194 private:
195 RetainPtr<const CPDF_Array> const m_pArray;
196 };
197
ToArray(CPDF_Object * obj)198 inline CPDF_Array* ToArray(CPDF_Object* obj) {
199 return obj ? obj->AsMutableArray() : nullptr;
200 }
201
ToArray(const CPDF_Object * obj)202 inline const CPDF_Array* ToArray(const CPDF_Object* obj) {
203 return obj ? obj->AsArray() : nullptr;
204 }
205
ToArray(RetainPtr<CPDF_Object> obj)206 inline RetainPtr<CPDF_Array> ToArray(RetainPtr<CPDF_Object> obj) {
207 return RetainPtr<CPDF_Array>(ToArray(obj.Get()));
208 }
209
ToArray(RetainPtr<const CPDF_Object> obj)210 inline RetainPtr<const CPDF_Array> ToArray(RetainPtr<const CPDF_Object> obj) {
211 return RetainPtr<const CPDF_Array>(ToArray(obj.Get()));
212 }
213
214 #endif // CORE_FPDFAPI_PARSER_CPDF_ARRAY_H_
215