| 
							- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 - <html xmlns="http://www.w3.org/1999/xhtml">
 - <head>
 - <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 - <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 - <meta name="generator" content="Doxygen 1.8.17"/>
 - <meta name="viewport" content="width=device-width, initial-scale=1"/>
 - <title>DISTRHO Plugin Framework: distrho/extra/LibraryUtils.hpp Source File</title>
 - <link href="tabs.css" rel="stylesheet" type="text/css"/>
 - <script type="text/javascript" src="jquery.js"></script>
 - <script type="text/javascript" src="dynsections.js"></script>
 - <link href="search/search.css" rel="stylesheet" type="text/css"/>
 - <script type="text/javascript" src="search/searchdata.js"></script>
 - <script type="text/javascript" src="search/search.js"></script>
 - <link href="doxygen.css" rel="stylesheet" type="text/css" />
 - </head>
 - <body>
 - <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 - <div id="titlearea">
 - <table cellspacing="0" cellpadding="0">
 -  <tbody>
 -  <tr style="height: 56px;">
 -   <td id="projectalign" style="padding-left: 0.5em;">
 -    <div id="projectname">DISTRHO Plugin Framework
 -    </div>
 -   </td>
 -  </tr>
 -  </tbody>
 - </table>
 - </div>
 - <!-- end header part -->
 - <!-- Generated by Doxygen 1.8.17 -->
 - <script type="text/javascript">
 - /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
 - var searchBox = new SearchBox("searchBox", "search",false,'Search');
 - /* @license-end */
 - </script>
 - <script type="text/javascript" src="menudata.js"></script>
 - <script type="text/javascript" src="menu.js"></script>
 - <script type="text/javascript">
 - /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
 - $(function() {
 -   initMenu('',true,false,'search.php','Search');
 -   $(document).ready(function() { init_search(); });
 - });
 - /* @license-end */</script>
 - <div id="main-nav"></div>
 - <!-- window showing the filter options -->
 - <div id="MSearchSelectWindow"
 -      onmouseover="return searchBox.OnSearchSelectShow()"
 -      onmouseout="return searchBox.OnSearchSelectHide()"
 -      onkeydown="return searchBox.OnSearchSelectKey(event)">
 - </div>
 - 
 - <!-- iframe showing the search results (closed by default) -->
 - <div id="MSearchResultsWindow">
 - <iframe src="javascript:void(0)" frameborder="0" 
 -         name="MSearchResults" id="MSearchResults">
 - </iframe>
 - </div>
 - 
 - <div id="nav-path" class="navpath">
 -   <ul>
 - <li class="navelem"><a class="el" href="dir_37257469cca17bab24b582e18a78eb75.html">distrho</a></li><li class="navelem"><a class="el" href="dir_b1be46be7d80596b116b2b4ac973f2f0.html">extra</a></li>  </ul>
 - </div>
 - </div><!-- top -->
 - <div class="header">
 -   <div class="headertitle">
 - <div class="title">LibraryUtils.hpp</div>  </div>
 - </div><!--header-->
 - <div class="contents">
 - <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span> <span class="comment">/*</span></div>
 - <div class="line"><a name="l00002"></a><span class="lineno">    2</span> <span class="comment"> * DISTRHO Plugin Framework (DPF)</span></div>
 - <div class="line"><a name="l00003"></a><span class="lineno">    3</span> <span class="comment"> * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com></span></div>
 - <div class="line"><a name="l00004"></a><span class="lineno">    4</span> <span class="comment"> *</span></div>
 - <div class="line"><a name="l00005"></a><span class="lineno">    5</span> <span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any purpose with</span></div>
 - <div class="line"><a name="l00006"></a><span class="lineno">    6</span> <span class="comment"> * or without fee is hereby granted, provided that the above copyright notice and this</span></div>
 - <div class="line"><a name="l00007"></a><span class="lineno">    7</span> <span class="comment"> * permission notice appear in all copies.</span></div>
 - <div class="line"><a name="l00008"></a><span class="lineno">    8</span> <span class="comment"> *</span></div>
 - <div class="line"><a name="l00009"></a><span class="lineno">    9</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD</span></div>
 - <div class="line"><a name="l00010"></a><span class="lineno">   10</span> <span class="comment"> * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN</span></div>
 - <div class="line"><a name="l00011"></a><span class="lineno">   11</span> <span class="comment"> * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL</span></div>
 - <div class="line"><a name="l00012"></a><span class="lineno">   12</span> <span class="comment"> * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER</span></div>
 - <div class="line"><a name="l00013"></a><span class="lineno">   13</span> <span class="comment"> * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN</span></div>
 - <div class="line"><a name="l00014"></a><span class="lineno">   14</span> <span class="comment"> * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
 - <div class="line"><a name="l00015"></a><span class="lineno">   15</span> <span class="comment"> */</span></div>
 - <div class="line"><a name="l00016"></a><span class="lineno">   16</span>  </div>
 - <div class="line"><a name="l00017"></a><span class="lineno">   17</span> <span class="preprocessor">#ifndef DISTRHO_LIBRARY_UTILS_HPP_INCLUDED</span></div>
 - <div class="line"><a name="l00018"></a><span class="lineno">   18</span> <span class="preprocessor">#define DISTRHO_LIBRARY_UTILS_HPP_INCLUDED</span></div>
 - <div class="line"><a name="l00019"></a><span class="lineno">   19</span>  </div>
 - <div class="line"><a name="l00020"></a><span class="lineno">   20</span> <span class="preprocessor">#include "../DistrhoUtils.hpp"</span></div>
 - <div class="line"><a name="l00021"></a><span class="lineno">   21</span>  </div>
 - <div class="line"><a name="l00022"></a><span class="lineno">   22</span> <span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>
 - <div class="line"><a name="l00023"></a><span class="lineno">   23</span> <span class="preprocessor"># include <winsock2.h></span></div>
 - <div class="line"><a name="l00024"></a><span class="lineno">   24</span> <span class="preprocessor"># include <windows.h></span></div>
 - <div class="line"><a name="l00025"></a><span class="lineno">   25</span> <span class="keyword">typedef</span> HMODULE lib_t;</div>
 - <div class="line"><a name="l00026"></a><span class="lineno">   26</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00027"></a><span class="lineno">   27</span> <span class="preprocessor"># include <dlfcn.h></span></div>
 - <div class="line"><a name="l00028"></a><span class="lineno">   28</span> <span class="keyword">typedef</span> <span class="keywordtype">void</span>* lib_t;</div>
 - <div class="line"><a name="l00029"></a><span class="lineno">   29</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00030"></a><span class="lineno">   30</span>  </div>
 - <div class="line"><a name="l00031"></a><span class="lineno">   31</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
 - <div class="line"><a name="l00032"></a><span class="lineno">   32</span> <span class="comment">// library related calls</span></div>
 - <div class="line"><a name="l00033"></a><span class="lineno">   33</span>  </div>
 - <div class="line"><a name="l00034"></a><span class="lineno">   34</span> <span class="comment">/*</span></div>
 - <div class="line"><a name="l00035"></a><span class="lineno">   35</span> <span class="comment"> * Open 'filename' library (must not be null).</span></div>
 - <div class="line"><a name="l00036"></a><span class="lineno">   36</span> <span class="comment"> * May return null, in which case "lib_error" has the error.</span></div>
 - <div class="line"><a name="l00037"></a><span class="lineno">   37</span> <span class="comment"> */</span></div>
 - <div class="line"><a name="l00038"></a><span class="lineno">   38</span> <span class="keyword">static</span> <span class="keyword">inline</span></div>
 - <div class="line"><a name="l00039"></a><span class="lineno">   39</span> lib_t lib_open(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> filename) noexcept</div>
 - <div class="line"><a name="l00040"></a><span class="lineno">   40</span> {</div>
 - <div class="line"><a name="l00041"></a><span class="lineno">   41</span>     DISTRHO_SAFE_ASSERT_RETURN(filename != <span class="keyword">nullptr</span> && filename[0] != <span class="charliteral">'\0'</span>, <span class="keyword">nullptr</span>);</div>
 - <div class="line"><a name="l00042"></a><span class="lineno">   42</span>  </div>
 - <div class="line"><a name="l00043"></a><span class="lineno">   43</span>     <span class="keywordflow">try</span> {</div>
 - <div class="line"><a name="l00044"></a><span class="lineno">   44</span> <span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>
 - <div class="line"><a name="l00045"></a><span class="lineno">   45</span>         return ::LoadLibraryA(filename);</div>
 - <div class="line"><a name="l00046"></a><span class="lineno">   46</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00047"></a><span class="lineno">   47</span>         return ::dlopen(filename, RTLD_NOW|RTLD_LOCAL);</div>
 - <div class="line"><a name="l00048"></a><span class="lineno">   48</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00049"></a><span class="lineno">   49</span>     } DISTRHO_SAFE_EXCEPTION_RETURN(<span class="stringliteral">"lib_open"</span>, <span class="keyword">nullptr</span>);</div>
 - <div class="line"><a name="l00050"></a><span class="lineno">   50</span> }</div>
 - <div class="line"><a name="l00051"></a><span class="lineno">   51</span>  </div>
 - <div class="line"><a name="l00052"></a><span class="lineno">   52</span> <span class="comment">/*</span></div>
 - <div class="line"><a name="l00053"></a><span class="lineno">   53</span> <span class="comment"> * Close a previously opened library (must not be null).</span></div>
 - <div class="line"><a name="l00054"></a><span class="lineno">   54</span> <span class="comment"> * If false is returned, "lib_error" has the error.</span></div>
 - <div class="line"><a name="l00055"></a><span class="lineno">   55</span> <span class="comment"> */</span></div>
 - <div class="line"><a name="l00056"></a><span class="lineno">   56</span> <span class="keyword">static</span> <span class="keyword">inline</span></div>
 - <div class="line"><a name="l00057"></a><span class="lineno">   57</span> <span class="keywordtype">bool</span> lib_close(<span class="keyword">const</span> lib_t lib) noexcept</div>
 - <div class="line"><a name="l00058"></a><span class="lineno">   58</span> {</div>
 - <div class="line"><a name="l00059"></a><span class="lineno">   59</span>     DISTRHO_SAFE_ASSERT_RETURN(lib != <span class="keyword">nullptr</span>, <span class="keyword">false</span>);</div>
 - <div class="line"><a name="l00060"></a><span class="lineno">   60</span>  </div>
 - <div class="line"><a name="l00061"></a><span class="lineno">   61</span>     <span class="keywordflow">try</span> {</div>
 - <div class="line"><a name="l00062"></a><span class="lineno">   62</span> <span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>
 - <div class="line"><a name="l00063"></a><span class="lineno">   63</span>         return ::FreeLibrary(lib);</div>
 - <div class="line"><a name="l00064"></a><span class="lineno">   64</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00065"></a><span class="lineno">   65</span>         <span class="keywordflow">return</span> (::dlclose(lib) == 0);</div>
 - <div class="line"><a name="l00066"></a><span class="lineno">   66</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00067"></a><span class="lineno">   67</span>     } DISTRHO_SAFE_EXCEPTION_RETURN(<span class="stringliteral">"lib_close"</span>, <span class="keyword">false</span>);</div>
 - <div class="line"><a name="l00068"></a><span class="lineno">   68</span> }</div>
 - <div class="line"><a name="l00069"></a><span class="lineno">   69</span>  </div>
 - <div class="line"><a name="l00070"></a><span class="lineno">   70</span> <span class="comment">/*</span></div>
 - <div class="line"><a name="l00071"></a><span class="lineno">   71</span> <span class="comment"> * Get a library symbol (must not be null).</span></div>
 - <div class="line"><a name="l00072"></a><span class="lineno">   72</span> <span class="comment"> * Returns null if the symbol is not found.</span></div>
 - <div class="line"><a name="l00073"></a><span class="lineno">   73</span> <span class="comment"> */</span></div>
 - <div class="line"><a name="l00074"></a><span class="lineno">   74</span> <span class="keyword">template</span><<span class="keyword">typename</span> Func></div>
 - <div class="line"><a name="l00075"></a><span class="lineno">   75</span> <span class="keyword">static</span> <span class="keyword">inline</span></div>
 - <div class="line"><a name="l00076"></a><span class="lineno">   76</span> Func lib_symbol(<span class="keyword">const</span> lib_t lib, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> symbol) noexcept</div>
 - <div class="line"><a name="l00077"></a><span class="lineno">   77</span> {</div>
 - <div class="line"><a name="l00078"></a><span class="lineno">   78</span>     DISTRHO_SAFE_ASSERT_RETURN(lib != <span class="keyword">nullptr</span>, <span class="keyword">nullptr</span>);</div>
 - <div class="line"><a name="l00079"></a><span class="lineno">   79</span>     DISTRHO_SAFE_ASSERT_RETURN(symbol != <span class="keyword">nullptr</span> && symbol[0] != <span class="charliteral">'\0'</span>, <span class="keyword">nullptr</span>);</div>
 - <div class="line"><a name="l00080"></a><span class="lineno">   80</span>  </div>
 - <div class="line"><a name="l00081"></a><span class="lineno">   81</span>     <span class="keywordflow">try</span> {</div>
 - <div class="line"><a name="l00082"></a><span class="lineno">   82</span> <span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>
 - <div class="line"><a name="l00083"></a><span class="lineno">   83</span> <span class="preprocessor"># if defined(__GNUC__) && (__GNUC__ >= 9)</span></div>
 - <div class="line"><a name="l00084"></a><span class="lineno">   84</span> <span class="preprocessor">#  pragma GCC diagnostic push</span></div>
 - <div class="line"><a name="l00085"></a><span class="lineno">   85</span> <span class="preprocessor">#  pragma GCC diagnostic ignored "-Wcast-function-type"</span></div>
 - <div class="line"><a name="l00086"></a><span class="lineno">   86</span> <span class="preprocessor"># endif</span></div>
 - <div class="line"><a name="l00087"></a><span class="lineno">   87</span>         <span class="keywordflow">return</span> (Func)::GetProcAddress(lib, symbol);</div>
 - <div class="line"><a name="l00088"></a><span class="lineno">   88</span> <span class="preprocessor"># if defined(__GNUC__) && (__GNUC__ >= 9)</span></div>
 - <div class="line"><a name="l00089"></a><span class="lineno">   89</span> <span class="preprocessor">#  pragma GCC diagnostic pop</span></div>
 - <div class="line"><a name="l00090"></a><span class="lineno">   90</span> <span class="preprocessor"># endif</span></div>
 - <div class="line"><a name="l00091"></a><span class="lineno">   91</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00092"></a><span class="lineno">   92</span>         <span class="keywordflow">return</span> (Func)(uintptr_t)::dlsym(lib, symbol);</div>
 - <div class="line"><a name="l00093"></a><span class="lineno">   93</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00094"></a><span class="lineno">   94</span>     } DISTRHO_SAFE_EXCEPTION_RETURN(<span class="stringliteral">"lib_symbol"</span>, <span class="keyword">nullptr</span>);</div>
 - <div class="line"><a name="l00095"></a><span class="lineno">   95</span> }</div>
 - <div class="line"><a name="l00096"></a><span class="lineno">   96</span>  </div>
 - <div class="line"><a name="l00097"></a><span class="lineno">   97</span> <span class="comment">/*</span></div>
 - <div class="line"><a name="l00098"></a><span class="lineno">   98</span> <span class="comment"> * Return the last operation error ('filename' must not be null).</span></div>
 - <div class="line"><a name="l00099"></a><span class="lineno">   99</span> <span class="comment"> * May return null.</span></div>
 - <div class="line"><a name="l00100"></a><span class="lineno">  100</span> <span class="comment"> */</span></div>
 - <div class="line"><a name="l00101"></a><span class="lineno">  101</span> <span class="keyword">static</span> <span class="keyword">inline</span></div>
 - <div class="line"><a name="l00102"></a><span class="lineno">  102</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* lib_error(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> filename) noexcept</div>
 - <div class="line"><a name="l00103"></a><span class="lineno">  103</span> {</div>
 - <div class="line"><a name="l00104"></a><span class="lineno">  104</span>     DISTRHO_SAFE_ASSERT_RETURN(filename != <span class="keyword">nullptr</span> && filename[0] != <span class="charliteral">'\0'</span>, <span class="keyword">nullptr</span>);</div>
 - <div class="line"><a name="l00105"></a><span class="lineno">  105</span>  </div>
 - <div class="line"><a name="l00106"></a><span class="lineno">  106</span> <span class="preprocessor">#ifdef DISTRHO_OS_WINDOWS</span></div>
 - <div class="line"><a name="l00107"></a><span class="lineno">  107</span>     <span class="keyword">static</span> <span class="keywordtype">char</span> libError[2048+1];</div>
 - <div class="line"><a name="l00108"></a><span class="lineno">  108</span>     std::memset(libError, 0, <span class="keyword">sizeof</span>(libError));</div>
 - <div class="line"><a name="l00109"></a><span class="lineno">  109</span>  </div>
 - <div class="line"><a name="l00110"></a><span class="lineno">  110</span>     <span class="keywordflow">try</span> {</div>
 - <div class="line"><a name="l00111"></a><span class="lineno">  111</span>         <span class="keyword">const</span> DWORD winErrorCode  = ::GetLastError();</div>
 - <div class="line"><a name="l00112"></a><span class="lineno">  112</span>         <span class="keyword">const</span> <span class="keywordtype">int</span>   winErrorFlags = FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM|FORMAT_MESSAGE_IGNORE_INSERTS;</div>
 - <div class="line"><a name="l00113"></a><span class="lineno">  113</span>         LPVOID      winErrorString;</div>
 - <div class="line"><a name="l00114"></a><span class="lineno">  114</span>  </div>
 - <div class="line"><a name="l00115"></a><span class="lineno">  115</span>         ::FormatMessage(winErrorFlags, <span class="keyword">nullptr</span>, winErrorCode, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPTSTR)&winErrorString, 0, <span class="keyword">nullptr</span>);</div>
 - <div class="line"><a name="l00116"></a><span class="lineno">  116</span>  </div>
 - <div class="line"><a name="l00117"></a><span class="lineno">  117</span>         std::snprintf(libError, 2048, <span class="stringliteral">"%s: error code %li: %s"</span>, filename, winErrorCode, (<span class="keyword">const</span> <span class="keywordtype">char</span>*)winErrorString);</div>
 - <div class="line"><a name="l00118"></a><span class="lineno">  118</span>         ::LocalFree(winErrorString);</div>
 - <div class="line"><a name="l00119"></a><span class="lineno">  119</span>     } DISTRHO_SAFE_EXCEPTION(<span class="stringliteral">"lib_error"</span>);</div>
 - <div class="line"><a name="l00120"></a><span class="lineno">  120</span>  </div>
 - <div class="line"><a name="l00121"></a><span class="lineno">  121</span>     <span class="keywordflow">return</span> (libError[0] != <span class="charliteral">'\0'</span>) ? libError : <span class="keyword">nullptr</span>;</div>
 - <div class="line"><a name="l00122"></a><span class="lineno">  122</span> <span class="preprocessor">#else</span></div>
 - <div class="line"><a name="l00123"></a><span class="lineno">  123</span>     return ::dlerror();</div>
 - <div class="line"><a name="l00124"></a><span class="lineno">  124</span> <span class="preprocessor">#endif</span></div>
 - <div class="line"><a name="l00125"></a><span class="lineno">  125</span> }</div>
 - <div class="line"><a name="l00126"></a><span class="lineno">  126</span>  </div>
 - <div class="line"><a name="l00127"></a><span class="lineno">  127</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
 - <div class="line"><a name="l00128"></a><span class="lineno">  128</span>  </div>
 - <div class="line"><a name="l00129"></a><span class="lineno">  129</span> <span class="preprocessor">#endif // DISTRHO_LIBRARY_UTILS_HPP_INCLUDED</span></div>
 - </div><!-- fragment --></div><!-- contents -->
 - <!-- start footer part -->
 - <hr class="footer"/><address class="footer"><small>
 - Generated on Mon Jun 14 2021 12:26:11 for DISTRHO Plugin Framework by  <a href="http://www.doxygen.org/index.html">
 - <img class="footer" src="doxygen.png" alt="doxygen"/>
 - </a> 1.8.17
 - </small></address>
 - </body>
 - </html>
 
 
  |