在Quick-cocos2dx中使用云风pbc解析Protocol Buffers,支持win、mac、ios、android

时间:2022-04-05 23:59:58
本例主要介绍 如何将 pbc 集成到quick-cocos2dx框架中,让我们的cocos2dx客户端Lua拥有编解码Protocol Buffers能力。
参考:
本例使用的项目位置:
https://github.com/miaodadao/pbc 
框架Quick-cocos2dx官网:http://cn.quick-x.com/
pb文件生成工具:
https://code.google.com/p/protobuf/downloads/list ,本例下载:protoc-2.4.1-win32.zip

大纲:
pb文件生成脚本编写
pbc项目简易修改
集成到相关平台:
集成到win的x-player
集成到mac的x-player
集成到ios、ipad的quick-cocos2dx项目中
集成到android的quick-cocos2dx项目中
项目pbc使用方法

pb文件生成脚本编写
下载protoc-2.4.1-win32.zip 解压到存放proto文件的目录,
https://code.google.com/p/protobuf/downloads/list 
在存放proto文件的位置编写生成protobin的脚本,本例使用win脚本bat.  pbcreate.bat 内容如下:
@echo off
set DIR=%~dp0
cd /d "%DIR%"
setlocal enabledelayedexpansion
for /r %%i in (*.proto) do ( 
set pbname=%%i

set pbname=!pbname:~0,-5!b

   
  protoc -I %DIR% --descriptor_set_out !pbname! %%i 
)
echo "finished"

pbc项目简易修改
1、下载克隆pbc项目,地址:
https://github.com/miaodadao/pbc 
2、修改项目:
    第一步: 在项目根
目录pbc-master下添加注册绑定Lua接口的头文件:pub-lua.h 内容如下:
#ifndef __LUA_PBC_EXTRA_H_
#define __LUA_PBC_EXTRA_H_

#if defined(_USRDLL)
    #define LUA_EXTENSIONS_DLL     __declspec(dllexport)
#else         /* use a DLL library */
    #define LUA_EXTENSIONS_DLL
#endif

#if __cplusplus
extern "C" {
#endif

#include "lauxlib.h"

int LUA_EXTENSIONS_DLL luaopen_protobuf_c(lua_State *L);
    
#if __cplusplus
}
#endif
#endif
     第二步:修改pbc项目中 binding\lua\pbc-lua.c 文件,添加上一步定义的头文件:
    在 #include "../../pbc.h" 后面添加 #include "../../pbc-lua.h"

集成到相关平台
1、打开quick-cocos2dx 项目的quick-x-player_2010.sln解决方案,集成到win的x-player:
      参考:
http://cn.quick-x.com/?p=253  Step 6: 编译 quick-x-player proj.win32 工程
    保证当前player功能能够编译,我的环境是vs2010,接下来再导入pbc项目,步骤如下:
    首先尝试在player的解决方案中添加现有项目,选择pbc项目下 pbc.vcxproj 文件,如果编译不正常则考虑自己新建空项目,然后在项目中导入pbc项目的所有源码,其项目属性配置可以直接参考player解决方案中 lua_extension_201x 的属性配置
    导入的pbc.vcxproj 项目后,要保证pbc.vcxproj 中包含进来pub-lua.h 
    接下来修改quick-x-player_201x项目属性:

    右键quick-x-player_201x项目>>属性>>通用属性>>添加新引用>>选择刚导入的pbc项目>>确定
    修改quick-x-player_201x项目的AppDelegate.cpp ,导入pbc的lua接口。
    添加pub-lua.h这个头文件,根据自己项目位置调整导入路径:

    #include "../../../lua_self_extensions/pbc-master/pbc-lua.h"
    注册pbc接口代码:在bool AppDelegate::applicationDidFinishLaunching()函数中的 luaopen_cocos2dx_extra_luabinding(L);添加代码:luaopen_protobuf_c(L);
    保存编译,到此完成了pbc在win的xplayer中的集成。

2、打开quick-cocos2dx 项目的quick-x-player.xcodeproj工程,集成到mac的x-player:
    展开项目在quickcocos2dx.xcodeproj\libquickcocos2dx 上右键菜单NewGroup>> 新建名为pbc的分组>>右键pbc选择Add Files to “quickcocos2dx.xcodeproj”... 菜单>>先选中 Create group for any added folders>>然后在选择框中切换到pbc项目目录>>选中binding、src、tool三个目录及pbc.h和pbc-lua.h两个头文件>>Add到项目中
    修改项目的AppDelegate.cpp ,导入pbc的lua接口,由于此文件修改方法与上一步相同,此处省略
     保存编译,到此完成了pbc在mac的xplayer中的集成。

3、打开quick-cocos2dx 创建的项目的proj.ios目录下的工程,集成pbc到项目中
    展开项目工程,在quickcocos2dx.xcodeproj\libquickcocos2dx 上右键菜单NewGroup,后续操作与上一步相同
    修改项目的AppDelegate.cpp ,导入pbc的lua接口,与上一步相同
    保存编译,到此完成了pbc在ios项目中的集成。

4、添加pbc集成到android的quick-cocos2dx项目中
    pbc项目的目录名称为pbc-master,在与pbc同级的目录,新建文件夹luaproj.android,在luaproj.android下添加Android.mk文件,内容如下:
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)

LOCAL_MODULE := quickextenpbc
LOCAL_MODULE_FILENAME := libquickextenpbc

LOCAL_EXPORT_CFLAGS := -Wno-psabi -DUSE_FILE32API -DCC_LUA_ENGINE_ENABLED=1 -DDEBUG=1 -DCOCOS2D_DEBUG=1
LOCAL_CFLAGS := -Wno-psabi -DUSE_FILE32API -DCC_LUA_ENGINE_ENABLED=1 -DDEBUG=1 -DCOCOS2D_DEBUG=1

LOCAL_WHOLE_STATIC_LIBRARIES := lua_pbc

include $(BUILD_STATIC_LIBRARY)
$(call import-module,pbc-master)

    在pbc的目录pbc-master下添加Android.mk文件,内容如下
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)

LOCAL_MODULE := lua_pbc
LOCAL_MODULE_FILENAME := liblua_pbc

LOCAL_SRC_FILES := \
 src/alloc.c \
src/array.c \
src/bootstrap.c \
src/context.c \
src/decode.c \
src/map.c \
src/pattern.c \
src/proto.c \
src/register.c \
src/rmessage.c \
src/stringpool.c \
src/varint.c \
src/wmessage.c \
binding/lua/pbc-lua.c \

LOCAL_C_INCLUDES+= \
src \

LOCAL_CFLAGS := -Wno-psabi -DUSE_FILE32API -DCC_LUA_ENGINE_ENABLED=1 -DDEBUG=1 -DCOCOS2D_DEBUG=1
LOCAL_WHOLE_STATIC_LIBRARIES := cocos_lua_static
include $(BUILD_STATIC_LIBRARY)
$(call import-module,scripting/lua/proj.android)
    在quick-cocos2dx 创建的项目的proj.android下修改build_native.bat:
        在脚本的最后找到 NDK_MODULE_PATH 为此变量添加 pbc项目 所在的文件目录,即pbc-master的上一级路径
    最后修改项目的proj.android\jni\Android.mk文件 添加pbc模块,内容如下:
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := game_shared
LOCAL_MODULE_FILENAME := libgame
LOCAL_SRC_FILES := hellocpp/main.cpp \
    ../../sources/AppDelegate.cpp
LOCAL_C_INCLUDES := $(LOCAL_PATH)/../../sources
LOCAL_CFLAGS += -Wno-psabi -DCC_LUA_ENGINE_ENABLED=1 -DDEBUG=1 -DCOCOS2D_DEBUG=1

LOCAL_WHOLE_STATIC_LIBRARIES := quickcocos2dx
LOCAL_WHOLE_STATIC_LIBRARIES += quickextenpbc

include $(BUILD_SHARED_LIBRARY)

$(call import-module,lib/proj.android) \
$(call import-module,luaproj.android)

        最后,核对android编译相关的环境变量,参考
http://cn.quick-x.com/?p=253 
        保持编译,到此完成了pbc集成到android项目的工作。

项目pbc使用方法 
    将pbc项目的pbc-master\binding\lua\protobuf.lua复制到自己项目的res/scripts/目录下,
    将proto文件编译后的.pb文件拷贝到自己项目的res/目录下
    使用参考:
    https://github.com/miaodadao/pbc
    云风博客http://blog.codingnow.com/2011/12/pbc_lua_binding.html