// Copyright (c) 2003-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:

// This module contains CParseLine and CSuiteDll classes

// CParseLine contains the functions required to execute

// a line of test script file.

// CSuiteDll objects contains information about test suite

// dlls that have been loaded.

// 

//

/**

 @file parseLine.cpp

*/

// system includes

#include <e32base.h>

#include <e32cons.h>

#include "f32file.h"

// test system includes

#include "../inc/Log.h"

#include "../inc/TestUtils.h"

#include "../inc/TestStep.h"

#include "../inc/TestSuite.h"

#include "script.h"

#include "parseline.h"

/** 

DLL fullpath 

@internalComponent

*/

_LIT(KTxtDLLpath,"c:\\;c:\\system\\libs\\;d:\\;d:\\system\\libs\\");

#ifdef __WINS__

/** 

Holds ced_exe DLL string constant 

@internalComponent

*/

_LIT(KTxtcedDLL,"ced_exe.dll");

#endif

/** 

Thread name format 

@internalComponent

*/

_LIT(KThreadNameFmt, "DoTestThread_%d");

/** 

Maximum test thread heap size 

@internalComponent

*/

const TInt KMaxTestThreadHeapSize = 0x10000;

/**

extern global data - pointer to test utils

@internalComponent

*/

GLDEF_D	CTestUtils *		pTestUtils;

/**

extern global data - pointer to Log system

@internalComponent

*/

GLDEF_D CLog *				pLogSystem;

/**

extern global data - running in automated, non-interactive, stop-for-nothing mode

@internalComponent

*/

GLDEF_D TBool				automatedMode = EFalse;

/**

extern global data - pointer to console

@internalComponent

*/

GLDEF_D CConsoleBase *		console;

CParseLine::CParseLine():iTestVerdict(EPass)

/**

constructor

*/

	{}

void CParseLine::ConstructL(CScript * ptr)

/**

create a new Array to store the test steps in

*/

	{

	// create a new Array to store the test steps in

	iArrayLoadedSuiteDll = new(ELeave) CArrayPtrFlat<CSuiteDll>(1);

	iScript = ptr;

	iSeverity = ESevrAll;

	iBreakOnError = EFalse;

	iThreadNameSuffix = User::TickCount();

	}

CParseLine* CParseLine::NewL( CScript * ptr)

/**

NewL static constructor

*/

	{

	CParseLine * self = new(ELeave) CParseLine;

	CleanupStack::PushL(self);

	self->ConstructL(ptr);

	CleanupStack::Pop();

	return self;

	}

CParseLine::~CParseLine()

/**

Delete all objects in iArrayLoadedSuiteDll.

This will unload any loaded test suite DLLS.

*/

	{

	// unload DLLs and their records

	if (iArrayLoadedSuiteDll)

		{

		// delete all objects in iArrayLoadedSuiteDll

		// the destructors will unload any loaded DLLS

		iArrayLoadedSuiteDll->ResetAndDestroy();

		delete iArrayLoadedSuiteDll;

		}

	}

void CParseLine::ProcessLineL(const TPtrC8 &aNrrowline, TInt8 lineNo)

/**

Process a line from the script file

@param aNrrowline The line to be parsed

@param lineNo The current line number

*/

	{

	// make a local unicode buffer

	TBuf<MAX_SCRIPT_LINE_LENGTH> LineBuf;

	//If the lenght of the command line is more than MAX_SCRIPT_LINE_LENGTH=200

	//Igore the line with Warning and the test result would be Inconclusive	

	if (aNrrowline.Length() > LineBuf.MaxLength())

	{

		TLex8 lex(aNrrowline);

		// start at the begining

		TPtrC8 token=lex.NextToken();

		TInt firstChar = aNrrowline[0];

		if(firstChar == '\r' || firstChar == '\n' || firstChar == '#' || firstChar == '/' || token.CompareF((TPtrC8((const TText8 *)("PRINT")))) == 0 || token.CompareF((TPtrC8((const TText8 *)("PAUSE_AT_END")))) == 0 || token.CompareF((TPtrC8((const TText8 *)("PAUSE")))) == 0)

		{

			// ignore command line	with comments	

		}

		else

		{

			pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("WARNING : Command line too Long (Exceeds length of 200)  Line:%d"), lineNo);

			iTestVerdict = EInconclusive;

		}

		return;

	}

	LineBuf.Fill( '\0',MAX_SCRIPT_LINE_LENGTH);

	// convert the narrow script file to Unicode

	TFileName testnameU;

	testnameU.Copy(aNrrowline);

	// find the end of the line

	TInt end= testnameU.Locate('\n');

	// copy the line into LineBuf

	if ((end != -1) && (end < MAX_SCRIPT_LINE_LENGTH))

		LineBuf = testnameU.Left(end-1);

	else

		LineBuf = testnameU;

	// the parser relies on spaces between tokens. Commas are

	// allowed but are just replaced with spaces

	while ( LineBuf.Locate(TChar(',')) != KErrNotFound )

		{

		// found a comma so replave with space

		LineBuf.Replace(LineBuf.Locate(TChar(',')),1,_L(" "));

		}

	// for debugging display the line with a line no

