sl@0: // Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description: The main purpose of RTFXEffect implementation is to forward 
sl@0: // RWsSession/RWindowBase calls to RegisterEffect and OverrideEffect to server side. 
sl@0: // Please see documantion of RTFXEffect::RegisterTFXEffect() for more details.
sl@0: //
sl@0: 
sl@0: #include "rtfxeffect.h"
sl@0: #include "w32comm.h"
sl@0: #include "client.h"
sl@0: 
sl@0: /**
sl@0: Constructor which takes handle and buffer paratemter and initilaizes 
sl@0: its member variables.
sl@0: 
sl@0: @param aHandle Client side handle of the class derived from MWsClientClass
sl@0: @param aBuffer Pointer to the wserv client side buffer of the above class
sl@0: */
sl@0: RTFXEffect::RTFXEffect(TInt aHandle, RWsBuffer* aBuffer) 
sl@0: 	: MWsClientClass(aBuffer), iDirPathSizePaded(0), iFileName1SizePaded(0),
sl@0: 	  iFileName2SizePaded(0), iCombSizePaded(0) 
sl@0: 	{
sl@0: 	iWsHandle = aHandle;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Function checks the sent parmaters and pancis client if any of its length 
sl@0: is greater than KMaxFileName. Calculates the padded lengths of sent parameters
sl@0: and stores them in member variables
sl@0: 
sl@0: @param aResourceDir directory name of animation description file
sl@0: @param aFilenameOutgoing File name of Outgoing phase of TFX
sl@0: @param aFilenameIncoming File name of Incoming phase of TFX
sl@0: */
sl@0: void RTFXEffect::CheckFileNameAndSetSizes(const TFileName& aResourceDir, 
sl@0: 		const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming)
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(aResourceDir.Length() <= KMaxFileName, Panic(EW32PanicStringTooLong));
sl@0: 	__ASSERT_ALWAYS(aFilenameOutgoing.Length() <= KMaxFileName, Panic(EW32PanicStringTooLong));
sl@0: 	__ASSERT_ALWAYS(aFilenameIncoming.Length() <= KMaxFileName, Panic(EW32PanicStringTooLong));
sl@0: 	
sl@0: 	iDirPathSizePaded = PaddedValue(aResourceDir.Size());
sl@0: 	iFileName1SizePaded = PaddedValue(aFilenameOutgoing.Size());
sl@0: 	iFileName2SizePaded = PaddedValue(aFilenameIncoming.Size());
sl@0: 	
sl@0: 	iCombSizePaded = iDirPathSizePaded + iFileName1SizePaded + iFileName2SizePaded;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Appends folder and file names to wserv client's buffer using AppendData() of MWsClientClass.
sl@0: AppendData adds data directly to buffer. So before calling AppendData we must make sure that
sl@0: current command is added to buffer. Please see description of MWsClientClass::AppendData()
sl@0: for more details.
sl@0: 
sl@0: @param aResourceDir directory name of animation description file
sl@0: @param aFilenameOutgoing File name of Outgoing phase of TFX
sl@0: @param aFilenameIncoming File name of Incoming phase of TFX
sl@0: */
sl@0: void RTFXEffect::AppendFileNameData(const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming)
sl@0: 	{
sl@0: 	AppendData(aResourceDir.Ptr(), aResourceDir.Size(), EFalse);
sl@0:     AppendData(aFilenameOutgoing.Ptr(), aFilenameOutgoing.Size(), EFalse);
sl@0:     AppendData(aFilenameIncoming.Ptr(), aFilenameIncoming.Size(), ETrue);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Writes file names using IPC args along with data related to TWsClCmdRegisterEffect
sl@0: Out going phase animation file name is sent in second slot of IPC to server
sl@0: In coming phase animation file name is sent in third slot of IPC to server
sl@0: Data related to TWsClCmdRegisterEffect and folder name are sent in the normal wserv buffer
sl@0: 
sl@0: @param aForRegister an object of TWsClCmdRegisterEffect filled with data related to RegisterTFXEffect
sl@0: 					If non Empty then this function is called for Register effect
sl@0: @param aForOverride an object of TWsClCmdOverrideEffect filled with data related to OverrideTFXEffect
sl@0: 					If non Empty then this function is called for Overide effect					 
sl@0: @param aResourceDir directory name of animation description file
sl@0: @param aFilenameOutgoing File name of Outgoing phase of TFX
sl@0: @param aFilenameIncoming File name of Incoming phase of TFX
sl@0: @param aCalledFrom value from TFXEffect enum reprseting whether called from RWsSession or RWindowbase 	
sl@0: */
sl@0: void RTFXEffect::WriteDataUsingIPC(TWsClCmdRegisterEffect* aForRegister, TWsClCmdOverrideEffect* aForOverride, 
sl@0: 		const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TFXEffect aCalledFrom)
sl@0: 	{
sl@0: 	TIpcArgs ipcArgsDesc;
sl@0: 	ipcArgsDesc.Set(1, &aFilenameOutgoing);
sl@0: 	ipcArgsDesc.Set(2, &aFilenameIncoming);
sl@0: 	// If called for RegisterTFXEffect
sl@0: 	if (aForRegister)
sl@0: 		{
sl@0: 		Write(aForRegister, sizeof(*aForRegister), aResourceDir.Ptr(), aResourceDir.Size(), 
sl@0: 				EWsClOpRegisterTFXEffectIPC, &ipcArgsDesc);
sl@0: 		}
sl@0: 	else	// Else called for OverrideTFXEffect
sl@0: 		{
sl@0: 		Write(aForOverride, sizeof(*aForOverride), aResourceDir.Ptr(), aResourceDir.Size(), 
sl@0: 				(aCalledFrom == ETFXSession ? EWsClOpOverrideEffectIPC : EWsWinOpOverrideEffectIPC), &ipcArgsDesc);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Checks if the sum of iCombSizePaded, size of TWsCmdHeader and sent size is less than
sl@0: the current buffer size.
sl@0: 
sl@0: @param aSize size to be compared with current buffer size
sl@0: @return ETrue if the combined size if less then or equal to current buffer size
sl@0: 		EFalse if the combined size is greater then current buffer size
sl@0:  */
sl@0: TBool RTFXEffect::CheckCombinedSizeWithCurrentBuffer(TInt aSize) const
sl@0: 	{
sl@0: 	return (iCombSizePaded + aSize + sizeof(TWsCmdHeader) <= iBuffer->BufferSize());
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Checks the length of sent variables and does as explained below   
sl@0: 
sl@0: Main logic involved in both RegisterTFXEffect() and OverrideTFXEffect() is as follows
sl@0: First check the sum of all strings 
sl@0: If it is less then max wserv buffer
sl@0:  Send unpadded sizes in TWsClCmdRegisterEffect/TWsClCmdOverrideEffect but when we append 
sl@0:  the data we make sure that we pad it
sl@0:  Then at server side get the buffer for total length(inlcuding pading)and unpad it and 
sl@0:  send it to renderstage's RegisterEffect/OverrideEffect function
sl@0: If it is greater then max wserv buffer 
sl@0:  Send one string in the wserv buffer as done before ie. pading and unpading
sl@0:  Other two strings are sent using IPC args in 2 and 3 slot of IPC and do explicit flush
sl@0:  And at server side get one string from buffer and other 2 from IPC
sl@0: 
sl@0: @param aAction Particular transition to register the animation for.
sl@0: @param aPurpose The purpose of the window.
sl@0: @param aResourceDir The name of the directory that contains the animation description files.
sl@0: @param aFilenameOutgoing The file containing the description of the animation for the outgoing phase of the transition. 
sl@0: 						 Specify KNullDesC for no outgoing phase effect.
sl@0: @param aFilenameIncoming The file containing the description of the animation for the incoming phase of the transition. 
sl@0: 						 Specify KNullDesC for no incoming phase effect.
sl@0: @param aAppUid The Application UID this effect applies to. Set to zero to specify that all apps will use default effect.
sl@0: @param aFlags Flag for the effect. Please see TTfxFlags for values this flag parameter can use.
sl@0: */
sl@0: void RTFXEffect::RegisterTFXEffect(TInt aAction, TInt aPurpose, const TFileName& aResourceDir, 
sl@0: 		const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TUint aAppUid, TBitFlags aFlags)
sl@0: 	{
sl@0: 	CheckFileNameAndSetSizes(aResourceDir, aFilenameOutgoing, aFilenameIncoming);
sl@0: 	if (CheckCombinedSizeWithCurrentBuffer(sizeof(TWsClCmdRegisterEffect)))
sl@0: 		{
sl@0: 		TWsClCmdRegisterEffect params(aAction, aPurpose, aResourceDir.Size(), aFilenameOutgoing.Size(), aFilenameIncoming.Size(), aAppUid, aFlags);
sl@0: 		// Here we just pass the length of combined strings so that it checks and does flush if needed.
sl@0: 		// Then AppendData actually adds the data to buffer at the end
sl@0: 		Write(&params, sizeof(params), iCombSizePaded, EWsClOpRegisterTFXEffectBuf);
sl@0: 		if (iCombSizePaded > 0)
sl@0: 			AppendFileNameData(aResourceDir, aFilenameOutgoing, aFilenameIncoming);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		TWsClCmdRegisterEffect params(aAction, aPurpose, aResourceDir.Size(), 0, 0, aAppUid, aFlags);
sl@0: 		WriteDataUsingIPC(&params, NULL, aResourceDir, aFilenameOutgoing, aFilenameIncoming, ETFXSession);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Checks the length of sent variables and does as explained in
sl@0: RTFXEffect::RegisterTFXEffect() API description
sl@0: 
sl@0: @param aAction The particular transition to set the animation for.
sl@0: @param aPurpose This override only effects the window/layers owned by the application that have the specified purpose.
sl@0: @param aResourceDir The name of the directory that contains the animation description files.
sl@0: @param aFilenameOutgoing The file containing the description of the animation for the outgoing phase of the transition. 
sl@0: 						 Specify KNullDesC for no outgoing phase effect.
sl@0: @param aFilenameIncoming The file containing the description of the animation for the incoming phase of the transition. 
sl@0: 						 Specify KNullDesC for no incoming phase effect.
sl@0: @param aFlags Flag for the effect. Please see TTfxFlags for values this flag parameter can use.
sl@0: */
sl@0: void RTFXEffect::OverrideTFXEffect(TFXEffect aCalledFrom, TInt aAction, TInt aPurpose, const TFileName& aResourceDir, 
sl@0: 		const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TBitFlags aFlags)
sl@0: 	{
sl@0: 	CheckFileNameAndSetSizes(aResourceDir, aFilenameOutgoing, aFilenameIncoming);
sl@0: 	if (CheckCombinedSizeWithCurrentBuffer(sizeof(TWsClCmdOverrideEffect)))
sl@0: 		{
sl@0: 		TWsClCmdOverrideEffect params(aAction, aPurpose, aResourceDir.Size(), aFilenameOutgoing.Size(), aFilenameIncoming.Size(), aFlags);
sl@0: 		Write(&params, sizeof(params), iCombSizePaded, (aCalledFrom == ETFXSession ? EWsClOpOverrideEffectBuf : EWsWinOpOverrideEffectBuf));
sl@0: 		if (iCombSizePaded > 0)
sl@0: 			AppendFileNameData(aResourceDir, aFilenameOutgoing, aFilenameIncoming);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		TWsClCmdOverrideEffect params(aAction, aPurpose, aResourceDir.Size(), 0, 0, aFlags);
sl@0: 		WriteDataUsingIPC(NULL, &params, aResourceDir, aFilenameOutgoing, aFilenameIncoming, aCalledFrom);
sl@0: 		}
sl@0: 	}