controlpanel/src/cpframework/src/cppluginloader.cpp
author hgs
Thu, 02 Sep 2010 17:14:05 +0800
changeset 55 4c15d9aa2384
parent 40 6465d5bb863a
permissions -rw-r--r--
201035
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
     1
/*
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
     3
* All rights reserved.
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0""
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
     8
*
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
     9
* Initial Contributors:
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    11
*
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    12
* Contributors:
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    13
*
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    14
* Description:  
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    15
*
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    16
*/
32
hgs
parents: 31
diff changeset
    17
#include <cppluginloader.h>
hgs
parents: 31
diff changeset
    18
#include <QString>
hgs
parents: 31
diff changeset
    19
#include <QDir>
hgs
parents: 31
diff changeset
    20
#include <QFileInfo>
hgs
parents: 31
diff changeset
    21
#include <QPluginLoader>
hgs
parents: 31
diff changeset
    22
#include <cpplugininterface.h>
36
hgs
parents: 34
diff changeset
    23
#include <cplauncherinterface.h>
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    24
#include "cputility.h"
32
hgs
parents: 31
diff changeset
    25
#include <cplogger.h>
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    26
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    27
32
hgs
parents: 31
diff changeset
    28
/*!
hgs
parents: 31
diff changeset
    29
    \class CpPluginLoader
hgs
parents: 31
diff changeset
    30
    \brief The CpPluginLoader class loads a controlpanel plugin at run-time.
hgs
parents: 31
diff changeset
    31
 */
hgs
parents: 31
diff changeset
    32
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    33
#ifdef WIN32
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    34
    #define PLUGINFILE_SUFFIX "dll"
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    35
#else
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    36
    #define PLUGINFILE_SUFFIX "qtplugin"
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    37
#endif
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    38
55
hgs
parents: 40
diff changeset
    39
/*
hgs
parents: 40
diff changeset
    40
 *  Load the root component object of the plugin from @pluginFile
hgs
parents: 40
diff changeset
    41
 *  if @pluginFile is an absoulte file path, load it directly, if is a 
hgs
parents: 40
diff changeset
    42
 *  file name, load the root component from path /resource/qt/plugins/controlpanel
hgs
parents: 40
diff changeset
    43
*/
hgs
parents: 40
diff changeset
    44
static QObject* loadPluginInterface(const QString &pluginFile)
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    45
{
34
hgs
parents: 32
diff changeset
    46
    CPPERF_LOG( QLatin1String("Loading plugin: ") + pluginFile );
hgs
parents: 32
diff changeset
    47
    
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    48
    QFileInfo fileInfo(pluginFile);
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    49
55
hgs
parents: 40
diff changeset
    50
    // scan the plugin file from path /resource/qt/plugins/controlpanel
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    51
    if (!fileInfo.isAbsolute()) {
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    52
        QString fileName = fileInfo.fileName();
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    53
        if (fileInfo.suffix().compare(PLUGINFILE_SUFFIX,Qt::CaseInsensitive)) {
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    54
            fileName = fileInfo.baseName() + '.' + PLUGINFILE_SUFFIX;
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    55
        }
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    56
32
hgs
parents: 31
diff changeset
    57
		QStringList pluginDirs = CpUtility::pluginDirectories();
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    58
		foreach(const QString &pluginDir,pluginDirs) {
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    59
			fileInfo.setFile(pluginDir + fileName);
55
hgs
parents: 40
diff changeset
    60
			// found a valid plugin file.
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    61
			if (fileInfo.exists() && QLibrary::isLibrary(fileInfo.absoluteFilePath())) {
34
hgs
parents: 32
diff changeset
    62
			    CPPERF_LOG( QLatin1String("Valid plugin stub found: ") + fileInfo.absoluteFilePath() );
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    63
				break;
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    64
			}
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    65
		}
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    66
    }
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    67
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    68
	QPluginLoader loader(fileInfo.absoluteFilePath());
55
hgs
parents: 40
diff changeset
    69
	QObject *plugin = loader.instance();
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    70
	if (!plugin) {
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    71
		loader.unload();
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    72
	}
34
hgs
parents: 32
diff changeset
    73
	
hgs
parents: 32
diff changeset
    74
	CPPERF_LOG( QLatin1String("Load plugin ") + (plugin ? QLatin1String("succeed.") : QLatin1String("failed.")) );
31
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    75
    
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    76
    return plugin;
2c9d3aa5bea2 201003_2
hgs
parents:
diff changeset
    77
}
32
hgs
parents: 31
diff changeset
    78
hgs
parents: 31
diff changeset
    79
/*!
55
hgs
parents: 40
diff changeset
    80
    load a CpPluginInterface by a controlpanel plugin file.
32
hgs
parents: 31
diff changeset
    81
    the plugin file can either absoulte file path or only file name.
hgs
parents: 31
diff changeset
    82
    acceptable format:
hgs
parents: 31
diff changeset
    83
        sampleplugin
hgs
parents: 31
diff changeset
    84
        sampleplugin.qtplugin
hgs
parents: 31
diff changeset
    85
        sampleplugin.dll
hgs
parents: 31
diff changeset
    86
        C:/resource/qt/plugins/controlpanel/sampleplugin.qtplugin
hgs
parents: 31
diff changeset
    87
        C:/resource/qt/plugins/controlpanel/sampleplugin.dll
hgs
parents: 31
diff changeset
    88
 */
36
hgs
parents: 34
diff changeset
    89
CpPluginInterface *CpPluginLoader::loadCpPluginInterface(const QString &pluginFile)
hgs
parents: 34
diff changeset
    90
{
55
hgs
parents: 40
diff changeset
    91
    return qobject_cast<CpPluginInterface*>(::loadPluginInterface(pluginFile));
36
hgs
parents: 34
diff changeset
    92
}
hgs
parents: 34
diff changeset
    93
37
hgs
parents: 36
diff changeset
    94
/*!
55
hgs
parents: 40
diff changeset
    95
    load a CpLauncherInterface by a controlpanel plugin file.
37
hgs
parents: 36
diff changeset
    96
    the plugin file can either absoulte file path or only file name.
hgs
parents: 36
diff changeset
    97
    acceptable format:
hgs
parents: 36
diff changeset
    98
        sampleplugin
hgs
parents: 36
diff changeset
    99
        sampleplugin.qtplugin
hgs
parents: 36
diff changeset
   100
        sampleplugin.dll
hgs
parents: 36
diff changeset
   101
        C:/resource/qt/plugins/controlpanel/sampleplugin.qtplugin
hgs
parents: 36
diff changeset
   102
        C:/resource/qt/plugins/controlpanel/sampleplugin.dll
hgs
parents: 36
diff changeset
   103
 */
36
hgs
parents: 34
diff changeset
   104
CpLauncherInterface *CpPluginLoader::loadCpLauncherInterface(const QString &pluginFile)
hgs
parents: 34
diff changeset
   105
{
55
hgs
parents: 40
diff changeset
   106
    return qobject_cast<CpLauncherInterface*>(::loadPluginInterface(pluginFile));  
32
hgs
parents: 31
diff changeset
   107
}
hgs
parents: 31
diff changeset
   108
hgs
parents: 31
diff changeset
   109