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 a39679293c add constructors and assignment operators for protected function results and the like
improve documentation about saving compilation time and space
add docs about the two `script_..._error` functions
update single
2017-08-27 00:05:35 -04:00
Catch@b1835e1de9 Update catch internally and make sure there's no errors in the tests for unused variables 2017-02-18 05:05:33 -05:00
docs add constructors and assignment operators for protected function results and the like 2017-08-27 00:05:35 -04:00
examples Mmmn, still can't type conditionals 2017-08-24 17:49:08 -04:00
single/sol add constructors and assignment operators for protected function results and the like 2017-08-27 00:05:35 -04:00
sol add constructors and assignment operators for protected function results and the like 2017-08-27 00:05:35 -04:00
.gitignore gcc plagues me , and will continue to, for a while to come 2017-08-07 02:07:21 -04:00
.gitmodules Ditch the dependency on the optional submodule, nobody's ever gonna care about it... 2016-11-01 05:31:59 -04:00
.travis.yml update travis 2017-08-11 23:22:30 -04:00
bootstrap.py large integer 2017-08-11 11:39:46 -04:00
CONTRIBUTING.md Handle qualified name failures of VC++, where using templates do not match the fully qualified names of what they alias to (Thanks, VC++) 2017-05-15 10:41:50 -04:00
install.deps.sh package management is stupid and the people who made it are full of shit 2016-08-22 23:22:17 -04:00
LICENSE.txt Handle qualified name failures of VC++, where using templates do not match the fully qualified names of what they alias to (Thanks, VC++) 2017-05-15 10:41:50 -04:00
ninja_syntax.py Switched over to bootstrap.py script 2014-06-05 18:37:46 -04:00
README.md overhaul examples and add 2 new ones in preparation for the coming hell 2017-08-06 12:20:32 -04:00
single.py Handle qualified name failures of VC++, where using templates do not match the fully qualified names of what they alias to (Thanks, VC++) 2017-05-15 10:41:50 -04:00
sol.hpp C++17 additions: std::variant, string_views of all types, checker for if we have the right version 2017-07-09 12:54:52 -04:00
test_container_semantics.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_containers.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_coroutines.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_customizations.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_environments.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_filters.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_functions.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_gc.cpp update table documentation and force traits not to use a deleted destructor -- rather, default it according to what it inherits 2017-08-22 10:53:46 -04:00
test_inheritance.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_large_integer.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_operators.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_overflow.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_plain_types.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_simple_usertypes.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_stack_guard.hpp Many of the tests are still busted, but we're getting closer. 2016-06-06 15:46:53 -04:00
test_state.cpp add constructors and assignment operators for protected function results and the like 2017-08-27 00:05:35 -04:00
test_storage.cpp C++17 additions: std::variant, string_views of all types, checker for if we have the right version 2017-07-09 12:54:52 -04:00
test_strings.cpp vetting for C++17 2017-07-09 19:04:51 -04:00
test_tables.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_usertypes.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_utility.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
test_variadics.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
tests.cpp "automatic usertypes" are now applied everywhere, regardless of what happens 2017-08-21 15:25:43 -04:00
tmp_thingy_user.lua add as_container documentation 2017-08-11 03:24:17 -04:00

Sol 2.18

Join the chat at https://gitter.im/chat-sol2/Lobby

Build Status Documentation Status

Sol is a C++ library binding to Lua. It currently supports all Lua versions 5.1+ (LuaJIT 2.x included). Sol aims to be easy to use and easy to add to a project. The library is header-only for easy integration with projects.

Documentation

Find it here. A run-through kind of tutorial is here! The API documentation goes over most cases (particularly, the "api/usertype" and "api/proxy" and "api/function" sections) that should still get you off your feet and going, and there's an examples directory here as well.

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);
}
#include <sol.hpp>
#include <cassert>

struct vars {
    int boop = 0;
};

int main() {
    sol::state lua;
    lua.new_usertype<vars>("vars", "boop", &vars::boop);
    lua.script("beep = vars.new()\n"
               "beep.boop = 1");
    assert(lua.get<vars>("beep").boop == 1);
}

More examples are given in the examples directory.

Presentations

"A Sun For the Moon - A Zero-Overhead Lua Abstraction using C++"
ThePhD
Lua Workshop 2016 - Mashape, San Francisco, CA
Deck

Creating a single header

You can grab a single header out of the library here. For stable version, check the releases tab on github for a provided single header file for maximum ease of use. A script called single.py is provided in the repository if there's some bleeding edge change that hasn't been published on the releases page. You can run this script to create a single file version of the library so you can only include that part of it. Check single.py --help for more info.

Features

  • Fastest in the land (see: sol bar in graph).
  • Supports retrieval and setting of multiple types including std::string and std::map/unordered_map.
  • 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, including protected_function with the ability to use an error-handling function.
  • operator[]-style manipulation of tables
  • C++ type representations in lua userdata as usertypes with guaranteed cleanup.
  • Customization points to allow your C++ objects to be pushed and retrieved from Lua as multiple consecutive objects, or anything else you desire!
  • 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 / begin() and end() iterators.

Supported Compilers

Sol makes use of C++11 and C++14 features. GCC 5.x.x and Clang 3.6.x (with std=c++1z and appropriate standard library) or higher should be able to compile without problems. However, the officially supported and CI-tested compilers are:

  • GCC 5.x.x+
  • Clang 3.6.x+
  • Visual Studio 2015 Community (Visual C++ 14.0)+

Please make sure you use the -std=c++1y, -std=c++14, -std=c++1z, -std=c++17 or better standard flags (some of these flags are the defaults in later versions of GCC 6+ and better).

Older compilers (GCC 4.9.x, Clang 3.4.x seem to be the lowest) can work with versions as late as v2.17.5, with the flag -std=c++14 or -std=c++1y.

License

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