sl@0: // Copyright (c) 2008-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: /**
sl@0:  @file
sl@0: */
sl@0: 
sl@0: #ifndef BURSTATE_H
sl@0: #define BURSTATE_H
sl@0: 
sl@0: // INCLUDES
sl@0: #include <e32svr.h>
sl@0: #include <featmgr/featurecmn.h>
sl@0: #include <featmgr/featureinfoplugin.h>
sl@0: #include <babackup.h>
sl@0: #include "featmgrclientserver.h"
sl@0: #include "featmgrtimer.h"
sl@0: #include "featmgrfeatureregistry.h"
sl@0: 
sl@0: // CLASS DECLARATION
sl@0: class CFeatMgrServer;
sl@0: class CBurState;
sl@0: 
sl@0: /**
sl@0:  * States of the backup and restore state-machine.
sl@0:  */ 
sl@0: typedef enum 
sl@0: 	{
sl@0: 	/** Normal state : Normal operation, not in a BUR state */
sl@0: 	EFeatMgrBURState_None = 0,          
sl@0: 	/** Error state */
sl@0: 	EFeatMgrBURState_Error,             
sl@0: 	/** Backup commands */
sl@0: 	EFeatMgrBURState_BackupStarted,     
sl@0: 	EFeatMgrBURState_BackupEnded,
sl@0: 	/** Restore commands */
sl@0: 	EFeatMgrBURState_RestoreStarted,    
sl@0: 	EFeatMgrBURState_RestoreEnded,
sl@0: 	} BURStatus;
sl@0: 
sl@0: const TInt KBURArrayLength = 7;
sl@0: const TInt KBURErrorArrayLength = 5;
sl@0: 
sl@0: 
sl@0: /** 
sl@0:  * State machine for handling the BUR operations for Feature Manager.
sl@0:  */ 
sl@0: class CBurState
sl@0: 	{
sl@0: 	public: 
sl@0: 
sl@0: 	~CBurState();
sl@0: 	CBurState(CFeatMgrServer* aServer);
sl@0: 
sl@0: 	static CBurState* NewL();
sl@0: 	static CBurState* NewLC();
sl@0: 	
sl@0:    	/**
sl@0:      * Function from MBackupOperationObserver in response to a change in the state of the backup and
sl@0:      * restore operation(s). This function is called to notify the Feature Manager that a backup and 
sl@0:      * restore operation is in progress.
sl@0:      * @param aBackupOperationAttributes The current state of the backup operation. Made up of 
sl@0:      *        MBackupObserver::TFileLockFlags and TOperationType types.
sl@0:      * @see	MBackupObserver::TFileLockFlags 
sl@0:      * @see	TOperationType.
sl@0:      */
sl@0: 	 void BUROperationL(const TBackupOperationAttributes& aBackupOperationAttributes);
sl@0: 
sl@0: 	private:
sl@0: 
sl@0: 	CBurState();
sl@0: 	void ConstructL();
sl@0: 	
sl@0:    /** 
sl@0:      * Used to check the TBackupOperationAttributes values that have arrived in Feature Manager 
sl@0:      * as part of HandleBackupOperationEventL. This function makes sure the arguments from the Backup and Restore
sl@0:      * server can be properly understood by the Feature Manager.
sl@0:      * @param  TBackupOperationAttributes
sl@0:      * @return Error code. Can either be KErrNone or KErrNotFound if an argument is not understood.
sl@0:      * @see    CFeatMgrFeatureRegistry::HandleBackupOperationEventL
sl@0:      */
sl@0:     TInt CheckBURArguments(  const TBackupOperationAttributes& aBackupOperationAttributes );
sl@0:     
sl@0:     /** 
sl@0:      * Conversion function will change TBackupOperationAttributes into a form more easily managed.
sl@0:      * @param TBackupOperationAttributes
sl@0:      * @return BURStatus
sl@0:      */
sl@0:     BURStatus ConvertToBURState(  const TBackupOperationAttributes& aBackupOperationAttributes );        
sl@0: 
sl@0:     /**
sl@0:      * Increment the state machine.
sl@0:      * @param aCurrent : current state (location)
sl@0:      * @param aGoto : state to go to next (direction)
sl@0:      * @return next state
sl@0:      */
sl@0:     BURStatus BUR_StateMachine( BURStatus aCurrent, BURStatus aGoto );
sl@0:     
sl@0:     void SetUpBurStruct();
sl@0:     
sl@0:     // Backup Notification
sl@0:     TUint32 iBackupFlag;
sl@0:     CBaBackupSessionWrapper *iBackupNotification;
sl@0:     BURStatus iCurrentBURStatus;
sl@0:     CFeatMgrServer *iServer;
sl@0:     
sl@0:     /** The file lock status of the file we are interested in. */ 
sl@0:     MBackupObserver::TFileLockFlags iBURLockFlag;
sl@0:     /** The current BUR operation, e.g. Start/End. */ 
sl@0:     MBackupOperationObserver::TOperationType iBUROpType;
sl@0:         
sl@0:     /**
sl@0:      * A structure for storing the information on the possible state elements
sl@0:      * that are used for backup and restore. Each element has a current state, and
sl@0:      * a direction to goto. e.g. (s1)-> (s2)-> (s3)-> (s4)-> (s5)-> etc..
sl@0:      * The state machine is formed from a series of these interconnecting elements, 
sl@0:      * and transition between states is handled by an associated function.
sl@0:      */
sl@0:     struct BURStruct
sl@0:         {
sl@0:         BURStatus iCurrent;
sl@0:         BURStatus iGoto;
sl@0:         
sl@0:         /** A function pointer that is called to switch between states */
sl@0:         BURStatus  (CFeatMgrServer::*iFunc)( BURStatus );
sl@0:         };
sl@0:     
sl@0:     /** 
sl@0:      * State machine architecture, written as BURStruct elements. This array defines the 
sl@0:      * normal operation paths of the state machine.
sl@0:      */
sl@0:     BURStruct iBURStructArray[ KBURArrayLength ];
sl@0:     /** 
sl@0:      * Error handling is taken care of in the same manner as normal operation 
sl@0:      * in the state machine architecture. Also written as written as BURStruct elements.
sl@0:      * The error array defines a set of paths to take upon discovering a path that is 
sl@0:      * not supported by the normal operation paths.
sl@0:      */
sl@0:     BURStruct iBURStructErrorArray[ KBURErrorArrayLength ];
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #endif // BURSTATE_H
sl@0: