Sol3 (sol2 v3.0) - a C++ <-> Lua API wrapper with advanced features and top notch performance - is here, and it's great! Documentation:
Go to file
PrincessNyanara 77901bb654 massive rework of stack
get turned into getter<T>, matches pusher<T> and uses same semantics as std::allocator and other things used throughout the codebase
-----
userdata has its traits defined outside in new file of userdata to prevent errors when trying to use those typetraits in places before userdata.hpp gets included
userdata was changed to support returning itself via pointers or references.
rework of stack changes semantics based on T&, T*, and T&& (the last one tries to create a new userdata and move in data)
solves problems maybe presented in https://github.com/Rapptz/sol/issues/25

-----
container.hpp is attempt at solving original problem before going on wild tangent with userdata, stack, and get
is going to attempt to use userdata to allow transporation of containers losslessly, perhaps without copying need
-----
found out trying to return a std::function does not work -- not sure what do exactly?
perhaps should push c closure as last thing, but right now it is tied to a key value (code comes from table.hpp and set_function)
will just have to think over how stack arranges itself and learn what to do
2014-06-09 06:28:55 -04:00
Catch@a6d74bd55a CATCH for tests. 2013-12-11 06:38:25 -05:00
examples Add examples for userdata 2014-04-27 05:36:57 -04:00
sol massive rework of stack 2014-06-09 06:28:55 -04:00
.gitignore Switched over to bootstrap.py script 2014-06-05 18:37:46 -04:00
.gitmodules CATCH for tests. 2013-12-11 06:38:25 -05:00
bootstrap.py Fix typo with bootstrap.py 2014-06-05 18:45:59 -04:00
CONTRIBUTING.md Add contributing guidelines 2013-12-14 05:26:43 -05:00
LICENSE.txt Initial commit 2013-11-25 04:56:27 -05:00
ninja_syntax.py Switched over to bootstrap.py script 2014-06-05 18:37:46 -04:00
README.md Update README 2014-01-18 23:07:55 -05:00
sol.hpp massive rework of stack 2014-06-09 06:28:55 -04:00
tests.cpp Add tests covering creation of tables from standard containers 2014-06-01 02:41:16 -04:00

Sol

Sol is a C++ library binding to Lua. It currently supports Lua 5.2. Sol aims to be easy to use and easy to add to a project. At this time, the library is header-only for easy integration with projects.

Sneak Peek

#include <sol.hpp>
#include <cassert>

int main() {
    sol::state lua;
    int x = 0;
    lua.set_function("beep", [&x]{ ++x; });
    lua.script("beep()");
    assert(x == 1);
}

More examples are given in the examples directory.

Features

  • Supports retrieval and setting of multiple types including std::string.
  • Lambda, function, and member function bindings are supported.
  • Intermediate type for checking if a variable exists.
  • Simple API that completely abstracts away the C stack API.
  • operator[]-style manipulation of tables is provided.
  • Support for tables.

Supported Compilers

Sol makes use of C++11 features. GCC 4.7 and Clang 3.3 or higher should be able to compile without problems. Visual Studio 2013 with the November CTP should be able to support this as well.

Caveats

Due to how this library is used compared to the C API, the Lua Stack is completely abstracted away. Not only that, but all Lua errors are thrown as exceptions instead. This allows you to handle the errors gracefully without being forced to exit.

It should be noted that the library itself depends on lua.hpp to be found by your compiler. It uses angle brackets, e.g. #include <lua.hpp>.

License

Sol is distributed with an MIT License. You can see LICENSE.txt for more info.

TODO

  • Possibly document functions and classes via doxygen.
  • Provide more examples to showcase uses.