FCL/sf/mw/homescreensrv: comparison idlefw/plugins/profileplugin/src/caiprofileplugin.cpp

equal deleted inserted replaced

-:1a2a00e78665
+:d0529222e3f0
 *
 * Description:  Profile plug-in publisher
 *
 */
+// System includes
 #include <ecom/ecom.h>
 #include <ecom/implementationproxy.h>
+#include <PUAcodes.hrh>
+#include <AknUtils.h>
+// User includes
+#include <aiprofilepluginuids.hrh>
 #include <aicontentobserver.h>
 #include <aiutility.h>
-#include <PUAcodes.hrh>
-#include <AknUtils.h>
 #include "aiprofileplugincontentmodel.h"
-#include <aiprofilepluginuids.hrh>
 #include "caiprofileplugin.h"
 #include "caiprofileengine.h"
 #include "aipluginsettings.h"
+// Constants
 // PUA code for the timed profile, missing from PUAcodes.hrh
 #define KAiTimedProfilePUA 0xF815
 #define KAiRTL 0x200F
-// CONST CLASS VARIABLES
 const TImplementationProxy KImplementationTable[] =
 {
 IMPLEMENTATION_PROXY_ENTRY( KImplUidProfilePlugin, CAiProfilePlugin::NewL )
 };
 // ======== LOCAL FUNCTIONS ========
 // ======== MEMBER FUNCTIONS ========
+// ---------------------------------------------------------------------------
-// ---------------------------------------------------------------------------
+// CAiProfilePlugin::NewL
-// Symbian 2nd phase constructor can leave
+//
 // ---------------------------------------------------------------------------
 //
 CAiProfilePlugin* CAiProfilePlugin::NewL()
 {
-CAiProfilePlugin* self = new (ELeave) CAiProfilePlugin;
+CAiProfilePlugin* self = new ( ELeave ) CAiProfilePlugin;
 CleanupStack::PushL( self );
 self->ConstructL();
 CleanupStack::Pop( self );
 return self;
 }
 // ---------------------------------------------------------------------------
-// Default constructor
+// CAiProfilePlugin::CAiProfilePlugin()
+//
 // ---------------------------------------------------------------------------
 //
 CAiProfilePlugin::CAiProfilePlugin()
 {
 }
 // ---------------------------------------------------------------------------
-// Symbian 2nd phase constructor can leave
+// CAiProfilePlugin::ConstructL
+//
 // ---------------------------------------------------------------------------
 //
 void CAiProfilePlugin::ConstructL()
 {
-iInfo.iUid.iUid = AI_UID_ECOM_IMPLEMENTATION_CONTENTPUBLISHER_PROFILEPLUGIN;
 iContent = AiUtility::CreateContentItemArrayIteratorL( KAiProfileContent );
 iEvents = AiUtility::CreateContentItemArrayIteratorL( KAiProfileEvents );
 iResources = AiUtility::CreateContentItemArrayIteratorL( KAiProfileResources );
+}
-iIsUpdated = ETrue;
-iAlive = EFalse;
+// ---------------------------------------------------------------------------
-}
+// CAiProfilePlugin::~CAiProfilePlugin
-// ---------------------------------------------------------------------------
-// Destructor
 // Deletes all data created to heap
 // ---------------------------------------------------------------------------
 //
 CAiProfilePlugin::~CAiProfilePlugin()
 {
 CleanPublishedProfileNames();
 Release( iContent );
 Release( iEvents );
 Release( iResources );
 delete iActiveProfileAndChar;
 delete iPreviousProfileNameAndChar;
 delete iEngine;
 iObservers.Close();
 }
 // ---------------------------------------------------------------------------
