mmappfw_plat/mpx_collection_utility_api/tsrc/collectionplaylisttest/inc/mpxcollectionplaylisttest.h
changeset 0 a2952bb97e68
equal deleted inserted replaced
-1:000000000000 0:a2952bb97e68
       
     1 /*
       
     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  STIF testing for MPX Collection Playlist
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPXCOLLECTIONPLAYLISTTEST_H
       
    20 #define MPXCOLLECTIONPLAYLISTTEST_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <StifLogger.h>
       
    24 #include <TestScripterInternal.h>
       
    25 #include <StifTestModule.h>
       
    26 
       
    27 #include <mpxmedia.h>
       
    28 #include <mpxcollectionplaylistobserver.h>
       
    29 #include <mpxcollectionobserver.h>
       
    30 #include <f32file.h>
       
    31 
       
    32 // CONSTANTS
       
    33 const TInt KErrBadTestParameter= -1000;         // Error on configuration file
       
    34 
       
    35 // MACROS
       
    36 // Logging path
       
    37 #ifdef __WINSCW__
       
    38 _LIT( KMPXCollectionPlaylistTestLogPath, "\\testing\\log\\" );
       
    39 #else
       
    40 _LIT( KMPXCollectionPlaylistTestLogPath, "e:\\testing\\log\\" );
       
    41 #endif
       
    42 // Log file
       
    43 _LIT( KMPXCollectionPlaylistTestLogFile, "mpxcollectionplaylisttest.txt" );
       
    44 
       
    45 // FORWARD DECLARATIONS
       
    46 class CMPXCollectionPlaylistTest;
       
    47 class MMPXCollectionUtility;
       
    48 class CMPXCollectionPath;
       
    49 class CMPXCollectionOpenUtility;//
       
    50 
       
    51 // CLASS DECLARATION
       
    52 
       
    53 /**
       
    54 *  CMPXCollectionPlaylistTest test class for STIF Test Framework TestScripter.
       
    55 *
       
    56 *  @lib mpxcollectionplaylisttest.lib
       
    57 *  @since s60 5.0
       
    58 */
       
    59 NONSHARABLE_CLASS(CMPXCollectionPlaylistTest) : public CScriptBase,
       
    60 									                              public MMPXCollectionObserver,
       
    61 									                              public MMPXCollectionPlaylistObserver
       
    62     {
       
    63 private:
       
    64 	enum TExpectedEvents
       
    65 		{
       
    66 		EEventHandlePlaylistExportCompletedL,
       
    67 		EEventHandlePlaylistImportCompletedL,
       
    68 		EEventHandleFileAddCompletedL,
       
    69 		EEventHandleDeleteCompletedL,
       
    70 		EEventHandleFileImportCompletedL
       
    71 		};
       
    72 
       
    73 public:  // Constructors and destructor
       
    74 
       
    75 	/**
       
    76 	* Two-phased constructor.
       
    77 	*/
       
    78 	static CMPXCollectionPlaylistTest* NewL( CTestModuleIf& aTestModuleIf );
       
    79 
       
    80 	/**
       
    81 	* Destructor.
       
    82 	*/
       
    83 	virtual ~CMPXCollectionPlaylistTest();
       
    84 
       
    85 public: // Functions from base classes
       
    86 
       
    87 	/**
       
    88 	* From CScriptBase Runs a script line.
       
    89 	* @since s60 5.0
       
    90 	* @param aItem Script line containing method name and parameters
       
    91 	* @return Symbian OS error code
       
    92 	*/
       
    93 	virtual TInt RunMethodL( CStifItemParser& aItem );
       
    94 
       
    95 	/**
       
    96 	* From MMPXCollectionObserver.
       
    97 	* @since s60 5.0
       
    98 	*/
       
    99 	virtual void HandleCollectionMediaL( const CMPXMedia& aMedia, TInt aError );
       
   100 	virtual void HandleCollectionMessage( CMPXMessage* aMsg, TInt aError );
       
   101 	virtual void HandleOpenL( const CMPXMedia& aEntries, TInt aIndex, TBool aComplete, TInt aError );
       
   102 	virtual void HandleOpenL( const CMPXCollectionPlaylist& aPlaylist, TInt aError );  
       
   103 
       
   104 	/**
       
   105 	* From MMPXCollectionPlaylistObserver.
       
   106 	* @since s60 5.0
       
   107 	*/
       
   108 	virtual void HandleCollectionPlaylistChange( TInt aErr );
       
   109 	
       
   110 private:
       
   111 
       
   112 	/**
       
   113 	* C++ default constructor.
       
   114 	*/
       
   115 	CMPXCollectionPlaylistTest( CTestModuleIf& aTestModuleIf );
       
   116 
       
   117 	/**
       
   118 	* By default Symbian 2nd phase constructor is private.
       
   119 	*/
       
   120 	void ConstructL();
       
   121 
       
   122 	/**
       
   123 	* Frees all resources allocated from test methods.
       
   124 	* @since s60 5.0
       
   125 	*/
       
   126 	void Delete();
       
   127 
       
   128 	/**
       
   129 	* Add event to the expected event list
       
   130 	* @since S60 5.0
       
   131 	*/
       
   132 	void AddExpectedEvent( TExpectedEvents aEvent );
       
   133 
       
   134 	/**
       
   135 	* Remove event from the expected event list
       
   136 	* @since S60 5.0
       
   137 	*/
       
   138 	TBool RemoveExpectedEvent( TExpectedEvents aEvent );
       
   139 
       
   140     /**
       
   141      * Build a MPX Collection Path
       
   142      * @since S60 5.0
       
   143      */
       
   144     void BuildCollectionPathL();
       
   145 
       
   146 	/**
       
   147 	* Test methods are listed below.
       
   148 	*/
       
   149 
       
   150 	/**
       
   151 	* Example test method.
       
   152 	* @since s60 5.0
       
   153 	* @param aItem Script line containing parameters.
       
   154 	* @return Symbian OS error code.
       
   155 	*/
       
   156 	TInt ExampleL( CStifItemParser& aItem );
       
   157 	//ADD NEW METHOD DEC HERE
       
   158 
       
   159 	TInt CreateUtilityNewPlaylist( CStifItemParser& aItem );
       
   160     TInt CreateUtilityPlaylistExist( CStifItemParser& aItem );
       
   161     TInt CreateUtilityCollectionPath( CStifItemParser& aItem );
       
   162     TInt CreateUtilityCollectionStream( CStifItemParser& aItem );
       
   163 	TInt CopyContentL( CStifItemParser& aItem );
       
   164 	TInt Next( CStifItemParser& aItem );
       
   165 	TInt Previous( CStifItemParser& aItem );
       
   166 	TInt SetToFirst( CStifItemParser& aItem );
       
   167 	TInt SetToLast( CStifItemParser& aItem );
       
   168 	TInt SetToIndex( CStifItemParser& aItem );
       
   169 	TInt Count( CStifItemParser& aItem );
       
   170 	TInt Levels( CStifItemParser& aItem );
       
   171 	TInt Index( CStifItemParser& aItem );
       
   172 	TInt Remote( CStifItemParser& aItem );
       
   173 	TInt RepeatMode( CStifItemParser& aItem );
       
   174 	TInt Shuffle( CStifItemParser& aItem );
       
   175 	TInt Path( CStifItemParser& aItem );
       
   176 	TInt MediaL( CStifItemParser& aItem );
       
   177 	TInt SetRepeatMode( CStifItemParser& aItem );
       
   178 	TInt SetRepeatEnabled( CStifItemParser& aItem );
       
   179 	TInt SetShuffleL( CStifItemParser& aItem );
       
   180 	TInt SetShuffleEnabledL( CStifItemParser& aItem );
       
   181 	TInt StreamingL( CStifItemParser& aItem );
       
   182 	TInt SetObserver( CStifItemParser& aItem );
       
   183 	TInt EmbeddedPlaylist( CStifItemParser& aItem );
       
   184 	TInt SetEmbeddedPlaylist( CStifItemParser& aItem );
       
   185 	TInt SetL( CStifItemParser& aItem );
       
   186 	TInt CancelRequest( CStifItemParser& aItem );
       
   187 	TInt Invalidate( CStifItemParser& aItem );	
       
   188 	//add function
       
   189 	TInt NextIndex( CStifItemParser& aItem );
       
   190 	TInt PathIndex( CStifItemParser& aItem );
       
   191 	TInt CMPXCollectionPlaylistDestructor( CStifItemParser& aItem );
       
   192 	
       
   193 	TInt CMPXCollectionOpenUtilityCreate(CStifItemParser& aItem);
       
   194 	TInt CMPXCollectionOpenUtilityStartL(CStifItemParser& aItem);
       
   195     TInt CMPXCollectionOpenUtilityPathL( CStifItemParser& aItem );  
       
   196 	TInt CMPXCollectionOpenUtilityStop( CStifItemParser& aItem );
       
   197 	TInt CMPXCollectionOpenUtilitySetDelay( CStifItemParser& aItem);
       
   198 	TInt CMPXCollectionOpenUtilityStartUsingPath( CStifItemParser& aItem );
       
   199 	TInt CMPXCollectionOpenUtilitySetDirection(CStifItemParser& aItem );
       
   200 	
       
   201 	TInt NewLMMPXCollectionUtility( CStifItemParser& aItem ); 
       
   202 
       
   203 	
       
   204 private:    // Data
       
   205 	CMPXCollectionPlaylist* iCollectionPlaylist;
       
   206     CMPXCollectionPath*     iCollectionPath;
       
   207     CMPXCollectionOpenUtility* iCollectionOpenUtility ;
       
   208 	TInt iResult;
       
   209 	// List of expected events
       
   210     RArray<TExpectedEvents> iExpectedEvents;
       
   211     };
       
   212 
       
   213 #endif      // MPXcollectionplaylistTEST_H