fpdf_structtree.cpp File Reference

(e4657a741c23c8f48e0e97ae2091dc2d99f4f27d)

#include "public/fpdf_structtree.h"
#include <memory>
#include "core/fpdfapi/page/cpdf_page.h"
#include "core/fpdfapi/parser/cpdf_array.h"
#include "core/fpdfapi/parser/cpdf_dictionary.h"
#include "core/fpdfdoc/cpdf_structelement.h"
#include "core/fpdfdoc/cpdf_structtree.h"
#include "core/fxcrt/compiler_specific.h"
#include "core/fxcrt/fx_memcpy_wrappers.h"
#include "core/fxcrt/fx_safe_types.h"
#include "core/fxcrt/numerics/safe_conversions.h"
#include "core/fxcrt/stl_util.h"
#include "fpdfsdk/cpdfsdk_helpers.h"

Include dependency graph for fpdf_structtree.cpp:

Go to the source code of this file.

Functions
FPDF_EXPORT FPDF_STRUCTTREE FPDF_CALLCONV	FPDF_StructTree_GetForPage (FPDF_PAGE page)
FPDF_EXPORT void FPDF_CALLCONV	FPDF_StructTree_Close (FPDF_STRUCTTREE struct_tree)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructTree_CountChildren (FPDF_STRUCTTREE struct_tree)
FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV	FPDF_StructTree_GetChildAtIndex (FPDF_STRUCTTREE struct_tree, int index)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetAltText (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetActualText (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetID (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
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_STRUCTELEMENT_ATTR FPDF_CALLCONV	FPDF_StructElement_GetAttributeAtIndex (FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetStringAttribute (FPDF_STRUCTELEMENT struct_element, FPDF_BYTESTRING attr_name, void *buffer, unsigned long buflen)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_GetMarkedContentID (FPDF_STRUCTELEMENT struct_element)
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_GetObjType (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetTitle (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_CountChildren (FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV	FPDF_StructElement_GetChildAtIndex (FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_GetChildMarkedContentID (FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV	FPDF_StructElement_GetParent (FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_Attr_GetCount (FPDF_STRUCTELEMENT_ATTR struct_attribute)
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 FPDF_STRUCTELEMENT_ATTR_VALUE FPDF_CALLCONV	FPDF_StructElement_Attr_GetValue (FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name)
FPDF_EXPORT FPDF_OBJECT_TYPE FPDF_CALLCONV	FPDF_StructElement_Attr_GetType (FPDF_STRUCTELEMENT_ATTR_VALUE value)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV	FPDF_StructElement_Attr_GetBooleanValue (FPDF_STRUCTELEMENT_ATTR_VALUE value, FPDF_BOOL *out_value)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV	FPDF_StructElement_Attr_GetNumberValue (FPDF_STRUCTELEMENT_ATTR_VALUE value, float *out_value)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV	FPDF_StructElement_Attr_GetStringValue (FPDF_STRUCTELEMENT_ATTR_VALUE value, void *buffer, unsigned long buflen, unsigned long *out_buflen)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV	FPDF_StructElement_Attr_GetBlobValue (FPDF_STRUCTELEMENT_ATTR_VALUE value, void *buffer, unsigned long buflen, unsigned long *out_buflen)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_Attr_CountChildren (FPDF_STRUCTELEMENT_ATTR_VALUE value)
FPDF_EXPORT FPDF_STRUCTELEMENT_ATTR_VALUE FPDF_CALLCONV	FPDF_StructElement_Attr_GetChildAtIndex (FPDF_STRUCTELEMENT_ATTR_VALUE value, int index)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_GetMarkedContentIdCount (FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_GetMarkedContentIdAtIndex (FPDF_STRUCTELEMENT struct_element, int index)

Function Documentation

FPDF_StructElement_Attr_CountChildren()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_Attr_CountChildren

(

FPDF_STRUCTELEMENT_ATTR_VALUE

value

)

Definition at line 455 of file fpdf_structtree.cpp.

References CPDFObjectFromFPDFStructElementAttrValue(), and ToArray().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetBlobValue()

FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetBlobValue	(	FPDF_STRUCTELEMENT_ATTR_VALUE	value,
		void *	buffer,
		unsigned long	buflen,
		unsigned long *	out_buflen )

Definition at line 433 of file fpdf_structtree.cpp.

References CPDFObjectFromFPDFStructElementAttrValue(), CPDF_Object::GetString(), and CPDF_Object::IsString().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetBooleanValue()

FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetBooleanValue	(	FPDF_STRUCTELEMENT_ATTR_VALUE	value,
		FPDF_BOOL *	out_value )

Definition at line 380 of file fpdf_structtree.cpp.

References CPDFObjectFromFPDFStructElementAttrValue(), CPDF_Object::GetInteger(), and CPDF_Object::IsBoolean().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetChildAtIndex()

FPDF_EXPORT FPDF_STRUCTELEMENT_ATTR_VALUE FPDF_CALLCONV FPDF_StructElement_Attr_GetChildAtIndex	(	FPDF_STRUCTELEMENT_ATTR_VALUE	value,
		int	index )

Definition at line 462 of file fpdf_structtree.cpp.

References CPDFObjectFromFPDFStructElementAttrValue(), and ToArray().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetCount()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_Attr_GetCount

(

FPDF_STRUCTELEMENT_ATTR

struct_attribute

)

Definition at line 325 of file fpdf_structtree.cpp.

References CPDFDictionaryFromFPDFStructElementAttr().

Referenced by CheckPDFiumCApi(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetName()

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 )

Definition at line 334 of file fpdf_structtree.cpp.

References CPDF_DictionaryLocker::CPDF_DictionaryLocker(), and CPDFDictionaryFromFPDFStructElementAttr().

Referenced by CheckPDFiumCApi(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetNumberValue()

FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetNumberValue	(	FPDF_STRUCTELEMENT_ATTR_VALUE	value,
		float *	out_value )

Definition at line 396 of file fpdf_structtree.cpp.

References CPDFObjectFromFPDFStructElementAttrValue(), CPDF_Object::GetNumber(), and CPDF_Object::IsNumber().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetStringValue()

FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetStringValue	(	FPDF_STRUCTELEMENT_ATTR_VALUE	value,
		void *	buffer,
		unsigned long	buflen,
		unsigned long *	out_buflen )

Definition at line 412 of file fpdf_structtree.cpp.

References CPDFObjectFromFPDFStructElementAttrValue(), CPDF_Object::IsName(), and CPDF_Object::IsString().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetType()

FPDF_EXPORT FPDF_OBJECT_TYPE FPDF_CALLCONV FPDF_StructElement_Attr_GetType

(

FPDF_STRUCTELEMENT_ATTR_VALUE

value

)

Definition at line 374 of file fpdf_structtree.cpp.

References CPDFObjectFromFPDFStructElementAttrValue(), and CPDF_Object::GetType().

Referenced by CheckPDFiumCApi(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetValue()

FPDF_EXPORT FPDF_STRUCTELEMENT_ATTR_VALUE FPDF_CALLCONV FPDF_StructElement_Attr_GetValue	(	FPDF_STRUCTELEMENT_ATTR	struct_attribute,
		FPDF_BYTESTRING	name )

Definition at line 362 of file fpdf_structtree.cpp.

References CPDFDictionaryFromFPDFStructElementAttr(), and CPDF_Dictionary::GetDirectObjectFor().

Referenced by CheckPDFiumCApi(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_CountChildren()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_CountChildren

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 280 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetActualText()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetActualText	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 98 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), and CPDF_StructElement::GetActualText().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetAltText()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetAltText	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 85 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), and CPDF_StructElement::GetAltText().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetAttributeAtIndex()

FPDF_EXPORT FPDF_STRUCTELEMENT_ATTR FPDF_CALLCONV FPDF_StructElement_GetAttributeAtIndex	(	FPDF_STRUCTELEMENT	struct_element,
		int	index )

Definition at line 166 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetAttributeCount()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetAttributeCount

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 148 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetChildAtIndex()

FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV FPDF_StructElement_GetChildAtIndex	(	FPDF_STRUCTELEMENT	struct_element,
		int	index )

Definition at line 291 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetChildMarkedContentID()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetChildMarkedContentID	(	FPDF_STRUCTELEMENT	struct_element,
		int	index )

Definition at line 302 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetID()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetID	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 112 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetLang()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetLang	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 130 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetMarkedContentID()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetMarkedContentID

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 229 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetMarkedContentIdAtIndex()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetMarkedContentIdAtIndex	(	FPDF_STRUCTELEMENT	struct_element,
		int	index )

Definition at line 493 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetMarkedContentIdCount()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetMarkedContentIdCount

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 477 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetObjType()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetObjType	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 253 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), fxcrt::WideString::FromUTF8(), and CPDF_StructElement::GetObjType().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetParent()

FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV FPDF_StructElement_GetParent

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 314 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), FPDFStructElementFromCPDFStructElement(), and CPDF_StructElement::GetParent().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetStringAttribute()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetStringAttribute	(	FPDF_STRUCTELEMENT	struct_element,
		FPDF_BYTESTRING	attr_name,
		void *	buffer,
		unsigned long	buflen )

Definition at line 199 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetTitle()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetTitle	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 267 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), and CPDF_StructElement::GetTitle().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetType()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetType	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 239 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), fxcrt::WideString::FromUTF8(), and CPDF_StructElement::GetType().

Referenced by CheckPDFiumCApi(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructTree_Close()

FPDF_EXPORT void FPDF_CALLCONV FPDF_StructTree_Close

(

FPDF_STRUCTTREE

struct_tree

)

Definition at line 58 of file fpdf_structtree.cpp.

Referenced by CheckPDFiumCApi(), and FPDFStructTreeDeleter::operator()().

Here is the caller graph for this function:

FPDF_StructTree_CountChildren()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructTree_CountChildren

(

FPDF_STRUCTTREE

struct_tree

)

Definition at line 64 of file fpdf_structtree.cpp.

References CPDFStructTreeFromFPDFStructTree().

Referenced by CheckPDFiumCApi().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructTree_GetChildAtIndex()

FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV FPDF_StructTree_GetChildAtIndex	(	FPDF_STRUCTTREE	struct_tree,
		int	index )

Definition at line 74 of file fpdf_structtree.cpp.

References CPDFStructTreeFromFPDFStructTree().

Referenced by CheckPDFiumCApi().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructTree_GetForPage()

FPDF_EXPORT FPDF_STRUCTTREE FPDF_CALLCONV FPDF_StructTree_GetForPage

(

FPDF_PAGE

page

)

Definition at line 46 of file fpdf_structtree.cpp.

References CPDFPageFromFPDFPage(), and CPDF_Page::GetDocument().

Referenced by CheckPDFiumCApi(), DumpPageStructure(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function: