/*

* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:

*

*/

#include "DataWrapperBase.h"

#define SECS_TO_MICROSEC(x)  (x*1000000)

/*@{*/

///	Constant Literals used.

_LIT(KPrefixHex,				"0x");

_LIT(KPrefixOctal,				"0");

_LIT(KSuffixBinary,				"b");

_LIT(KIncludeSection,			"include");

_LIT(KFile,						"file%d");

_LIT(KMatch,					"*{*,*}*");

_LIT(KStart,					"{");

_LIT(KSeparator,				",");

_LIT(KEnd,						"}");

_LIT(KDataRead,					"INI READ : %S %S %S");

_LIT(KTagPointX,				"%S_x");

_LIT(KTagPointY,				"%S_y");

_LIT(KTagRectMinX,				"%S_minX");

_LIT(KTagRectMaxX,				"%S_maxX");

_LIT(KTagRectMinY,				"%S_minY");

_LIT(KTagRectMaxY,				"%S_maxY");

_LIT(KTagSizeHeight,			"%S_height");

_LIT(KTagSizeWidth,				"%S_width");

_LIT(KEnumElements,				"enum_elements");

_LIT(KPrefixHexKey,				"0x%S");

_LIT(KCmdUtilityPromptMessage,	"utilityPromptMessage");

_LIT(KPromptText,				"message");

_LIT(KDelay,					"delay");

_LIT(KExpectedKey,				"keyCode");

/*@}*/

const TInt	KDefaultDelay	=	10;

const TInt	KBounceErrKey	=	50000;

CDataWrapperBase::CDataWrapperBase()

:	CDataWrapper()

	{

	}

CDataWrapperBase::~CDataWrapperBase()

/**

 * Public destructor

 */

	{

	iInclude.ResetAndDestroy();

	iBuffer.ResetAndDestroy();

	iFs.Close();

	}

void CDataWrapperBase::InitialiseL()

	{

	iTimer.CreateLocal();

	CDataWrapper::InitialiseL();

	TBuf<KMaxTestExecuteCommandLength>	tempStore;

	TPtrC		fileName;

	TBool		moreData=ETrue;

	TBool		index=0;

	while ( moreData )

		{

		tempStore.Format(KFile(), ++index);

		moreData=GetStringFromConfig(KIncludeSection, tempStore, fileName);

		if (moreData)

			{

			CIniData*	iniData=CIniData::NewL(fileName);

			CleanupStack::PushL(iniData);

			iInclude.Append(iniData);

			CleanupStack::Pop(iniData);

			}

		}

	User::LeaveIfError(iFs.Connect());

	}

TBool CDataWrapperBase::GetBoolFromConfig(const TDesC& aSectName,const TDesC& aKeyName,TBool& aResult)

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TBool reference passed in possible values TRUE, FALSE

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - The value of the boolean

 * @return TBool - ETrue for found, EFalse for not found

 */

	{

	TBool	ret=EFalse;

	TPtrC	result;

	TRAPD(err, ret=GetCommandStringParameterL(aSectName, aKeyName, result));

	if ( err != KErrNone )

		{

		ret=EFalse;

		}

	if ( ret )

		{

		_LIT(KTrue,"true");

		aResult=(result.FindF(KTrue) != KErrNotFound);

		}

	return ret;

	}

TBool CDataWrapperBase::GetIntFromConfig(const TDesC& aSectName, const TDesC& aKeyName, TInt& aResult)

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TInt reference passed in

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - The value of the integer

 * @return TBool - ETrue for found, EFalse for not found

 */

	{

	TPtrC	result;

	TBool	ret=EFalse;

	TRAPD(err, ret=GetCommandStringParameterL(aSectName, aKeyName, result));

	if ( err != KErrNone )

		{

		ret=EFalse;

		}

	if ( ret )

		{

		TLex	lex(result);

		ret=(lex.Val(aResult)==KErrNone);

		}

	return ret;

	}

TBool CDataWrapperBase::GetStringFromConfig(const TDesC& aSectName, const TDesC& aKeyName, TPtrC& aResult)

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TPtrC reference passed in

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - Reference to the string on the heap

 * @return TBool - ETrue for found, EFalse for not found

 */

	{

	TBool	ret=EFalse;

	TRAPD(err, ret=GetCommandStringParameterL(aSectName, aKeyName, aResult));

	if ( err != KErrNone )

		{

		ret=EFalse;

		}

	return ret;

	}

TBool CDataWrapperBase::GetHexFromConfig(const TDesC& aSectName, const TDesC& aKeyName, TInt& aResult)

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TInt reference passed in. The value can optionally be prefixed with 0x

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - The integer value of the Hex input

 * @return TBool - ETrue for found, EFalse for not found

 */

	{

	TPtrC	result;

	TBool	ret=EFalse;

	TRAPD(err, ret=GetCommandStringParameterL(aSectName, aKeyName, result));

	if ( err != KErrNone )

		{

		ret=EFalse;

		}

	if ( ret )

		{

		TLex	lex;

		if( result.FindC(KPrefixHex)==KErrNone )

			{

			lex=result.Mid(KPrefixHex().Length());

			}

		else

			{

			lex=result;

			}

		ret=(lex.Val((TUint &)aResult, EHex)==KErrNone);

		}

	return ret;

	}

TBool CDataWrapperBase::GetUintFromConfig(const TDesC& aSectName, const TDesC& aKeyName, TUint& aResult)

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TUint reference passed in.

 * If the value is prefixed with 0x the value is read as a hexidecimal value

 * If the value is suffixed with b the value is read as a binary value

 * If the value is prefixed with a 0 the value is read as an octal value

 * If it does not match the above it is read in as an integer

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - The integer value of the Hex input

 * @return TBool - ETrue for found, EFalse for not found

 */

	{

	TPtrC	result;

	TBool	ret=EFalse;

	TRAPD(err, ret=GetCommandStringParameterL(aSectName, aKeyName, result));

	if ( err != KErrNone )

		{

		ret=EFalse;

		}

	if ( ret )

		{

		TLex	lex(result);

		if( result.FindC(KPrefixHex)==KErrNone )

			{

			lex=result.Mid(KPrefixHex().Length());

			ret=(lex.Val(aResult, EHex)==KErrNone);

			}

		else

			{

			TInt	binarySuffixPosition=result.Length()-KSuffixBinary().Length();

			if ( result.FindC(KSuffixBinary)==binarySuffixPosition )

				{

				lex=result.Left(binarySuffixPosition);

				ret=(lex.Val(aResult, EBinary)==KErrNone);

				}

			else

				{

				if( result.FindC(KPrefixOctal)==KErrNone )

					{

					ret=(lex.Val(aResult, EOctal)==KErrNone);

					}

				else

					{

					TInt	intResult;

					ret=(lex.Val(intResult)==KErrNone);

					if ( ret )

						{

						aResult=(TUint)intResult;

						}

					}

				}

			}

		}

	return ret;

	}

TBool CDataWrapperBase::GetEnumFromConfig(const TDesC& aSectName, const TDesC& aKeyName, const TEnumEntryTable* aTable, TInt& aResult)

	{

	TPtrC	str;

	TBool	ret=GetStringFromConfig(aSectName, aKeyName, str);

	if ( ret )

		{

		TBool	found=EFalse;

		TInt	index=0;

		while ( (aTable[index].iValue!=-1) && !found )

			{

			if ( aTable[index].iString==str )

				{

				found=ETrue;

				aResult=aTable[index].iValue;

				}

			else

				{

				++index;

				}

			}

		if ( !found )

			{

			ret=GetIntFromConfig(aSectName, aKeyName, aResult);

			}

		}

	return ret;

	}

