5#include "public/fpdf_structtree.h"
9#include "core/fpdfapi/page/cpdf_page.h"
10#include "core/fpdfapi/parser/cpdf_array.h"
11#include "core/fpdfapi/parser/cpdf_dictionary.h"
12#include "core/fpdfdoc/cpdf_structelement.h"
13#include "core/fpdfdoc/cpdf_structtree.h"
14#include "core/fxcrt/fx_safe_types.h"
15#include "core/fxcrt/stl_util.h"
16#include "fpdfsdk/cpdfsdk_helpers.h"
17#include "third_party/base/numerics/safe_conversions.h"
21unsigned long WideStringToBuffer(
const WideString& str,
23 unsigned long buflen) {
30int GetMcidFromDict(
const CPDF_Dictionary* dict) {
33 if (obj && obj->IsNumber())
34 return obj->GetInteger();
48 return FPDFStructTreeFromCPDFStructTree(
55 std::unique_ptr<CPDF_StructTree>(
56 CPDFStructTreeFromFPDFStructTree(struct_tree));
65 FX_SAFE_INT32 tmp_size = tree->CountTopElements();
66 return tmp_size.ValueOrDefault(-1);
72 if (!tree || index < 0 ||
73 static_cast<size_t>(index) >= tree->CountTopElements()) {
76 return FPDFStructElementFromCPDFStructElement(
77 tree->GetTopElement(
static_cast<size_t>(index)));
83 unsigned long buflen) {
84 CPDF_StructElement* elem =
86 return elem ? WideStringToBuffer(elem
->GetAltText(), buffer, buflen) : 0;
92 unsigned long buflen) {
93 CPDF_StructElement* elem =
101 unsigned long buflen) {
102 CPDF_StructElement* elem =
106 absl::optional<WideString> id = elem->GetID();
109 return Utf16EncodeMaybeCopyAndReturnLength(id.value(), buffer, buflen);
115 unsigned long buflen) {
116 CPDF_StructElement* elem =
120 absl::optional<WideString> lang = elem->GetLang();
121 if (!lang.has_value())
123 return Utf16EncodeMaybeCopyAndReturnLength(lang.value(), buffer, buflen);
128 CPDF_StructElement* elem =
136 attr_obj = attr_obj->GetDirect();
139 if (attr_obj->IsArray())
140 return fxcrt::CollectionSize<
int>(*attr_obj->AsArray());
141 return attr_obj->IsDictionary() ? 1 : -1;
147 CPDF_StructElement* elem =
156 attr_obj = attr_obj->GetDirect();
160 if (attr_obj->IsDictionary()) {
161 return index == 0 ? FPDFStructElementAttrFromCPDFDictionary(
162 attr_obj->AsDictionary())
165 if (attr_obj->IsArray()) {
166 const CPDF_Array* array = attr_obj->AsArray();
167 if (index < 0 ||
static_cast<size_t>(index) >= array->size())
172 return FPDFStructElementAttrFromCPDFDictionary(array->GetDictAt(index));
179 FPDF_BYTESTRING attr_name,
181 unsigned long buflen) {
182 CPDF_StructElement* elem =
186 RetainPtr<
const CPDF_Array> array = ToArray(elem->GetA());
190 for (
const RetainPtr<CPDF_Object>& obj : locker) {
191 const CPDF_Dictionary* obj_dict = obj->AsDictionary();
194 RetainPtr<
const CPDF_Object> attr = obj_dict->GetObjectFor(attr_name);
195 if (!attr || !(attr->IsString() || attr->IsName()))
197 return Utf16EncodeMaybeCopyAndReturnLength(attr->GetUnicodeText(), buffer,
205 CPDF_StructElement* elem =
210 return p && p->IsNumber() ? p->GetInteger() : -1;
216 unsigned long buflen) {
217 CPDF_StructElement* elem =
219 return elem ? WideStringToBuffer(
228 unsigned long buflen) {
229 CPDF_StructElement* elem =
231 return elem ? WideStringToBuffer(
240 unsigned long buflen) {
241 CPDF_StructElement* elem =
243 return elem ? WideStringToBuffer(elem
->GetTitle(), buffer, buflen) : 0;
248 CPDF_StructElement* elem =
253 FX_SAFE_INT32 tmp_size = elem->CountKids();
254 return tmp_size.ValueOrDefault(-1);
260 CPDF_StructElement* elem =
262 if (!elem || index < 0 ||
static_cast<size_t>(index) >= elem->CountKids())
265 return FPDFStructElementFromCPDFStructElement(elem->GetKidIfElement(index));
271 CPDF_StructElement* elem =
273 if (!elem || index < 0 ||
static_cast<size_t>(index) >= elem->CountKids()) {
277 return elem->GetKidContentId(index);
282 CPDF_StructElement* elem =
284 CPDF_StructElement* parent = elem ? elem
->GetParent() :
nullptr;
293 const CPDF_Dictionary* dict =
297 return fxcrt::CollectionSize<
int>(*dict);
304 unsigned long buflen,
305 unsigned long* out_buflen) {
310 const CPDF_Dictionary* dict =
316 for (
auto& it : locker) {
319 NulTerminateMaybeCopyAndReturnLength(it.first, buffer, buflen);
329 FPDF_BYTESTRING name) {
330 const CPDF_Dictionary* dict =
340 FPDF_STRUCTELEMENT_ATTR struct_attribute,
341 FPDF_BYTESTRING name,
342 FPDF_BOOL* out_value) {
346 const CPDF_Dictionary* dict =
352 if (!obj || !obj->IsBoolean())
355 *out_value = obj->GetInteger();
361 FPDF_BYTESTRING name,
366 const CPDF_Dictionary* dict =
372 if (!obj || !obj->IsNumber())
375 *out_value = obj->GetNumber();
381 FPDF_BYTESTRING name,
383 unsigned long buflen,
384 unsigned long* out_buflen) {
388 const CPDF_Dictionary* dict =
394 if (!obj || !(obj->IsString() || obj->IsName()))
397 *out_buflen = Utf16EncodeMaybeCopyAndReturnLength(
398 WideString
::FromUTF8(obj->GetString().AsStringView()
), buffer, buflen);
404 FPDF_BYTESTRING name,
406 unsigned long buflen,
407 unsigned long* out_buflen) {
411 const CPDF_Dictionary* dict =
417 if (!obj || !obj->IsString())
420 ByteString result = obj->GetString();
421 const unsigned long len =
422 pdfium::base::checked_cast<
unsigned long>(result.GetLength());
423 if (buffer && len <= buflen)
424 memcpy(buffer, result
.c_str(), len);
432 CPDF_StructElement* elem =
440 if (p->IsNumber() || p->IsDictionary())
443 return p->IsArray() ?
fxcrt::CollectionSize<
int>(*p->AsArray()) : -1;
449 CPDF_StructElement* elem =
458 return index == 0 ? p->GetInteger() : -1;
460 if (p->IsDictionary())
461 return GetMcidFromDict(p->GetDict().Get());
464 const CPDF_Array* array = p->AsArray();
465 if (index < 0 ||
static_cast<size_t>(index) >= array->size())
468 if (array_elem->IsNumber())
469 return array_elem->GetInteger();
470 if (array_elem->IsDictionary()) {
471 return GetMcidFromDict(array_elem->GetDict().Get());
CPDF_DictionaryLocker(const CPDF_Dictionary *pDictionary)
ByteString GetNameFor(const ByteString &key) const
CPDF_Document * GetDocument() const override
ByteString GetType() const
WideString GetTitle() const
WideString GetActualText() const
CPDF_StructElement * GetParent() const
ByteString GetObjType() const
WideString GetAltText() const
bool operator==(const char *ptr) const
const char * c_str() const
static WideString FromUTF8(ByteStringView str)
CPDF_StructElement * CPDFStructElementFromFPDFStructElement(FPDF_STRUCTELEMENT struct_element)
unsigned long Utf16EncodeMaybeCopyAndReturnLength(const WideString &text, void *buffer, unsigned long buflen)
FPDF_STRUCTELEMENT FPDFStructElementFromCPDFStructElement(CPDF_StructElement *struct_element)
CPDF_Page * CPDFPageFromFPDFPage(FPDF_PAGE page)
CPDF_StructTree * CPDFStructTreeFromFPDFStructTree(FPDF_STRUCTTREE struct_tree)
const CPDF_Dictionary * CPDFDictionaryFromFPDFStructElementAttr(FPDF_STRUCTELEMENT_ATTR struct_element_attr)
FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV FPDF_StructElement_GetParent(FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetLang(FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetAttributeCount(FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetStringValue(FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name, void *buffer, unsigned long buflen, unsigned long *out_buflen)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetBooleanValue(FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name, FPDF_BOOL *out_value)
FPDF_EXPORT void FPDF_CALLCONV FPDF_StructTree_Close(FPDF_STRUCTTREE struct_tree)
FPDF_EXPORT FPDF_STRUCTTREE FPDF_CALLCONV FPDF_StructTree_GetForPage(FPDF_PAGE page)
FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetMarkedContentID(FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetStringAttribute(FPDF_STRUCTELEMENT struct_element, FPDF_BYTESTRING attr_name, void *buffer, unsigned long buflen)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetBlobValue(FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name, void *buffer, unsigned long buflen, unsigned long *out_buflen)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetName(FPDF_STRUCTELEMENT_ATTR struct_attribute, int index, void *buffer, unsigned long buflen, unsigned long *out_buflen)
FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetMarkedContentIdAtIndex(FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetActualText(FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV FPDF_StructTree_GetChildAtIndex(FPDF_STRUCTTREE struct_tree, int index)
FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_Attr_GetCount(FPDF_STRUCTELEMENT_ATTR struct_attribute)
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetID(FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetNumberValue(FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name, float *out_value)
FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV FPDF_StructElement_GetChildAtIndex(FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetObjType(FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT FPDF_OBJECT_TYPE FPDF_CALLCONV FPDF_StructElement_Attr_GetType(FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name)
FPDF_EXPORT FPDF_STRUCTELEMENT_ATTR FPDF_CALLCONV FPDF_StructElement_GetAttributeAtIndex(FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetType(FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetAltText(FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetChildMarkedContentID(FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT int FPDF_CALLCONV FPDF_StructTree_CountChildren(FPDF_STRUCTTREE struct_tree)
FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_CountChildren(FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetMarkedContentIdCount(FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetTitle(FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
#define FPDF_OBJECT_UNKNOWN