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">DLibrary.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/DLibrary.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> <span class="preprocessor">#include <string></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> </div>
61 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>pluma{</div>
62 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
63 <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classpluma_1_1DLibrary.htm#a32400d8e50c0f03cb525ca7500b4516e"> 37</a></span> <a class="code" href="classpluma_1_1DLibrary.htm">DLibrary</a>* <a class="code" href="classpluma_1_1DLibrary.htm#a32400d8e50c0f03cb525ca7500b4516e">DLibrary::load</a>(<span class="keyword">const</span> std::string& path){</div>
64 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">if</span> ( path.empty() ){</div>
65 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  fprintf(stderr, <span class="stringliteral">"Failed to load library: Empty path\n"</span>);</div>
66 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span> NULL;</div>
67 <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div>
68 <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span>* handle = NULL;</div>
69 <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
70 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// load library - OS dependent operation</span></div>
71 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"> #ifdef PLUMA_SYS_WINDOWS</span></div>
72 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span> handle = ::LoadLibraryA(path.c_str());</div>
73 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">if</span> (!handle){</div>
74 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  fprintf(stderr, <span class="stringliteral">"Failed to load library \"%s\".\n"</span>, path.c_str());</div>
75 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> NULL;</div>
76 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div>
77 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"> #else</span></div>
78 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span> handle = ::dlopen(path.c_str(), RTLD_NOW);</div>
79 <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">if</span> (!handle){</div>
80 <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* errorString = ::dlerror();</div>
81 <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  fprintf(stderr, <span class="stringliteral">"Failed to load library \"%s\"."</span>, path.c_str());</div>
82 <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">if</span>(errorString) fprintf(stderr, <span class="stringliteral">" OS returned error: \"%s\"."</span>, errorString);</div>
83 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  fprintf(stderr, <span class="stringliteral">"\n"</span>);</div>
84 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> NULL;</div>
85 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div>
86 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"> #endif</span></div>
87 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"></span> <span class="comment">// return a DLibrary with the DLL handle</span></div>
88 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="classpluma_1_1DLibrary.htm">DLibrary</a>(handle);</div>
89 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> }</div>
90 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
91 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
92 <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classpluma_1_1DLibrary.htm#a3fa679bc824b36ce61b67716bedd15c7"> 67</a></span> <a class="code" href="classpluma_1_1DLibrary.htm#a3fa679bc824b36ce61b67716bedd15c7">DLibrary::~DLibrary</a>(){</div>
93 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">if</span> (handle){</div>
94 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"> #ifdef PLUMA_SYS_WINDOWS</span></div>
95 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor"></span> ::FreeLibrary( (HMODULE)handle );</div>
96 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> #else</span></div>
97 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"></span> ::dlclose(handle);</div>
98 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> #endif</span></div>
99 <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"></span> }</div>
100 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> }</div>
101 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
102 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
103 <div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classpluma_1_1DLibrary.htm#a57dd3726140cce08957e40cb5b001d84"> 79</a></span> <span class="keywordtype">void</span>* <a class="code" href="classpluma_1_1DLibrary.htm#a57dd3726140cce08957e40cb5b001d84">DLibrary::getSymbol</a>(<span class="keyword">const</span> std::string& symbol){</div>
104 <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">if</span> (!handle){</div>
105 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  fprintf(stderr, <span class="stringliteral">"Cannot inspect library symbols, library isn't loaded.\n"</span>);</div>
106 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> NULL;</div>
107 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div>
108 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span>* res;</div>
109 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"> #ifdef PLUMA_SYS_WINDOWS</span></div>
110 <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor"></span> res = (<span class="keywordtype">void</span>*)(::GetProcAddress((HMODULE)handle, symbol.c_str()));</div>
111 <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"> #else</span></div>
112 <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"></span> res = (<span class="keywordtype">void</span>*)(::dlsym(handle, symbol.c_str()));</div>
113 <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"> #endif</span></div>
114 <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"></span> <span class="keywordflow">if</span> (!res){</div>
115 <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  fprintf(stderr, <span class="stringliteral">"Library symbol \"%s\" not found.\n"</span>, symbol.c_str());</div>
116 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> NULL;</div>
117 <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div>
118 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> res;</div>
119 <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> }</div>
120 <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
121 <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
122 <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> DLibrary::DLibrary(<span class="keywordtype">void</span>* handle):</div>
123 <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  handle(handle)</div>
124 <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> {</div>
125 <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="comment">// Nothing to do</span></div>
126 <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> }</div>
127 <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
128 <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> } <span class="comment">// namespace pluma</span></div>
129 <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
130 <div class="ttc" id="classpluma_1_1DLibrary_htm_a32400d8e50c0f03cb525ca7500b4516e"><div class="ttname"><a href="classpluma_1_1DLibrary.htm#a32400d8e50c0f03cb525ca7500b4516e">pluma::DLibrary::load</a></div><div class="ttdeci">static DLibrary * load(const std::string &path)</div><div class="ttdoc">Load a library. </div><div class="ttdef"><b>Definition:</b> <a href="DLibrary_8cpp_source.htm#l00037">DLibrary.cpp:37</a></div></div>
131 <div class="ttc" id="classpluma_1_1DLibrary_htm"><div class="ttname"><a href="classpluma_1_1DLibrary.htm">pluma::DLibrary</a></div><div class="ttdoc">Manages a Dynamic Linking Library. </div><div class="ttdef"><b>Definition:</b> <a href="DLibrary_8hpp_source.htm#l00049">DLibrary.hpp:49</a></div></div>
132 <div class="ttc" id="classpluma_1_1DLibrary_htm_a57dd3726140cce08957e40cb5b001d84"><div class="ttname"><a href="classpluma_1_1DLibrary.htm#a57dd3726140cce08957e40cb5b001d84">pluma::DLibrary::getSymbol</a></div><div class="ttdeci">void * getSymbol(const std::string &symbol)</div><div class="ttdoc">Get a symbol from the library. </div><div class="ttdef"><b>Definition:</b> <a href="DLibrary_8cpp_source.htm#l00079">DLibrary.cpp:79</a></div></div>
133 <div class="ttc" id="classpluma_1_1DLibrary_htm_a3fa679bc824b36ce61b67716bedd15c7"><div class="ttname"><a href="classpluma_1_1DLibrary.htm#a3fa679bc824b36ce61b67716bedd15c7">pluma::DLibrary::~DLibrary</a></div><div class="ttdeci">~DLibrary()</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> <a href="DLibrary_8cpp_source.htm#l00067">DLibrary.cpp:67</a></div></div>
134 </div><!-- fragment --></div><!-- contents -->
137 :: Copyright © 2011 Gil Costa, all rights reserved ::
138 Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.7.4</a> ::