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.cpp</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> </div>
55 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// Headers</span></div>
56 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span><span class="preprocessor">#include <Pluma/Host.hpp></span></div>
57 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <cstdio></span></div>
58 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
59 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
60 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span>pluma{</div>
61 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
62 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> Host::Host(){</div>
63 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// Nothing to do</span></div>
64 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> }</div>
65 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
66 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
67 <div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classpluma_1_1Host.htm#ab673ba94ff56a12cdf2a7a25ebb8cc36"> 42</a></span> <span class="keywordtype">bool</span> <a class="code" href="classpluma_1_1Host.htm#ab673ba94ff56a12cdf2a7a25ebb8cc36">Host::add</a>(<a class="code" href="classpluma_1_1Provider.htm">Provider</a>* provider){</div>
68 <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">if</span> (provider == NULL){</div>
69 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  fprintf(stderr, <span class="stringliteral">"Trying to add a null provider.\n"</span>);</div>
70 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
71 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  }</div>
72 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">if</span> (!validateProvider(provider)){</div>
73 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">delete</span> provider;</div>
74 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
75 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div>
76 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  addRequests[ provider->plumaGetType() ].push_back(provider);</div>
77 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
78 <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> }</div>
79 <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
80 <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
81 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> Host::~Host(){</div>
82 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  clearProviders();</div>
83 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// map frees itself</span></div>
84 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</div>
85 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
86 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
87 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">void</span> Host::clearProviders(){</div>
88 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  ProvidersMap::iterator it;</div>
89 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">for</span> (it = knownTypes.begin() ; it != knownTypes.end() ; ++it){</div>
90 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  std::list<Provider*>& providers = it->second.providers;</div>
91 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  std::list<Provider*>::iterator provIt;</div>
92 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">for</span> (provIt = providers.begin() ; provIt != providers.end() ; ++provIt){</div>
93 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">delete</span> *provIt;</div>
94 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div>
95 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  std::list<Provider*>().swap(providers);</div>
96 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div>
97 <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div>
98 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
99 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
100 <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">bool</span> Host::knows(<span class="keyword">const</span> std::string& type)<span class="keyword"> const</span>{</div>
101 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> knownTypes.find(type) != knownTypes.end();</div>
102 <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div>
103 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
104 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
105 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Host::getVersion(<span class="keyword">const</span> std::string& type)<span class="keyword"> const</span>{</div>
106 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  ProvidersMap::const_iterator it = knownTypes.find(type);</div>
107 <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">if</span> (it != knownTypes.end())</div>
108 <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">return</span> it->second.version;</div>
109 <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> 0;</div>
110 <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> }</div>
111 <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
112 <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
113 <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Host::getLowestVersion(<span class="keyword">const</span> std::string& type)<span class="keyword"> const</span>{</div>
114 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  ProvidersMap::const_iterator it = knownTypes.find(type);</div>
115 <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">if</span> (it != knownTypes.end())</div>
116 <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> it->second.lowestVersion;</div>
117 <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> 0;</div>
118 <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> }</div>
119 <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
120 <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
121 <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keywordtype">void</span> Host::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>
122 <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">if</span> (!knows(type)){</div>
123 <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  ProviderInfo pi;</div>
124 <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  pi.version = version;</div>
125 <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  pi.lowestVersion = lowestVersion;</div>
126 <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  knownTypes[type] = pi;</div>
127 <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  }</div>
128 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> }</div>
129 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
130 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div>
131 <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">const</span> std::list<Provider*>* Host::getProviders(<span class="keyword">const</span> std::string& type)<span class="keyword"> const</span>{</div>
132 <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  ProvidersMap::const_iterator it = knownTypes.find(type);</div>
133 <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">if</span> (it != knownTypes.end())</div>
134 <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">return</span> &it->second.providers;</div>
135 <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> NULL;</div>
136 <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> }</div>
137 <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
138 <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
139 <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keywordtype">bool</span> Host::validateProvider(Provider* provider)<span class="keyword"> const</span>{</div>
140 <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">const</span> std::string& type = provider->plumaGetType();</div>
141 <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordflow">if</span> ( !knows(type) ){</div>
142 <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  fprintf(stderr, <span class="stringliteral">"%s provider type isn't registered.\n"</span>, type.c_str());</div>
143 <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
144 <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  }</div>
145 <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordflow">if</span> (!provider->isCompatible(*<span class="keyword">this</span>)){</div>
146 <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  fprintf(stderr, <span class="stringliteral">"Incompatible %s provider version.\n"</span>, type.c_str());</div>
147 <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
148 <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  }</div>
149 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
150 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> }</div>
151 <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div>
152 <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div>
153 <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">bool</span> Host::registerProvider(Provider* provider){</div>
154 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordflow">if</span> (!validateProvider(provider)){</div>
155 <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">delete</span> provider;</div>
156 <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
157 <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  }</div>
158 <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  knownTypes[ provider->plumaGetType() ].providers.push_back(provider);</div>
159 <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
160 <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> }</div>
161 <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div>
162 <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
163 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="keywordtype">void</span> Host::cancelAddictions(){</div>
164 <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  TempProvidersMap::iterator it;</div>
165 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordflow">for</span>( it = addRequests.begin() ; it != addRequests.end() ; ++it){</div>
166 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  std::list<Provider*> lst = it->second;</div>
167 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  std::list<Provider*>::iterator providerIt;</div>
168 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">for</span> (providerIt = lst.begin() ; providerIt != lst.end() ; ++providerIt){</div>
169 <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keyword">delete</span> *providerIt;</div>
170 <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  }</div>
171 <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  }</div>
172 <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="comment">// clear map</span></div>
173 <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  TempProvidersMap().swap(addRequests);</div>
174 <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> }</div>
175 <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div>
176 <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div>
177 <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="keywordtype">bool</span> Host::confirmAddictions(){</div>
178 <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordflow">if</span> (addRequests.empty()) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
179 <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  TempProvidersMap::iterator it;</div>
180 <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordflow">for</span>( it = addRequests.begin() ; it != addRequests.end() ; ++it){</div>
181 <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  std::list<Provider*> lst = it->second;</div>
182 <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  std::list<Provider*>::iterator providerIt;</div>
183 <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordflow">for</span> (providerIt = lst.begin() ; providerIt != lst.end() ; ++providerIt){</div>
184 <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  knownTypes[it->first].providers.push_back(*providerIt);</div>
185 <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  }</div>
186 <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  }</div>
187 <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment">// clear map</span></div>
188 <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  TempProvidersMap().swap(addRequests);</div>
189 <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
190 <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> }</div>
191 <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div>
192 <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div>
193 <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> } <span class="comment">//namespace pluma</span></div>
194 <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>
195 <div class="ttc" id="classpluma_1_1Host_htm_ab673ba94ff56a12cdf2a7a25ebb8cc36"><div class="ttname"><a href="classpluma_1_1Host.htm#ab673ba94ff56a12cdf2a7a25ebb8cc36">pluma::Host::add</a></div><div class="ttdeci">bool add(Provider *provider)</div><div class="ttdoc">Add provider. </div><div class="ttdef"><b>Definition:</b> <a href="Host_8cpp_source.htm#l00042">Host.cpp:42</a></div></div>
196 </div><!-- fragment --></div><!-- contents -->
199 :: Copyright © 2011 Gil Costa, all rights reserved ::
200 Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.7.4</a> ::
git://git.creatis.insa-lyon.fr / cpPlugins.git / blob