+// CAiProfilePlugin::PublishL
 // Publishes the profiles
 // ---------------------------------------------------------------------------
 //
 void CAiProfilePlugin::PublishL()
 {
 TInt err( KErrNone );
 TInt observers( iObservers.Count() );
-TInt transactionId = reinterpret_cast<TInt>( this );
+TInt transactionId ( reinterpret_cast<TInt>( this ) );
 iCurrentCount = iEngine->NumberOfProfiles();
-for ( int i = 0; i < observers; i++ )
-{
+for ( TInt i = 0; i < observers; i++ )
-MAiContentObserver* observer = iObservers[i];
+{
+MAiContentObserver* observer( iObservers[i] );
 err = observer->StartTransaction( transactionId );
 		if ( err == KErrNotSupported )
 {
 // The observer does not support transactions, check for real errors.
 if ( observer->CanPublish( *this, EAiProfileActiveProfileNameAndIconChar, 0 ) )
 {
 delete iActiveProfileAndChar;
 iActiveProfileAndChar = NULL;
 // silent/non-silent icon + timed icon + space + possible RTL*2 = 5
-TInt maxChars = iEngine->ActiveProfileName().Length() + 5;
+TInt maxChars( iEngine->ActiveProfileName().Length() + 5 );
 iActiveProfileAndChar = HBufC::NewL( maxChars );
-TPtr profileNamePtr = iActiveProfileAndChar->Des();
+TPtr profileNamePtr( iActiveProfileAndChar->Des() );
 if( AknLayoutUtils::LayoutMirrored() )
 {
 profileNamePtr.Append( KAiRTL );
 }
 if ( iEngine->IsActiveProfileTimedL() )
 {
 profileNamePtr.Append( KAiTimedProfilePUA );
 }
-if( iEngine->IsActiveProfileSilentL() )
+if ( iEngine->IsActiveProfileSilentL() )
 {
 profileNamePtr.Append( KPuaCodeSilentSymbol );
 }
 else
 {
 profileNamePtr.Append( KPuaCodeAprofSound );
 }
-_LIT( KSpace, " " );
+_LIT( KSpace, " " );
 profileNamePtr.Append( KSpace );
-if( AknLayoutUtils::LayoutMirrored() )
+if ( AknLayoutUtils::LayoutMirrored() )
 {
 profileNamePtr.Append( KAiRTL );
 }
 profileNamePtr.Append( iEngine->ActiveProfileName() );
 		//All profile names
 	// clean profiles that are already deleted.
 	// Cleans the array blindly from the end, because in the next
 	// step all the profiles are republished
-if( iPreviousCount > iCurrentCount )
+if ( iPreviousCount > iCurrentCount )
 {
 for( TInt k = iCurrentCount; k < iPreviousCount; k++ )
 {
 observer->Clean( *this, EAiProfileContentProfileName, k + 1 );
 }
 }
 		for ( TInt j = 0; j < iCurrentCount; j++ )
 			{
 			if ( observer->CanPublish( *this, EAiProfileContentProfileName, j + 1 ) )
 				{
 				observer->Publish(*this, EAiProfileContentProfileName, iEngine->ProfileNameByIndex( j ), j + 1 );
 	{
 	if ( iEngine->IsActiveProfileSilentL() )
 		{
 		TBuf<1> silent; // one character
 		silent.Append( KPuaCodeSilentSymbol );
 		observer->Publish( *this, EAiProfileActiveProfileSilentChar, silent, EAiProfileActiveProfileSilentChar );
 		}
 	else
 		{
 		observer->Clean( *this, EAiProfileActiveProfileSilentChar, EAiProfileActiveProfileSilentChar );
 if ( observer->CanPublish( *this, EAiProfileActiveProfileIcon, EAiProfileActiveProfileIcon ) )
 	{
 		observer->Clean( *this, EAiProfileActiveProfileIcon, EAiProfileActiveProfileSilentIconResource );
 		observer->Clean( *this, EAiProfileActiveProfileIcon, EAiProfileActiveProfileGeneralIconResource );
 		observer->Clean( *this, EAiProfileActiveProfileIcon, EAiProfileActiveProfileTimedIconResource );
-	if ( iEngine->IsActiveProfileTimedL() )
+		if ( iEngine->IsActiveProfileTimedL() )
 		{
 		observer->Publish( *this,
 							EAiProfileActiveProfileIcon,
 							EAiProfileActiveProfileTimedIconResource,
 							EAiProfileActiveProfileTimedIconResource );
 		iEngine->IsOffline() )
 	{
 		observer->Clean( *this, EAiProfileActiveProfileSilentChar, EAiProfileActiveProfileSilentChar );
 		observer->Clean( *this, EAiProfileActiveProfileIcon, 1 );
 		observer->Clean( *this, EAiProfileActiveProfileIcon, 2 );
-// uncomment also this and respective policy lines in profiles.xml if whole widget needs to be hidden in AI3
+		// uncomment also this and respective policy lines in profiles.xml if whole widget needs to be hidden in AI3
 		//observer->Clean( *this, EAiProfileContentActiveProfileName, EAiProfileContentActiveProfileName );
 		}
 if ( err == KErrNone )
 {
 err = observer->Commit( transactionId );
 if ( err == KErrNotSupported)
 {
 return;
 }
 }
+}
-iIsUpdated = EFalse;
-}
 iPreviousCount = iCurrentCount;
 }
 // ---------------------------------------------------------------------------
-// From class CAiContentPublisher
+// CAiProfilePlugin::Start
-// Plug-in is requested to unload its engines due backup operation
+//
 // ---------------------------------------------------------------------------
 //
-void CAiProfilePlugin::Stop( TAiTransitionReason /*aReason*/ )
+void CAiProfilePlugin::Start( TStartReason /*aReason*/ )
 {
-FreeEngine();
+}
-}
+// ---------------------------------------------------------------------------
-// ---------------------------------------------------------------------------
+// CAiProfilePlugin::Stop
-// From class CAiContentPublisher
+//
-// Plug-in is instructed that it is allowed to consume CPU resources
+// ---------------------------------------------------------------------------
-// ---------------------------------------------------------------------------
+//
-//
+void CAiProfilePlugin::Stop( TStopReason /*aReason*/ )
-void CAiProfilePlugin::Resume( TAiTransitionReason aReason )
+{
-{
+}
-TRAP_IGNORE( DoResumeL( aReason ) );
-}
+// ---------------------------------------------------------------------------
+// CAiProfilePlugin::Resume
-// ---------------------------------------------------------------------------
+//
-// From class CAiContentPublisher
+// ---------------------------------------------------------------------------
-// Plug-in is instructed that it is not allowed to consume CPU resources
+//
-// ---------------------------------------------------------------------------
+void CAiProfilePlugin::Resume( TResumeReason aReason )
-//
+{
-void CAiProfilePlugin::Suspend( TAiTransitionReason /*aReason*/ )
+if ( aReason == EForeground )
 {
-if ( iEngine && iAlive )
+TRAP_IGNORE( DoResumeL() );
-{
+}
-iEngine->Suspend();
+}
-}
+// ---------------------------------------------------------------------------
-iAlive = EFalse;
+// CAiProfilePlugin::Suspend
-}
+//
+// ---------------------------------------------------------------------------
-// ---------------------------------------------------------------------------
+//
-// From class CAiContentPublisher
+void CAiProfilePlugin::Suspend( TSuspendReason /*aReason*/ )
-// The plug-in MUST maintain a registry of subscribers and send
+{
-// notification to all of them whenever the state changes or new content
+}
-// is available
+// ---------------------------------------------------------------------------
+// CAiProfilePlugin::SubscribeL
+//
 // ---------------------------------------------------------------------------
 //
 void CAiProfilePlugin::SubscribeL( MAiContentObserver& aObserver )
 {
 iObservers.AppendL( &aObserver );
 }
 // ---------------------------------------------------------------------------
-// From class CAiContentPublisher
+// CAiProfilePlugin::ConfigureL
-// Plug-ins take ownership of the settings array, so it must either
+//
-// store it in a member or free it.
+// ---------------------------------------------------------------------------
-// ---------------------------------------------------------------------------
+//
-//
+void CAiProfilePlugin::ConfigureL( RAiSettingsItemArray& /*aSettings*/ )
-void CAiProfilePlugin::ConfigureL( RAiSettingsItemArray& aSettings )
-{
-aSettings.ResetAndDestroy();
-}
-// ---------------------------------------------------------------------------
-// From class CAiContentPublisher
-// Returns the extension interface. Actual type depends on the passed
-// aUid argument.
-// ---------------------------------------------------------------------------
-//
-TAny* CAiProfilePlugin::Extension( TUid aUid )
 {
-if (aUid == KExtensionUidProperty)
+}
-		{
-return static_cast<MAiPropertyExtension*>(this);
+// ---------------------------------------------------------------------------
-	}
+// CAiProfilePlugin::GetProperty
-else if (aUid == KExtensionUidEventHandler)
+//
-	{
+// ---------------------------------------------------------------------------
-return static_cast<MAiEventHandlerExtension*>(this);
+//
-	}
+TAny* CAiProfilePlugin::GetProperty( TProperty aProperty )
-else
+{
-	{
+if ( aProperty == EPublisherContent )
-return NULL;
+{
-	}
+return static_cast< MAiContentItemIterator* >( iContent );
 }
+else if ( aProperty == EPublisherEvents )
-// ---------------------------------------------------------------------------
+{
-// From class MAiPropertyExtension
+return static_cast< MAiContentItemIterator* >( iEvents );
-// Read property of publisher plug-in.
+}
-// ---------------------------------------------------------------------------
+else if ( aProperty == EPublisherResources )
-//
+{
-TAny* CAiProfilePlugin::GetPropertyL( TInt aProperty )
+return static_cast< MAiContentItemIterator* >( iResources );
-{
+}
-TAny* property = NULL;
+return NULL;
-switch ( aProperty )
+}
-{
-case EAiPublisherInfo:
+// ---------------------------------------------------------------------------
-{
+// CAiProfilePlugin::HandleEvent
-property = static_cast<TAiPublisherInfo*>( &iInfo );
+//
-break;
+// ---------------------------------------------------------------------------
-}
+//
+void CAiProfilePlugin::HandleEvent( TInt aEvent, const TDesC& aParam )
-case EAiPublisherContent:
+{
-{
+TRAP_IGNORE( iEngine->HandleAiEventL( aEvent, aParam ) );
-property = static_cast<MAiContentItemIterator*>( iContent );
+}
-break;
-}
+// ---------------------------------------------------------------------------
+// CAiProfilePlugin::DoResumeL
-case EAiPublisherEvents:
+//
-{
+// ---------------------------------------------------------------------------
-property = static_cast<MAiContentItemIterator*>( iEvents );
+//
-break;
+void CAiProfilePlugin::DoResumeL()
-}
+{
+if( !iEngine )
-case EAiPublisherResources:
+{
-property = static_cast<MAiContentItemIterator*>( iResources );
+iEngine = CAiProfileEngine::NewL( this );
-break;
+iEngine->UpdateProfileNamesL();
-default:
-break;
+PublishL();
-}
-return property;
-}
-// ---------------------------------------------------------------------------
-// From class MAiPropertyExtension
-// Write property value to optimize the content model.
-// ---------------------------------------------------------------------------
-//
-void CAiProfilePlugin::SetPropertyL( TInt aProperty, TAny* aValue )
-{
-if( aProperty == EAiPublisherInfo )
-{
-ASSERT( aValue );
-const TAiPublisherInfo* info(
-static_cast<const TAiPublisherInfo*>( aValue ) );
-iInfo = *info;
 }
 }
 // ---------------------------------------------------------------------------
-// From class MAiEventHandlerExtension.
+// CAiProfilePlugin::NotifyContentUpdate()
-// Handles an event sent by the AI framework.
+// This method is called from the engine, when the profile data has changed
 // ---------------------------------------------------------------------------
-//
-void CAiProfilePlugin::HandleEvent(TInt aEvent, const TDesC& aParam)
-	{
-if ( iEngine )
-	{
-// We have no way of reporting errors to framework so just ignore them.
-TRAP_IGNORE( iEngine->HandleAiEventL( aEvent, aParam ) );
-	}
-	}
-// ---------------------------------------------------------
-// This method is called from the engine, when the profile
-// data content has been changed. Method call is made through
-// the MAiProfilePluginNotifier interface.
-// ---------------------------------------------------------
 //
 void CAiProfilePlugin::NotifyContentUpdate()
 {
-iIsUpdated = ETrue;
 TRAP_IGNORE( PublishL() );
 }
 // ---------------------------------------------------------------------------
-// From class CAiContentPublisher
+// CAiProfilePlugin::CleanPublishedProfileNames
-// framework instructs plug-in that it is allowed to consume CPU resources
-// ---------------------------------------------------------------------------
-//
-void CAiProfilePlugin::DoResumeL( TAiTransitionReason aReason )
-{
-if ( !iEngine )
-{
-iEngine = CAiProfileEngine::NewL( this );
-}
-	//update in startup phase and idle is on foreground.
-if( aReason != EAiBacklightOff && aReason != EAiIdleBackground )
-	{
-	// force republish in case layout has changed
-if ( aReason == EAiScreenLayoutChanged )
-{
-delete iPreviousProfileNameAndChar;
-iPreviousProfileNameAndChar = NULL;
-}
-	if ( !iAlive )
-	    {
-iEngine->ResumeL();
-	    }
-	    iEngine->UpdateProfileNamesL();
-PublishL();
-	    iAlive = ETrue;
-	}
-}
-// ---------------------------------------------------------------------------
-// Frees engine resources
-// ---------------------------------------------------------------------------
-//
-void CAiProfilePlugin::FreeEngine()
-{
-delete iEngine;
-iEngine = NULL;
-iAlive = EFalse;
-}
-// ---------------------------------------------------------------------------
 // Clean profile names from content
 // ---------------------------------------------------------------------------
 //
 void CAiProfilePlugin::CleanPublishedProfileNames()
 {
 TInt obsCount( iObservers.Count() );
 for ( TInt i( 0 ); i < obsCount; i++ )
 {
-MAiContentObserver* observer = iObservers[i];
+MAiContentObserver* observer( iObservers[i] );
-for( TInt j( 0 ); j < iCurrentCount && observer; j++ )
+for ( TInt j( 0 ); j < iCurrentCount && observer; j++ )
 {
 observer->Clean( *this, EAiProfileContentProfileName, j + 1 );
 }
 }
 }
 EXPORT_C const TImplementationProxy* ImplementationGroupProxy(
 TInt& aTableCount )
 {
 aTableCount = sizeof( KImplementationTable ) /
 sizeof( TImplementationProxy );
 return KImplementationTable;
 }

branch	RCL_3
changeset 9	d0529222e3f0
parent 0	79c6a41cd166
child 18	bd874ee5e5e2