diff options
Diffstat (limited to 'lib/sol2/docs/source/tutorial/existing.rst')
| -rw-r--r-- | lib/sol2/docs/source/tutorial/existing.rst | 39 |
1 files changed, 0 insertions, 39 deletions
diff --git a/lib/sol2/docs/source/tutorial/existing.rst b/lib/sol2/docs/source/tutorial/existing.rst deleted file mode 100644 index a78d046..0000000 --- a/lib/sol2/docs/source/tutorial/existing.rst +++ /dev/null @@ -1,39 +0,0 @@ -integrating into existing code -============================== - -If you're already using lua and you just want to use ``sol`` in some places, you can use ``state_view``: - -.. code-block:: cpp - :linenos: - :caption: using state_view - :name: state-view-snippet - - int something_in_my_system (lua_State* L) { - // start using sol with a pre-existing system - sol::state_view lua(L); // non-owning - - lua.script("print('bark bark bark!')"); - - // get the table off the top of the stack - sol::table expected_table(L, -1); - // start using it... - - return 0; // or whatever you require of working with a raw function - } - -:doc:`sol::state_view<../api/state>` is exactly like ``sol::state``, but it doesn't manage the lifetime of a ``lua_State*``. Therefore, you get all the goodies that come with a ``sol::state`` without any of the ownership implications. sol has no initialization components that need to deliberately remain alive for the duration of the program. It's entirely self-containing and uses lua's garbage collectors and various implementation techniques to require no state C++-side. After you do that, all of the power of `sol` is available to you, and then some! - -``sol::state_view`` is also helpful when you want to `create a DLL that loads some Lua module`_ via requires. - -You may also want to call ``require`` and supply a string of a script file or something that returns an object that you set equal to something in C++. For that, you can use the :ref:`require functionality<state-require-function>`. - -Remember that sol can be as lightweight as you want it: almost all of sol's Lua types take the ``lua_State*`` argument and then a second ``int index`` stack index argument, meaning you can use :doc:`tables<../api/table>`, :doc:`lua functions<../api/function>`, :doc:`coroutines<../api/coroutine>`, and other reference-derived objects that expose the proper constructor for your use. You can also set :doc:`usertypes<../api/usertype>` and other things you need without changing your entire architecture in one go. - -You can even customize it to `work with an external Lua wrapper/framework/library`_. - -Note that you can also make non-standard pointer and reference types with custom reference counting and such also play nice with the system. See :doc:`unique_usertype_traits\<T><../api/unique_usertype_traits>` to see how! Custom types is also mentioned in the :doc:`customization tutorial<customization>`. - -There are a few things that creating a ``sol::state`` does for you. You can read about it :ref:`in the sol::state docs<state-automatic-handlers>` and call those functions directly if you need them. - -.. _create a DLL that loads some Lua module: https://github.com/ThePhD/sol2/tree/develop/examples/require_dll_example -.. _work with an external Lua wrapper/framework/library: https://github.com/ThePhD/sol2/tree/develop/examples/interop |