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

Getting used to travis...

Browse Source
This commit is contained in:
ThePhD 2016-02-24 22:38:05 -05:00
parent 2a5cd3bd49
commit 189a8eea4b
2 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,4 +1,4 @@
## Sol ## Sol 2
[![Build Status](https://travis-ci.org/Rapptz/sol.svg?branch=master)](https://travis-ci.org/Rapptz/sol) [![Build Status](https://travis-ci.org/Rapptz/sol.svg?branch=master)](https://travis-ci.org/Rapptz/sol)
@ -45,27 +45,30 @@ For maximum ease of use, a script called `single.py` is provided. You can run th
## Features ## Features
- Supports retrieval and setting of multiple types including `std::string`. - [Fast](http://satoren.github.io/lua_binding_benchmark/).
- Supports retrieval and setting of multiple types including `std::string` and `std::map/unordered_map`.
- Lambda, function, and member function bindings are supported. - Lambda, function, and member function bindings are supported.
- Intermediate type for checking if a variable exists. - Intermediate type for checking if a variable exists.
- Simple API that completely abstracts away the C stack API. - Simple API that completely abstracts away the C stack API, including `protected_function` with the ability to use an error-handling function.
- `operator[]`-style manipulation of tables - `operator[]`-style manipulation of tables
- C++ type representations in lua userdata as `usertype`s with guaranteed cleanup - C++ type representations in lua userdata as `usertype`s with guaranteed cleanup
- Support for tables. - Overloaded function calls: `my_function(1); my_function("Hello")` in the same lua script route to different function calls based on parameters
- Support for tables, nested tables, table iteration with `table.for_each`.
## Supported Compilers ## Supported Compilers
Sol makes use of C++11/14 features. GCC 4.7 and Clang 3.3 or higher should be able to compile without problems. However, the Sol makes use of C++11/14 features. GCC 4.7 and Clang 3.3 or higher should be able to compile without problems. However, the
officially supported compilers are: officially supported compilers are:
- GCC 4.9.0+ - GCC 4.8.0+
- Clang 3.6+ - Clang 3.4+
- Visual Studio 2015 Community (Visual C++ 14.0) - Visual Studio 2015 Community (Visual C++ 14.0) and above
## Caveats ## 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 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. Lua errors are thrown as exceptions instead: if you don't want to deal with errors thrown by at_panic, you can set your own panic function
or use the `protected_function` API. 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. 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>`. `#include <lua.hpp>`.