Tag: lua

CocosBuilder的Cocos2dx-lua绑定方案

2015-01-30 by jennal·5 Comments

CocosBuilder的Cocos2dx-lua绑定方案

前情提要

似乎写每一份代码，每一篇文章，都有些理由，所以忍不住要写个前情提要。

CocosBuilder虽然已经2年没有更新了，已经被SpriteBuilder所取代，但是由于我们早期的项目使用的就是CocosBuilder，而SpriteBuilder增加的功能并没有特别出彩，没有足够的理由让我们抛弃CocosBuilder，于是沿用下来。但是如果拿不开源的CocosStudio来比较，我还是推荐使用CocosBuilder。

据我所知，最早让Cocos2dx的lua版本支持CocosBuilder的，是这个项目：LuaProxy。不知道为什么，CocosBuilder官方库只做了对js的支持，甚至做了html5的支持，却完全没有考虑对lua的支持。而LuaProxy就是建立在官方对js支持的基础上，做了lua的实现。但是读完CocosBuilder中js方案的实现，以及Cocos2dx中CCBReader对js方案的实现，我居然产生了，这不可能是一个人写的吧，这种想法。因为js方案与cpp方案的思路完全不同，如果是同一个人做的，这也太蛋疼了吧？（不过我没有看js那边的使用方法，只是按照LuaProxy的使用方法去理解的。）

cpp方案用了一种非常优雅的方式，加载的过程中，自定义类需要有一个对应的Loader，使用字符串来索引Loader，以帮助CCBReader生成对应的类的实例。

LuaProxy的方案的缺陷

首先最不能忍的，就是用了一个全局table ccb来替代cpp中的registerCCNodeLoader，看起来好像可以解决，但是必须事先把所有需要绑定的Controller的名字写入这个ccb里面，也就意味着很可能许多不需要的代码会被提前加载，对于lua这样的脚本语言来说，这完全是不必要的代价。
全局ccb也带来了另外一个问题，同屏加载多个相同ccbi时，动态更新数据的问题。
- 试想这种情况：你用CocosBuilder的粒子编辑器做了一束烟花，但是粒子贴图要在几种里面随机，这个需要在代码里面实现。于是你把这个CCParticleSystemQuad绑定到了ccb的一个table中。然后需求变了，策划需要同时放多个烟花，于是同时出现的烟花，只有最后一个的贴图可以随机了。因为他们共享同一个全局ccb的table，后加载的覆盖了前面加载的。这里只是举一个简单的例子，实际应用可能比这个情况复杂得多。
嵌套CCBFile时，无法对子CCBFile做操作的问题。可能子CCBFile绑定了某个lua对象，有一些函数可以调用，有一些成员变量可以使用。但是全在全局ccb里面，父节点根本不知道子CCBFile对应全局ccb的哪个对象。

解决方案

对于lua这样的脚本语言来说，完全可以在加载ccbi的过程中，动态加载需要的lua文件，进行绑定，我们需要做的只是设定一个绑定规则。然后对CocosBuilder做一些小改动，让publish的时候，同时生成lua文件，那整个开发流程将大大被缩短。

So，为了解决上面的3个问题，我做了两件事

修改了CCBReader读取的一些方法，提供给lua读取嵌套CCBReader的方法。并且重写了lua读取ccbi的代码。
修改了CocosBuilder的源代码，让它在publish的时候，直接生成对应的lua文件。

准备工作

1.下载以下cpp文件，覆盖掉cocos2dx的相应文件，然后重新编译Runtime

PS: 值得注意的是，我修改的是cocos2dx 3.2，不确定覆盖更高或者更低的版本会不会出问题，如果不是3.2的用户，可以查看这个commit，自行修改相应代码。

2.下载以下lua文件，放到lua项目的src对应目录下

3.获取修改过的CocosBuilder

有2个方法

从Github clone源代码自己编译：https://github.com/jennal/CocosBuilder
下载我编译好的版本：https://github.com/Jennal/CocosBuilder/blob/master/Release/CocosBuilder.app.tar.gz?raw=true

PS: 值得注意的是，由于我们的项目使用的默认设计尺寸是1200x800，所以代码中的缩放比例都是针对这个分辨率的。修改也不难，在这里：CocosBuilder/ccBuilder/ResolutionSetting.m，把顶部的两个define改成你自己要的设计尺寸就行了。

#define DESIGN_WIDTH 1200
#define DESIGN_HEIGHT 800

1 2	#define DESIGN_WIDTH 1200 #define DESIGN_HEIGHT 800

使用方法

改完Cocos2dx的框架代码，下载了lua代码，有了Cocosbuilder的修改版，准备完成，正式进入使用阶段。

1.ccb文件制作

ccb文件的制作基本没有什么特别，只是有几个点需要注意：

Publish Settings里面多了个选项，记得勾起来。新建项目，默认是勾的。
文件名与该文件的Controller名，必须保持一致，这是为了简化接口，也为了让代码与设计统一

2.代码绑定

生成的lua文件已经包含了一些注释，几乎不用有太多额外的代码，就可以很容易地绑定ccbi文件与lua类。

下面讲解几个需要注意的地方

CCBLoader:setRootPath的两个参数

--[[
第一个参数表示绑定lua文件的package前缀
第二个参数表示ccb文件的路径
]]
CCBLoader:setRootPath("UI.ccb", "ccb/")

