Rules Foreign CC

boost_build
cmake
cmake_tool
cmake_variant
configure_make
configure_make_variant
ForeignCcArtifactInfo
ForeignCcDepsInfo
make
make_tool
make_variant
meson
meson_with_requirements
native_tool_toolchain
ninja
ninja_tool
rules_foreign_cc_dependencies
ToolInfo

boost_build

boost_build(name, additional_inputs, additional_tools, alwayslink, bootstrap_options, build_data,
            copts, data, defines, deps, dynamic_deps, env, includes, lib_name, lib_source, linkopts,
            out_bin_dir, out_binaries, out_data_dirs, out_dll_dir, out_headers_only, out_include_dir,
            out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs, postfix_script,
            set_file_prefix_map, tool_prefix, tools_deps, user_options)

Rule for building Boost. Invokes bootstrap.sh and then b2 install.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
additional_inputs	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
additional_tools	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
alwayslink	Optional. if true, link all the object files from the static library, even if they are not used.	Boolean	optional	`False`
bootstrap_options	any additional flags to pass to bootstrap.sh	List of strings	optional	`[]`
build_data	Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
copts	Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.	List of strings	optional	`[]`
data	Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
defines	Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
deps	Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)	List of labels	optional	`[]`
dynamic_deps	Same as deps but for cc_shared_library.	List of labels	optional	`[]`
env	Environment variables to set during the build. `$(execpath)` macros may be used to point at files which are listed as `data`, `deps`, or `build_data`, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing `PATH` (e.g. `PATH`, `LD_LIBRARY_PATH`, `CPATH`) entries will be prepended to the existing variable.	Dictionary: String -> String	optional	`{}`
includes	Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
lib_name	Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.	String	optional	`""`
lib_source	Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.	Label	required
linkopts	Optional link options to be passed up to the dependencies of this library	List of strings	optional	`[]`
out_bin_dir	Optional name of the output subdirectory with the binary files, defaults to 'bin'.	String	optional	`"bin"`
out_binaries	Optional names of the resulting binaries.	List of strings	optional	`[]`
out_data_dirs	Optional names of additional directories created by the build that should be declared as bazel action outputs	List of strings	optional	`[]`
out_dll_dir	Optional name of the output subdirectory with the dll files, defaults to 'bin'.	String	optional	`"bin"`
out_headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	`False`
out_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	`"include"`
out_interface_libs	Optional names of the resulting interface libraries.	List of strings	optional	`[]`
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	`"lib"`
out_shared_libs	Optional names of the resulting shared libraries.	List of strings	optional	`[]`
out_static_libs	Optional names of the resulting static libraries. Note that if `out_headers_only`, `out_static_libs`, `out_shared_libs`, and `out_binaries` are not set, default `lib_name.a`/`lib_name.lib` static library is assumed	List of strings	optional	`[]`
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	`""`
set_file_prefix_map	Use -ffile-prefix-map with the intention to remove the sandbox path from debug symbols	Boolean	optional	`False`
tool_prefix	A prefix for build commands	String	optional	`""`
tools_deps	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
user_options	any additional flags to pass to b2	List of strings	optional	`[]`

cmake

cmake(name, additional_inputs, additional_tools, alwayslink, build_args, build_data, cache_entries,
      copts, data, defines, deps, dynamic_deps, env, generate_args, generate_crosstool_file, includes,
      install, install_args, lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs,
      out_dll_dir, out_headers_only, out_include_dir, out_interface_libs, out_lib_dir,
      out_shared_libs, out_static_libs, postfix_script, set_file_prefix_map, targets, tool_prefix,
      tools_deps, working_directory)

