Merge pull request #409 from natural-law/gradle-support

Improve the command cocos compile to fit the new implementation of AndroidStudio project.

Author: Bin Zhang

bin/strings.json

@@ -183,6 +183,7 @@
         "COMPILE_ERROR_WRONG_VS_VER_FMT" : "VS %d is not supported.",
         "COMPILE_ERROR_LOW_VS_VER" : "Version of VS is too low.",
         "COMPILE_ERROR_MSDBUILD_NOT_FOUND" : "MSBuild is not found.",
+        "COMPILE_ERROR_UNKNOWN_ENGINE_VERSION" : "Unknown engine version!",
         "COMPILE_INFO_FIND_VS_PATH_FMT" : "Find VS path : %s",
         "COMPILE_INFO_DEVENV_NOT_FOUND" : "Not found devenv. Try to use msbuild instead.",
         "COMPILE_INFO_FIND_MSBUILD_FMT" : "Found msbuild path: %s",
@@ -526,6 +527,7 @@
         "COMPILE_ERROR_WRONG_VS_VER_FMT" : "不支持 VS %d。",
         "COMPILE_ERROR_LOW_VS_VER" : "VS 版本过低。",
         "COMPILE_ERROR_MSDBUILD_NOT_FOUND" : "未找到 MSBuild 工具。",
+        "COMPILE_ERROR_UNKNOWN_ENGINE_VERSION" : "無法識別引擎版本!",
         "COMPILE_INFO_FIND_VS_PATH_FMT" : "找到 VS 安装路径：%s",
         "COMPILE_INFO_DEVENV_NOT_FOUND" : "未找到 devenv。尝试使用 msbuild 来代替。",
         "COMPILE_INFO_FIND_MSBUILD_FMT" : "找到 msbuild 安装路径：%s",
@@ -868,6 +870,7 @@
         "COMPILE_ERROR_WRONG_VS_VER_FMT" : "不支持 VS %d。",
         "COMPILE_ERROR_LOW_VS_VER" : "VS 版本過低。",
         "COMPILE_ERROR_MSDBUILD_NOT_FOUND" : "未找到 MSBuild 工具。",
+        "COMPILE_ERROR_UNKNOWN_ENGINE_VERSION" : "无法识别引擎版本!",
         "COMPILE_INFO_FIND_VS_PATH_FMT" : "找到 VS 安裝路徑：%s",
         "COMPILE_INFO_DEVENV_NOT_FOUND" : "未找到 devenv。嘗試使用 msbuild 來代替。",
         "COMPILE_INFO_FIND_MSBUILD_FMT" : "找到 msbuild 安裝路徑：%s",

plugins/plugin_compile/build_android.py

@@ -37,13 +37,24 @@ class AndroidBuilder(object):
     GRADLE_KEY_STORE_PASS = "RELEASE_STORE_PASSWORD"
     GRADLE_KEY_ALIAS_PASS = "RELEASE_KEY_PASSWORD"
 
-    def __init__(self, verbose, app_android_root, no_res, proj_obj, use_studio=False):
+    GRADLE_PROP_TARGET_VERSION = 'PROP_TARGET_SDK_VERSION'
+    GRADLE_PROP_NDK_MODE = 'PROP_NDK_MODE'
+    GRADLE_PROP_APP_ABI = 'PROP_APP_ABI'
+    GRADLE_PROP_COMPILE_SCRIPT = 'PROP_COMPILE_SCRIPT'
+    GRADLE_PROP_LUA_ENCRYPT = 'PROP_LUA_ENCRYPT'
+    GRADLE_PROP_LUA_ENCRYPT_KEY = 'PROP_LUA_ENCRYPT_KEY'
+    GRADLE_PROP_LUA_ENCRYPT_SIGN = 'PROP_LUA_ENCRYPT_SIGN'
+
+    def __init__(self, verbose, app_android_root, no_res, proj_obj, ndk_mode, app_abi, use_studio=False, gradle_support_ndk=False):
         self._verbose = verbose
 
         self.app_android_root = app_android_root
         self._no_res = no_res
         self._project = proj_obj
         self.use_studio = use_studio