TBool CDataWrapperBase::GetOrFromConfig(const TDesC& aSectName, const TDesC& aKeyName, const TEnumEntryTable* aTable, TUint& aResult)

	{

	TPtrC 	str;

	TBool	ret=GetStringFromConfig(aSectName, aKeyName, str);

	if ( ret )

		{

		TUint	temp=0;

		ret=ProcessString(str, temp, aTable);

		if ( ret )

			{

			aResult=temp;

			}

		}

	return ret;

	}

TBool CDataWrapperBase::ProcessString(const TDesC& aStr, TUint& aResult, const TEnumEntryTable* aTable)

	{

	TBool	ret=ETrue;

	TInt	location=aStr.Match(_L("*|*"));

	if( location!=KErrNotFound )

		{

		// Converting Left part of the data

		TPtrC	tempStr=aStr.Left(location);

		ret=ProcessString(tempStr, aResult, aTable);

		// Converting right data can be with another "|"

		tempStr.Set(aStr.Mid(location+1));

		TUint	temp;

		if ( ProcessString(tempStr, temp, aTable) )

			{

			aResult|=temp;

			}

		else

			{

			ret=EFalse;

			}

		}

	else

		{

		ret=ProcessEntry(aStr, aResult, aTable);

		}

	return ret;

	}

TBool CDataWrapperBase::ProcessEntry(const TDesC& aStr, TUint& aResult, const TEnumEntryTable* aTable)

	{

	TBool	ret=ETrue;

	TBool	found=EFalse;

	TInt	index=0;

	while ( (aTable[index].iValue!=-1) && !found )

		{

		if ( aTable[index].iString==aStr )

			{

			found=ETrue;

			aResult=aTable[index].iValue;

			}

		else

			{

			++index;

			}

		}

	if ( !found )

		{

		TUint	flags;

		TLex	lex(aStr);

		ret=(lex.Val(flags, EHex)==KErrNone);

		if ( ret )

			{

			aResult=flags;

			}

		}

	return ret;

	}

TBool CDataWrapperBase::GetCommandStringParameterL(const TDesC& aSectName, const TDesC& aKeyName, TPtrC& aResult)

	{

	TBool	ret=EFalse;

	if ( aSectName.Length()!=0 )

		{

		ret=CDataWrapper::GetStringFromConfig(aSectName, aKeyName, aResult);

		for ( TInt index=iInclude.Count(); (index>0) && (!ret); )

			{

			ret=iInclude[--index]->FindVar(aSectName, aKeyName, aResult);

			if ( ret )

				{

				INFO_PRINTF4(KDataRead, &aSectName, &aKeyName, &aResult);

				}

			}

		}

	if ( ret )

		{

		if ( aResult.Match(KMatch)!=KErrNotFound )

			{

			//	We have an entry of the format

			//	entry =*{section,entry}*

			//	where * is one or more characters

			//	We need to construct this from other data in the ini file replacing {*,*}

			//	with the data from

			//	[section]

			//	entry =some_value

			HBufC*	buffer=HBufC::NewLC(aResult.Length());

			buffer->Des().Copy(aResult);

			TInt	startLength=KStart().Length();

			TInt	sparatorLength=KSeparator().Length();

			TInt	endLength=KEnd().Length();

			TInt	bufferLength;

			TInt	start;

			TInt	sparator;

			TInt	end;

			TPtrC	remaining;

			TLex	lex;

			do

				{

				bufferLength=buffer->Length();

				start=buffer->Find(KStart);

				remaining.Set(buffer->Des().Right(bufferLength-start-startLength));

				sparator=remaining.Find(KSeparator);

				remaining.Set(remaining.Right(remaining.Length()-sparator-sparatorLength));

				sparator += (start + startLength);

				end=remaining.Find(KEnd) + sparator + sparatorLength;

				TPtrC	sectionName(buffer->Ptr()+start+startLength, sparator-start-startLength);

				TPtrC	keyName(buffer->Ptr()+sparator+sparatorLength, end-sparator-sparatorLength);

				sectionName.Set(TLex(sectionName).NextToken());

				keyName.Set(TLex(keyName).NextToken());

				TInt	entrySize=0;

				TPtrC	entryData;

				TBool	found=CDataWrapper::GetStringFromConfig(sectionName, keyName, entryData);

				for ( TInt index=iInclude.Count(); (index>0) && (!found);  )

					{

					found=iInclude[--index]->FindVar(sectionName, keyName, entryData);

					}

				if ( found )

					{

					entrySize=entryData.Length();

					}

				TInt	newLength=start + bufferLength - end - endLength + entrySize;

				HBufC*	bufferNew=HBufC::NewLC(newLength);

				bufferNew->Des().Copy(buffer->Ptr(), start);

				if ( entrySize>0 )

					{

					bufferNew->Des().Append(entryData);

					}

				bufferNew->Des().Append(buffer->Ptr() + end + endLength, bufferLength - end - endLength);

				CleanupStack::Pop(bufferNew);

				CleanupStack::PopAndDestroy(buffer);

				buffer=bufferNew;

				CleanupStack::PushL(buffer);

				}

			while ( buffer->Match(KMatch)!=KErrNotFound );

			iBuffer.Append(buffer);

			CleanupStack::Pop(buffer);

			aResult.Set(*buffer);

			INFO_PRINTF4(KDataRead, &aSectName, &aKeyName, &aResult);

			}

		}

	return ret;

	}

