Binding Code To Lua

wiki

Lua can be embedded and extended[1] with code or applications written in other languages. Code and values in another language can be exposed to Lua and vice-versa. The following lists low and high level solutions for binding between Lua and other languages.

Lua C API

The most direct method to bind to Lua is with the Lua C API. The C API consists of two parts: the basic API (lua.h) provides the primitive functions for all interactions between C and Lua, while the auxiliary library (lauxlib.h) provides higher-level functions for some common tasks.[2]

[The Lua 5.1 Reference Manual: The Application Program Interface] (5.1) describes Lua's native C API for calling Lua from C and vice-versa.

See also Lua book [PIL2]. Or read about the C API online in the 1st edition of PIL: [PIL1 - The C API]

Enabling API checking

By default, the Lua C API does almost no sanity checking of arguments passed to it. Passing incorrect stack indexes, for example, can result in segfaults or random data corruption. You should always enable API checking in any debug build. You can do this by compiling with the option -DLUA_USE_APICHECK. luaconf.h uses this C macro to define luai_apicheck to call assert() in various places (you can also edit this definition to do something possibly more useful).

Example

Some examples of using the C API can be found by examining the source code of Lua's own standard libraries (src/*lib.c}. For example, the math library (math.*) is implemented in the file src/lmathlib.c. The basic form of this file is outlined below. First we import various headers, including the C API (lua.h) and the axillary library (lauxlib.h):


#define LUA_LIB

#include "lua.h"

#include "lauxlib.h"

Then various Lua functions implemented in C are defined. These all have the same signature, and arguments are passed via Lua's own stack. For example, the sin function is defined as follows. luaL_check_number() is used to check the correct type of the sin function argument. lua_pushnumber() is used to return the sine calculated. Note, the return value of the math_sin() function is the number of values returned (lua functions can return many values).


static int math_sin (lua_State *L) {

  lua_pushnumber(L, sin(luaL_checknumber(L, 1)));

  return 1;

}

