/*

* Copyright (c) 2002-2008 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:  Message handler

*

*/

#ifndef CPEMESSAGEHANDLER_H

#define CPEMESSAGEHANDLER_H

//  INCLUDES

#include <pevirtualengine.h>

#include <DosSvrServices.h>

#include <cphcltcommandhandler.h>

#include <cphcltdialdata.h>

#include "mpecallhandling.h"

#include "mpecallcontrolif.h" 

#include "mpekeysequencerecognitionif.h"

// CONSTANTS

const TInt KModeNormal = 0;  // Normal System mode  

const TInt KModeFligth = 1;  // Flight mode 

const TInt KModePDA    = 2;  // PDA mode 

// Valid characters in an dialing string

_LIT( KPEClientValidChars, "+0123456789*#pwPW" );

_LIT( KPEValidDTMFChars, "0123456789*#pwPW" );

_LIT( KPEValidDTMFStringStopChars, "+pPwW" );

// DTMF Speed dial substitution

_LIT( KPEValidSpeedDialChars, "23456789" );

const TInt KPEDtmfSpeedDialSubstitutionsMax = 2; // prevent infinite loop.

const TInt KPESpeedDialIndexMin = 2;

const TInt KPESpeedDialIndexMax = 9;

// DTMF parsing status for Speed dial location

enum TPESpeedDialSubstituionStatus

    {

    EPEDtmfSpeedDialOk,

    EPEDtmfSpeedDialPromptUser,

    EPEDtmfSpeedDialNotAssigned,

    EPEDtmfSpeedDialInvalidSpeedDial

    };

// Invalid characters in an dialing string, these chars can be removed from dial string

_LIT( KPECharsThatCanBeDelete, "\"/ ().-" );

// MACROS

// None.

// DATA TYPES

// Phone number prefix text, for prefix change

typedef TBuf<10> TPEPrefixText;

// FUNCTION PROTOTYPES

// None.

// FORWARD DECLARATIONS

class MPEPhoneModelInternal;

class MPECallHandling;

class MEngineMonitor;

class CPEGsmAudioData;

class CPESimStateMonitor;

class CPEMMParserBase;

class CPETimer;

class MPEAudioData;

class MPELogHandling;

class MPEContactHandling;

class CPEMMHandlerContainer;

class RTASecuritySession;

class CPEClientInformation;

class CPEClientServices;

class CPEClientCallRequestMonitor;

class CPEExternalDataHandler;

class MPEDataStore;

class CPhoneGsmOptionContainerBase;

class CPEParserPhoneNumberHandler;

class CPEParserSSHandler;

class CPhoneGsmParserBase;

class CPhoneGsmHandlerContainer;

class CPhoneGsmParserResult;

class CPEParserEmergencyNumberHandler;

class CPEParserVoipNumberHandler;

class CPEManualCallControlHandler;

class MPEServiceHandling;

// CLASS DECLARATION

/**

*  Handles phone related messages from the MPEPhoneModelInternal object.

*

*  @lib phoneenginebase.dll

*  @since S60_5.0

*/

