rules_foreign_cc/workspace_definitions.bzl

53 lines
2.6 KiB
Python

"""A module for defining WORKSPACE dependencies required for rules_foreign_cc"""
load("//for_workspace:repositories.bzl", "repositories")
load(
"//tools/build_defs/shell_toolchain/toolchains:ws_defs.bzl",
shell_toolchain_workspace_initalization = "workspace_part",
)
# buildifier: disable=unnamed-macro
def rules_foreign_cc_dependencies(
native_tools_toolchains = [],
register_default_tools = True,
additional_shell_toolchain_mappings = [],
additional_shell_toolchain_package = None):
"""Call this function from the WORKSPACE file to initialize rules_foreign_cc \
dependencies and let neccesary code generation happen \
(Code generation is needed to support different variants of the C++ Starlark API.).
Args:
native_tools_toolchains: pass the toolchains for toolchain types
'@rules_foreign_cc//tools/build_defs:cmake_toolchain' and
'@rules_foreign_cc//tools/build_defs:ninja_toolchain' with the needed platform constraints.
If you do not pass anything, registered default toolchains will be selected (see below).
register_default_tools: If True, the cmake and ninja toolchains, calling corresponding
preinstalled binaries by name (cmake, ninja) will be registered after
'native_tools_toolchains' without any platform constraints. The default is True.
additional_shell_toolchain_mappings: Mappings of the shell toolchain functions to
execution and target platforms constraints. Similar to what defined in
@rules_foreign_cc//tools/build_defs/shell_toolchain/toolchains:toolchain_mappings.bzl
in the TOOLCHAIN_MAPPINGS list. Please refer to example in @rules_foreign_cc//toolchain_examples.
additional_shell_toolchain_package: A package under which additional toolchains, referencing
the generated data for the passed additonal_shell_toolchain_mappings, will be defined.
This value is needed since register_toolchains() is called for these toolchains.
Please refer to example in @rules_foreign_cc//toolchain_examples.
"""
repositories()
shell_toolchain_workspace_initalization(
additional_shell_toolchain_mappings,
additional_shell_toolchain_package,
)
native.register_toolchains(*native_tools_toolchains)
if register_default_tools:
native.register_toolchains(
"@rules_foreign_cc//tools/build_defs:preinstalled_cmake_toolchain",
"@rules_foreign_cc//tools/build_defs:preinstalled_ninja_toolchain",
"@rules_foreign_cc//tools/build_defs:preinstalled_make_toolchain",
)