+        self.gradle_support_ndk = gradle_support_ndk
+        self.app_abi = app_abi
+        self.ndk_mode = ndk_mode
 
         # check environment variable
         if self.use_studio:
@@ -60,6 +71,21 @@ def _run_cmd(self, command, cwd=None):
         cocos.CMDRunner.run_cmd(command, self._verbose, cwd=cwd)
 
     def _parse_cfg(self):
+        # get the properties for sign release apk
+        if self.use_studio:
+            self.key_store_str = AndroidBuilder.GRADLE_KEY_STORE
+            self.key_alias_str = AndroidBuilder.GRADLE_KEY_ALIAS
+            self.key_store_pass_str = AndroidBuilder.GRADLE_KEY_STORE_PASS
+            self.key_alias_pass_str = AndroidBuilder.GRADLE_KEY_ALIAS_PASS
+        else:
+            self.key_store_str = AndroidBuilder.ANT_KEY_STORE
+            self.key_alias_str = AndroidBuilder.ANT_KEY_ALIAS
+            self.key_store_pass_str = AndroidBuilder.ANT_KEY_STORE_PASS
+            self.key_alias_pass_str = AndroidBuilder.ANT_KEY_ALIAS_PASS
+
+        if self.gradle_support_ndk:
+            return
+
         self.cfg_path = os.path.join(self.app_android_root, BUILD_CFIG_FILE)
         try:
             f = open(self.cfg_path)
@@ -79,18 +105,6 @@ def _parse_cfg(self):
 
         self.ndk_module_paths = cfg['ndk_module_path']
 
-        # get the properties for sign release apk
-        if self.use_studio:
-            self.key_store_str = AndroidBuilder.GRADLE_KEY_STORE
-            self.key_alias_str = AndroidBuilder.GRADLE_KEY_ALIAS
-            self.key_store_pass_str = AndroidBuilder.GRADLE_KEY_STORE_PASS
-            self.key_alias_pass_str = AndroidBuilder.GRADLE_KEY_ALIAS_PASS
-        else:
-            self.key_store_str = AndroidBuilder.ANT_KEY_STORE
-            self.key_alias_str = AndroidBuilder.ANT_KEY_ALIAS
-            self.key_store_pass_str = AndroidBuilder.ANT_KEY_STORE_PASS
-            self.key_alias_pass_str = AndroidBuilder.ANT_KEY_ALIAS_PASS
-
         move_cfg = {}
         self.key_store = None
         if cfg.has_key(AndroidBuilder.CFG_KEY_STORE):
@@ -169,6 +183,18 @@ def remove_c_libs(self, libs_dir):
                     os.remove(lib_file)
 
     def update_project(self, android_platform):
+        if self.gradle_support_ndk:
+            # If gradle supports ndk build, should write local.properties manually
+            local_porps_path = os.path.join(self.app_android_root, 'local.properties')
+            lines = [
+                'sdk.dir=%s\n' % self.sdk_root,
+                'ndk.dir=%s\n' % cocos.check_environment_variable('NDK_ROOT')
+            ]
+            f = open(local_porps_path, 'w')
+            f.writelines(lines)
+            f.close()
+            return
+
         if self.use_studio:
             manifest_path = os.path.join(self.app_android_root, 'app')
         else:
@@ -356,7 +382,7 @@ def ant_build_apk(self, build_mode, custom_step_args):
         self._project.invoke_custom_step_script(cocos_project.Project.CUSTOM_STEP_POST_ANT_BUILD,
                                                 target_platform, args_ant_copy)
 
-    def gradle_build_apk(self, build_mode):
+    def gradle_build_apk(self, build_mode, android_platform, compile_obj):
         # check the compileSdkVersion & buildToolsVersion
         check_file = os.path.join(self.app_android_root, 'app', 'build.gradle')
         f = open(check_file)
