<buttonid="sidebar-toggle"class="icon-button"type="button"title="Toggle Table of Contents"aria-label="Toggle Table of Contents"aria-controls="sidebar">
<inputtype="search"id="searchbar"name="searchbar"placeholder="Search this book ..."aria-controls="searchresults-outer"aria-describedby="searchresults-header">
<li>Build libraries/binaries with CMake from sources using cmake rule</li>
<li>Use cmake targets in <ahref="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library">cc_library</a>, <ahref="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_binary">cc_binary</a> targets as dependency</li>
<li>Bazel <ahref="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_toolchain">cc_toolchain</a> parameters are used inside cmake build</li>
<li>See full list of cmake arguments below 'example'</li>
<li>Works on Ubuntu, Mac OS and Windows (<em>see special notes below in Windows section</em>) operating systems</li>
</ul>
<p><strong>Example:</strong>
(Please see full examples in ./examples)</p>
<p>The example for <strong>Windows</strong> is below, in the section 'Usage on Windows'.</p>
<ul>
<li>In <code>WORKSPACE.bazel</code>, we use a <code>http_archive</code> to download tarballs with the libraries we use.</li>
<li>In <code>BUILD.bazel</code>, we instantiate a <code>cmake</code> rule which behaves similarly to a <ahref="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library">cc_library</a>, which can then be used in a C++ rule (<ahref="https://docs.bazel.build/versions/master/be/c-cpp.html#cc_binary">cc_binary</a> in this case).</li>
<tr><tdalign="left"><aid="cmake-name"></a>name</td><tdalign="left">A unique name for this target.</td><tdalign="left"><ahref="https://bazel.build/docs/build-ref.html#name">Name</a></td><tdalign="left">required</td><tdalign="left"></td></tr>
<tr><tdalign="left"><aid="cmake-additional_inputs"></a>additional_inputs</td><tdalign="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><tdalign="left"><ahref="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-additional_tools"></a>additional_tools</td><tdalign="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><tdalign="left"><ahref="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-alwayslink"></a>alwayslink</td><tdalign="left">Optional. if true, link all the object files from the static library, even if they are not used.</td><tdalign="left">Boolean</td><tdalign="left">optional</td><tdalign="left">False</td></tr>
<tr><tdalign="left"><aid="cmake-build_args"></a>build_args</td><tdalign="left">Arguments for the CMake build command</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-build_data"></a>build_data</td><tdalign="left">Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.</td><tdalign="left"><ahref="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-cache_entries"></a>cache_entries</td><tdalign="left">CMake cache entries to initialize (they will be passed with <code>-Dkey=value</code>) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first)</td><tdalign="left"><ahref="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><tdalign="left">optional</td><tdalign="left">{}</td></tr>
<tr><tdalign="left"><aid="cmake-copts"></a>copts</td><tdalign="left">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.</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-data"></a>data</td><tdalign="left">Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.</td><tdalign="left"><ahref="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-defines"></a>defines</td><tdalign="left">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.</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-deps"></a>deps</td><tdalign="left">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)</td><tdalign="left"><ahref="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-env"></a>env</td><tdalign="left">Environment variables to set during the build. <code>$(execpath)</code> macros may be used to point at files which are listed as <code>data</code>, <code>deps</code>, or <code>build_data</code>, 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.Variables containing <code>PATH</code> (e.g. <code>PATH</code>, <code>LD_LIBRARY_PATH</code>, <code>CPATH</code>) entries will be prepended to the existing variable.</td><tdalign="left"><ahref="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a></td><tdalign="left">optional</td><tdalign="left">{}</td></tr>
<tr><tdalign="left"><aid="cmake-generate_args"></a>generate_args</td><tdalign="left">Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: <code>["-G Ninja", "--debug-output", "-DFOO=bar"]</code>. Note that unless a generator (<code>-G</code>) argument is provided, the default generators are <ahref="https://cmake.org/cmake/help/latest/generator/Unix%20Makefiles.html">Unix Makefiles</a> for Linux and MacOS and <ahref="https://cmake.org/cmake/help/latest/generator/Ninja.html">Ninja</a> for Windows.</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-generate_crosstool_file"></a>generate_crosstool_file</td><tdalign="left">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 <code>-Dkey=value</code> and environment variables). If <code>CMAKE_TOOLCHAIN_FILE</code> cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify <code>CMAKE_SYSTEM_NAME</code> in the cache_entries</td><tdalign="left">Boolean</td><tdalign="left">optional</td><tdalign="left">True</td></tr>
<tr><tdalign="left"><aid="cmake-install"></a>install</td><tdalign="left">If True, the <code>cmake --install</code> comand will be performed after a build</td><tdalign="left">Boolean</td><tdalign="left">optional</td><tdalign="left">True</td></tr>
<tr><tdalign="left"><aid="cmake-install_args"></a>install_args</td><tdalign="left">Arguments for the CMake install command</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-lib_name"></a>lib_name</td><tdalign="left">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.</td><tdalign="left">String</td><tdalign="left">optional</td><tdalign="left">""</td></tr>
<tr><tdalign="left"><aid="cmake-lib_source"></a>lib_source</td><tdalign="left">Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.</td><tdalign="left"><ahref="https://bazel.build/docs/build-ref.html#labels">Label</a></td><tdalign="left">required</td><tdalign="left"></td></tr>
<tr><tdalign="left"><aid="cmake-linkopts"></a>linkopts</td><tdalign="left">Optional link options to be passed up to the dependencies of this library</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-out_bin_dir"></a>out_bin_dir</td><tdalign="left">Optional name of the output subdirectory with the binary files, defaults to 'bin'.</td><tdalign="left">String</td><tdalign="left">optional</td><tdalign="left">"bin"</td></tr>
<tr><tdalign="left"><aid="cmake-out_binaries"></a>out_binaries</td><tdalign="left">Optional names of the resulting binaries.</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-out_data_dirs"></a>out_data_dirs</td><tdalign="left">Optional names of additional directories created by the build that should be declared as bazel action outputs</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-out_headers_only"></a>out_headers_only</td><tdalign="left">Flag variable to indicate that the library produces only headers</td><tdalign="left">Boolean</td><tdalign="left">optional</td><tdalign="left">False</td></tr>
<tr><tdalign="left"><aid="cmake-out_include_dir"></a>out_include_dir</td><tdalign="left">Optional name of the output subdirectory with the header files, defaults to 'include'.</td><tdalign="left">String</td><tdalign="left">optional</td><tdalign="left">"include"</td></tr>
<tr><tdalign="left"><aid="cmake-out_interface_libs"></a>out_interface_libs</td><tdalign="left">Optional names of the resulting interface libraries.</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-out_lib_dir"></a>out_lib_dir</td><tdalign="left">Optional name of the output subdirectory with the library files, defaults to 'lib'.</td><tdalign="left">String</td><tdalign="left">optional</td><tdalign="left">"lib"</td></tr>
<tr><tdalign="left"><aid="cmake-out_shared_libs"></a>out_shared_libs</td><tdalign="left">Optional names of the resulting shared libraries.</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-out_static_libs"></a>out_static_libs</td><tdalign="left">Optional names of the resulting static libraries. Note that if <code>out_headers_only</code>, <code>out_static_libs</code>, <code>out_shared_libs</code>, and <code>out_binaries</code> are not set, default <code>lib_name.a</code>/<code>lib_name.lib</code> static library is assumed</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-postfix_script"></a>postfix_script</td><tdalign="left">Optional part of the shell script to be added after the make commands</td><tdalign="left">String</td><tdalign="left">optional</td><tdalign="left">""</td></tr>
<tr><tdalign="left"><aid="cmake-targets"></a>targets</td><tdalign="left">A list of targets with in the foreign build system to produce. An empty string (<code>""</code>) will result in a call to the underlying build system with no explicit target set</td><tdalign="left">List of strings</td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-tool_prefix"></a>tool_prefix</td><tdalign="left">A prefix for build commands</td><tdalign="left">String</td><tdalign="left">optional</td><tdalign="left">""</td></tr>
<tr><tdalign="left"><aid="cmake-tools_deps"></a>tools_deps</td><tdalign="left"><strong>deprecated</strong>: Please use the <code>build_data</code> attribute.</td><tdalign="left"><ahref="https://bazel.build/docs/build-ref.html#labels">List of labels</a></td><tdalign="left">optional</td><tdalign="left">[]</td></tr>
<tr><tdalign="left"><aid="cmake-working_directory"></a>working_directory</td><tdalign="left">Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.)</td><tdalign="left">String</td><tdalign="left">optional</td><tdalign="left">""</td></tr>
<tr><tdalign="left"><aid="cmake_variant-toolchain"></a>toolchain</td><tdalign="left">The desired make variant toolchain to use, e.g. @rules_foreign_cc//toolchains:preinstalled_nmake_toolchain</td><tdalign="left">none</td></tr>
