1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/Suicidal/Suicidal.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,269 @@
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 Suicidal class
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 "TestUtilities.h" // For __FILE__LINE__
1.24 +#include "Interface.h"
1.25 +#include "ImplementationProxy.h"
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, and then commits suicide.
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 CSuicidalImplementation : public CExampleInterface
1.38 +{
1.39 +// Methods
1.40 +public:
1.41 +/**
1.42 + @fn NewL()
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 + @return CSuicidalImplementation* The class instance.
1.48 + @pre None
1.49 + @post CSuicidalImplementation has been constructed,
1.50 + and initialised.
1.51 + */
1.52 + static CSuicidalImplementation* NewL();
1.53 +
1.54 +/**
1.55 + @fn ~CSuicidalImplementation()
1.56 + Intended Usage : Default Destructor
1.57 + Error Condition : None
1.58 + @since 7.0
1.59 + @pre CSuicidalImplementation has been constructed
1.60 + @post CSuicidalImplementation has been completely destroyed,
1.61 + and is no longer registered with the scheduler.
1.62 + */
1.63 + virtual ~CSuicidalImplementation();
1.64 +
1.65 +/**
1.66 + @fn DoMethodL()
1.67 + Intended Usage : Overload of the pure interface method
1.68 + Representative of some 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 CSuicidalImplementation 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 CSuicidalImplementation has been constructed
1.91 + @post CSuicidalImplementation is active with a status of KRequestPending.
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.0s
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 CSuicidalImplementation()
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 CSuicidalImplementation has been constructed
1.114 + */
1.115 + CSuicidalImplementation();
1.116 +
1.117 +/**
1.118 + @fn ConstructL()
1.119 + Intended Usage : Completes the safe construction of the CSuicidalImplementation object
1.120 + Error Condition : Leaves with the error code.
1.121 + @leave KErrNoMemory.
1.122 + @since 7.0
1.123 + @pre CSuicidalImplementation has been constructed
1.124 + @post CSuicidalImplementation has been fully initialised.
1.125 + */
1.126 + void ConstructL();
1.127 +
1.128 +// Provide the CActive overloads
1.129 +/**
1.130 + @fn RunL()
1.131 + Intended Usage : When the object activates commit suicide.
1.132 + Error Condition : Not enough memory available to complete the scan.
1.133 + @leave KErrNoMemory
1.134 + @since 7.0
1.135 + @pre CSuicidalImplementation is fully constructed.
1.136 + @post CSuicidalImplementation has committed suicide,
1.137 + and deleted itself.
1.138 + */
1.139 + void RunL();
1.140 +/**
1.141 + @fn DoCancel()
1.142 + Intended Usage : The cancel action called by CActive::Cancel().
1.143 + Error Condition : None
1.144 + @since 7.0
1.145 + @pre CSuicidalImplementation is fully constructed.
1.146 + @post CSuicidalImplementation behaviour is cancelled and
1.147 + it is no longer active on the current scheduler.
1.148 + */
1.149 + void DoCancel();
1.150 +
1.151 +/**
1.152 + @fn RunError(TInt aError)
1.153 + Intended Usage : Called by the RunL leaving.
1.154 + @since 7.0
1.155 + @param aError The error code that the RunL left with.
1.156 + @return TInt KErrNone.
1.157 + @pre CSuicidalImplementation is fully constructed.
1.158 + @post CSuicidalImplementation is returned to a
1.159 + sensible active state.
1.160 + */
1.161 + TInt RunError(TInt aError);
1.162 +
1.163 +}; // End of CSuicidalImplementation definition
1.164 +
1.165 +// __________________________________________________________________________
1.166 +// Implementation
1.167 +const TInt KDefaultTestAllocSize = 8;
1.168 +
1.169 +CSuicidalImplementation* CSuicidalImplementation::NewL()
1.170 +// Intended Usage : Safe construction which leaves nothing upon the cleanup stack
1.171 +// Error Condition : Will leave with an appropriate error code
1.172 +// Dependencies : CBase
1.173 +// @param " "
1.174 +// @return CSuicidalImplementation* a pointer to the fully instantiated CSuicidalImplementation object
1.175 +// @pre None
1.176 +// @post The object has been fully instantiated
1.177 +// Static member
1.178 + {
1.179 + CSuicidalImplementation* self=new(ELeave) CSuicidalImplementation(); // calls c'tor
1.180 + CleanupStack::PushL(self); // Make the construction safe by using the cleanup stack
1.181 + self->ConstructL(); // Complete the 'construction'.
1.182 + CleanupStack::Pop(self);
1.183 + return self;
1.184 + }
1.185 +
1.186 +CSuicidalImplementation::~CSuicidalImplementation()
1.187 +// Default virtual d'tor
1.188 + {
1.189 + // Do Nothing
1.190 + }
1.191 +
1.192 +CSuicidalImplementation::CSuicidalImplementation()
1.193 +// Default c'tor for use by derived and
1.194 +// static construction methods only
1.195 +: CExampleInterface()
1.196 + {
1.197 + // Deliberately do nothing here : See ConstructL() for initialisation completion.
1.198 + }
1.199 +
1.200 +void CSuicidalImplementation::ConstructL()
1.201 +// Intended Usage : Safely complete the initialization of the constructed object
1.202 +// Error Condition : Will leave with an appropriate error code
1.203 +// Dependencies : CBase
1.204 +// @return void
1.205 +// @pre CSuicidalImplementation has been constructed
1.206 +// @post The CSuicidalImplementation object has been fully instantiated
1.207 +//
1.208 + {
1.209 + // Allocate and delete some memory
1.210 + // so that leave testing can check
1.211 + // for the correct handling.
1.212 + HBufC* temp = HBufC::NewL(KDefaultTestAllocSize);
1.213 + delete temp;
1.214 + }
1.215 +
1.216 +void CSuicidalImplementation::DoMethodL()
1.217 + {
1.218 + CActiveScheduler::Add(this);
1.219 + }
1.220 +
1.221 +TInt CSuicidalImplementation::FireAndForget()
1.222 + {
1.223 + TInt error = KErrNone;
1.224 + TRAP(error,DoMethodL());
1.225 + if(!IsActive())
1.226 + {
1.227 + SetActive();
1.228 + iStatus = KRequestPending;
1.229 + TRequestStatus* status = &iStatus;
1.230 + User::RequestComplete(status, error);
1.231 + }
1.232 + return error;
1.233 + }
1.234 +
1.235 +// Provide the CActive overloads
1.236 +void CSuicidalImplementation::RunL()
1.237 + {
1.238 + User::LeaveIfError(iStatus.Int());
1.239 + delete this; // AAARGH : Scary self deletion!!!!
1.240 + }
1.241 +
1.242 +void CSuicidalImplementation::DoCancel()
1.243 + {
1.244 + // Do nothing
1.245 + }
1.246 +
1.247 +TInt CSuicidalImplementation::RunError(TInt)
1.248 + {
1.249 + delete this; // AAARGH : Scary self deletion!!!!
1.250 + return KErrNone; // Don't Panic
1.251 + }
1.252 +
1.253 +TUid CSuicidalImplementation::ImplId()
1.254 + {
1.255 + TUid idVal = {0x10009DC5};
1.256 + return (idVal);
1.257 + }
1.258 +
1.259 +// __________________________________________________________________________
1.260 +// Exported proxy for instantiation method resolution
1.261 +// Define the interface UIDs
1.262 +const TImplementationProxy ImplementationTable[] =
1.263 + {
1.264 + IMPLEMENTATION_PROXY_ENTRY(0x10009DC5, CSuicidalImplementation::NewL) // SuicidalImplementationClass
1.265 + };
1.266 +
1.267 +EXPORT_C const TImplementationProxy* ImplementationGroupProxy(TInt& aTableCount)
1.268 + {
1.269 + aTableCount = sizeof(ImplementationTable) / sizeof(TImplementationProxy);
1.270 +
1.271 + return ImplementationTable;
1.272 + }