doc/third_party/Pluma/html/Pluma_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">Pluma.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_PLUMA_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_PLUMA_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/Provider.hpp&gt;</span></div>
  60 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &lt;Pluma/PluginManager.hpp&gt;</span></div>
  61 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div>
  62 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">// Andy macro to convert parameter to string</span></div>
  63 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"></span><span class="preprocessor">#define PLUMA_2STRING(X) #X</span></div>
  64 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor"></span></div>
  65 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">// Macro that helps host applications defining</span></div>
  66 <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">// their provider classes</span></div>
  67 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"></span><span class="preprocessor">#define PLUMA_PROVIDER_HEADER(TYPE)\</span></div>
  68 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="preprocessor">PLUMA_PROVIDER_HEADER_BEGIN(TYPE)\</span></div>
  69 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">virtual TYPE* create() const = 0;\</span></div>
  70 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor">PLUMA_PROVIDER_HEADER_END</span></div>
  71 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="preprocessor"></span></div>
  72 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">// Macro that generate first part of the provider definition</span></div>
  73 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"></span><span class="preprocessor">#define PLUMA_PROVIDER_HEADER_BEGIN(TYPE)\</span></div>
  74 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">class TYPE##Provider: public pluma::Provider{\</span></div>
  75 <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">private:\</span></div>
  76 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">    friend class pluma::Pluma;\</span></div>
  77 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="preprocessor">    static const unsigned int PLUMA_INTERFACE_VERSION;\</span></div>
  78 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">    static const unsigned int PLUMA_INTERFACE_LOWEST_VERSION;\</span></div>
  79 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">    static const std::string PLUMA_PROVIDER_TYPE;\</span></div>
  80 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="preprocessor">    std::string plumaGetType() const{ return PLUMA_PROVIDER_TYPE; }\</span></div>
  81 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="preprocessor">public:\</span></div>
  82 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="preprocessor">    unsigned int getVersion() const{ return PLUMA_INTERFACE_VERSION; }</span></div>
  83 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="preprocessor"></span></div>
  84 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">// Macro that generate last part of the provider definition</span></div>
  85 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"></span><span class="preprocessor">#define PLUMA_PROVIDER_HEADER_END };</span></div>
  86 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="preprocessor"></span></div>
  87 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment">// Macro that generate the provider declaration</span></div>
  88 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"></span><span class="preprocessor">#define PLUMA_PROVIDER_SOURCE(TYPE, Version, LowestVersion)\</span></div>
  89 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="preprocessor">const std::string TYPE##Provider::PLUMA_PROVIDER_TYPE = PLUMA_2STRING( TYPE );\</span></div>
  90 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="preprocessor">const unsigned int TYPE##Provider::PLUMA_INTERFACE_VERSION = Version;\</span></div>
  91 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="preprocessor">const unsigned int TYPE##Provider::PLUMA_INTERFACE_LOWEST_VERSION = LowestVersion;</span></div>
  92 <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="preprocessor"></span></div>
  93 <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
  94 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">// Macro that helps plugins generating their provider implementations</span></div>
  95 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment">// PRE: SPECIALIZED_TYPE must inherit from BASE_TYPE</span></div>
  96 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"></span><span class="preprocessor">#define PLUMA_INHERIT_PROVIDER(SPECIALIZED_TYPE, BASE_TYPE)\</span></div>
  97 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="preprocessor">class SPECIALIZED_TYPE##Provider: public BASE_TYPE##Provider{\</span></div>
  98 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="preprocessor">public:\</span></div>
  99 <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="preprocessor">    BASE_TYPE * create() const{ return new SPECIALIZED_TYPE (); }\</span></div>
 100 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="preprocessor">};</span></div>
 101 <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="preprocessor"></span></div>
 102 <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div>
 103 <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="keyword">namespace </span>pluma{</div>
 104 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div>
 105 <div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classpluma_1_1Pluma.htm">   94</a></span>&#160;<span class="keyword">class </span><a class="code" href="classpluma_1_1Pluma.htm">Pluma</a>: <span class="keyword">public</span> <a class="code" href="classpluma_1_1PluginManager.htm">PluginManager</a>{</div>
 106 <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div>
 107 <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="keyword">public</span>:</div>
 108 <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    <a class="code" href="classpluma_1_1Pluma.htm#adf4e065f5169931f6290f3828b49e7bb">Pluma</a>();</div>
 109 <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div>
 110 <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;    <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Prov<span class="keywordtype">id</span>erType&gt;</div>
 111 <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classpluma_1_1Pluma.htm#a200c59b0983c7ca53d11b03cf8220bc7">acceptProviderType</a>();</div>
 112 <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;</div>
 113 <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Prov<span class="keywordtype">id</span>erType&gt;</div>
 114 <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classpluma_1_1Pluma.htm#a49fa0b2b4497885c4e978259be0a7abe">getProviders</a>(std::vector&lt;ProviderType*&gt;&amp; providers);</div>
 115 <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;};</div>
 116 <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;</div>
 117 <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="preprocessor">#include &lt;Pluma/Pluma.inl&gt;</span></div>
 118 <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;</div>
 119 <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;}</div>
 120 <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div>
 121 <div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;</div>
 122 <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="preprocessor">#endif // PLUMA_PLUMA_HPP</span></div>
 123 <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="preprocessor"></span></div>
 124 <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;</div>
 125 <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>
 126 <div class="ttc" id="classpluma_1_1Pluma_htm"><div class="ttname"><a href="classpluma_1_1Pluma.htm">pluma::Pluma</a></div><div class="ttdoc">Pluma plugins management. </div><div class="ttdef"><b>Definition:</b> <a href="Pluma_8hpp_source.htm#l00094">Pluma.hpp:94</a></div></div>
 127 <div class="ttc" id="classpluma_1_1Pluma_htm_a49fa0b2b4497885c4e978259be0a7abe"><div class="ttname"><a href="classpluma_1_1Pluma.htm#a49fa0b2b4497885c4e978259be0a7abe">pluma::Pluma::getProviders</a></div><div class="ttdeci">void getProviders(std::vector&lt; ProviderType * &gt; &amp;providers)</div><div class="ttdoc">Get the stored providers of a certain type. </div></div>
 128 <div class="ttc" id="classpluma_1_1Pluma_htm_a200c59b0983c7ca53d11b03cf8220bc7"><div class="ttname"><a href="classpluma_1_1Pluma.htm#a200c59b0983c7ca53d11b03cf8220bc7">pluma::Pluma::acceptProviderType</a></div><div class="ttdeci">void acceptProviderType()</div><div class="ttdoc">Tell Pluma to accept a certain type of providers. </div></div>
 129 <div class="ttc" id="classpluma_1_1Pluma_htm_adf4e065f5169931f6290f3828b49e7bb"><div class="ttname"><a href="classpluma_1_1Pluma.htm#adf4e065f5169931f6290f3828b49e7bb">pluma::Pluma::Pluma</a></div><div class="ttdeci">Pluma()</div><div class="ttdoc">Default Constructor. </div><div class="ttdef"><b>Definition:</b> <a href="Pluma_8inl_source.htm#l00027">Pluma.inl:27</a></div></div>
 130 </div><!-- fragment --></div><!-- contents -->
 131
 132         <p id="footer">
 133             &nbsp;::&nbsp; Copyright &copy; 2011 Gil Costa, all rights reserved &nbsp;::&nbsp;
 134             Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.7.4</a> &nbsp;::&nbsp;
 135         </p>
 136     </body>
 137 </html>