<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>kwin/lib Library: kdecoration_plugins_p.cpp Source File (kwin/lib Library)</title>
<link href="../../common/doxygen.css" rel="stylesheet" type="text/css">
</head>
<div class="header">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td rowspan="2" width="92">
<a href="../../index.html" title="The API documentation main page"><img src="../../common/docheadergears.png" style="border:0px;" alt=""></a>
</td>
<td width="95%">
<h1>kwin/lib Library API Documentation</h1>
</td>
</tr>
<tr>
<td valign="bottom">
<table class="links" border=0 cellspacing=0>
<tr>
<td><a href="index.html">Overview</a></td>
<td><a href="hierarchy.html" title="Inheritance list, sorted roughly alphabetically">Class Hierarchy</a></td>
<td><a href="classes.html" title="Alphabetical list of classes">Classes</a></td>
<td><a href="annotated.html" title="Classes, structs, unions and interfaces with brief descriptions">Classes (annotated)</a></td>
<td><a href="functions.html" title="Documented class members with links to the classes they belong to">Members</a></td>
<td><a href="namespaces.html" title="All documented namespaces with brief descriptions">Namespaces</a></td>
<td><a href="files.html" title="A list of all documented files with brief descriptions">Source Files</a></td>
</tr>
</table>
</td></tr></table>
</div>
<div id="hgrad"></div>
<div class="text">
<!-- Generated by Doxygen 1.4.4 -->
<h1>kdecoration_plugins_p.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*****************************************************************</span>
<a name="l00002"></a>00002 <span class="comment">This file is part of the KDE project.</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">Copyright (C) 1999, 2000 Daniel M. Duley <mosfet@kde.org></span>
<a name="l00005"></a>00005 <span class="comment">Copyright (C) 2003 Lubos Lunak <l.lunak@kde.org></span>
<a name="l00006"></a>00006 <span class="comment"></span>
<a name="l00007"></a>00007 <span class="comment">Permission is hereby granted, free of charge, to any person obtaining a</span>
<a name="l00008"></a>00008 <span class="comment">copy of this software and associated documentation files (the "Software"),</span>
<a name="l00009"></a>00009 <span class="comment">to deal in the Software without restriction, including without limitation</span>
<a name="l00010"></a>00010 <span class="comment">the rights to use, copy, modify, merge, publish, distribute, sublicense,</span>
<a name="l00011"></a>00011 <span class="comment">and/or sell copies of the Software, and to permit persons to whom the</span>
<a name="l00012"></a>00012 <span class="comment">Software is furnished to do so, subject to the following conditions:</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">The above copyright notice and this permission notice shall be included in</span>
<a name="l00015"></a>00015 <span class="comment">all copies or substantial portions of the Software.</span>
<a name="l00016"></a>00016 <span class="comment"></span>
<a name="l00017"></a>00017 <span class="comment">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00018"></a>00018 <span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00019"></a>00019 <span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL</span>
<a name="l00020"></a>00020 <span class="comment">THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00021"></a>00021 <span class="comment">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
<a name="l00022"></a>00022 <span class="comment">FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span>
<a name="l00023"></a>00023 <span class="comment">DEALINGS IN THE SOFTWARE.</span>
<a name="l00024"></a>00024 <span class="comment">******************************************************************/</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#include "kdecoration_plugins_p.h"</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#include <kconfig.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <kdebug.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <klocale.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <klibloader.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <assert.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="preprocessor">#include <qdir.h></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <qfile.h></span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor">#include "kdecorationfactory.h"</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 KDecorationPlugins::KDecorationPlugins( KConfig* cfg )
<a name="l00040"></a>00040 : create_ptr( NULL ),
<a name="l00041"></a>00041 library( NULL ),
<a name="l00042"></a>00042 fact( NULL ),
<a name="l00043"></a>00043 old_library( NULL ),
<a name="l00044"></a>00044 old_fact( NULL ),
<a name="l00045"></a>00045 pluginStr( <span class="stringliteral">"kwin3_undefined "</span> ),
<a name="l00046"></a>00046 config( cfg )
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 }
<a name="l00049"></a>00049
<a name="l00050"></a>00050 KDecorationPlugins::~KDecorationPlugins()
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052 <span class="keywordflow">if</span>(library)
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 assert( fact != NULL );
<a name="l00055"></a>00055 <span class="keyword">delete</span> fact;
<a name="l00056"></a>00056 library->unload();
<a name="l00057"></a>00057 }
<a name="l00058"></a>00058 <span class="keywordflow">if</span>(old_library)
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 assert( old_fact != NULL );
<a name="l00061"></a>00061 <span class="keyword">delete</span> old_fact;
<a name="l00062"></a>00062 old_library->unload();
<a name="l00063"></a>00063 }
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keywordtype">bool</span> KDecorationPlugins::reset( <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> changed )
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068 QString oldPlugin = pluginStr;
<a name="l00069"></a>00069 config->reparseConfiguration();
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> ret = <span class="keyword">false</span>;
<a name="l00071"></a>00071 <span class="keywordflow">if</span>(( !loadPlugin( <span class="stringliteral">""</span> ) && library ) <span class="comment">// "" = read the one in cfg file</span>
<a name="l00072"></a>00072 || oldPlugin == pluginStr )
<a name="l00073"></a>00073 { <span class="comment">// no new plugin loaded, reset the old one</span>
<a name="l00074"></a>00074 assert( fact != NULL );
<a name="l00075"></a>00075 ret = fact->reset( changed );
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077 <span class="keywordflow">return</span> ret || oldPlugin != pluginStr;
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>* KDecorationPlugins::factory()
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 <span class="keywordflow">return</span> fact;
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment">// convenience</span>
<a name="l00086"></a>00086 <a class="code" href="classKDecoration.html">KDecoration</a>* KDecorationPlugins::createDecoration( KDecorationBridge* bridge )
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088 <span class="keywordflow">if</span>( fact != NULL )
<a name="l00089"></a>00089 <span class="keywordflow">return</span> fact->createDecoration( bridge );
<a name="l00090"></a>00090 <span class="keywordflow">return</span> NULL;
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="comment">// returns true if plugin was loaded successfully</span>
<a name="l00094"></a>00094 <span class="keywordtype">bool</span> KDecorationPlugins::loadPlugin( QString nameStr )
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096 <span class="keywordflow">if</span>( nameStr.isEmpty())
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 KConfigGroupSaver saver( config, <span class="stringliteral">"Style"</span> );
<a name="l00099"></a>00099 nameStr = config->readEntry(<span class="stringliteral">"PluginLib"</span>, defaultPlugin );
<a name="l00100"></a>00100 }
<a name="l00101"></a>00101 <span class="comment">// make sure people can switch between HEAD and kwin_iii branch</span>
<a name="l00102"></a>00102 <span class="keywordflow">if</span>( nameStr.startsWith( <span class="stringliteral">"kwin_"</span> ))
<a name="l00103"></a>00103 nameStr = <span class="stringliteral">"kwin3_"</span> + nameStr.mid( 5 );
<a name="l00104"></a>00104
<a name="l00105"></a>00105 KLibrary *oldLibrary = library;
<a name="l00106"></a>00106 <a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>* oldFactory = fact;
<a name="l00107"></a>00107
<a name="l00108"></a>00108 QString path = KLibLoader::findLibrary(QFile::encodeName(nameStr));
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="comment">// If the plugin was not found, try to find the default</span>
<a name="l00111"></a>00111 <span class="keywordflow">if</span> (path.isEmpty())
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113 nameStr = defaultPlugin;
<a name="l00114"></a>00114 path = KLibLoader::findLibrary(QFile::encodeName(nameStr));
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment">// If no library was found, exit kwin with an error message</span>
<a name="l00118"></a>00118 <span class="keywordflow">if</span> (path.isEmpty())
<a name="l00119"></a>00119 {
<a name="l00120"></a>00120 error( i18n(<span class="stringliteral">"No window decoration plugin library was found."</span> ));
<a name="l00121"></a>00121 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00122"></a>00122 }
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="comment">// Check if this library is not already loaded.</span>
<a name="l00125"></a>00125 <span class="keywordflow">if</span>(pluginStr == nameStr)
<a name="l00126"></a>00126 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="comment">// Try loading the requested plugin</span>
<a name="l00129"></a>00129 library = KLibLoader::self()->library(QFile::encodeName(path));
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">// If that fails, fall back to the default plugin</span>
<a name="l00132"></a>00132 <span class="keywordflow">if</span> (!library)
<a name="l00133"></a>00133 {
<a name="l00134"></a>00134 kdDebug() << <span class="stringliteral">" could not load library, try default plugin again"</span> << endl;
<a name="l00135"></a>00135 nameStr = defaultPlugin;
<a name="l00136"></a>00136 <span class="keywordflow">if</span> ( pluginStr == nameStr )
<a name="l00137"></a>00137 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00138"></a>00138 path = KLibLoader::findLibrary(QFile::encodeName(nameStr));
<a name="l00139"></a>00139 <span class="keywordflow">if</span> (!path.isEmpty())
<a name="l00140"></a>00140 library = KLibLoader::self()->library(QFile::encodeName(path));
<a name="l00141"></a>00141 }
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="keywordflow">if</span> (!library)
<a name="l00144"></a>00144 {
<a name="l00145"></a>00145 error( i18n(<span class="stringliteral">"The default decoration plugin is corrupt "</span>
<a name="l00146"></a>00146 <span class="stringliteral">"and could not be loaded."</span> ));
<a name="l00147"></a>00147 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00148"></a>00148 }
<a name="l00149"></a>00149
<a name="l00150"></a>00150 create_ptr = NULL;
<a name="l00151"></a>00151 <span class="keywordflow">if</span>( library->hasSymbol(<span class="stringliteral">"create_factory"</span>))
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 <span class="keywordtype">void</span>* create_func = library->symbol(<span class="stringliteral">"create_factory"</span>);
<a name="l00154"></a>00154 <span class="keywordflow">if</span>(create_func)
<a name="l00155"></a>00155 create_ptr = (<a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>* (*)())create_func;
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157 <span class="keywordflow">if</span>(!create_ptr)
<a name="l00158"></a>00158 {
<a name="l00159"></a>00159 error( i18n( <span class="stringliteral">"The library %1 is not a KWin plugin."</span> ).arg( path ));
<a name="l00160"></a>00160 library->unload();
<a name="l00161"></a>00161 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00162"></a>00162 }
<a name="l00163"></a>00163 fact = create_ptr();
<a name="l00164"></a>00164 fact->checkRequirements( <span class="keyword">this</span> ); <span class="comment">// let it check what is supported</span>
<a name="l00165"></a>00165
<a name="l00166"></a>00166 pluginStr = nameStr;
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="comment">// For clients in kdeartwork </span>
<a name="l00169"></a>00169 QString catalogue = nameStr;
<a name="l00170"></a>00170 catalogue.replace( <span class="stringliteral">"kwin3_"</span>, <span class="stringliteral">"kwin_"</span> );
<a name="l00171"></a>00171 KGlobal::locale()->insertCatalogue( catalogue );
<a name="l00172"></a>00172 <span class="comment">// For clients in kdebase</span>
<a name="l00173"></a>00173 KGlobal::locale()->insertCatalogue( <span class="stringliteral">"kwin_clients"</span> );
<a name="l00174"></a>00174 <span class="comment">// For clients in kdeartwork</span>
<a name="l00175"></a>00175 KGlobal::locale()->insertCatalogue( <span class="stringliteral">"kwin_art_clients"</span> );
<a name="l00176"></a>00176
<a name="l00177"></a>00177 old_library = oldLibrary; <span class="comment">// save for delayed destroying</span>
<a name="l00178"></a>00178 old_fact = oldFactory;
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00181"></a>00181 }
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="keywordtype">void</span> KDecorationPlugins::destroyPreviousPlugin()
<a name="l00184"></a>00184 {
<a name="l00185"></a>00185 <span class="comment">// Destroy the old plugin</span>
<a name="l00186"></a>00186 <span class="keywordflow">if</span>(old_library)
<a name="l00187"></a>00187 {
<a name="l00188"></a>00188 <span class="keyword">delete</span> old_fact;
<a name="l00189"></a>00189 old_fact = NULL;
<a name="l00190"></a>00190 old_library->unload();
<a name="l00191"></a>00191 old_library = NULL;
<a name="l00192"></a>00192 }
<a name="l00193"></a>00193 }
<a name="l00194"></a>00194
<a name="l00195"></a>00195 <span class="keywordtype">void</span> KDecorationPlugins::error( <span class="keyword">const</span> QString& )
<a name="l00196"></a>00196 {
<a name="l00197"></a>00197 }
</pre></div></div>
<div id="bottom-nav">
<img src="../../common/bottom2.png" align="right" height="59" width="227" alt="KDE Logo">
</div>
<div class="bottom">
This file is part of the documentation for kwin/lib Library Version 3.4.2.
</div>
<div class="bottom" style="color:#cccccc">
Documentation copyright © 1996-2004 the KDE developers.<br>
Generated on Wed Jun 14 19:07:27 2006 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.4.4 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2003
</div>
</body>
</html>
