Skip to content

Latest commit

 

History

History
76 lines (60 loc) · 4.01 KB

README.md

File metadata and controls

76 lines (60 loc) · 4.01 KB
Raw

cmake-cpp-boilerplate

This repository is a CMake boilerplate for starting cross-platform C++ projects. The default setting uses C++20, but you can change it in cmake/StandardProjectSettings.cmake.

External dependencies

A C++ compiler

Recent version of Visual Studio, GCC, and Clang should be find.

CMake 3.15+

CMake is the build tool used for this project.

  • (Optional) Ninja can greatly improve the incremental build time.

Package Management

This boilerplate uses Conan to manage packages.

Usage

Before starting your project, modify all the settings with BP_* prefix in the CMake files into your own prefix. You need to modify those names in both the CMake files and the CI scripts.

There are also several predefined CMake targets, and you can rename those targets by searching and replacing "cmake_cpp_boilerplate"

Target Alias Explaination
cmake_cpp_boilerplate_compiler_options cmake_cpp_boilerplate::compiler_options An interface target for compiler options
cmake_cpp_boilerplate_lib cmake_cpp_boilerplate::lib Most of the code should reside here to be used in both the app and the test
cmake_cpp_boilerplate_app N/A Main
cmake_cpp_boilerplate_test N/A Unit tests

Executing CMake

When using CMake, you need to pass -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=cmake/conan_provider.cmake to CMake as argument. For example,

cmake -B build -S . -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=[path-to-cmake-conan]/conan_provider.cmake -DCMAKE_BUILD_TYPE=Release

Unit test

This boilerplate uses Catch2 as the Unit Test Framework. The CMake option BP_BUILD_TESTS (ON by default) enables the building of unit test.

The CMake option BP_BUILD_TESTS_COVERAGE (OFF by default) enables the test coverage with gcov and lcov. To make the coverage web report working, you need a codecov account. And you also need to substitute the CODECOV_TOKEN in .travis.yml to your own.

Compiler warning and sanitizers

Every time you add a new target, you need to enable the warnings and sanitizers on that target. Please write

target_link_libraries(<your target name> PRIVATE compiler_options)

This project enables a reasonable amount of warnings across compilers GCC, Clang, and MSVC. The option BP_WARNING_AS_ERROR treats warnings as errors. You can modify cmake/compiler.cmake to customize warning settings.

We can optionally enable compiler sanitizers for the project. Sanitizers are run-time checks that catch common bugs. Not all compilers support all the sanitizers, and enabling non-supported sanitizer triggers either a compile-time error or warning. The option BP_USE_ASAN enables the address sanitizer; BP_USE_TSAN enables the thread sanitizer; BP_USE_MSAN enables the memory sanitizer; BP_USE_UBSAN enables the undefined behavior sanitizer.

All the CMake Options

  • BP_BUILD_TESTS (ON by default) enables the building of unit test
  • BP_BUILD_TESTS_COVERAGE (OFF by default) enables the test coverage with gcov and lcov. The compiler must be either gcc or clang.
  • BP_WARNING_AS_ERROR (ON by default) treats warnings as errors
  • BP_ENABLE_PCH (OFF by default) enables precompile headers. You can modify the precompiled header list in compiler.cmake
  • BP_USE_ASAN (OFF by default) enables the address sanitizer
  • BP_USE_TSAN (OFF by default) enables the thread sanitizer
  • BP_USE_MSAN (OFF by default) enables the memory sanitizer
  • BP_USE_UBSAN (OFF by default) enables the undefined behavior sanitizer
  • BP_ENABLE_IPO (OFF by default) enables Interprocedural optimization, aka Link Time Optimization

License

This repository is released under Public Domain, use it in whatever way you want. See License for more information.