#ifdef SCRIPT_DEBUG

	pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("Line:%d %s "), lineNo, LineBuf.Ptr()  );

#endif

	// if there has been a failure and the user has selected

	// x then the next commands in the script are skipped until

	// a test complete statement is found

	if ( iBreakOnError )

		{

		if (LineBuf.Find(_L("TEST_COMPLETE"))==0)

			{

			TestComplete( LineBuf );

			// reset flag now test complete found

			iBreakOnError = EFalse;

			}

		// do not process the rest of the line

		return;

		}

	// check the line for command keywords

	if ((LineBuf.Find(_L("//"))==0) || (LineBuf.Find(_L("#"))==0))

		{

		// ignore comments

		}

	else

		{

		// use Tlex to decode the cmd

		TLex lex(LineBuf);

		// start at the begining

		TPtrC token=lex.NextToken();

		if (token.CompareF(_L("LOAD_SUITE"))==0)

			{

			LoadSuiteL( LineBuf );

			}

		else if (token.CompareF(_L("RUN_SCRIPT"))==0)

			{

			RunScriptL( LineBuf );

			}

		else if (token.CompareF(_L("RUN_TEST_STEP"))==0)

			{

			RunTestStep( LineBuf );

			}

		else if (token.CompareF(_L("RUN_PANIC_STEP"))==0)

			{

			RunPanicTestStep( LineBuf );

			}

		else if (token.CompareF(_L("RUN_UTILS"))==0)

			{

			RunUtil( LineBuf );

			}

		else if (token.CompareF(_L("CED"))==0)

			{

			RunCed( LineBuf );

			}

		else if (token.CompareF(_L("RUN_PROGRAM"))==0)

			{

			RunProgram( LineBuf );

			}

		else if (token.CompareF(_L("UNLOAD"))==0)

			{

			Unload(LineBuf);

			}

		else if (token.CompareF(_L("HEAP_MARK"))==0)

			{

			HeapMark();

			}

		else if (token.CompareF(_L("HEAP_MARKEND"))==0)

			{

			HeapCheck();

			}

		else if (token.CompareF(_L("REQUEST_MARK"))==0)

			{

			RequestMark();

			}

		else if (token.CompareF(_L("REQUEST_CHECK"))==0)

			{

			RequestCheck();

			}

		else if (token.CompareF(_L("HANDLES_MARK"))==0)

			{

			HandlesMark();

			}

		else if (token.CompareF(_L("HANDLES_CHECK"))==0)

			{

			HandlesCheck();

			}

		else if (token.CompareF(_L("PRINT"))==0)

			{

			scriptPrint( LineBuf );

			}

		else if (token.CompareF(_L("DELAY"))==0)

			{

			Delay( LineBuf );

			}

		else if (token.CompareF(_L("SEVERITY"))==0)

			{

			SetSeverity( LineBuf );

			}

		else if (token.CompareF(_L("PAUSE_AT_END"))==0)

			{

			pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("Pause at end enabled "));

			iScript->iPauseAtEnd = ETrue;

			}

		else if (token.CompareF(_L("MULTITHREAD"))==0)

			{

			pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("Multithread operation enabled "));

			iScript->iMultThread = ETrue;

			}

		else if (token.CompareF(_L("SINGLETHREAD"))==0)

			{

			pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("Single thread operation enabled "));

			iScript->iMultThread = EFalse;

			}

		else if (token.CompareF(_L("PAUSE"))==0)

			{

			iScript->Pause();

			}

		else if (token.CompareF(_L("BREAK_ON_ERROR"))==0)

			{	// if the current test verdict is not PASS

			// give the user the chance to quit

			if ( iTestVerdict != EPass )

				iBreakOnError = iScript->BreakOnError();

			}

		else if (token.CompareF(_L("TEST_COMPLETE"))==0)

			{

			// use Tlex to decode the cmd line

			TestComplete( LineBuf );

			}

		else if (token.CompareF(_L("LOG_SETTINGS"))==0)

			{

			// use Tlex to decode the cmd line

			LogSettings( LineBuf );

			}

		else if (LineBuf.Length()==0)

			{

			// ignore blank lines

			}

		else

			{

			// failed to decode line

			pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("Error in script line:%d - %s "), lineNo, LineBuf.Ptr()  );

			}

		}

}

void CParseLine::TestComplete( const TDesC& Text )

