PDObject.h

Go to the documentation of this file.

//
// PDObject.h
//
// Copyright (c) 2012 - 2015 Karl-Johan Alm (http://github.com/kallewoof)
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#ifndef INCLUDED_PDObject_h
#define INCLUDED_PDObject_h

#include "PDDefines.h"


extern PDObjectRef PDObjectCreateFromDefinitionsStack(PDInteger obid, pd_stack defs);

extern void PDObjectSetSynchronizationCallback(PDObjectRef object, PDSynchronizer callback, const void *syncInfo);

extern void PDObjectDelete(PDObjectRef object);

extern void PDObjectUndelete(PDObjectRef object);


extern PDInteger PDObjectGetObID(PDObjectRef object);

extern PDInteger PDObjectGetGenID(PDObjectRef object);

extern PDBool PDObjectGetObStreamFlag(PDObjectRef object);

extern const char *PDObjectGetReferenceString(PDObjectRef object);

extern PDObjectType PDObjectGetType(PDObjectRef object);

extern PDObjectType PDObjectDetermineType(PDObjectRef object);

extern void PDObjectSetType(PDObjectRef object, PDObjectType type);

extern PDBool PDObjectHasStream(PDObjectRef object);

extern PDInteger PDObjectGetRawStreamLength(PDObjectRef object);

extern PDInteger PDObjectGetExtractedStreamLength(PDObjectRef object);

extern PDBool PDObjectHasTextStream(PDObjectRef object);

extern char *PDObjectGetStream(PDObjectRef object);

extern void *PDObjectGetValue(PDObjectRef object);

extern void PDObjectSetValue(PDObjectRef object, void *value);

// *  Get the instance type of the object.
// *
// *  @param object The object
// *
// *  @return Instance type value. PDInstanceTypeUnknown is returned if the instance type could not be determined.
// */
//extern PDInstanceType PDObjectGetInstanceType(PDObjectRef object);
//
// *  Get the instance for the object's definition. The instance is a PDDictionary, PDArray, PDString, etc. depending on what the
// *  object's definition looks like.
// *
// *  @param object The object
// *
// *  @return Appropriate object type. Use PDResolve() to determine its type if unsure.
// */
//extern void *PDObjectGetInstance(PDObjectRef object);

extern PDDictionaryRef PDObjectGetDictionary(PDObjectRef object);

extern PDArrayRef PDObjectGetArray(PDObjectRef object);


extern void PDObjectReplaceWithString(PDObjectRef object, char *str, PDInteger len);


extern void PDObjectSkipStream(PDObjectRef object);

extern void PDObjectSetStream(PDObjectRef object, char *str, PDInteger len, PDBool includeLength, PDBool allocated, PDBool encrypted);

extern PDBool PDObjectSetStreamFiltered(PDObjectRef object, char *str, PDInteger len, PDBool encrypted);

extern void PDObjectSetFlateDecodedFlag(PDObjectRef object, PDBool state);

extern void PDObjectSetPredictionStrategy(PDObjectRef object, PDPredictorType strategy, PDInteger columns);

extern void PDObjectSetStreamEncrypted(PDObjectRef object, PDBool encrypted);


extern PDInteger PDObjectGenerateDefinition(PDObjectRef object, char **dstBuf, PDInteger capacity);

extern PDInteger PDObjectPrinter(void *inst, char **buf, PDInteger offs, PDInteger *cap);

#endif
 // unbalanced, but doxygen complains for some reason