--[[

第一个参数表示绑定lua文件的package前缀

第二个参数表示ccb文件的路径

]]

CCBLoader:setRootPath("UI.ccb", "ccb/")

生成的lua文件的ctor相当于cpp中使用ccbi的onNodeLoaded，换句话说，代码执行到这里的时候，这个节点的子节点以及绑定都应该已经完成，可以放心使用了。可以在这里做一些初始化数据的工作。
创建ccbi节点的方法

local mainLayer = require("UI.ccb.MainLayer"):new()

1	local mainLayer = require("UI.ccb.MainLayer"):new()

示例下载

https://github.com/Jennal/CocosBuilder/blob/master/Sample/CCBSample-lua-binding.tar.gz?raw=true

感谢

虽然LuaProxy的方案并不完美，但也为我的改进铺平的道路，在这里感谢LuaProxy的作者shawnclovie。

lua的面向对象库

2015-01-04 by jennal·0 Comment

接上一篇文章cocos2d-x中lua-binding的面向对象开发的研究，终于有时间整理一下我自己写的面向对象方案。
先上github地址：https://github.com/Jennal/LuaUtils/blob/master/src/Oop.lua

为什么要写这个库？

我们一直使用cocos2d-x来作为底层框架进行开发。之前用的是cpp，最近转到lua，所以难免保留一些cpp的习惯，包括饱受诟病的多继承。我不想讨论多继承有多好，或者有多糟。我认为，作为库来说，应该尽量提供符合大家习惯的机制，至于是否使用，如何使用，取决于用户。

我们知道lua在语言级别并没有支持类，而是提供了更灵活的metatable，我们可以利用metatable来实现类似cpp的类。cocos2d-x的lua绑定提供了类的支持，支持创建lua级别的类，也支持从cpp继承，但是对于面向对象机制来说，只提供继承，远远不够。

我想要的面向对象机制

多层级继承
- 从lua继承
- 从lua继承后的lua继承
- 从cpp继承
- 从cpp继承后的lua继承
单继承
多继承
- 调用不同父类的构造函数
- 调用不同父类的同名函数
- 多继承不允许从2个或者以上的cpp继承
接口继承
- 接口用来约束必须实现的成员函数
判断是否是某个类的实例
- 包括是否是某个父类的子类的实例

如何使用我的库

单继承

从lua创建对象

local Oop = require("Oop")
-- 从lua创建对象
local A = Oop.class("A")
-- 构造函数
function A:ctor(arg)
    self.arg = arg
    print("create A")
end
-- new的参数将传递到ctor中
local a = A:new("hello") -- create A
print("a.arg", a.arg) -- a.arg  hello
-- 从lua创建的类继承
local B = Oop.class("B", A)
function B:ctor(arg, brg)
    -- 调用父类的构造函数
    B.super.A.ctor(self, arg)
    self.brg = brg
    print("create B")
end
local b = B:new("hello", "world") -- create A \n create B
print("b.arg", "b.brg", b.arg, b.brg) -- b.arg  b.brg   hello   world

local Oop = require("Oop")

-- 从lua创建对象

local A = Oop.class("A")

-- 构造函数

function A:ctor(arg)

self.arg = arg

print("create A")

end

-- new的参数将传递到ctor中

local a = A:new("hello") -- create A

print("a.arg", a.arg) -- a.arg hello

-- 从lua创建的类继承

local B = Oop.class("B", A)

function B:ctor(arg, brg)

-- 调用父类的构造函数

B.super.A.ctor(self, arg)

self.brg = brg

print("create B")

end

local b = B:new("hello", "world") -- create A \n create B

print("b.arg", "b.brg", b.arg, b.brg) -- b.arg b.brg hello world

从cpp创建对象

-- 从cpp创建对象
local SpriteEx = Oop.class("SpriteEx", function(...)
    return cc.Sprite:create(...)
end)
-- 构造函数
function SpriteEx:ctor(...)
    self.arg = {...}
    print("create SpriteEx")
end
-- new的参数将传递到上面的匿名function中，以及ctor中
local sprite = SpriteEx:new("hello.png") -- create SpriteEx
print("sprite.arg", unpack(sprite.arg)) -- sprite.arg   hello.png
-- 从cpp创建的类继承
local SpecialSprite = Oop.class("SpecialSprite", SpriteEx)
function SpecialSprite:ctor(...)
    -- 调用父类的构造函数
    B.super.A.ctor(self, ...)
    print("create SpecialSprite")
end
local ss = SpecialSprite:new("hello.png") -- create SpriteEx \n create SpecialSprite
print("ss.arg", unpack(ss.arg)) -- ss.arg   hello.png

-- 从cpp创建对象

local SpriteEx = Oop.class("SpriteEx", function(...)

return cc.Sprite:create(...)

end)

-- 构造函数

function SpriteEx:ctor(...)

self.arg = {...}

print("create SpriteEx")

end

-- new的参数将传递到上面的匿名function中，以及ctor中

local sprite = SpriteEx:new("hello.png") -- create SpriteEx

print("sprite.arg", unpack(sprite.arg)) -- sprite.arg hello.png

-- 从cpp创建的类继承

local SpecialSprite = Oop.class("SpecialSprite", SpriteEx)