@@ -404,6 +430,32 @@ def gradle_build_apk(self, build_mode):
 
         mode_str = 'Debug' if build_mode == 'debug' else 'Release'
         cmd = '"%s" --parallel --info assemble%s' % (gradle_path, mode_str)
+
+        if self.gradle_support_ndk:
+            add_props = {
+                AndroidBuilder.GRADLE_PROP_NDK_MODE: self.ndk_mode
+            }
+            if android_platform:
+                add_props[AndroidBuilder.GRADLE_PROP_TARGET_VERSION] = android_platform
+
+            if self.app_abi:
+                add_props[AndroidBuilder.GRADLE_PROP_APP_ABI] = ':'.join(self.app_abi.split(' '))
+
+            if self._project._is_script_project():
+                if compile_obj._compile_script:
+                    add_props[AndroidBuilder.GRADLE_PROP_COMPILE_SCRIPT] = 1
+                else:
+                    add_props[AndroidBuilder.GRADLE_PROP_COMPILE_SCRIPT] = 0
+
+            if self._project._is_lua_project():
+                if compile_obj._lua_encrypt:
+                    add_props[AndroidBuilder.GRADLE_PROP_LUA_ENCRYPT] = 1
+                    add_props[AndroidBuilder.GRADLE_PROP_LUA_ENCRYPT_KEY] = compile_obj._lua_encrypt_key
+                    add_props[AndroidBuilder.GRADLE_PROP_LUA_ENCRYPT_SIGN] = compile_obj._lua_encrypt_sign
+
+            for key in add_props.keys():
+                cmd += ' -P%s=%s' % (key, add_props[key])
+
         self._run_cmd(cmd, cwd=self.app_android_root)
 
     class LuaBuildType:
@@ -461,7 +513,7 @@ def _get_build_type(self, param_of_appabi):
 
         return self.LuaBuildType.UNKNOWN
 
-    def do_build_apk(self, build_mode, no_apk, output_dir, custom_step_args, compile_obj):
+    def do_build_apk(self, build_mode, no_apk, output_dir, custom_step_args, android_platform, compile_obj):
         if self.use_studio:
             assets_dir = os.path.join(self.app_android_root, "app", "assets")
             project_name = None
