CMake: Verwendung, Templates & Build System

Wenn man ein neues Produkt entwickelt, kann man sich leicht hinreißen lassen. Die Begeisterung für die Aufgabe, die Kreativität der beteiligten Entwickler & Entwicklerinnen, die verschiedenen Entwicklungskits der Chip- und Modulhersteller. Manchmal reicht es aus, von einer Idee zu hören, um mit der Entwicklung von Funktionen und Software im Allgemeinen direkt loslegen zu wollen.

Diese Leidenschaft ist zwar lobenswert und kann manchmal sogar einen schnelleren Weg zur Marktreife bieten, ist aber nicht unbedingt die effizienteste Vorgehensweise, vor allem nicht, wenn es um die Umsetzung in großem Maßstab geht. Für Softwareprojekte ist es daher am besten, ein so genanntes „Build-System“ zu verwenden.

Ein Build-System ist ein Satz von Werkzeugen und Prozessen, mit denen die Kompilierung und Assemblierung von Quellcodes in ausführbare Programme, Bibliotheken oder andere einsatzfähige Artefakte automatisiert wird. Im Allgemeinen besteht es aus einem Compiler (übersetzt geschriebenen Quellcode in Maschinencode) und Build-Tools & Konfiguration (ein automatisierter Prozess, der die Quelldateien kompiliert und eine Bibliothek erzeugt).

Hier bei ithinx bevorzugen wir derzeit CMake (Cross-Platform Make) als unser Build-Tool der Wahl. In diesem Artikel erfahren Sie, was genau CMake ist, wie es funktioniert, welche Vorteile es bietet und welche Templates Sie nutzen können.

Was ist CMake? Eine Definition

Die Software CMake ist ein leistungsstarkes Build System, das Entwicklern hilft, Projekte effizient zu verwalten und plattformübergreifend zu bauen. CMake ist ein Open-Source-Tool, das ursprünglich von Kitware entwickelt wurde und heute insbesondere für C++-Projekte weit verbreitet ist. CMake bietet viele Vorteile gegenüber klassischen Build-Tools wie Make oder Ninja, ermöglicht es, Projekte schneller zu starten und vereinfacht den Wartungsaufwand erheblich.

Grundlagen des CMake Build Systems

Das CMake Build System bildet das Herzstück jeder Projektkonfiguration. Es steuert, wie der Quellcode kompiliert, verknüpft und zu ausführbaren Programmen oder Bibliotheken zusammengeführt wird. Zentrale Elemente sind dabei die Datei CMakeLists.txt, die sogenannten Targets (also definierte Ausgabedateien wie Executables oder Libraries) sowie die Einbindung externer Abhängigkeiten.

Diese Komponenten greifen eng ineinander: Die CMakeLists.txt definiert die Projektstruktur und die verwendeten Abhängigkeiten, während Targets angeben, welche Dateien gebaut werden sollen. Dadurch kann CMake komplexe Software-Projekte zuverlässig und plattformübergreifend verwalten – unabhängig davon, ob sie auf Windows, Linux oder macOS erstellt werden.

Aufbau einer CMakeLists.txt

Die CMakeLists.txt ist die zentrale Steuerdatei eines Projekts. Sie legt fest, welche Dateien kompiliert werden, welche Bibliotheken benötigt werden und wie das Ergebnis heißen soll.
Sie ist klar strukturiert: Am Anfang stehen meist Projektname und minimale CMake-Version, gefolgt von der Definition von Executables oder Libraries. Anschließend werden externe Bibliotheken eingebunden und Zielverknüpfungen hergestellt. Ein sauber aufgebautes CMake Template spart Zeit und reduziert Fehlkonfigurationen, besonders in größeren Softwareprojekten.

Die CMakeLists.txt Datei enthält alle Anweisungen, die CMake benötigt, um das Projekt zu bauen:

• Projektname und minimale CMake-Version
• Definition von Executables und Libraries
• Einbindung externer Pakete

Beispiel:

• cmake_minimum_required(VERSION 3.20)
• project(MeinProjekt)
• add_executable(MeinProgramm main.cpp)

Targets: Executables und Libraries

Targets sind das Herzstück des Build-Prozesses. Ein Target kann ein ausführbares Programm (Executable) oder eine Bibliothek (Library) sein. Durch die Definition von Targets weiß CMake genau, welche Quelldateien kompiliert und wie sie miteinander verknüpft werden müssen. Targets erleichtern auch die Wiederverwendung: Einmal definierte Bibliotheken können in mehreren Projekten oder Modulen eingebunden werden, was das Software CMake Build System besonders effizient macht.

Einbindung externer Bibliotheken

CMake erlaubt es, externe Bibliotheken wie Boost, OpenSSL oder Eigen einfach in Projekte einzubinden. Anstatt komplizierte Pfade manuell zu verwalten, können Entwickler Abhängigkeiten deklarativ angeben. CMake sucht die benötigten Pakete automatisch, prüft Versionen und sorgt dafür, dass die passenden Header- und Library-Dateien eingebunden werden. Das steigert die Portabilität erheblich und vermeidet manuelle Fehlerquellen, insbesondere bei größeren oder gemeinsam genutzten Projekten.