Rule for building external library with CMake.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
additional_inputs	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
additional_tools	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
alwayslink	Optional. if true, link all the object files from the static library, even if they are not used.	Boolean	optional	`False`
build_args	Arguments for the CMake build command	List of strings	optional	`[]`
build_data	Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
cache_entries	CMake cache entries to initialize (they will be passed with `-Dkey=value`) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first)	Dictionary: String -> String	optional	`{}`
copts	Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.	List of strings	optional	`[]`
data	Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
defines	Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
deps	Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)	List of labels	optional	`[]`
dynamic_deps	Same as deps but for cc_shared_library.	List of labels	optional	`[]`
env	Environment variables to set during the build. `$(execpath)` macros may be used to point at files which are listed as `data`, `deps`, or `build_data`, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing `PATH` (e.g. `PATH`, `LD_LIBRARY_PATH`, `CPATH`) entries will be prepended to the existing variable.	Dictionary: String -> String	optional	`{}`
generate_args	Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: `["-G Ninja", "--debug-output", "-DFOO=bar"]`. Note that unless a generator (`-G`) argument is provided, the default generators are Unix Makefiles for Linux and MacOS and Ninja for Windows.	List of strings	optional	`[]`
generate_crosstool_file	When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as `-Dkey=value` and environment variables). If `CMAKE_TOOLCHAIN_FILE` cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify `CMAKE_SYSTEM_NAME` in the cache_entries	Boolean	optional	`True`
includes	Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
install	If True, the `cmake --install` comand will be performed after a build	Boolean	optional	`True`
install_args	Arguments for the CMake install command	List of strings	optional	`[]`
lib_name	Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.	String	optional	`""`
lib_source	Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.	Label	required
linkopts	Optional link options to be passed up to the dependencies of this library	List of strings	optional	`[]`
out_bin_dir	Optional name of the output subdirectory with the binary files, defaults to 'bin'.	String	optional	`"bin"`
out_binaries	Optional names of the resulting binaries.	List of strings	optional	`[]`
out_data_dirs	Optional names of additional directories created by the build that should be declared as bazel action outputs	List of strings	optional	`[]`
out_dll_dir	Optional name of the output subdirectory with the dll files, defaults to 'bin'.	String	optional	`"bin"`
out_headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	`False`
out_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	`"include"`
out_interface_libs	Optional names of the resulting interface libraries.	List of strings	optional	`[]`
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	`"lib"`
out_shared_libs	Optional names of the resulting shared libraries.	List of strings	optional	`[]`
out_static_libs	Optional names of the resulting static libraries. Note that if `out_headers_only`, `out_static_libs`, `out_shared_libs`, and `out_binaries` are not set, default `lib_name.a`/`lib_name.lib` static library is assumed	List of strings	optional	`[]`
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	`""`
set_file_prefix_map	Use -ffile-prefix-map with the intention to remove the sandbox path from debug symbols	Boolean	optional	`False`
targets	A list of targets with in the foreign build system to produce. An empty string (`""`) will result in a call to the underlying build system with no explicit target set	List of strings	optional	`[]`
tool_prefix	A prefix for build commands	String	optional	`""`
tools_deps	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
working_directory	Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)	String	optional	`""`

configure_make

