<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>libkdepim: pluginmanager.cpp Source File (libkdepim)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../">API Reference</a>
/ <a href=".">libkdepim</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<h2><a name="content"></a>libkdepim</h2>
<!-- Generated by Doxygen 1.5.5 -->
<h1>pluginmanager.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 2; -*-</span>
<a name="l00023"></a>00023 <span class="comment"></span><span class="preprocessor">#include "pluginmanager.h"</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include "plugin.h"</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#include <qapplication.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <qfile.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <qregexp.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <qtimer.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <qvaluestack.h></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="preprocessor">#include <kapplication.h></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <kdebug.h></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <kparts/componentfactory.h></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <kplugininfo.h></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <ksettings/dispatcher.h></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <ksimpleconfig.h></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include <kstandarddirs.h></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <kstaticdeleter.h></span>
<a name="l00041"></a>00041 <span class="preprocessor">#include <kurl.h></span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">namespace </span>Komposer
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">class </span>PluginManager::Private
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 <span class="comment">// All available plugins, regardless of category, and loaded or not</span>
<a name="l00051"></a>00051 QValueList<KPluginInfo*> plugins;
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="comment">// Dict of all currently loaded plugins, mapping the KPluginInfo to</span>
<a name="l00054"></a>00054 <span class="comment">// a plugin</span>
<a name="l00055"></a>00055 QMap<KPluginInfo*, Plugin*> loadedPlugins;
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">// The plugin manager's mode. The mode is StartingUp until loadAllPlugins()</span>
<a name="l00058"></a>00058 <span class="comment">// has finished loading the plugins, after which it is set to Running.</span>
<a name="l00059"></a>00059 <span class="comment">// ShuttingDown and DoneShutdown are used during Komposer shutdown by the</span>
<a name="l00060"></a>00060 <span class="comment">// async unloading of plugins.</span>
<a name="l00061"></a>00061 <span class="keyword">enum</span> ShutdownMode { StartingUp, Running, ShuttingDown, DoneShutdown };
<a name="l00062"></a>00062 ShutdownMode shutdownMode;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 KSharedConfig::Ptr config;
<a name="l00065"></a>00065 <span class="comment">// Plugins pending for loading</span>
<a name="l00066"></a>00066 QValueStack<QString> pluginsToLoad;
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00069"></a>00069 PluginManager::PluginManager( QObject *parent )
<a name="l00070"></a>00070 : QObject( parent )
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072 d = <span class="keyword">new</span> Private;
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="comment">// We want to add a reference to the application's event loop so we</span>
<a name="l00075"></a>00075 <span class="comment">// can remain in control when all windows are removed.</span>
<a name="l00076"></a>00076 <span class="comment">// This way we can unload plugins asynchronously, which is more</span>
<a name="l00077"></a>00077 <span class="comment">// robust if they are still doing processing.</span>
<a name="l00078"></a>00078 kapp->ref();
<a name="l00079"></a>00079 d->shutdownMode = Private::StartingUp;
<a name="l00080"></a>00080
<a name="l00081"></a>00081 KSettings::Dispatcher::self()->registerInstance( KGlobal::instance(),
<a name="l00082"></a>00082 <span class="keyword">this</span>, SLOT( loadAllPlugins() ) );
<a name="l00083"></a>00083
<a name="l00084"></a>00084 d->plugins = KPluginInfo::fromServices(
<a name="l00085"></a>00085 KTrader::self()->query( QString::fromLatin1( <span class="stringliteral">"Komposer/Plugin"</span> ),
<a name="l00086"></a>00086 QString::fromLatin1( <span class="stringliteral">"[X-Komposer-Version] == 1"</span> ) ) );
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088
<a name="l00089"></a>00089 PluginManager::~PluginManager()
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 <span class="keywordflow">if</span> ( d->shutdownMode != Private::DoneShutdown ) {
<a name="l00092"></a>00092 slotShutdownTimeout();
<a name="l00093"></a>00093 <span class="preprocessor">#if 0</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span> kdWarning() << k_funcinfo
<a name="l00095"></a>00095 << <span class="stringliteral">"Destructing plugin manager without going through "</span>
<a name="l00096"></a>00096 << <span class="stringliteral">"the shutdown process!"</span>
<a name="l00097"></a>00097 << endl
<a name="l00098"></a>00098 << kdBacktrace(10) << endl;
<a name="l00099"></a>00099 <span class="preprocessor">#endif</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span> }
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="comment">// Quick cleanup of the remaining plugins, hope it helps</span>
<a name="l00103"></a>00103 QMap<KPluginInfo*, Plugin*>::ConstIterator it;
<a name="l00104"></a>00104 <span class="keywordflow">for</span> ( it = d->loadedPlugins.begin(); it != d->loadedPlugins.end(); <span class="comment">/* EMPTY */</span> )
<a name="l00105"></a>00105 {
<a name="l00106"></a>00106 <span class="comment">// Remove causes the iterator to become invalid, so pre-increment first</span>
<a name="l00107"></a>00107 QMap<KPluginInfo*, Plugin*>::ConstIterator nextIt( it );
<a name="l00108"></a>00108 ++nextIt;
<a name="l00109"></a>00109 kdWarning() << k_funcinfo << <span class="stringliteral">"Deleting stale plugin '"</span>
<a name="l00110"></a>00110 << it.data()->name() << <span class="stringliteral">"'"</span> << endl;
<a name="l00111"></a>00111 <span class="keyword">delete</span> it.data();
<a name="l00112"></a>00112 it = nextIt;
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">delete</span> d;
<a name="l00116"></a>00116 }
<a name="l00117"></a>00117
<a name="l00118"></a>00118 QValueList<KPluginInfo*>
<a name="l00119"></a>00119 PluginManager::availablePlugins( <span class="keyword">const</span> QString &category )<span class="keyword"> const</span>
<a name="l00120"></a>00120 <span class="keyword"></span>{
<a name="l00121"></a>00121 <span class="keywordflow">if</span> ( category.isEmpty() )
<a name="l00122"></a>00122 <span class="keywordflow">return</span> d->plugins;
<a name="l00123"></a>00123
<a name="l00124"></a>00124 QValueList<KPluginInfo*> result;
<a name="l00125"></a>00125 QValueList<KPluginInfo*>::ConstIterator it;
<a name="l00126"></a>00126 for ( it = d->plugins.begin(); it != d->plugins.end(); ++it )
<a name="l00127"></a>00127 {
<a name="l00128"></a>00128 <span class="keywordflow">if</span> ( ( *it )->category() == category )
<a name="l00129"></a>00129 result.append( *it );
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="keywordflow">return</span> result;
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134
<a name="l00135"></a>00135 QMap<KPluginInfo*, Plugin*>
<a name="l00136"></a>00136 PluginManager::loadedPlugins( <span class="keyword">const</span> QString &category )<span class="keyword"> const</span>
<a name="l00137"></a>00137 <span class="keyword"></span>{
<a name="l00138"></a>00138 QMap<KPluginInfo*, Plugin*> result;
<a name="l00139"></a>00139 QMap<KPluginInfo*, Plugin*>::ConstIterator it;
<a name="l00140"></a>00140 <span class="keywordflow">for</span> ( it = d->loadedPlugins.begin(); it != d->loadedPlugins.end(); ++it )
<a name="l00141"></a>00141 {
<a name="l00142"></a>00142 <span class="keywordflow">if</span> ( category.isEmpty() || it.key()->category() == category )
<a name="l00143"></a>00143 result.insert( it.key(), it.data() );
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="keywordflow">return</span> result;
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="keywordtype">void</span>
<a name="l00150"></a>00150 PluginManager::shutdown()
<a name="l00151"></a>00151 {
<a name="l00152"></a>00152 d->shutdownMode = Private::ShuttingDown;
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="comment">// Remove any pending plugins to load, we're shutting down now :)</span>
<a name="l00155"></a>00155 d->pluginsToLoad.clear();
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="comment">// Ask all plugins to unload</span>
<a name="l00158"></a>00158 <span class="keywordflow">if</span> ( d->loadedPlugins.empty() ) {
<a name="l00159"></a>00159 d->shutdownMode = Private::DoneShutdown;
<a name="l00160"></a>00160 } <span class="keywordflow">else</span> {
<a name="l00161"></a>00161 QMap<KPluginInfo*, Plugin*>::ConstIterator it;
<a name="l00162"></a>00162 <span class="keywordflow">for</span> ( it = d->loadedPlugins.begin(); it != d->loadedPlugins.end(); <span class="comment">/* EMPTY */</span> )
<a name="l00163"></a>00163 {
<a name="l00164"></a>00164 <span class="comment">// Remove causes the iterator to become invalid, so pre-increment first</span>
<a name="l00165"></a>00165 QMap<KPluginInfo*, Plugin*>::ConstIterator nextIt( it );
<a name="l00166"></a>00166 ++nextIt;
<a name="l00167"></a>00167 it.data()->aboutToUnload();
<a name="l00168"></a>00168 it = nextIt;
<a name="l00169"></a>00169 }
<a name="l00170"></a>00170 }
<a name="l00171"></a>00171
<a name="l00172"></a>00172 QTimer::singleShot( 3000, <span class="keyword">this</span>, SLOT(slotShutdownTimeout()) );
<a name="l00173"></a>00173 }
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="keywordtype">void</span>
<a name="l00176"></a>00176 PluginManager::slotPluginReadyForUnload()
<a name="l00177"></a>00177 {
<a name="l00178"></a>00178 <span class="comment">// Using QObject::sender() is on purpose here, because otherwise all</span>
<a name="l00179"></a>00179 <span class="comment">// plugins would have to pass 'this' as parameter, which makes the API</span>
<a name="l00180"></a>00180 <span class="comment">// less clean for plugin authors</span>
<a name="l00181"></a>00181 Plugin* plugin = <span class="keyword">dynamic_cast<</span>Plugin*<span class="keyword">></span>( <span class="keyword">const_cast<</span>QObject*<span class="keyword">></span>( sender() ) );
<a name="l00182"></a>00182 <span class="keywordflow">if</span> ( !plugin )
<a name="l00183"></a>00183 {
<a name="l00184"></a>00184 kdWarning() << k_funcinfo << <span class="stringliteral">"Calling object is not a plugin!"</span> << endl;
<a name="l00185"></a>00185 <span class="keywordflow">return</span>;
<a name="l00186"></a>00186
<a name="l00187"></a>00187 }
<a name="l00188"></a>00188 kdDebug()<<<span class="stringliteral">"manager unloading"</span><<endl;
<a name="l00189"></a>00189 plugin->deleteLater();
<a name="l00190"></a>00190 }
<a name="l00191"></a>00191
<a name="l00192"></a>00192 <span class="keywordtype">void</span>
<a name="l00193"></a>00193 PluginManager::slotShutdownTimeout()
<a name="l00194"></a>00194 {
<a name="l00195"></a>00195 <span class="comment">// When we were already done the timer might still fire.</span>
<a name="l00196"></a>00196 <span class="comment">// Do nothing in that case.</span>
<a name="l00197"></a>00197 <span class="keywordflow">if</span> ( d->shutdownMode == Private::DoneShutdown )
<a name="l00198"></a>00198 <span class="keywordflow">return</span>;
<a name="l00199"></a>00199
<a name="l00200"></a>00200 <span class="preprocessor">#ifndef NDEBUG</span>
<a name="l00201"></a>00201 <span class="preprocessor"></span> QStringList remaining;
<a name="l00202"></a>00202 <span class="keywordflow">for</span> ( QMap<KPluginInfo*, Plugin*>::ConstIterator it = d->loadedPlugins.begin();
<a name="l00203"></a>00203 it != d->loadedPlugins.end(); ++it )
<a name="l00204"></a>00204 remaining.append( it.key()->pluginName() );
<a name="l00205"></a>00205
<a name="l00206"></a>00206 kdWarning() << k_funcinfo << <span class="stringliteral">"Some plugins didn't shutdown in time!"</span> << endl
<a name="l00207"></a>00207 << <span class="stringliteral">"Remaining plugins: "</span>
<a name="l00208"></a>00208 << remaining.join( QString::fromLatin1( <span class="stringliteral">", "</span> ) ) << endl
<a name="l00209"></a>00209 << <span class="stringliteral">"Forcing Komposer shutdown now."</span> << endl;
<a name="l00210"></a>00210 <span class="preprocessor">#endif</span>
<a name="l00211"></a>00211 <span class="preprocessor"></span>
<a name="l00212"></a>00212 slotShutdownDone();
<a name="l00213"></a>00213 }
<a name="l00214"></a>00214
<a name="l00215"></a>00215 <span class="keywordtype">void</span>
<a name="l00216"></a>00216 PluginManager::slotShutdownDone()
<a name="l00217"></a>00217 {
<a name="l00218"></a>00218 d->shutdownMode = Private::DoneShutdown;
<a name="l00219"></a>00219
<a name="l00220"></a>00220 kapp->deref();
<a name="l00221"></a>00221 }
<a name="l00222"></a>00222
<a name="l00223"></a>00223 <span class="keywordtype">void</span>
<a name="l00224"></a>00224 PluginManager::loadAllPlugins()
<a name="l00225"></a>00225 {
<a name="l00226"></a>00226 <span class="comment">// FIXME: We need session management here - Martijn</span>
<a name="l00227"></a>00227
<a name="l00228"></a>00228 <span class="keywordflow">if</span> ( !d->config )
<a name="l00229"></a>00229 d->config = KSharedConfig::openConfig( <span class="stringliteral">"komposerrc"</span> );
<a name="l00230"></a>00230
<a name="l00231"></a>00231 QMap<QString, QString> entries = d->config->entryMap(
<a name="l00232"></a>00232 QString::fromLatin1( <span class="stringliteral">"Plugins"</span> ) );
<a name="l00233"></a>00233
<a name="l00234"></a>00234 QMap<QString, QString>::Iterator it;
<a name="l00235"></a>00235 <span class="keywordflow">for</span> ( it = entries.begin(); it != entries.end(); ++it )
<a name="l00236"></a>00236 {
<a name="l00237"></a>00237 QString key = it.key();
<a name="l00238"></a>00238 <span class="keywordflow">if</span> ( key.endsWith( QString::fromLatin1( <span class="stringliteral">"Enabled"</span> ) ) )
<a name="l00239"></a>00239 {
<a name="l00240"></a>00240 key.setLength( key.length() - 7 );
<a name="l00241"></a>00241 <span class="comment">//kdDebug() << k_funcinfo << "Set " << key << " to " << it.data() << endl;</span>
<a name="l00242"></a>00242
<a name="l00243"></a>00243 <span class="keywordflow">if</span> ( it.data() == QString::fromLatin1( <span class="stringliteral">"true"</span> ) )
<a name="l00244"></a>00244 {
<a name="l00245"></a>00245 <span class="keywordflow">if</span> ( !plugin( key ) )
<a name="l00246"></a>00246 d->pluginsToLoad.push( key );
<a name="l00247"></a>00247 }
<a name="l00248"></a>00248 <span class="keywordflow">else</span>
<a name="l00249"></a>00249 {
<a name="l00250"></a>00250 <span class="comment">// FIXME: Does this ever happen? As loadAllPlugins is only called on startup</span>
<a name="l00251"></a>00251 <span class="comment">// I'd say 'no'. If it does, it should be made async</span>
<a name="l00252"></a>00252 <span class="comment">// though. - Martijn</span>
<a name="l00253"></a>00253 <span class="keywordflow">if</span> ( plugin( key ) )
<a name="l00254"></a>00254 unloadPlugin( key );
<a name="l00255"></a>00255 }
<a name="l00256"></a>00256 }
<a name="l00257"></a>00257 }
<a name="l00258"></a>00258
<a name="l00259"></a>00259 <span class="comment">// Schedule the plugins to load</span>
<a name="l00260"></a>00260 QTimer::singleShot( 0, <span class="keyword">this</span>, SLOT( slotLoadNextPlugin() ) );
<a name="l00261"></a>00261 }
<a name="l00262"></a>00262
<a name="l00263"></a>00263 <span class="keywordtype">void</span> PluginManager::slotLoadNextPlugin()
<a name="l00264"></a>00264 {
<a name="l00265"></a>00265 <span class="keywordflow">if</span> ( d->pluginsToLoad.isEmpty() )
<a name="l00266"></a>00266 {
<a name="l00267"></a>00267 <span class="keywordflow">if</span> ( d->shutdownMode == Private::StartingUp )
<a name="l00268"></a>00268 {
<a name="l00269"></a>00269 d->shutdownMode = Private::Running;
<a name="l00270"></a>00270 emit allPluginsLoaded();
<a name="l00271"></a>00271 }
<a name="l00272"></a>00272 <span class="keywordflow">return</span>;
<a name="l00273"></a>00273 }
<a name="l00274"></a>00274
<a name="l00275"></a>00275 QString key = d->pluginsToLoad.pop();
<a name="l00276"></a>00276 loadPluginInternal( key );
<a name="l00277"></a>00277
<a name="l00278"></a>00278 <span class="comment">// Schedule the next run unconditionally to avoid code duplication on the</span>
<a name="l00279"></a>00279 <span class="comment">// allPluginsLoaded() signal's handling. This has the added benefit that</span>
<a name="l00280"></a>00280 <span class="comment">// the signal is delayed one event loop, so the accounts are more likely</span>
<a name="l00281"></a>00281 <span class="comment">// to be instantiated.</span>
<a name="l00282"></a>00282 QTimer::singleShot( 0, <span class="keyword">this</span>, SLOT( slotLoadNextPlugin() ) );
<a name="l00283"></a>00283 }
<a name="l00284"></a>00284
<a name="l00285"></a>00285 Plugin*
<a name="l00286"></a>00286 PluginManager::loadPlugin( <span class="keyword">const</span> QString &pluginId,
<a name="l00287"></a>00287 PluginLoadMode mode <span class="comment">/* = LoadSync */</span> )
<a name="l00288"></a>00288 {
<a name="l00289"></a>00289 <span class="keywordflow">if</span> ( mode == LoadSync ) {
<a name="l00290"></a>00290 <span class="keywordflow">return</span> loadPluginInternal( pluginId );
<a name="l00291"></a>00291 } <span class="keywordflow">else</span> {
<a name="l00292"></a>00292 d->pluginsToLoad.push( pluginId );
<a name="l00293"></a>00293 QTimer::singleShot( 0, <span class="keyword">this</span>, SLOT( slotLoadNextPlugin() ) );
<a name="l00294"></a>00294 <span class="keywordflow">return</span> 0;
<a name="l00295"></a>00295 }
<a name="l00296"></a>00296 }
<a name="l00297"></a>00297
<a name="l00298"></a>00298 Plugin*
<a name="l00299"></a>00299 PluginManager::loadPluginInternal( <span class="keyword">const</span> QString &pluginId )
<a name="l00300"></a>00300 {
<a name="l00301"></a>00301 KPluginInfo* info = infoForPluginId( pluginId );
<a name="l00302"></a>00302 <span class="keywordflow">if</span> ( !info ) {
<a name="l00303"></a>00303 kdWarning() << k_funcinfo << <span class="stringliteral">"Unable to find a plugin named '"</span>
<a name="l00304"></a>00304 << pluginId << <span class="stringliteral">"'!"</span> << endl;
<a name="l00305"></a>00305 <span class="keywordflow">return</span> 0;
<a name="l00306"></a>00306 }
<a name="l00307"></a>00307
<a name="l00308"></a>00308 <span class="keywordflow">if</span> ( d->loadedPlugins.contains( info ) )
<a name="l00309"></a>00309 <span class="keywordflow">return</span> d->loadedPlugins[ info ];
<a name="l00310"></a>00310
<a name="l00311"></a>00311 <span class="keywordtype">int</span> error = 0;
<a name="l00312"></a>00312 Plugin *plugin = KParts::ComponentFactory::createInstanceFromQuery<Komposer::Plugin>(
<a name="l00313"></a>00313 QString::fromLatin1( <span class="stringliteral">"Komposer/Plugin"</span> ),
<a name="l00314"></a>00314 QString::fromLatin1( <span class="stringliteral">"[X-KDE-PluginInfo-Name]=='%1'"</span> ).arg( pluginId ),
<a name="l00315"></a>00315 <span class="keyword">this</span>, 0, QStringList(), &error );
<a name="l00316"></a>00316
<a name="l00317"></a>00317 <span class="keywordflow">if</span> ( plugin ) {
<a name="l00318"></a>00318 d->loadedPlugins.insert( info, plugin );
<a name="l00319"></a>00319 info->setPluginEnabled( <span class="keyword">true</span> );
<a name="l00320"></a>00320
<a name="l00321"></a>00321 connect( plugin, SIGNAL(destroyed(QObject*)),
<a name="l00322"></a>00322 <span class="keyword">this</span>, SLOT(slotPluginDestroyed(QObject*)) );
<a name="l00323"></a>00323 connect( plugin, SIGNAL(readyForUnload()),
<a name="l00324"></a>00324 <span class="keyword">this</span>, SLOT(slotPluginReadyForUnload()) );
<a name="l00325"></a>00325
<a name="l00326"></a>00326 kdDebug() << k_funcinfo << <span class="stringliteral">"Successfully loaded plugin '"</span>
<a name="l00327"></a>00327 << pluginId << <span class="stringliteral">"'"</span> << endl;
<a name="l00328"></a>00328
<a name="l00329"></a>00329 emit pluginLoaded( plugin );
<a name="l00330"></a>00330 } <span class="keywordflow">else</span> {
<a name="l00331"></a>00331 <span class="keywordflow">switch</span> ( error ) {
<a name="l00332"></a>00332 <span class="keywordflow">case</span> KParts::ComponentFactory::ErrNoServiceFound:
<a name="l00333"></a>00333 kdDebug() << k_funcinfo << <span class="stringliteral">"No service implementing the given mimetype "</span>
<a name="l00334"></a>00334 << <span class="stringliteral">"and fullfilling the given constraint expression can be found."</span>
<a name="l00335"></a>00335 << endl;
<a name="l00336"></a>00336 <span class="keywordflow">break</span>;
<a name="l00337"></a>00337
<a name="l00338"></a>00338 <span class="keywordflow">case</span> KParts::ComponentFactory::ErrServiceProvidesNoLibrary:
<a name="l00339"></a>00339 kdDebug() << <span class="stringliteral">"the specified service provides no shared library."</span> << endl;
<a name="l00340"></a>00340 <span class="keywordflow">break</span>;
<a name="l00341"></a>00341
<a name="l00342"></a>00342 <span class="keywordflow">case</span> KParts::ComponentFactory::ErrNoLibrary:
<a name="l00343"></a>00343 kdDebug() << <span class="stringliteral">"the specified library could not be loaded."</span> << endl;
<a name="l00344"></a>00344 <span class="keywordflow">break</span>;
<a name="l00345"></a>00345
<a name="l00346"></a>00346 <span class="keywordflow">case</span> KParts::ComponentFactory::ErrNoFactory:
<a name="l00347"></a>00347 kdDebug() << <span class="stringliteral">"the library does not export a factory for creating components."</span>
<a name="l00348"></a>00348 << endl;
<a name="l00349"></a>00349 <span class="keywordflow">break</span>;
<a name="l00350"></a>00350
<a name="l00351"></a>00351 <span class="keywordflow">case</span> KParts::ComponentFactory::ErrNoComponent:
<a name="l00352"></a>00352 kdDebug() << <span class="stringliteral">"the factory does not support creating components "</span>
<a name="l00353"></a>00353 << <span class="stringliteral">"of the specified type."</span>
<a name="l00354"></a>00354 << endl;
<a name="l00355"></a>00355 <span class="keywordflow">break</span>;
<a name="l00356"></a>00356 }
<a name="l00357"></a>00357
<a name="l00358"></a>00358 kdDebug() << k_funcinfo << <span class="stringliteral">"Loading plugin '"</span> << pluginId
<a name="l00359"></a>00359 << <span class="stringliteral">"' failed, KLibLoader reported error: '"</span>
<a name="l00360"></a>00360 << KLibLoader::self()->lastErrorMessage()
<a name="l00361"></a>00361 << <span class="stringliteral">"'"</span> << endl;
<a name="l00362"></a>00362 }
<a name="l00363"></a>00363
<a name="l00364"></a>00364 <span class="keywordflow">return</span> plugin;
<a name="l00365"></a>00365 }
<a name="l00366"></a>00366
<a name="l00367"></a>00367 <span class="keywordtype">bool</span>
<a name="l00368"></a>00368 PluginManager::unloadPlugin( <span class="keyword">const</span> QString &spec )
<a name="l00369"></a>00369 {
<a name="l00370"></a>00370 QMap<KPluginInfo*, Plugin*>::ConstIterator it;
<a name="l00371"></a>00371 <span class="keywordflow">for</span> ( it = d->loadedPlugins.begin(); it != d->loadedPlugins.end(); ++it )
<a name="l00372"></a>00372 {
<a name="l00373"></a>00373 <span class="keywordflow">if</span> ( it.key()->pluginName() == spec )
<a name="l00374"></a>00374 {
<a name="l00375"></a>00375 it.data()->aboutToUnload();
<a name="l00376"></a>00376 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00377"></a>00377 }
<a name="l00378"></a>00378 }
<a name="l00379"></a>00379
<a name="l00380"></a>00380 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00381"></a>00381 }
<a name="l00382"></a>00382
<a name="l00383"></a>00383 <span class="keywordtype">void</span>
<a name="l00384"></a>00384 PluginManager::slotPluginDestroyed( QObject *plugin )
<a name="l00385"></a>00385 {
<a name="l00386"></a>00386 QMap<KPluginInfo*, Plugin*>::Iterator it;
<a name="l00387"></a>00387 <span class="keywordflow">for</span> ( it = d->loadedPlugins.begin(); it != d->loadedPlugins.end(); ++it )
<a name="l00388"></a>00388 {
<a name="l00389"></a>00389 <span class="keywordflow">if</span> ( it.data() == plugin )
<a name="l00390"></a>00390 {
<a name="l00391"></a>00391 d->loadedPlugins.erase( it );
<a name="l00392"></a>00392 <span class="keywordflow">break</span>;
<a name="l00393"></a>00393 }
<a name="l00394"></a>00394 }
<a name="l00395"></a>00395
<a name="l00396"></a>00396 <span class="keywordflow">if</span> ( d->shutdownMode == Private::ShuttingDown && d->loadedPlugins.isEmpty() )
<a name="l00397"></a>00397 {
<a name="l00398"></a>00398 <span class="comment">// Use a timer to make sure any pending deleteLater() calls have</span>
<a name="l00399"></a>00399 <span class="comment">// been handled first</span>
<a name="l00400"></a>00400 QTimer::singleShot( 0, <span class="keyword">this</span>, SLOT(slotShutdownDone()) );
<a name="l00401"></a>00401 }
<a name="l00402"></a>00402 }
<a name="l00403"></a>00403
<a name="l00404"></a>00404 Plugin*
<a name="l00405"></a>00405 PluginManager::plugin( <span class="keyword">const</span> QString &pluginId )<span class="keyword"> const</span>
<a name="l00406"></a>00406 <span class="keyword"></span>{
<a name="l00407"></a>00407 KPluginInfo *info = infoForPluginId( pluginId );
<a name="l00408"></a>00408 <span class="keywordflow">if</span> ( !info )
<a name="l00409"></a>00409 <span class="keywordflow">return</span> 0;
<a name="l00410"></a>00410
<a name="l00411"></a>00411 <span class="keywordflow">if</span> ( d->loadedPlugins.contains( info ) )
<a name="l00412"></a>00412 <span class="keywordflow">return</span> d->loadedPlugins[ info ];
<a name="l00413"></a>00413 <span class="keywordflow">else</span>
<a name="l00414"></a>00414 <span class="keywordflow">return</span> 0;
<a name="l00415"></a>00415 }
<a name="l00416"></a>00416
<a name="l00417"></a>00417 QString
<a name="l00418"></a>00418 PluginManager::pluginName( <span class="keyword">const</span> Plugin *plugin )<span class="keyword"> const</span>
<a name="l00419"></a>00419 <span class="keyword"></span>{
<a name="l00420"></a>00420 QMap<KPluginInfo*, Plugin*>::ConstIterator it;
<a name="l00421"></a>00421 <span class="keywordflow">for</span> ( it = d->loadedPlugins.begin(); it != d->loadedPlugins.end(); ++it )
<a name="l00422"></a>00422 {
<a name="l00423"></a>00423 <span class="keywordflow">if</span> ( it.data() == plugin )
<a name="l00424"></a>00424 <span class="keywordflow">return</span> it.key()->name();
<a name="l00425"></a>00425 }
<a name="l00426"></a>00426
<a name="l00427"></a>00427 <span class="keywordflow">return</span> QString::fromLatin1( <span class="stringliteral">"Unknown"</span> );
<a name="l00428"></a>00428 }
<a name="l00429"></a>00429
<a name="l00430"></a>00430 QString
<a name="l00431"></a>00431 PluginManager::pluginId( <span class="keyword">const</span> Plugin *plugin )<span class="keyword"> const</span>
<a name="l00432"></a>00432 <span class="keyword"></span>{
<a name="l00433"></a>00433 QMap<KPluginInfo*, Plugin*>::ConstIterator it;
<a name="l00434"></a>00434 <span class="keywordflow">for</span> ( it = d->loadedPlugins.begin(); it != d->loadedPlugins.end(); ++it )
<a name="l00435"></a>00435 {
<a name="l00436"></a>00436 <span class="keywordflow">if</span> ( it.data() == plugin )
<a name="l00437"></a>00437 <span class="keywordflow">return</span> it.key()->pluginName();
<a name="l00438"></a>00438 }
<a name="l00439"></a>00439
<a name="l00440"></a>00440 <span class="keywordflow">return</span> QString::fromLatin1( <span class="stringliteral">"unknown"</span> );
<a name="l00441"></a>00441 }
<a name="l00442"></a>00442
<a name="l00443"></a>00443 QString
<a name="l00444"></a>00444 PluginManager::pluginIcon( <span class="keyword">const</span> Plugin *plugin )<span class="keyword"> const</span>
<a name="l00445"></a>00445 <span class="keyword"></span>{
<a name="l00446"></a>00446 QMap<KPluginInfo*, Plugin*>::ConstIterator it;
<a name="l00447"></a>00447 <span class="keywordflow">for</span> ( it = d->loadedPlugins.begin(); it != d->loadedPlugins.end(); ++it )
<a name="l00448"></a>00448 {
<a name="l00449"></a>00449 <span class="keywordflow">if</span> ( it.data() == plugin )
<a name="l00450"></a>00450 <span class="keywordflow">return</span> it.key()->icon();
<a name="l00451"></a>00451 }
<a name="l00452"></a>00452
<a name="l00453"></a>00453 <span class="keywordflow">return</span> QString::fromLatin1( <span class="stringliteral">"Unknown"</span> );
<a name="l00454"></a>00454 }
<a name="l00455"></a>00455
<a name="l00456"></a>00456 KPluginInfo*
<a name="l00457"></a>00457 PluginManager::infoForPluginId( <span class="keyword">const</span> QString &pluginId )<span class="keyword"> const</span>
<a name="l00458"></a>00458 <span class="keyword"></span>{
<a name="l00459"></a>00459 QValueList<KPluginInfo*>::ConstIterator it;
<a name="l00460"></a>00460 <span class="keywordflow">for</span> ( it = d->plugins.begin(); it != d->plugins.end(); ++it )
<a name="l00461"></a>00461 {
<a name="l00462"></a>00462 <span class="keywordflow">if</span> ( ( *it )->pluginName() == pluginId )
<a name="l00463"></a>00463 <span class="keywordflow">return</span> *it;
<a name="l00464"></a>00464 }
<a name="l00465"></a>00465
<a name="l00466"></a>00466 <span class="keywordflow">return</span> 0;
<a name="l00467"></a>00467 }
<a name="l00468"></a>00468
<a name="l00469"></a>00469 <span class="keywordtype">bool</span>
<a name="l00470"></a>00470 PluginManager::setPluginEnabled( <span class="keyword">const</span> QString &pluginId, <span class="keywordtype">bool</span> enabled <span class="comment">/* = true */</span> )
<a name="l00471"></a>00471 {
<a name="l00472"></a>00472 <span class="keywordflow">if</span> ( !d->config )
<a name="l00473"></a>00473 d->config = KSharedConfig::openConfig( <span class="stringliteral">"komposerrc"</span> );
<a name="l00474"></a>00474
<a name="l00475"></a>00475 d->config->setGroup( <span class="stringliteral">"Plugins"</span> );
<a name="l00476"></a>00476
<a name="l00477"></a>00477
<a name="l00478"></a>00478 <span class="keywordflow">if</span> ( !infoForPluginId( pluginId ) )
<a name="l00479"></a>00479 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00480"></a>00480
<a name="l00481"></a>00481 d->config->writeEntry( pluginId + QString::fromLatin1( <span class="stringliteral">"Enabled"</span> ), enabled );
<a name="l00482"></a>00482 d->config->sync();
<a name="l00483"></a>00483
<a name="l00484"></a>00484 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00485"></a>00485 }
<a name="l00486"></a>00486
<a name="l00487"></a>00487 }
<a name="l00488"></a>00488
<a name="l00489"></a>00489 <span class="preprocessor">#include "pluginmanager.moc"</span>
</pre></div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>libkdepim</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classActionBase.html">actionbase</option>, <option value="classActionEditWidget.html">actioneditwidget</option>, <option value="classAlarmClient.html">alarmclient</option>, <option value="classConditionEditWidget.html">conditioneditwidget</option>, <option value="classGroupItem.html">groupitem</option>, <option value="classKABC_1_1ResourceNull.html">kabc::resourcenull</option>, <option value="classKConfigWizard.html">kconfigwizard</option>, <option value="classKDateEdit.html">kdateedit</option>, <option value="classKDatePickerPopup.html">kdatepickerpopup</option>, <option value="classKIncidenceChooser.html">kincidencechooser</option>, <option value="classKomposer_1_1Core.html">komposer::core</option>, <option value="classKomposer_1_1KomposerIface.html">komposer::komposeriface</option>, <option value="classKParts_1_1InfoExtension.html">kparts::infoextension</option>, <option value="classKParts_1_1SideBarExtension.html">kparts::sidebarextension</option>, <option value="classKPartsGenericPart.html">kpartsgenericpart</option>, <option value="classKPartsWidgetPlugin.html">kpartswidgetplugin</option>, <option value="classKPIM_1_1BroadcastStatus.html">kpim::broadcaststatus</option>, <option value="classKPIM_1_1ClickLineEdit.html">kpim::clicklineedit</option>, <option value="classKPIM_1_1CollectingProcess.html">kpim::collectingprocess</option>, <option value="classKPIM_1_1ConfigManager.html">kpim::configmanager</option>, <option value="classKPIM_1_1DiffAlgoDisplay.html">kpim::diffalgodisplay</option>, <option value="classKPIM_1_1DistributionList.html">kpim::distributionlist</option>, <option value="classKPIM_1_1KMailCompletion.html">kpim::kmailcompletion</option>, <option value="classKPIM_1_1KPixmapRegionSelectorDialog.html">kpim::kpixmapregionselectordialog</option>, <option value="classKPIM_1_1KPixmapRegionSelectorWidget.html">kpim::kpixmapregionselectorwidget</option>, <option value="classKPIM_1_1LdapClient.html">kpim::ldapclient</option>, <option value="classKPIM_1_1LdapObject.html">kpim::ldapobject</option>, <option value="classKPIM_1_1LdapSearch.html">kpim::ldapsearch</option>, <option value="classKPIM_1_1OverlayWidget.html">kpim::overlaywidget</option>, <option value="classKPIM_1_1PluginLoader.html">kpim::pluginloader</option>, <option value="classKPIM_1_1ProgressManager.html">kpim::progressmanager</option>, <option value="classKPIM_1_1ResourceABC.html">kpim::resourceabc</option>, <option value="classKPIM_1_1SelectionItem.html">kpim::selectionitem</option>, <option value="classKPIM_1_1ThreadWeaver_1_1Event.html">kpim::threadweaver::event</option>, <option value="classKPIM_1_1ThreadWeaver_1_1Job.html">kpim::threadweaver::job</option>, <option value="classKPIM_1_1ThreadWeaver_1_1Thread.html">kpim::threadweaver::thread</option>, <option value="classKPIM_1_1ThreadWeaver_1_1Weaver.html">kpim::threadweaver::weaver</option>, <option value="classKPIM_1_1ThreadWeaver_1_1WeaverExtension.html">kpim::threadweaver::weaverextension</option>, <option value="classKPIM_1_1ThreadWeaver_1_1WeaverThreadLogger.html">kpim::threadweaver::weaverthreadlogger</option>, <option value="classKPrefsDialog.html">kprefsdialog</option>, <option value="classKPrefsWid.html">kprefswid</option>, <option value="classKPrefsWidBool.html">kprefswidbool</option>, <option value="classKPrefsWidColor.html">kprefswidcolor</option>, <option value="classKPrefsWidCombo.html">kprefswidcombo</option>, <option value="classKPrefsWidDate.html">kprefswiddate</option>, <option value="classKPrefsWidDuration.html">kprefswidduration</option>, <option value="classKPrefsWidFont.html">kprefswidfont</option>, <option value="classKPrefsWidInt.html">kprefswidint</option>, <option value="classKPrefsWidManager.html">kprefswidmanager</option>, <option value="classKPrefsWidPath.html">kprefswidpath</option>, <option value="classKPrefsWidRadios.html">kprefswidradios</option>, <option value="classKPrefsWidString.html">kprefswidstring</option>, <option value="classKPrefsWidTime.html">kprefswidtime</option>, <option value="classKRecentAddress_1_1RecentAddresses.html">krecentaddress::recentaddresses</option>, <option value="classKRegExp3.html">kregexp3</option>, <option value="classKResourcePrefs.html">kresourceprefs</option>, <option value="classKRSqueezedTextLabel.html">krsqueezedtextlabel</option>, <option value="classKSubscription.html">ksubscription</option>, <option value="classKTimeEdit.html">ktimeedit</option>, <option value="classKVCardDrag.html">kvcarddrag</option>, <option value="classKWidgetLister.html">kwidgetlister</option>, <option value="classLinkLocator.html">linklocator</option>, <option value="classQStrictUtf7Codec.html">qstrictutf7codec</option>, <option value="classQUtf7Codec.html">qutf7codec</option>, <option value="classRuleEditWidget.html">ruleeditwidget</option>, <option value="classRuleListWidget.html">rulelistwidget</option>, <option value="classRuleStack.html">rulestack</option>, <option value="classScorableGroup.html">scorablegroup</option>, <option value="classSingleActionWidget.html">singleactionwidget</option>, <option value="classSingleConditionWidget.html">singleconditionwidget</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
