mirror of
https://github.com/ThePhD/sol2.git
synced 2024-03-22 13:10:44 +08:00
75 lines
2.6 KiB
ReStructuredText
75 lines
2.6 KiB
ReStructuredText
|
state
|
||
|
|
=====
|
||
|
|
owning and non-owning state holders for registry and globals
|
||
|
|
------------------------------------------------------------
|
||
|
|
|
||
|
|
.. code-block:: cpp
|
||
|
|
|
||
|
|
class state_view;
|
||
|
|
class state : state_view, std::unique_ptr<lua_State*>;
|
||
|
|
|
||
|
|
The most important class here is ``state_view``. This structure takes a ``lua_State*`` that was already created and gives you simple, easy access to Lua's interfaces without taking ownership. ``state`` derives from ``state_view``, inheriting all of this functionality, but has the additional purpose of creating a fresh ``lua_State*`` and managing its lifetime for you in the default constructor.
|
||
|
|
|
||
|
|
The majority of the members between ``state_view`` and :doc:`sol::table<table>` are identical, with added for this higher-level type. Therefore, all of the examples and notes in :doc:`sol::table<table>` apply here as well.
|
||
|
|
|
||
|
|
enumerations
|
||
|
|
------------
|
||
|
|
|
||
|
|
.. _libenum:
|
||
|
|
|
||
|
|
.. code-block:: cpp
|
||
|
|
:caption: in-lua libraries
|
||
|
|
|
||
|
|
enum class lib : char {
|
||
|
|
base,
|
||
|
|
package,
|
||
|
|
coroutine,
|
||
|
|
string,
|
||
|
|
os,
|
||
|
|
math,
|
||
|
|
table,
|
||
|
|
debug,
|
||
|
|
bit32,
|
||
|
|
io,
|
||
|
|
count // do not use
|
||
|
|
};
|
||
|
|
|
||
|
|
This enumeration details the various base libraries that come with Lua. See the `standard lua libraries`_ for details about the various standard libraries.
|
||
|
|
|
||
|
|
|
||
|
|
members
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. code-block:: cpp
|
||
|
|
:caption: function: open standard libraries/modules
|
||
|
|
|
||
|
|
template<typename... Args>
|
||
|
|
void open_libraries(Args&&... args);
|
||
|
|
|
||
|
|
This function takes a number of :ref:`sol::lib<libenum>` as arguments and opens up the associated Lua core libraries.
|
||
|
|
|
||
|
|
.. code-block:: cpp
|
||
|
|
:caption: function: script / script_file
|
||
|
|
|
||
|
|
void script(const std::string& code);
|
||
|
|
void script_file(const std::string& filename);
|
||
|
|
|
||
|
|
These functions run the desired blob of either code that is in a string, or code that comes from a filename, on the ``lua_State*``.
|
||
|
|
|
||
|
|
.. code-block:: cpp
|
||
|
|
:caption: function: global table / registry table
|
||
|
|
|
||
|
|
global_table globals() const;
|
||
|
|
table registry() const;
|
||
|
|
|
||
|
|
Get either the global table or the Lua registry as a :doc:`sol::table<table>`, which allows you to modify either of them directly. Note that getting the global table from a ``state``/``state_view`` is usually unnecessary as it has all the exact same functions as a :doc:`sol::table<table>` anyhow.
|
||
|
|
|
||
|
|
|
||
|
|
.. code-block:: cpp
|
||
|
|
:caption: function: Lua set_panic
|
||
|
|
|
||
|
|
void set_panic(lua_CFunction panic);
|
||
|
|
|
||
|
|
Overrides the panic function Lua calls when something unrecoverable or unexpected happens in the Lua VM. Must be a function of the that matches the ``int(*)(lua_State*)`` function signature.
|
||
|
|
|
||
|
|
.. _standard lua libraries: http://www.lua.org/manual/5.2/manual.html#6
|