idlehomescreen/xmluirendering/uiengine/src/xnrootdata.cpp
changeset 0 f72a12da539e
child 9 f966699dea19
equal deleted inserted replaced
-1:000000000000 0:f72a12da539e
       
     1 /*
       
     2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Data class to hold application root configuration info
       
    15 *
       
    16 */
       
    17 
       
    18 // User includes
       
    19 #include "xnviewmanager.h"
       
    20 #include "xnviewdata.h"
       
    21 
       
    22 #include "xnappuiadapter.h"
       
    23 #include "xncontroladapter.h"
       
    24 #include "xnuiengine.h"
       
    25 #include "xnecomhandler.h"
       
    26 #include "xncomposer.h"
       
    27 #include "xnodtparser.h"
       
    28 
       
    29 #include "xndomdocument.h"
       
    30 #include "xndomnode.h"
       
    31 #include "xnodt.h"
       
    32 
       
    33 #include "xnnode.h"
       
    34 #include "xntype.h"
       
    35 
       
    36 #include "xnpanic.h"
       
    37 
       
    38 #include "xnplugindata.h"
       
    39 #include "xnrootdata.h"
       
    40 
       
    41 // Constants
       
    42 const TInt KScheduleInterval( 1000000 );
       
    43 
       
    44 // ============================ LOCAL FUNCTIONS ================================
       
    45 
       
    46 // ============================ MEMBER FUNCTIONS ===============================
       
    47 // -----------------------------------------------------------------------------
       
    48 // CXnRootData::NewL()
       
    49 // Two-phased constructor.
       
    50 // -----------------------------------------------------------------------------
       
    51 //
       
    52 CXnRootData* CXnRootData::NewL( CXnViewManager& aManager, 
       
    53     TUid aApplicationUid )
       
    54     {
       
    55     CXnRootData* self = CXnRootData::NewLC( aManager, aApplicationUid );
       
    56     CleanupStack::Pop( self );
       
    57     return self;
       
    58     }
       
    59 
       
    60 // -----------------------------------------------------------------------------
       
    61 // CXnRootData::NewLC()
       
    62 // Two-phased constructor.
       
    63 // -----------------------------------------------------------------------------
       
    64 //
       
    65 CXnRootData* CXnRootData::NewLC( CXnViewManager& aManager, 
       
    66     TUid aApplicationUid )
       
    67     {
       
    68     CXnRootData* self = new ( ELeave ) CXnRootData( aManager, aApplicationUid );
       
    69     CleanupStack::PushL( self );
       
    70     self->ConstructL();
       
    71     return self;
       
    72     }
       
    73 
       
    74 // -----------------------------------------------------------------------------
       
    75 // CXnRootData::CXnRootData()
       
    76 // C++ default constructor
       
    77 // -----------------------------------------------------------------------------
       
    78 //
       
    79 CXnRootData::CXnRootData( CXnViewManager& aManager, TUid aApplicationUid )     
       
    80     : CXnPluginData( aManager ), iApplicationUid( aApplicationUid )          
       
    81     {
       
    82     iFlags.Clear( EIsRemovable );
       
    83     }
       
    84 
       
    85 // -----------------------------------------------------------------------------
       
    86 // CXnRootData::~CXnRootData()
       
    87 // C++ default destructor.
       
    88 // -----------------------------------------------------------------------------
       
    89 //
       
    90 CXnRootData::~CXnRootData()
       
    91     {
       
    92     if ( iLoadTimer )
       
    93         {
       
    94         iLoadTimer->Cancel();
       
    95         }
       
    96     
       
    97     delete iLoadTimer;
       
    98     
       
    99     if ( iDestroyTimer )
       
   100         {
       
   101         iDestroyTimer->Cancel();
       
   102         }
       
   103     
       
   104     delete iDestroyTimer;
       
   105     
       
   106     iViewsToDestroy.ResetAndDestroy();
       
   107     
       
   108     iPluginsData.ResetAndDestroy();
       
   109     
       
   110     delete iODT->DomDocument().RootNode()->LayoutNode();
       
   111     
       
   112     delete iODT;
       
   113 
       
   114     delete iParser;
       
   115     delete iEcomHandler;
       
   116                   
       
   117     User::Heap().Compress();
       
   118     }
       
   119 
       
   120 // -----------------------------------------------------------------------------
       
   121 // CXnRootData::ConstructL()
       
   122 // 2nd phase constructor
       
   123 // -----------------------------------------------------------------------------
       
   124 //
       
   125 void CXnRootData::ConstructL()
       
   126     {   
       
   127     CXnPluginData::ConstructL();
       
   128     
       
   129     iEcomHandler = CXnEcomHandler::NewL();
       
   130     
       
   131     iParser = CXnODTParser::NewL( iManager, *iEcomHandler );   
       
   132     
       
   133     iLoadTimer = CPeriodic::NewL( CActive::EPriorityStandard );           
       
   134     iDestroyTimer = CPeriodic::NewL( CActive::EPriorityStandard );
       
   135     }
       
   136 
       
   137 // -----------------------------------------------------------------------------
       
   138 // CXnRootData::LoadL()
       
   139 // 
       
   140 // -----------------------------------------------------------------------------
       
   141 //
       
   142 void CXnRootData::LoadL()
       
   143     { 
       
   144     if ( Occupied() )
       
   145         {
       
   146         return;
       
   147         }
       
   148            
       
   149     // Load application root configuration
       
   150     TRAPD( error,
       
   151             
       
   152         iODT = iManager.Composer().ComposeRootL( *this );
       
   153     
       
   154         if ( iODT )
       
   155             {
       
   156             iManager.Parser().LoadRootL( *this, iApplicationUid );
       
   157             }              
       
   158         );
       
   159     
       
   160     if ( !iODT || error || !Occupied() )
       
   161         {
       
   162         // Can't recover
       
   163         Panic( EXnInvalidConfiguration );               
       
   164         }
       
   165     
       
   166     RPointerArray< CXnViewData > failedPlugins;
       
   167     CleanupClosePushL( failedPlugins );
       
   168     
       
   169     TBool succeed( EFalse );
       
   170            
       
   171     for ( TInt i = 0; i < iPluginsData.Count(); i++ )
       
   172         {
       
   173         CXnViewData* plugin( 
       
   174                 static_cast< CXnViewData* >( iPluginsData[ i ] ) ); 
       
   175         
       
   176         if ( plugin->Initial() )
       
   177             {
       
   178             plugin->LoadL();
       
   179     
       
   180             if ( plugin->Occupied() )
       
   181                 {
       
   182                 succeed = ETrue;                
       
   183                 }
       
   184             else
       
   185                 {
       
   186                 // Failed to load
       
   187                 failedPlugins.AppendL( plugin );                
       
   188                 }
       
   189 
       
   190             break;
       
   191             }
       
   192         } 
       
   193                             
       
   194     for ( TInt i = 0; !succeed && i < iPluginsData.Count(); i++ )
       
   195         {
       
   196         CXnViewData* plugin( 
       
   197                 static_cast< CXnViewData* >( iPluginsData[ i ] ) );
       
   198         
       
   199         if ( failedPlugins.Find( plugin ) == KErrNotFound )
       
   200             {
       
   201             plugin->SetInitial();
       
   202             
       
   203             plugin->LoadL();
       
   204 
       
   205             if ( plugin->Occupied() )
       
   206                 {                                       
       
   207                 succeed = ETrue;                
       
   208                 }
       
   209             else
       
   210                 {
       
   211                 // Failed to load
       
   212                 failedPlugins.AppendL( plugin );                                                    
       
   213                 }
       
   214             }
       
   215         }    
       
   216     
       
   217     if ( !succeed )
       
   218         {
       
   219         // Can't recover
       
   220         Panic( EXnInvalidConfiguration );                       
       
   221         }
       
   222     
       
   223     for ( TInt i = failedPlugins.Count() - 1; i >= 0; i-- )
       
   224         {        
       
   225         CXnPluginData* toDestroy( failedPlugins[i] );
       
   226         
       
   227         TInt index( iPluginsData.Find( toDestroy ) );
       
   228         
       
   229         iPluginsData.Remove( index );
       
   230         
       
   231         delete toDestroy;
       
   232         toDestroy = NULL;                     
       
   233         }
       
   234     
       
   235     CleanupStack::PopAndDestroy( &failedPlugins );
       
   236     }
       
   237 
       
   238 // -----------------------------------------------------------------------------
       
   239 // CXnRootData::Destroy()
       
   240 // 
       
   241 // -----------------------------------------------------------------------------
       
   242 //
       
   243 void CXnRootData::Destroy()
       
   244     {
       
   245     iLoadTimer->Cancel();
       
   246     iDestroyTimer->Cancel();
       
   247     
       
   248     iFlags.Set( EIsDispose );
       
   249     
       
   250     iDestroyTimer->Start( TTimeIntervalMicroSeconds32( 0 ),
       
   251                           TTimeIntervalMicroSeconds32( 0 ),
       
   252                           TCallBack( RunDestroyL, this ) );           
       
   253     }
       
   254 
       
   255 // -----------------------------------------------------------------------------
       
   256 // CXnRootData::LoadRemainingViews()
       
   257 // 
       
   258 // -----------------------------------------------------------------------------
       
   259 //
       
   260 void CXnRootData::LoadRemainingViews()
       
   261     {
       
   262     if ( iFlags.IsClear( EIsDispose ) && !AllViewsLoaded() )
       
   263         {
       
   264         iLoadForward = ETrue;
       
   265         
       
   266         iLoadTimer->Cancel();
       
   267         
       
   268         iLoadTimer->Start( TTimeIntervalMicroSeconds32( KScheduleInterval ),
       
   269                            TTimeIntervalMicroSeconds32( KScheduleInterval ),
       
   270                            TCallBack( RunLoadL, this ) );       
       
   271         }
       
   272     }
       
   273 
       
   274 // -----------------------------------------------------------------------------
       
   275 // CXnRootData::CancelLoadRemainingViews()
       
   276 // 
       
   277 // -----------------------------------------------------------------------------
       
   278 //
       
   279 void CXnRootData::CancelLoadRemainingViews()
       
   280     {    
       
   281     if ( iFlags.IsClear( EIsDispose ) && !AllViewsLoaded() )
       
   282         {
       
   283         iLoadTimer->Cancel();
       
   284         }
       
   285     }
       
   286 
       
   287 // -----------------------------------------------------------------------------
       
   288 // CXnRootData::ODT()
       
   289 // 
       
   290 // -----------------------------------------------------------------------------
       
   291 //
       
   292 CXnODT* CXnRootData::ODT() const
       
   293     {
       
   294     return iODT;
       
   295     }
       
   296 
       
   297 // -----------------------------------------------------------------------------
       
   298 // CXnRootData::RootNode()
       
   299 // 
       
   300 // -----------------------------------------------------------------------------
       
   301 //
       
   302 CXnNode* CXnRootData::RootNode() const
       
   303     {
       
   304     return iODT->DomDocument().RootNode()->LayoutNode();
       
   305     }
       
   306 
       
   307 // -----------------------------------------------------------------------------
       
   308 // CXnRootData::Parser()
       
   309 // 
       
   310 // -----------------------------------------------------------------------------
       
   311 //
       
   312 CXnODTParser& CXnRootData::Parser() const
       
   313     {
       
   314     return *iParser;
       
   315     }
       
   316 
       
   317 // -----------------------------------------------------------------------------
       
   318 // CXnRootData::EcomHandler()
       
   319 // 
       
   320 // -----------------------------------------------------------------------------
       
   321 //
       
   322 CXnEcomHandler& CXnRootData::EcomHandler() const
       
   323     {
       
   324     return *iEcomHandler;
       
   325     }
       
   326 
       
   327 // -----------------------------------------------------------------------------
       
   328 // CXnRootData::ActiveViewData()
       
   329 // Finds the active view data
       
   330 // -----------------------------------------------------------------------------
       
   331 //
       
   332 CXnViewData& CXnRootData::ActiveViewData() const
       
   333     {    
       
   334     for ( TInt i = 0; i < iPluginsData.Count(); i++ )
       
   335         {
       
   336         CXnViewData& plugin( static_cast< CXnViewData& >( *iPluginsData[i] ) );
       
   337         
       
   338         if ( plugin.Active() )
       
   339             {
       
   340             return plugin;
       
   341             }
       
   342         }
       
   343     
       
   344     // If active is not set, then try initial
       
   345     for ( TInt i = 0; i < iPluginsData.Count(); i++ )
       
   346         {
       
   347         CXnViewData& plugin( static_cast< CXnViewData& >( *iPluginsData[i] ) );
       
   348         
       
   349         if ( plugin.Initial() )
       
   350             {
       
   351             return plugin;
       
   352             }
       
   353         }
       
   354    
       
   355     Panic( EXnInvalidConfiguration );
       
   356 
       
   357     // Remove compiler warning
       
   358     return static_cast< CXnViewData& > ( *iPluginsData[0] );
       
   359     }
       
   360 
       
   361 // -----------------------------------------------------------------------------
       
   362 // CXnRootData::PreviousViewData()
       
   363 // Finds the active view data
       
   364 // -----------------------------------------------------------------------------
       
   365 //
       
   366 CXnViewData& CXnRootData::PreviousViewData() const
       
   367     {      
       
   368     CXnViewData& active( ActiveViewData() );
       
   369     
       
   370     TInt count( iPluginsData.Count() );
       
   371 
       
   372     if ( count == 1 )
       
   373         {
       
   374         // Only one view available
       
   375         return active;               
       
   376         }
       
   377 
       
   378     TInt index( iPluginsData.Find( &active ) );
       
   379     
       
   380     if ( index == 0 )
       
   381         {
       
   382         // Return the last
       
   383         return static_cast< CXnViewData& >( *iPluginsData[ count - 1 ] );        
       
   384         }
       
   385     else
       
   386         {
       
   387         // Return the previous
       
   388         return static_cast< CXnViewData& >( *iPluginsData[ index - 1 ] );        
       
   389         }
       
   390     }
       
   391 
       
   392 // -----------------------------------------------------------------------------
       
   393 // CXnRootData::NextViewData()
       
   394 // Finds the active view data
       
   395 // -----------------------------------------------------------------------------
       
   396 //
       
   397 CXnViewData& CXnRootData::NextViewData() const
       
   398     {       
       
   399     CXnViewData& active( ActiveViewData() );
       
   400     
       
   401     TInt count( iPluginsData.Count() );
       
   402 
       
   403     if ( count == 1 )
       
   404         {
       
   405         // Only one view available
       
   406         return active;
       
   407         }
       
   408 
       
   409     TInt index( iPluginsData.Find( &active ) );
       
   410 
       
   411     if ( index + 1 < count )
       
   412         {
       
   413         // Return the next
       
   414         return static_cast< CXnViewData& >( *iPluginsData[ index + 1 ] );        
       
   415         }
       
   416     else
       
   417         {
       
   418         // Return the first
       
   419         return static_cast< CXnViewData& >( *iPluginsData[ 0 ] );        
       
   420         }
       
   421     }
       
   422 
       
   423 // -----------------------------------------------------------------------------
       
   424 // CXnRootData::DestroyViewData()
       
   425 // Sets view data to be destroyed
       
   426 // -----------------------------------------------------------------------------
       
   427 //
       
   428 void CXnRootData::DestroyViewData( CXnViewData* aViewData )
       
   429     {
       
   430     TInt index( iPluginsData.Find( aViewData ) );
       
   431     
       
   432     if ( index != KErrNotFound )
       
   433         {
       
   434         iPluginsData.Remove( index );
       
   435                 
       
   436         if ( iViewsToDestroy.Find( aViewData ) == KErrNotFound )
       
   437             {
       
   438             iViewsToDestroy.Append( aViewData );
       
   439             
       
   440             iDestroyTimer->Cancel();
       
   441             
       
   442             iDestroyTimer->Start( TTimeIntervalMicroSeconds32( 0 ),
       
   443                                   TTimeIntervalMicroSeconds32( 0 ),
       
   444                                   TCallBack( RunDestroyL, this ) );                       
       
   445             }        
       
   446         }       
       
   447     }
       
   448 
       
   449 // -----------------------------------------------------------------------------
       
   450 // CXnRootData::AllViewsLoaded()
       
   451 // 
       
   452 // -----------------------------------------------------------------------------
       
   453 //
       
   454 TBool CXnRootData::AllViewsLoaded() const
       
   455     {
       
   456     for ( TInt i = 0; i < iPluginsData.Count(); i++ )
       
   457         {
       
   458         if ( !iPluginsData[i]->Occupied() )
       
   459             {
       
   460             return EFalse;
       
   461             }
       
   462         }
       
   463     
       
   464     return ETrue;
       
   465     }
       
   466 
       
   467 // -----------------------------------------------------------------------------
       
   468 // CXnRootData::AllViewsDestroyed()
       
   469 // 
       
   470 // -----------------------------------------------------------------------------
       
   471 //
       
   472 TBool CXnRootData::AllViewsDestroyed() const
       
   473     {
       
   474     return ( iPluginsData.Count() == 0 ) && iFlags.IsSet( EIsDispose ); 
       
   475     }
       
   476 
       
   477 // -----------------------------------------------------------------------------
       
   478 // CXnRootData::RunLoadL()
       
   479 // 
       
   480 // -----------------------------------------------------------------------------
       
   481 //
       
   482 /* static */ TInt CXnRootData::RunLoadL( TAny* aAny )
       
   483     {
       
   484     CXnRootData* self = static_cast< CXnRootData* >( aAny );
       
   485     
       
   486     if ( self->iFlags.IsSet( EIsDispose ) )
       
   487         {
       
   488         self->iLoadTimer->Cancel();
       
   489         }
       
   490     else
       
   491         {               
       
   492         CXnPluginData& active( self->ActiveViewData() );
       
   493         
       
   494         CXnPluginData* toLoad( NULL );
       
   495                        
       
   496         TInt index( self->iPluginsData.Find( &active ) );
       
   497         TInt count( self->iPluginsData.Count() );
       
   498                 
       
   499         if ( self->iLoadForward )
       
   500             {
       
   501             self->iLoadForward = EFalse;
       
   502             
       
   503             // Start from the next one
       
   504             index = index + 1;
       
   505             
       
   506             if ( index == count )
       
   507                 {
       
   508                 index = 0;
       
   509                 }
       
   510                          
       
   511             for ( TInt i = index; i < self->iPluginsData.Count(); i++ )
       
   512                 {
       
   513                 if ( !self->iPluginsData[i]->Occupied() )
       
   514                     {
       
   515                     toLoad = self->iPluginsData[i];
       
   516                     break;
       
   517                     }
       
   518                 }                              
       
   519             }
       
   520         else
       
   521             {
       
   522             self->iLoadForward = ETrue;
       
   523             
       
   524             if ( index == 0 )
       
   525                 {
       
   526                 index = count - 1;
       
   527                 }
       
   528             else
       
   529                 {
       
   530                 index = index - 1;
       
   531                 }
       
   532             
       
   533             for ( TInt i = index; i >= 0; i-- )
       
   534                 {
       
   535                 if ( !self->iPluginsData[i]->Occupied() )
       
   536                     {
       
   537                     toLoad = self->iPluginsData[i];
       
   538                     break;
       
   539                     }
       
   540                 }
       
   541             }
       
   542         
       
   543         if ( !self->AllViewsLoaded() && toLoad )
       
   544             {                       
       
   545             toLoad->LoadL();            
       
   546             }
       
   547         
       
   548         if ( self->AllViewsLoaded() )
       
   549             {            
       
   550             self->iLoadTimer->Cancel();            
       
   551             }                    
       
   552         }
       
   553         
       
   554     return KErrNone;
       
   555     }
       
   556 
       
   557 // -----------------------------------------------------------------------------
       
   558 // CXnRootData::SetMaxPages( TInt32 aPages )
       
   559 // 
       
   560 // -----------------------------------------------------------------------------
       
   561 //
       
   562 void CXnRootData::SetMaxPages( TInt32 aPages )
       
   563     {
       
   564     iMaxPages = aPages;
       
   565     }
       
   566 
       
   567 // -----------------------------------------------------------------------------
       
   568 // CXnRootData::MaxPages()
       
   569 // 
       
   570 // -----------------------------------------------------------------------------
       
   571 //
       
   572 TInt32 CXnRootData::MaxPages()
       
   573     {
       
   574     return iMaxPages;
       
   575     }
       
   576 
       
   577 // -----------------------------------------------------------------------------
       
   578 // CXnRootData::RunDestroyL()
       
   579 // 
       
   580 // -----------------------------------------------------------------------------
       
   581 //
       
   582 /* static */ TInt CXnRootData::RunDestroyL( TAny* aAny )
       
   583     {
       
   584     CXnRootData* self = static_cast< CXnRootData* >( aAny );
       
   585     
       
   586     if( self->iFlags.IsSet( EIsDispose ) )
       
   587         {
       
   588         for ( TInt i = 0; i < self->iViewsToDestroy.Count(); i++ )
       
   589             {            
       
   590             if ( self->iPluginsData.Find( 
       
   591                 self->iViewsToDestroy[i] ) == KErrNotFound )
       
   592                 {
       
   593                 // These must be deleted also
       
   594                 self->iPluginsData.AppendL( self->iViewsToDestroy[i] );
       
   595                 }            
       
   596             }
       
   597         
       
   598         self->iViewsToDestroy.Reset();
       
   599         
       
   600         if ( self->iPluginsData.Count() > 0 )
       
   601             {
       
   602             CXnPluginData* toDestroy( self->iPluginsData[0] );
       
   603             
       
   604             delete toDestroy;
       
   605             toDestroy = NULL;
       
   606             
       
   607             self->iPluginsData.Remove( 0 );
       
   608 
       
   609             User::Heap().Compress();            
       
   610             }
       
   611         
       
   612         if ( self->AllViewsDestroyed() )
       
   613             {
       
   614             // All done
       
   615             delete self;
       
   616             }                
       
   617         }
       
   618     else
       
   619         {
       
   620         if ( self->iViewsToDestroy.Count() > 0 )
       
   621             {
       
   622             CXnPluginData* toDestroy( self->iViewsToDestroy[0] );
       
   623             
       
   624             delete toDestroy;
       
   625             toDestroy = NULL;
       
   626             
       
   627             self->iViewsToDestroy.Remove( 0 );
       
   628 
       
   629             User::Heap().Compress();                                              
       
   630             }
       
   631         
       
   632         if ( self->iViewsToDestroy.Count() == 0 )
       
   633             {
       
   634             if ( self->iFlags.IsClear( EIsDispose ) )
       
   635                 {
       
   636                 self->iDestroyTimer->Cancel();
       
   637                 }            
       
   638             }
       
   639         }
       
   640     
       
   641     return KErrNone;
       
   642     }
       
   643 
       
   644 // End of file
       
   645