A module exporting symbols for Stardoc generation.

Rules

boost_build

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

name

A unique name for this target.

additional_inputs

deprecated: Please use the build_data attribute.

additional_tools

deprecated: Please use the build_data attribute.

Optional. if true, link all the object files from the static library, even if they are not used.

bootstrap_options

any additional flags to pass to bootstrap.sh

build_data

Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.

data

Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.

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.

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 buidl system will be looking for and paths to which are provided by the calling rule)

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. No other macros are supported.

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.

lib_source

Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.

linkopts

Optional link options to be passed up to the dependencies of this library

out_bin_dir

Optional name of the output subdirectory with the binary files, defaults to 'bin'.

out_binaries

Optional names of the resulting binaries.

out_data_dirs

Optional names of additional directories created by the build that should be declared as bazel action outputs

out_headers_only

Flag variable to indicate that the library produces only headers

out_include_dir

Optional name of the output subdirectory with the header files, defaults to 'include'.

out_interface_libs

Optional names of the resulting interface libraries.

out_lib_dir

Optional name of the output subdirectory with the library files, defaults to 'lib'.

out_shared_libs

Optional names of the resulting shared libraries.

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

postfix_script

Optional part of the shell script to be added after the make commands

tool_prefix

A prefix for build commands

tools_deps

deprecated: Please use the build_data attribute.

user_options

any additional flags to pass to b2


cmake

Rule for building external library with CMake.

name

A unique name for this target.

additional_inputs

deprecated: Please use the build_data attribute.

additional_tools

deprecated: Please use the build_data attribute.

Optional. if true, link all the object files from the static library, even if they are not used.

build_args

Arguments for the CMake build command

build_data

Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.

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)

data

Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.

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.

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 buidl system will be looking for and paths to which are provided by the calling rule)

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. No other macros are supported.

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.

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

install

If True, the cmake --install comand will be performed after a build

install_args

Arguments for the CMake install command

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.

lib_source

Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.

linkopts

Optional link options to be passed up to the dependencies of this library

out_bin_dir

Optional name of the output subdirectory with the binary files, defaults to 'bin'.

out_binaries

Optional names of the resulting binaries.

out_data_dirs

Optional names of additional directories created by the build that should be declared as bazel action outputs

out_headers_only

Flag variable to indicate that the library produces only headers

out_include_dir

Optional name of the output subdirectory with the header files, defaults to 'include'.

out_interface_libs

Optional names of the resulting interface libraries.

out_lib_dir

Optional name of the output subdirectory with the library files, defaults to 'lib'.

out_shared_libs

Optional names of the resulting shared libraries.

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

postfix_script

Optional part of the shell script to be added after the make commands

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

tool_prefix

A prefix for build commands

tools_deps

deprecated: Please use the build_data attribute.

working_directory

Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)


cmake_tool

Rule for building CMake. Invokes bootstrap script and make install.

name

A unique name for this target.

srcs

The target containing the build tool's sources


configure_make

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.

name

A unique name for this target.

additional_inputs

deprecated: Please use the build_data attribute.

additional_tools

deprecated: Please use the build_data attribute.

Optional. if true, link all the object files from the static library, even if they are not used.

args

A list of arguments to pass to the call to make

autoconf

Set to True if 'autoconf' should be invoked before 'configure', currently requires configure_in_place to be True.

autoconf_options

Any options to be put in the 'autoconf.sh' command line.

autogen

Set to True if 'autogen.sh' should be invoked before 'configure', currently requires configure_in_place to be True.

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.

autogen_options

Any options to be put in the 'autogen.sh' command line.

autoreconf

Set to True if 'autoreconf' should be invoked before 'configure.', currently requires configure_in_place to be True.

autoreconf_options

Any options to be put in the 'autoreconf.sh' command line.

build_data

Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.

configure_command

The name of the configuration script file, default: configure. The file must be in the root of the source directory.

configure_in_place

Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory.

configure_options

Any options to be put on the 'configure' command line.

configure_prefix

A prefix for the call to the configure_command.

data

Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.

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.

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 buidl system will be looking for and paths to which are provided by the calling rule)

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. No other macros are supported.

install_prefix

Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag.

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.

lib_source

Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.

linkopts

Optional link options to be passed up to the dependencies of this library

