Calling Lua functions : using C++ language.

Renato Tegon Forti

Rate me:

4.84/5 (17 votes)

2 Feb 2007MIT5 min read

49.3K

739

Calling Lua functions : using C++ language.

Download source code - 538.1 Kb

Audience

This article was written for C++ developers that want extend your application with Lua programming Language.

Introduction

One of the most common tasks when you use Lua in C++ application is call Lua functions, but this can be tiresome, you need use a lot of functions of LUA C API (lua_getglobal, lua_pushnumber, lua_pushstring, lua_tointeger and so on) to call one simple Lua function. Here I will show C++ templates that can make your life easy.

Interface

The interface is very easy see:. Think that you have these four Lua function and you want to call in your application:

Listing 1 – Lua Functions – test.lua
--------------------------------------------------------------------------------------

var = 10;<o:p>

<o:p>

function sum4(a, b, c, d)<o:p>

return a+b+c+d;<o:p>

end<o:p>

<o:p>

function catenate(a, b)<o:p>

return a.." and "..b;<o:p>

end<o:p>

<o:p>

function incVar(value)<o:p>

end<o:p>

<o:p>

function getVar()<o:p>

return var;<o:p>

end<o:p>

--------------------------------------------------------------------------------------

Then what you need to call these function is use:

LuaCall template class.

The basic way are you instantiate LuaCall with types of your Lua function receive and return, for sample:

float a = LuaCall<float, int, float, int, int>(L, "sum4").call(5, 1.5, 5, 5);

See complete sample below (listing 2).

Listing 2 – using LuaCall – main.cpp

--------------------------------------------------------------------------------------

#include <iostream><o:p>

#include "LuaCall.h"<o:p>

<o:p>

extern "C" {<o:p>

#include <lua.h><o:p>

#include <lauxlib.h><o:p>

#include <lualib.h><o:p>

}<o:p>

<o:p>

int main()<o:p>

{<o:p>

<o:p>

try<o:p>

{ <o:p>

lua_State *L;<o:p>

<o:p>

L = luaL_newstate();<o:p>

<o:p>

if(luaL_loadfile(L, "list1.lua") || lua_pcall(L, 0, 0, 0))<o:p>

{<o:p>

throw std::string(std::string(lua_tostring(L, -1)));<o:p>

}<o:p>

<o:p>

std::cout << LuaCall<float, int, float, int, int>(L, "sum4").call(5, 1.5, 5, 5) << std::endl;<o:p>

<o:p>

std::cout << LuaCall<std::string, std::string, std::string>(L, "catenate").call("Renato", "Bianca") << std::endl;<o:p>

<o:p>

LuaCall<NullT, int>(L, "incVar").call(10);<o:p>

<o:p>

std::cout << LuaCall<int>(L, "getVar").call() << std::endl;<o:p>

<o:p>

if(L != NULL)<o:p>

{<o:p>

lua_close(L);<o:p>

}<o:p>

}<o:p>

catch (const std::string &e)<o:p>

{<o:p>

std::cout << e << std::endl;<o:p>

}<o:p>

<o:p>

return 0;<o:p>

}<o:p>

Implementation

This is the implementation of LuaCall:

Listing 3 –LuaCall imp – LuaCall.h

--------------------------------------------------------------------------------------

template <<o:p>

typename T1, <o:p>

typename T2<o:p>

><o:p>

class Duo <o:p>

{<o:p>

};<o:p>

<o:p>

// type that represents unused type parameters<o:p>

class NullT <o:p>

{<o:p>

};<o:p>

<o:p>

class LuaCallBase<o:p>

