[iOS/OSX] Refactor mac_framework so that it can be shared with iOS.

build/config/mac/rules.gni

 # Copyright 2015 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import("//build/toolchain/toolchain.gni")
 
-# Template to package a shared library into a Mac framework bundle.
+# Template to package a shared library into a framework bundle.

[Robert Sesek, 2016/04/11 15:35:26]

"This is used as the base template for both iOS and Mac frameworks."

[sdefresne, 2016/04/12 11:51:19]

Done.

 #
 # Arguments
 #
-#     info_plist:
-#         string, path to the Info.plist file that will be used for the bundle.
-#
 #     output_name:
 #         (optional) string, name of the generated framework without the
 #         .framework suffix. If omitted, defaults to target_name.
 #
 #     framework_version:
 #         (optional) string, version of the framework. Typically this is a
 #         single letter, like "A". If omitted, the Versions/ subdirectory
 #         structure will not be created, and build output will go directly
 #         into the framework subdirectory.
-template("mac_framework") {
-  assert(defined(invoker.deps),
-         "Dependencies must be specified for $target_name")
-  assert(defined(invoker.info_plist),
-         "The Info.plist file must be specified for $target_name")
-
+#
+# See "gn help shared_library" for more information on arguments supported
+# by shared library target.
+template("framework_bundle") {
   _target_name = target_name
   _output_name = target_name
   if (defined(invoker.output_name)) {
     _output_name = invoker.output_name
   }
+
+  _framework_target = _target_name

[Robert Sesek, 2016/04/11 15:35:26]

Leave a comment here along the lines of:

"If the framework is un-versioned, the final _target_name will be the
create_bundle(_framework_target). If the framework is versioned, an action with
the final _target_name will depend on the create_bundle() target in order to
prepare the versioned directory structure."

[sdefresne, 2016/04/12 11:51:19]

Done.

   _framework_name = _output_name + ".framework"
-  _framework_version = ""
-  if (defined(invoker.framework_version)) {
+  _framework_root_dir = "$root_out_dir/$_framework_name"
+  if (defined(invoker.framework_version) && invoker.framework_version != "") {
     _framework_version = invoker.framework_version
+    _framework_root_dir += "/Versions/$_framework_version"
+    _framework_target = _target_name + "_create_bundle"
   }
-  _framework_target = _output_name + "_framework"
 
   _shared_library_target = target_name + "_shared_library"
   _shared_library_bundle_data = _shared_library_target + "_bundle_data"
 
   shared_library(_shared_library_target) {
     visibility = [ ":$_shared_library_bundle_data" ]
     forward_variables_from(invoker,
                            "*",
                            [
                              "assert_no_deps",
                              "data_deps",
-                             "info_plist",
                              "output_name",
-                             "visibility",

[Robert Sesek, 2016/04/11 15:35:26]

Does the local visibility definition override here?

[sdefresne, 2016/04/12 11:51:19]

I incorrectly removed "visibility" and "info_plist" here. Fixed, thank you for
spotting this.

                            ])
   }
 
   bundle_data(_shared_library_bundle_data) {
     visibility = [ ":$_framework_target" ]
     forward_variables_from(invoker, [ "testonly" ])
     sources = [
       "$root_out_dir/${shlib_prefix}${_shared_library_target}${shlib_extension}",
     ]
     outputs = [
       "{{bundle_executable_dir}}/$_output_name",
     ]
     public_deps = [
       ":$_shared_library_target",
     ]
   }
 
-  _info_plist_target = target_name + "_info_plist"
-
-  # TODO(rsesek): Process Info.plist variables.
-
-  _info_plist_bundle_data = _info_plist_target + "_bundle_data"
-
-  bundle_data(_info_plist_bundle_data) {
-    visibility = [ ":$_framework_target" ]
-    forward_variables_from(invoker, [ "testonly" ])
-    sources = [
-      invoker.info_plist,
-    ]
-    outputs = [
-      "{{bundle_root_dir}}/Info.plist",
-    ]
-  }
-
   create_bundle(_framework_target) {
-    visibility = [ ":$_target_name" ]
     forward_variables_from(invoker,
                            [
                              "data_deps",
                              "deps",
                              "public_deps",
                              "testonly",
-                             "visibility",
                            ])
 
+    if (defined(_framework_version)) {
+      visibility = [ ":$_target_name" ]
+    } else {
+      forward_variables_from(invoker, [ "visibility" ])
+    }
+
     if (!defined(deps)) {
       deps = []
     }
-    deps += [
-      ":$_info_plist_bundle_data",
-      ":$_shared_library_bundle_data",
-    ]
+    deps += [ ":$_shared_library_bundle_data" ]
 
-    bundle_root_dir = "$root_out_dir/$_framework_name"
-    if (_framework_version != "") {
-      bundle_root_dir += "/Versions/$_framework_version"
-    }
+    bundle_root_dir = _framework_root_dir
     bundle_resources_dir = "$bundle_root_dir/Resources"
     bundle_executable_dir = "$bundle_root_dir"
   }
 
-  if (_framework_version != "") {
+  if (defined(_framework_version)) {
     action(_target_name) {
       forward_variables_from(invoker,
                              [
                                "visibility",
                                "testonly",
                              ])
       script = "$root_out_dir/gyp-mac-tool"
       outputs = [
         "$root_out_dir/$_framework_name/Versions/Current",
       ]
       args = [
         "package-framework",
         "$_framework_name",
         "$_framework_version",
       ]
       deps = [
         ":$_framework_target",
       ]
     }
-  } else {
-    group(_target_name) {
-      forward_variables_from(invoker,
-                             [
-                               "visibility",
-                               "testonly",
-                             ])
-      deps = [
-        ":$_framework_target",
-      ]
-    }
   }
 }
+
+# Template to package a shared library into a Mac framework bundle.
+#
+# Arguments
+#
+#     info_plist:
+#         string, path to the Info.plist file that will be used for the bundle.
+#
+#     output_name:
+#         (optional) string, name of the generated framework without the
+#         .framework suffix. If omitted, defaults to target_name.
+#
+#     framework_version:
+#         (optional) string, version of the framework. Typically this is a
+#         single letter, like "A". If omitted, the Versions/ subdirectory
+#         structure will not be created, and build output will go directly
+#         into the framework subdirectory.
+#
+# See "gn help shared_library" for more information on arguments supported
+# by shared library target.
+template("mac_framework_bundle") {
+  assert(defined(invoker.deps),
+         "Dependencies must be specified for $target_name")
+  assert(defined(invoker.info_plist),
+         "The Info.plist file must be specified for $target_name")
+
+  _info_plist_target = target_name + "_info_plist"
+
+  # TODO(rsesek): Process Info.plist variables.
+
+  _info_plist_bundle_data = _info_plist_target + "_bundle_data"
+
+  bundle_data(_info_plist_bundle_data) {
+    forward_variables_from(invoker, [ "testonly" ])
+    sources = [
+      invoker.info_plist,
+    ]
+    outputs = [
+      "{{bundle_root_dir}}/Info.plist",
+    ]
+  }
+
+  framework_bundle(target_name) {
+    forward_variables_from(invoker, "*", [ "info_plist" ])
+
+    if (!defined(deps)) {
+      deps = []
+    }
+    deps += [ ":$_info_plist_bundle_data" ]
+  }
+}