function SpecialSprite:ctor(...)

-- 调用父类的构造函数

B.super.A.ctor(self, ...)

print("create SpecialSprite")

end

local ss = SpecialSprite:new("hello.png") -- create SpriteEx \n create SpecialSprite

print("ss.arg", unpack(ss.arg)) -- ss.arg hello.png

多继承

纯lua多继承

local A = Oop.class("A")
function A:ctor(arg)
    self.arg = arg
    print("create A")
end
function A:show()
    print("A show", self.arg)
end
local B = Oop.class("B")
function B:ctor(arg)
    self.arg = arg
    print("create B")
end
function B:show()
    print("B show", self.arg)
end
local C = Oop.class("C", A, B)
function C:ctor(arg)
    -- 调用不同父类的构造函数
    C.super.A.ctor(self, arg)
    C.super.B.ctor(self, arg)
end
function C:showA()
    -- 调用不同父类的同名函数
    C.super.A.show(self)
end
function C:showB()
    -- 调用不同父类的同名函数
    C.super.B.show(self)
end
local c = C:new("Hello") -- create A \n create B
c:showA() -- A show Hello
c:showB() -- B show Hello

local A = Oop.class("A")

function A:ctor(arg)

self.arg = arg

print("create A")

end

function A:show()

print("A show", self.arg)

end

local B = Oop.class("B")

function B:ctor(arg)

self.arg = arg

print("create B")

end

function B:show()

print("B show", self.arg)

end

local C = Oop.class("C", A, B)

function C:ctor(arg)

-- 调用不同父类的构造函数

C.super.A.ctor(self, arg)

C.super.B.ctor(self, arg)

end

function C:showA()

-- 调用不同父类的同名函数

C.super.A.show(self)

end

function C:showB()

-- 调用不同父类的同名函数

C.super.B.show(self)

end

local c = C:new("Hello") -- create A \n create B

c:showA() -- A show Hello

c:showB() -- B show Hello

lua与cpp的多继承

local Oop = require("init")
local A = Oop.class("A")
function A:ctor(arg)
    self.arg = arg
    print("create A")
end
function A:show()
    print("A show", self.arg)
end
local B = Oop.class("B", function(...)
    return cc.Sprite:create(...)
end)
function B:ctor(arg)
    self.arg = arg
    print("create B")
end
function B:show()
    print("B show", self.arg)
end
local C = Oop.class("C", A, B)
function C:ctor(arg)
    C.super.A.ctor(self, arg)
    C.super.B.ctor(self)
end
function C:showA()
    C.super.A.show(self)
end
function C:showB()
    C.super.B.show(self)
end
local c = C:new("Hello.png") -- create A \n create B
c:showA() -- A show Hello.png
c:showB() -- B show Hello.png
-- layer:addChild(c)

local Oop = require("init")

local A = Oop.class("A")

function A:ctor(arg)

self.arg = arg

print("create A")

end

function A:show()

print("A show", self.arg)

end

local B = Oop.class("B", function(...)

return cc.Sprite:create(...)

end)

function B:ctor(arg)

self.arg = arg

print("create B")

end

function B:show()

print("B show", self.arg)

end

local C = Oop.class("C", A, B)

function C:ctor(arg)

C.super.A.ctor(self, arg)

C.super.B.ctor(self)

end

function C:showA()

C.super.A.show(self)

end

function C:showB()

C.super.B.show(self)

end

local c = C:new("Hello.png") -- create A \n create B

c:showA() -- A show Hello.png

c:showB() -- B show Hello.png

-- layer:addChild(c)

接口

-- 定义一个接口
local IA = Oop.interface("IA", {
    {"func1", "(param1, param2)", "description"}, -- 成员函数1
    {"func2", ""}, -- 成员函数2
},{
    {"member", ""} -- 成员变量
})
IA.func1() -- 抛出异常: func1(param1, param2) is not implemented
local test = IA.member -- 抛出异常: member is not defined
local IAImpl = Oop.class("IAImpl", Oop.Obj, IA)
function IAImpl:func2()
    return true
end
IAImpl.member = 1
-- 实现接口
local o = IAImpl:new()
o:func1() -- 抛出异常: func1(param1, param2) is not implemented
print(o:func2()) -- true
print(o.member) -- 1

-- 定义一个接口

local IA = Oop.interface("IA", {

{"func1", "(param1, param2)", "description"}, -- 成员函数1

{"func2", ""}, -- 成员函数2

},{

{"member", ""} -- 成员变量

})

IA.func1() -- 抛出异常: func1(param1, param2) is not implemented

local test = IA.member -- 抛出异常: member is not defined

local IAImpl = Oop.class("IAImpl", Oop.Obj, IA)

function IAImpl:func2()

return true

end

IAImpl.member = 1

-- 实现接口

local o = IAImpl:new()

o:func1() -- 抛出异常: func1(param1, param2) is not implemented

print(o:func2()) -- true

print(o.member) -- 1

判断是否某个类或接口的实例

Oop.isClass(obj, "A") -- false
Oop.checkClass(obj, "A") -- 抛出异常：param should be A type
Oop.checkClass(obj, "A", 2) -- 抛出异常：param2 should be A type

Oop.isClass(obj, "A") -- false

Oop.checkClass(obj, "A") -- 抛出异常：param should be A type

