mirror of
https://github.com/ThePhD/sol2.git
synced 2024-03-22 13:10:44 +08:00
Update README
This commit is contained in:
Rapptz
parent
c123fd9204
commit
172096e016
148
README.md
148
README.md
|
|
@ -1,69 +1,79 @@
|
|||
## 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
|
||||
|
||||
```cpp
|
||||
#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);
|
||||
}
|
||||
```
|
||||
|
||||
```cpp
|
||||
#include <sol.hpp>
|
||||
#include <cassert>
|
||||
|
||||
struct vars {
|
||||
int boop = 0;
|
||||
};
|
||||
|
||||
int main() {
|
||||
sol::state lua;
|
||||
lua.new_userdata<vars>("vars", "boop", &vars::boop);
|
||||
lua.script("local beep = vars.new()\n"
|
||||
"beep.boop = 1");
|
||||
assert(lua.get<vars>("beep").boop == 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.
|
||||
## Sol
|
||||
|
||||
[](https://travis-ci.org/Rapptz/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
|
||||
|
||||
```cpp
|
||||
#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);
|
||||
}
|
||||
```
|
||||
|
||||
```cpp
|
||||
#include <sol.hpp>
|
||||
#include <cassert>
|
||||
|
||||
struct vars {
|
||||
int boop = 0;
|
||||
};
|
||||
|
||||
int main() {
|
||||
sol::state lua;
|
||||
lua.new_userdata<vars>("vars", "boop", &vars::boop);
|
||||
lua.script("local beep = vars.new()\n"
|
||||
"beep.boop = 1");
|
||||
assert(lua.get<vars>("beep").boop == 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. However, the
|
||||
officially supported compilers are:
|
||||
|
||||
- GCC 4.8.0
|
||||
- GCC 4.9.0
|
||||
- Clang 3.4
|
||||
|
||||
Visual Studio 2013 with the November CTP could possibly compile it, despite not being explicitly supported. The last
|
||||
version that Visual Studio 2013 was supported was on tag v0.9.0. Anything after that is wishful hope. In order to retrieve
|
||||
that tagged version, just do `git checkout v0.9.0`.
|
||||
|
||||
## 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.
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user