configure_make(name, additional_inputs, additional_tools, alwayslink, args, autoconf,
               autoconf_options, autogen, autogen_command, autogen_options, autoreconf,
               autoreconf_options, build_data, configure_command, configure_in_place,
               configure_options, configure_prefix, configure_xcompile, copts, data, defines, deps,
               dynamic_deps, env, executable_ldflags_vars, includes, install_prefix, lib_name,
               lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs, out_dll_dir,
               out_headers_only, out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs,
               out_static_libs, postfix_script, prefix_flag, set_file_prefix_map, shared_ldflags_vars,
               targets, tool_prefix, tools_deps)

Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
additional_inputs	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
additional_tools	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
alwayslink	Optional. if true, link all the object files from the static library, even if they are not used.	Boolean	optional	`False`
args	A list of arguments to pass to the call to `make`	List of strings	optional	`[]`
autoconf	Set to True if 'autoconf' should be invoked before 'configure', currently requires `configure_in_place` to be True.	Boolean	optional	`False`
autoconf_options	Any options to be put in the 'autoconf.sh' command line.	List of strings	optional	`[]`
autogen	Set to True if 'autogen.sh' should be invoked before 'configure', currently requires `configure_in_place` to be True.	Boolean	optional	`False`
autogen_command	The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that.	String	optional	`"autogen.sh"`
autogen_options	Any options to be put in the 'autogen.sh' command line.	List of strings	optional	`[]`
autoreconf	Set to True if 'autoreconf' should be invoked before 'configure.', currently requires `configure_in_place` to be True.	Boolean	optional	`False`
autoreconf_options	Any options to be put in the 'autoreconf.sh' command line.	List of strings	optional	`[]`
build_data	Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
configure_command	The name of the configuration script file, default: configure. The file must be in the root of the source directory.	String	optional	`"configure"`
configure_in_place	Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory.	Boolean	optional	`False`
configure_options	Any options to be put on the 'configure' command line.	List of strings	optional	`[]`
configure_prefix	A prefix for the call to the `configure_command`.	String	optional	`""`
configure_xcompile	If this is set and an xcompile scenario is detected, pass the necessary autotools flags.	Boolean	optional	`False`
copts	Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.	List of strings	optional	`[]`
data	Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
defines	Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
deps	Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)	List of labels	optional	`[]`
dynamic_deps	Same as deps but for cc_shared_library.	List of labels	optional	`[]`
env	Environment variables to set during the build. `$(execpath)` macros may be used to point at files which are listed as `data`, `deps`, or `build_data`, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing `PATH` (e.g. `PATH`, `LD_LIBRARY_PATH`, `CPATH`) entries will be prepended to the existing variable.	Dictionary: String -> String	optional	`{}`
executable_ldflags_vars	A list of variable names use as LDFLAGS for executables. These variables will be passed to the make command as make vars and overwrite what is defined in the Makefile.	List of strings	optional	`[]`
includes	Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
install_prefix	Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with the flag specified by prefix_flag.	String	optional	`""`
lib_name	Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.	String	optional	`""`
lib_source	Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.	Label	required
linkopts	Optional link options to be passed up to the dependencies of this library	List of strings	optional	`[]`
out_bin_dir	Optional name of the output subdirectory with the binary files, defaults to 'bin'.	String	optional	`"bin"`
out_binaries	Optional names of the resulting binaries.	List of strings	optional	`[]`
out_data_dirs	Optional names of additional directories created by the build that should be declared as bazel action outputs	List of strings	optional	`[]`
out_dll_dir	Optional name of the output subdirectory with the dll files, defaults to 'bin'.	String	optional	`"bin"`
out_headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	`False`
out_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	`"include"`
out_interface_libs	Optional names of the resulting interface libraries.	List of strings	optional	`[]`
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	`"lib"`
out_shared_libs	Optional names of the resulting shared libraries.	List of strings	optional	`[]`
out_static_libs	Optional names of the resulting static libraries. Note that if `out_headers_only`, `out_static_libs`, `out_shared_libs`, and `out_binaries` are not set, default `lib_name.a`/`lib_name.lib` static library is assumed	List of strings	optional	`[]`
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	`""`
prefix_flag	The flag to specify the install directory prefix with.	String	optional	`"--prefix="`
set_file_prefix_map	Use -ffile-prefix-map with the intention to remove the sandbox path from debug symbols	Boolean	optional	`False`
shared_ldflags_vars	A list of variable names use as LDFLAGS for shared libraries. These variables will be passed to the make command as make vars and overwrite what is defined in the Makefile.	List of strings	optional	`[]`
targets	A list of targets within the foreign build system to produce. An empty string (`""`) will result in a call to the underlying build system with no explicit target set	List of strings	optional	`["", "install"]`
tool_prefix	A prefix for build commands	String	optional	`""`
tools_deps	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`

make

make(name, additional_inputs, additional_tools, alwayslink, args, build_data, copts, data, defines,
     deps, dynamic_deps, env, executable_ldflags_vars, includes, install_prefix, lib_name, lib_source,
     linkopts, out_bin_dir, out_binaries, out_data_dirs, out_dll_dir, out_headers_only,
     out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs,
     postfix_script, set_file_prefix_map, shared_ldflags_vars, targets, tool_prefix, tools_deps)

Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with PREFIX="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. Not all Makefiles will work equally well here, and some may require patching.Your Makefile must either support passing the install prefix using the PREFIX flag, or it needs to have a different way to pass install prefix to it. An equivalent of make install MUST be specified as one of the targets.This is because all the paths with param names prefixed by out_* are expressed as relative to INSTALLDIR, not the source directory.That is, if you execute only make, but not make install, this rule will not be able to pick up any build outputs. Finally, your make install rule must dereference symlinks to ensure that the installed files don't end up being symlinks to files in the sandbox. For example, installation lines like cp $SOURCE $DEST must become cp -L $SOURCE $DEST, as the -L will ensure that symlinks are dereferenced.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
additional_inputs	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
additional_tools	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
alwayslink	Optional. if true, link all the object files from the static library, even if they are not used.	Boolean	optional	`False`
args	A list of arguments to pass to the call to `make`	List of strings	optional	`[]`
build_data	Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
copts	Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.	List of strings	optional	`[]`
data	Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
defines	Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
deps	Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)	List of labels	optional	`[]`
dynamic_deps	Same as deps but for cc_shared_library.	List of labels	optional	`[]`
env	Environment variables to set during the build. `$(execpath)` macros may be used to point at files which are listed as `data`, `deps`, or `build_data`, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing `PATH` (e.g. `PATH`, `LD_LIBRARY_PATH`, `CPATH`) entries will be prepended to the existing variable.	Dictionary: String -> String	optional	`{}`
executable_ldflags_vars	A string list of variable names use as LDFLAGS for executables. These variables will be passed to the make command as make vars and overwrite what is defined in the Makefile.	List of strings	optional	`[]`
includes	Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
install_prefix	Install prefix, i.e. relative path to where to install the result of the build. Passed as an arg to "make" as PREFIX=<install_prefix>.	String	optional	`"$$INSTALLDIR$$"`
lib_name	Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.	String	optional	`""`
lib_source	Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.	Label	required
linkopts	Optional link options to be passed up to the dependencies of this library	List of strings	optional	`[]`
out_bin_dir	Optional name of the output subdirectory with the binary files, defaults to 'bin'.	String	optional	`"bin"`
out_binaries	Optional names of the resulting binaries.	List of strings	optional	`[]`
out_data_dirs	Optional names of additional directories created by the build that should be declared as bazel action outputs	List of strings	optional	`[]`
out_dll_dir	Optional name of the output subdirectory with the dll files, defaults to 'bin'.	String	optional	`"bin"`
out_headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	`False`
out_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	`"include"`
out_interface_libs	Optional names of the resulting interface libraries.	List of strings	optional	`[]`
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	`"lib"`
out_shared_libs	Optional names of the resulting shared libraries.	List of strings	optional	`[]`
out_static_libs	Optional names of the resulting static libraries. Note that if `out_headers_only`, `out_static_libs`, `out_shared_libs`, and `out_binaries` are not set, default `lib_name.a`/`lib_name.lib` static library is assumed	List of strings	optional	`[]`
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	`""`
set_file_prefix_map	Use -ffile-prefix-map with the intention to remove the sandbox path from debug symbols	Boolean	optional	`False`
shared_ldflags_vars	A string list of variable names use as LDFLAGS for shared libraries. These variables will be passed to the make command as make vars and overwrite what is defined in the Makefile.	List of strings	optional	`[]`
targets	A list of targets within the foreign build system to produce. An empty string (`""`) will result in a call to the underlying build system with no explicit target set. However, in order to extract build outputs, you must execute at least an equivalent of make install, and have your make file copy the build outputs into the directory specified by `install_prefix`.	List of strings	optional	`["", "install"]`
tool_prefix	A prefix for build commands	String	optional	`""`
tools_deps	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`

make_tool

make_tool(name, configure_xcompile, env, srcs)

Rule for building Make. Invokes configure script and make install.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
configure_xcompile	If this is set and an xcompile scenario is detected, pass the necessary autotools flags. (Only applies if autotools is used)	Boolean	optional	`False`
env	Environment variables to set during the build. This attribute is subject to make variable substitution.	Dictionary: String -> String	optional	`{}`
srcs	The target containing the build tool's sources	Label	required

meson

meson(name, additional_inputs, additional_tools, alwayslink, build_args, build_data, copts, data,
      defines, deps, dynamic_deps, env, includes, install, install_args, lib_name, lib_source,
      linkopts, options, out_bin_dir, out_binaries, out_data_dirs, out_dll_dir, out_headers_only,
      out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs,
      postfix_script, set_file_prefix_map, setup_args, targets, tool_prefix, tools_deps)

Rule for building external libraries with Meson.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
additional_inputs	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
additional_tools	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
alwayslink	Optional. if true, link all the object files from the static library, even if they are not used.	Boolean	optional	`False`
build_args	Arguments for the Meson build command	List of strings	optional	`[]`
build_data	Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
copts	Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.	List of strings	optional	`[]`
data	Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
defines	Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
deps	Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)	List of labels	optional	`[]`
dynamic_deps	Same as deps but for cc_shared_library.	List of labels	optional	`[]`
env	Environment variables to set during the build. `$(execpath)` macros may be used to point at files which are listed as `data`, `deps`, or `build_data`, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing `PATH` (e.g. `PATH`, `LD_LIBRARY_PATH`, `CPATH`) entries will be prepended to the existing variable.	Dictionary: String -> String	optional	`{}`
includes	Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
install	If True, the `meson install` comand will be performed after a build	Boolean	optional	`True`
install_args	Arguments for the meson install command	List of strings	optional	`[]`
lib_name	Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.	String	optional	`""`
lib_source	Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.	Label	required
linkopts	Optional link options to be passed up to the dependencies of this library	List of strings	optional	`[]`
options	Meson option entries to initialize (they will be passed with `-Dkey=value`)	Dictionary: String -> String	optional	`{}`
out_bin_dir	Optional name of the output subdirectory with the binary files, defaults to 'bin'.	String	optional	`"bin"`
out_binaries	Optional names of the resulting binaries.	List of strings	optional	`[]`
out_data_dirs	Optional names of additional directories created by the build that should be declared as bazel action outputs	List of strings	optional	`[]`
out_dll_dir	Optional name of the output subdirectory with the dll files, defaults to 'bin'.	String	optional	`"bin"`
out_headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	`False`
out_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	`"include"`
out_interface_libs	Optional names of the resulting interface libraries.	List of strings	optional	`[]`
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	`"lib"`
out_shared_libs	Optional names of the resulting shared libraries.	List of strings	optional	`[]`
out_static_libs	Optional names of the resulting static libraries. Note that if `out_headers_only`, `out_static_libs`, `out_shared_libs`, and `out_binaries` are not set, default `lib_name.a`/`lib_name.lib` static library is assumed	List of strings	optional	`[]`
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	`""`
set_file_prefix_map	Use -ffile-prefix-map with the intention to remove the sandbox path from debug symbols	Boolean	optional	`False`
setup_args	Arguments for the Meson setup command	List of strings	optional	`[]`
targets	A list of targets with in the foreign build system to produce. An empty string (`""`) will result in a call to the underlying build system with no explicit target set	List of strings	optional	`[]`
tool_prefix	A prefix for build commands	String	optional	`""`
tools_deps	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`

native_tool_toolchain

native_tool_toolchain(name, env, path, target, tools)

Rule for defining the toolchain data of the native tools (cmake, ninja), to be used by rules_foreign_cc with toolchain types @rules_foreign_cc//toolchains:cmake_toolchain and @rules_foreign_cc//toolchains:ninja_toolchain.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
env	Environment variables to be set when using this tool e.g. M4	Dictionary: String -> String	optional	`{}`
path	Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example `//examples:built_cmake_toolchain`)	String	optional	`""`
target	If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.	Label	optional	`None`
tools	Additional tools.If `target` expands to several files, `tools` can be used to isolate a specific file that can be used in `env`.	List of labels	optional	`[]`