Oop.checkClass(obj, "A", 2) -- 抛出异常：param2 should be A type

在MacOSX下用cmake编译cocos2dx的笔记

2014-12-06 by jennal·0 Comment

最近项目想用Qt来做cocos2d-x的跨平台编辑器。由于对Qt和OpenGL都是新手，所以想用相对低成本的方法来做，参考了不少项目。发现好多人有用Qt来做cocos2d-x的编辑器的想法，包括cocos2d-x官方，但不知道什么原因，几乎所有的项目都中途流产了。大部分项目使用的是相对较旧的cocos2d-x版本，有些甚至无法编译成功。不过这些项目也给了我不少帮助，参考了很多有价值的信息。

最后，我决定自己做一个QtPort，选用CMake来做项目管理，因为新版的cocos2d-x已经带了CMakeLists.txt，如果直接用Qt的pro/pri/prf等项目文件，那工程量就太大了。

工具

otool

这个工具帮了很大忙，因为使用CMake，所有需要链接的库都需要自己设置。而我不知道需要哪些库，利用otool -L xxx来查看用XCode编译出来的xxx使用了哪些库，也让我顺利把所需的库都加进来。

安装组件

首先要用到的就是HomeBrew了。安装完HomeBrew，就可以用它安装各种东西了。

> brew update
> brew install glew jpeg webp libtiff freetype libwebsockets glew

1 2	> brew update > brew install glew jpeg webp libtiff freetype libwebsockets glew

这里教大家一个小技巧，当编译提示

library not found for -lfreetype

1	library not found for -lfreetype

这里的-l后面就是缺失的库的名字，可以把这个名字直接放到brew install后面进行安装。
如果名字不对的话，也可以使用brew search freetype进行搜索。

问题

Spine库的CCSkeleton.cpp文件会编译不过，我们也用不到Spine库，所以暂时不编译它。
Audio相关的库编译不过，我在CMakeLists里加了个AUDIO_BUILD的option的选项，也暂时关闭它。
编译lua时遇到了比较大的问题
- 首先，因为我们禁用了Spine和Audio的编译，但是cocos2dx的tolua代码中，并没有根据这个条件编译进行判断，是否包含这些文件。为了防止使用这些文件出问题，我加了#ifdef来判断，当定义了不要Spine或者Audio时，把相关的lua函数都注册成空函数。
- 然后是luasocket的问题，cocos2dx官方根本就没有写luasocket的CMakeLists.txt，不过写起来还算顺利，唯一需要注意的是luasocket的wsocket.c和usocket.c，是需要分平台编译的，wsocket.c是针对Win平台写的，usocket.c是针对unix-like系统写的。

关于CMakeLists的代码

好像没有特别需要说明的，基本就是CMake的规则，唯一值得一提的是，MacOSX下面的编译，记得这么做

# add the executable
add_executable(${APP_NAME}
  MACOSX_BUNDLE
  WIN32
  ${SAMPLE_SRC}
)

# add the executable

add_executable(${APP_NAME}

MACOSX_BUNDLE

WIN32

${SAMPLE_SRC}

)

这样生成的目录结构才会是这样的

AppName.app/
AppName.app/Contents
AppName.app/Contents/Info.plist
AppName.app/Contents/MacOS
AppName.app/Contents/MacOS/AppExecutable

AppName.app/

AppName.app/Contents

AppName.app/Contents/Info.plist

AppName.app/Contents/MacOS

AppName.app/Contents/MacOS/AppExecutable

最后

最后给出我的项目地址：https://github.com/Jennal/cocos2dx-3.2-qt

解决cocos2dx-lua绑定print不能打印指针的问题

2014-10-29 by jennal·0 Comment

cocos2d-x的lua绑定，把原生的print函数给改掉了，就为了加个cocos2d: [LUA-print]的前缀，实在让人无语。临时工为了方便，直接去掉了table、user data可以显示指针地址的功能，所以我只好去改源代码了。

有2种改法，先说复杂的

找到这个文件

cocos2d-x/cocos/scripting/lua-bindings/manual/CCLuaStack.cpp

修改这个函数

lua_print

直接替换整个函数的代码

int lua_print(lua_State * luastate)
{
    int nargs = lua_gettop(luastate);
    std::string t;
    for (int i=1; i <= nargs; i++)
    {
        const char * str = lua_tostring(luastate, i);
        if (str)
        {
            /* number, string */
            t += lua_tostring(luastate, i);
        }
        else if (lua_isnone(luastate, i))
            t += "none";
        else if (lua_isnil(luastate, i))
            t += "nil";
        else if (lua_isboolean(luastate, i))
        {
            if (lua_toboolean(luastate, i) != 0)
                t += "true";
            else
                t += "false";
        }else{
            /* table, userdata, lightuserdata, thread */
            t += lua_typename(luastate, lua_type(luastate, i));
            char pointer[16];
            memset(pointer, 0, 16);
            sprintf(pointer, "%p", lua_topointer(luastate, i));
            t += ": ";
            t += pointer;
        }
        if (i!=nargs)
            t += "\t";
    }
    CCLOG("[LUA-print] %s", t.c_str());
    return 0;
}

int lua_print(lua_State * luastate)

