devsoundextensions/ciextnfactoryplugins/ciplatformmsghndlrplugin/src/ciplatformmsghndlrplugin.cpp
author hgs
Thu, 07 Oct 2010 22:34:12 +0100
changeset 0 b8ed18f6c07b
child 5 b220a9341636
permissions -rw-r--r--
2010wk40
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     1
/*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies). 
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     3
* All rights reserved.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     8
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
     9
* Initial Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    11
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    12
* Contributors:
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    13
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    14
* Description:   Class definition of plugin implementing message handler
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    15
*                interface.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    16
*
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    17
*/
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    18
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    19
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    20
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    21
// Include files
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    22
#include "ciplatformmsghndlrplugin.h"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    23
#include "ciplatformmsghndlrplugin.hrh"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    24
#include "citraces.h"
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    25
#include <ecom.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    26
#include <CustomInterfaceBuilder.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    27
#include <CustomInterfaceCustomCommandParser.h>
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    28
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    29
#define RET_ERR_IF_ERR(s) if(s!=KErrNone) return s
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    30
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    31
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    32
// Constructs and returns an application object.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    33
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    34
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    35
MCIMsgHndlrIntfc* CCIPlatformMsgHndlrPlugin::NewL()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    36
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    37
    DEB_TRACE0(_L("*CI* CCIPlatformMsgHndlrPlugin::NewL"));
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    38
    CCIPlatformMsgHndlrPlugin* self = new (ELeave) CCIPlatformMsgHndlrPlugin;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    39
    CleanupStack::PushL( self );
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    40
    self->ConstructL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    41
    CleanupStack::Pop( self );
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    42
    MCIMsgHndlrIntfc* ptr = static_cast<MCIMsgHndlrIntfc*>(self);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    43
    return ptr;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    44
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    45
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    46
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    47
// Destructor
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    48
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    49
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    50
CCIPlatformMsgHndlrPlugin::~CCIPlatformMsgHndlrPlugin()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    51
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    52
    // No Impl
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    53
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    54
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    55
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    56
// Called by framework when plugin is constructed
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    57
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    58
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    59
TInt CCIPlatformMsgHndlrPlugin::Initialize( MCustomInterface& aCustomInterface, TUid aDestructorKey )
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    60
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    61
    TInt status(KErrNone);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    62
    iMCustomInterface = &aCustomInterface;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    63
    iDestructorKey = aDestructorKey;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    64
    iCIFWObjectsInitialized = EFalse;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    65
    return status;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    66
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    67
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    68
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    69
// Called by framework when it needs to know plugin implementation uid
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    70
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    71
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    72
TUid CCIPlatformMsgHndlrPlugin::ImplementationUid()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    73
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    74
    TUid implId = {KUidCCIPlatformMsgHndlrPlugin};
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    75
    return implId;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    76
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    77
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    78
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    79
// Called by framework forwarding request to handle aMessage
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    80
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    81
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    82
TBool CCIPlatformMsgHndlrPlugin::HandleMessage( const RMmfIpcMessage& aMessage )
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    83
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    84
    DEB_TRACE0(_L("*CI* CCIPlatformMsgHndlrPlugin::HandleMessage"));
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    85
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    86
    TBool handled(EFalse);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    87
    // Initialize Custom Interface Framework Objects if not done already
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    88
    if (!iCIFWObjectsInitialized)
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    89
        {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    90
        TRAPD( status, InitializeCIFWObjectsL());
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    91
        if ( status != KErrNone )
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    92
            {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    93
            aMessage.Complete(status);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    94
            handled = ETrue;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    95
            }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    96
        }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    97
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    98
    // Get the destination info from the client into TMMFMessage.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
    99
    TMMFMessage message(aMessage);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   100
    TRAPD(status, message.FetchDestinationL());
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   101
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   102
    // Check if Custom Command Parser manager can handle the message...
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   103
    if (!handled)
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   104
        {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   105
        handled = iCustomCommandParserManager->HandleRequest(message);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   106
        }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   107
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   108
    // Check if the aMessage is for one of the MMF Objects
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   109
    if (!handled)
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   110
        {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   111
        CMMFObject* object = NULL;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   112
        // Try to find MMFObject that handles this request
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   113
        TInt status = iMMFObjectContainer->FindMMFObject(message.Destination(),
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   114
                                                     object);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   115
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   116
        // If found, give message to the MMFObject
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   117
        if ( KErrNone == status )
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   118
            {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   119
            object->HandleRequest(message);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   120
            handled = ETrue;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   121
            }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   122
        }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   123
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   124
    return handled;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   125
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   126
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   127
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   128
// Called by framework when plugin is to be deleted
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   129
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   130
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   131
void CCIPlatformMsgHndlrPlugin::Close()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   132
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   133
    DEB_TRACE0(_L("*CI* CCIPlatformMsgHndlrPlugin::Close"));
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   134
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   135
    iMCustomInterface = NULL;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   136
    delete iCustomCommandParserManager;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   137
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   138
    iCustomCommandParserManager =  NULL;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   139
    delete iMMFObjectContainer;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   140
    iMMFObjectContainer = NULL;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   141
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   142
    iCIFWObjectsInitialized = EFalse;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   143
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   144
    REComSession::DestroyedImplementation(iDestructorKey);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   145
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   146
    delete this;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   147
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   148
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   149
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   150
// Called by framework to get handle to custom interface builder
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   151
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   152
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   153
const TMMFMessageDestination& CCIPlatformMsgHndlrPlugin::GetCustomInterfaceBuilderL()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   154
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   155
    // return the handle
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   156
    return iCustomInterfaceBuilder->Handle();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   157
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   158
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   159
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   160
// Constructor
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   161
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   162
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   163
CCIPlatformMsgHndlrPlugin::CCIPlatformMsgHndlrPlugin()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   164
:iMCustomInterface(NULL),
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   165
iCIFWObjectsInitialized(EFalse),
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   166
iMMFObjectContainer(NULL),
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   167
iCustomCommandParserManager(NULL),
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   168
iCustomInterfaceBuilder(NULL)
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   169
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   170
    // No Impl
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   171
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   172
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   173
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   174
// Second phase constructor
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   175
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   176
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   177
void CCIPlatformMsgHndlrPlugin::ConstructL()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   178
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   179
    // No Impl
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   180
    }
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   181
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   182
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   183
// Initializes objects required for Custom Interface Framework.
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   184
// ---------------------------------------------------------------------------
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   185
//
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   186
void CCIPlatformMsgHndlrPlugin::InitializeCIFWObjectsL()
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   187
    {
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   188
    DEB_TRACE0(_L("*CI* CCIPlatformMsgHndlrPlugin::InitializeCIFWObjectsL"));
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   189
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   190
    iMMFObjectContainer = new(ELeave) CMMFObjectContainer;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   191
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   192
    iCustomCommandParserManager = CMMFCustomCommandParserManager::NewL();
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   193
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   194
    CCustomInterfaceCustomCommandParser* ciccParser = CCustomInterfaceCustomCommandParser::NewL(*this);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   195
    CleanupStack::PushL( ciccParser );
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   196
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   197
    iCustomCommandParserManager->AddCustomCommandParserL(*ciccParser);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   198
    CleanupStack::Pop( ciccParser );
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   199
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   200
    iCustomInterfaceBuilder = CCustomInterfaceBuilder::NewL( *iMMFObjectContainer, *iMCustomInterface);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   201
    iMMFObjectContainer->AddMMFObject(*iCustomInterfaceBuilder);
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   202
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   203
    iCIFWObjectsInitialized = ETrue;
b8ed18f6c07b 2010wk40
hgs
parents:
diff changeset
   204
    }