IObjectModel.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.
// 
//========================================================================================

#ifndef __IOBJECTMODEL__
#define __IOBJECTMODEL__


#include "IPMUnknown.h"
#include "ShuksanID.h"
#include "InterfaceTrackingUtils.h"

class IClassInfo;
class IObjectModelIterator;
class ITagRegistry;
class IInterfaceRegistry;
class InterfaceProxyRegistry;
class ReadWriteObject;
class ObjectModel;
class BossConstructorList;


class IObjectModel : public IPMUnknown {
public:
 enum { kDefaultIID = IID_IOBJECTMODEL };

 //-------------------------------------------------------------------------------


 virtual uint32 CountClasses() const = 0;

 virtual ClassID GetClassID(uint32 indexCount) const = 0;

 virtual IClassInfo *QueryClassInfo(ClassID theClass) const = 0;

 virtual IObjectModelIterator * NewObjectModelIterator(PMIID iid) const = 0;
 
 //-------------------------------------------------------------------------------

 
 virtual const char* GetIDName(int32 idSpace, int32 id) const = 0;

 virtual const char* GetIDName(ClassID id) const = 0;

 virtual const char* GetIDName(PMIID id) const = 0;

 virtual const char* GetIDName(ImplementationID id) const = 0;

 virtual const char* GetIDName(PluginID id) const = 0;

 virtual const char* GetIDName(ServiceID id) const = 0;

 virtual const char* GetIDName(WidgetID id) const = 0;

 virtual const char* GetIDName(ActionID id) const = 0;
 
 virtual IPMUnknown *ConstructObject(ClassID theClass, PMIID iid) const = 0;

 virtual ReadWriteObject QueryReadWrite(ImplementationID faceID) const = 0;

 virtual void ReleaseReadWrite(const ReadWriteObject& releaseThis) const = 0;

 virtual ReadWriteObject QueryInterfaceSnapshotReadWrite(ImplementationID faceID) const = 0;

 virtual InterfaceResetViewFun QueryInterfaceResetViewFun(ImplementationID prop) const = 0;

 virtual void ReleaseInterfaceResetViewFun (ImplementationID prop) const = 0;

 //-------------------------------------------------------------------------------


 // Register a new ID.
 virtual void RegisterID(PluginID ownerComponent, int32 IDSpaceID, const char* name, int32 id) = 0;

 // Tells the object model how to create an instance of the class.
 virtual void AddClassFactory(PluginID ownerComponent, ClassID id, BossConstructor construct) = 0;
 // Tells the object model how to create a given interface implementation. Factoryname is the name
 // of the implementation class.
 virtual void RegisterInterfaceFactory(PluginID ownerComponent, ImplementationID faceID) = 0;
 virtual void FillOutInterfaceFactory(PluginID ownerComponent, ImplementationID faceID, InterfaceConstructor construct, InterfaceDestructor destroyer, InterfaceSizeOf sizeofFunc, InterfaceReadWrite readWriter, InterfaceReadWrite snapshotReadWriter, InterfaceResetViewFun resetViewFun) = 0;
 virtual void AddImplementationAlias(PluginID ownerComponent, ImplementationID implID, ImplementationID basedOn) = 0;
 
 // Return a pointer to the tags registry.
 virtual ITagRegistry *GetTagRegistry() = 0;

 // Return the ID of the plugin that supplies the implementation.
 virtual PluginID GetOwner(ImplementationID implID) const = 0;
 // Return the ID of the plugin that supplies the aliased implementation.
 virtual PluginID GetOwnerAlias(ImplementationID implID) const = 0;
 
 virtual IInterfaceRegistry *GetInterfaceRegistry() const = 0;
 
 virtual BossConstructor GetClassConstructor(const ClassID theClass) const = 0;
 
 
#ifdef INTERFACEPROXIES_SUPPORTED 
 virtual IPMUnknown* CreateProxyObject ( const PMIID faceID, 
 IPMUnknown *ptheInterfaceImpl, 
 const int32 proxyID,
 IPMUnknown *boss) = 0;
 
 virtual InterfaceReadWrite GetNonProxyReadWriter(ImplementationID faceID) const = 0;
 virtual InterfaceReadWrite GetNonProxySnapshotReadWriter(ImplementationID faceID) const = 0;
 virtual InterfaceResetViewFun GetNonProxyInterfaceResetViewFun(ImplementationID faceID) const = 0;

 virtual bool16 InterfaceIsTracked(const PMIID faceID) const = 0;
 virtual void TrackInterface(const PMIID interfaceID, const ClassID clsid) = 0; 
 virtual bool16 BossIsTracked(const ClassID id) const = 0;
 virtual void TrackBoss(const ClassID id) = 0;
#endif

#ifdef DEBUG
#ifdef INTERFACEPROXIES_SUPPORTED
 virtual bool16 IsBossTrackingOn(void) const = 0;
#endif
 virtual void XferSavedDataStuff(IPMStream*) = 0;
#endif

 
};

class ReadWriteObject {
 public:

#ifdef DEBUG
 ReadWriteObject(InterfaceReadWrite readWrite, ImplementationID implID = kInvalidImpl) :
 fImplID(implID),
#else
 ReadWriteObject(InterfaceReadWrite readWrite) :
#endif
 fReadWrite(readWrite)
 {}
 InterfaceReadWrite GetReadWrite() const { return fReadWrite; }
 private:
 InterfaceReadWrite fReadWrite;
#ifdef DEBUG
 public:
 ImplementationID GetImplementationID() const
 { return fImplID; }
 private:
 ImplementationID fImplID;
#endif
};


class StackBasedSnapshotReadWritePtr
{
public:
 StackBasedSnapshotReadWritePtr(const IObjectModel *om, ImplementationID implID) : 
 fObjectModel(om),
 fSnapshotReadWrite(om->QueryInterfaceSnapshotReadWrite(implID))
 {}
 
 ~StackBasedSnapshotReadWritePtr()
 {
 fObjectModel->ReleaseReadWrite(fSnapshotReadWrite);
 }
 
 operator InterfaceReadWrite() const
 { return fSnapshotReadWrite.GetReadWrite(); }
 InterfaceReadWrite GetSnapshotReadWrite() const
 { return fSnapshotReadWrite.GetReadWrite(); }
 
private:
 ReadWriteObject fSnapshotReadWrite;
 const IObjectModel *fObjectModel;
};

class StackBasedReadWritePtr
{
public:
 StackBasedReadWritePtr(const IObjectModel *om, ImplementationID implID) : 
 fObjectModel(om),
 fReadWrite(om->QueryReadWrite(implID))
 {}
 
 ~StackBasedReadWritePtr()
 {
 fObjectModel->ReleaseReadWrite(fReadWrite);
 }
 
 operator InterfaceReadWrite() const
 { return fReadWrite.GetReadWrite(); }
 InterfaceReadWrite GetReadWrite() const
 { return fReadWrite.GetReadWrite(); }
 
private:
 ReadWriteObject fReadWrite;
 const IObjectModel *fObjectModel;
};

 IObjectModel* GetObjectModelInstance();



#endif // __IOBJECTMODEL__