diff options
Diffstat (limited to 'doc/html/boost/dll/experimental/import_mangled.html')
| -rw-r--r-- | doc/html/boost/dll/experimental/import_mangled.html | 146 |
1 files changed, 146 insertions, 0 deletions
diff --git a/doc/html/boost/dll/experimental/import_mangled.html b/doc/html/boost/dll/experimental/import_mangled.html new file mode 100644 index 0000000000..c7f3f536ff --- /dev/null +++ b/doc/html/boost/dll/experimental/import_mangled.html @@ -0,0 +1,146 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function import_mangled</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../../boost_dll/reference.html#header.boost.dll.import_mangled_hpp" title="Header <boost/dll/import_mangled.hpp>"> +<link rel="prev" href="import_c_idm45899629424512.html" title="Function import_class"> +<link rel="next" href="../../../boost_dll/limitations.html" title="Limitations"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="import_c_idm45899629424512.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_dll/reference.html#header.boost.dll.import_mangled_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../../boost_dll/limitations.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.dll.experimental.import_mangled"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function import_mangled</span></h2> +<p>boost::dll::experimental::import_mangled</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../boost_dll/reference.html#header.boost.dll.import_mangled_hpp" title="Header <boost/dll/import_mangled.hpp>">boost/dll/import_mangled.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">filesystem</span><span class="special">::</span><span class="identifier">path</span> <span class="special">&</span> lib<span class="special">,</span> + <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> + <span class="identifier">load_mode</span><span class="special">::</span><span class="identifier">type</span> mode <span class="special">=</span> <span class="identifier">load_mode</span><span class="special">::</span><span class="identifier">default_mode</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">filesystem</span><span class="special">::</span><span class="identifier">path</span> <span class="special">&</span> lib<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">,</span> + <span class="identifier">load_mode</span><span class="special">::</span><span class="identifier">type</span> mode <span class="special">=</span> <span class="identifier">load_mode</span><span class="special">::</span><span class="identifier">default_mode</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">smart_library</span> <span class="special">&</span> lib<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">smart_library</span> <span class="special">&</span> lib<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="identifier">smart_library</span> <span class="special">&&</span> lib<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="identifier">smart_library</span> <span class="special">&&</span> lib<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">shared_library</span> <span class="special">&</span> lib<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">shared_library</span> <span class="special">&</span> lib<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="identifier">shared_library</span> <span class="special">&&</span> lib<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> + <span class="identifier">result_type</span> <span class="identifier">import_mangled</span><span class="special">(</span><span class="identifier">shared_library</span> <span class="special">&&</span> lib<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45928051759344"></a><h2>Description</h2> +<p>Returns callable object or boost::shared_ptr<T> that holds the symbol imported from the loaded library. Returned value refcounts usage of the loaded shared library, so that it won't get unload until all copies of return value are not destroyed.</p> +<p>For importing symbols by <span class="bold"><strong>alias</strong></span> names use <a class="link" href="../import_alias.html" title="Function import_alias">boost::dll::import_alias</a> method.</p> +<p><span class="bold"><strong>Examples:</strong></span> </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">function</span><span class="special"><</span><span class="keyword">int</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">></span> <span class="identifier">f</span> <span class="special">=</span> <span class="identifier">import_mangled</span><span class="special"><</span><span class="keyword">int</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">></span><span class="special">(</span><span class="string">"test_lib.so"</span><span class="special">,</span> <span class="string">"integer_func_name"</span><span class="special">)</span><span class="special">;</span> + +<span class="keyword">auto</span> <span class="identifier">f_cpp11</span> <span class="special">=</span> <span class="identifier">import_mangled</span><span class="special"><</span><span class="keyword">int</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">></span><span class="special">(</span><span class="string">"test_lib.so"</span><span class="special">,</span> <span class="string">"integer_func_name"</span><span class="special">)</span><span class="special">;</span> +</pre> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">i</span> <span class="special">=</span> <span class="identifier">import_mangled</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span><span class="special">(</span><span class="string">"test_lib.so"</span><span class="special">,</span> <span class="string">"integer_name"</span><span class="special">)</span><span class="special">;</span> +</pre> +<p>Additionally you can also import overloaded symbols, including member-functions.</p> +<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">fp</span> <span class="special">=</span> <span class="identifier">import_mangled</span><span class="special"><</span><span class="keyword">void</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">,</span> <span class="keyword">void</span><span class="special">(</span><span class="keyword">double</span><span class="special">)</span><span class="special">></span><span class="special">(</span><span class="string">"test_lib.so"</span><span class="special">,</span> <span class="string">"func"</span><span class="special">)</span><span class="special">;</span> +</pre> +<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">fp</span> <span class="special">=</span> <span class="identifier">import_mangled</span><span class="special"><</span><span class="identifier">my_class</span><span class="special">,</span> <span class="keyword">void</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">,</span> <span class="keyword">void</span><span class="special">(</span><span class="keyword">double</span><span class="special">)</span><span class="special">></span><span class="special">(</span><span class="string">"test_lib.so"</span><span class="special">,</span> <span class="string">"func"</span><span class="special">)</span><span class="special">;</span> +</pre> +<p>If qualified member-functions are needed, this can be set by repeating the class name with const or volatile. All following signatures after the redifintion will use this, i.e. the latest.</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> +<p>*</p> +<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">fp</span> <span class="special">=</span> <span class="identifier">import_mangled</span><span class="special"><</span><span class="identifier">my_class</span><span class="special">,</span> <span class="keyword">void</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">,</span> <span class="keyword">void</span><span class="special">(</span><span class="keyword">double</span><span class="special">)</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">my_class</span><span class="special">,</span> <span class="keyword">void</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">,</span> <span class="keyword">void</span><span class="special">(</span><span class="keyword">double</span><span class="special">)</span><span class="special">></span><span class="special">(</span><span class="string">"test_lib.so"</span><span class="special">,</span> <span class="string">"func"</span><span class="special">)</span><span class="special">;</span> +</pre> +</li></ul></div> +<p> +</p> +<p><span class="bold"><strong>Template</strong></span> <span class="bold"><strong>parameter</strong></span> <span class="bold"><strong>T:</strong></span> Type of the symbol that we are going to import. Must be explicitly specified.</p> +<p> + + +</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term">Parameters:</span></p></td> +<td><div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><code class="computeroutput">lib</code></span></p></td> +<td><p>Path to shared library or shared library to load function from. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">mode</code></span></p></td> +<td><p>An mode that will be used on library load.</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">name</code></span></p></td> +<td><p>Null-terminated C or C++ mangled name of the function to import. Can handle std::string, char*, const char*. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p>callable object if T is a function type, or boost::shared_ptr<T> if T is an object type.</p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>boost::system::system_error if symbol does not exist or if the DLL/DSO was not loaded. Overload that accepts path also throws std::bad_alloc in case of insufficient memory. </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2014 Renato Tegon Forti, Antony Polukhin<br>Copyright © 2015 Antony Polukhin<br>Copyright © 2016 Antony Polukhin, Klemens Morgenstern<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="import_c_idm45899629424512.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_dll/reference.html#header.boost.dll.import_mangled_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../../boost_dll/limitations.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |