objects.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CORE_OBJECTS_H_INCLUDED_
#define PDFSDK_CORE_OBJECTS_H_INCLUDED_

 
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/core/streams.h>
#include <pdfsdk/core/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    kPDObjectNull,      
    kPDObjectInteger,   
    kPDObjectReal,      
    kPDObjectBoolean,   
    kPDObjectName,      
    kPDObjectString,    
    kPDObjectDict,      
    kPDObjectArray,     
    kPDObjectStream     
} PDObjectType;
 
/*
 *  May be created from a PDDoc using one of the following methods for
 *  the different object types:
 *
 *  PDDocCreateBoolObject(PDDoc file, bool isIndirect, bool value, PDObject* object)
 *  PDDocCreateIntObject(PDDoc file, bool isIndirect, int64_t value, PDObject* object)
 *  PDDocCreateRealObject(PDDoc file, bool isIndirect, float value, PDObject* object)
 *  PDDocCreateStringObjectFromUnicode(PDDoc file, bool isIndirect, const wchar_t* buffer, size_t bufSize, PDObject* object)
 *  PDDocCreateStringObject(PDDoc file, bool isIndirect, const void* buffer, size_t numBytes, bool bIsHexString, PDObject* object)
 *  PDDocCreateNameObject(PDDoc file, bool isIndirect,  PDAtom name, PDObject* object)
 *  PDDocCreateArrayObject(PDDoc file, bool isIndirect, PDObject* object)
 *  PDDocCreateDictObject(PDDoc file, bool isIndirect, PDObject* object)
 *  PDDocCreateStreamObject(PDDoc file, PDObject dict, const void* buffer, size_t numBytes, PDObject* object)
 *
 *  Retrieval of internal basic objects may be done with one of the following methods:
 *
 *  PDObjectGetType(PDObject object, PDObjectType* type)
 *  PDObjectGetBool(PDObject object, bool* value)
 *  PDObjectGetInt(PDObject object, int64_t* value)
 *  PDObjectGetReal(PDObject object, float* value)
 *  PDObjectGetUnicodeString(PDObject object, wchar_t* buffer, size_t bufSize, size_t* bufNeededSize)
 *  PDObjectGetString(PDObject object, void* buffer, size_t numBytes, size_t* neededBytes)
 *  PDObjectGetName(PDObject object, PDAtom* name)
 *
 *  PDObject with type kPDObjectArray may be manipulated with one of the following methods:
 *
 *  PDObjectArrayAdd(PDObject array, PDObject objectToAdd)
 *  PDObjectArrayGet(PDObject array, size_t index, PDObject* object)
 *  PDObjectArrayRemove(PDObject array, size_t index)
 *  PDObjectArrayGetLength(PDObject array, size_t* index)
 *
 *  PDObject with type kPDObjectDict may be manipulated with one of the following methods:
 *
 *  PDObjectDictPut(PDObject dict, PDAtom name, PDObject object)
 *  PDObjectDictFind(PDObject dict, PDAtom name, PDObject* object)
 *  PDObjectDictRemove(PDObject dict, PDAtom name)
 *
 *  PDObject with type kPDObjectStream may be manipulated with one of the following methods:
 *
 *  PDObjectStreamGetDict(PDObject objectStream, PDObject* dict)
 *  PDObjectStreamOpen(PDObject object, PDStream* stream)
 *  PDStreamRead(PDStream readStream, void* buffer, unsigned int numBytes, int64_t* numBytesRead)
 *  PDStreamClose(PDStream stream)
 *
 */
 
typedef struct PDObject {
    uint64_t handle;
} PDObject;
 
inline PDObject PDObjectCreateNull() {
    PDObject nullObj = {0};
    return nullObj;
}
 
#define nullPDObject (PDObjectCreateNull())

typedef PDErrCode(PDFSDK_CALLCONV* PDObjectDictEnumProc)(PDAtom key, PDObject value, void* userData);

typedef enum {
    kPDObjectStreamOpenRaw,         
    kPDObjectStreamOpenDecrypted,   
    kPDObjectStreamOpenFiltered,    
} PDObjectStreamOpenMode;
 