{<o:p>

<o:p>

public:<o:p>

LuaCallBase(lua_State *luaState, const std::string& functionName)<o:p>

{<o:p>

L = luaState;<o:p>

lua_getglobal(L, functionName.c_str());<o:p>

}<o:p>

<o:p>

protected:<o:p>

<o:p>

void push(const int &value)<o:p>

{<o:p>

lua_pushinteger(L, value);<o:p>

}<o:p>

<o:p>

{<o:p>

lua_pushnumber(L, value);<o:p>

}<o:p>

<o:p>

{<o:p>

}<o:p>

<o:p>

{<o:p>

lua_pushstring(L, value.c_str());<o:p>

}<o:p>

<o:p>

void get(int &value) const<o:p>

{<o:p>

value = lua_tointeger(L, -1);<o:p>

}<o:p>

<o:p>

void get(float &value) const<o:p>

{<o:p>

value = lua_tonumber(L, -1);<o:p>

}<o:p>

<o:p>

void get(double &value) const<o:p>

{<o:p>

value = lua_tonumber(L, -1);<o:p>

}<o:p>

<o:p>

void get(std::string &value) const <o:p>

value = (char*)lua_tostring(L, -1);<o:p>

}<o:p>

<o:p>

void get(NullT &value) const <o:p>

{<o:p>

}<o:p>

<o:p>

protected:<o:p>

<o:p>

lua_State *L;<o:p>

};<o:p>

<o:p>

template <<o:p>

typename TR,<o:p>

typename T1 = NullT,<o:p>

typename T2 = NullT,<o:p>

typename T3 = NullT,<o:p>

typename T4 = NullT<o:p>

><o:p>

class LuaCall<o:p>

: public Duo<TR, typename LuaCall<T1,T2,T3,T4,NullT> > <o:p>

, public LuaCallBase<o:p>

{<o:p>

public:<o:p>

<o:p>

LuaCall(lua_State *L, const std::string& functionName)<o:p>

: LuaCallBase(L, functionName)<o:p>

{<o:p>

<o:p>

}<o:p>

<o:p>

TR call(T1 a1, T2 a2, T3 a3, T4 a4)<o:p>

{<o:p>

TR returnValue;<o:p>

<o:p>

push(a1);<o:p>

push(a2);<o:p>

push(a3);<o:p>

push(a4);<o:p>

<o:p>

if(lua_pcall(L, 4, 1, 0) != 0)<o:p>

{<o:p>

throw std::string(std::string(lua_tostring(L, -1)));<o:p>

}<o:p>

<o:p>

get(returnValue);<o:p>

<o:p>

return returnValue;<o:p>

}<o:p>

<o:p>

};<o:p>

<o:p>

template <<o:p>

typename TR, <o:p>

typename T1, <o:p>

typename T2, <o:p>

typename T3<o:p>

><o:p>

class LuaCall<TR,T1,T2,T3,NullT> <o:p>

, public LuaCallBase<o:p>

{<o:p>

public:<o:p>

: LuaCallBase(L, functionName)<o:p>

{<o:p>

<o:p>

}<o:p>

<o:p>

TR call(T1 a1, T2 a2, T3 a3)<o:p>

TR returnValue;<o:p>

<o:p>

push(a1);<o:p>

push(a2);<o:p>

push(a3);<o:p>

<o:p>

if(lua_pcall(L, 3, 1, 0) != 0)<o:p>

{<o:p>

throw std::string(std::string(lua_tostring(L, -1)));<o:p>

<o:p>

get(returnValue);<o:p>

<o:p>

return returnValue;<o:p>

}<o:p>

};<o:p>

<o:p>

<o:p>

template <<o:p>

typename TR, <o:p>

typename T1, <o:p>

typename T2<o:p>

><o:p>

, public LuaCallBase<o:p>

{<o:p>

public:<o:p>

: LuaCallBase(L, functionName)<o:p>

{<o:p>

<o:p>

}<o:p>

<o:p>

TR returnValue;<o:p>

<o:p>

push(a1);<o:p>

push(a2);<o:p>

<o:p>

if(lua_pcall(L, 2, 1, 0) != 0)<o:p>

{<o:p>

}<o:p>

<o:p>

get(returnValue);<o:p>

<o:p>

return returnValue;<o:p>

}<o:p>

};<o:p>