{

int nargs = lua_gettop(luastate);

std::string t;

for (int i=1; i <= nargs; i++)

{

const char * str = lua_tostring(luastate, i);

if (str)

{

/* number, string */

t += lua_tostring(luastate, i);

}

else if (lua_isnone(luastate, i))

t += "none";

else if (lua_isnil(luastate, i))

t += "nil";

else if (lua_isboolean(luastate, i))

{

if (lua_toboolean(luastate, i) != 0)

t += "true";

else

t += "false";

}else{

/* table, userdata, lightuserdata, thread */

t += lua_typename(luastate, lua_type(luastate, i));

char pointer[16];

memset(pointer, 0, 16);

sprintf(pointer, "%p", lua_topointer(luastate, i));

t += ": ";

t += pointer;

}

if (i!=nargs)

t += "\t";

}

CCLOG("[LUA-print] %s", t.c_str());

return 0;

}

简单的办法

还是这个文件

cocos2d-x/cocos/scripting/lua-bindings/manual/CCLuaStack.cpp

找到这段代码

    // Register our version of the global "print" function
    const luaL_reg global_functions [] = {
        {"print", lua_print},
        {NULL, NULL}
    };

// Register our version of the global "print" function

const luaL_reg global_functions [] = {

{"print", lua_print},

{NULL, NULL}

};

直接注释掉，这样就可以用lua原生的print函数了。如果还是想要那个前缀，很简单，只需要在lua文件里面写就可以了，具体就不用多说了。

cocos2d-x中lua-binding的面向对象开发的研究

2014-10-18 by jennal·8 Comments

起因

网路上已经有很多关于lua面向对象开发的文章，为什么我要自己写一篇呢？

一切都是因cocos2d-x 3.2的lua绑定而起。我们的新项目打算用lua进行开发，一直在跟进quick-x项目，从独立、第三方，到现在的被触控收编。cocos2d-x 3.2是最新的稳定版，把quick-x的很多好东西吸纳进来。与其说吸纳，不如说是直接把源代码拿过来了。所以，现在cocos2d-x 3.2直接就支持lua的面向对象开发，提供了原来只有quick-x才有的class等方法来方便的创建对象以及做继承。

既然cocos2d-x官方都认为quick-x的东西很好，我也不得不研究一下这套针对lua开发的创建类和继承的方法。不研究不要紧，一研究吓一跳。备受关注的quick-x，把自己宣传的那么好，那么便捷（我刚开始研究quick-x的时候，用它写过一个项目，提供的接口确实很便捷，大大提高了开发效率，但是没有研究实现细节），没想到最最底层，最最基础的部分，创建类、类继承的方案却如此业余，简直是一个刚学lua两三天的“高手”写出来的。说刚学两三天，是因为，从这个方案可以看出，完全没有理解lua语言的真谛，没有做到thinking in lua，而“高手”并不是贬义，一般人真的做不出这样的设计，写不出这样的代码。

分析

当然，也不是说这份代码一无是处（下个章节会详细分析），我这里先说说这份代码的优点和缺陷，仅代表个人意见，希望能引起共鸣。

优点

分解了创建实例(cls.__create)和构造函数的方法(instance:ctor)，这样做的好处很明显，让混沌的思路清晰起来，并且“支持”从function继承，这也是支持从cpp对象继承的基础。
创造了类与类的实例之间的区别
- 类：cls.class == nil
- 类的实例：instance.class ~= nil
支持从cpp、lua的table继承，也支持创造新的类
支持默认构造函数
- 当创建新的类时，有一个什么都不做的构造函数
- 当lua的table继承时，可以调用父类的构造函数

缺陷

不支持多继承，这对于从cpp开发转过来的开发人员来说，可能是最大的问题，因为lua的特性其实是可以支持多继承的
没有充分利用lua的特性（下面的review详细展开讲）
- 从lua的table继承时，不需要做clone，clone会失去很多好处，并且带来额外的内存开销
构造函数在继承过程中存在设计缺陷（下面的review会展开讲）

小结

所以总体上来看，还是优点多于缺点的。但是对于用惯了多继承（即使是不支持多继承的语言，比如Java、C#也是支持多接口实现的）的我来说，这点实在不可忍，所以不得不自己写了一套继承机制，为了避免这篇文章太长，将在下一篇文章中公开。

代码review

下面是重头戏了，让我们来看看class函数的代码。

--Create an class.
function class(classname, super)
    -- Part 1 --
    local superType = type(super)
    local cls
    if superType ~= "function" and superType ~= "table" then
        superType = nil
        super = nil
    end
    -- End of Part 1 --
    if superType == "function" or (super and super.__ctype == 1) then
        -- Part 2 --
        -- inherited from native C++ Object
        cls = {}
        if superType == "table" then
            -- copy fields from super
            for k,v in pairs(super) do cls[k] = v end
            cls.__create = super.__create
            cls.super    = super
        else
            cls.__create = super
        end
        cls.ctor    = function() end
        cls.__cname = classname
        cls.__ctype = 1
        function cls.new(...)
            local instance = cls.__create(...)
            -- copy fields from class to native object
            for k,v in pairs(cls) do instance[k] = v end
            instance.class = cls
            instance:ctor(...)
            return instance
        end
        -- End of Part 2 --
    else
        -- Part 3 --
        -- inherited from Lua Object
        if super then
            cls = clone(super)
            cls.super = super
        else
            cls = {ctor = function() end}
        end
        cls.__cname = classname
        cls.__ctype = 2 -- lua
        cls.__index = cls
        function cls.new(...)
            local instance = setmetatable({}, cls)
            instance.class = cls
            instance:ctor(...)
            return instance
        end
        -- End of Part 3 --
    end
    return cls
