<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csutil/plugmgr.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<h1>csutil/plugmgr.h</h1><a href="plugmgr_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 1998-2001 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_PLUGMGR_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_PLUGMGR_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="parray_8h.html" title="Pointer Array.">csutil/parray.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="scf_8h.html" title="Crystal Space Shared Class Facility (SCF).">csutil/scf.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="mutex_8h.html" title="Mutual-exclusion object.">csutil/threading/mutex.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="plugin_8h.html" title="Plugin manager interface.">iutil/plugin.h</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="pluginconfig_8h.html" title="Configurator interface.">iutil/pluginconfig.h</a>"</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiComponent.html" title="This interface describes a generic component in Crystal Space.">iComponent</a>;
<a name="l00035"></a>00035 <span class="keyword">struct </span><a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>;
<a name="l00036"></a>00036
<a name="l00041"></a><a class="code" href="classcsPluginManager.html">00041</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsPluginManager.html" title="This is the standard implementation of the plugin manager.">csPluginManager</a> :
<a name="l00042"></a>00042 <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a><csPluginManager, iPluginManager>
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044 <span class="keyword">private</span>:
<a name="l00046"></a>00046 <a class="code" href="classCS_1_1Threading_1_1MutexImpl.html" title="General mutex class.">CS::Threading::RecursiveMutex</a> mutex;
<a name="l00047"></a>00047
<a name="l00051"></a>00051 <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT csPlugin
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="keyword">public</span>:
<a name="l00055"></a>00055 <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iComponent></a> Plugin;
<a name="l00057"></a>00057 <span class="keywordtype">char</span> *ClassID;
<a name="l00058"></a>00058
<a name="l00060"></a>00060 csPlugin (<a class="code" href="structiComponent.html" title="This interface describes a generic component in Crystal Space.">iComponent</a> *<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>, <span class="keyword">const</span> <span class="keywordtype">char</span> *iClassID);
<a name="l00062"></a>00062 <span class="keyword">virtual</span> ~csPlugin ();
<a name="l00063"></a>00063 };
<a name="l00064"></a>00064
<a name="l00068"></a>00068 <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT csPluginsVector : <span class="keyword">public</span> <a class="code" href="classcsPDelArray.html" title="An array of pointers.">csPDelArray</a><csPlugin>
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 <span class="keyword">public</span>:
<a name="l00072"></a>00072 csPluginsVector (<span class="keywordtype">int</span> l, <span class="keywordtype">int</span> d) : <a class="code" href="classcsPDelArray.html" title="An array of pointers.">csPDelArray<csPlugin></a> (l, d) {}
<a name="l00074"></a>00074 <span class="keyword">static</span> <span class="keywordtype">int</span> CompareAddress (csPlugin* <span class="keyword">const</span>& Item, <a class="code" href="structiComponent.html" title="This interface describes a generic component in Crystal Space.">iComponent</a>* <span class="keyword">const</span>& Key)
<a name="l00075"></a>00075 { <span class="keywordflow">return</span> Item->Plugin == Key ? 0 : 1; }
<a name="l00076"></a>00076 };
<a name="l00077"></a>00077
<a name="l00081"></a>00081 <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT csPluginOption
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 <span class="keyword">public</span>:
<a name="l00084"></a>00084 <span class="keywordtype">char</span> *Name;
<a name="l00085"></a>00085 <a class="code" href="group__util.html#g91624a433f78618fba6823a5d79bdb52" title="Types that can be contained within a variant.">csVariantType</a> Type;
<a name="l00086"></a>00086 <span class="keywordtype">int</span> ID;
<a name="l00087"></a>00087 <span class="keywordtype">bool</span> Value; <span class="comment">// If Type is CSVAR_BOOL</span>
<a name="l00088"></a>00088 <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iPluginConfig></a> Config;
<a name="l00089"></a>00089
<a name="l00090"></a>00090 csPluginOption (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName, <a class="code" href="group__util.html#g91624a433f78618fba6823a5d79bdb52" title="Types that can be contained within a variant.">csVariantType</a> iType, <span class="keywordtype">int</span> iID,
<a name="l00091"></a>00091 <span class="keywordtype">bool</span> iValue, <a class="code" href="structiPluginConfig.html" title="Interface to a configurator object.">iPluginConfig</a>* cfg)
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093 Name = <a class="code" href="group__util.html#gc3a6e34ea28a22fdeda8802c872ce2d0" title="Allocate a new char [] and copy the string into the newly allocated storage.">csStrNew</a> (iName);
<a name="l00094"></a>00094 Type = iType;
<a name="l00095"></a>00095 ID = iID;
<a name="l00096"></a>00096 Value = iValue;
<a name="l00097"></a>00097 Config = cfg;
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099 <span class="keyword">virtual</span> ~csPluginOption ()
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 <span class="keyword">delete</span> [] Name;
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104
<a name="l00106"></a>00106 <a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>* object_reg;
<a name="l00107"></a>00107
<a name="l00109"></a>00109 csPluginsVector Plugins;
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="comment">// List of all options for all plug-in modules.</span>
<a name="l00112"></a>00112 <a class="code" href="classcsPDelArray.html" title="An array of pointers.">csPDelArray<csPluginOption></a> OptionList;
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keyword">public</span>:
<a name="l00116"></a>00116 <a class="code" href="classcsPluginManager.html" title="This is the standard implementation of the plugin manager.">csPluginManager</a> (<a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>* object_reg);
<a name="l00118"></a>00118 <span class="keyword">virtual</span> ~<a class="code" href="classcsPluginManager.html" title="This is the standard implementation of the plugin manager.">csPluginManager</a> ();
<a name="l00119"></a>00119
<a name="l00121"></a>00121 <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a> *LoadPlugin (<span class="keyword">const</span> <span class="keywordtype">char</span> *iClassID, <span class="keywordtype">bool</span> init = <span class="keyword">true</span>);
<a name="l00122"></a>00122
<a name="l00126"></a>00126 <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a> *QueryPlugin (<span class="keyword">const</span> <span class="keywordtype">char</span> *iInterface, <span class="keywordtype">int</span> iVersion);
<a name="l00128"></a>00128 <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a> *QueryPlugin (<span class="keyword">const</span> <span class="keywordtype">char</span>* iClassID,
<a name="l00129"></a>00129 <span class="keyword">const</span> <span class="keywordtype">char</span> *iInterface, <span class="keywordtype">int</span> iVersion);
<a name="l00131"></a>00131 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> UnloadPlugin (<a class="code" href="structiComponent.html" title="This interface describes a generic component in Crystal Space.">iComponent</a> *<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>);
<a name="l00133"></a>00133 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> RegisterPlugin (<span class="keyword">const</span> <span class="keywordtype">char</span> *iClassID,
<a name="l00134"></a>00134 <a class="code" href="structiComponent.html" title="This interface describes a generic component in Crystal Space.">iComponent</a> *iObject);
<a name="l00136"></a>00136 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iPluginIterator></a> GetPlugins ();
<a name="l00138"></a>00138 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Clear ();
<a name="l00139"></a>00139
<a name="l00141"></a>00141 <span class="keyword">virtual</span> <span class="keywordtype">void</span> QueryOptions (<a class="code" href="structiComponent.html" title="This interface describes a generic component in Crystal Space.">iComponent</a> *iObject);
<a name="l00142"></a>00142 };
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="preprocessor">#endif // __CS_PLUGMGR_H__</span>
<a name="l00145"></a>00145 <span class="preprocessor"></span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2138