ninja

ninja(name, additional_inputs, additional_tools, alwayslink, args, build_data, copts, data, defines,
      deps, directory, dynamic_deps, env, includes, lib_name, lib_source, linkopts, out_bin_dir,
      out_binaries, out_data_dirs, out_dll_dir, out_headers_only, out_include_dir, out_interface_libs,
      out_lib_dir, out_shared_libs, out_static_libs, postfix_script, set_file_prefix_map, targets,
      tool_prefix, tools_deps)

Rule for building external libraries with Ninja.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
additional_inputs	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
additional_tools	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`
alwayslink	Optional. if true, link all the object files from the static library, even if they are not used.	Boolean	optional	`False`
args	A list of arguments to pass to the call to `ninja`	List of strings	optional	`[]`
build_data	Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
copts	Optional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.	List of strings	optional	`[]`
data	Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.	List of labels	optional	`[]`
defines	Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
deps	Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)	List of labels	optional	`[]`
directory	A directory to pass as the `-C` argument. The rule will always use the root directory of the `lib_sources` attribute if this attribute is not set	String	optional	`""`
dynamic_deps	Same as deps but for cc_shared_library.	List of labels	optional	`[]`
env	Environment variables to set during the build. `$(execpath)` macros may be used to point at files which are listed as `data`, `deps`, or `build_data`, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing `PATH` (e.g. `PATH`, `LD_LIBRARY_PATH`, `CPATH`) entries will be prepended to the existing variable.	Dictionary: String -> String	optional	`{}`
includes	Optional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.	List of strings	optional	`[]`
lib_name	Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.	String	optional	`""`
lib_source	Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.	Label	required
linkopts	Optional link options to be passed up to the dependencies of this library	List of strings	optional	`[]`
out_bin_dir	Optional name of the output subdirectory with the binary files, defaults to 'bin'.	String	optional	`"bin"`
out_binaries	Optional names of the resulting binaries.	List of strings	optional	`[]`
out_data_dirs	Optional names of additional directories created by the build that should be declared as bazel action outputs	List of strings	optional	`[]`
out_dll_dir	Optional name of the output subdirectory with the dll files, defaults to 'bin'.	String	optional	`"bin"`
out_headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	`False`
out_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	`"include"`
out_interface_libs	Optional names of the resulting interface libraries.	List of strings	optional	`[]`
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	`"lib"`
out_shared_libs	Optional names of the resulting shared libraries.	List of strings	optional	`[]`
out_static_libs	Optional names of the resulting static libraries. Note that if `out_headers_only`, `out_static_libs`, `out_shared_libs`, and `out_binaries` are not set, default `lib_name.a`/`lib_name.lib` static library is assumed	List of strings	optional	`[]`
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	`""`
set_file_prefix_map	Use -ffile-prefix-map with the intention to remove the sandbox path from debug symbols	Boolean	optional	`False`
targets	A list of targets with in the foreign build system to produce. An empty string (`""`) will result in a call to the underlying build system with no explicit target set	List of strings	optional	`[]`
tool_prefix	A prefix for build commands	String	optional	`""`
tools_deps	deprecated: Please use the `build_data` attribute.	List of labels	optional	`[]`

ninja_tool

ninja_tool(name, configure_xcompile, env, srcs)

Rule for building Ninja. Invokes configure script.

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
configure_xcompile	If this is set and an xcompile scenario is detected, pass the necessary autotools flags. (Only applies if autotools is used)	Boolean	optional	`False`
env	Environment variables to set during the build. This attribute is subject to make variable substitution.	Dictionary: String -> String	optional	`{}`
srcs	The target containing the build tool's sources	Label	required

ForeignCcArtifactInfo

ForeignCcArtifactInfo(bin_dir_name, dll_dir_name, gen_dir, include_dir_name, lib_dir_name)

Groups information about the external library install directory, and relative bin, include and lib directories.

Serves to pass transitive information about externally built artifacts up the dependency chain.

Can not be used as a top-level provider. Instances of ForeignCcArtifactInfo are encapsulated in a depset ForeignCcDepsInfo::artifacts.

FIELDS

Name	Description
bin_dir_name	Bin directory, relative to install directory
dll_dir_name	DLL directory, relative to install directory
gen_dir	Install directory
include_dir_name	Include directory, relative to install directory
lib_dir_name	Lib directory, relative to install directory

ForeignCcDepsInfo

ForeignCcDepsInfo(artifacts)

Provider to pass transitive information about external libraries.

FIELDS

Name	Description
artifacts	Depset of ForeignCcArtifactInfo

ToolInfo

ToolInfo(env, path, target)

Information about the native tool

FIELDS

Name	Description
env	Environment variables to set when using this tool e.g. M4
path	Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example `//examples:built_cmake_toolchain`)
target	If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.

