usbuis/usbuinotif/tsrc/usbuinotifapitest/inc/usbuinotifapitest.h
branchRCL_3
changeset 24 e02eb84a14d2
parent 23 25fce757be94
--- a/usbuis/usbuinotif/tsrc/usbuinotifapitest/inc/usbuinotifapitest.h	Tue Aug 31 16:13:57 2010 +0300
+++ b/usbuis/usbuinotif/tsrc/usbuinotifapitest/inc/usbuinotifapitest.h	Wed Sep 01 12:20:49 2010 +0100
@@ -1,5 +1,5 @@
 /*
-* Copyright (c) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).
+* Copyright (c) 2008-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"
@@ -15,6 +15,9 @@
 *
 */
 
+
+
+
 #ifndef USBUINOTIFAPITEST_H
 #define USBUINOTIFAPITEST_H
 
@@ -32,57 +35,98 @@
 #include <usbwatcher.h>
 #include <usb/hostms/srverr.h> 
 // CONSTANTS
+//const ?type ?constant_var = ?constant;
 
 // MACROS
+//#define ?macro ?macro_def
 #define TEST_CLASS_VERSION_MAJOR 0
 #define TEST_CLASS_VERSION_MINOR 0
 #define TEST_CLASS_VERSION_BUILD 0
 
 // Logging path
-_LIT( KUSBUiNotifApiTestLogPath, "e:\\testing\\stiflogs\\" ); 
+//_LIT( KUsbUiNotifApiTestLogPath, "\\logs\\testframework\\UsbUiNotifApiTest\\" );
+
+// Logging path for ATS - for phone builds comment this line
+_LIT( KUsbUiNotifApiTestLogPath, "e:\\testing\\stiflogs\\" ); 
 
 // Log file
-_LIT( KUSBUiNotifApiTestLogFile, "USBUiNotifApiTest.txt" ); 
-_LIT( KUSBUiNotifApiTestLogFileWithTitle, "USBUiNotifApiTest_[%S].txt" );
+_LIT( KUsbUiNotifApiTestLogFile, "UsbUiNotifApiTest.txt" ); 
+_LIT( KUsbUiNotifApiTestLogFileWithTitle, "UsbUiNotifApiTest_[%S].txt" );
 
 // FUNCTION PROTOTYPES
+//?type ?function_name(?arg_list);
 
 // FORWARD DECLARATIONS
-class CUSBUiNotifApiTest;
+//class ?FORWARD_CLASSNAME;
+class CUsbUiNotifApiTest;
 
 // DATA TYPES
+//enum ?declaration
+
+enum TUsbUiNotifApiTestResult
+    {
+    ETestCasePassed,
+    ETestCaseFailed
+    };
+
 enum TTestOption
     {
     EQueryDiscarded = 0,
     EQueryAccepted,
     EQueryCanceled
     };
+//typedef ?declaration
+//extern ?data_type;
 
 // CLASS DECLARATION
 
+NONSHARABLE_CLASS( TUsbUiNotifApiTestBlockParams )
+    {
+    public:
+        TPtrC iTestBlockName;
+        
+        TPtrC iTestOption1;
+        TPtrC iTestOption2;
+        TPtrC iTestOption3;
+        
+        TInt iTestIntOption1;
+        TInt iTestIntOption2;
+        
+        TChar iTestCharOption1;
+        TChar iTestCharOption2;
+    };
+
 /**
-*  CUSBUiNotifApiTest test class for STIF Test Framework TestScripter.
+*  CUsbUiNotifApiTest test class for STIF Test Framework TestScripter.
 *  ?other_description_lines
 *
 *  @lib ?library
 *  @since ?Series60_version
 */
