mobilemessaging/unieditor/application/src/UniEditorOperation.cpp
changeset 79 2981cb3aa489
parent 0 72b543305e3a
equal deleted inserted replaced
25:84d9eb65b26f 79:2981cb3aa489
       
     1 /*
       
     2 * Copyright (c) 2006,2007 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:   CUniEditorOperation
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 // ========== INCLUDE FILES ================================
       
    21 
       
    22 #include <e32std.h>
       
    23 
       
    24 #include "UniEditorLogging.h"    // For logging support
       
    25 
       
    26 #include "UniEditorOperation.h"
       
    27 
       
    28 // ========== EXTERNAL DATA STRUCTURES =====================
       
    29 
       
    30 // ========== EXTERNAL FUNCTION PROTOTYPES =================
       
    31 
       
    32 // ========== CONSTANTS ====================================
       
    33 
       
    34 // ========== MACROS =======================================
       
    35 
       
    36 // ========== LOCAL CONSTANTS AND MACROS ===================
       
    37 const TInt KErrorGranularity = 3;
       
    38 
       
    39 // ========== MODULE DATA STRUCTURES =======================
       
    40 
       
    41 // ========== LOCAL FUNCTION PROTOTYPES ====================
       
    42 
       
    43 // ========== LOCAL FUNCTIONS ==============================
       
    44 
       
    45 // ========== MEMBER FUNCTIONS =============================
       
    46 
       
    47 // ---------------------------------------------------------
       
    48 // CUniEditorOperation::CUniEditorOperation
       
    49 //
       
    50 // Constructor.
       
    51 // ---------------------------------------------------------
       
    52 //
       
    53 CUniEditorOperation::CUniEditorOperation( MUniEditorOperationObserver& aObserver,
       
    54                                           CUniEditorDocument& aDocument,
       
    55                                           RFs& aFs,
       
    56                                           TUniEditorOperationType aOperationType ) :
       
    57     CActive( EPriorityStandard ),
       
    58     iObserver( aObserver ),
       
    59     iDocument( aDocument ),
       
    60     iFs( aFs ),
       
    61     iOperationType( aOperationType )
       
    62     {
       
    63     CActiveScheduler::Add( this );
       
    64     }
       
    65 
       
    66 
       
    67 // ---------------------------------------------------------
       
    68 // CUniEditorOperation::CUniEditorOperation
       
    69 //
       
    70 // Destructor.
       
    71 // ---------------------------------------------------------
       
    72 //
       
    73 CUniEditorOperation::~CUniEditorOperation()
       
    74     {
       
    75     delete iErrors;
       
    76     }
       
    77 
       
    78 // ---------------------------------------------------------
       
    79 // CUniEditorOperation::BaseConstructL
       
    80 //
       
    81 // 2nd phase constructor.
       
    82 // ---------------------------------------------------------
       
    83 //
       
    84 void CUniEditorOperation::BaseConstructL()
       
    85     {
       
    86     iErrors = new ( ELeave ) CArrayFixFlat<TInt>( KErrorGranularity );
       
    87     }
       
    88 
       
    89 // ---------------------------------------------------------
       
    90 // CUniEditorOperation::CompleteSelf
       
    91 //
       
    92 // Completes current step of state machine
       
    93 // ---------------------------------------------------------
       
    94 //
       
    95 void CUniEditorOperation::CompleteSelf( TInt aError )
       
    96     {
       
    97     iStatus = KRequestPending;
       
    98     TRequestStatus* pStatus = &iStatus;
       
    99     SetActive();
       
   100     User::RequestComplete( pStatus, aError );
       
   101     }
       
   102 
       
   103 // ---------------------------------------------------------
       
   104 // CUniEditorOperation::SetPending
       
   105 // ---------------------------------------------------------
       
   106 //
       
   107 void CUniEditorOperation::SetPending()
       
   108     {
       
   109     if ( !IsActive() )
       
   110         {
       
   111         iStatus = KRequestPending;
       
   112         SetActive();
       
   113         }
       
   114     }
       
   115 
       
   116 // ---------------------------------------------------------
       
   117 // CUniEditorOperation::CompleteOperation
       
   118 // ---------------------------------------------------------
       
   119 //
       
   120 void CUniEditorOperation::CompleteOperation( TInt aError )
       
   121     {
       
   122     SetPending();
       
   123         
       
   124     TRequestStatus* pStatus = &iStatus;
       
   125     User::RequestComplete( pStatus, aError );
       
   126     }
       
   127 
       
   128 // ---------------------------------------------------------
       
   129 // CUniEditorOperation::RunError
       
   130 //
       
   131 // ---------------------------------------------------------
       
   132 //
       
   133 TInt CUniEditorOperation::RunError( TInt aError )
       
   134     {
       
   135 #ifdef USE_LOGGER
       
   136     switch ( iOperationType )
       
   137         {
       
   138         case EUniEditorOperationChangeSlide:
       
   139         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationChangeSlide error: %d"), aError );
       
   140         break;
       
   141         case EUniEditorOperationInsert:
       
   142         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationInsert error: %d"), aError );
       
   143         break;
       
   144         case EUniEditorOperationLaunch:
       
   145         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationLaunch error: %d"), aError );
       
   146         break;
       
   147         case EUniEditorOperationPreview:
       
   148         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationPreview error: %d"), aError );
       
   149         break;
       
   150         case EUniEditorOperationSave:
       
   151         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationSave error: %d"), aError );
       
   152         break;
       
   153         case EUniEditorOperationProcessImage:
       
   154         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationProcessImage error: %d"), aError );
       
   155         break;
       
   156         case EUniEditorOperationSend:
       
   157         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationSend error: %d"), aError );
       
   158         break;
       
   159         case EUniEditorOperationSendUi:
       
   160         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationSendUi error: %d"), aError );
       
   161         break;
       
   162         case EUniEditorOperationSetSender:
       
   163         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationSetSender error: %d"), aError );
       
   164         break;
       
   165         case EUniEditorOperationVCard:
       
   166         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationVCard error: %d"), aError );
       
   167         break;
       
   168         case EUniEditorOperationConvertVideo:
       
   169         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError EUniEditorOperationConvertVideo error: %d"), aError );
       
   170         break;
       
   171         default:        
       
   172         UNILOGGER_WRITEF(_L("CUniEditorOperation::RunError UnknownOperation error: %d"), aError );
       
   173         break;
       
   174         }
       
   175 #endif
       
   176 
       
   177     if ( aError == KLeaveExit )
       
   178         {
       
   179         return KLeaveExit;
       
   180         }
       
   181     else
       
   182         {
       
   183         CompleteSelf( aError );
       
   184         return KErrNone;
       
   185         }
       
   186     }
       
   187 
       
   188 
       
   189 // ---------------------------------------------------------
       
   190 // CUniEditorOperation::GetErrors
       
   191 // ---------------------------------------------------------
       
   192 //
       
   193 CArrayFixFlat<TInt>* CUniEditorOperation::GetErrors()
       
   194     {
       
   195     return iErrors;
       
   196     }
       
   197 
       
   198 // ---------------------------------------------------------
       
   199 // CUniEditorOperation::SetError
       
   200 // ---------------------------------------------------------
       
   201 //
       
   202 void CUniEditorOperation::SetError( TInt aError )
       
   203     {
       
   204 #ifdef USE_LOGGER
       
   205     switch ( iOperationType )
       
   206         {
       
   207         case EUniEditorOperationChangeSlide:
       
   208         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationChangeSlide error: %d"), aError );
       
   209         break;
       
   210         case EUniEditorOperationInsert:
       
   211         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationInsert error: %d"), aError );
       
   212         break;
       
   213         case EUniEditorOperationLaunch:
       
   214         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationLaunch error: %d"), aError );
       
   215         break;
       
   216         case EUniEditorOperationPreview:
       
   217         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationPreview error: %d"), aError );
       
   218         break;
       
   219         case EUniEditorOperationSave:
       
   220         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationSave error: %d"), aError );
       
   221         break;
       
   222         case EUniEditorOperationProcessImage:
       
   223         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationProcessImage error: %d"), aError );
       
   224         break;
       
   225         case EUniEditorOperationSend:
       
   226         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationSend error: %d"), aError );
       
   227         break;
       
   228         case EUniEditorOperationSendUi:
       
   229         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationSendUi error: %d"), aError );
       
   230         break;
       
   231         case EUniEditorOperationSetSender:
       
   232         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationSetSender error: %d"), aError );
       
   233         break;
       
   234         case EUniEditorOperationVCard:
       
   235         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationVCard error: %d"), aError );
       
   236         break;
       
   237         case EUniEditorOperationConvertVideo:
       
   238         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError EUniEditorOperationConvertVideo error: %d"), aError );
       
   239         break;
       
   240         default:        
       
   241         UNILOGGER_WRITEF(_L("CUniEditorOperation::SetError UnknownOperation error: %d"), aError );
       
   242         break;
       
   243         }
       
   244 #endif
       
   245 
       
   246     // Won't leave unless out of memory when allocating
       
   247     // new block of error codes.
       
   248     TRAPD( error, iErrors->AppendL( aError ) );
       
   249     if ( error != KErrNone )
       
   250         {
       
   251         iDocument.EikonEnv()->HandleError( error );
       
   252         } 
       
   253     }
       
   254     
       
   255 // ---------------------------------------------------------
       
   256 // CUniEditorOperation::ResetErrors
       
   257 // ---------------------------------------------------------
       
   258 //
       
   259 void CUniEditorOperation::ResetErrors()
       
   260     {
       
   261     iErrors->Reset();
       
   262     }
       
   263     
       
   264 // ---------------------------------------------------------
       
   265 // CUniEditorOperation::SetErrorAndReport
       
   266 // ---------------------------------------------------------
       
   267 //
       
   268 TInt CUniEditorOperation::SetErrorAndReport( TInt aError )
       
   269     {
       
   270     if ( aError != KErrNone )
       
   271         {
       
   272 #ifdef USE_LOGGER
       
   273         switch ( iOperationType )
       
   274             {
       
   275             case EUniEditorOperationChangeSlide:
       
   276             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationChangeSlide error: %d"), aError );
       
   277             break;
       
   278             case EUniEditorOperationInsert:
       
   279             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationInsert error: %d"), aError );
       
   280             break;
       
   281             case EUniEditorOperationLaunch:
       
   282             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationLaunch error: %d"), aError );
       
   283             break;
       
   284             case EUniEditorOperationPreview:
       
   285             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationPreview error: %d"), aError );
       
   286             break;
       
   287             case EUniEditorOperationSave:
       
   288             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationSave error: %d"), aError );
       
   289             break;
       
   290             case EUniEditorOperationProcessImage:
       
   291             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationProcessImage error: %d"), aError );
       
   292             break;
       
   293             case EUniEditorOperationSend:
       
   294             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationSend error: %d"), aError );
       
   295             break;
       
   296             case EUniEditorOperationSendUi:
       
   297             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationSendUi error: %d"), aError );
       
   298             break;
       
   299             case EUniEditorOperationSetSender:
       
   300             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationSetSender error: %d"), aError );
       
   301             break;
       
   302             case EUniEditorOperationVCard:
       
   303             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationVCard error: %d"), aError );
       
   304             break;
       
   305             case EUniEditorOperationConvertVideo:
       
   306             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport EUniEditorOperationConvertVideo error: %d"), aError );
       
   307             break;
       
   308             default:        
       
   309             UNILOGGER_WRITEF(_L("CUniEditorOperation::SetErrorAndReport UnknownOperation error: %d"), aError );
       
   310             break;
       
   311             }
       
   312 #endif
       
   313 
       
   314         SetError( aError );
       
   315         iObserver.EditorOperationEvent( iOperationType,
       
   316                                         EUniEditorOperationError );
       
   317         }
       
   318 
       
   319     return aError;
       
   320     }
       
   321 
       
   322 // ---------------------------------------------------------
       
   323 // CUniEditorOperation::PrintOperationAndState
       
   324 // ---------------------------------------------------------
       
   325 //
       
   326 void CUniEditorOperation::PrintOperationAndState()
       
   327     {
       
   328 #ifdef USE_LOGGER
       
   329     switch ( iOperationType )
       
   330         {
       
   331         case EUniEditorOperationChangeSlide:
       
   332         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationChangeSlide State: %d"), iOperationState );
       
   333         break;
       
   334         case EUniEditorOperationInsert:
       
   335         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationInsert State: %d"), iOperationState );
       
   336         break;
       
   337         case EUniEditorOperationLaunch:
       
   338         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationLaunch State: %d"), iOperationState );
       
   339         break;
       
   340         case EUniEditorOperationPreview:
       
   341         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationPreview State: %d"), iOperationState );
       
   342         break;
       
   343         case EUniEditorOperationSave:
       
   344         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationSave State: %d"), iOperationState );
       
   345         break;
       
   346         case EUniEditorOperationProcessImage:
       
   347         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationProcessImage State: %d"), iOperationState );
       
   348         break;
       
   349         case EUniEditorOperationSend:
       
   350         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationSend State: %d"), iOperationState );
       
   351         break;
       
   352         case EUniEditorOperationSendUi:
       
   353         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationSendUi State: %d"), iOperationState );
       
   354         break;
       
   355         case EUniEditorOperationSetSender:
       
   356         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationSetSender State: %d"), iOperationState );
       
   357         break;
       
   358         case EUniEditorOperationVCard:
       
   359         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState EUniEditorOperationVCard State: %d"), iOperationState );
       
   360         break;
       
   361         default:        
       
   362         UNILOGGER_WRITEF(_L("CUniEditorOperation::PrintOperationAndState UnknownOperation State: %d"), iOperationState );
       
   363         break;
       
   364         }
       
   365 #endif
       
   366     }
       
   367 
       
   368 // ---------------------------------------------------------
       
   369 // CUniEditorOperation::DoCancel
       
   370 //
       
   371 // Calls derived class to cancel outstanding operations and perform
       
   372 // cleanup. Notifies observer that operation has been cancelled. Reporting
       
   373 // is needed as operation might be cancelled by other object than
       
   374 // the observer (e.g. input blocker). Finally
       
   375 // completes the operation if request is still pending. This should
       
   376 // not happen but it is better to handle this situation to prevent
       
   377 // deadlock.
       
   378 // ---------------------------------------------------------
       
   379 //
       
   380 void CUniEditorOperation::DoCancel()
       
   381     {
       
   382     DoCancelCleanup();
       
   383     
       
   384     iObserver.EditorOperationEvent( iOperationType,
       
   385                                     EUniEditorOperationCancel );
       
   386 
       
   387     
       
   388     if ( iStatus == KRequestPending )
       
   389         {
       
   390         CompleteOperation( KErrCancel );
       
   391         }
       
   392     }
       
   393 
       
   394 // ---------------------------------------------------------
       
   395 // CUniEditorOperation::EditorOperationEvent
       
   396 // ---------------------------------------------------------
       
   397 //
       
   398 void CUniEditorOperation::EditorOperationEvent( TUniEditorOperationType aOperation,
       
   399                                                 TUniEditorOperationEvent aEvent )
       
   400     {
       
   401     if ( aEvent == EUniEditorOperationCancel )
       
   402         {
       
   403         iObserver.EditorOperationEvent( iOperationType, aEvent );
       
   404         CompleteOperation( KErrCancel );
       
   405         }
       
   406     else
       
   407         {
       
   408         HandleOperationEvent( aOperation, aEvent );
       
   409         }    
       
   410     }
       
   411 
       
   412 // ---------------------------------------------------------
       
   413 // CUniEditorOperation::EditorOperationQuery
       
   414 // ---------------------------------------------------------
       
   415 //
       
   416 TBool CUniEditorOperation::EditorOperationQuery( TUniEditorOperationType aOperation,
       
   417                                                  TUniEditorOperationQuery aQuery )
       
   418     {
       
   419     return iObserver.EditorOperationQuery( aOperation, aQuery );
       
   420     }
       
   421 
       
   422 // ---------------------------------------------------------
       
   423 // CUniEditorOperation::HandleOperationEvent
       
   424 // ---------------------------------------------------------
       
   425 //
       
   426 void CUniEditorOperation::HandleOperationEvent( TUniEditorOperationType /*aOperation*/,
       
   427                                                 TUniEditorOperationEvent /*aEvent*/ )
       
   428     {   
       
   429     CompleteOperation( KErrNone );
       
   430     }
       
   431 
       
   432 // EOF