object.h

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CXX_PDF_OBJECT_H_INCLUDED_
#define PDFSDK_CXX_PDF_OBJECT_H_INCLUDED_
 
#include <cassert>
#include <string>
#include <string_view>
#include <utility>
 
#include <pdfsdk/core/objects.h>
 
#include "forward_declarations.h"
#include "wrapper_base.h"
 
namespace PDF {
 
class DictEnumerator;

class Object {
public:
#ifndef SWIG
    ~Object();

    Object() noexcept;

    Object(PDObject obj, bool adopt = false) noexcept;

    Object(const Object& that) noexcept;

    Object(Object&& that) noexcept;

    Object& operator=(const Object& rhs) noexcept;

    Object& operator=(Object&& rhs) noexcept;

    void reset(PDObject obj, bool adopt = false) noexcept;

    PDObject* operator&() noexcept;

    PDObject get() const noexcept;

    PDObject detach() noexcept;
 
    explicit operator bool() const noexcept { return !Equals(nullPDObject); }
    bool operator==(const Object& rhs) const noexcept { return Equals(rhs); }
#endif

    bool Equals(const Object& rhs) const noexcept;

    PDObjectType GetObjectType() const;

    bool IsNull() const;

    bool IsBool() const;

    bool IsInteger() const;

    bool IsReal() const;

    bool IsNumber() const;

    bool IsString() const;

    bool IsName() const;

    bool IsDict() const;

    bool IsArray() const;

    bool IsStream() const;

    bool IsDictOrStream() const;

    bool IsIndirect() const;

    uint32_t GetObjNumber() const;

    uint16_t GetGenNumber() const;

    uint64_t GetFileOffset() const;

    bool GetBoolValue() const;

    int64_t GetIntValue() const;

    float GetRealValue() const;

    std::wstring GetUnicodeString() const;

    std::string GetStringValue() const;

    PDAtom GetNameValue() const;

    void ArrayAdd(const Object& object);

    void ArrayAddInteger(int64_t value);

    void ArrayAddReal(float value);

    void ArrayAddBoolean(bool value);

    void ArrayAddName(PDAtom value);

    void ArrayAddString(std::string_view bytes, bool hex = false);

    void ArrayAddStringUnicode(std::wstring_view unicode);

    Object ArrayAddDict();

    Object ArrayAddArray();

    void ArrayInsert(size_t index, const Object& object);

    void ArrayPut(size_t index, const Object& object);

    Object ArrayGet(size_t index) const;

    void ArrayRemove(size_t index);

    size_t GetArrayLength() const;

    void DictPut(PDAtom name, const Object& object);

    void DictPutName(PDAtom name, PDAtom value);

    void DictPutInteger(PDAtom name, int64_t value);

    void DictPutReal(PDAtom name, float value);

    void DictPutBoolean(PDAtom name, bool value);

    void DictPutString(PDAtom name, std::string_view bytes, bool hex = false);

    void DictPutStringUnicode(PDAtom name, std::wstring_view unicode);

    Object DictPutDict(PDAtom name);

    Object DictPutArray(PDAtom name);

    Object DictFind(PDAtom name) const;

    PDAtom DictFindName(PDAtom name) const;

    void DictRemove(PDAtom name);

    template<class Func>
    void DictEnum(Func&& func) const;

    DictEnumerator DictGetEnumerator() const;

    size_t GetDictNumEntries() const;

    Object GetStreamDict() const;

    ReadStream StreamOpen(PDObjectStreamOpenMode openMode = kPDObjectStreamOpenFiltered) const;

    bool DeepEquals(const Object& that);
 
private:
    void Acquire() noexcept;
    void Release() noexcept;
 
protected:
    PDObject m_obj;
};

class DictEnumerator : public detail::RefCountedHandle<PDDictEnumerator> {
public:
    bool MoveNext();

    void Reset();

    PDAtom GetKey() const;

    Object GetValue() const;
 
#ifndef SWIG
    // Range-based for loop support: for (auto [key, value] : dict.DictGetEnumerator()) { ... }
    // begin() rewinds and positions at the first entry, so it is idempotent.
    struct End {};
    DictEnumerator& begin() { Reset(); MoveNext(); return *this; }
    End end() const { return {}; }
    DictEnumerator& operator++() { MoveNext(); return *this; }
    bool operator!=(End) const { return GetKey() != kPDAtomNull; }
    std::pair<PDAtom, Object> operator*() const;
#endif
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(DictEnumerator, PDDictEnumerator)
};
 
}  // namespace PDF
 
#include "object_impl.inl"
 
#endif  // PDFSDK_CXX_PDF_OBJECT_H_INCLUDED_