blob: 6dd8f8f002a643a1497dda6dcd58e0b63544e3a3 [file] [log] [blame]
// Copyright 2017 The PDFium Authors
// 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.
#include <vector>
#include "core/fxcrt/fx_string.h"
#include "core/fxcrt/retain_ptr.h"
#include "core/fxcrt/unowned_ptr.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
class CPDF_Dictionary;
class CPDF_Object;
class CPDF_StructTree;
class CPDF_StructElement final : public Retainable {
ByteString GetType() const { return m_Type; }
ByteString GetObjType() const;
WideString GetAltText() const;
WideString GetActualText() const;
WideString GetTitle() const;
absl::optional<WideString> GetID() const;
absl::optional<WideString> GetLang() const;
RetainPtr<const CPDF_Object> GetA() const;
RetainPtr<const CPDF_Object> GetK() const;
size_t CountKids() const;
CPDF_StructElement* GetKidIfElement(size_t index) const;
bool UpdateKidIfElement(const CPDF_Dictionary* pDict,
CPDF_StructElement* pElement);
CPDF_StructElement* GetParent() const { return m_pParentElement; }
void SetParent(CPDF_StructElement* pParentElement) {
m_pParentElement = pParentElement;
struct Kid {
enum Type { kInvalid, kElement, kPageContent, kStreamContent, kObject };
Kid(const Kid& that);
Type m_Type = kInvalid;
uint32_t m_PageObjNum = 0; // For {PageContent, StreamContent, Object}.
uint32_t m_RefObjNum = 0; // For {StreamContent, Object} types.
uint32_t m_ContentId = 0; // For {PageContent, StreamContent} types.
RetainPtr<CPDF_StructElement> m_pElement; // For Element type.
RetainPtr<const CPDF_Dictionary> m_pDict; // For Element type.
CPDF_StructElement(const CPDF_StructTree* pTree,
RetainPtr<const CPDF_Dictionary> pDict);
~CPDF_StructElement() override;
void LoadKids(RetainPtr<const CPDF_Dictionary> pDict);
void LoadKid(uint32_t PageObjNum,
RetainPtr<const CPDF_Object> pKidObj,
Kid* pKid);
UnownedPtr<const CPDF_StructTree> const m_pTree;
RetainPtr<const CPDF_Dictionary> const m_pDict;
UnownedPtr<CPDF_StructElement> m_pParentElement;
const ByteString m_Type;
std::vector<Kid> m_Kids;