/*

* Copyright (c) 2004-2007 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 is the main interface of the SI Controller Plugin.

*

*/

// INCLUDE FILES

#include "srsfbldvariant.hrh"

#include <mmfcontrollerframeworkbase.h>

#include <nsssispeechrecognitioncustomcommandparser.h>

#include <implementationproxy.h>

#include "sicontrollerplugininterface.h"

#include "sicontrollerplugin.h"

#include "sipluginimplementationuids.hrh"

#include "rubydebug.h"

// ============================= LOCAL FUNCTIONS ===============================

// ============================ MEMBER FUNCTIONS ===============================

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::CSIControllerPluginInterface

// C++ default constructor can NOT contain any code, that might leave.

// -----------------------------------------------------------------------------

//

CSIControllerPluginInterface::CSIControllerPluginInterface()

    {

    RUBY_DEBUG0( "CSIControllerPluginInterface::CSIControllerPluginInterface" );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::ConstructL

// Symbian 2nd phase constructor can leave.

// -----------------------------------------------------------------------------

//

#ifndef __CONSOLETEST__

void CSIControllerPluginInterface::ConstructL()

    {

    RUBY_DEBUG_BLOCK( "CSIControllerPluginInterface::ConstructL" );

    iController = CSIControllerPlugin::NewL(*this);

    CSISpeechRecognitionCustomCommandParser* speechRecognitionParser =

        CSISpeechRecognitionCustomCommandParser::NewL(*this);

    CleanupStack::PushL(speechRecognitionParser);

    AddCustomCommandParserL(*speechRecognitionParser);

    // The parser is owned by the controller framework

    CleanupStack::Pop(speechRecognitionParser);

    }

#else	// __CONSOLETEST__ defined

// Unit Test

void CSIControllerPluginInterface::ConstructL( MSrsObserver* aObserver )

    {

    iController = CSIControllerPlugin::NewL(*this);

    iObserver = aObserver;

    }

// Unit Test

void CSIControllerPluginInterface::ConstructL()

    {

    iController = CSIControllerPlugin::NewL(*this);

    iObserver = NULL;

    }

#endif	// __CONSOLETEST__

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::NewL

// Two-phased constructor.

// -----------------------------------------------------------------------------

//

CSIControllerPluginInterface* CSIControllerPluginInterface::NewL()

    {

    RUBY_DEBUG_BLOCK( "CSIControllerPluginInterface::NewL" );

    CSIControllerPluginInterface* self = new( ELeave ) CSIControllerPluginInterface;

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop();

    return self;

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::~CSIControllerPluginInterface

// Destructor.

// -----------------------------------------------------------------------------

//

CSIControllerPluginInterface::~CSIControllerPluginInterface()

    {

    RUBY_DEBUG0( "CSIControllerPluginInterface::~CSIControllerPluginInterface" );

    delete iController;

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::AddDataSourceL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::AddDataSourceL( MDataSource& /*aDataSource*/ )

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::AddDataSinkL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::AddDataSinkL( MDataSink& /*aDataSink*/ )

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::RemoveDataSourceL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::RemoveDataSourceL( MDataSource& /*aDataSource*/ )

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::RemoveDataSinkL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::RemoveDataSinkL( MDataSink& /*aDataSink*/ )

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::ResetL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::ResetL()

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::PrimeL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::PrimeL()

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::PlayL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::PlayL()

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::PauseL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::PauseL()

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::StopL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::StopL()

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::PositionL

// This function is not supported.

// -----------------------------------------------------------------------------

//

TTimeIntervalMicroSeconds CSIControllerPluginInterface::PositionL() const

    {

    User::Leave( KErrNotSupported );

    return TTimeIntervalMicroSeconds( 0 ); // Just to make the compiler happy

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::SetPositionL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::SetPositionL( const TTimeIntervalMicroSeconds& /*aPosition*/ )

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::DurationL

// This function is not supported.

// -----------------------------------------------------------------------------

//

TTimeIntervalMicroSeconds CSIControllerPluginInterface::DurationL() const

    {

    User::Leave( KErrNotSupported );

    return TTimeIntervalMicroSeconds( 0 ); // Just to make the compiler happy

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::SetPrioritySettings

// Set the priority settings for this controller.  This is used during recording

// and playback.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::SetPrioritySettings( const TMMFPrioritySettings& aPrioritySettings )

    {

    iController->SetPrioritySettings( aPrioritySettings );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::GetNumberOfMetaDataEntriesL

// This function is not supported.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::GetNumberOfMetaDataEntriesL( TInt& /*aNumberOfEntries*/ )

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::GetMetaDataEntryL

// This function is not supported.

// -----------------------------------------------------------------------------

//

CMMFMetaDataEntry* CSIControllerPluginInterface::GetMetaDataEntryL( TInt /*aIndex*/ )

    {

    User::Leave( KErrNotSupported );

    return NULL; // Just to make the compiler happy

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrAddPronunciationL

// Adds a new pronunciation into the lexicon.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrAddPronunciationL( TSILexiconID aLexiconID,

                                                         TSIModelBankID aModelBankID,

                                                         TSIModelID aModelID,

                                                         TSIPronunciationID& aPronunciationID )

    {

    iController->AddPronunciationL(aLexiconID, aModelBankID, aModelID, aPronunciationID);

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrAddRuleL

// Adds a new rule into the grammar.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrAddRuleL( TSIGrammarID /*aGrammarID*/,

                                                TSILexiconID /*aLexiconID*/,

                                                TSIPronunciationID /*aPronunciationID*/,

                                                TSIRuleID& /*aRuleID*/ )

    {

    User::Leave( KErrNotSupported );	

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrCancel

// Cancels the current activity and returns the plugin to Idle state.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrCancel()

    {

    iController->Cancel();

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrCommitTrainL

// Training is complete.  Call model database handler to save the model into the

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrCommitChangesL()

    {

    iController->CommitChangesL( ETrue );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrCreateGrammarL

// Creates a new grammar.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrCreateGrammarL( TSIGrammarID& aGrammarID )

    {

    iController->CreateGrammarL( aGrammarID );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrCreateLexiconL

// Creates a new lexicon.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrCreateLexiconL( TSILexiconID& aLexiconID )

    {

    iController->CreateLexiconL( aLexiconID );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrCreateModelBankL

// Creates a new model bank.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrCreateModelBankL( TSIModelBankID& aModelBankID )

    {

    iController->CreateModelBankL( aModelBankID );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrEndRecSessionL

// Ends recognition session and releases resources.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrEndRecSessionL()

    {

    iController->EndRecSessionL();

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAllClientGrammarIDsL

// Returns all grammar Ids that belong to the current client.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAllClientGrammarIDsL( RArray<TSIGrammarID>& aGrammarIDs )

    {

    iController->GetAllClientGrammarIDsL( aGrammarIDs );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAllClientLexiconIDsL

// Returns all lexicon Ids that belong to the current client.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAllClientLexiconIDsL( RArray<TSILexiconID>& aLexiconIDs )

    {

    iController->GetAllClientLexiconIDsL( aLexiconIDs );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAllClientModelBankIDsL

// Returns all model bank Ids that belong to the current client.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAllClientModelBankIDsL( RArray<TSIModelBankID>& aModelBankIDs )

    {

    iController->GetAllClientModelBankIDsL( aModelBankIDs );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAllGrammarIDsL

// Returns all grammar Ids that exist (for all clients).

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAllGrammarIDsL( RArray<TSIGrammarID>& aGrammarIDs )

    {

    iController->GetAllGrammarIDsL( aGrammarIDs );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAllLexiconIDsL

// Returns all lexicon Ids that exist (for all clients).

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAllLexiconIDsL( RArray<TSILexiconID>& aLexiconIDs )

    {

    iController->GetAllLexiconIDsL( aLexiconIDs );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAllModelBankIDsL

// Returns all model bank Ids that exist (for all clients).

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAllModelBankIDsL( RArray<TSIModelBankID>& aModelBankIDs )

    {

    iController->GetAllModelBankIDsL( aModelBankIDs );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAllModelIDsL

// Gets all model IDs in the model bank.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAllModelIDsL( TSIModelBankID aModelBankID,

                                                       RArray<TSIModelID>& aModelIDs )

    {

    iController->GetAllModelIDsL( aModelBankID, aModelIDs );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAllPronunciationIDsL

// Gets all pronunciation IDs in the lexicon.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAllPronunciationIDsL( TSILexiconID aLexiconID,

                                                               RArray<TSIPronunciationID>& aPronunciationIDs )

    {

    iController->GetAllPronunciationIDsL( aLexiconID, aPronunciationIDs );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAllRuleIDsL

// Gets all rule IDs in the grammar.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAllRuleIDsL( TSIGrammarID aGrammarID,

                                                      RArray<TSIRuleID>& aRuleIDs )

    {

    iController->GetAllRuleIDsL( aGrammarID, aRuleIDs );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetAvailableStorageL

// Calculates the available number of models that can be trained by subtracting

// the current total from the system defined max.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetAvailableStorageL( TInt& /*aCount*/ )

    {

    User::Leave( KErrNotSupported );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetEnginePropertiesL

// Returns the current recognition engine properties.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetEnginePropertiesL( const RArray<TInt>& aPropertyId,

                                                            RArray<TInt>& aPropertyValue )

    {

    iController->GetEnginePropertiesL( aPropertyId, aPropertyValue );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetModelCountL

// Gets the number of models in a model bank.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetModelCountL( TSIModelBankID aModelBankID,

													  TInt& aCount )

    {

    iController->GetModelCountL( aModelBankID, aCount );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetPronunciationCountL

//  

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetPronunciationCountL( TSILexiconID aLexiconID, 

                                                              TInt& aCount )

    {

    iController->GetPronunciationCountL( aLexiconID, aCount );

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetRuleCountL

//  

// -----------------------------------------------------------------------------

//	

void CSIControllerPluginInterface::MSrGetRuleCountL( TSIGrammarID aGrammarID, TInt& aCount )

    {

    iController->GetRuleCountL(aGrammarID, aCount);

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetRuleValidityL

// Checks to see if a rule exists in the specified grammar or not.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetRuleValidityL( TSIGrammarID aGrammarID,

                                                        TSIRuleID aRuleID,

                                                        TBool& aValid )

    {

    iController->GetRuleValidityL(aGrammarID, aRuleID, aValid);

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrGetUtteranceDurationL

// Gets the duration of an utterance.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrGetUtteranceDurationL( TSIModelBankID /*aModelBankID*/,

                                                             TSIModelID /*aModelID*/,

                                                             TTimeIntervalMicroSeconds32& /*aDuration*/ )

    {

    User::Leave(KErrNotSupported);	

    }

// -----------------------------------------------------------------------------

// CSIControllerPluginInterface::MSrLoadEngineParametersL

// Loads the specified recognizer parameter(s).  These parameters are used to

// alter the recognizer's default parameters.  The parameters are specified as

// attribute and value pairs.

// -----------------------------------------------------------------------------

//

void CSIControllerPluginInterface::MSrLoadEngineParametersL( const RArray<TInt>& aParameterId,