1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/graphics/windowing/windowserver/nga/CLIENT/rtfxeffect.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,197 @@
1.4 +// Copyright (c) 2010 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: The main purpose of RTFXEffect implementation is to forward
1.17 +// RWsSession/RWindowBase calls to RegisterEffect and OverrideEffect to server side.
1.18 +// Please see documantion of RTFXEffect::RegisterTFXEffect() for more details.
1.19 +//
1.20 +
1.21 +#include "rtfxeffect.h"
1.22 +#include "w32comm.h"
1.23 +#include "client.h"
1.24 +
1.25 +/**
1.26 +Constructor which takes handle and buffer paratemter and initilaizes
1.27 +its member variables.
1.28 +
1.29 +@param aHandle Client side handle of the class derived from MWsClientClass
1.30 +@param aBuffer Pointer to the wserv client side buffer of the above class
1.31 +*/
1.32 +RTFXEffect::RTFXEffect(TInt aHandle, RWsBuffer* aBuffer)
1.33 + : MWsClientClass(aBuffer), iDirPathSizePaded(0), iFileName1SizePaded(0),
1.34 + iFileName2SizePaded(0), iCombSizePaded(0)
1.35 + {
1.36 + iWsHandle = aHandle;
1.37 + }
1.38 +
1.39 +/**
1.40 +Function checks the sent parmaters and pancis client if any of its length
1.41 +is greater than KMaxFileName. Calculates the padded lengths of sent parameters
1.42 +and stores them in member variables
1.43 +
1.44 +@param aResourceDir directory name of animation description file
1.45 +@param aFilenameOutgoing File name of Outgoing phase of TFX
1.46 +@param aFilenameIncoming File name of Incoming phase of TFX
1.47 +*/
1.48 +void RTFXEffect::CheckFileNameAndSetSizes(const TFileName& aResourceDir,
1.49 + const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming)
1.50 + {
1.51 + __ASSERT_ALWAYS(aResourceDir.Length() <= KMaxFileName, Panic(EW32PanicStringTooLong));
1.52 + __ASSERT_ALWAYS(aFilenameOutgoing.Length() <= KMaxFileName, Panic(EW32PanicStringTooLong));
1.53 + __ASSERT_ALWAYS(aFilenameIncoming.Length() <= KMaxFileName, Panic(EW32PanicStringTooLong));
1.54 +
1.55 + iDirPathSizePaded = PaddedValue(aResourceDir.Size());
1.56 + iFileName1SizePaded = PaddedValue(aFilenameOutgoing.Size());
1.57 + iFileName2SizePaded = PaddedValue(aFilenameIncoming.Size());
1.58 +
1.59 + iCombSizePaded = iDirPathSizePaded + iFileName1SizePaded + iFileName2SizePaded;
1.60 + }
1.61 +
1.62 +/**
1.63 +Appends folder and file names to wserv client's buffer using AppendData() of MWsClientClass.
1.64 +AppendData adds data directly to buffer. So before calling AppendData we must make sure that
1.65 +current command is added to buffer. Please see description of MWsClientClass::AppendData()
1.66 +for more details.
1.67 +
1.68 +@param aResourceDir directory name of animation description file
1.69 +@param aFilenameOutgoing File name of Outgoing phase of TFX
1.70 +@param aFilenameIncoming File name of Incoming phase of TFX
1.71 +*/
1.72 +void RTFXEffect::AppendFileNameData(const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming)
1.73 + {
1.74 + AppendData(aResourceDir.Ptr(), aResourceDir.Size(), EFalse);
1.75 + AppendData(aFilenameOutgoing.Ptr(), aFilenameOutgoing.Size(), EFalse);
1.76 + AppendData(aFilenameIncoming.Ptr(), aFilenameIncoming.Size(), ETrue);
1.77 + }
1.78 +
1.79 +/**
1.80 +Writes file names using IPC args along with data related to TWsClCmdRegisterEffect
1.81 +Out going phase animation file name is sent in second slot of IPC to server
1.82 +In coming phase animation file name is sent in third slot of IPC to server
1.83 +Data related to TWsClCmdRegisterEffect and folder name are sent in the normal wserv buffer
1.84 +
1.85 +@param aForRegister an object of TWsClCmdRegisterEffect filled with data related to RegisterTFXEffect
1.86 + If non Empty then this function is called for Register effect
1.87 +@param aForOverride an object of TWsClCmdOverrideEffect filled with data related to OverrideTFXEffect
1.88 + If non Empty then this function is called for Overide effect
1.89 +@param aResourceDir directory name of animation description file
1.90 +@param aFilenameOutgoing File name of Outgoing phase of TFX
1.91 +@param aFilenameIncoming File name of Incoming phase of TFX
1.92 +@param aCalledFrom value from TFXEffect enum reprseting whether called from RWsSession or RWindowbase
1.93 +*/
1.94 +void RTFXEffect::WriteDataUsingIPC(TWsClCmdRegisterEffect* aForRegister, TWsClCmdOverrideEffect* aForOverride,
1.95 + const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TFXEffect aCalledFrom)
1.96 + {
1.97 + TIpcArgs ipcArgsDesc;
1.98 + ipcArgsDesc.Set(1, &aFilenameOutgoing);
1.99 + ipcArgsDesc.Set(2, &aFilenameIncoming);
1.100 + // If called for RegisterTFXEffect
1.101 + if (aForRegister)
1.102 + {
1.103 + Write(aForRegister, sizeof(*aForRegister), aResourceDir.Ptr(), aResourceDir.Size(),
1.104 + EWsClOpRegisterTFXEffectIPC, &ipcArgsDesc);
1.105 + }
1.106 + else // Else called for OverrideTFXEffect
1.107 + {
1.108 + Write(aForOverride, sizeof(*aForOverride), aResourceDir.Ptr(), aResourceDir.Size(),
1.109 + (aCalledFrom == ETFXSession ? EWsClOpOverrideEffectIPC : EWsWinOpOverrideEffectIPC), &ipcArgsDesc);
1.110 + }
1.111 + }
1.112 +
1.113 +/**
1.114 +Checks if the sum of iCombSizePaded, size of TWsCmdHeader and sent size is less than
1.115 +the current buffer size.
1.116 +
1.117 +@param aSize size to be compared with current buffer size
1.118 +@return ETrue if the combined size if less then or equal to current buffer size
1.119 + EFalse if the combined size is greater then current buffer size
1.120 + */
1.121 +TBool RTFXEffect::CheckCombinedSizeWithCurrentBuffer(TInt aSize) const
1.122 + {
1.123 + return (iCombSizePaded + aSize + sizeof(TWsCmdHeader) <= iBuffer->BufferSize());
1.124 + }
1.125 +
1.126 +/**
1.127 +Checks the length of sent variables and does as explained below
1.128 +
1.129 +Main logic involved in both RegisterTFXEffect() and OverrideTFXEffect() is as follows
1.130 +First check the sum of all strings
1.131 +If it is less then max wserv buffer
1.132 + Send unpadded sizes in TWsClCmdRegisterEffect/TWsClCmdOverrideEffect but when we append
1.133 + the data we make sure that we pad it
1.134 + Then at server side get the buffer for total length(inlcuding pading)and unpad it and
1.135 + send it to renderstage's RegisterEffect/OverrideEffect function
1.136 +If it is greater then max wserv buffer
1.137 + Send one string in the wserv buffer as done before ie. pading and unpading
1.138 + Other two strings are sent using IPC args in 2 and 3 slot of IPC and do explicit flush
1.139 + And at server side get one string from buffer and other 2 from IPC
1.140 +
1.141 +@param aAction Particular transition to register the animation for.
1.142 +@param aPurpose The purpose of the window.
1.143 +@param aResourceDir The name of the directory that contains the animation description files.
1.144 +@param aFilenameOutgoing The file containing the description of the animation for the outgoing phase of the transition.
1.145 + Specify KNullDesC for no outgoing phase effect.
1.146 +@param aFilenameIncoming The file containing the description of the animation for the incoming phase of the transition.
1.147 + Specify KNullDesC for no incoming phase effect.
1.148 +@param aAppUid The Application UID this effect applies to. Set to zero to specify that all apps will use default effect.
1.149 +@param aFlags Flag for the effect. Please see TTfxFlags for values this flag parameter can use.
1.150 +*/
1.151 +void RTFXEffect::RegisterTFXEffect(TInt aAction, TInt aPurpose, const TFileName& aResourceDir,
1.152 + const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TUint aAppUid, TBitFlags aFlags)
1.153 + {
1.154 + CheckFileNameAndSetSizes(aResourceDir, aFilenameOutgoing, aFilenameIncoming);
1.155 + if (CheckCombinedSizeWithCurrentBuffer(sizeof(TWsClCmdRegisterEffect)))
1.156 + {
1.157 + TWsClCmdRegisterEffect params(aAction, aPurpose, aResourceDir.Size(), aFilenameOutgoing.Size(), aFilenameIncoming.Size(), aAppUid, aFlags);
1.158 + // Here we just pass the length of combined strings so that it checks and does flush if needed.
1.159 + // Then AppendData actually adds the data to buffer at the end
1.160 + Write(¶ms, sizeof(params), iCombSizePaded, EWsClOpRegisterTFXEffectBuf);
1.161 + if (iCombSizePaded > 0)
1.162 + AppendFileNameData(aResourceDir, aFilenameOutgoing, aFilenameIncoming);
1.163 + }
1.164 + else
1.165 + {
1.166 + TWsClCmdRegisterEffect params(aAction, aPurpose, aResourceDir.Size(), 0, 0, aAppUid, aFlags);
1.167 + WriteDataUsingIPC(¶ms, NULL, aResourceDir, aFilenameOutgoing, aFilenameIncoming, ETFXSession);
1.168 + }
1.169 + }
1.170 +
1.171 +/**
1.172 +Checks the length of sent variables and does as explained in
1.173 +RTFXEffect::RegisterTFXEffect() API description
1.174 +
1.175 +@param aAction The particular transition to set the animation for.
1.176 +@param aPurpose This override only effects the window/layers owned by the application that have the specified purpose.
1.177 +@param aResourceDir The name of the directory that contains the animation description files.
1.178 +@param aFilenameOutgoing The file containing the description of the animation for the outgoing phase of the transition.
1.179 + Specify KNullDesC for no outgoing phase effect.
1.180 +@param aFilenameIncoming The file containing the description of the animation for the incoming phase of the transition.
1.181 + Specify KNullDesC for no incoming phase effect.
1.182 +@param aFlags Flag for the effect. Please see TTfxFlags for values this flag parameter can use.
1.183 +*/
1.184 +void RTFXEffect::OverrideTFXEffect(TFXEffect aCalledFrom, TInt aAction, TInt aPurpose, const TFileName& aResourceDir,
1.185 + const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TBitFlags aFlags)
1.186 + {
1.187 + CheckFileNameAndSetSizes(aResourceDir, aFilenameOutgoing, aFilenameIncoming);
1.188 + if (CheckCombinedSizeWithCurrentBuffer(sizeof(TWsClCmdOverrideEffect)))
1.189 + {
1.190 + TWsClCmdOverrideEffect params(aAction, aPurpose, aResourceDir.Size(), aFilenameOutgoing.Size(), aFilenameIncoming.Size(), aFlags);
1.191 + Write(¶ms, sizeof(params), iCombSizePaded, (aCalledFrom == ETFXSession ? EWsClOpOverrideEffectBuf : EWsWinOpOverrideEffectBuf));
1.192 + if (iCombSizePaded > 0)
1.193 + AppendFileNameData(aResourceDir, aFilenameOutgoing, aFilenameIncoming);
1.194 + }
1.195 + else
1.196 + {
1.197 + TWsClCmdOverrideEffect params(aAction, aPurpose, aResourceDir.Size(), 0, 0, aFlags);
1.198 + WriteDataUsingIPC(NULL, ¶ms, aResourceDir, aFilenameOutgoing, aFilenameIncoming, aCalledFrom);
1.199 + }
1.200 + }