1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/inc/ImplementationInformation.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,214 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// This file contains the definition of the CImplementationInformation API class.
1.18 +//
1.19 +//
1.20 +
1.21 +/**
1.22 + @file
1.23 + @publishedAll
1.24 + @released
1.25 +*/
1.26 +
1.27 +#ifndef __IMPLEMENTATIONINFORMATION_H__
1.28 +#define __IMPLEMENTATIONINFORMATION_H__
1.29 +
1.30 +// ____________________________________________________________________________
1.31 +// INCLUDES
1.32 +
1.33 +#include <s32std.h>
1.34 +#include <f32file.h>
1.35 +
1.36 +
1.37 +// ____________________________________________________________________________
1.38 +// TYPES
1.39 +
1.40 +/**
1.41 +Simplifies the definition of extended interfaces array
1.42 +@publishedPartner
1.43 +@released
1.44 +*/
1.45 +// To be used internally by ECOM and by Phone Manufacturers
1.46 +typedef RArray<TUid> RExtendedInterfacesArray;
1.47 +
1.48 +
1.49 +
1.50 +// ____________________________________________________________________________
1.51 +// CLASSES
1.52 +
1.53 +/**
1.54 +The CimplementationInformation class acts as the container for the registration
1.55 +data relating to a particular interface implementation.
1.56 +Note that this class is used in both the ECOM client and server side hence the
1.57 +mixed API classification seen below. For the client side only the API used to
1.58 +extract the registration data should be used.
1.59 +*/
1.60 +NONSHARABLE_CLASS(CImplementationInformation) : public CBase
1.61 + {
1.62 +public: // internalComponent APIs
1.63 + // Internal methods used only inside ECOM , not for client use.
1.64 +
1.65 + static CImplementationInformation* NewLC(TBool aClientSide,
1.66 + RReadStream& aStream);
1.67 +
1.68 + static CImplementationInformation* NewL(TUid aUid,
1.69 + TInt aVersion,
1.70 + HBufC* aName,
1.71 + HBufC8* aDataType,
1.72 + HBufC8* aOpaqueData,
1.73 + TDriveUnit aDrive,
1.74 + TBool aRomOnly,
1.75 + TBool aRomBased);
1.76 + static CImplementationInformation* NewL(TUid aUid,
1.77 + TInt aVersion,
1.78 + HBufC* aName,
1.79 + HBufC8* aDataType,
1.80 + HBufC8* aOpaqueData,
1.81 + TDriveUnit aDrive,
1.82 + TBool aRomOnly,
1.83 + TBool aRomBased,
1.84 + RExtendedInterfacesArray* aExtendedInterfaces);
1.85 +
1.86 + ~CImplementationInformation();
1.87 +
1.88 +public: // publishedAll APIs
1.89 + // Available for use by all clients
1.90 +
1.91 + inline const TDesC& DisplayName() const;
1.92 +
1.93 + inline const TDesC8& DataType() const;
1.94 + inline const TDesC8& OpaqueData() const;
1.95 +
1.96 + inline TUid ImplementationUid() const;
1.97 + inline TInt Version() const;
1.98 +
1.99 + inline TDriveUnit Drive() const;
1.100 +
1.101 + inline TBool RomOnly() const;
1.102 + inline TBool RomBased() const;
1.103 +
1.104 + inline TVendorId VendorId() const;
1.105 +
1.106 + inline TBool Disabled() const;
1.107 +
1.108 + // This function should not be used by any ECOM client as it will have no
1.109 + // effect at all on the implementation information stored in the server side
1.110 + inline void SetDisabled(TBool aDisabled);
1.111 +
1.112 + IMPORT_C void GetExtendedInterfaceListL(RExtendedInterfacesArray& aList);
1.113 +
1.114 +public: // internalComponent APIs
1.115 + // Internal methods used inside ECOM, not for client use.
1.116 +
1.117 + void ExternalizeL(TBool aClientSide,RWriteStream& aStream) const;
1.118 + void InternalizeL(TBool aClientSide,RReadStream& aStream);
1.119 +
1.120 + void SetRomBased(TBool aRomBased);
1.121 + void SetDrive(TDriveUnit aDrive);
1.122 +
1.123 + inline void SetVendorId(const TVendorId aVid);
1.124 +
1.125 + void AddExtendedInterfaceL(const TUid& aExtendedInterface);
1.126 + RExtendedInterfacesArray* GetExtendedInterfaceList();
1.127 +
1.128 +private: // internalComponent APIs
1.129 + // Internal methods used inside ECOM, not for client use.
1.130 +
1.131 + CImplementationInformation();
1.132 +
1.133 + CImplementationInformation(TUid aUid,
1.134 + TInt aVersion,
1.135 + HBufC* aName,
1.136 + HBufC8* aDataType,
1.137 + HBufC8* aOpaqueData,
1.138 + TDriveUnit aDrive,
1.139 + TBool aRomOnly,
1.140 + TBool aRomBased);
1.141 +
1.142 + CImplementationInformation(TUid aUid,
1.143 + TInt aVersion,
1.144 + HBufC* aName,
1.145 + HBufC8* aDataType,
1.146 + HBufC8* aOpaqueData,
1.147 + TDriveUnit aDrive,
1.148 + TBool aRomOnly,
1.149 + TBool aRomBased,
1.150 + RExtendedInterfacesArray* aExtendedInterfaces);
1.151 +
1.152 +private:
1.153 + /** The implementation UID */
1.154 + TUid iImplementationUid;
1.155 +
1.156 + /** The implementation version */
1.157 + TInt iVersion;
1.158 +
1.159 + /** This implementations human readable name intended for display in
1.160 + UI implementations */
1.161 + HBufC* iDisplayName;
1.162 +
1.163 + /** The type of data this implementation is registered to handle :
1.164 + Used for matching against the run-time cue provided by the client
1.165 + during default interface implementation resolution.
1.166 + */
1.167 + HBufC8* iData;
1.168 +
1.169 + /** Data registered for this implementation which can be used by the client
1.170 + during non-default resolution operations but is ignored by the framework.
1.171 + */
1.172 + HBufC8* iOpaqueData;
1.173 +
1.174 + /** The flag recording if this implementation is disabled or enabled */
1.175 + TBool iDisabled;
1.176 +
1.177 + /** The drive that this plug-in resides on */
1.178 + TDriveUnit iDrive;
1.179 +
1.180 + /** The flag recording whether this implementation may only be loaded
1.181 + from read-only internal media */
1.182 + TBool iRomOnly;
1.183 +
1.184 + /** This flag records whether this implementation was discovered on
1.185 + read-only internal media or that it is a later version of one that was */
1.186 + TBool iRomBased;
1.187 +
1.188 + /** The Vendor ID of the plug-in which this implementation belongs to*/
1.189 + TVendorId iVid;
1.190 +
1.191 + /** Array of extended interfaces.*/
1.192 + RExtendedInterfacesArray* iExtendedInterfaceList;
1.193 +
1.194 + }; // End CImplementationInformation
1.195 +
1.196 +
1.197 +// ____________________________________________________________________________
1.198 +// TYPES
1.199 +
1.200 +/**
1.201 +Simplifies the definition of functions which return registry information
1.202 +*/
1.203 +typedef RArray<CImplementationInformation*> RImplInfoArray;
1.204 +
1.205 +/**
1.206 +Simplifies the definition of functions which return registry information
1.207 +*/
1.208 +typedef RPointerArray<CImplementationInformation> RImplInfoPtrArray;
1.209 +
1.210 +
1.211 +// ____________________________________________________________________________
1.212 +// INLINES
1.213 +
1.214 +#include <ecom/implementationinformation.inl>
1.215 +
1.216 +
1.217 +#endif // __IMPLEMENTATIONINFORMATION_H__