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
Sol3 (sol2 v3.0) - a C++ <-> Lua API wrapper with advanced features and top notch performance - is here, and it's great! Documentation:
209 Commits 3 Branches 96 Tags 29 MiB
C++ 90.1%
CMake 6.1%
C 2.1%
Shell 0.9%
Python 0.6%
Other 0.1%
423e44d6dc
Go to file
PrincessNyanara 423e44d6dc all tests compile excepted related to test_table_return_two(), which uses contiguous container std::vector but has key-value pairs inside of it 
c++ semantics dictate that it's accessed by index, but the tests seem to want to indicate that it should be accessed like a hashmap (or just using basic lua table semantics)
i have no idea how to make this incompatibility work in the new system...
i will ask repo master if he knows anything
2014-06-09 06:29:03 -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 all tests compile excepted related to test_table_return_two(), which uses contiguous container std::vector but has key-value pairs inside of it 2014-06-09 06:29:03 -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 all tests compile excepted related to test_table_return_two(), which uses contiguous container std::vector but has key-value pairs inside of it 2014-06-09 06:29:03 -04:00

README.md

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.