TBool CDataWrapperBase::GetCommandStringParameter(const TDesC& aParameterName, const TDesC& aSection, TPtrC& aResult, TText8 *aFileName, TInt aLine, TBool aMandatory)

	{

	TBool	ret = GetStringFromConfig(aSection, aParameterName, aResult);

	if (aMandatory && !ret)

		{

		Logger().LogExtra(aFileName, aLine, ESevrErr, _L("No %S"), &aParameterName);

		SetBlockResult(EFail);

		}

	return ret;

	}

TBool CDataWrapperBase::GetCommandIntParameter(const TDesC& aParameterName, const TDesC& aSection, TInt& aResult, TText8* aFileName, TInt aLine, TBool aMandatory)

	{

	TBool	ret = GetIntFromConfig(aSection, aParameterName, aResult);

	if (aMandatory && !ret)

		{

		Logger().LogExtra(aFileName, aLine, ESevrErr, _L("No %S"), &aParameterName);

		SetBlockResult(EFail);

		}

	return ret;

	}

TBool CDataWrapperBase::GetCommandBoolParameter(const TDesC& aParameterName, const TDesC& aSection, TBool& aResult, TText8 *aFileName, TInt aLine, TBool aMandatory)

	{

	TBool	ret = GetBoolFromConfig(aSection, aParameterName, aResult);

	if (aMandatory && !ret)

		{

		Logger().LogExtra(aFileName, aLine, ESevrErr, _L("No %S"), &aParameterName);

		SetBlockResult(EFail);

		}

	return ret;

	}

TBool CDataWrapperBase::GetPointFromConfig(const TDesC& aSectName, const TDesC& aKeyName, TPoint& aResult)

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name

 * Copies the value to the TPoint reference passed in

 * @param aSectName - Section within the test steps ini file

 * @param aKeyName - Name of a key within a section

 * @return aResult - The value of the TPoint

 * @return TBool - ETrue for found, EFalse for not found

 */

	{

	TBuf<KMaxTestExecuteCommandLength>	tempStore;

	TInt	x;

	tempStore.Format(KTagPointX, &aKeyName);

	TBool	ret=GetIntFromConfig(aSectName, tempStore, x);

	TInt	y;

	tempStore.Format(KTagPointY, &aKeyName);

	if ( !GetIntFromConfig(aSectName, tempStore, y) )

		{

		ret=EFalse;

		}

	if ( ret )

		{

		aResult.SetXY(x, y);

		}

	return ret;

	}

TBool CDataWrapperBase::GetRectFromConfig(const TDesC& aSectName, const TDesC& aKeyName, TRect& aResult)

/**

 * Reads the value present from the test steps ini file within the mentioned section name and key name