Cmake

Na podstawie: https://cmake.org/cmake/help/latest/guide/tutorial/index.html

Podstawy

Mamy tu minimalny przykład

#na początku zawsze określamy min wersję CMake'a
cmake_minimum_required(VERSION 3.10)

# set the project name
project(Tutorial)

# Tworzymy tylko jeden plik wyjściowy `Tutorial` ze skompilowanego pliku tutorial.cxx
add_executable(Tutorial tutorial.cxx)

Budowanie

#warto stworzyć sobie nowy folder i w nim budować
mkdir build; cd build

cmake SCIEZKA_DO_FOLDERU_GLOWNEGO # zwykle do folderu z plikiem CMakeLists.txt
cmake --build . #można tu też użyć po prostu make (Linux)

Inne użyteczne komendy

cmake --build . --target help # wypisanie celów w ramach projektu

cmake --build . --target # budowanie danego celu

Konfigurowalne pliki nagłówkowe

Za pomocą CMake'a możemy generować pliki nagłówkowe zawierające zmienne oraz parametry zawarte w plikach CMake.

Przykładowo możemy w ten sposób zapisywać wersję naszego programu.

cmake_minimum_required(VERSION 3.10)

# set the project name and version
project(Tutorial VERSION 1.0)

# opisujemy tu na podstawie czego ma być wygenerowany nasz plik nagłówkowy
configure_file(TutorialConfig.h.in TutorialConfig.h)

# Skoro utworzony zostanie plik TutorialConfig.h to warto dodać ścieżkę na krórej się znajduje do listy ścieżek w których będą szukane pliki
target_include_directories(Tutorial PUBLIC
                           "${PROJECT_BINARY_DIR}"
                           )

Zawartość pliku TutorialConfig.h.in

// the configured options and settings for Tutorial
#define Tutorial_VERSION_MAJOR @Tutorial_VERSION_MAJOR@
#define Tutorial_VERSION_MINOR @Tutorial_VERSION_MINOR@

Określenie wymaganej wersji C++

# specify the C++ standard
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)

Biblioteki

Tworzenie własnych

Podobnie jak programy, za pomocą cmake'a możemy definiować też biblioteki W wypadku prostych bibliotek wewnątrz naszych preojektów wystarczy jednolinijkowy plik CMakeLists.txt w ich folderze.

# Dodaj bibliotekę o nazwie MathFunctions zawierającą plik mysqrt.cxx
add_library(MathFunctions mysqrt.cxx)

(Ta biblioteka znajduje się w folderze MathFunctions w głównym folderze projektu. W folderze tym mamy jeszcze plik nagłówkowy MathFunctions.h)

Linkowanie bibliotek

# add the MathFunctions library
add_subdirectory(MathFunctions)

# add the executable
add_executable(Tutorial tutorial.cxx)

# Musimy podlinkować wszystkie biblioteki używane przez plik Tutorial
target_link_libraries(Tutorial PUBLIC MathFunctions)

# add the binary tree to the search path for include files
# so that we will find TutorialConfig.h
target_include_directories(Tutorial PUBLIC
                          "${PROJECT_BINARY_DIR}"
                          "${PROJECT_SOURCE_DIR}/MathFunctions"
                          )

Logika

Zmienne

Zmienne są definiowane podczas przypisywania im wartości.

listy

# Dodanie elementu do listy
list(APPEND EXTRA_LIBS MathFunctions)

# Dodanie elementów do listy regexem (warto tu pamiętać, że domyślnie te
# te ścieżki są globalne, więc aby je potem złapać regexem trzeba załóżyć, że zaczynają się od /
file(GLOB TARGET_SRC "src/*.cpp" )

# Usuwanie elementu z listy
list(REMOVE_ITEM TARGET_SRC "/*main.cpp" )

Aby zmienna została podmieniona przez generator na jej zawartość musi być ona umieszczona w klamrach, bez nich po prostu przekazujemy stringa.

message(HEADERS)
#>>> [cmake] HEADERS

message(${HEADERS})
#>>> [cmake] /include/plik.hpp /inlude/plik2.hpp

TODO-uporządkować ten punkt

Opcje

Są to parametry dla buildu, które będą potem także widoczne w narzędziach z GUI dla CMake.

option(USE_MYMATH "Use tutorial provided math implementation" ON)

Ta opcja będzie widoczna z domyślną wartością ON

IF-y

W CMake'u możemy tworzyć całe wyrażenia warunkowe za pomocą wcześniej predefiniowanych amiennych.

if(USE_MYMATH)
  add_subdirectory(MathFunctions)
  list(APPEND EXTRA_LIBS MathFunctions)
  list(APPEND EXTRA_INCLUDES "${PROJECT_SOURCE_DIR}/MathFunctions")
endif()

# add the executable
add_executable(Tutorial tutorial.cxx)

target_link_libraries(Tutorial PUBLIC ${EXTRA_LIBS})

# add the binary tree to the search path for include files
# so that we will find TutorialConfig.h
target_include_directories(Tutorial PUBLIC
                           "${PROJECT_BINARY_DIR}"
                           ${EXTRA_INCLUDES}
                           )

Pliki

Szukanie i dodawanie plików

#prosty sposób na wczytanie wszystkich plików z danego folderu do zmiennej
file(GLOB_RECURSE SOURCES ${CMAKE_SOURCE_DIR} "src/*")

Domyślne ścieżki w CMake

CMAKE_SOURCE_DIR

TODO

Instalacja

dokumentacja

Lepsze wsparcie dla IDE

Poniższa komenda wygeneruje przy budowie plik compile_commands.json, który może być potem używane przez IDE.

set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

Np aby VScode użył tego pliku należy go podać w ustawieniach:

  "configurations": [
    {
      "name": "Mac",
      "intelliSenseMode": "clang-x64",
      "includePath": ["${myDefaultIncludePath}", "/another/path"],
      "macFrameworkPath": ["/System/Library/Frameworks"],
      "defines": ["FOO", "BAR=100"],
      "forcedInclude": ["${workspaceFolder}/include/config.h"],
      "compilerPath": "/usr/bin/clang",
      "cStandard": "c11",
      "cppStandard": "c++17",
      "compileCommands": "/path/to/compile_commands.json",
      "browse": {
        "path": ["${workspaceFolder}"],
        "limitSymbolsToIncludedHeaders": true,
        "databaseFilename": ""
      }
    }
  ],