1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
// Copyright 2016 PDFium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
#ifndef CORE_FPDFAPI_PARSER_CPDF_DICTIONARY_H_
#define CORE_FPDFAPI_PARSER_CPDF_DICTIONARY_H_
#include <map>
#include <set>
#include <utility>
#include <vector>
#include "core/fpdfapi/parser/cpdf_object.h"
#include "core/fxcrt/fx_coordinates.h"
#include "core/fxcrt/fx_string.h"
#include "core/fxcrt/retain_ptr.h"
#include "core/fxcrt/string_pool_template.h"
#include "core/fxcrt/weak_ptr.h"
#include "third_party/base/check.h"
class CPDF_IndirectObjectHolder;
// Dictionaries never contain nullptr for valid keys, but some of the methods
// will return nullptr to indicate non-existent keys.
class CPDF_Dictionary final : public CPDF_Object {
public:
using DictMap = std::map<ByteString, RetainPtr<CPDF_Object>>;
using const_iterator = DictMap::const_iterator;
CONSTRUCT_VIA_MAKE_RETAIN;
// CPDF_Object:
Type GetType() const override;
RetainPtr<CPDF_Object> Clone() const override;
CPDF_Dictionary* GetDict() override;
const CPDF_Dictionary* GetDict() const override;
bool IsDictionary() const override;
CPDF_Dictionary* AsDictionary() override;
const CPDF_Dictionary* AsDictionary() const override;
bool WriteTo(IFX_ArchiveStream* archive,
const CPDF_Encryptor* encryptor) const override;
bool IsLocked() const { return !!m_LockCount; }
size_t size() const { return m_Map.size(); }
const CPDF_Object* GetObjectFor(const ByteString& key) const;
CPDF_Object* GetObjectFor(const ByteString& key);
const CPDF_Object* GetDirectObjectFor(const ByteString& key) const;
CPDF_Object* GetDirectObjectFor(const ByteString& key);
// These will return the string representation of the object specified by
// |key|, for any object type that has a string representation.
ByteString GetStringFor(const ByteString& key) const;
ByteString GetStringFor(const ByteString& key,
const ByteString& default_str) const;
WideString GetUnicodeTextFor(const ByteString& key) const;
// This will only return the string representation of a name object specified
// by |key|. Useful when the PDF spec requires the value to be an object of
// type name. i.e. /Foo and not (Foo).
ByteString GetNameFor(const ByteString& key) const;
bool GetBooleanFor(const ByteString& key, bool bDefault) const;
int GetIntegerFor(const ByteString& key) const;
int GetIntegerFor(const ByteString& key, int default_int) const;
float GetNumberFor(const ByteString& key) const;
const CPDF_Dictionary* GetDictFor(const ByteString& key) const;
CPDF_Dictionary* GetDictFor(const ByteString& key); // Prefer next form.
RetainPtr<CPDF_Dictionary> GetMutableDictFor(const ByteString& key);
const CPDF_Array* GetArrayFor(const ByteString& key) const;
CPDF_Array* GetArrayFor(const ByteString& key); // Prefer next form.
RetainPtr<CPDF_Array> GetMutableArrayFor(const ByteString& key);
const CPDF_Stream* GetStreamFor(const ByteString& key) const;
CPDF_Stream* GetStreamFor(const ByteString& key);
CFX_FloatRect GetRectFor(const ByteString& key) const;
CFX_Matrix GetMatrixFor(const ByteString& key) const;
bool KeyExist(const ByteString& key) const;
std::vector<ByteString> GetKeys() const;
// Creates a new object owned by the dictionary and returns an unowned
// pointer to it. Invalidates iterators for the element with the key |key|.
// Prefer using these templates over calls to SetFor(), since by creating
// a new object with no previous references, they ensure cycles can not be
// introduced.
template <typename T, typename... Args>
typename std::enable_if<!CanInternStrings<T>::value, T*>::type SetNewFor(
const ByteString& key,
Args&&... args) {
return static_cast<T*>(
SetFor(key, pdfium::MakeRetain<T>(std::forward<Args>(args)...)));
}
template <typename T, typename... Args>
typename std::enable_if<CanInternStrings<T>::value, T*>::type SetNewFor(
const ByteString& key,
Args&&... args) {
return static_cast<T*>(SetFor(
key, pdfium::MakeRetain<T>(m_pPool, std::forward<Args>(args)...)));
}
// If |pObj| is null, then |key| is erased from the map. Otherwise, takes
// ownership of |pObj|, returns an unowned pointer to it. Invalidates
// iterators for the element with the key |key|.
CPDF_Object* SetFor(const ByteString& key, RetainPtr<CPDF_Object> pObj);
// Convenience functions to convert native objects to array form.
void SetRectFor(const ByteString& key, const CFX_FloatRect& rect);
void SetMatrixFor(const ByteString& key, const CFX_Matrix& matrix);
void ConvertToIndirectObjectFor(const ByteString& key,
CPDF_IndirectObjectHolder* pHolder);
// Invalidates iterators for the element with the key |key|.
RetainPtr<CPDF_Object> RemoveFor(const ByteString& key);
// Invalidates iterators for the element with the key |oldkey|.
void ReplaceKey(const ByteString& oldkey, const ByteString& newkey);
WeakPtr<ByteStringPool> GetByteStringPool() const { return m_pPool; }
private:
friend class CPDF_DictionaryLocker;
CPDF_Dictionary();
explicit CPDF_Dictionary(const WeakPtr<ByteStringPool>& pPool);
~CPDF_Dictionary() override;
ByteString MaybeIntern(const ByteString& str);
RetainPtr<CPDF_Object> CloneNonCyclic(
bool bDirect,
std::set<const CPDF_Object*>* visited) const override;
mutable uint32_t m_LockCount = 0;
WeakPtr<ByteStringPool> m_pPool;
DictMap m_Map;
};
class CPDF_DictionaryLocker {
public:
FX_STACK_ALLOCATED();
using const_iterator = CPDF_Dictionary::const_iterator;
explicit CPDF_DictionaryLocker(const CPDF_Dictionary* pDictionary);
~CPDF_DictionaryLocker();
const_iterator begin() const {
CHECK(m_pDictionary->IsLocked());
return m_pDictionary->m_Map.begin();
}
const_iterator end() const {
CHECK(m_pDictionary->IsLocked());
return m_pDictionary->m_Map.end();
}
private:
RetainPtr<const CPDF_Dictionary> const m_pDictionary;
};
inline CPDF_Dictionary* ToDictionary(CPDF_Object* obj) {
return obj ? obj->AsDictionary() : nullptr;
}
inline const CPDF_Dictionary* ToDictionary(const CPDF_Object* obj) {
return obj ? obj->AsDictionary() : nullptr;
}
inline RetainPtr<CPDF_Dictionary> ToDictionary(RetainPtr<CPDF_Object> obj) {
return RetainPtr<CPDF_Dictionary>(ToDictionary(obj.Get()));
}
#endif // CORE_FPDFAPI_PARSER_CPDF_DICTIONARY_H_
|
