CPMUnknown.h

//========================================================================================
// 
// $File$
// 
// Owner: Mat Marcus
// 
// $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 __CPMUnknown__
#define __CPMUnknown__


#include "HelperInterface.h"


// Helper class for manaaging multiple PreDirty calls
class DirtyOptimizer : boost::noncopyable
{
public:

 DirtyOptimizer (IPMUnknown *face) :
 fFace (face),
 fDirtied (false)
 {
 }

 inline void PreDirty (ImplementationID prop = kInvalidImpl, bool16 allowModification = kTrue)
 {
 if (!fDirtied)
 {
 ::PreDirty (fFace, prop, allowModification);
 fDirtied = true;
 }
 }

 inline void PreDirtyNoMessage (ImplementationID prop = kInvalidImpl, bool16 allowModification = kTrue)
 {
 if (!fDirtied)
 {
 ::PreDirtyNoMessage (fFace, prop, allowModification);
 fDirtied = true;
 }
 }

private:

 IPMUnknown *fFace;
 bool fDirtied;
};


//========================================================================================
// CPMUnknown
//========================================================================================

template <class Interface>
class CPMUnknown : public Interface
{
public:
 IPMUnknown *QueryInterface(PMIID interfaceID) const;
 void AddRef() const;
 void Release() const;
 void PreDirty(ImplementationID prop = kInvalidImpl, bool16 allowModification = kTrue);
 void PreDirtyNoMessage(ImplementationID prop = kInvalidImpl, bool16 allowModification = kTrue);

 // Don't allow default construction, copy construction or assignment...
 CPMUnknown() = delete;
 CPMUnknown(const CPMUnknown &) = delete;
 CPMUnknown &operator =(const CPMUnknown &) = delete;

protected:
 explicit CPMUnknown(IPMUnknown *boss); 
 HelperInterface fHelperInterface;
};

//========================================================================================
// CPMUnknown implementation
//========================================================================================

template <class Interface>
CPMUnknown<Interface>::CPMUnknown(IPMUnknown *boss) :
 fHelperInterface(boss)
{
}

template <class Interface>
void CPMUnknown<Interface>::AddRef() const
{
 fHelperInterface.AddRef();
}
 
template <class Interface>
void CPMUnknown<Interface>::Release() const
{
 fHelperInterface.Release();
}

template <class Interface>
void CPMUnknown<Interface>::PreDirty(ImplementationID prop, bool16 allowModification)
{
 ::PreDirty(this, prop, allowModification);
}

template <class Interface>
void CPMUnknown<Interface>::PreDirtyNoMessage(ImplementationID prop, bool16 allowModification)
{
 ::PreDirtyNoMessage(this, prop, allowModification);
}

template <class Interface>
IPMUnknown* CPMUnknown<Interface>::QueryInterface(PMIID interfaceID) const
{
#ifdef DEBUG
 if (interfaceID == IID_IGETINTERFACEIMPL)
 return const_cast<CPMUnknown<Interface> *>(this);
#endif

 return fHelperInterface.QueryInterface(interfaceID);
}

#endif //__CPMUnknown__