These functions are registered into Lua by building a table of function pointers and names and then calling luaL_register(). Constants pi and huge are set separately. This registration code is placed in a function named luaopen_math(), which can be called statically (e.g. from linit.c) or dynamically (via Lua's shared library loading mechanism via require).


static const luaL_reg mathlib[] = {

{"abs",   math_abs},

{"cos",   math_cos},

{"sin",   math_sin},

... etc...rest of table not included, but make sure you finish of with:

{NULL, NULL}

};



/*

** Open math library

*/

LUALIB_API int luaopen_math (lua_State *L) {

  luaL_register(L, LUA_MATHLIBNAME, mathlib);

  lua_pushnumber(L, PI);

  lua_setfield(L, -2, "pi");

  lua_pushnumber(L, HUGE_VAL);

  lua_setfield(L, -2, "huge");

  return 1;

}

Binding C/C++ with Lua

C

[LuaAutoC] (5.2) - Automatically wrap C functions and structs at runtime.
[LuaNativeObjects] (5.1) - A C bindings generator written in Lua. It turns C structs into objects.
[luapi] (5.0) - a C API over the official Lua API.
[CaLua] (5.0) - A way to bind C functions and structures to Lua, and work with C pointers, arrays and functions in Lua. (uses x86 assembly)

C Foreign Function Interfaces (FFI)

[Alien] (5.1) - a foreign function interface (FFI) for Lua. An [FFI] lets Lua code call C functions directly without having to write C "glue", so you can use Alien to write C extensions purely in Lua. (Wraps libffi)
[C/Invoke for Lua] (5.1) - Use [C/Invoke] from Lua to call C libraries (DLLs, .so files) directly, like Microsoft's P/Invoke and Python's ctypes. (Similar to Alien)
[The LuaJIT FFI] allows calling external C functions and using C data structures from Lua code. It parses plain C declarations and supports C99 plus some GCC/MSVC/C++ extensions.
[luaffi] (5.1) - an implementation of LuaJIT FFI for Lua.

C Inline

[lua-tcc] (5.1) - Simple interface to TCC, a fast runtime C compiler by Fabrice Bellard, it allows a Lua script to compile C code and register it at runtime as Lua-callable C funcions. Intentionally limited to avoid TCC's bug with multi-environments, that would be too tempting in Lua.
[Luatcc] (5.1) - another, more complete, Lua binding for libtcc, which is the core library of the [Tiny C Compiler]. It allows compiling and loading C code directly from Lua, includes the ability to load C modules directly from C source.
InlineCee provides a similar approach, invoking other compilers out-of-process.

C++

Various C++ or C++ template bindings have been developed to simplify the process in C++:

[CppLua] (5.0 & 5.1) - a C++ wrapper of the Lua API; handles class member functions.
[LuaCppInterface] (5.2) - a C++ wrapper of the Lua API. Uses TMP to make calling/passing functions, handling coroutines and filling tables easy and type-safe.
[sol] (5.2) - a C++11 easy to use and type safe wrapper of the Lua API.
[Diluculum] (5.1) - A library that intends to make the coexistence of C++ and Lua more harmonious.
[Tomaka17's lua wrapper] (5.2) - Simple bindings for Lua using C++11 supporting class and function registration, custom member functions, multiple return values, tables and more.
[Luabind] (5.1 & [5.2]) - a template-based binding of C++ classes and functions which uses the Boost library. The library seems to be abandoned by the [original authors], but some more or less actively maintained [forks] exist, e.g. [3] or [4].
[LuaBridge] (5.1 & 5.2) - lightweight, dependency-free, template-based library for exporting C++ classes/functions to Lua environments.
[SLB] (5.2) - Simple Lua Binder, a cross platform, small, easy to integrate, template-based library. Very similar to Luabind or boost-python but SLB doesn't require boost or any other dependency.
[Luna] (4.0), LunaWrapper (5.1) and LunaFive(5.2) - clean, template-based method of binding a C++ class to Lua. See also [LTN5] and SimplerCppBinding.
[MLuaBind] (5.1) - a template-based binding of C++ classes and functions which uses the Loki library.
[MultiScript] (5.1) - a simple library that demonstrates Lua independent C++ interface to bind C++ classes and functions.
[OOLua] (5.1, 5.2 & 5.3 work2) - Cross platform template generator binding which has no dependencies.
[Selene] (5.2) - Dead simple and intuitive C++11 bindings supporting class registration and functions.
[Sweet Lua] (5.1) - a template-based binding of C++ classes and functions. (MSVC)
[lux] - emits functions at compile time via C++ templates and argument overloading
[dub] - Creates bindings to Lua by using Doxygen to parse C++ headers. Supports many advanced features (namespaces, type casting, natural public member read/write, template resolution, etc).
[nlua] - 'namespace lua' binding of C/C++ functions, table-like usage, templated based (no boost)
[LuaWrapper] - A single header library that provides type-safe and intuitive functions such as luaW_to<T> and luaW_push<T> for arbitrary types, to make managing C++ classes with Lua simple.
[luna-gen] - Automatic lua binding-code generator. Fully-featured, fast compilation and execution speed, human-readable output codes, and no boost dependency.
[Lutok] - Lightweight C++ API for Lua. Lutok provides provides thin C++ wrappers around the Lua C API to ease the interaction between C++ and Lua. These wrappers make intensive use of RAII to prevent resource leakage, expose C++-friendly data types, report errors by means of exceptions and ensure that the Lua stack is always left untouched in the face of errors. The library also provides a small subset of miscellaneous utility functions built on top of the wrappers.
[lualite] - Very lightweight library for creating Lua bindings. Boost is not a dependency.
[integral] - C++ library with no dependencies for creating Lua bindings.
[lua-intf] (5.1 & 5.2) - Pure C++11 API and binding for Lua (headers only), supports lua stack API, a higher level API that can refer lua object just like a C++ class object, and can also export C++ class and functions for lua script. The export binding supports custom C++ type, multiple return values, C++ shared pointer, in/out arguments, and can also make argument optional or with default value. The new version also comes with an optional Qt data type mapping (QString, QVariant, QByteArray, etc...).
[LuaState] (5.1 & 5.2) - C++11 template library (clang, gcc and VS 12) no boost. Made to be really easy to use and as fast as possible. Lambda based bindings from Lua to C++.

See also:

DoItYourselfCppBinding - provides a few simple code fragments for helping Lua and C++ work together
LuaGenPlusPlus - luagen++, a C++ header file to generate efficient sequences of Lua C API calls at compile-time via template metaprogramming techniques
CppStreamChunkReader - lua_load chunk reader for any C++ std::istream (function)
CppConvenientLuaWrapperClass
CppObjectBinding
ExtractingWxClasses
[A comparison of LuaBind, SWIG, OOLua, and toLua++] - One developer's attempt to find a good binding framework for use in a memory-constrained environment.

Calling Lua from C/C++

These frameworks and articles are one-way bindings: to call Lua functions from C/C++ passing arguments and getting return values.

[A Generic Call Function] (5.0) - from PiL uses a format string to call a global function with a variable number of arguments.
[LuaGenericCall] (5.1) - uses code snippets and printf/scanf like format strings to support many types and features.
[LuaClassBasedCall] (5.1) - uses code snippets along with C++ constructor overloads and templates, supports nearly all C++ types.
[lua_icxx] (5.1) - embeds a Lua interpreter in a C++ application, using an OO API. See also SimpleLuaIcxxExample.
SimpleLuaApiExample - example using the C API: the C program loads/runs a Lua script file, sets Lua variables and retrieves return value.
CppLuaDataPassing - another more advanced example using regular C API to run a Lua script file with arguments.
GettingValuesFromLua - explanation of how to get return values from lua_dostring.
CallingLuaFromCpp - example to use the Luna binding (see above) to call Lua from C++.

Embedding Lua in C++

These frameworks are a little broader than the previous ones: they allow your C++ program full interaction with a Lua interpreter, but leave the task of extending Lua to other binding systems (SWIG, tolua++, and others).

[lua_icxx]: (pronounced "lua-ix") Lua interpreter for C++; call Lua functions and User Data (class) methods, use tables, create function sandboxes, use multiple return values, evaluate expressions and scripts, and more. The missing link for use of bindings like SWIG and tolua++.

Automatic binding generators

[toLua] (5.2) - If there is a lot of information to bind then automating the process using a binding generator can help. toLua is one such tool. A package file is prepared, which is a cleaned up version of the C/C++ interface. Another advantage of this technique is that less work may be required between Lua versions if the Lua C API changes significantly.
[tolua++] (5.1) - an extended version of tolua, with some extra features oriented to c++. See also CompilingToluappWithoutScons (compiling tolua++ without SCons).

[CPB] (5.0) - A simple, fast, and powerful binding library for the Lua scripting language. It takes the information from the compilers symbols and generates binding code directly from it. (MSVC)

[SWIG] (5.0/5.1) - Simplified Wrapper and Interface Generator, it can generate bindings between your C/C++ code and a variety of scripting languages (Python, Perl, Tcl/Tk, Ruby, ...), including Lua. A big advantage might be that *one* interface file, similar to that used in tolua/tolua++, is used for bindings to all languages supported by SWIG. See also the SWIG docs pertaining to Lua [5].

[luna-gen] - lua binding-code generator that supports features such as properties, inheritance (both from lua and c++), namespace, enum, type-checking, c++ exception handling, adopt-policy, g++ and MSVS, operator overloading, user-configurable custum string and number/enum types and so on. Fast compilation and execution speed (much faster than luabind and SWIG), human-readable output codes, no boost dependency.

[dub] - Uses Doxygen to parse C++ headers. Supports features such as properties, inheritance, type casting, Lua wrapping, enum, exception handling, operators, custom type binding, C++ template resolution, C++ callbacks with error handling, overloaded methods with runtime type resolution, etc. The generated code is optimized to be as fast as possible (return value optimization, inline objects, etc).

Proxy wrapper for DLL

Function information can be exported from dynamically linked libraries. [FuBi] describes a method to call these functions from script (or RPC). This functionality can be used from Lua [6].

Miscellaneous

[wxScript] (5.0) - A set of abstract classes to add script-interpreter support to your wxWidgets applications/libraries.

Other languages

Ada

[Lua-Ada] (5.0) - Lua binding to Ada 95. (link broken)
[lua-ada] (5.1) - Ada bindings to the Lua language (public domain)

Bash Shell

The luabash tool is a dynamically loadable module for the bash shell that provides a bridge between the bash shell and the lua scripting language. This enables complex embedded code segments to be replaced with efficient lua code and the speed of shell scripts to be increased without the drastic need to rewrite existing code.

Basic

[FreeBASIC] - A open-source BASIC compiler that comes with the Lua headers and libraries.
[PBLua] (5.0.2) - a Purebasic library wrapping Lua 5.0.2. (deprecated)
[PowerBLua] (5.0) - PowerBASIC include & source for wrapping Lua (work in progress).
[BlitzMax] (5.1.2) - a BlitzMax module wrapping Lua 5.1.2 (note: the link currently points into this wiki (which is usually a bad idea in this list) but this will change as soon as the package has its own web site)

COBOL

[OpenCOBOL] (5.1) - Using Lua with OpenCOBOL 1.1
[OCLua] - Generated documentation from the OpenCOBOL interface source code

D

[LuaD] (5.1) - Lua bindings and high-level interfaces for the D programming language.
[DLua] (5.1) - Lua bindings for the D programming language.

Erlang

[erlua] (5.1) - aims to enable seamless interoperability between Erlang and Lua.
[erl-lua] (5.1) - an Erlang linked-in driver that allows embedding Lua into the Erlang VM.
[erluna] (5.1) - Lua bindings for Erlang.

Fortran

[Aotus] (5.2) - aims to enable seamless usage of Lua scripts for configuration of Fortran applications, uses the ISO-C-Binding.
[f2k3-lua] - Interaction with Lua via the Fortran 2003 ISO-C-Binding.

Go

[golua] (5.1) - Lua bindings for Go.
[luar] (5.1) - a reflection layer on top of golua API providing a simplified way to publish go functions to a Lua VM..

Haskell

[HsLua] (5.1) - Scripting.Lua binding for Haskell.

Java

[LuaJava] (5.1) - allows scripts written in Lua to manipulate components developed in Java (JNI to native Lua) and vice-versa.
[JNLua] (5.2, 5.1) - another Java JNI <-> Lua bridge. Includes JSR 223 (Scripting for the Java Platform) provider.
[jna-lua] - Java JNA <-> native Lua bridge.

LabVIEW

[LuaVIEW] (5.0, 5.1) - embedding Lua into National Instruments LabVIEW.

Objective-C

[LuaObjCBridge] (5.1) - calling Lua from Objective-C and vice-versa (MacOS X Cocoa).
[LuaCore] (5.1) - a LuaObjCBridge-based framework, makes it easy to setup and run Lua scripts.
[LuaCocoa] (5.1) - spiritual successor to LuaObjCBridge/LuaCore?, bridge between Lua & Obj-C, and uses Apple's BridgeSupport? to fill in remaining non-ObjC areas (e.g. structs, C functions, inline functions) to access all APIs on the platform. Also includes a command line tool suitable for writing AppleScript? in Lua via ScriptingBridge?. (Mac OS X).
[iPhone Wax] (5.1) - a bridge between Lua and all the Objective-C/CocoaTouch classes.
[Objective Lua] (5.1) - brings Objective-C-like syntax to Lua.
[TLC] (LuaJIT 2) - A lightweight (Under 400 lines, pure Lua) bridge that exposes Objective-C objects&methods to Lua.

OCaml

[ocaml-lua] (5.1.x) - calling Lua from OCaml and vice-versa (tested only in Linux, should work with OS X).

Pascal

[Pascal bindings] (5.1 to 5.3) - Aims to keep up-to-date Pascal bindings for the Lua library, both for Delphi and Freepascal.
[LuaPascal] (5.1) - Integrates Lua and Object Pascal languages. Allows Lua to manipulate components developed in Pascal/Delphi.
[Lua4Delphi] (5.1) - Delphi and VCL Lua interface and Util functions.
LuaDelphi (5.1) - calling Lua from Delphi/Pascal.
[Lua 5.1 for Delphi 2010] (5.1) - Delphi 2009 and Delphi 2010 Lua interface with OOP callback functions.
[Lua4Delphi] (5.1) - for Delphi 2010 and XE.
[THlua] (5.0) - Lua distribution for Delphi/Kylix/FreePascal. Includes header files, samples, some utils. For Windows, there are also LuaBinaries and project files for Visual Studio 6. Last updated in 2003.
[Delphi-Lua] (5.0) - calling Lua from Delphi/Pascal.
[DLua] (5.0) - calling Lua from Delphi/Pascal.
[Free Pascal] Pascal units lua, lualib, lauxlib corresponding closely to the usual C API and axiliary library. See LuaInFreePascal.

Perl

[LuaPerl] (5.1) - calling Perl (5.8 and 5.10 streams) from Lua.
[Inline::Lua] (5.1) - calling Lua from Perl (inline).
[Data::Lua] (5.1) - parse variables out of Lua code. Relies on Inline::Lua.
[re::engine::Lua] (5.1) - supplies the Lua regular expression dialect for Perl.

PHP

[LuaPhpExtension] (5.1) - PHP extension which allows embedding the Lua interpreter in a PHP application.
[Nutria] (5.1) - PHP Standard Library written in Lua.

Python

LunaticPython [7] (5.1) - Lua/Python two-way bridge. Allows embedding of Lua interpreter in Python programs, and embedding of Python interpreter in Lua programs.
[Lupa] (LuaJIT2) - Embedded Lua in Python. Allows two-way communication between Python and Lua code and tries to adhere to common behaviour on both sides.

Ruby

[RubyLuaBridge] (5.1) - calling Lua from Ruby (calling Ruby from Lua is planned)
[rub-lua5] (5.0) - calling Lua from Ruby.

Tcl

[ltcltk] (5.1) - a binding of Tcl and Tk for Lua.
[LuaTclBridge] (5.0) - a Lua<->Tcl bridge.
[TcLux] (4.0) - Tcl extension which embeds Lua into Tcl.
See also [Lua] on Tcl.tk wiki.

Frameworks

CORBA

[OiL] (5.1) - ORB in Lua ([CORBA])

Windows COM

LuaCom - (5.1/5.0) Lua interface to Microsoft's Component Object Model (COM). Calling COM objects from Lua and implementing COM objects in Lua.

Windows .NET

[dotLua] (5.0) - A .NET/CLI library, wrapping the Lua API.
LuaInterface [8] (5.1) - a library for integration between the Lua language and Microsoft .NET platform's Common Language Runtime (CLR). Lua scripts can use it to instantiate CLR objects, access properties, call methods, and even handle events with Lua functions.
[LuaNETInterface] [9] (5.1) - a modification of LuaInterface to provide definition of Lua functions using attributes and loaded into the Lua engine using reflection.
[NLua] (5.2) - a fork of LuaInterface which is active as of 2014

Firefox

[Moonshine] - embedded Lua environment for the Firefox web browser. Allows Firefox extensions to be developed in Lua rather than JavaScript. Implemented as an extension (XPI), written in XUL, JavaScript, and C++.

XML-RPC / SOAP

See LuaXml.