1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/inc/ImplementationInformation.inl Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,202 @@
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 implementation of
1.18 +// the CImplementationInformation class.
1.19 +// Provide the inline implementation of CImplementationInformation
1.20 +// CImplementationInformation provides access to information on a particular implementation
1.21 +//
1.22 +//
1.23 +
1.24 +/**
1.25 +
1.26 + Intended Usage : Accessor for this implementation's human readable name
1.27 + @since 7.0
1.28 + @return The human readable name for this implementation
1.29 + @pre CImplementationInformation is fully constructed and initialized
1.30 +*/
1.31 +const TDesC& CImplementationInformation::DisplayName() const
1.32 + {
1.33 + if(iDisplayName == NULL)
1.34 + return KNullDesC();
1.35 + else
1.36 + return *iDisplayName;
1.37 + }
1.38 +
1.39 +
1.40 +/**
1.41 +Intended Usage : Accessor for this implementation's default binary data
1.42 +@since 7.0
1.43 +@return The data type which this implementation supports
1.44 +@pre CImplementationInformation is fully constructed and initialized
1.45 +*/
1.46 +const TDesC8& CImplementationInformation::DataType() const
1.47 + {
1.48 + if(iData == NULL)
1.49 + return KNullDesC8();
1.50 + else
1.51 + return *iData;
1.52 + }
1.53 +
1.54 +
1.55 +/**
1.56 +Intended Usage : Accessor for this implementation's opaque binary data
1.57 +@since 7.0
1.58 +@return The opaque data which is available for this implementation
1.59 +@pre CImplementationInformation is fully constructed and initialized
1.60 +*/
1.61 +const TDesC8& CImplementationInformation::OpaqueData() const
1.62 + {
1.63 + if(iOpaqueData == NULL)
1.64 + return KNullDesC8();
1.65 + else
1.66 + return *iOpaqueData;
1.67 + }
1.68 +
1.69 +
1.70 +/**
1.71 +Intended Usage : Accessor for this implementation's Uid
1.72 +@since 7.0
1.73 +@return The Uid of this implementation
1.74 +@pre CImplementationInformation is fully constructed and initialized
1.75 +*/
1.76 +TUid CImplementationInformation::ImplementationUid() const
1.77 + {
1.78 + return iImplementationUid;
1.79 + }
1.80 +
1.81 +
1.82 +/**
1.83 +Intended Usage : Accessor for the version number of this implementation
1.84 +@since 7.0
1.85 +@return The version number of this implementation
1.86 +@pre CImplementationInformation is fully constructed and initialized
1.87 +*/
1.88 +TInt CImplementationInformation::Version() const
1.89 + {
1.90 + return iVersion;
1.91 + }
1.92 +
1.93 +
1.94 +/**
1.95 +Intended Usage : Accessor for whether this implementation is currently
1.96 + disabled
1.97 +@since 7.0
1.98 +@return Flag indicating whether this implementation is disabled
1.99 +@pre CImplementationInformation is fully constructed and initialized
1.100 +*/
1.101 +TBool CImplementationInformation::Disabled() const
1.102 + {
1.103 + return iDisabled;
1.104 + }
1.105 +
1.106 +
1.107 +/**
1.108 +Intended Usage : Marks this implementation as disabled, or enabled.
1.109 +Note that this function should not be used by any ECOM client side as it will have no effect at all
1.110 +on the implementation information stored in the server side.
1.111 +@since 7.0
1.112 +@param aDisabled ETrue to indicate this implementation should be disabled, EFalse for enabled.
1.113 +@pre CImplementationInformation is fully constructed and initialized
1.114 +@post Implementation is marked as.
1.115 +*/
1.116 +void CImplementationInformation::SetDisabled(TBool aDisabled)
1.117 + {
1.118 + iDisabled = aDisabled;
1.119 + }
1.120 +
1.121 +/**
1.122 +Intended Usage : Returns the drive that this implementation is installed on
1.123 +Error Condition : None
1.124 +@since 7.0
1.125 +@return The drive that this implementation is on
1.126 +@pre CImplementationInformation is fully constructed.
1.127 +*/
1.128 +TDriveUnit CImplementationInformation::Drive() const
1.129 + {
1.130 + return iDrive;
1.131 + }
1.132 +
1.133 +
1.134 +/**
1.135 +Intended Usage : Accessor for whether this implementation is to be loaded
1.136 + from ROM only
1.137 +@return Flag indicating whether this implementation is to be loaded from ROM only
1.138 +@pre CImplementationInformation is fully constructed
1.139 +*/
1.140 +TBool CImplementationInformation::RomOnly() const
1.141 + {
1.142 + return iRomOnly;
1.143 + }
1.144 +
1.145 +/**
1.146 +Intended Usage : Accessor for whether this implementation is on ROM or is
1.147 + a later version of one on ROM
1.148 +@return Flag indicating whether this implementation is on ROM or is a later version of one on ROM
1.149 +@pre CImplementationInformation is fully constructed
1.150 +*/
1.151 +TBool CImplementationInformation::RomBased() const
1.152 + {
1.153 + return iRomBased;
1.154 + }
1.155 +/**
1.156 +Intended Usage: Returns the VID of the plug-in that this implementation belongs to.
1.157 + The VID is the VendorId for the plug-in's DLL
1.158 +@pre CImplementationInformation is fully constructed
1.159 +@return VendorId of the plug-in that this implementation belongs to.
1.160 +*/
1.161 +TVendorId CImplementationInformation::VendorId() const
1.162 + {
1.163 + return iVid;
1.164 + }
1.165 +
1.166 +/**
1.167 +Intended Usage: Sets the VID of the plug-in that this implementation belongs to.
1.168 + The VID is the VendorId for the plug-in's DLL.
1.169 +@internalComponent
1.170 +@pre CImplementationInformation is fully constructed
1.171 +@param aVid VendorId of the plug-in that this implementation belongs to.
1.172 +*/
1.173 +void CImplementationInformation::SetVendorId(const TVendorId aVid)
1.174 + {
1.175 + iVid = aVid;
1.176 + }
1.177 +
1.178 +// ____________________________________________________________________________
1.179 +// Provide the inline implementations of useful utilitiy functions related to
1.180 +// CImplementationInformation for use in client and server sides.
1.181 +//
1.182 +
1.183 +/**
1.184 +Comparison function used in ordering functions (e.g. as used with TLinearOrder)
1.185 +where ECOM UID identified structures are held in ordered RArray/RPointerArray
1.186 +objects.
1.187 +
1.188 +@internalComponent
1.189 +@param aUid1 First UID value of comparison
1.190 +@param aUid2 Second UID Value of comparison
1.191 +@return Returns 1 when aUid1 > aUid2; -1 when aUid1 < aUid2; 0 when they equal
1.192 +*/
1.193 +inline TInt CompareTUidValues(TInt aUid1, TInt aUid2)
1.194 + {
1.195 + // This has been implemented as 'return aUid1-aUid2' previously.
1.196 + // This can lead to overflow problems when comparing 2 signed integers
1.197 + // if the operands are large enough: large aUid minus large negative aUid2
1.198 + // returns a negative value due to arithmetic overflow of the result when
1.199 + // you'd want a positive value. Hence the longer hand implementation below.
1.200 + if (aUid1 > aUid2)
1.201 + return 1;
1.202 + if (aUid1 < aUid2)
1.203 + return -1;
1.204 + return 0;
1.205 + }