struct_tree.h

// Copyright (c) 2026 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CXX_STRUCT_TREE_H_INCLUDED_
#define PDFSDK_CXX_STRUCT_TREE_H_INCLUDED_
 
#include <string>
#include <string_view>
 
#include <pdfsdk/core/struct_tree.h>
 
#include "forward_declarations.h"
#include "object.h"
 
namespace PDF {

class StructTreeElement {
public:
    StructTreeElement() noexcept = default;

    static StructTreeElement CreateFromPdfObject(const Object& object);

    Object GetPdfObject() const;

    bool Equals(const StructTreeElement& rhs) const noexcept;
 
#ifndef SWIG
    explicit operator bool() const noexcept { return static_cast<bool>(m_obj); }
    bool operator==(const StructTreeElement& rhs) const noexcept { return Equals(rhs); }
#endif

    void SetType(PDAtom type);

    PDAtom GetType() const;

    std::string GetID() const;

    void SetID(std::string_view id);

    void SetTitle(std::wstring_view title);

    std::wstring GetTitle() const;

    void SetAltText(std::wstring_view altText);

    std::wstring GetAltText() const;

    void SetActualText(std::wstring_view actualText);

    std::wstring GetActualText() const;

    void SetLanguage(std::wstring_view lang);

    std::wstring GetLanguage() const;

    size_t GetNumAttrObjs() const;

    Object GetAttrObj(size_t index) const;

    int GetAttrObjRevision(size_t index) const;

    void InsertAttrObj(size_t index, const Object& attrObj);

    void RemoveAttrObj(const Object& attrObj);

    size_t GetNumClasses() const;

    PDAtom GetClass(size_t index) const;

    int GetClassRevision(size_t index) const;

    void AddClass(PDAtom name);

    void RemoveClass(PDAtom name);

    int GetRevision() const;

    void IncrementRevision();

    StructTreeElement GetParent() const;

    bool IsDetached() const;

    size_t GetNumKids() const;

    PDStructTreeKidType GetKidType(size_t index) const;

    void RemoveKid(size_t index);

    StructTreeElement GetKidElement(size_t index) const;

    void InsertKidElement(size_t index, const StructTreeElement& kid);

    Page GetKidMCPage(size_t index) const;

    int GetKidMCID(size_t index) const;

    Object GetKidMCStm(size_t index) const;

    Object GetKidMCStmOwn(size_t index) const;

    void InsertKidMC(size_t index,
                     const Page& page,
                     const Element& mc,
                     const Object& stm = Object(),
                     const Object& stmOwn = Object());

    void InsertKidMCID(size_t index,
                       const Page& page,
                       int mcid,
                       const Object& stm = Object(),
                       const Object& stmOwn = Object());

    Page GetKidOBJRPage(size_t index) const;

    Object GetKidOBJRObject(size_t index) const;

    void InsertKidOBJR(size_t index, const Page& page, const Object& object);
 
private:
    friend class StructTreeRoot;
 
    explicit StructTreeElement(const Object& object) noexcept;
 
    Object m_obj;
};

class StructTreeRoot {
public:
    StructTreeRoot() noexcept = default;

    static StructTreeRoot CreateFromPdfObject(const Object& object);

    Object GetPdfObject() const;

    bool Equals(const StructTreeRoot& rhs) const noexcept;
 
#ifndef SWIG
    explicit operator bool() const noexcept { return static_cast<bool>(m_obj); }
    bool operator==(const StructTreeRoot& rhs) const noexcept { return Equals(rhs); }
#endif

    size_t ClassMapGetNumAttrObjs(PDAtom name) const;

    Object ClassMapGetAttrObj(PDAtom name, size_t index) const;

    void ClassMapInsertAttrObj(PDAtom name, size_t index, const Object& attrObj);

    void ClassMapRemoveAttrObj(PDAtom name, const Object& attrObj);

    void ClassMapRemoveClass(PDAtom name);

    void ClassMapRemoveAll();

    void RoleMapPut(PDAtom from, PDAtom to);

    PDAtom RoleMapGet(PDAtom from) const;

    void RoleMapRemove(PDAtom from);

    StructTreeElement CreateElement(PDAtom type);

    size_t GetNumKids() const;

    StructTreeElement GetKid(size_t index) const;

    void InsertKid(size_t index, const StructTreeElement& element);

    void RemoveKid(size_t index);

    StructTreeElement FindElementByID(std::string_view id) const;

    StructTreeElement GetMCParent(const Page& page, const Element& mc) const;

    StructTreeElement GetMCIDParent(const Page& page, int mcid) const;

    StructTreeElement GetObjectParent(const Object& object) const;
 
private:
    explicit StructTreeRoot(const Object& object) noexcept;
 
    Object m_obj;
};
 
}  // namespace PDF
 
#include "struct_tree_impl.inl"
 
#endif  // PDFSDK_CXX_STRUCT_TREE_H_INCLUDED_