<o:p>

<o:p>

template <<o:p>

typename TR, <o:p>

typename T1<o:p>

><o:p>

class LuaCall<TR,T1,NullT,NullT,NullT> <o:p>

, public LuaCallBase<o:p>

{<o:p>

public:<o:p>

: LuaCallBase(L, functionName)<o:p>

{<o:p>

<o:p>

}<o:p>

<o:p>

{<o:p>

TR returnValue;<o:p>

<o:p>

push(a1);<o:p>

<o:p>

if(lua_pcall(L, 1, 1, 0) != 0)<o:p>

{<o:p>

<o:p>

get(returnValue);<o:p>

<o:p>

return returnValue;<o:p>

}<o:p>

};<o:p>

<o:p>

template <typename TR><o:p>

class LuaCall<TR,NullT,NullT,NullT,NullT> <o:p>

, public LuaCallBase<o:p>

{<o:p>

public:<o:p>

: LuaCallBase(L, functionName)<o:p>

{<o:p>

}<o:p>

<o:p>

TR call(void)<o:p>

{<o:p>

TR returnValue;<o:p>

<o:p>

if(lua_pcall(L, 0, 1, 0) != 0)<o:p>

{<o:p>

}<o:p>

<o:p>

get(returnValue);<o:p>

<o:p>

return returnValue;<o:p>

}<o:p>

};<o:p>

<o:p>

template <><o:p>

class LuaCall<NullT,NullT,NullT,NullT,NullT> <o:p>

: public LuaCallBase<o:p>

{<o:p>

public:<o:p>

{<o:p>

}<o:p>

<o:p>

void call(void)<o:p>

if(lua_pcall(L, 0, 0, 0) != 0)<o:p>

{<o:p>

}<o:p>

};<o:p>

Bibliography

Roberto Ierusalimschy
Programming in Lua – 2nd ed. (http://www.inf.puc-rio.br/~roberto/pil2/)
ISBN 85-903798-2-5

David Vandevoorde - Nicolai M. Josuttis
C++ Templates - The Complete Guide
ISBN 0-201-73484-2

Lua.org
http://www.lua.org/

Mailing list
http://www.lua.org/lua-l.html

Community
http://www.lua.org/community.html

Embeddable scripting with Lua
http://www-128.ibm.com/developerworks/linux/library/l-lua.html

The Web Links listed here may not be valid in the future.

License

This article, along with any associated source code and files, is licensed under The MIT License

Written By

Renato Tegon Forti

Systems Engineer

Brazil

This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Calling Lua functions : using C++ language.

Audience

Introduction

Interface

See complete sample below (listing 2).

Bibliography

Roberto Ierusalimschy Programming in Lua – 2nd ed. (http://www.inf.puc-rio.br/~roberto/pil2/) ISBN 85-903798-2-5 David Vandevoorde - Nicolai M. Josuttis C++ Templates - The Complete GuideISBN 0-201-73484-2

Lua.org http://www.lua.org/

Mailing list http://www.lua.org/lua-l.html

Community http://www.lua.org/community.html

Embeddable scripting with Lua http://www-128.ibm.com/developerworks/linux/library/l-lua.html

The Web Links listed here may not be valid in the future.

License

Comments and Discussions

Roberto Ierusalimschy
Programming in Lua – 2nd ed. (http://www.inf.puc-rio.br/~roberto/pil2/)
ISBN 85-903798-2-5

David Vandevoorde - Nicolai M. Josuttis
C++ Templates - The Complete Guide
ISBN 0-201-73484-2

Lua.org
http://www.lua.org/

Mailing list
http://www.lua.org/lua-l.html

Community
http://www.lua.org/community.html

Embeddable scripting with Lua
http://www-128.ibm.com/developerworks/linux/library/l-lua.html