PersistUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Utilities for getting objects' persistent identity.
// 
//========================================================================================

#ifndef __PersistUtils__
#define __PersistUtils__

class IContentMgr;
class IControllingUnknown;

#include "UIDRef.h"

 UID GetUID( const IPMUnknown *obj);
 
 IDataBase *GetDataBase(const IPMUnknown *obj);
 
 UIDRef GetUIDRef(const IPMUnknown *obj);
 
 void PreDirty(IPMUnknown *pFace, ImplementationID prop = kInvalidImpl, bool16 allowModification = kTrue);

 void PreDirtyAllowDuplicateMessage(IPMUnknown *pFace, ImplementationID prop = kInvalidImpl, bool16 allowModification = kTrue);

 void PreDirtyNoMessage(IPMUnknown *pFace, ImplementationID prop = kInvalidImpl, bool16 allowModification = kTrue);

 void PreDirtyOverrideMessage(IPMUnknown *pFace, PMIID overrideIID, ImplementationID prop = kInvalidImpl, bool16 allowModification = kTrue);

 void PreDirtyOverrideAllowDuplicateMessage(IPMUnknown *pFace, PMIID overrideIID, ImplementationID prop = kInvalidImpl, bool16 allowModification = kTrue);

 void PreDirty(IControllingUnknown *boss, IPMUnknown *p, ImplementationID prop, bool16 allowModification);

 void PreDirtyNoMessage(IControllingUnknown *boss, IPMUnknown *p, ImplementationID prop, bool16 allowModification);

 void PreDirtyViewInterface(IPMUnknown *pFace, ImplementationID prop = kInvalidImpl);

 ClassID GetClass( const IPMUnknown *obj);

 bool16 ClassesAreCompatible(const ClassID& aClass, const ClassID& bClass);

 bool16 ClassIsDescendantOf(const ClassID& anscestor, const ClassID& descendant);

 void CopyData(IPMStream *inStream, IPMStream *outStream, int32 length);

 class CopyDataFunctor
 {
 public:
 virtual bool Transfer(uchar *buffer, uint32 len) = 0;
 };

 void CopyData(IPMStream *inStream, int32 length, CopyDataFunctor *transferOut);





#ifdef DEBUG
// only only only for debug code!
 int32 GetRefCount(const IPMUnknown *obj);
 ImplementationID GetImplID(const IPMUnknown *obj, PMIID interfaceID);
#endif


// Internal Use Only
// passing nil will return the application's plug-in ID.
 PluginID GetPluginID( const IPMUnknown *obj );





#endif // __PersistUtils__