/**

This function implements the script test complete keyword

@param The contents of Text are added to the log file with the result

*/

	{

	// use Tlex to decode the cmd line

	TLex lex(Text);

	// start at the begining

	TPtrC token=lex.NextToken();

	// step over the keyword

	token.Set(lex.NextToken());

	if (token.Length() !=0 )

		iCurrentStepName = token;

	// Test cases must be careful to clean up after themselves - any stray signals generated in a test case 

	// lead here to automatic failure of the step. They are caught here to allow further cases to run 

	// without crashing.

	while (RThread().RequestCount()!=0)

	{

		pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("Warning! Test case generated stray signal! (cleaning up)") );

		User::WaitForAnyRequest();

		iTestVerdict = EFail;

	}

	// add the current result to the script

	iScript->AddResult( iTestVerdict );

	// reset for next test

	iTestVerdict = EPass;

	}

void CParseLine::scriptPrint(  const TDesC& Text )

/**

This function implements the script PRINT Keyword

@param Text The text to be added to the log file 

*/

	{

	// display the text after the PRINT and 1 space = 6

	pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("%s "), (Text.Ptr()+6) );

	}

void CParseLine::Delay(  const TDesC& Text )

/**

This function implements the script Delay Keyword

@param Text contains the time to delay in milliseconds

*/

	{

	// if the test has already failed skip the delay

	if ( iTestVerdict != EPass )

		{

		pLogSystem->Log(_L("skipped delay as test has already failed") );

		return;

		}

	// get the required time for the delay

	// first get the value as a string

	TLex TimeOut(Text);

	TimeOut.NextToken();

	TPtrC token=TimeOut.NextToken();

	// convert the value into a int

	TLex timeoutLex(token);

	TInt GuardTimerValue =2500;

	if (timeoutLex.Val(GuardTimerValue) != KErrNone  )

		{

		pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr,

			_L("error in guard timer value could not decode >%S< as value"),

			&token,

			GuardTimerValue );

		return;

		}

	// display the text after the PRINT and 1 space = 6

	pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr,

		_L("Delay for %d mS"), GuardTimerValue );

	// wait for the required delay

	RTimer GuardTimer;

	GuardTimer.CreateLocal();			// create for this thread

	TRequestStatus TimerStatus;

	GuardTimer.After(TimerStatus,GuardTimerValue * 1000);

	User::WaitForRequest(TimerStatus);

	GuardTimer.Cancel();

	}

void CParseLine::SetSeverity(  const TDesC& Text )

/**

This function implements the script SetSeverity Keyword

@param Text contains the severity level

*/

	{

	// get the required time for the delay

	// first get the value as a string

	TLex SeverityOut(Text);

	SeverityOut.NextToken();

	TPtrC token=SeverityOut.NextToken();

	// convert the value into a int

	TLex Severity(token);

	TInt SeverityValue = 7;

	if (Severity.Val(SeverityValue) != KErrNone  )

		{

		pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr,

			_L("Error in severity level value could not decode >%S< as value"),

			&token,

			SeverityValue );

		return;

		}

	if(SeverityValue & ~7)

		{

		pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__,

			ESevrErr, _L("Error in severity value."));

		SeverityValue = 7;

		return;

		}

	else

		{

		iSeverity = SeverityValue;

		TInt NoOfDlls = iArrayLoadedSuiteDll->Count();

		for ( TInt i=0; i < NoOfDlls; i++ )

			{

			CSuiteDll * ptrSuite = iArrayLoadedSuiteDll->At(i);

			ptrSuite->iTestSuite->SetSeverity(iSeverity);

			}

		}

	pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("Severity is set to %d"), SeverityValue );

	}

void CParseLine::RunScriptL( const TDesC& Text )

/**

This function implements the script RUN_SCRIPT Keyword

@param Text contains the script file name

*/

	{

	// use Tlex to decode the cmd line

	TLex lex(Text);

	// start at the begining

	TPtrC token=lex.NextToken();

	// step over the keyword

	token.Set(lex.NextToken());

	// format for printing

	pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("RUN_SCRIPT %S"),&token );

	// create a new Script object (but use the current parse

	// as it has the dll loaded record

	CScript* newScript=CScript::NewL(this);

	CleanupStack::PushL(newScript);

	// read in the script file

	TFileName scriptFileName=token;

	if ( newScript->OpenScriptFile( scriptFileName ))

		{

		// process it

		iTestVerdict = newScript->ExecuteScriptL();

		/* verdicts for scripts are not really useful so forget! */

		/* pLogSystem->LogExtra(((TText8*)__FILE__), __LINE__, ESevrErr, _L("The final result for test script %S was %s"),

		&token,

		pLogSystem->TestResultText( iTestVerdict ) ); */

		// add results from the new script to the owner script

		iScript->AddResult( newScript );

		}

	else

		{

		// failed to find script so verdict incloncusive

		iTestVerdict = EInconclusive;

		}

	CleanupStack::PopAndDestroy(newScript);