NONSHARABLE_CLASS( CPEMessageHandler ) 

    : 

        public CBase, 

        public MPECallControlIF,

        public MPEKeySequenceRecognitionIF

    {

    public:  // Destructor

        /**

        * Two-phased constructor.

        */

        static CPEMessageHandler* NewL( 

                MPEPhoneModelInternal& aModel,

                MPECallHandling& aCallHandling,

                MEngineMonitor& aEngineMonitor,

                CPEGsmAudioData& aAudioData,

                MPELogHandling& aLogHandling,

                MPEContactHandling& aContactHandling,

                CPESimStateMonitor& aSimStateMonitor,

                CPEExternalDataHandler& aGsmExternalDataHandler,

                                           MPEServiceHandling& aServiceHandling,

                RFs& aFsSession );

        /**

        * Destructor.

        */

        ~CPEMessageHandler();

    public: // New functions

        /**

        * Handles answer call message from the phone application.

        * @param aAutomaticAnswer, ETrue if triggered by automatic answer

        * @return possible error code from the CallHandling subsystem.

        */

        TInt HandleAnswerCall( const TBool aAutomaticAnswer );

        /**

        * Handles accessory mode changed message from AudioHandling subsystem.

        * @param aVideoCall, ETrue if call type video call

        * @return possible error code from the AudioHandling subsystem

        */

        TInt HandleAudioRouting( TBool aVideoCall, TInt aCallId );

        /**

        * Handles route preference changed message from AudioHandling subsystem.

        * @return possible error code from the AudioHandling subsystem

        */

        TInt HandleRoutePreferenceChanged();

        /**

        * Handles continue dtmf sending ('w' character in the dtmf string have defected stop in the dtmf sending)

        * @param aContinue, informs continue or not.

        */

        void HandleContinueDtmfSending( const TBool aContinue );

        /**

        * Handles release all message from phone application 

        * @return possible error code from the CallHandling subsystem.

        */

        TInt HandleReleaseAll( );

        /**

        * Handles release message from phone application 

        * @param aAutoResumeOption if options for autoresume.

        * @return Return possible error code.

        */

        TInt HandleReleaseCall( TPEHangUpOptions aAutoResumeOption = ETPEHangUpDefault );

        /**

        * Handles send dtmf message from phone application 

        * @return possible error code from the CallHandling subsystem.

        */

        TInt HandleSendDtmf();

        /**

        * Handles audio mute message from the phone application. 

        */

        void HandleSetAudioMute();

        /**

        * Handles audio output message from the phone application. 

        * @return possible error code from the AudioHandling subsystem.

        */

        TInt HandleSetAudioOutput();

        /**

        * Handles change volume message from the phone application.

        */

        void HandleSetAudioVolume();

        /**

        * Starts tone playing. 

        */

        void HandlePlayDTMFL();

        /**

        * Stops tone playing. 

        * @return error code.

        */

        TInt HandleEndDTMF();

        /**

        * Terminates all connected calls, waiting call, data connections.

        * @return errorCode.

        */        

        TInt HandleTerminateAllConnections(); 

        /**

        * Sets phone client information

        * @param aCallId, the dentification number of the call.

        * @param aMainPartOfPhoneNumber The phone number, 

        *        where extra chaters "/ ().-" and possible prefix are removed. 

        */        

        void SetClientInformation( const TInt aCallId, 

            const TDesC& aMainPartOfPhoneNumber );

         /**

        * Sets phone client information

        * @param aClientDialData Client dial data 

        */  

        void SetClientData( 

            const CPhCltDialData& aClientDialData ); 

        /**

        * Checks if the current char is removable

        * @param TChar, current character from inspected string.

        * @return TBool.

        */

        TBool IsItCharThatCanDelete( const TChar& aChar ) const;

        /**

        * Checks if the current char is valid

        * @param TChar, current character from inspected string.

        * @return TBool.

        */

        TBool IsValidChar( const TChar& aChar, const TDesC& aValidChars ) const;

        /**

        * Removes invalid char if it is removable

        * @param TDesc, current string from wich we are interested in.

        * @return TBool.

        */

        TBool RemoveInvalidChars( TDes& aString, 

                                           const TDesC& aValidChars, 

                                           const TBool aCheckForDelete ) const;

        /**

        * Handles lifetimer data from customa api -> engineinfo.

        * @return TInt possible error code..

        */

        TInt HandleGetLifeTimerData() const;

        /**

        * Handles EPEMessageDTMFSent message from call handling subsystem

        * @param ECCPErrorNone or KPEDontSendMessage

        */

        TInt HandleDtmfSent();

        /**

        * Stops DTMF sending and resets DTMF processing state

        */

        void StopDtmfSending();

        /**

        * Handles reject call message 

        * @return possible error code from the CallHandling subsystem.

        */

        TInt HandleRejectCall();

        /**

        * Called asyncronously from callback. Calls HandleSendDtmf()

        * function.

        * @param aAny Pointer to 'this' object.

        * @return error code.

        */

        static TInt CallBackHandleSendDtmf( TAny* aAny );

        /**

        * Handles plus (+) sign in a DTMF string.

        * @param aDtmfString Current DTMF string to process.

        */

        void HandlePlusSignInDtmf( const TPEDtmfString& aDtmfString );

        /**

        * Called asyncronously from callback.

        * @param aAny Pointer to 'this' object.

        * @return error code.

        */

        static TInt CallbackSendMessageStoppedDTMF( TAny* aAny );

        /**

        * Handles build conference message from phone application

        * @return Return possible error code from the CallHandling subsystem.

        */

        TInt HandleBuildConferenceCall();

        /**

        * Handles Going private in Conference Call

        * @return possible error code from the CallHandling subsystem.

        */

        TInt HandleGoOneToOne();        

        /**

        * Gets basic service group value. 

        * @return basic service group.

        */

        inline RMobilePhone::TMobileService BasicServiceGroup();

        /**

        * Handles add conference member message from phone application

        * @return possible error code.

        */

        TInt HandleAddConferenceMember();

        /**

        * Handles dropped conference member message

        */

        void HandleDroppedConferenceMember();

        /**

        * Handles EPEMessageALSLineChanged message.

        */

        void HandleALSLineChanged();

        /**

        * Handles error message from the CallHandling subsystem.

        * @param aCallId is the identification number of the call.

        * @param aBusyCall informs that error cause was busy remote party.

        */

        void HandleCallHandlingError( const TInt aCallId, const TBool aBusyCall );

        /**

        * Handles cancel SS string command.

        * @return Possible error code from the Settings utility subsystem.

        *         Security module don't have return value from cancel command.

        */

        TInt HandleCancelSSstringCommand();

        /**

        * Handles conference idle state

        * @param aCallId is the identification number of the call.

        * @return Return possible error code.

        */

        TInt HandleConferenceIdleState( const TInt aCallId );

        /**

        * Handles connected message from the CallHandling subsystem.

        * @param aCallId, identification number of the call.

        * @return possible error code from the CallHandling subsystem.

        */

        TInt HandleConnectedState( const TInt aCallId );

        /**

        * Handles video call logging in Connected state

        * @param aCallId is the identification number of the call.

        * @return Return possible error code.

        */

        TInt HandleVideoCallConnected( const TInt aCallId );

        /**

        * Handles video call logging in Idle state

        * @param aCallId is the identification number of the call.

        * @return Return possible error code.

        */

        TInt HandleVideoCallIdle( const TInt aCallId );

        /**

        * Handles EPEMessageSetALSLine message.

        */

        void HandleSetALSLineL();

        /**

        * Handles dial message from phone application or phone client.

        * @param aClientCall, Informs is the current call client originated or not.

        * @return Return possible error code.

        */

        TInt HandleDialCall( const TBool aClientCall );        

        /**

        * Handles dial emergency message from phone application or phone client.

        * Phase one of emergency call initialization

        * @param aClientCall, Informs is the current call client originated or not.

        * @return Return possible error code.

        */

        TInt HandleDialEmergencyCall( const TBool aClientCall );        

        /**

        * Handles Sat dial request completed message from the phone application 

        */

        void HandleSatCallRequestCompleted( );

        /**

        * Phase two of emergency call initialization

        */

        void ContinueDialEmergency();

        /**

        * Handles dialing state transition for voice and video calls

        * @param aCallId is the identification number of the call.

        */

        void HandleDialingStateL( const TInt aCallId );

        /**

        * Handles incoming voice and video call

        * @param aCallId is the identification number of the call.

        */

        void HandleIncomingCallL( const TInt aCallId );

        /**

        * Handles disconnecting without inband tones.

        * @param aCallId is the identification number of the call.

        * @return possible error code.

        */

        TInt HandleDisconnecting( const TInt aCallId ); 

        /**

        * Handles disconnecting with inband tones.

        * @param aCallId is the identification number of the call.

        * @return possible error code.

        */

        TInt HandleDisconnectingWithInband( const TInt aCallId );

        /**

        * Handles drop conference member message from phone application

        * @return possible error code from the CallHandling subsystem.

        */

        TInt HandleDropConferenceMember();

        /**

        * Handles hold message from the phone application 

        * @return possible error code from the CallHandling subsystem.

        */

        TInt HandleHoldCall( );

        /**

        * Handles video call switch to video or voice from phoneui 

        */

        TInt HandleSwitchToVideoOrVoice( const TInt aCallId ); 

        /**

        * Continue switch to video call or voice call.

        * Calls dial method to create new video call or voice call 

        * to same phonenumber.

        * @param aCallId is the identification number of the call.

        * @return possible error code from the CallHandling subsystem.

        */

        TInt ContinueSwitchToCall( const TInt aCallId );  

        /**

        * Handles idle state message from the CallHandling subsystem.

        * @param aCallId is the identification number of the call.

        * @return Return possible error code from the CallHandling subsystem.

        */

        TInt HandleVoiceCallIdleState( const TInt aCallId );

        /**

        * Handles play DMTF message from phone application 

        */

        void ProcessPlayDTMFL( );

        /**

        * Handles end DTMF playing message from phone application 

        * @return possible error code from the CallHandling subsystem.

        */

        TInt ProcessEndDTMF( );

        /**

        * Handles resume message from phone application 

        * @return possible error code from the CallHandling subsystem.

        */

        TInt HandleResumeCall( );

        /**

        * Handles send USSD request from CPEGsmParserMiscHandler

        * @param aString, USSD string to be sent

        * @return Symbian OS error code

        */

        TInt HandleSendUssd( const TDesC& aString );

        /**

        * Handles EPEMessageSimStateChanged from Dos Server.

        * @return None.

        */

        void HandleSimStateChanged( );

        /**

        * Handles startup message from the phone application.

        * @return None.

        */

        void HandleStartUp();

        /**

        * Handles Phone Number Edited message from phone application 

        */

        void HandlePhoneNumberEditedL();

        /**

        * Handles service enabled message from service handling subsystem

        * @since Series60_5.0

        * @return possible error code from the ServiceHandling subsystem

        */

        TInt HandleServiceEnabled();

        /**

         * Handles remote party information changed         

         * @since Series60_5.2         

         */

        void HandleRemotePartyInfoChanged( );

        /**

        * Handles swap message from the phone application 

        * @return possible error code from the CallHandling subsystem.

        */

        inline TInt HandleSwapCalls();

        /**

        * Handles transfer message from phone application.

        * @return possible error code from the CallHandling subsystem.

        */

        inline TInt HandleTransferCalls();