@@ -489,45 +541,44 @@ def do_build_apk(self, build_mode, no_apk, output_dir, custom_step_args, compile
             project_name = self._xml_attr(self.app_android_root, 'build.xml', 'project', 'name')
             gen_apk_folder = os.path.join(self.app_android_root, 'bin')
 
-        # copy resources
-        self._copy_resources(custom_step_args, assets_dir)
+        # gradle supports copy assets & compile scripts from engine 3.15
+        if not self.gradle_support_ndk:
+            # copy resources
+            self._copy_resources(custom_step_args, assets_dir)
+
+            # check the project config & compile the script files
+            if self._project._is_lua_project():
+                src_dir = os.path.join(assets_dir, 'src')
+                build_type = self._get_build_type(compile_obj.app_abi)
 
-        # check the project config & compile the script files
-        if self._project._is_lua_project():
-            print "generate byte code ............"
-            src_dir = os.path.join(assets_dir, 'src')
-            build_type = self._get_build_type(compile_obj.app_abi)
+                # only build 64bit
+                if build_type == self.LuaBuildType.ONLY_BUILD_64BIT:
+                    dst_dir = os.path.join(assets_dir, 'src/64bit')
+                    is_compiled = compile_obj.compile_lua_scripts(src_dir, dst_dir, True)
+                    if is_compiled:
+                        # remove unneeded lua files
+                        compile_obj._remove_file_with_ext(src_dir, '.lua')
+                        shutil.rmtree(os.path.join(src_dir, 'cocos'))
+
+                # only build 32bit
+                if build_type == self.LuaBuildType.ONLY_BUILD_32BIT:
+                    # build 32-bit bytecode
+                    compile_obj.compile_lua_scripts(src_dir, src_dir, False)
 
-            # only build 64bit
-            if build_type == self.LuaBuildType.ONLY_BUILD_64BIT:
-                if build_mode == 'release':
+                # build 32bit and 64bit
+                if build_type == self.LuaBuildType.BUILD_32BIT_AND_64BIT:
+                    # build 64-bit bytecode
                     dst_dir = os.path.join(assets_dir, 'src/64bit')
                     compile_obj.compile_lua_scripts(src_dir, dst_dir, True)
-                    # remove unneeded lua files
-                    compile_obj._remove_file_with_ext(src_dir, '.lua')
-                    shutil.rmtree(os.path.join(src_dir, 'cocos'))
-                else:
+                    # build 32-bit bytecode
+                    compile_obj.compile_lua_scripts(src_dir, src_dir, False)
+
+                if build_type == self.LuaBuildType.UNKNOWN:
+                    # haven't set APP_ABI in parameter and Application.mk, default build 32bit
                     compile_obj.compile_lua_scripts(src_dir, src_dir, False)
 
-            # only build 32bit
-            if build_type == self.LuaBuildType.ONLY_BUILD_32BIT:
-                # build 32-bit bytecode
-                compile_obj.compile_lua_scripts(src_dir, src_dir, False)
-            
-            # build 32bit and 64bit
-            if build_type == self.LuaBuildType.BUILD_32BIT_AND_64BIT:
-                # build 64-bit bytecode
-                dst_dir = os.path.join(assets_dir, 'src/64bit')
-                compile_obj.compile_lua_scripts(src_dir, dst_dir, True)
-                # build 32-bit bytecode
-                compile_obj.compile_lua_scripts(src_dir, src_dir, False)
-
-            if build_type == self.LuaBuildType.UNKNOWN:
-                # haven't set APP_ABI in parameter and Application.mk, default build 32bit
-                compile_obj.compile_lua_scripts(src_dir, src_dir, False)
-
-        if self._project._is_js_project():
-            compile_obj.compile_js_scripts(assets_dir, assets_dir)
+            if self._project._is_js_project():
+                compile_obj.compile_js_scripts(assets_dir, assets_dir)
 
         if not no_apk:
             # gather the sign info if necessary
@@ -536,7 +587,7 @@ def do_build_apk(self, build_mode, no_apk, output_dir, custom_step_args, compile
 
             # build apk
             if self.use_studio:
-                self.gradle_build_apk(build_mode)
+                self.gradle_build_apk(build_mode, android_platform, compile_obj)
             else:
                 self.ant_build_apk(build_mode, custom_step_args)
 

plugins/plugin_compile/project_compile.py

@@ -378,19 +378,18 @@ def _remove_file_with_ext(self, work_dir, ext):
 
     def compile_lua_scripts(self, src_dir, dst_dir, build_64):
         if not self._project._is_lua_project():
-            return
+            return False
 
         if not self._compile_script and not self._lua_encrypt:
-            return
+            return False
 
         cocos_cmd_path = os.path.join(os.path.dirname(os.path.abspath(sys.argv[0])), "cocos")
         rm_ext = ".lua"
         compile_cmd = "\"%s\" luacompile -s \"%s\" -d \"%s\"" % (cocos_cmd_path, src_dir, dst_dir)
 
         if not self._compile_script:
             compile_cmd = "%s --disable-compile" % compile_cmd
-
-        if build_64:
+        elif build_64:
             compile_cmd = "%s --bytecode-64bit" % compile_cmd
 
         if self._lua_encrypt:
@@ -409,12 +408,14 @@ def compile_lua_scripts(self, src_dir, dst_dir, build_64):
         # remove the source scripts
         self._remove_file_with_ext(dst_dir, rm_ext)
 
+        return True
+
     def compile_js_scripts(self, src_dir, dst_dir):
         if not self._project._is_js_project():
-            return
+            return False
 
         if not self._compile_script:
-            return
+            return False
 
         cocos_cmd_path = os.path.join(os.path.dirname(os.path.abspath(sys.argv[0])), "cocos")
         rm_ext = ".js"
@@ -425,6 +426,7 @@ def compile_js_scripts(self, src_dir, dst_dir):
 
         # remove the source scripts
         self._remove_file_with_ext(dst_dir, rm_ext)
+        return True
 
     def add_warning_at_end(self, warning_str):
         if warning_str is None or len(warning_str) == 0:
@@ -439,6 +441,26 @@ def is_valid_path(self, p):
 
         return ret
 
+    def get_engine_version_num(self):
+        # 1. get engine version from .cocos_project.json
+        engine_ver_str = self._project.get_proj_config(cocos_project.Project.KEY_ENGINE_VERSION)
+
+        # 2. engine version is not found. find from source file
+        if engine_ver_str is None:
+            engine_dir = self.get_engine_dir()
+            if engine_dir is not None:
+                engine_ver_str = utils.get_engine_version(engine_dir)
+
+        if engine_ver_str is None:
+            return None
+
+        version_pattern = r'.*([\d]+)\.([\d]+)'
+        match = re.match(version_pattern, engine_ver_str)
+        if match:
+            return ((int)(match.group(1)), (int)(match.group(2)))
+        else:
+            return None
+
     def build_android(self):
         if not self._platforms.is_android_active():
             return
@@ -475,9 +497,24 @@ def build_android(self):
             ide_name = 'Eclipse'
         cocos.Logging.info(MultiLanguage.get_string('COMPILE_INFO_ANDROID_PROJPATH_FMT', (ide_name, project_android_dir)))
 
+        # Check whether the gradle of the project is support ndk or not
+        gradle_support_ndk = False
+        if using_studio:
+            # Get the engine version of the project
+            engine_version_num = self.get_engine_version_num()
+            if engine_version_num is None:
+                raise cocos.CCPluginError(MultiLanguage.get_string('COMPILE_ERROR_UNKNOWN_ENGINE_VERSION'))
+
+            # Gradle supports NDK build from engine 3.15
+            main_ver = engine_version_num[0]
+            minor_ver = engine_version_num[1]
+            if main_ver > 3 or (main_ver == 3 and minor_ver >= 15):
+                gradle_support_ndk = True
+
         from build_android import AndroidBuilder
         builder = AndroidBuilder(self._verbose, project_android_dir,
-                                 self._no_res, self._project, using_studio)
+                                 self._no_res, self._project, self._ndk_mode,
+                                 self.app_abi, using_studio, gradle_support_ndk)
 
         args_ndk_copy = self._custom_step_args.copy()
         target_platform = self._platforms.get_current_platform()
@@ -486,7 +523,7 @@ def build_android(self):
         builder.update_project(self._ap)
 
         if not self._project._is_script_project() or self._project._is_native_support():
-            if self._ndk_mode != "none":
+            if self._ndk_mode != "none" and not gradle_support_ndk:
                 # build native code
                 cocos.Logging.info(MultiLanguage.get_string('COMPILE_INFO_BUILD_NATIVE'))
                 ndk_build_param = [
@@ -541,7 +578,7 @@ def build_android(self):
         # build apk
         if not self._no_apk:
             cocos.Logging.info(MultiLanguage.get_string('COMPILE_INFO_BUILD_APK'))
-        self.apk_path = builder.do_build_apk(build_mode, self._no_apk, output_dir, self._custom_step_args, self)
+        self.apk_path = builder.do_build_apk(build_mode, self._no_apk, output_dir, self._custom_step_args, self._ap, self)
         self.android_package, self.android_activity = builder.get_apk_info()
 
         cocos.Logging.info(MultiLanguage.get_string('COMPILE_INFO_BUILD_SUCCEED'))