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