taskswitcher/contextengine/hgfswpreviewprovider/src/previewprovider.cpp
changeset 4 4d54b72983ae
parent 3 fb3763350a08
child 5 c743ef5928ba
equal deleted inserted replaced
3:fb3763350a08 4:4d54b72983ae
     1 /*
       
     2 * ==============================================================================
       
     3 *  Name        : %name: previewprovider.cpp %
       
     4 *  Part of     : Hg fast swap preview provider plugin
       
     5 *  Description : Preview provider API
       
     6 *  Version     : %version: sa1spcx1#3 %
       
     7 *
       
     8 *  Copyright (c) 2008 Nokia Corporation.
       
     9 *  This material, including documentation and any related
       
    10 *  computer programs, is protected by copyright controlled by
       
    11 *  Nokia Corporation. All rights are reserved. Copying,
       
    12 *  including reproducing, storing, adapting or translating, any
       
    13 *  or all of this material requires the prior written consent of
       
    14 *  Nokia Corporation. This material also contains confidential
       
    15 *  information which may not be disclosed to others without the
       
    16 *  prior written consent of Nokia Corporation.
       
    17 * ==============================================================================
       
    18 */
       
    19 
       
    20 #include "hgpreviewprovider.h"
       
    21 #include "hgpreviewobserver.h"
       
    22 #include "previewmsg.h"
       
    23 #include "previewproviderlogging.h"
       
    24 #include <w32std.h>
       
    25 #include <s32mem.h>
       
    26 #include <e32property.h>
       
    27 
       
    28 #define SZ( x ) ( sizeof( x ) / sizeof( TInt ) )
       
    29 
       
    30 // CONSTANTS
       
    31 
       
    32 // Publish & subscribe UID (akncapserver.exe SID so that it can define the keys)
       
    33 const TUid KPSUidPreviewProvider = { 0x10207218 };
       
    34 
       
    35 // P&S keys
       
    36 const TUint32 KPSKeyWgId = 0x20016BE1;
       
    37 const TUint32 KPSKeyFbsBitmapId = 0x20016BE2;
       
    38 const TUint32 KPSKeyOperation = 0x20016BE3;
       
    39 
       
    40 /**
       
    41  * Operation which will be done after P&S keys have changed.
       
    42  */
       
    43 enum TPreviewOperation
       
    44     {
       
    45     EOperationNone,
       
    46     EOperationUnregister,
       
    47     EOperationBitmapUpdated
       
    48     };
       
    49 
       
    50 /**
       
    51  * CPropertyListener
       
    52  */
       
    53 NONSHARABLE_CLASS( CPropertyListener ) : public CActive
       
    54     {
       
    55 public:
       
    56     static CPropertyListener* NewL( MHgFastSwapPreviewObserver& aObs );
       
    57     virtual ~CPropertyListener();
       
    58     
       
    59 protected:
       
    60     CPropertyListener( MHgFastSwapPreviewObserver& aObs );
       
    61     void ConstructL();  
       
    62 
       
    63 private: // From CActive
       
    64     void RunL();
       
    65     void DoCancel();
       
    66     
       
    67 private:    
       
    68     void ReadPropertiesL();
       
    69     void DefinePropertyL( TInt aPSKey ); 
       
    70     void Subscribe();
       
    71 
       
    72 private:
       
    73     MHgFastSwapPreviewObserver& iObs;
       
    74     RProperty iProperty;
       
    75    
       
    76     TInt iWgId;
       
    77     TInt iFbsBitmapId;
       
    78     
       
    79     TPreviewOperation iOperation;
       
    80     };
       
    81 
       
    82 // --------------------------------------------------------------------------
       
    83 // CPropertyListener::~CPropertyListener
       
    84 // --------------------------------------------------------------------------
       
    85 //
       
    86 CPropertyListener::~CPropertyListener()
       
    87     {
       
    88     Cancel();
       
    89     iProperty.Close();
       
    90     }
       
    91 
       
    92 // --------------------------------------------------------------------------
       
    93 // CPropertyListener::CPropertyListener
       
    94 // --------------------------------------------------------------------------
       
    95 //
       
    96 CPropertyListener::CPropertyListener( MHgFastSwapPreviewObserver& aObs ) : 
       
    97     CActive( CActive::EPriorityHigh ), iObs( aObs )
       
    98     {
       
    99     }
       
   100 
       
   101 // --------------------------------------------------------------------------
       
   102 // CPropertyListener::NewL
       
   103 // --------------------------------------------------------------------------
       
   104 //
       
   105 CPropertyListener* CPropertyListener::NewL( MHgFastSwapPreviewObserver& aObs )
       
   106     {
       
   107     CPropertyListener* self = new ( ELeave ) CPropertyListener( aObs );
       
   108     CleanupStack::PushL( self );
       
   109     self->ConstructL();
       
   110     CleanupStack::Pop( self );
       
   111     return self;    
       
   112     }
       
   113 
       
   114 // --------------------------------------------------------------------------
       
   115 // CPropertyListener::RunL
       
   116 // --------------------------------------------------------------------------
       
   117 //
       
   118 void CPropertyListener::RunL()
       
   119     {
       
   120     // Resubscribe before processing new value to prevent missing updates
       
   121     Subscribe();
       
   122     
       
   123     // Read all properties to member variables
       
   124     ReadPropertiesL();
       
   125     
       
   126     // Do the callback
       
   127     switch( iOperation )
       
   128         {
       
   129         case EOperationUnregister:
       
   130             {
       
   131             iObs.HandleFswPpApplicationUnregistered( iWgId );
       
   132             break;            
       
   133             }        
       
   134         case EOperationBitmapUpdated:
       
   135             {
       
   136             iObs.HandleFswPpApplicationChange( iWgId, iFbsBitmapId );
       
   137             break;
       
   138             }
       
   139         default:
       
   140             break;
       
   141         }
       
   142     }
       
   143 
       
   144 // --------------------------------------------------------------------------
       
   145 // CPropertyListener::DoCancel
       
   146 // --------------------------------------------------------------------------
       
   147 //
       
   148 void CPropertyListener::DoCancel()
       
   149     {
       
   150     iProperty.Cancel();
       
   151     }
       
   152 
       
   153 // --------------------------------------------------------------------------
       
   154 // CPropertyListener::ReadProperties
       
   155 // --------------------------------------------------------------------------
       
   156 //
       
   157 void CPropertyListener::ReadPropertiesL()
       
   158     {
       
   159     // Read all properties
       
   160     User::LeaveIfError( iProperty.Get( KPSUidPreviewProvider, KPSKeyWgId, iWgId ) );
       
   161     User::LeaveIfError( iProperty.Get( KPSUidPreviewProvider, KPSKeyFbsBitmapId, iFbsBitmapId ) );
       
   162     TInt operation( 0 );
       
   163     User::LeaveIfError( iProperty.Get( KPSUidPreviewProvider, KPSKeyOperation, operation ) );
       
   164     iOperation = static_cast<TPreviewOperation>( operation );    
       
   165     }
       
   166 
       
   167 // --------------------------------------------------------------------------
       
   168 // CPropertyListener::DefinePropertyL
       
   169 // --------------------------------------------------------------------------
       
   170 //
       
   171 void CPropertyListener::DefinePropertyL( TInt aPSKey )
       
   172     {
       
   173     TInt err = RProperty::Define( KPSUidPreviewProvider, aPSKey, RProperty::EInt );
       
   174     // Don't mind the already exists error
       
   175     if ( err != KErrAlreadyExists && err != KErrPermissionDenied )
       
   176         {
       
   177         User::LeaveIfError( err );
       
   178         }    
       
   179     }
       
   180 
       
   181 // --------------------------------------------------------------------------
       
   182 // CPropertyListener::Subscribe
       
   183 // --------------------------------------------------------------------------
       
   184 //
       
   185 void CPropertyListener::Subscribe()
       
   186     {
       
   187     iProperty.Subscribe( iStatus );
       
   188     SetActive();  
       
   189     }
       
   190 
       
   191 // --------------------------------------------------------------------------
       
   192 // CPropertyListener::ConstructL
       
   193 // --------------------------------------------------------------------------
       
   194 //
       
   195 void CPropertyListener::ConstructL()
       
   196     {
       
   197     HGLOG_CONTEXT( ConstructL, HGLOG_LOCAL );
       
   198     HGLOG_IN();
       
   199     
       
   200     DefinePropertyL( KPSKeyWgId );
       
   201     DefinePropertyL( KPSKeyFbsBitmapId );
       
   202     DefinePropertyL( KPSKeyOperation );
       
   203     
       
   204     User::LeaveIfError( iProperty.Attach( KPSUidPreviewProvider, KPSKeyWgId ) );
       
   205     CActiveScheduler::Add( this );
       
   206     
       
   207     // initial subscription
       
   208     Subscribe();
       
   209     
       
   210     HGLOG_OUT();    
       
   211     }
       
   212 
       
   213 /**
       
   214  * CHgFastSwapPreviewProviderClient
       
   215  */
       
   216 NONSHARABLE_CLASS( CHgFastSwapPreviewProviderClient ) : public CWsGraphic
       
   217     {
       
   218 public:
       
   219     CHgFastSwapPreviewProviderClient( MHgFastSwapPreviewObserver& aObs );
       
   220     void ConstructL();
       
   221     void Register( TInt aWgId );
       
   222     void Unregister( TInt aWgId );
       
   223     void ChangeScreen( TInt aScreenNo );
       
   224     void SetPreviewParam( const TSize& aSize, TDisplayMode aMode );
       
   225     void TakePreview();
       
   226     void AckPreview( TInt aPreviewId );
       
   227     virtual ~CHgFastSwapPreviewProviderClient();
       
   228 private:
       
   229     void HandleMessage( const TDesC8& aData );
       
   230     void OnReplace();
       
   231 private:
       
   232     void DoHandleMessageL( const TDesC8& aData );
       
   233     void SetProperties( TInt aHandle, TInt aWgId, TInt aOp );    
       
   234 private:
       
   235     MHgFastSwapPreviewObserver& iObs;
       
   236     CPropertyListener* iListener;
       
   237     };
       
   238 
       
   239 
       
   240 // --------------------------------------------------------------------------
       
   241 // CHgFastSwapPreviewProviderClient::CHgFastSwapPreviewProviderClient
       
   242 // --------------------------------------------------------------------------
       
   243 //
       
   244 CHgFastSwapPreviewProviderClient::CHgFastSwapPreviewProviderClient(
       
   245         MHgFastSwapPreviewObserver& aObs ) : iObs( aObs )
       
   246     {
       
   247     }
       
   248 
       
   249 // --------------------------------------------------------------------------
       
   250 // CHgFastSwapPreviewProviderClient::~CHgFastSwapPreviewProviderClient
       
   251 // --------------------------------------------------------------------------
       
   252 //
       
   253 CHgFastSwapPreviewProviderClient::~CHgFastSwapPreviewProviderClient()
       
   254     {
       
   255     delete iListener;
       
   256     }
       
   257 
       
   258 // --------------------------------------------------------------------------
       
   259 // CHgFastSwapPreviewProviderClient::ConstructL
       
   260 // --------------------------------------------------------------------------
       
   261 //
       
   262 void CHgFastSwapPreviewProviderClient::ConstructL()
       
   263     {
       
   264     HGLOG_CONTEXT( ConstructL, HGLOG_LOCAL );
       
   265     HGLOG_IN();
       
   266 
       
   267     const TUid id = { 0x20016BEC };
       
   268     BaseConstructL( id, KNullDesC8 );
       
   269     iListener = CPropertyListener::NewL( iObs );
       
   270     
       
   271     HGLOG_OUT();        
       
   272     }    
       
   273 
       
   274 // --------------------------------------------------------------------------
       
   275 // CHgFastSwapPreviewProviderClient::Register
       
   276 // --------------------------------------------------------------------------
       
   277 //    
       
   278 void CHgFastSwapPreviewProviderClient::Register( TInt aWgId )
       
   279     {
       
   280     HGLOG_CONTEXT( Register, HGLOG_LOCAL );
       
   281     HGLOG_IN();
       
   282     
       
   283     const TInt msg[] = {
       
   284         NPreviewMsg::ERegister,
       
   285         aWgId
       
   286         };
       
   287     TPckgC<TInt[SZ(msg)]> buf(msg);
       
   288     SendMessage(buf);
       
   289     Flush();
       
   290 
       
   291     HGLOG_OUT();
       
   292     }
       
   293 
       
   294 // --------------------------------------------------------------------------
       
   295 // CHgFastSwapPreviewProviderClient::Unregister
       
   296 // --------------------------------------------------------------------------
       
   297 //    
       
   298 void CHgFastSwapPreviewProviderClient::Unregister( TInt aWgId )
       
   299     {
       
   300     HGLOG_CONTEXT( Unregister, HGLOG_LOCAL );
       
   301     HGLOG_IN();
       
   302 
       
   303     const TInt msg[] = {
       
   304         NPreviewMsg::EUnregister,
       
   305         aWgId
       
   306         };
       
   307     TPckgC<TInt[SZ(msg)]> buf(msg);
       
   308     SendMessage(buf);
       
   309     Flush();
       
   310     
       
   311     HGLOG_OUT();
       
   312     }
       
   313 
       
   314 // --------------------------------------------------------------------------
       
   315 // CHgFastSwapPreviewProviderClient::ChangeScreen
       
   316 // --------------------------------------------------------------------------
       
   317 //    
       
   318 void CHgFastSwapPreviewProviderClient::ChangeScreen( TInt aScreenNo )
       
   319     {
       
   320     HGLOG_CONTEXT( ChangeScreen, HGLOG_LOCAL );
       
   321     HGLOG_IN();
       
   322     
       
   323     const TInt msg[] = {
       
   324         NPreviewMsg::EChangeScreen,
       
   325         aScreenNo
       
   326         };
       
   327     TPckgC<TInt[SZ(msg)]> buf(msg);
       
   328     SendMessage(buf);
       
   329     Flush();
       
   330     
       
   331     HGLOG_OUT();     
       
   332     }
       
   333 
       
   334 // --------------------------------------------------------------------------
       
   335 // CHgFastSwapPreviewProviderClient::SetPreviewParam
       
   336 // --------------------------------------------------------------------------
       
   337 //    
       
   338 void CHgFastSwapPreviewProviderClient::SetPreviewParam(const TSize& aSize,
       
   339         TDisplayMode aMode)
       
   340     {
       
   341     HGLOG_CONTEXT( SetPreviewParam, HGLOG_LOCAL );
       
   342     HGLOG_IN();
       
   343     
       
   344     const TInt msg[] = {
       
   345         NPreviewMsg::ESetPreviewParam,
       
   346         aSize.iWidth,
       
   347         aSize.iHeight,
       
   348         static_cast<TInt>(aMode)
       
   349         };
       
   350     TPckgC<TInt[SZ(msg)]> buf(msg);
       
   351     SendMessage(buf);
       
   352     Flush();
       
   353 
       
   354     HGLOG_OUT();
       
   355     }
       
   356 
       
   357 // --------------------------------------------------------------------------
       
   358 // CHgFastSwapPreviewProviderClient::TakePreview 
       
   359 // --------------------------------------------------------------------------
       
   360 //    
       
   361 void CHgFastSwapPreviewProviderClient::TakePreview()
       
   362     {
       
   363     HGLOG_CONTEXT( TakePreview, HGLOG_LOCAL );
       
   364     HGLOG_IN();
       
   365     
       
   366     TPckgC<TInt> buf(NPreviewMsg::ETakePreview);
       
   367     SendMessage(buf);
       
   368     Flush();
       
   369     
       
   370     HGLOG_OUT();      
       
   371     }
       
   372 
       
   373 // --------------------------------------------------------------------------
       
   374 // CHgFastSwapPreviewProviderClient::AckPreview 
       
   375 // --------------------------------------------------------------------------
       
   376 //
       
   377 void CHgFastSwapPreviewProviderClient::AckPreview( TInt aPreviwId )
       
   378     {
       
   379     HGLOG_CONTEXT( TakePreview, HGLOG_LOCAL );
       
   380     HGLOG_IN();
       
   381     
       
   382     const TInt msg[] = { NPreviewMsg::EAckPreviewReady,
       
   383                          aPreviwId };
       
   384     TPckgC<TInt[SZ(msg)]> buf(msg);
       
   385     SendMessage(buf);
       
   386     Flush();
       
   387     
       
   388     HGLOG_OUT();
       
   389     }
       
   390 
       
   391 // --------------------------------------------------------------------------
       
   392 // CHgFastSwapPreviewProviderClient::HandleMessage
       
   393 // --------------------------------------------------------------------------
       
   394 //    
       
   395 void CHgFastSwapPreviewProviderClient::HandleMessage( const TDesC8& aData )
       
   396     {
       
   397     TRAP_IGNORE(DoHandleMessageL(aData));
       
   398     }
       
   399 
       
   400 // --------------------------------------------------------------------------
       
   401 // CHgFastSwapPreviewProviderClient::DoHandleMessageL
       
   402 // --------------------------------------------------------------------------
       
   403 //
       
   404 void CHgFastSwapPreviewProviderClient::DoHandleMessageL( const TDesC8& aData )
       
   405     {
       
   406     HGLOG_CONTEXT( DoHandleMessageL, HGLOG_LOCAL );
       
   407     HGLOG_IN();
       
   408     
       
   409     RDesReadStream in( aData );
       
   410     TInt message = in.ReadInt32L();
       
   411     switch ( message )
       
   412         {
       
   413         case NPreviewMsg::EPreviewReady:
       
   414             {
       
   415             const TInt id = in.ReadInt32L();
       
   416             const TInt handle = in.ReadInt32L();    
       
   417             SetProperties( handle, id, EOperationBitmapUpdated );
       
   418             }
       
   419             break;
       
   420         case NPreviewMsg::EUnregisterReady:
       
   421             {
       
   422             const TInt id = in.ReadInt32L();
       
   423             const TInt handle = in.ReadInt32L();
       
   424             SetProperties( handle, id, EOperationUnregister );
       
   425             }
       
   426             break;
       
   427         }
       
   428 
       
   429     HGLOG_OUT();
       
   430     }
       
   431 
       
   432 // --------------------------------------------------------------------------
       
   433 // CHgFastSwapPreviewProviderClient::SetProperties
       
   434 // --------------------------------------------------------------------------
       
   435 //
       
   436 void CHgFastSwapPreviewProviderClient::SetProperties(TInt aHandle, TInt aWgId,
       
   437         TInt aOp)
       
   438     {
       
   439     // Notify CPropertyListener via P&S
       
   440     RProperty::Set( KPSUidPreviewProvider, KPSKeyFbsBitmapId, aHandle );
       
   441     RProperty::Set( KPSUidPreviewProvider, KPSKeyOperation, aOp );
       
   442     // KPSKeyWgId should be notified first since that is being listened 
       
   443     // by CPropertyListener 
       
   444     RProperty::Set( KPSUidPreviewProvider, KPSKeyWgId, aWgId );    
       
   445     }
       
   446 
       
   447 // --------------------------------------------------------------------------
       
   448 // CHgFastSwapPreviewProviderClient::OnReplace
       
   449 // --------------------------------------------------------------------------
       
   450 //
       
   451 void CHgFastSwapPreviewProviderClient::OnReplace()
       
   452     {
       
   453     }
       
   454     
       
   455 /////////////////////////////////////////////////////////////////////////////
       
   456 
       
   457 
       
   458 // --------------------------------------------------------------------------
       
   459 // CHgFastSwapPreviewProvider::NewL
       
   460 // --------------------------------------------------------------------------
       
   461 //
       
   462 EXPORT_C CHgFastSwapPreviewProvider* CHgFastSwapPreviewProvider::NewL(
       
   463         MHgFastSwapPreviewObserver& aObs)
       
   464     {
       
   465     CHgFastSwapPreviewProvider* p = new (ELeave) CHgFastSwapPreviewProvider();
       
   466     CleanupStack::PushL( p );
       
   467     p->ConstructL( aObs );
       
   468     CleanupStack::Pop( p );
       
   469     return p;
       
   470     }
       
   471 
       
   472 // --------------------------------------------------------------------------
       
   473 // CHgFastSwapPreviewProvider::~CHgFastSwapPreviewProvider
       
   474 // --------------------------------------------------------------------------
       
   475 //    
       
   476 EXPORT_C CHgFastSwapPreviewProvider::~CHgFastSwapPreviewProvider()
       
   477     {
       
   478     if ( iClient )
       
   479         {
       
   480         iClient->Destroy();
       
   481         }
       
   482     delete iClient;
       
   483     }
       
   484 
       
   485 // --------------------------------------------------------------------------
       
   486 // CHgFastSwapPreviewProvider::Register
       
   487 // --------------------------------------------------------------------------
       
   488 //    
       
   489 EXPORT_C TInt CHgFastSwapPreviewProvider::Register( TInt aWgId )
       
   490     {
       
   491     iClient->Register( aWgId );
       
   492     return KErrNone;
       
   493     }
       
   494 
       
   495 // --------------------------------------------------------------------------
       
   496 // CHgFastSwapPreviewProvider::Unregister
       
   497 // --------------------------------------------------------------------------
       
   498 //    
       
   499 EXPORT_C TInt CHgFastSwapPreviewProvider::Unregister( TInt aWgId )    
       
   500     {
       
   501     iClient->Unregister( aWgId );
       
   502     return KErrNone;
       
   503     }
       
   504 
       
   505 // --------------------------------------------------------------------------
       
   506 // CHgFastSwapPreviewProvider::ChangeScreen
       
   507 // --------------------------------------------------------------------------
       
   508 //    
       
   509 EXPORT_C TInt CHgFastSwapPreviewProvider::ChangeScreen( TInt aScreenId )
       
   510     {
       
   511     iClient->ChangeScreen( aScreenId );
       
   512     return KErrNone;
       
   513     }    
       
   514 
       
   515 // --------------------------------------------------------------------------
       
   516 // CHgFastSwapPreviewProvider::SetPreviewParam
       
   517 // --------------------------------------------------------------------------
       
   518 //
       
   519 EXPORT_C TInt CHgFastSwapPreviewProvider::SetPreviewParam(const TSize& aSize,
       
   520         TDisplayMode aMode)
       
   521     {
       
   522     HGLOG_CONTEXT( SetPreviewParam, HGLOG_LOCAL );
       
   523     HGLOG_IN();
       
   524     
       
   525     TInt error( KErrNone );
       
   526     
       
   527     if ( aMode == ENone || aMode == EColor64K )
       
   528         {
       
   529         iClient->SetPreviewParam( aSize, aMode );        
       
   530         }
       
   531     else
       
   532         {
       
   533         error = KErrNotSupported;
       
   534         }
       
   535    
       
   536     HGLOG_OUT();
       
   537     return error;
       
   538     }
       
   539 
       
   540 // --------------------------------------------------------------------------
       
   541 // CHgFastSwapPreviewProvider::TakePreview
       
   542 // --------------------------------------------------------------------------
       
   543 //    
       
   544 EXPORT_C TInt CHgFastSwapPreviewProvider::TakePreview()
       
   545     {
       
   546     // Reset timer for screensaver (dismiss screensaver)
       
   547     User::ResetInactivityTime(); 
       
   548            
       
   549     iClient->TakePreview();
       
   550     return KErrNone;
       
   551     }
       
   552 
       
   553 // --------------------------------------------------------------------------
       
   554 // CHgFastSwapPreviewProvider::AckPreview
       
   555 // --------------------------------------------------------------------------
       
   556 //
       
   557 EXPORT_C void CHgFastSwapPreviewProvider::AckPreview( TInt aPreviewId )
       
   558     {
       
   559     iClient->AckPreview( aPreviewId );
       
   560     }
       
   561 
       
   562 // --------------------------------------------------------------------------
       
   563 // CHgFastSwapPreviewProvider::CHgFastSwapPreviewProvider
       
   564 // --------------------------------------------------------------------------
       
   565 //    
       
   566 CHgFastSwapPreviewProvider::CHgFastSwapPreviewProvider()
       
   567     {
       
   568     }
       
   569 
       
   570 // --------------------------------------------------------------------------
       
   571 // CHgFastSwapPreviewProvider::ConstructL
       
   572 // --------------------------------------------------------------------------
       
   573 //    
       
   574 void CHgFastSwapPreviewProvider::ConstructL( MHgFastSwapPreviewObserver& aObs )
       
   575     {
       
   576     HGLOG_CONTEXT( ConstructL, HGLOG_LOCAL );
       
   577     HGLOG_IN();
       
   578     
       
   579     iClient = new ( ELeave ) CHgFastSwapPreviewProviderClient( aObs );
       
   580     iClient->ConstructL();
       
   581     
       
   582     HGLOG_OUT();
       
   583     }
       
   584 
       
   585 // End of file
       
   586