end

--Create an class.

function class(classname, super)

-- Part 1 --

local superType = type(super)

local cls

if superType ~= "function" and superType ~= "table" then

superType = nil

super = nil

end

-- End of Part 1 --

if superType == "function" or (super and super.__ctype == 1) then

-- Part 2 --

-- inherited from native C++ Object

cls = {}

if superType == "table" then

-- copy fields from super

for k,v in pairs(super) do cls[k] = v end

cls.__create = super.__create

cls.super = super

else

cls.__create = super

end

cls.ctor = function() end

cls.__cname = classname

cls.__ctype = 1

function cls.new(...)

local instance = cls.__create(...)

-- copy fields from class to native object

for k,v in pairs(cls) do instance[k] = v end

instance.class = cls

instance:ctor(...)

return instance

end

-- End of Part 2 --

else

-- Part 3 --

-- inherited from Lua Object

if super then

cls = clone(super)

cls.super = super

else

cls = {ctor = function() end}

end

cls.__cname = classname

cls.__ctype = 2 -- lua

cls.__index = cls

function cls.new(...)

local instance = setmetatable({}, cls)

instance.class = cls

instance:ctor(...)

return instance

end

-- End of Part 3 --

end

return cls

end

为了让没有使用过这个函数的读者也能读懂，先说一下函数的用法吧

--- Sample1: 创建新的类
-- 创建一个名为ClassA的类
local ClassA = class("ClassA")
-- 创建ClassA类的实例
local a = ClassA.new()
-- ClassA的构造函数
function ClassA:ctor()
    self.name = "a"
end
local aa = ClassA.new()
print(aa.name) -- 输出：a
--- Sample2: 从lua的table继承
-- 创建一个名为ClassB的类，ClassB继承于ClassA
local ClassB = class("ClassB", ClassA)
-- 创建ClassB类的实例
local b = ClassB.new()
--- Sample3: 从cpp对象（在lua中是userdata）继承
-- 创建一个名为ClassC的类，ClassC继承于cc.Scene
local ClassC = class("ClassC", function()
    return cc.Scene:create()
end)
-- 创建ClassC类的实例
local c = ClassC.new()

--- Sample1: 创建新的类

-- 创建一个名为ClassA的类

local ClassA = class("ClassA")

-- 创建ClassA类的实例

local a = ClassA.new()

-- ClassA的构造函数

function ClassA:ctor()

self.name = "a"

end

local aa = ClassA.new()

print(aa.name) -- 输出：a

--- Sample2: 从lua的table继承

-- 创建一个名为ClassB的类，ClassB继承于ClassA

local ClassB = class("ClassB", ClassA)

-- 创建ClassB类的实例

local b = ClassB.new()

--- Sample3: 从cpp对象（在lua中是userdata）继承

-- 创建一个名为ClassC的类，ClassC继承于cc.Scene

local ClassC = class("ClassC", function()

return cc.Scene:create()

end)

-- 创建ClassC类的实例

local c = ClassC.new()

总体上看，这个函数可以分为3个部分（我已经在代码中用注释标明）。

局部变量声明以及参数类型检查
从cpp类继承
从lua的table继承

局部变量声明以及参数类型检查

local superType = type(super) -- 父类的类型，用于后面决定要进入哪个分支
local cls -- 这将是最后的返回值
-- 父类的类型必须是function或者table，如果都不是，就当做super传的是nil，也就是说当做创建新类来处理
if superType ~= "function" and superType ~= "table" then
    superType = nil
    super = nil
end

local superType = type(super) -- 父类的类型，用于后面决定要进入哪个分支

local cls -- 这将是最后的返回值

-- 父类的类型必须是function或者table，如果都不是，就当做super传的是nil，也就是说当做创建新类来处理

if superType ~= "function" and superType ~= "table" then

superType = nil

super = nil

end

从cpp类继承

-- inherited from native C++ Object
cls = {} -- 初始化cls
-- 父类是从cpp的类继承的
if superType == "table" then
    -- 从父类拷贝所有的元素，我认为这里是有问题的，详见下面的问题1
    for k,v in pairs(super) do cls[k] = v end
    cls.__create = super.__create -- 我想这个只是用来提醒自己，其实这个赋值已经包含在上面的for循环中了
    cls.super    = super
else
    -- 传进来的super是function，__create用来创建类的实例
    cls.__create = super
end
cls.ctor    = function() end  -- 默认构造函数，我认为这里有2个问题的，详见下面的问题2和问题3
cls.__cname = classname  -- 类名
cls.__ctype = 1  -- 类的类型，代表是从cpp的类（userdata）继承的
-- 类的new方法，同问题3
function cls.new(...)
    local instance = cls.__create(...)  -- 创建类的实例
    -- 拷贝所有的元素到实例中，我认为这里也是有问题的，详见下面的问题4
    for k,v in pairs(cls) do instance[k] = v end
    instance.class = cls  -- 对实例的class进行赋值，可以从实例找到cls
    instance:ctor(...)  -- 调用构造函数
    return instance