cmake_tool

cmake_tool(name, srcs, kwargs)

Macro for building CMake

PARAMETERS

Name	Description	Default Value
name	A unique name for this target	none
srcs	The target containing the build tool's sources	none
kwargs	Remaining args	none

cmake_variant

cmake_variant(name, toolchain, kwargs)

Wrapper macro around the cmake() rule to force usage of the given make variant toolchain.

PARAMETERS

Name	Description	Default Value
name	The target name	none
toolchain	The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain	none
kwargs	Remaining keyword arguments	none

configure_make_variant

configure_make_variant(name, toolchain, kwargs)

Wrapper macro around the configure_make() rule to force usage of the given make variant toolchain.

PARAMETERS

Name	Description	Default Value
name	The target name	none
toolchain	The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain	none
kwargs	Remaining keyword arguments	none

make_variant

make_variant(name, toolchain, kwargs)

Wrapper macro around the make() rule to force usage of the given make variant toolchain.

PARAMETERS

Name	Description	Default Value
name	The target name	none
toolchain	The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain	none
kwargs	Remaining keyword arguments	none

meson_with_requirements

meson_with_requirements(name, requirements, kwargs)

Wrapper macro around Meson rule to add Python libraries required by the Meson build.

PARAMETERS

Name	Description	Default Value
name	The target name	none
requirements	List of Python "requirements", see https://github.com/bazelbuild/rules_python/tree/00545742ad2450863aeb82353d4275a1e5ed3f24#using-third_party-packages-as-dependencies	none
kwargs	Remaining keyword arguments	none

