doc/third_party/Pluma/html/PluginManager_8hpp_source.htm

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3     <head>
   4         <title>Pluma - Plug-in Management Framework</title>
   5         <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
   6         <link href="doxygen.css" rel="stylesheet" type="text/css" />
   7         <link href="tabs.css" rel="stylesheet" type="text/css" />
   8     </head>
   9     <body>
  10         <div id="logo">
  11             <img src="./logo.png" title="Pluma home" alt="Pluma logo" />
  12         </div>
  13 <!-- Generated by Doxygen 1.8.6 -->
  14   <div id="navrow1" class="tabs">
  15     <ul class="tablist">
  16       <li><a href="index.htm"><span>Main&#160;Page</span></a></li>
  17       <li><a href="annotated.htm"><span>Classes</span></a></li>
  18       <li class="current"><a href="files.htm"><span>Files</span></a></li>
  19     </ul>
  20   </div>
  21   <div id="navrow2" class="tabs2">
  22     <ul class="tablist">
  23       <li><a href="files.htm"><span>File&#160;List</span></a></li>
  24     </ul>
  25   </div>
  26 </div><!-- top -->
  27 <div class="header">
  28   <div class="headertitle">
  29 <div class="title">PluginManager.hpp</div>  </div>
  30 </div><!--header-->
  31 <div class="contents">
  32 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div>
  33 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// Pluma - Plug-in Management Framework</span></div>
  34 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// Copyright (C) 2010-2012 Gil Costa (gsaurus@gmail.com)</span></div>
  35 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">//</span></div>
  36 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// This software is provided &#39;as-is&#39;, without any express or implied warranty.</span></div>
  37 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
  38 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//</span></div>
  39 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
  40 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
  41 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">// subject to the following restrictions:</span></div>
  42 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">//</span></div>
  43 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
  44 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">//    you must not claim that you wrote the original software.</span></div>
  45 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">//    If you use this software in a product, an acknowledgment</span></div>
  46 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">//    in the product documentation would be appreciated but is not required.</span></div>
  47 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">//</span></div>
  48 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
  49 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">//    and must not be misrepresented as being the original software.</span></div>
  50 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">//</span></div>
  51 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
  52 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">//</span></div>
  53 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"></span></div>
  54 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#ifndef PLUMA_PLUGIN_MANAGER_HPP</span></div>
  55 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define PLUMA_PLUGIN_MANAGER_HPP</span></div>
  56 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor"></span></div>
  57 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">// Headers</span></div>
  58 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"></span><span class="preprocessor">#include &lt;Pluma/Config.hpp&gt;</span></div>
  59 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#include &lt;Pluma/Host.hpp&gt;</span></div>
  60 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
  61 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
  62 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
  63 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
  64 <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">namespace </span>pluma{</div>
  65 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="keyword">class </span>DLibrary;</div>
  66 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
  67 <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classpluma_1_1PluginManager.htm">   44</a></span>&#160;<span class="keyword">class </span>PLUMA_API <a class="code" href="classpluma_1_1PluginManager.htm">PluginManager</a>{</div>
  68 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
  69 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
  70 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="keyword">public</span>:</div>
  71 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div>
  72 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    ~<a class="code" href="classpluma_1_1PluginManager.htm">PluginManager</a>();</div>
  73 <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
  74 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <span class="keywordtype">bool</span> load(<span class="keyword">const</span> std::string&amp; path);</div>
  75 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div>
  76 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
  77 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    <span class="keywordtype">bool</span> load(<span class="keyword">const</span> std::string&amp; folder, <span class="keyword">const</span> std::string&amp; pluginName);</div>
  78 <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
  79 <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    <span class="keywordtype">int</span> loadFromFolder(<span class="keyword">const</span> std::string&amp; folder, <span class="keywordtype">bool</span> recursive = <span class="keyword">false</span>);</div>
  80 <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div>
  81 <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    <span class="keywordtype">bool</span> unload(<span class="keyword">const</span> std::string&amp; pluginName);</div>
  82 <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div>
  83 <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;    <span class="keywordtype">void</span> unloadAll();</div>
  84 <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;</div>
  85 <div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    <span class="keywordtype">bool</span> addProvider(<a class="code" href="classpluma_1_1Provider.htm">Provider</a>* provider);</div>
  86 <div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;</div>
  87 <div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;    <span class="keywordtype">void</span> getLoadedPlugins(std::vector&lt;const std::string*&gt;&amp; pluginNames) <span class="keyword">const</span>;</div>
  88 <div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;</div>
  89 <div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;    <span class="keywordtype">bool</span> isLoaded(<span class="keyword">const</span> std::string&amp; pluginName) <span class="keyword">const</span>;</div>
  90 <div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;</div>
  91 <div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;</div>
  92 <div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="keyword">protected</span>:</div>
  93 <div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;</div>
  94 <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    <a class="code" href="classpluma_1_1PluginManager.htm">PluginManager</a>();</div>
  95 <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;</div>
  96 <div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;    <span class="keywordtype">void</span> registerType(<span class="keyword">const</span> std::string&amp; type, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> version, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> lowestVersion);</div>
  97 <div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;</div>
  98 <div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;    <span class="keyword">const</span> std::list&lt;Provider*&gt;* getProviders(<span class="keyword">const</span> std::string&amp; type) <span class="keyword">const</span>;</div>
  99 <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;</div>
 100 <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;</div>
 101 <div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="keyword">private</span>:</div>
 102 <div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;</div>
 103 <div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;    <span class="keyword">static</span> std::string getPluginName(<span class="keyword">const</span> std::string&amp; path);</div>
 104 <div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;</div>
 105 <div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;    <span class="keyword">static</span> std::string resolvePathExtension(<span class="keyword">const</span> std::string&amp; path);</div>
 106 <div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;</div>
 107 <div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;</div>
 108 <div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="keyword">private</span>:</div>
 109 <div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;</div>
 110 <div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;    <span class="keyword">typedef</span> <span class="keywordtype">bool</span> fnRegisterPlugin(<a class="code" href="classpluma_1_1Host.htm">Host</a>&amp;);</div>
 111 <div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;    <span class="keyword">typedef</span> std::map&lt;std::string,DLibrary*&gt; LibMap;</div>
 112 <div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;</div>
 113 <div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;    LibMap libraries;   </div>
 114 <div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;    <a class="code" href="classpluma_1_1Host.htm">Host</a> host;          </div>
 115 <div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;</div>
 116 <div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;};</div>
 117 <div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;</div>
 118 <div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;}   <span class="comment">// namespace pluma</span></div>
 119 <div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;</div>
 120 <div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;<span class="preprocessor">#endif // PLUMA_PLUGIN_MANAGER_HPP</span></div>
 121 <div class="ttc" id="classpluma_1_1PluginManager_htm"><div class="ttname"><a href="classpluma_1_1PluginManager.htm">pluma::PluginManager</a></div><div class="ttdoc">Manages loaded plugins. </div><div class="ttdef"><b>Definition:</b> <a href="PluginManager_8hpp_source.htm#l00044">PluginManager.hpp:44</a></div></div>
 122 <div class="ttc" id="classpluma_1_1Provider_htm"><div class="ttname"><a href="classpluma_1_1Provider.htm">pluma::Provider</a></div><div class="ttdoc">Interface to provide applications with objects from plugins. </div><div class="ttdef"><b>Definition:</b> <a href="Provider_8hpp_source.htm#l00042">Provider.hpp:42</a></div></div>
 123 <div class="ttc" id="classpluma_1_1Host_htm"><div class="ttname"><a href="classpluma_1_1Host.htm">pluma::Host</a></div><div class="ttdoc">Manages providers. </div><div class="ttdef"><b>Definition:</b> <a href="Host_8hpp_source.htm#l00044">Host.hpp:44</a></div></div>
 124 </div><!-- fragment --></div><!-- contents -->
 125
 126         <p id="footer">
 127             &nbsp;::&nbsp; Copyright &copy; 2011 Gil Costa, all rights reserved &nbsp;::&nbsp;
 128             Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.7.4</a> &nbsp;::&nbsp;
 129         </p>
 130     </body>
 131 </html>