summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/sol2/docs/source/api/resolve.rst
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/sol2/docs/source/api/resolve.rst')
-rw-r--r--3rdparty/sol2/docs/source/api/resolve.rst28
1 files changed, 26 insertions, 2 deletions
diff --git a/3rdparty/sol2/docs/source/api/resolve.rst b/3rdparty/sol2/docs/source/api/resolve.rst
index d8811d43f5c..193e2fae80f 100644
--- a/3rdparty/sol2/docs/source/api/resolve.rst
+++ b/3rdparty/sol2/docs/source/api/resolve.rst
@@ -7,9 +7,9 @@ utility to pick overloaded C++ function calls
:caption: function: resolve C++ overload
template <typename... Args, typename F>
- auto resolve( F f );
+ constexpr auto resolve( F f );
-``resolve`` is a function that is meant to help users pick a single function out of a group of overloaded functions in C++. You can use it to pick overloads by specifying the signature as the first template argument. Given a collection of overloaded functions:
+``resolve`` is a function that is meant to help users pick a single function out of a group of overloaded functions in C++. It works for *both member and free functions* You can use it to pick overloads by specifying the signature as the first template argument. Given a collection of overloaded functions:
.. code-block:: cpp
:linenos:
@@ -18,6 +18,12 @@ utility to pick overloaded C++ function calls
int overloaded(int x, int y);
int overloaded(int x, int y, int z);
+ struct thing {
+ int overloaded(int x);
+ int overloaded(int x, int y);
+ int overloaded(int x, int y, int z);
+ };
+
You can disambiguate them using ``resolve``:
.. code-block:: cpp
@@ -26,6 +32,7 @@ You can disambiguate them using ``resolve``:
auto one_argument_func = resolve<int(int)>( overloaded );
auto two_argument_func = resolve<int(int, int)>( overloaded );
auto three_argument_func = resolve<int(int, int, int)>( overloaded );
+ auto member_three_argument_func = resolve<int(int, int, int)>( &thing::overloaded );
This resolution becomes useful when setting functions on a :doc:`table<table>` or :doc:`state_view<state>`:
@@ -37,3 +44,20 @@ This resolution becomes useful when setting functions on a :doc:`table<table>` o
lua.set_function("a", resolve<int(int)>( overloaded ) );
lua.set_function("b", resolve<int(int, int)>( overloaded ));
lua.set_function("c", resolve<int(int, int, int)>( overloaded ));
+
+
+It can also be used with :doc:`sol::c_call<c_call>`:
+
+.. code-block:: cpp
+ :linenos:
+
+ sol::state lua;
+
+ auto f = sol::c_call<
+ decltype(sol::resolve<int(int, int)>(&overloaded)),
+ sol::resolve<int(int, int)>(&overloaded)
+ >;
+ lua.set_function("f", f);
+
+ lua.script("f(1, 2)");
+