end

-- inherited from native C++ Object

cls = {} -- 初始化cls

-- 父类是从cpp的类继承的

if superType == "table" then

-- 从父类拷贝所有的元素，我认为这里是有问题的，详见下面的问题1

for k,v in pairs(super) do cls[k] = v end

cls.__create = super.__create -- 我想这个只是用来提醒自己，其实这个赋值已经包含在上面的for循环中了

cls.super = super

else

-- 传进来的super是function，__create用来创建类的实例

cls.__create = super

end

cls.ctor = function() end -- 默认构造函数，我认为这里有2个问题的，详见下面的问题2和问题3

cls.__cname = classname -- 类名

cls.__ctype = 1 -- 类的类型，代表是从cpp的类（userdata）继承的

-- 类的new方法，同问题3

function cls.new(...)

local instance = cls.__create(...) -- 创建类的实例

-- 拷贝所有的元素到实例中，我认为这里也是有问题的，详见下面的问题4

for k,v in pairs(cls) do instance[k] = v end

instance.class = cls -- 对实例的class进行赋值，可以从实例找到cls

instance:ctor(...) -- 调用构造函数

return instance

end

问题1：从父类做深度拷贝

这里的super已经是拷贝过cpp类（userdata）的所有元素，已经是个lua的table了，我认为这里可以完全当做从lua的table继承来处理，而没必要再做一次深度拷贝。

问题2：默认的空构造函数

先理一下代码走到这里的前提

super是function
或者super是从cpp类继承的table

你想到了什么？对，如果super是从cpp类继承的table，那么这里的默认构造函数就屏蔽了父类的构造函数。当然，在构造函数ctor里面有办法调到父类的构造函数的，可以这么做self.class.super.ctor(self)。但是回过头来看第一个前提，super是function的时候，super是没有被赋值到self.class.super的，所以现在要调用父类的构造函数的话，莫非还要判断一下？

问题3：不能被重复利用的代码

由于lua的随意性，很容易同一份代码被“写了多次”，又由于lua的函数是第一类对象，也就是说函数是可以被动态创建的。那么所有代码中，被我标记了问题3的地方，这些地方的函数，虽然看起来就一份代码，但是被创建出来以后却全是不同的实例。试想一下，每一个新创建的类型（不是类的实例），都包含了一个冗余的代码块，得有多大的代价？（实际开销可能并不大，但总觉得是个浪费。）

问题4：创建实例时的深度拷贝

这是在干嘛呢？拷贝那么多遍干嘛？都已经拷贝一遍到cls里面了，再拷贝一遍到instance干嘛呢？完全没有thinking in lua嘛！这里只需要setmetatable就可以了呀。

从lua的table继承

-- inherited from Lua Object
if super then
    cls = clone(super)  -- 从父类做深度拷贝，又来了，问题5
    cls.super = super  -- 标记父类
else
    cls = {ctor = function() end}  -- 父类为空时，创建默认构造函数，同上面的问题3
end
cls.__cname = classname  -- 保存类名
cls.__ctype = 2 -- lua  -- 标记这是个lua继承来的类
cls.__index = cls  -- 为setmetatable做准备
-- 类的new方法，同上面的问题3
function cls.new(...)
    local instance = setmetatable({}, cls)  -- “正统的”lua类继承来了
    instance.class = cls  -- 对实例的class进行赋值，可以从实例找到cls
    instance:ctor(...)  -- 调用构造函数
    return instance
end

-- inherited from Lua Object

if super then

cls = clone(super) -- 从父类做深度拷贝，又来了，问题5

cls.super = super -- 标记父类

else

cls = {ctor = function() end} -- 父类为空时，创建默认构造函数，同上面的问题3

end

cls.__cname = classname -- 保存类名

cls.__ctype = 2 -- lua -- 标记这是个lua继承来的类

cls.__index = cls -- 为setmetatable做准备

-- 类的new方法，同上面的问题3

function cls.new(...)

local instance = setmetatable({}, cls) -- “正统的”lua类继承来了

instance.class = cls -- 对实例的class进行赋值，可以从实例找到cls

instance:ctor(...) -- 调用构造函数

return instance

end

问题5：从父类做深度拷贝

刚刚从userdata做深度还是可以理解的，但是现在是从lua的table做继承呀，放着setmetatable不用，又clone干嘛呀？

总结

很多观点可能会有人认为偏颇，因为大多是深度拷贝的问题，而深度拷贝的时候，对于table、function、userdata等数据来说，也只是拷贝一个引用，并没有太大的代价。但我始终固执地认为，既然要用lua，就应该用lua的思维来解决问题，特别是底层的部分，而且底层的部分，对于内存和执行效率的考虑应该更深入，更全面一些。

不过至少大家可以达成共识，最大的问题就是问题2。

最后，放出我自己写的Oop库来解决上面的问题，并且有更多惊喜等着你去发现。

从Goal游戏说起

2014-09-23 by jennal·0 Comment

游戏规则

原文地址

https://github.com/eatnumber1/goal/blob/master/README.md

翻译

以下翻译复制于FreeBuf

