sl@0: // Copyright (c) 2002-2009 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:
sl@0: //
sl@0: 
sl@0: #ifndef __SCRIPT_H__
sl@0: #define __SCRIPT_H__
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * File name / line buffer lengths
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: 
sl@0: class CParseLine;
sl@0: class CFileName;
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Script processor.
sl@0:  * Reads, parses and executes the test script.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: class CScript : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	static CScript* NewL(CTestUtils* aTestUtils, CLog* aLog, TInt64 aGuardTimer, const TDesC& aMatchString);
sl@0: 	static CScript* NewL(CParseLine* aParse, CTestUtils* aTestUtils, CLog* aLog, TInt64 aGuardTimer, const TDesC& aMatchString);
sl@0: 	static CScript* NewLC(CTestUtils* aTestUtils, CLog* aLog, TInt64 aGuardTimer, const TDesC& aMatchString);
sl@0: 	static CScript* NewLC(CParseLine* aParse, CTestUtils* aTestUtils, CLog* aLog, TInt64 aGuardTimer, const TDesC& aMatchString);
sl@0: 	~CScript();	
sl@0: 
sl@0: 	TBool OpenScriptFile(CFileName* aScriptFileName);		// read in a script file
sl@0: 	TVerdict ExecuteScriptL();						// parse and execute script 
sl@0: 	void DisplayResults();
sl@0: 	void AddResult(TVerdict aTestVerdict);
sl@0: 	void AddResult(CScript* aSubScript);
sl@0: 	void Pause();
sl@0: 	TBool BreakOnError();
sl@0: 
sl@0: 	TBool iPauseAtEnd;
sl@0: 	// iMultThread removed - multithreading now standard
sl@0: 
sl@0: protected:
sl@0: 	CScript();
sl@0: 	void ConstructL(CTestUtils* aTestUtils, CLog* aLog, TInt64 aGuardTimer, const TDesC& aMatchString);
sl@0: 	void ConstructL(CParseLine* aParse, CTestUtils*, CLog* aLog, TInt64 aGuardTimer, const TDesC& aMatchString);
sl@0: 
sl@0: private:
sl@0: 	void ProcessLineL(const TDesC8& aNarrowline, TInt8 aLineNo);	// process a line of script
sl@0: 	void LogExtra(const TText8* aFile, TInt aLine, TInt aSeverity,
sl@0: 		TRefByValue<const TDesC16> aFmt, ...);
sl@0: 
sl@0: private:
sl@0: 	// data members
sl@0: 	RFs		iTheFs;										// the file system
sl@0: 	HBufC8* iScriptBuffer;								// ptr to script file in memory
sl@0: 	TPath	iTheTestPath;								// test path
sl@0: 
sl@0: 	// line parse object
sl@0: 	CParseLine* iParse;
sl@0: 	// flag indicates whether iParse is owned or not
sl@0: 	TBool	iParseOwner;
sl@0: 
sl@0: 	// recursion count - static global 
sl@0: // do not define static if Unit Testing
sl@0: #if !defined (__TSU_TESTFRAMEWORK__)
sl@0: 	static TInt iScriptDepth;
sl@0: #endif
sl@0: 
sl@0: 	// log
sl@0: 	CLog* iLog;
sl@0: 
sl@0: 	// default guard timer, if any
sl@0: 	TInt64 iGuardTimer;
sl@0: 	
sl@0: 	// matchString if any
sl@0: 	HBufC* iMatchString;
sl@0: 
sl@0: 	// current results
sl@0: 	TInt	iPass;
sl@0: 	TInt	iFail;
sl@0: 	TInt	iInconclusive;
sl@0: 	TInt	iTestSuiteError;
sl@0: 	TInt	iAbort;
sl@0: 	TInt	iKnownFailure;
sl@0: 	TInt	iTotal;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #endif // __SCRIPT_H__