PDF_CORE_API void PDFSDK_CALLCONV PDObjectAcquire(PDObject object);
PDF_CORE_API void PDFSDK_CALLCONV PDObjectRelease(PDObject object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetObjectByID(PDDoc file, uint32_t id, PDObject* pObj);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectCopy(PDDoc file, PDObject srcobject, PDObject* pObj);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetRootObject(PDDoc file, PDObject* pObj);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocGetInfoObject(PDDoc file, PDObject* pObj);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetType(PDObject object, PDObjectType* type);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDeepEqual(PDObject objA, PDObject objB, bool* pEqual);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetDoc(PDObject object, PDDoc* pDoc);
 
// PDObjectBool
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateBoolObject(PDDoc file, bool indirect, bool value, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetBool(PDObject object, bool* value);
 
// PDObjectInt
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateIntObject(PDDoc file, bool indirect, int64_t value, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetInt(PDObject object, int64_t* value);
 
// PDObjectReal
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateRealObject(PDDoc file, bool indirect, float value, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetReal(PDObject object, float* value);
 
// PDObjectString
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateStringObjectFromUnicode(PDDoc file, bool indirect, const wchar_t* buffer, size_t bufSize, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateStringObject(PDDoc file, bool indirect, const void* buffer, size_t numBytes, bool hexString, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetUnicodeString(PDObject object, wchar_t* buffer, size_t bufSize, size_t* bufNeededSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetString(PDObject object, void* buffer, size_t numBytes, size_t* neededBytes);
 
// PDObjectName
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateNameObject(PDDoc file, bool indirect, PDAtom name, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetName(PDObject object, PDAtom* name);
 
// PDObjectArray
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateArrayObject(PDDoc file, bool indirect, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectArrayAdd(PDObject array, PDObject object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectArrayInsert(PDObject array, size_t index, PDObject object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectArrayPut(PDObject array, size_t index, PDObject object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectArrayGet(PDObject array, size_t index, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectArrayRemove(PDObject array, size_t index);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectArrayGetLength(PDObject array, size_t* index);
 
// PDObjectDict
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateDictObject(PDDoc file, bool indirect, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictPut(PDObject dict, PDAtom name, PDObject object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictFind(PDObject dict, PDAtom name, PDObject* object);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictFindName(PDObject dict, PDAtom name, PDAtom* pvalue);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictRemove(PDObject dict, PDAtom name);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictEnum(PDObject dict, PDObjectDictEnumProc enumProc, void* userData);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictGetNumEntries(PDObject array, size_t* index);
 
// PDDictEnumerator
// A freshly created enumerator is positioned before the first entry; call
// PDObjectDictEnumeratorMoveNext before reading the key/value.
// Use PDHandleAcquire / PDHandleRelease to manage enumerator lifetime.
typedef struct PDDictEnumeratorRec_* PDDictEnumerator;
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictEnumeratorCreate(PDObject dict, PDDictEnumerator* pEnum);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictEnumeratorMoveNext(PDDictEnumerator enumerator, bool* pHasEntry);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictEnumeratorReset(PDDictEnumerator enumerator);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictEnumeratorGetKey(PDDictEnumerator enumerator, PDAtom* pKey);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectDictEnumeratorGetValue(PDDictEnumerator enumerator, PDObject* pValue);
 
// PDObjectStream
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDDocCreateStreamObject(PDDoc file, const void* buffer, size_t bufSize, PDObject attributesDict, PDObject encodeParms, bool encodeSource, PDObject* pObj);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectStreamGetDict(PDObject objectStream, PDObject* pDict);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectStreamOpen(PDObject object, PDObjectStreamOpenMode openMode, PDReadStream* pStm);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectIsIndirect(PDObject object, bool* pIndirect);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetObjNumber(PDObject object, uint32_t* pObjNum);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetGenNumber(PDObject object, uint16_t* pGenNum);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDObjectGetFileOffset(PDObject object, uint64_t* pFileOffset);
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_CORE_OBJECTS_H_INCLUDED_