CMake

CMake
Developer(s)	Andy Cedilnik, Bill Hoffman, Brad King, Ken Martin, Alexander Neundorf
Initial release	2000; 24 years ago
Stable release	3.31.2 / 5 December 2024
Preview release	3.31.0-rc3 / 29 October 2024
Repository	gitlab.kitware.com/cmake/cmake ;
Written in	C, C++
Operating system	Cross-platform
Type	Software development tools
License	BSD-3-Clause
Website	cmake.org

CMake is a free, cross-platform, software development tool for building applications via compiler-independent instructions. It also can automate testing, packaging and installation. It runs on a variety of platforms and supports many programming languages.^[4]

As a meta-build tool, CMake configures native build tools which in turn build the codebase. CMake generates configuration files for other build tools based on CMake-specific configuration files. The other tools are responsible for more directly building; using the generated files. A single set of CMake-specific configuration files can be used to build a codebase using the native build tools of multiple platforms.^[5]

Notable native build tools supported by CMake include: Make, Qt Creator, Ninja, Android Studio, Xcode, and Visual Studio.^[5]

CMake is distributed as free and open-source software under a permissive BSD-3-Clause license.^[6]

History

Initial development began in 1999 at Kitware with funding from the United States National Library of Medicine as part of the Visible Human Project.^[5] CMake was first released in 2000.

CMake was developed to support building the Insight Segmentation and Registration Toolkit (ITK) for multiple platforms. Stated goals included addressing weaknesses while maintaining strengths of contemporary tools such as autoconf and libtool, and to align with state of the art build technology of the time: configure scripts and Make files for Unix platforms, and Visual Studio project files for Windows.^[7]^[5]

CMake was inspired by multiple contemporary tools. pcmaker – developed by Ken Martin and others to support building the Visualization Toolkit (VTK) – converted Unix Make files into NMake files for building on Windows.^[5] gmake supported Unix and Windows compilers, but its design lead to hard to resolve environment issues. Both tools were working examples of a build tool that supported both Unix and Windows, but they suffered from a serious flaw: they required Windows developers to use the command line even though many prefer to use an integrated development environment (IDE) such as Visual Studio.

CMake was to provide similar cross-platform support but to better satisfy the preferences of the developers on each platform.

The design goals of the first version included:^[5]

Depend only on host C++ compiler; no other third-party tools or libraries required
Generate Visual Studio project files (as well as Unix files)
Support building _targets: program, static library, shared library
Run build-time code generators
Support separate directory trees for source vs. build files
Support host computer capability introspection
Support automatic dependency scanning of C/C++ header files
All features must work consistently and equally well on all supported platforms

For various reasons, CMake developers chose to develop a scripting language for CMake instead of using Tcl – a popular language for building at the time. Use of Tcl would have then added a dependency to the host machine which is counter to the goal of no dependencies other than a compiler. Also, Tcl was not well supported on Windows and some Unix systems at the time of initial development.^[5]

Subsequent development and improvements were fueled by the incorporation of CMake into developers’ own systems, including the VXL Project,^{[clarification needed]} the CABLE^[8] features added by Brad King,^{[clarification needed]} and GE Corporate R&D for support of DART.^{[clarification needed]} Additional features were created when VTK transitioned to CMake for its build environment and for supporting ParaView.

Version 3.0 was released in June 2014.^[9] It has been described as the beginning of "Modern CMake".^[10] Experts now advise to avoid variables in favor of _targets and properties.^[11] The commands add_compile_options, include_directories, link_directories, link_libraries that were at the core of CMake 2 should now be replaced by _target-specific commands.

Name

CMake developer Brad King stated that "the 'C' in CMake stands for 'cross-platform'".^[12]

Features

Generators

Support for each native build tool is provided as a separate generator. CMake uses a particular generator by default for the host environment. Alternatively, a generator can be selected via the command line option -G. For example, generator Unix Makefiles creates files for make.^[5]

CMake does not support custom generators without modifying the CMake implementation. None-the-less, the CMake source code could be modified to include a custom generator.

Build _targets

CMake supports building executables, libraries (e.g. libxyz, xyz.dll etc.), object file libraries and pseudo-_targets (including aliases). CMake can produce object files that can be linked against by executable binaries/libraries, avoiding dynamic (run-time) linking and using static (compile-time) linking instead. This enables flexibility in configuration of various optimizations.^[13]

_target generation can be configured via _target properties. With older versions, this was done via CMAKE_-prefixed global variables, but this approach is deprecated.^[11]^[14]

Hierarchical configuration

CMake configuration files can be structured according the hierarchical structure of the source code; the source tree. A CMakeLists.txt in a root source directory serves as the root of the configuration. It may include sub-directories which each contain a CMakeLists.txt. Repeating this, results in a hierarchical structure of configuration that follows the structure of the source code.^[11]^[14]

Separate build tree

CMake can locate generated files (both by CMake and the native build tools) in a directory tree that is separate from the source tree.^[5]

This enables multiple builds from the same source tree since each has non-overlapping file system space. This may be leveraged to build different or even incompatible configurations such as for different platforms.

