doc/third_party/Pluma/html/DLibrary_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">DLibrary.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_DYNAMIC_LIBRARY_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_DYNAMIC_LIBRARY_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;string&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="comment">// include OS dependent support for DLL</span></div>
  62 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#ifdef PLUMA_SYS_WINDOWS</span></div>
  63 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor"></span><span class="preprocessor">    #include &lt;Windows.h&gt;</span></div>
  64 <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#else</span></div>
  65 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor"></span><span class="preprocessor">    #include &lt;dlfcn.h&gt;</span></div>
  66 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#endif</span></div>
  67 <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor"></span></div>
  68 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
  69 <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div>
  70 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keyword">namespace </span>pluma{</div>
  71 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div>
  72 <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classpluma_1_1DLibrary.htm">   49</a></span>&#160;<span class="keyword">class </span><a class="code" href="classpluma_1_1DLibrary.htm">DLibrary</a>{</div>
  73 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div>
  74 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
  75 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="keyword">public</span>:</div>
  76 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
  77 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keyword">static</span> <a class="code" href="classpluma_1_1DLibrary.htm">DLibrary</a>* <a class="code" href="classpluma_1_1DLibrary.htm#a32400d8e50c0f03cb525ca7500b4516e">load</a>(<span class="keyword">const</span> std::string&amp; path);</div>
  78 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div>
  79 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <a class="code" href="classpluma_1_1DLibrary.htm#a3fa679bc824b36ce61b67716bedd15c7">~DLibrary</a>();</div>
  80 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
  81 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="keywordtype">void</span>* <a class="code" href="classpluma_1_1DLibrary.htm#a57dd3726140cce08957e40cb5b001d84">getSymbol</a>(<span class="keyword">const</span> std::string&amp; symbol);</div>
  82 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div>
  83 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
  84 <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="keyword">private</span>:</div>
  85 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div>
  86 <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <a class="code" href="classpluma_1_1DLibrary.htm">DLibrary</a>();</div>
  87 <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div>
  88 <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    <a class="code" href="classpluma_1_1DLibrary.htm">DLibrary</a>(<span class="keywordtype">void</span>* handle);</div>
  89 <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div>
  90 <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div>
  91 <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;</div>
  92 <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment">// Member data</span></div>
  93 <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"></span></div>
  94 <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div>
  95 <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="keyword">private</span>:</div>
  96 <div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;</div>
  97 <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    <span class="keywordtype">void</span>* handle; </div>
  98 <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;</div>
  99 <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;};</div>
 100 <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div>
 101 <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div>
 102 <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;}   <span class="comment">// namespace pluma</span></div>
 103 <div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;</div>
 104 <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;</div>
 105 <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="preprocessor">#endif // PLUMA_DYNAMIC_LIBRARY_HPP</span></div>
 106 <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 &amp;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>
 107 <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>
 108 <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 &amp;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>
 109 <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>
 110 </div><!-- fragment --></div><!-- contents -->
 111
 112         <p id="footer">
 113             &nbsp;::&nbsp; Copyright &copy; 2011 Gil Costa, all rights reserved &nbsp;::&nbsp;
 114             Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.7.4</a> &nbsp;::&nbsp;
 115         </p>
 116     </body>
 117 </html>