--- a/stif/DemoModule/inc/DemoModule.h Thu Jul 15 20:25:38 2010 +0300
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,327 +0,0 @@
-/*
-* Copyright (c) 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 file contains the header file of DemoModule of
-* STIF TestFramework.
-*
-*/
-
-#ifndef DEMOMODULE_H
-#define DEMOMODULE_H
-
-// INCLUDES
-#include "StifTestModule.h"
-#include <StifLogger.h>
-
-// CONSTANTS
-// None
-
-// MACROS
-// None
-
-// Logging path
-_LIT( KDemoModuleLogPath, "\\logs\\testframework\\DemoModule\\" );
-// Log file
-_LIT( KDemoModuleLogFile, "DemoModule.txt" );
-_LIT( KDemoModuleLogFileWithTitle, "DemoModule_[%S].txt" );
-
-// Function pointer related internal definitions
-#define GETPTR &
-#define ENTRY(str,func) {_S(str), GETPTR func,0,0,0}
-#define FUNCENTRY(func) {_S(#func), GETPTR func,0,0,0}
-#define OOM_ENTRY(str,func,a,b,c) {_S(str), GETPTR func,a,b,c}
-#define OOM_FUNCENTRY(func,a,b,c) {_S(#func), GETPTR func,a,b,c}
-
-// FUNCTION PROTOTYPES
-// None
-
-// FORWARD DECLARATIONS
-class CDemoModule;
-
-// DATA TYPES
-// None
-
-// A typedef for function that does the actual testing,
-// function is a type
-// TInt CDemoModule::<NameOfFunction> ( TTestResult& aResult )
-typedef TInt (CDemoModule::* TestFunction)(TTestResult&);
-
-// CLASS DECLARATION
-
-/**
-* An internal structure containing a test case name and
-* the pointer to function doing the test
-*
-* @lib ?library
-* @since ?Series60_version
-*/
-class TCaseInfoInternal
- {
- public:
- const TText* iCaseName;
- TestFunction iMethod;
- TBool iIsOOMTest;
- TInt iFirstMemoryAllocation;
- TInt iLastMemoryAllocation;
- };
-
-// CLASS DECLARATION
-
-/**
-* A structure containing a test case name and
-* the pointer to function doing the test
-*
-* @lib ?library
-* @since ?Series60_version
-*/
-class TCaseInfo
- {
- public:
- TPtrC iCaseName;
- TestFunction iMethod;
- TBool iIsOOMTest;
- TInt iFirstMemoryAllocation;
- TInt iLastMemoryAllocation;
-
- TCaseInfo( const TText* a ) : iCaseName( (TText*) a )
- {
- };
-
- };
-
-
-// CLASS DECLARATION
-
-/**
-* This a DemoModule class.
-* ?other_description_lines
-*
-* @lib ?library
-* @since ?Series60_version
-*/
-NONSHARABLE_CLASS(CDemoModule) : public CTestModuleBase
- {
- public: // Constructors and destructor
-
-
- /**
- * Two-phased constructor.
- */
- static CDemoModule* NewL();
-
- /**
- * Destructor.
- */
- virtual ~CDemoModule();
-
- public: // New functions
- // None
-
- public: // Functions from base classes
-
- /**
- * From CTestModuleBase InitL is used to initialize the
- * DemoModule. It is called once for every instance of
- * TestModuleDemoModule after its creation.
- * @since ?Series60_version
- * @param aIniFile Initialization file for the test module (optional)
- * @param aFirstTime Flag is true when InitL is executed for first
- * created instance of DemoModule.
- * @return Symbian OS error code
- */
- TInt InitL( TFileName& aIniFile, TBool aFirstTime );
-
- /**
- * From CTestModuleBase GetTestCasesL is used to inquiry test cases
- * from DemoModule.
- * @since ?Series60_version
- * @param aTestCaseFile Test case file (optional)
- * @param aTestCases Array of TestCases returned to test framework
- * @return Symbian OS error code
- */
- TInt GetTestCasesL( const TFileName& aTestCaseFile,
- RPointerArray<TTestCaseInfo>& aTestCases );
-
- /**
- * From CTestModuleBase RunTestCaseL is used to run an individual
- * test case.
- * @since ?Series60_version
- * @param aCaseNumber Test case number
- * @param aTestCaseFile Test case file (optional)
- * @param aResult Test case result returned to test framework (PASS/FAIL)
- * @return Symbian OS error code (test case execution error, which is
- * not reported in aResult parameter as test case failure).
- */
- TInt RunTestCaseL( const TInt aCaseNumber,
- const TFileName& aTestCaseFile,
- TTestResult& aResult );
-
- /**
- * From CTestModuleBase; OOMTestQueryL is used to specify is particular
- * test case going to be executed using OOM conditions
- * @param aTestCaseFile Test case file (optional)
- * @param aCaseNumber Test case number (optional)
- * @param aFailureType OOM failure type (optional)
- * @param aFirstMemFailure The first heap memory allocation failure value (optional)
- * @param aLastMemFailure The last heap memory allocation failure value (optional)
- * @return TBool
- */
- virtual TBool OOMTestQueryL( const TFileName& /* aTestCaseFile */,
- const TInt /* aCaseNumber */,
- TOOMFailureType& aFailureType,
- TInt& /* aFirstMemFailure */,
- TInt& /* aLastMemFailure */ );
-
- /**
- * From CTestModuleBase; OOMTestInitializeL may be used to initialize OOM
- * test environment
- * @param aTestCaseFile Test case file (optional)
- * @param aCaseNumber Test case number (optional)
- * @return None
- */
- virtual void OOMTestInitializeL( const TFileName& /* aTestCaseFile */,
- const TInt /* aCaseNumber */ );
- /**
- * From CTestModuleBase; OOMTestFinalizeL may be used to finalize OOM
- * test environment
- * @param aTestCaseFile Test case file (optional)
- * @param aCaseNumber Test case number (optional)
- * @return None
- */
- virtual void OOMTestFinalizeL( const TFileName& /* aTestCaseFile */,
- const TInt /* aCaseNumber */ );
-
- /**
- * From CTestModuleBase; OOMHandleWarningL
- * @param aTestCaseFile Test case file (optional)
- * @param aCaseNumber Test case number (optional)
- * @param aFailNextValue FailNextValue for OOM test execution (optional)
- * @return None
- */
- virtual void OOMHandleWarningL( const TFileName& /* aTestCaseFile */,
- const TInt /* aCaseNumber */,
- TInt& /* aFailNextValue */);
- protected: // New functions
- // None
-
- protected: // Functions from base classes
- // None
-
- private:
-
- /**
- * C++ default constructor.
- */
- CDemoModule();
-
- /**
- * By default Symbian 2nd phase constructor is private.
- */
- void ConstructL();
-
- // Prohibit copy constructor if not deriving from CBase.
- // ?classname( const ?classname& );
- // Prohibit assigment operator if not deriving from CBase.
- // ?classname& operator=( const ?classname& );
-
- /**
- * Function returning test case name and pointer to test case function.
- * @since ?Series60_version
- * @param aCaseNumber test case number
- * @return TCaseInfo
- */
- const TCaseInfo Case ( const TInt aCaseNumber ) const;
-
- /**
- * Simple math calculation test.
- */
- TInt SimpleMathTest( TTestResult& aResult );
-
- /**
- * Math calculation test.
- */
- TInt MathTest( TTestResult& aResult );
-
- /**
- * Actual Hardcoded test case functions are listed below.
- */
-
- /**
- * Printing test case.
- * @since ?Series60_version
- * @param aResult Test case result (PASS/FAIL)
- * @return Symbian OS error code (test case execution error
- * that is not returned as test case result in aResult)
- */
- TInt PrintTest( TTestResult& aResult );
-
- /**
- * Printing loop test case.
- * @since ?Series60_version
- * @param aResult Test case result (PASS/FAIL)
- * @return Symbian OS error code (test case execution error
- * that is not returned as test case result in aResult)
- */
- TInt LoopTest( TTestResult& aResult );
-
- /**
- * Test case for heap memory allocation
- * @since ?Series60_version
- * @param aResult Test case result (PASS/FAIL)
- * @return panic or Symbian OS error code (test case execution error
- * that is not returned as test case result in aResult)
- */
- TInt HeapMemoryAllocation( TTestResult& aResult );
-
- public: // Data
- // None
-
- protected: // Data
- // None
-
- private: // Data
- // Pointer to test (function) to be executed
- TestFunction iMethod;
-
- // Pointer to logger
- CStifLogger * iLog;
-
- // Normal logger
- CStifLogger* iStdLog;
-
- // Test case logger
- CStifLogger* iTCLog;
-
- // Flag saying if test case title should be added to log file name
- TBool iAddTestCaseTitleToLogName;
-
- // ?one_line_short_description_of_data
- //?data_declaration;
-
- // Reserved pointer for future extension
- //TAny* iReserved;
-
- public: // Friend classes
- // None
-
- protected: // Friend classes
- // None
-
- private: // Friend classes
- // None
-
- };
-
-#endif // DEMOMODULE_H
-
-// End of File