绑定结构和ctor / dtor与tolua ++

时间:2011-02-15 04:06:14

标签: c binding lua tolua++

假设我想将一段代码绑定到Lua,如下所示:

typedef struct bar {
  void * some_data;
} bar;
bar * bar_create(void);
void bar_do_something(bar * baz);
void bar_free(bar * baz);

我想从Lua脚本创建这些对象,而不是显式管理它们的生命周期。我希望我的脚本能够写

require "foo"
local baz = foo:bar()
baz:do_something()
baz = nil

问题:为了使其按预期工作,我需要以某种方式告诉tolua ++关于bar_create和bar_free是bar的构造函数/析构函数。我怎么做?对于类,tolua ++声称自动使用他们的ctor / dtor,但是对于结构?

我能想出的最好的事情就是foo.pkg的定义:

module foo {
  struct bar {
    static tolua_outside bar_create @ create();
    tolua_outside bar_do_something @ do_something();
    tolua_outside bar_free @ free();
  };
}

这意味着我必须明确地调用create()和free()。​​

1 个答案:

答案 0 :(得分:1)

可以使用tolua ++将bar函数导入Lua并将其包装以生成对象样式的接口,包括垃圾收集。

为了演示参数的传递,我已将bar接口更改为

bar * bar_create(int x);
int bar_do_something(bar * baz, int y);
void bar_free(bar * baz);

编写了一个测试实现,在调用函数时打印出xy等。

bar_create() Lua函数返回userdata值。 Lua通过调用存储在数据元表中的__gc方法来释放此类用户数据。给定userdata值和析构函数gc__gc方法将被覆盖,以便首先调用gc,然后调用原始的gc方法:

function wrap_garbage_collector(userdata, gc)
    local mt = getmetatable(userdata)
    local old_gc = mt.__gc
    function mt.__gc (data)
        gc(data)
        old_gc(data)
    end
end

相同类型的用户数据共享相同的元表;因此,wrap_garbage_collector()函数应该只为每个类调用一次(假设tolua ++的metatables构造一次并且仅在退出时释放)。

在这个答案的底部是一个完整的bar.pkg文件,它导入bar函数并将bar类添加到名为foo的Lua模块中。 foo模块被加载到解释器(see for example my SO tolua++ example)中,并按如下方式使用:

bars = {}

for i = 1, 3 do
    bars[i] = foo.bar(i)
end

for i = 1, 3 do
    local result = bars[i]:do_something(i * i)
    print("result:", result)
end

测试实现打印出发生的事情:

bar(1)
bar(2)
bar(3)
bar(1)::do_something(1)
result: 1
bar(2)::do_something(4)
result: 8
bar(3)::do_something(9)
result: 27
~bar(3)
~bar(2)
~bar(1)

下面的bar类的构造有点复杂:build_class()实用程序返回一个给定构造函数,析构函数和类方法的类(Lua表)。毫无疑问需要进行调整,但作为原型演示,示例应该没问题。

$#include "bar.hpp"

// The bar class functions.
bar * bar_create(int x);
int bar_do_something(bar * baz, int y);
void bar_free(bar * baz);

$[
    -- Wrapping of the garbage collector of a user data value.
    function wrap_garbage_collector(userdata, gc)
        local mt = getmetatable(userdata)
        local old_gc = mt.__gc
        function mt.__gc (data)
            gc(data)
            old_gc(data)
        end
    end

    -- Construction of a class.
    --
    -- Arguments:
    --
    --   cons : constructor of the user data
    --   gc : destructor of the user data
    --   methods : a table of pairs { method = method_fun }
    --
    -- Every 'method_fun' of 'methods' is passed the user data 
    -- as the first argument.
    --
    function build_class(cons, gc, methods)
        local is_wrapped = false
        function class (args)
            -- Call the constructor.
            local value = cons(args)

            -- Adjust the garbage collector of the class (once only).
            if not is_wrapped then
                wrap_garbage_collector(value, gc)
                is_wrapped = true
            end

            -- Return a table with the methods added.
            local t = {}
            for name, method in pairs(methods) do
                t[name] =
                    function (self, ...)
                        -- Pass data and arguments to the method.
                        return (method(value, ...))
                    end
            end

            return t
        end
        return class
    end

    -- The Lua module that contains our classes.
    foo = foo or {}

    -- Build and assign the classes.
    foo.bar =
        build_class(bar_create, bar_free,
                    { do_something = bar_do_something })

    -- Clear global functions that shouldn't be visible.
    bar_create = nil
    bar_free = nil
    bar_do_something = nil
$]