1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
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" />
11 <img src="./logo.png" title="Pluma home" alt="Pluma logo" />
13 <!-- Generated by Doxygen 1.8.6 -->
14 <div id="navrow1" class="tabs">
16 <li><a href="index.htm"><span>Main 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>
21 <div id="navrow2" class="tabs2">
23 <li><a href="files.htm"><span>File List</span></a></li>
28 <div class="headertitle">
29 <div class="title">Host.hpp</div> </div>
31 <div class="contents">
32 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
33 <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Pluma - Plug-in Management Framework</span></div>
34 <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <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> <span class="comment">//</span></div>
36 <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span></div>
37 <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">//</span></div>
39 <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <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> <span class="comment">// subject to the following restrictions:</span></div>
42 <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div>
43 <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <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> <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> <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> <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> <span class="comment">//</span></div>
48 <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <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> <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> <span class="comment">//</span></div>
51 <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <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> <span class="comment">//</span></div>
53 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
54 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef PLUMA_HOST_HPP</span></div>
55 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor">#define PLUMA_HOST_HPP</span></div>
56 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span></div>
57 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Headers</span></div>
58 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="preprocessor">#include <Pluma/Config.hpp></span></div>
59 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <Pluma/Provider.hpp></span></div>
60 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
61 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include <vector></span></div>
62 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <list></span></div>
63 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <map></span></div>
64 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
65 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">namespace </span>pluma{</div>
66 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
67 <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classpluma_1_1Host.htm"> 44</a></span> <span class="keyword">class </span>PLUMA_API <a class="code" href="classpluma_1_1Host.htm">Host</a>{</div>
68 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classpluma_1_1PluginManager.htm">PluginManager</a>;</div>
69 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classpluma_1_1Provider.htm">Provider</a>;</div>
70 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
71 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
72 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div>
73 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
74 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">bool</span> add(<a class="code" href="classpluma_1_1Provider.htm">Provider</a>* provider);</div>
75 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
76 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
77 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">private</span>:</div>
78 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
79 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classpluma_1_1Host.htm">Host</a>();</div>
80 <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
81 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  ~<a class="code" href="classpluma_1_1Host.htm">Host</a>();</div>
82 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
83 <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">bool</span> knows(<span class="keyword">const</span> std::string& type) <span class="keyword">const</span>;</div>
84 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
85 <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getVersion(<span class="keyword">const</span> std::string& type) <span class="keyword">const</span>;</div>
86 <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
87 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getLowestVersion(<span class="keyword">const</span> std::string& type) <span class="keyword">const</span>;</div>
88 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
89 <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">void</span> registerType(<span class="keyword">const</span> std::string& type, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> version, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> lowestVersion);</div>
90 <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
91 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">const</span> std::list<Provider*>* getProviders(<span class="keyword">const</span> std::string& type) <span class="keyword">const</span>;</div>
92 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
93 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">void</span> clearProviders();</div>
94 <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
95 <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordtype">bool</span> validateProvider(<a class="code" href="classpluma_1_1Provider.htm">Provider</a>* provider) <span class="keyword">const</span>;</div>
96 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
97 <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">bool</span> registerProvider(<a class="code" href="classpluma_1_1Provider.htm">Provider</a>* provider);</div>
98 <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div>
99 <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordtype">void</span> cancelAddictions();</div>
100 <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div>
101 <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">bool</span> confirmAddictions();</div>
102 <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
103 <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div>
104 <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div>
105 <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">// Member data</span></div>
106 <div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"></span></div>
107 <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="keyword">private</span>:</div>
108 <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div>
109 <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="keyword">struct </span>ProviderInfo{</div>
110 <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> version;</div>
111 <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> lowestVersion;</div>
112 <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  std::list<Provider*> providers;</div>
113 <div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  };</div>
114 <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div>
115 <div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keyword">typedef</span> std::map<std::string, ProviderInfo > ProvidersMap;</div>
116 <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keyword">typedef</span> std::map<std::string, std::list<Provider*> > TempProvidersMap;</div>
117 <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div>
118 <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  ProvidersMap knownTypes; </div>
119 <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  TempProvidersMap addRequests; </div>
120 <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div>
121 <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> };</div>
122 <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div>
123 <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> } <span class="comment">// namespace pluma</span></div>
124 <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div>
125 <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="preprocessor">#endif // PLUMA_HOST_HPP</span></div>
126 <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>
127 <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>
128 <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>
129 </div><!-- fragment --></div><!-- contents -->
132 :: Copyright © 2011 Gil Costa, all rights reserved ::
133 Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.7.4</a> ::