规则就是鼓励你打破规则，要的就是你机智！
程序执行时，该方案要能打印出带足够多的’o’的”goal”来展示程序的功能；
代码g()()('al')必须出现在源代码中。
- g()('al')不能是一个字符串文字；
- 而'al'必须是字符串，或是其他语言中的等价类型，你可以用创建自己的一套语言标准方法（例如C语言必须用"，Ruby可以用"或'的任意一种；
- g()('al')在你语言中必须是有效的右值(如果适用的话）
g()('al')也许不能输出这样一个字符串，如果真的在你的语言中不能输出一个字符串，你应该提交一个原理解释：为什么它不能一个打印出一个可接受字符串的方案呢!
你必须能够插入任意数量的()以调用，而不用修改你的方案。如果非要修改原方案那么它就是失败的。
噢，提醒一下g('al')必须返回”gal”。

PS: 看到这里，如果想自己小试身手可以先不往下看，自己先写一段可以运行的代码，再继续往下

分析

这个规则看起来有点复杂，让先理一理规则，思考一下这个游戏到底要我们做什么。

由于游戏要求用不同的语言实现，支持()调用在不同的语言里可能是不同的东西，例如：C++可能是仿函数，可能是构造函数等。以下都用函数指代可以执行()调用的实体。

写一个名为g的函数
g函数要有2个重载
- 有1个参数时，返回 g+参数
- 没有参数时，返回一个函数，我叫它o函数，o函数也需要2个重载
  - 有1个参数时，返回 g+o+参数
  - 没有参数时，再返回一个类似o的函数，区别是它在带1个参数时，要加2个o
…以此类推

PS: 看到这里，如果还没有自己小试身手的想法，建议就不要浪费时间再往下看了，看了也白看

解决方法

由于最近初学lua，lua的函数是first-class的，所以我的直觉就是lua能非常简单地解决这个问题，所以下面全是lua代码的实现。其他任何函数是first-class或者语言级支持闭包的语言，都能很容易移植或者改写。

第一次尝试

问题有点复杂，让我们把问题分为两个部分

约束的规则
- 各种古怪的调用方式
期望的结果
- 生成"g"+"o"*n+"al"，例如：gal, goal, gooal等

这样看来，第1个部分太难，我们尝试放着第1部分不管，只实现第2部分的要求

local n = 3
local result = 'g'
for i=1,n do
    result = result .. 'o'
end
result = result .. 'al'
print(result)

local n = 3

local result = 'g'

for i=1,n do

result = result .. 'o'

end

result = result .. 'al'

print(result)

结果跟预期的一样，现在只需要修改n的值，就能得到n个o的goal。

第二次尝试

看来进展挺顺利，让我们继续往下，基于第1部分的规则，我们要写一个g函数，支持2种重载，返回不同的值（字符串/o函数），返回的o函数也是类似的，支持2种重载，返回不同的值（字符串/函数）。所以，我考虑o能不能就是g呢？先假设这是可行的，让我们来试试

现在分析一下2种情况的重载

有1个参数时，返回 'g'+'o'*(调用g的次数-1)+参数
没有参数时，返回g自己

local o = ''
local function g(str)
    if str then
        return 'g'..o..str
    end
    o = o .. 'o'
    return g
end
print(g()()()()('al'))

local o = ''

local function g(str)

if str then

return 'g'..o..str

end

o = o .. 'o'

return g

end

print(g()()()()('al'))

可以看到，我们用一个闭包，很容易地解决了这个问题，当每次g被无参数调用的时候，o就加上一个'o'。

第三次尝试

上面的代码看起来好像很完美了，但是g()()()()('al')不能重复调用，因为g共享了同一个o变量。但其实这很容易解决。

local o = ''
local function g(str)
    if str then
        local oo = o
        o = ''
        return 'g'..oo..str
    end
    o = o .. 'o'
    return g
end
print(g()()()()('al'))
print(g()()('al'))

local o = ''

local function g(str)

if str then

local oo = o

o = ''

return 'g'..oo..str

end

o = o .. 'o'

return g

end

print(g()()()()('al'))

print(g()()('al'))

是的，在最后返回之前，重置一下o就行了。这就是传说中的“递归结束条件”。

第4次尝试

如果上面的代码看起来已经完全符合游戏规则，甚至符合了我们自己增加的条件（因为规则并没有要求，能够重复调用）。既然已经加了个规则，我们最后尝试一下，再加个规则，就是当g没有调用g('al')时，例如：g()()，后面再调用g()()('al')，也应该可以正确输出gooal。

为了符合这个条件，我们只能让g返回另一个函数，然后实现一个真正的闭包。

local function g(str)
    local o = ''
    local function fo(str)
        if str then
            return 'g'..o..str
        end
        o = o .. 'o'
        return fo
    end
    return fo(str)
end
g()()
print(g()()()()('al'))
print(g('al'))
print(g()()('al'))

local function g(str)

local o = ''

local function fo(str)

if str then

return 'g'..o..str

end

o = o .. 'o'

return fo

end

return fo(str)

end

g()()

print(g()()()()('al'))

print(g('al'))

print(g()()('al'))

至此，我觉得已经玩够了，该结束了。不知道有没有把问题描述清楚，我想说的是，再复杂的问题，只要我们理解清楚需求，拆分成小模块去逐一击破。到最后甚至可以发现规则的漏洞，自己去加强规则，玩转规则。