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