Vanilla.PDF  1.3.0
Cross-platform toolkit for creating and modifying PDF documents
c_object.h
Go to the documentation of this file.
1 #ifndef _C_OBJECT_H
2 #define _C_OBJECT_H
3 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
28  typedef enum {
33  ObjectType_Null = 0,
34 
39  ObjectType_Array,
40 
45  ObjectType_Boolean,
46 
51  ObjectType_Dictionary,
52 
57  ObjectType_Integer,
58 
63  ObjectType_Name,
64 
69  ObjectType_Real,
70 
75  ObjectType_Stream,
76 
81  ObjectType_String,
82 
87  ObjectType_IndirectReference
88  } ObjectType;
89 
98  VANILLAPDF_API error_type CALLING_CONVENTION Object_GetType(ObjectHandle* handle, ObjectType* result);
99 
103  VANILLAPDF_API error_type CALLING_CONVENTION Object_TypeName(ObjectType type, string_type* result);
104 
108  VANILLAPDF_API error_type CALLING_CONVENTION Object_GetOffset(ObjectHandle* handle, offset_type* result);
109 
114  VANILLAPDF_API error_type CALLING_CONVENTION Object_Release(ObjectHandle* handle);
115 
119  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToArray(ObjectHandle* handle, ArrayObjectHandle** result);
120 
124  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToStream(ObjectHandle* handle, StreamObjectHandle** result);
125 
129  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToDictionary(ObjectHandle* handle, DictionaryObjectHandle** result);
130 
134  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToIndirectReference(ObjectHandle* handle, IndirectObjectReferenceHandle** result);
135 
139  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToInteger(ObjectHandle* handle, IntegerObjectHandle** result);
140 
144  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToBoolean(ObjectHandle* handle, BooleanObjectHandle** result);
145 
149  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToReal(ObjectHandle* handle, RealObjectHandle** result);
150 
154  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToNull(ObjectHandle* handle, NullObjectHandle** result);
155 
159  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToName(ObjectHandle* handle, NameObjectHandle** result);
160 
164  VANILLAPDF_API error_type CALLING_CONVENTION Object_ToString(ObjectHandle* handle, StringObjectHandle** result);
165 
168 #ifdef __cplusplus
169 };
170 #endif
171 
172 #endif /* _C_OBJECT_H */
ObjectHandle::Object_ToInteger
error_type Object_ToInteger(ObjectHandle *handle, IntegerObjectHandle **result)
Reinterpret current object as IntegerObjectHandle.
RealObjectHandle
Represents floating point numbers.
NullObjectHandle
Used as missing value.
ObjectType_Name
Definition: c_object.h:63
ObjectType
ObjectType
Available types of objects.
Definition: c_object.h:28
ObjectHandle::Object_ToDictionary
error_type Object_ToDictionary(ObjectHandle *handle, DictionaryObjectHandle **result)
Reinterpret current object as DictionaryObjectHandle.
ObjectType_Real
Definition: c_object.h:69
ObjectHandle::Object_TypeName
error_type Object_TypeName(ObjectType type, string_type *result)
Get string representation of object type.
ObjectHandle::Object_Release
error_type Object_Release(ObjectHandle *handle)
Decrement the internal reference counter.
ObjectHandle::Object_GetOffset
error_type Object_GetOffset(ObjectHandle *handle, offset_type *result)
Get input file offset where this object was found.
ObjectHandle::Object_ToStream
error_type Object_ToStream(ObjectHandle *handle, StreamObjectHandle **result)
Reinterpret current object as StreamObjectHandle.
IntegerObjectHandle
Represents integer values.
c_handles.h
This file contains all type forward declarations returned by the library API.
IndirectObjectReferenceHandle
Represents reference to other object.
string_type
const char * string_type
C-Style string.
Definition: c_types.h:82
ObjectType_Dictionary
Definition: c_object.h:51
ObjectHandle::Object_ToBoolean
error_type Object_ToBoolean(ObjectHandle *handle, BooleanObjectHandle **result)
Reinterpret current object as BooleanObjectHandle.
ArrayObjectHandle
Represents array of mixed type elements.
ObjectHandle::Object_GetType
error_type Object_GetType(ObjectHandle *handle, ObjectType *result)
Get derived type of current object.
ObjectHandle::Object_ToNull
error_type Object_ToNull(ObjectHandle *handle, NullObjectHandle **result)
Reinterpret current object as NullObjectHandle.
DictionaryObjectHandle
Represents key-value map.
ObjectHandle
Base class for syntactic tokens.
ObjectHandle::Object_ToString
error_type Object_ToString(ObjectHandle *handle, StringObjectHandle **result)
Reinterpret current object as StringObjectHandle.
BooleanObjectHandle
Represents boolean type.
ObjectType_Integer
Definition: c_object.h:57
ObjectType_IndirectReference
Definition: c_object.h:87
error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
ObjectHandle::Object_ToIndirectReference
error_type Object_ToIndirectReference(ObjectHandle *handle, IndirectObjectReferenceHandle **result)
Reinterpret current object as IndirectObjectReferenceHandle.
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries...
ObjectType_String
Definition: c_object.h:81
c_values.h
This file contains types and constants used as parameters or return values.
offset_type
int64_t offset_type
Offset type compatible with standard IO.
Definition: c_types.h:56
ObjectHandle::Object_ToReal
error_type Object_ToReal(ObjectHandle *handle, RealObjectHandle **result)
Reinterpret current object as RealObjectHandle.
ObjectType_Null
Definition: c_object.h:33
StringObjectHandle
Reprsents human readable text.
StreamObjectHandle
Represents compressed data inside document.
NameObjectHandle
Represents unique name references in document.
ObjectHandle::Object_ToName
error_type Object_ToName(ObjectHandle *handle, NameObjectHandle **result)
Reinterpret current object as NameObjectHandle.
ObjectType_Array
Definition: c_object.h:39
ObjectType_Boolean
Definition: c_object.h:45
ObjectHandle::Object_ToArray
error_type Object_ToArray(ObjectHandle *handle, ArrayObjectHandle **result)
Reinterpret current object as ArrayObjectHandle.
ObjectType_Stream
Definition: c_object.h:75