Multi-Plattform Builds

Einer der größten Vorteile von CMake ist seine Fähigkeit, plattformübergreifende Builds zu erzeugen. Das bedeutet, dass dieselbe CMakeLists.txt auf verschiedenen Betriebssystemen oder mit unterschiedlichen Compilern verwendet werden kann. CMake generiert automatisch die passenden Projektdateien – etwa für Visual Studio auf Windows oder Makefiles auf Linux. So lassen sich selbst komplexe Projekte konsistent über mehrere Umgebungen hinweg kompilieren, ohne dass Konfigurationsdateien angepasst werden müssen.

ithinx CMake Tem­pla­te

Bei ithinx gehen wir noch einen Schritt weiter und verwenden unser eigenes ithinx CMake Template. Unser Template vereinfacht und standardisiert die Integration von CMake in Projekte, vereinfacht das Testing und schafft eine nahtlose Integration in unser Continuous-Integration System (meistens Jenkins), generiert Code-Metriken (einer Methodik um den Qualität von Code zu messen), Dokumentation und erzeugt generische Deployment-Pakete.

Bei ithinx unterstützt das Ganze das V-Modell, das wir für die Entwicklung verwenden und ermöglicht neuen Mitarbeitenden (entweder im Projekt oder in der Organisation) den einfachen Einstieg in das Projekt. Vor allem reduziert es den Einrichtungsaufwand, d.h. weniger Zeitaufwand für uns und damit auch weniger Kosten für unsere Kunden.

Vorteile von CMake: So profitieren Sie vom CMake Build System

• Plattformunabhängigkeit: CMake erlaubt es Entwicklern, Build-Konfigurationen zu definieren, die nahtlos über verschiedene Betriebssysteme und Build-Umgebungen hinweg funktionieren.
• Generator-basiertes Build-System: CMake generiert plattformspezifische Build-Dateien (z.B. Makefiles, Visual Studio Projektdateien) auf der Basis der Projektkonfiguration und ist damit an verschiedene Build-Tools anpassbar.
• Modularität und Abhängigkeitsmanagement: CMake unterstützt modulare Projektstrukturen und hilft bei der Verwaltung von Abhängigkeiten zwischen verschiedenen Komponenten oder Bibliotheken.
• Anpassbare Konfiguration: Entwickler können die Build-Einstellungen, Kompilieroptionen und andere Parameter über CMake anpassen und so den Build-Prozess auf spezifische Anforderungen zuschneiden.
• Out-of-Source-Builds: CMake fördert die Praxis, das Projekt außerhalb des Quellcodeverzeichnisses zu bauen, um saubere und organisierte Builds zu ermöglichen, ohne den Quellcodebaum zu überladen.
• Integration mit Test-Frameworks: CMake erleichtert die Integration mit Test-Frameworks und ermöglicht automatisierte Tests als Teil des Build-Prozesses. Wie Sie an anderer Stelle auf unserer Website lesen werden, legen wir großen Wert auf das Testen und die Automatisierung von Tests.

Insgesamt vereinfacht und standardisiert CMake den Prozess der Erstellung von Softwareprojekten und erleichtert Entwicklern die Verwaltung und Pflege komplexer Build-Konfigurationen auf verschiedenen Plattformen.

FAQ: Häufige Fragen & Antworten rundum CMake

Was ist CMake und wofür wird es verwendet?

CMake ist ein plattformübergreifendes Build-System, das Quellcode in ausführbare Programme oder Bibliotheken übersetzt. Es dient als Meta-Build-System, das Projektdateien für unterschiedliche Compiler und Entwicklungsumgebungen erzeugt. Dadurch lässt sich Software CMake effizient und konsistent auf Windows, macOS und Linux entwickeln und pflegen.

Wie funktioniert das CMake Build System?

Das CMake Build System erstellt zunächst auf Basis der CMakeLists.txt die passenden Build-Dateien für den gewählten Compiler oder die Entwicklungsumgebung. Anschließend übersetzt es die Quelldateien in ausführbare Programme oder Bibliotheken. Dieser zweistufige Prozess sorgt dafür, dass Projekte flexibel und unabhängig von Plattform oder Compiler konfiguriert werden können.

CMake vs. Make: Was ist der Unterschied?

CMake ist ein Build-System-Generator, der automatisch Konfigurationsdateien für unterschiedliche Plattformen und Tools erstellt. Make hingegen ist ein reines Build-Tool, das diese Konfigurationen ausführt, aber nicht selbst generiert. Mit CMake kann ein Projekt somit einmal definiert und anschließend mit verschiedenen Compilern oder auf unterschiedlichen Systemen gebaut werden – ein entscheidender Vorteil für plattformübergreifende Softwareentwicklung.

Weiterführende Ressourcen

• Offizielle CMake-Dokumentation