rules_foreign_cc_dependencies

rules_foreign_cc_dependencies(native_tools_toolchains, register_default_tools, cmake_version,
                              make_version, ninja_version, meson_version, pkgconfig_version,
                              register_preinstalled_tools, register_built_tools, register_toolchains,
                              register_built_pkgconfig_toolchain)

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.).

PARAMETERS

Name	Description	Default Value
native_tools_toolchains	pass the toolchains for toolchain types '@rules_foreign_cc//toolchains:cmake_toolchain' and '@rules_foreign_cc//toolchains: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.	`True`
cmake_version	The target version of the cmake toolchain if `register_default_tools` or `register_built_tools` is set to `True`.	`"3.23.2"`
make_version	The target version of the default make toolchain if `register_built_tools` is set to `True`.	`"4.4.1"`
ninja_version	The target version of the ninja toolchain if `register_default_tools` or `register_built_tools` is set to `True`.	`"1.12.1"`
meson_version	The target version of the meson toolchain if `register_built_tools` is set to `True`.	`"1.5.1"`
pkgconfig_version	The target version of the pkg_config toolchain if `register_built_tools` is set to `True`.	`"0.29.2"`
register_preinstalled_tools	If true, toolchains will be registered for the native built tools installed on the exec host	`True`
register_built_tools	If true, toolchains that build the tools from source are registered	`True`
register_toolchains	If true, registers the toolchains via native.register_toolchains. Used by bzlmod	`True`
register_built_pkgconfig_toolchain	If true, the built pkgconfig toolchain will be registered. On Windows it may be preferrable to set this to False, as this requires the --enable_runfiles bazel option. Also note that building pkgconfig from source under bazel results in paths that are more than 256 characters long, which will not work on Windows unless the following options are added to the .bazelrc and symlinks are enabled in Windows. startup --windows_enable_symlinks -> This is required to enable symlinking to avoid long runfile paths build --action_env=MSYS=winsymlinks:nativestrict -> This is required to enable symlinking to avoid long runfile paths startup --output_user_root=C:/b -> This is required to keep paths as short as possible	`True`

Rules ForeignCc