sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // This file contains the definition for the Extended Interface TImplementationProxy structure.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0:  @publishedPartner
sl@0:  @released
sl@0: */
sl@0: 
sl@0: #ifndef __EXTENDED_INTERFACE_IMPLEMENTATIONPROXY_H__
sl@0: #define __EXTENDED_INTERFACE_IMPLEMENTATIONPROXY_H__
sl@0: 
sl@0: // ____________________________________________________________________________
sl@0: // INCLUDES
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <ecom/implementationproxy.h>
sl@0: 
sl@0: // ____________________________________________________________________________
sl@0: // TYPES - TImplementationProxy3
sl@0: 
sl@0: /**
sl@0: Pre-defined function pointer type used in TImplementationProxy3 to fetch the extended interface
sl@0: @param      aObject A pointer to the instantiation interface implementation returned by a call to one of the 
sl@0:             CreateImplementationL() methods
sl@0: @param      aExtendedInterfaceUid Identifies the interface to fetch from the instantiation interface implementation.
sl@0: @param      aBitFlags Output parameter used for communication between plugin's and ECOM. Currently used by plugin implementors 
sl@0:             to signal if an extended interface implementation requires release.
sl@0: @param      aReleaseObject Optional output parameter. If the plugin is allocating a new extension object then the address 
sl@0:             returned by new must be returned in this argument for ECOM to supply it back to the plugin implementation for 
sl@0:             later deletion when release is requried, aBitFlags must have the KReleaseRequiredMask flag set in such cases. 
sl@0:             If a simple re-cast extension pattern is used in this proxy function then this argument should be left unchanged.
sl@0: @leave		KErrNoMemory
sl@0: @leave      Or any of the System Wide error codes
sl@0: @return     TAny* A pointer to the extended interface implementation if the instantiation interface implementation
sl@0:             supports it, or NULL if the instantiation interface implementation does not support it.
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: typedef TAny* (*TFuncPtrGetL)(TAny* /* aObject */, const TUid& /* aExtendedInterfaceUid */, TUint32& /* aBitFlags */, TAny*& /* aReleaseObject */);
sl@0: 
sl@0: /**
sl@0: Pre-defined function pointer type used in TImplementationProxy3 to release the 
sl@0: extended interface. Implementations of this function must never leave.
sl@0: @param      aReleaseObject The release object address, previously supplied by a function of type TProxyExtendedInterfaceGetPtrL,
sl@0:             that is to be deleted by the instantiation interface implementation.
sl@0: @param      aExtendedInterfaceUid Identifies the extended interface implementation that is to be released. If the supplied
sl@0:             uid is not recognised then this function should be implemented in such a way that it returns without performing
sl@0:             any cleanup.  
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: typedef void (*TFuncPtrRelease)(TAny* /* aReleaseObject */, const TUid& /* aExtendedInterfaceUid */);
sl@0: 
sl@0: /**
sl@0: Type definition for function pointer to fetch the extended interface.
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: typedef TFuncPtrGetL TProxyExtendedInterfaceGetPtrL;
sl@0: 
sl@0: /**
sl@0: Type definition for function pointer to release the extended interface.
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: typedef TFuncPtrRelease TProxyExtendedInterfaceReleasePtr;
sl@0: 
sl@0: /**
sl@0: Extended interface bit masks.
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: const TUint32 KReleaseRequiredMask = 0x00000001;
sl@0: 
sl@0: 
sl@0: /**
sl@0: The structure that defines the pairing required by the ECOM framework
sl@0: to correctly identify the instantiation method pointer to provide
sl@0: to a client's resolution request. This is for PLUGIN3 dll's and
sl@0: implementations.
sl@0: 
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: typedef struct
sl@0: 	{
sl@0: 	/** The unique UID for an Interface Implementation */
sl@0: 	TUid	iImplementationUid;
sl@0: 	/** The function pointer to the instantiation method */
sl@0: 	TProxyNewLPtr iNewLFuncPtr;
sl@0: 	/** The function pointer to the method used to fetch extended interfaces*/
sl@0: 	TProxyExtendedInterfaceGetPtrL iFuncPtrInterfaceGetL;
sl@0: 	/** The function pointer used to release the extended interfaces. This MUST be a non-leaving method.*/
sl@0: 	TProxyExtendedInterfaceReleasePtr iFuncPtrInterfaceRelease;
sl@0: 	/** reserved for future proofing*/
sl@0: 	TInt32 iReserved1;
sl@0: 	TInt32 iReserved2;
sl@0: 	TInt32 iReserved3;
sl@0: 	TInt32 iReserved4;
sl@0: 	} TImplementationProxy3;
sl@0: 	
sl@0: /**
sl@0: Macro to initialise an element of a static array of TImplementationProxy objects with PLUGIN3 type.
sl@0: This macro deals with casting the function pointer to the type used in the structure.
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: #define IMPLEMENTATION_PROXY_ENTRY3(aUid, aFuncPtr, aGetExtFuncPtr, aReleaseExtFuncPtr)	{{aUid},(TProxyNewLPtr)(aFuncPtr),(aGetExtFuncPtr),(aReleaseExtFuncPtr),0,0,0,0}
sl@0: 
sl@0: #endif	// __EXTENDED_INTERFACE_IMPLEMENTATIONPROXY_H__