1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/Example/ExampleTwo.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,238 @@
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 +// The implementation of a some classes
1.18 +// to be provided by ECom.
1.19 +// 1. Using the CExampleInterface class as a base.
1.20 +//
1.21 +//
1.22 +
1.23 +#include "Interface.h"
1.24 +#include "ImplementationProxy.h"
1.25 +#include "TestUtilities.h" // For __FILE__LINE__
1.26 +
1.27 +// ____________________________________________________________________________
1.28 +//
1.29 +/**
1.30 + Intended usage: This class implements the functionality promised by
1.31 + the CExampleInterface defintion class. It does little apart from provides a test instance
1.32 + which may be retrieved and run for testing purposes.
1.33 + Its resolution is based upon its registered default data string that
1.34 + advertises this class as being able to handle 'text\wml' data.
1.35 + @since 7.0
1.36 + */
1.37 +class CImplementationClassFour : public CExampleInterface
1.38 +{
1.39 +// Methods
1.40 +public:
1.41 +/**
1.42 + @fn NewL(TAny* aInitParams)
1.43 + Intended Usage : Standardised safe construction which leaves nothing the cleanup stack.
1.44 + Error Condition : Leaves with error code.
1.45 + @leave KErrNoMemory.
1.46 + @since 7.0
1.47 + @param aInitParams The parameter struct used for initialising this object
1.48 + @return CImplementationClassFour* The class instance.
1.49 + @pre None
1.50 + @post CImplementationClassFour has been constructed,
1.51 + and initialised.
1.52 + */
1.53 + static CImplementationClassFour* NewL(TAny* aInitParams);
1.54 +
1.55 +/**
1.56 + @fn ~CImplementationClassFour()
1.57 + Intended Usage : Default Destructor
1.58 + Error Condition : None
1.59 + @since 7.0
1.60 + @pre CImplementationClassFour has been constructed
1.61 + @post CImplementationClassFour has been completely destroyed.
1.62 + */
1.63 + virtual ~CImplementationClassFour();
1.64 +
1.65 +/**
1.66 + @fn DoMethodL()
1.67 + Intended Usage : Overload of the pure interface method
1.68 + Representative of a method provided on
1.69 + the interface by the interface definer.
1.70 + Error Condition : Leaves with an error code.
1.71 + @leave KErrNoMemory, KErrNotSupported.
1.72 + @since 7.0
1.73 + @return None
1.74 + @pre CImplementationClassFour has been constructed
1.75 + @post Unspecified
1.76 + */
1.77 + void DoMethodL();
1.78 +
1.79 +/**
1.80 + @fn FireAndForget()
1.81 + Intended Usage : Overload of the pure interface method
1.82 + asynchronous function which
1.83 + an interface definer could specify.
1.84 + It allows the client to call the function in the knowledge
1.85 + that the object will commit suicide when the
1.86 + function completes.
1.87 + Error Condition : None.
1.88 + @since 7.0
1.89 + @return TInt KErrNone for success.
1.90 + @pre CImplementationClassFour has been constructed
1.91 + @post Unspecified
1.92 + */
1.93 + TInt FireAndForget();
1.94 +
1.95 + /**
1.96 + @fn ImplId()
1.97 + Intended Usage : To verify the object returned by ECOM.
1.98 + Error Condition : None.
1.99 + @since 7.0
1.100 + @return TUid (ECOM's Implementation Uid for this class.)
1.101 + @pre CImplementationClassThree has been constructed
1.102 + @post Unspecified
1.103 + */
1.104 + TUid ImplId();
1.105 +
1.106 +private:
1.107 +/**
1.108 + @fn CImplementationClassFour()
1.109 + Intended Usage : Default Constructor : usable only by derived classes
1.110 + Error Condition : None
1.111 + @since 7.0
1.112 + @pre None
1.113 + @post CImplementationClassFour has been constructed
1.114 + */
1.115 + CImplementationClassFour();
1.116 +
1.117 +/**
1.118 + @fn ConstructL(TAny* aInitParams)
1.119 + Intended Usage : Completes the safe construction of the CImplementationClassFour object
1.120 + Error Condition : Leaves with the error code.
1.121 + @leave KErrNoMemory.
1.122 + @since 7.0
1.123 + @param aInitParams The parameter struct used for initialising this object
1.124 + @pre CImplementationClassFour has been constructed
1.125 + @post CImplementationClassFour has been fully initialised.
1.126 + */
1.127 + void ConstructL(TAny* aInitParams);
1.128 +
1.129 +// Provide the CActive overloads
1.130 + void RunL();
1.131 + void DoCancel();
1.132 + TInt RunError(TInt aError);
1.133 +
1.134 +private:
1.135 +/** A place for allocating some memory in the ConstructL */
1.136 + HBufC* iInternalDescriptor;
1.137 +/** An int to be stored in TLS to test its useage */
1.138 + TInt iTLSInt;
1.139 +
1.140 +}; // End of CImplementationClassFour definition
1.141 +
1.142 +// __________________________________________________________________________
1.143 +// Implementation
1.144 +
1.145 +CImplementationClassFour* CImplementationClassFour::NewL(TAny* aInitParams)
1.146 +// Intended Usage : Safe construction which leaves nothing upon the cleanup stack
1.147 +// Error Condition : Will leave with an appropriate error code
1.148 +// Dependencies : CBase
1.149 +// @param " "
1.150 +// @return CImplementationClassFour* a pointer to the fully instantiated CImplementationClassFour object
1.151 +// @pre None
1.152 +// @post The object has been fully instantiated
1.153 +// Static member
1.154 + {
1.155 + CImplementationClassFour* self=new(ELeave) CImplementationClassFour(); // calls c'tor
1.156 + CleanupStack::PushL(self); // Make the construction safe by using the cleanup stack
1.157 + self->ConstructL(aInitParams); // Complete the 'construction'.
1.158 + CleanupStack::Pop(self);
1.159 + return self;
1.160 + }
1.161 +
1.162 +CImplementationClassFour::~CImplementationClassFour()
1.163 +// Default virtual d'tor
1.164 + {
1.165 + delete iInternalDescriptor;
1.166 + }
1.167 +
1.168 +CImplementationClassFour::CImplementationClassFour()
1.169 +// Default c'tor for use by derived and
1.170 +// static construction methods only
1.171 +: CExampleInterface()
1.172 + {
1.173 + // Deliberately do nothing here : See ConstructL() for initialisation completion.
1.174 + }
1.175 +
1.176 +void CImplementationClassFour::ConstructL(TAny* aInitParams)
1.177 +// Intended Usage : Safely complete the initialization of the constructed object
1.178 +// Error Condition : Will leave with an appropriate error code
1.179 +// Dependencies : CBase
1.180 +// @return void
1.181 +// @pre CImplementationClassFour has been constructed
1.182 +// @post The CImplementationClassFour object has been fully instantiated
1.183 +//
1.184 + {
1.185 + TExampleInterfaceInitParams* params = REINTERPRET_CAST(TExampleInterfaceInitParams*,
1.186 + aInitParams);
1.187 + if(params->descriptor)
1.188 + iInternalDescriptor = params->descriptor->AllocL();
1.189 +
1.190 + Dll::SetTls(&iTLSInt);
1.191 + }
1.192 +
1.193 +void CImplementationClassFour::DoMethodL()
1.194 + {
1.195 + // Access TLS to ensure it has been set properly
1.196 + REINTERPRET_CAST(TInt*, Dll::Tls());
1.197 + }
1.198 +
1.199 +TInt CImplementationClassFour::FireAndForget()
1.200 + {
1.201 + TRAPD(error,DoMethodL());
1.202 + return error; // Always KErrNotSupported
1.203 + }
1.204 +
1.205 +// Provide the CActive overloads
1.206 +void CImplementationClassFour::RunL()
1.207 + {
1.208 + // Do nothing : should never be called
1.209 + __ASSERT_DEBUG(EFalse,User::Invariant());
1.210 + }
1.211 +
1.212 +void CImplementationClassFour::DoCancel()
1.213 + {
1.214 + // Do nothing
1.215 + }
1.216 +
1.217 +TInt CImplementationClassFour::RunError(TInt /*aError*/)
1.218 + {
1.219 + return KErrNone;
1.220 + }
1.221 +
1.222 +TUid CImplementationClassFour::ImplId()
1.223 + {
1.224 + TUid idVal = {0x101F847A};
1.225 + return (idVal);
1.226 + }
1.227 +
1.228 +// __________________________________________________________________________
1.229 +// Exported proxy for instantiation method resolution
1.230 +// Define the interface UIDs
1.231 +const TImplementationProxy ImplementationTable[] =
1.232 + {
1.233 + IMPLEMENTATION_PROXY_ENTRY(0x101F847A, CImplementationClassFour::NewL)
1.234 + };
1.235 +
1.236 +EXPORT_C const TImplementationProxy* ImplementationGroupProxy(TInt& aTableCount)
1.237 + {
1.238 + aTableCount = sizeof(ImplementationTable) / sizeof(TImplementationProxy);
1.239 + return ImplementationTable;
1.240 + }
1.241 +