src/main/starlark/builtins_bzl/common/objc/objc_library.bzl - bazel - Git at Google

 # Copyright 2020 The Bazel Authors. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
 #    http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.

 """objc_library Starlark implementation replacing native"""

 load("@_builtins//:common/objc/compilation_support.bzl", "compilation_support")
 load("@_builtins//:common/objc/attrs.bzl", "common_attrs")
 load("@_builtins//:common/objc/transitions.bzl", "apple_crosstool_transition")
 load("@_builtins//:common/cc/cc_helper.bzl", "cc_helper")

 objc_internal = _builtins.internal.objc_internal
 CcInfo = _builtins.toplevel.CcInfo
 cc_common = _builtins.toplevel.cc_common
 coverage_common = _builtins.toplevel.coverage_common
 apple_common = _builtins.toplevel.apple_common

 def _attribute_error(attr_name, msg):
     fail("in attribute '" + attr_name + "': " + msg)

 def _validate_attributes(label):
     if label.name.find("/") != -1:
         _attribute_error("name", "this attribute has unsupported character '/'")

 def _build_linking_context(
         *,
         actions,
         archive,
         cc_toolchain,
         deps,
         feature_configuration,
         label,
         objc_provider):
     """Creates CcLinkingContext for the objc_library target CcInfo provider.

     Args:
         actions: The actions provider from `ctx.actions`.
         archive: Archive library from Objc CompilationArtifacts.
         cc_toolchain: CcToolchainInfo provider for current target.
         deps: List of dependencies for the objc_library target.
         feature_configuration: Features configuration for current target.
         label: The label of the target being analyzed.
         objc_provider: Current apple_common.ObjcProvider for target.
     """
     libraries = []
     if archive != None:
         library_to_link = _static_library(
             actions = actions,
             cc_toolchain = cc_toolchain,
             feature_configuration = feature_configuration,
             static_library = archive,
         )
         libraries.append(library_to_link)

     archives_from_objc_library = {}
     for library in objc_provider.library.to_list():
         archives_from_objc_library[library.path] = library

     objc_libraries_cc_infos = []
     for dep in deps:
         if apple_common.Objc in dep and CcInfo in dep:
             objc_libraries_cc_infos.append(dep[CcInfo])

     merged_objc_library_cc_infos = cc_common.merge_cc_infos(cc_infos = objc_libraries_cc_infos)

     for linker_input in merged_objc_library_cc_infos.linking_context.linker_inputs.to_list():
         for lib in linker_input.libraries:
             path = None
             if lib.static_library != None:
                 path = lib.static_library.path
             elif lib.pic_static_library != None:
                 path = lib.pic_static_library.path
             if path in archives_from_objc_library and archives_from_objc_library[path]:
                 libraries.append(lib)
                 archives_from_objc_library[path] = None

     for archive_from_objc_library in archives_from_objc_library.values():
         if archive_from_objc_library:
             library_to_link = _static_library(
                 actions = actions,
                 cc_toolchain = cc_toolchain,
                 feature_configuration = feature_configuration,
                 static_library = archive_from_objc_library,
             )
             libraries.append(library_to_link)

     libraries.extend(objc_provider.cc_library.to_list())

     user_link_flags = _user_link_flags(
         cc_info = merged_objc_library_cc_infos,
         objc_provider = objc_provider,
     )

     direct_linker_inputs = []
     if len(user_link_flags) != 0 or len(libraries) != 0 or objc_provider.linkstamp:
         linker_input = cc_common.create_linker_input(
             owner = label,
             libraries = depset(libraries),
             user_link_flags = user_link_flags,
             linkstamps = objc_provider.linkstamp,
         )
         direct_linker_inputs.append(linker_input)

     return cc_common.create_linking_context(
         linker_inputs = depset(direct = direct_linker_inputs, order = "topological"),
     )

 def _static_library(
         *,
         actions,
         cc_toolchain,
         feature_configuration,
         static_library):
     """"Creates a LibraryToLink resource for CcLinkingContext.LinkerInputs.

     Args:
         actions: The actions provider from `ctx.actions`.
         cc_toolchain: CcToolchainInfo provider for current target.
         feature_configuration: Features configuration for current target.
         static_library: Static library artifact to link.
     """
     alwayslink = False
     if static_library.extension == "lo":
         alwayslink = True
     return cc_common.create_library_to_link(
         actions = actions,
         feature_configuration = feature_configuration,
         cc_toolchain = cc_toolchain,
         static_library = static_library,
         alwayslink = alwayslink,
     )

 def _user_link_flags(*, cc_info, objc_provider):
     """Builds objc_library CcInfo user link flags for frameworks and dylibs.

     Args:
         cc_info: Merged CcInfo provider from objc_library target deps.
         objc_provider: Current objc_library ObjC provider.
     Returns:
         List of user link flags for frameworks and dylibs.
     """

     sdk_dylibs = objc_provider.sdk_dylib.to_list()
     sdk_frameworks = objc_provider.sdk_framework.to_list()

     all_user_link_flags = []
     all_user_link_flags.extend(objc_provider.linkopt.to_list())

     for linker_input in cc_info.linking_context.linker_inputs.to_list():
         all_user_link_flags.extend(linker_input.user_link_flags)

     for i, user_link_flag in enumerate(all_user_link_flags):
         if user_link_flag.startswith("-l"):
             sdk_dylibs.append("lib" + user_link_flag[2:])
         elif user_link_flag == "-framework":
             sdk_frameworks.append(all_user_link_flags[i + 1])

     sdk_user_link_flags = []
     for sdk_framework in depset(sdk_frameworks).to_list():
         sdk_user_link_flags.append(["-framework", sdk_framework])
     for sdk_dylib in depset(sdk_dylibs).to_list():
         if sdk_dylib.startswith("lib"):
             sdk_dylib = sdk_dylib[3:]
         sdk_user_link_flags.append(["-l" + sdk_dylib])

     return sdk_user_link_flags

 def _objc_library_impl(ctx):
     """Implementation of objc_library."""

     _validate_attributes(label = ctx.label)

     cc_toolchain = cc_helper.find_cpp_toolchain(ctx)

     common_variables = compilation_support.build_common_variables(
         ctx = ctx,
         toolchain = cc_toolchain,
         use_pch = True,
         deps = ctx.attr.deps,
         runtime_deps = ctx.attr.runtime_deps,
         linkopts = ctx.attr.linkopts,
         alwayslink = ctx.attr.alwayslink,
     )
     files = []
     if common_variables.compilation_artifacts.archive != None:
         files.append(common_variables.compilation_artifacts.archive)

     (cc_compilation_context, compilation_outputs, output_groups) = compilation_support.register_compile_and_archive_actions(
         common_variables,
     )

     compilation_support.validate_attributes(common_variables)

     j2objc_providers = objc_internal.j2objc_providers_from_deps(ctx = ctx)

     objc_provider = common_variables.objc_provider
     feature_configuration = compilation_support.build_feature_configuration(common_variables, False, True)
     linking_context = _build_linking_context(
         actions = ctx.actions,
         archive = common_variables.compilation_artifacts.archive,
         cc_toolchain = cc_toolchain,
         deps = ctx.attr.deps,
         feature_configuration = feature_configuration,
         label = ctx.label,
         objc_provider = objc_provider,
     )

     return [
         DefaultInfo(
             files = depset(files),
             data_runfiles = ctx.runfiles(files = files),
         ),
         CcInfo(
             compilation_context = cc_compilation_context,
             linking_context = linking_context,
         ),
         objc_provider,
         j2objc_providers[0],
         j2objc_providers[1],
         objc_internal.instrumented_files_info(
             ctx = ctx,
             cc_toolchain = cc_toolchain,
             config = ctx.configuration,
             object_files = compilation_outputs.objects,
         ),
         OutputGroupInfo(**output_groups),
     ]

 objc_library = rule(
     implementation = _objc_library_impl,
     attrs = common_attrs.union(
         {
             "data": attr.label_list(allow_files = True),
         },
         common_attrs.CC_TOOLCHAIN_RULE,
         common_attrs.LICENSES,
         common_attrs.COMPILING_RULE,
         common_attrs.COMPILE_DEPENDENCY_RULE,
         common_attrs.INCLUDE_SCANNING_RULE,
         common_attrs.SDK_FRAMEWORK_DEPENDER_RULE,
         common_attrs.COPTS_RULE,
         common_attrs.XCRUN_RULE,
     ),
     fragments = ["objc", "apple", "cpp"],
     cfg = apple_crosstool_transition,
     toolchains = cc_helper.use_cpp_toolchain(),
     incompatible_use_toolchain_transition = True,
 )
	# Copyright 2020 The Bazel Authors. All rights reserved.
	#
	# Licensed under the Apache License, Version 2.0 (the "License");
	# you may not use this file except in compliance with the License.
	# You may obtain a copy of the License at
	#
	# http://www.apache.org/licenses/LICENSE-2.0
	#
	# Unless required by applicable law or agreed to in writing, software
	# distributed under the License is distributed on an "AS IS" BASIS,
	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	# See the License for the specific language governing permissions and
	# limitations under the License.

	"""objc_library Starlark implementation replacing native"""

	load("@_builtins//:common/objc/compilation_support.bzl", "compilation_support")
	load("@_builtins//:common/objc/attrs.bzl", "common_attrs")
	load("@_builtins//:common/objc/transitions.bzl", "apple_crosstool_transition")
	load("@_builtins//:common/cc/cc_helper.bzl", "cc_helper")

	objc_internal = _builtins.internal.objc_internal
	CcInfo = _builtins.toplevel.CcInfo
	cc_common = _builtins.toplevel.cc_common
	coverage_common = _builtins.toplevel.coverage_common
	apple_common = _builtins.toplevel.apple_common

	def _attribute_error(attr_name, msg):
	fail("in attribute '" + attr_name + "': " + msg)

	def _validate_attributes(label):
	if label.name.find("/") != -1:
	_attribute_error("name", "this attribute has unsupported character '/'")

	def _build_linking_context(
	*,
	actions,
	archive,
	cc_toolchain,
	deps,
	feature_configuration,
	label,
	objc_provider):
	"""Creates CcLinkingContext for the objc_library target CcInfo provider.

	Args:
	actions: The actions provider from `ctx.actions`.
	archive: Archive library from Objc CompilationArtifacts.
	cc_toolchain: CcToolchainInfo provider for current target.
	deps: List of dependencies for the objc_library target.
	feature_configuration: Features configuration for current target.
	label: The label of the target being analyzed.
	objc_provider: Current apple_common.ObjcProvider for target.
	"""
	libraries = []
	if archive != None:
	library_to_link = _static_library(
	actions = actions,
	cc_toolchain = cc_toolchain,
	feature_configuration = feature_configuration,
	static_library = archive,
	)
	libraries.append(library_to_link)

	archives_from_objc_library = {}
	for library in objc_provider.library.to_list():
	archives_from_objc_library[library.path] = library

	objc_libraries_cc_infos = []
	for dep in deps:
	if apple_common.Objc in dep and CcInfo in dep:
	objc_libraries_cc_infos.append(dep[CcInfo])

	merged_objc_library_cc_infos = cc_common.merge_cc_infos(cc_infos = objc_libraries_cc_infos)

	for linker_input in merged_objc_library_cc_infos.linking_context.linker_inputs.to_list():
	for lib in linker_input.libraries:
	path = None
	if lib.static_library != None:
	path = lib.static_library.path
	elif lib.pic_static_library != None:
	path = lib.pic_static_library.path
	if path in archives_from_objc_library and archives_from_objc_library[path]:
	libraries.append(lib)
	archives_from_objc_library[path] = None

	for archive_from_objc_library in archives_from_objc_library.values():
	if archive_from_objc_library:
	library_to_link = _static_library(
	actions = actions,
	cc_toolchain = cc_toolchain,
	feature_configuration = feature_configuration,
	static_library = archive_from_objc_library,
	)
	libraries.append(library_to_link)

	libraries.extend(objc_provider.cc_library.to_list())

	user_link_flags = _user_link_flags(
	cc_info = merged_objc_library_cc_infos,
	objc_provider = objc_provider,
	)

	direct_linker_inputs = []
	if len(user_link_flags) != 0 or len(libraries) != 0 or objc_provider.linkstamp:
	linker_input = cc_common.create_linker_input(
	owner = label,
	libraries = depset(libraries),
	user_link_flags = user_link_flags,
	linkstamps = objc_provider.linkstamp,
	)
	direct_linker_inputs.append(linker_input)

	return cc_common.create_linking_context(
	linker_inputs = depset(direct = direct_linker_inputs, order = "topological"),
	)

	def _static_library(
	*,
	actions,
	cc_toolchain,
	feature_configuration,
	static_library):
	""""Creates a LibraryToLink resource for CcLinkingContext.LinkerInputs.

	Args:
	actions: The actions provider from `ctx.actions`.
	cc_toolchain: CcToolchainInfo provider for current target.
	feature_configuration: Features configuration for current target.
	static_library: Static library artifact to link.
	"""
	alwayslink = False
	if static_library.extension == "lo":
	alwayslink = True
	return cc_common.create_library_to_link(
	actions = actions,
	feature_configuration = feature_configuration,
	cc_toolchain = cc_toolchain,
	static_library = static_library,
	alwayslink = alwayslink,
	)

	def _user_link_flags(*, cc_info, objc_provider):
	"""Builds objc_library CcInfo user link flags for frameworks and dylibs.

	Args:
	cc_info: Merged CcInfo provider from objc_library target deps.
	objc_provider: Current objc_library ObjC provider.
	Returns:
	List of user link flags for frameworks and dylibs.
	"""

	sdk_dylibs = objc_provider.sdk_dylib.to_list()
	sdk_frameworks = objc_provider.sdk_framework.to_list()

	all_user_link_flags = []
	all_user_link_flags.extend(objc_provider.linkopt.to_list())

	for linker_input in cc_info.linking_context.linker_inputs.to_list():
	all_user_link_flags.extend(linker_input.user_link_flags)

	for i, user_link_flag in enumerate(all_user_link_flags):
	if user_link_flag.startswith("-l"):
	sdk_dylibs.append("lib" + user_link_flag[2:])
	elif user_link_flag == "-framework":
	sdk_frameworks.append(all_user_link_flags[i + 1])

	sdk_user_link_flags = []
	for sdk_framework in depset(sdk_frameworks).to_list():
	sdk_user_link_flags.append(["-framework", sdk_framework])
	for sdk_dylib in depset(sdk_dylibs).to_list():
	if sdk_dylib.startswith("lib"):
	sdk_dylib = sdk_dylib[3:]
	sdk_user_link_flags.append(["-l" + sdk_dylib])

	return sdk_user_link_flags

	def _objc_library_impl(ctx):
	"""Implementation of objc_library."""

	_validate_attributes(label = ctx.label)

	cc_toolchain = cc_helper.find_cpp_toolchain(ctx)

	common_variables = compilation_support.build_common_variables(
	ctx = ctx,
	toolchain = cc_toolchain,
	use_pch = True,
	deps = ctx.attr.deps,
	runtime_deps = ctx.attr.runtime_deps,
	linkopts = ctx.attr.linkopts,
	alwayslink = ctx.attr.alwayslink,
	)
	files = []
	if common_variables.compilation_artifacts.archive != None:
	files.append(common_variables.compilation_artifacts.archive)

	(cc_compilation_context, compilation_outputs, output_groups) = compilation_support.register_compile_and_archive_actions(
	common_variables,
	)

	compilation_support.validate_attributes(common_variables)

	j2objc_providers = objc_internal.j2objc_providers_from_deps(ctx = ctx)

	objc_provider = common_variables.objc_provider
	feature_configuration = compilation_support.build_feature_configuration(common_variables, False, True)
	linking_context = _build_linking_context(
	actions = ctx.actions,
	archive = common_variables.compilation_artifacts.archive,
	cc_toolchain = cc_toolchain,
	deps = ctx.attr.deps,
	feature_configuration = feature_configuration,
	label = ctx.label,
	objc_provider = objc_provider,
	)

	return [
	DefaultInfo(
	files = depset(files),
	data_runfiles = ctx.runfiles(files = files),
	),
	CcInfo(
	compilation_context = cc_compilation_context,
	linking_context = linking_context,
	),
	objc_provider,
	j2objc_providers[0],
	j2objc_providers[1],
	objc_internal.instrumented_files_info(
	ctx = ctx,
	cc_toolchain = cc_toolchain,
	config = ctx.configuration,
	object_files = compilation_outputs.objects,
	),
	OutputGroupInfo(**output_groups),
	]

	objc_library = rule(
	implementation = _objc_library_impl,
	attrs = common_attrs.union(
	{
	"data": attr.label_list(allow_files = True),
	},
	common_attrs.CC_TOOLCHAIN_RULE,
	common_attrs.LICENSES,
	common_attrs.COMPILING_RULE,
	common_attrs.COMPILE_DEPENDENCY_RULE,
	common_attrs.INCLUDE_SCANNING_RULE,
	common_attrs.SDK_FRAMEWORK_DEPENDER_RULE,
	common_attrs.COPTS_RULE,
	common_attrs.XCRUN_RULE,
	),
	fragments = ["objc", "apple", "cpp"],
	cfg = apple_crosstool_transition,
	toolchains = cc_helper.use_cpp_toolchain(),
	incompatible_use_toolchain_transition = True,
	)