xref: /freebsd/contrib/lutok/README (revision a90b9d0159070121c221b966469c3e36d912bf82)
1Lutok is a lightweight C++ API library for Lua.
2
3Lutok provides thin C++ wrappers around the Lua C API to ease the
4interaction between C++ and Lua.  These wrappers make intensive use of
5RAII to prevent resource leakage, expose C++-friendly data types, report
6errors by means of exceptions and ensure that the Lua stack is always
7left untouched in the face of errors.  The library also provides a small
8subset of miscellaneous utility functions built on top of the wrappers.
9
10Lutok focuses on providing a clean and safe C++ interface; the drawback
11is that it is not suitable for performance-critical environments.  In
12order to implement error-safe C++ wrappers on top of a Lua C binary
13library, Lutok adds several layers or abstraction and error checking
14that go against the original spirit of the Lua C API and thus degrade
15performance.
16
17For further information on the contents of this distribution file,
18please refer to the following other documents:
19
20* AUTHORS: List of authors and contributors to this project.
21* COPYING: License information.
22* INSTALL: Compilation and installation instructions.
23* NEWS: List of major changes between formal releases.
24
25For general project information, please visit:
26
27    https://github.com/jmmv/lutok/
28