IClassInfo.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.
// 
// 
// Review Date:
// 
//========================================================================================

#ifndef __ICLASSINFO__
#define __ICLASSINFO__

#include "ShuksanID.h"
#include "IControllingUnknown.h"
#include <utility>

// Forward declare
class InterfaceInfo;

class IClassInfo : public IControllingUnknown {
public:
 virtual int32 CountInterfaces() const = 0;
 
 virtual PMIID GetInterface(int32 index) const = 0;
 
 virtual ImplementationID GetImplementation(PMIID whichInterface) const = 0;
 
 virtual ImplementationID GetImplementationByIndex(int32 interfaceIndex) const = 0;
 
 virtual PMIID GetIID(ImplementationID whichInterface) const = 0;
 
 virtual ClassID GetClass() const = 0;

 virtual ClassID GetParentClass() const = 0;

 virtual PluginID GetOwnerComponent(PMIID forWhat = IID_IUNKNOWN) const = 0;
 
 

 // For Internal Use Only

#ifdef USE_ALLOCATE_WITH_BOSS
 // Return the size in bytes to allocate for the boss.
 virtual int32 LengthInBytes() const = 0;
#endif

 // Create a new instance of the interface. The instance is
 // completely blank, and will require initialization by the
 // caller (for instance, to specify the boss).
 virtual IPMUnknown *CreateInterface(InterfaceInfo const* interfaceInfo, IControllingUnknown *boss) const = 0;

 // Delete the interface/
 virtual void DestructInterface(int32 index, IPMUnknown *obj) const = 0;

 // Return the index where PMIID is found, or -1 if there is none.
 virtual int32 GetIndex(PMIID interfaceID) const = 0;

#ifdef USE_ALLOCATE_WITH_BOSS
 // Return the offset within the boss block of the n'th interface, or 0 if the
 // interface is indepenedently allocated.
 virtual int32 GetOffset(int32 i) const = 0;

 // Return true if all interfaces are allocated in the same memory block as the boss.
 virtual bool16 IsAtomic() const = 0;
#endif

 virtual void Init(ClassID clsID) = 0;
 
 // Set the UID of the object model that owns this class info.
 //virtual void SetObjectModel(UID objectModel) = 0;

 // Set the ClassID of the class that this classinfo represents. Invalid if
 // the class already has a ClassID.
 //virtual void SetClass(ClassID clsID) = 0;

 // Set the parent (base) class. Does nothing if the owner or parent has 
 // already been set.
 virtual void SetParentClass(ClassID parentClass) = 0;

 // Sets the owner as specified. Does nothing if the owner has already been set.
 virtual void SetOwnerComponent(PluginID owner) = 0;

 // Add a new interface to the class. The interface is identified
 // by the interfaceID, and instances of it can be created
 // with the factory.
 virtual void AddInterface(PMIID interfaceID, ImplementationID faceID, PluginID owner, bool16 asAddin = kFalse) = 0;
 
 virtual std::pair<InterfaceInfo const*, int32> FindInterfaceInfo(PMIID interfaceID) const = 0;

 virtual void FinalizeClassInfo() = 0;

 virtual void Unregister(PluginID owner) = 0;
 
 // Keep track of how many bosses are currently instantiated for this class
#ifdef DEBUG
public:
 virtual void ConstructedBoss() const = 0;
 virtual void DestructedBoss() const = 0;
 virtual int32 CurrentInstanceCount() const = 0;
 virtual int32 InstanceCount() const = 0;
 virtual int32 HighWaterMark() const = 0;
#endif

#ifdef DEBUG
 virtual void QueriedInterface(int32 index) = 0;
#endif

 virtual IPMUnknown *ConstructBoss() const = 0;
};


#endif // __ICLASSINFO__