StarMirror/sol2
1
0
Fork 0
mirror of https://github.com/ThePhD/sol2.git synced 2024-03-22 13:10:44 +08:00
Code Issues Projects Releases Wiki Activity

Fixed documentation SNAFUs and typos. Praying for stack_get speed...

Browse Source
This commit is contained in:
ThePhD 2016-06-11 13:10:38 -04:00
parent 412718badb
commit 69b45e4d66
2 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/api/state.rst
View File

@ -56,7 +56,7 @@ This function takes a number of :ref:`sol::lib<lib-enum>` as arguments and opens
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*``. It will not run isolated: any scripts or code run will affect code in other states as well: code ran in this fashion is not isolated.
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*``. It will not run isolated: any scripts or code run will affect code in the ``lua_State*`` the object uses as well. Code ran in this fashion is not isolated. If you need isolation, consider creating a new state or traditional Lua sandboxing techniques.
.. code-block:: cpp
:caption: function: load / load_file
@ -65,7 +65,7 @@ These functions run the desired blob of either code that is in a string, or code
sol::load_result load(const std::string& code);
sol::load_result load_file(const std::string& filename);
These functions *load* the desired blob of either code that is in a string, or code that comes from a filename, on the ``lua_State*``. It will not run: it returns a ``load_result`` proxy that can be called, turned into a `sol::function`,. or similar, will run the loaded code.
These functions *load* the desired blob of either code that is in a string, or code that comes from a filename, on the ``lua_State*``. It will not run: it returns a ``load_result`` proxy that can be called to actually run the code, turned into a ``sol::function``, a ``sol::protected_function``, or some other abstraction. If it is called, it will run on the object's current ``lua_State*``: it is not isolated. If you need isolation, consider creating a new state or traditional Lua sandboxing techniques.
.. code-block:: cpp
:caption: function: global table / registry table

2
sol/stack_get.hpp
View File

@ -289,7 +289,6 @@ struct getter<T*> {
}
static T* get_no_nil_from(lua_State* L, void* udata, int index = -1) {
#if 0
#ifndef SOL_NO_EXCEPTIONS
if (luaL_getmetafield(L, index, &detail::base_class_check_key()[0]) != 0) {
void* basecastdata = lua_touserdata(L, -1);
@ -316,7 +315,6 @@ struct getter<T*> {
lua_pop(L, 1);
}
#endif // No Runtime Type Information || Exceptions
#endif // Speed test
T* obj = static_cast<T*>(udata);
return obj;
}