对“tolua++导出C++子类后在Lua中无法添加新成员”这一问题的初步分析

一、问题的起因

    问题首先是在Quick-x中发现的，原因是希望为CCNode添加一个Lua自定义方法就会出错：

function CCNode:myMethod()
end

    运行错误提示是 [LUA ERROR] stack overflow，在Player上运行时甚至直接抛出异常提示框必须直接关闭程序。

    进一步调试，有以下结果：

    1.此问题只出现在导出的子类中，如CCObject就不会有问题，而包括CCNode在内所有继承CCObject的类就有问题

    2.并不仅仅是新加方法有问题，新加成员变量也是有问题的

    因此，这一问题可以描述为：tolua++导出的C++子类，在Lua中无法添加新成员。

二、问题的分析

    由于是无法添加新成员，首先考虑的是__newindex元方法是否有问题。

    分析tolua++的代码，可以看到在tolua_classevents函数中，将__newindex设置为了class_newindex_event函数：

static int class_newindex_event (lua_State* L)
{
    int t = lua_type(L,1);

    if (t == LUA_TUSERDATA)
    {
        //此处代码略去
    }
    else if (t== LUA_TTABLE)
    {
        module_newindex_event(L);
    }
    return 0;
}

    当CCObject和它的子类添加新成员时，这里的t值是LUA_TTABLE，因此会调用module_newindex_event函数：

static int module_newindex_event (lua_State* L)
{
    lua_pushstring(L,".set");
    lua_rawget(L,-4);
    if (lua_istable(L,-1))
    {
        //此处代码略去
    }
    /* call old newindex meta event */
    if (lua_getmetatable(L,1) && lua_getmetatable(L,-1))
    {
        lua_pushstring(L,"__newindex");
        lua_rawget(L,-2);
        if (lua_isfunction(L,-1))
        {
            lua_pushvalue(L,1);
            lua_pushvalue(L,2);
            lua_pushvalue(L,3);
            lua_call(L,3,0);
        }
    }
    lua_settop(L,3);
    lua_rawset(L,-3);
    return 0;
}

   可以看出这里是取metatable里的.set表，并对新的成员进行赋值。

   第一个判断，CCObject和它的子类都不会进入，没有影响。

   但第二个判断情况就不同了，CCObject不会进入，它的子类是会进入的。从代码写法上看，这里似乎是希望调用其父类的__newindex，但这样是很有问题的。

    首先现在这样的写法，取到的仍然是子类自己的__newindex，因此会再调用一次class_newindex_event函数，而class_newindex_event自然又会调用module_newindex_event，结果又回到了这段代码当中！这样，函数不断递归调用，永无休止，直到堆栈溢出为止，这就是出错为stack overflow的原因。

    其次我还没有想明白的是，即使是父类的__newindex，这里似乎也没有调用的必要。因为子类要是定义一个新成员是在父类里生效的话，那问题就大了。所以这里我认为直接调用lua_rawset应该就可以了。

三、临时解决方案

    基于以上分析，我认为问题就在于module_newindex_event的处理上。我尝试不调用module_newindex_event，而直接对新成员进行赋值操作，即修改class_newindex_event函数的相关代码如下：

    else if (t== LUA_TTABLE)
    {
//        module_newindex_event(L);
		lua_settop(L,3);
		lua_rawset(L,-3);
    }

   修改的这两句相当于在lua里面直接调用rawset对新成员进行赋值操作。

   修改后，在Lua中运行以下代码：

function CCNode:testFunc()
  print("----------CCNode.testFunc------Entry now!!!")
end

function MainScene:ctor()
    local s = display.newSprite("Logo.png", display.cx, display.cy)
    self:addChild(s)
    s:testFunc()
end

    上述代码是可以正常运行并得到预想中的输出的。

    不过目前这只是临时方案。我不知道tolua++原来这样写代码是不是另有原因。后面我将再仔细考虑清楚，这样的修改会不会有什么负作用。

(2014.5.30加注：quick-x的2.2.3版本目前已经采用了这一修改方案)

转载于:https://my.oschina.net/SunLightJuly/blog/262880