-NONSHARABLE_CLASS(CUSBUiNotifApiTest) : public CScriptBase
+NONSHARABLE_CLASS( CUsbUiNotifApiTest ) : public CScriptBase
     {
     public:  // Constructors and destructor
 
         /**
         * Two-phased constructor.
         */
-        static CUSBUiNotifApiTest* NewL( CTestModuleIf& aTestModuleIf );
+        static CUsbUiNotifApiTest* NewL( CTestModuleIf& aTestModuleIf );
 
         /**
         * Destructor.
         */
-        virtual ~CUSBUiNotifApiTest();
+        virtual ~CUsbUiNotifApiTest();
 
     public: // New functions
 
+        /**
+        * ?member_description.
+        * @since ?Series60_version
+        * @param ?arg1 ?description
+        * @return ?description
+        */
+        //?type ?member_function( ?type ?arg1 );
+
     public: // Functions from base classes
 
         /**
@@ -95,20 +139,38 @@
 
     protected:  // New functions
 
+        /**
+        * ?member_description.
+        * @since ?Series60_version
+        * @param ?arg1 ?description
+        * @return ?description
+        */
+        //?type ?member_function( ?type ?arg1 );
+
     protected:  // Functions from base classes
 
+        /**
+        * From ?base_class ?member_description
+        */
+        //?type ?member_function();
+
     private:
 
         /**
         * C++ default constructor.
         */
-        CUSBUiNotifApiTest( CTestModuleIf& aTestModuleIf );
+        CUsbUiNotifApiTest( CTestModuleIf& aTestModuleIf );
 
         /**
         * 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& );
+
         /**
         * Frees all resources allocated from test methods.
         * @since ?Series60_version
@@ -118,23 +180,13 @@
         /**
         * Test methods are listed below. 
         */
-        virtual TInt CableConnectedNotifierTest( CStifItemParser& aItem );
-        virtual TInt FinishCableConnectedQuery( CStifItemParser& aItem );
-        virtual TInt UsbQueriesNotifierTest( CStifItemParser& aItem );
-        virtual TInt UsbOTGErrorNotifierTests( CStifItemParser& aItem );
-        virtual TInt UsbOTGWarningNotifierTests( CStifItemParser& aItem );
-        virtual TInt FinishQuery( CStifItemParser& aItem );
-        virtual TInt LoadNotifiersL( CStifItemParser& aItem );
-        virtual TInt UnLoadNotifiers ( CStifItemParser& aItem );
-        virtual TInt UsbMSMMNotifierTests ( CStifItemParser& aItem );
-        virtual TInt CancelMsmmNotifier( CStifItemParser& aItem );
-        virtual TInt CancelQueryNotifier( CStifItemParser& aItem );
-        virtual TInt CancelOtgErrorNotifier( CStifItemParser& aItem );
-        virtual TInt CancelOtgWarningNotifier( CStifItemParser& aItem );
-        virtual TInt CancelCableConnectedNotifier( CStifItemParser& aItem );
-        virtual TInt WaitForRequest( CStifItemParser& aItem );
-        virtual TInt SynchStart( CStifItemParser& aItem );
-        virtual TInt Update( CStifItemParser& aItem );
+
+        virtual TInt ExecuteApiTestBlock( CStifItemParser& aItem );
+        virtual TInt ExecuteModuleTestBlock( CStifItemParser& aItem );
+        virtual TInt ExecuteBranchTestBlock( CStifItemParser& aItem );
+        
+        
+        
         /**
          * Method used to log version of test class
          */
@@ -142,22 +194,52 @@
 
         //ADD NEW METHOD DEC HERE
         //[TestMethods] - Do not remove
+
+        void GetTestBlockParamsL( CStifItemParser& aItem );
+        
+    	void DoExecuteApiTestBlockL( CStifItemParser& aItem, TUsbUiNotifApiTestResult& aTestResult );    	
+    	void DoExecuteModuleTestBlockL( CStifItemParser& aItem, TUsbUiNotifApiTestResult& aTestResult );    
+    	void DoExecuteBranchTestBlockL( CStifItemParser& aItem, TUsbUiNotifApiTestResult& aTestResult );
+    	
+        void ExampleTestL( TPtrC aTestOption, TPtrC aTestSubOption, 
+                 TInt aTestIntOption, TInt aTestCharOption, TUsbUiNotifApiTestResult& aTestResult );
+
+        void CableConnectedNotifierTest( TPtrC aTestSubOption, TUsbUiNotifApiTestResult& aTestResult );
+        void ConnectionNotifierTest( TPtrC aTestSubOption, TUsbUiNotifApiTestResult& aTestResult );
+        void UsbQueriesNotifierTest( TPtrC aTestSubOption, TUsbUiNotifApiTestResult& aTestResult );
+        void UsbOTGErrorNotifierTests( TPtrC aTestSubOption, TUsbUiNotifApiTestResult& aTestResult );
+        void UsbOTGWarningNotifierTests( TPtrC aTestSubOption, TUsbUiNotifApiTestResult& aTestResult );
+        TInt FinishQuery( TPtrC aTestSubOption, TUsbUiNotifApiTestResult& aTestResult );
+        void LoadNotifiersL( TUsbUiNotifApiTestResult& aTestResult );
+        void UnLoadNotifiers ( TUsbUiNotifApiTestResult& aTestResult );
+        void Update( TUsbUiNotifApiTestResult& aTestResult );
+        //void Cancelnotifier( TPtrC aTestSubOption, TUsbUiNotifApiTestResult& aTestResult ); 
+        void Notifierstart( TUsbUiNotifApiTestResult& aTestResult );
+        //void AsyncConnectionNotifier ( TPtrC aTestSubOption, TUsbUiNotifApiTestResult& aTestResult );
+        void UsbMSMMNotifierTests ( TPtrC aTestSubOption, TUsbUiNotifApiTestResult& aTestResult );
+
         TInt GetTestOption( TPtrC aOptionString, TTestOption& aOption );
         TInt GetPersonalityIdFromString( TPtrC aOptionString, TInt& aPersonalityId );
         TInt GetQueryType( TPtrC aTypeString, TUSBUIQueries& aQueryType );        
         TInt GetOTGErrorType( TPtrC aTypeString, TUsbUiNotifOtgError& aQueryType );
         TInt GetOTGWarningType( TPtrC aTypeString, TUsbUiNotifOtgWarning& aQueryType );
         TInt GetMSMMrrorType( TPtrC aTypeString, THostMsErrCode& aQueryType );
-        TInt FindAndKillProcess(const TDesC& aProcessName);
 
+        inline void Trace(TRefByValue<const TDesC8> aFmt, ...);
+        inline void Trace(TRefByValue<const TDesC16> aFmt, ...);
+	
     public:     // Data
+        // ?one_line_short_description_of_data
+        //?data_declaration;
 
     protected:  // Data
+        // ?one_line_short_description_of_data
+        //?data_declaration;
 
     private:    // Data
-        
+        TUsbUiNotifApiTestBlockParams iTestBlockParams;
+
         RNotifier *iNotifier;
-        TBool iNotifierConnected;
         RUsbWatcher* iUsbWatcher;
  
         CRepository* iRepository;
@@ -172,14 +254,19 @@
         THostMsErrData iErrData;
         THostMsErrorDataPckg iErrPckg ;
 
+        // Reserved pointer for future extension
+        //TAny* iReserved;
+
     public:     // Friend classes
         //?friend_class_declaration;
     protected:  // Friend classes
         //?friend_class_declaration;
     private:    // Friend classes
         //?friend_class_declaration;
+        
+    };
 
-    };
+#include "UsbUiNotifApiTestDebug.inl"
 
 #endif      // USBUINOTIFAPITEST_H