out_bin_dir

Optional name of the output subdirectory with the binary files, defaults to 'bin'.

out_binaries

Optional names of the resulting binaries.

out_data_dirs

Optional names of additional directories created by the build that should be declared as bazel action outputs

out_headers_only

Flag variable to indicate that the library produces only headers

out_include_dir

Optional name of the output subdirectory with the header files, defaults to 'include'.

out_interface_libs

Optional names of the resulting interface libraries.

out_lib_dir

Optional name of the output subdirectory with the library files, defaults to 'lib'.

out_shared_libs

Optional names of the resulting shared libraries.

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

postfix_script

Optional part of the shell script to be added after the make commands

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

tool_prefix

A prefix for build commands

tools_deps

deprecated: Please use the build_data attribute.


make

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.

name

A unique name for this target.

additional_inputs

deprecated: Please use the build_data attribute.

additional_tools

deprecated: Please use the build_data attribute.

Optional. if true, link all the object files from the static library, even if they are not used.

args

A list of arguments to pass to the call to make

build_data

Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.

data

Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.

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.

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 buidl system will be looking for and paths to which are provided by the calling rule)

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. No other macros are supported.

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.

lib_source

Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.

linkopts

Optional link options to be passed up to the dependencies of this library

out_bin_dir

Optional name of the output subdirectory with the binary files, defaults to 'bin'.

out_binaries

Optional names of the resulting binaries.

out_data_dirs

Optional names of additional directories created by the build that should be declared as bazel action outputs

out_headers_only

Flag variable to indicate that the library produces only headers

out_include_dir

Optional name of the output subdirectory with the header files, defaults to 'include'.

out_interface_libs

Optional names of the resulting interface libraries.

out_lib_dir

Optional name of the output subdirectory with the library files, defaults to 'lib'.

out_shared_libs

Optional names of the resulting shared libraries.

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

postfix_script

Optional part of the shell script to be added after the make commands

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

tool_prefix

A prefix for build commands

tools_deps

deprecated: Please use the build_data attribute.


make_tool

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

name

A unique name for this target.

srcs

The target containing the build tool's sources


native_tool_toolchain

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.

name

A unique name for this target.

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.


ninja

Rule for building external libraries with Ninja.

name

A unique name for this target.

additional_inputs

deprecated: Please use the build_data attribute.

additional_tools

deprecated: Please use the build_data attribute.

Optional. if true, link all the object files from the static library, even if they are not used.

args

A list of arguments to pass to the call to ninja

build_data

Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.

data

Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.

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.

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 buidl system will be looking for and paths to which are provided by the calling rule)

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

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. No other macros are supported.

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.

lib_source

Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.

linkopts

Optional link options to be passed up to the dependencies of this library

out_bin_dir

Optional name of the output subdirectory with the binary files, defaults to 'bin'.

out_binaries

Optional names of the resulting binaries.

out_data_dirs

Optional names of additional directories created by the build that should be declared as bazel action outputs

out_headers_only

Flag variable to indicate that the library produces only headers

out_include_dir

Optional name of the output subdirectory with the header files, defaults to 'include'.

out_interface_libs

Optional names of the resulting interface libraries.

out_lib_dir

Optional name of the output subdirectory with the library files, defaults to 'lib'.

out_shared_libs

Optional names of the resulting shared libraries.

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

postfix_script

Optional part of the shell script to be added after the make commands

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

tool_prefix

A prefix for build commands

tools_deps

deprecated: Please use the build_data attribute.


ninja_tool

Rule for building Ninja. Invokes configure script.

name

A unique name for this target.

srcs

The target containing the build tool's sources


Macros and Functions

rules_foreign_cc_dependencies

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

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.

cmake_version

The target version of the cmake toolchain if register_default_tools or register_built_tools is set to True.

make_version

The target version of the default make toolchain if register_built_tools is set to True.

ninja_version

The target version of the ninja toolchain if register_default_tools or register_built_tools is set to True.

register_preinstalled_tools

If true, toolchains will be registered for the native built tools installed on the exec host

register_built_tools

If true, toolchains that build the tools from source are registered


Providers

ForeignCcArtifactInfo

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.

ForeignCcDepsInfo

Provider to pass transitive information about external libraries.

ToolInfo

Information about the native tool