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
ThePhD d7ea4718c8 multi_return<> name to return_type<> .
Makes more sense, as the return does not always have to be multiple types.
(Indeed, it is specialized for 1 and 0 cases).
2014-05-08 13:08:21 -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 multi_return<> name to return_type<> . 2014-05-08 13:08:21 -04:00
.gitignore Switch from static member strings to userdata_traits 2014-04-27 05:08:39 -04:00
.gitmodules CATCH for tests. 2013-12-11 06:38:25 -05:00
build.ninja Renamed sol.scratch.cpp to tests.cpp 2013-12-12 05:40:05 -05: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
README.md Update README 2014-01-18 23:07:55 -05:00
sol.hpp function header with addition to sol.hpp so that a person can do function invocations on lua functions without explicitly adding sol/functions.hpp 2013-12-01 18:15:26 -05:00
tests.cpp Add new_userdata to create internally memory managed userdata from sol::state 2014-04-27 05:09:28 -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.