This also simplifies file management by allowing removing generated files by deleting a single directory tree instead of removing multiple files and directories throughout the source tree. This tends to prevent accidentally deleting source files or accidentally adding generated files to source control.

Dependency management

CMake ensures that downstream components are re-built when its sources are changed or built.^[5]

Flexible project structure

CMake can locate system-wide and user-specified executables, files, and libraries. These locations are stored in a cache, which can then be tailored before generating the _target build files. The cache can be edited with a graphical editor, which is shipped with CMake.

Complicated directory hierarchies and applications that rely on several libraries are well supported by CMake. For instance, CMake is able to accommodate a project that has multiple toolkits, or libraries that each have multiple directories. In addition, CMake can work with projects that require executables to be created before generating code to be compiled for the final application. Its open-source, extensible design allows CMake to be adapted as necessary for specific projects.^[15]

IDE configuration support

CMake can generate project files for several popular IDEs, such as Microsoft Visual Studio, Xcode, and Eclipse CDT. It can also produce build scripts for MSBuild or NMake on Windows; Unix Make on Unix-like platforms such as Linux, macOS, and Cygwin; and Ninja on both Windows and Unix-like platforms.

Compiler feature detection

CMake allows specification of features that the compiler is required to support in order to get the _target program or library compiled.^[16]

Compiler support

CMake supports many compilers, including: Apple Clang, Clang, GNU GCC, MSVC, Oracle Developer Studio, and Intel C++ Compiler.^[17]

Packaging

CMake can both consume and produce packages. CMake provides functions for pulling packages from a remote server that can be used as part of the build process. Via CPack, files may be packed into an archive file for package manager or installer supported by a _target platform.^[18]^{: 132, 142}^[19]^[20]

GUI

Cmake may be run by using a ncurses program like ccmake that can be used to configure projects via command-line interface.

Precompiled headers

It's possible to generate precompiled headers via CMake since version 3.6.^[21]

JSON strings

CMake supports extracting values into variables from JSON-data strings (since version 3.19).^[22]

Language

CMake includes an interpreter for a relatively simple, custom, imperative scripting language that supports variables, string manipulation, arrays, function and macro declaration, and module inclusion (importing).

The interpreter reads CMake language commands from files named CMakeLists.txt which specify source files and build preferences. CMake uses this information to generate native tool configuration files. Additionally, files with suffix .cmake can be used for storing additional script.^[23]

Command syntax

CMake language commands are formatted as:

name(argument ...)

Arguments are whitespace-separated and can include keywords to separate groups of arguments. For instance, in the following command, the keyword COMPILE_FLAGS delimits a list of source files from compiler flags.^[24]

set_source_file_properties(filename ... COMPILE_FLAGS compile_flag ...)

Implementation

The CMake scripting language is implemented via Yacc and Lex generators.

The executable programs CMake, CPack, and CTest are written in C++.

Much of CMake's functionality is implemented in modules written in the CMake language.^[25]

CMake documentation (since release 3.0) uses reStructuredText markup. HTML pages and man pages are generated by the Sphinx documentation generator.

Additional tools

CMake ships with numerous .cmake script files and development tools that facilitate tasks such as finding dependencies (both built-in and external, e.g. FindXYZ modules), testing the toolchain environment and executables, packaging releases (CPack), and managing dependencies on external projects (ExternalProject module). Additional development tools include:^[26]^[27]

ccmake and cmake-gui — for updating configuration variables intended for a native build tool
CPack — for packaging software as Linux RPM, deb, and gzip packages, NSIS files (for Windows), and macOS packages ^[28]^[29]
CTest and CDash — for software testing and reporting

Adoption

CMake has been very widely adopted among commercial, open source, and academic software projects. A few notable users include Android NDK, Netflix, Inria, MySQL, Boost (C++ libraries), KeePassXC, KDE, KiCAD, FreeCAD, Webkit, Blender,^[30] Biicode, ReactOS, Apache Qpid, the ATLAS experiment,^[31] and Second Life.^[32]

Build process

Building via CMake has a two major stages.^[5] First, native build tool configuration files are generated from CMake configuration files – written in the CMake scripting language. The command line syntax is cmake <dir> where <dir> is a directory that contains a CMakeLists.txt file. Then, the native build tools are invoked either via CMake (cmake --build <dir>) or directly via the native tool's interface. The native build tools use the generated files.^[15]^[33]

Examples

Hello world

The following demonstrates configuring CMake to build a hello world program written in C++, and using CMake to build the program.

hello.cpp:

#include <iostream>
int main() {
    std::cout << "Hello, world!" << std::endl;
    return 0;
}

CMakeLists.txt:

cmake_minimum_required(VERSION 3.5)
project(HelloWorld CXX)
add_executable(hello hello.cpp)

To build via CMake, first cd to the directory containing the two files above. Then, generate the native build config files via the cross-platform CMake command:

cmake -B out .

All generated files will be under the directory out as specified via -B out.

Then, build via the native build tool as supported thru CMake:

cmake --build out

The program is then available for running. Via Bash, the command is like ./out/hello. On Windows, the output file ends with .exe.

Include

This example demonstrates configuring the preprocessor include path.