Development/Tutorials/CMake (de)

CMake

Anleitungsserie	Grundlagen
Voriges Kapitel	None
Nächstes Kapitel	n/a
Weiterführende Texte	n/a
Navigation	Deutsche Startseite

Zusammenfassung

CMake ist das Build-System, das KDE benutzt. Diese Anleitung beschreibt, wie man CMake benutzt und wie man die Projektdateien schreibt.

Einführung

CMake liest Script Dateien ein und gibt Eingabedateien für das native Buildsystem der Platform auf der es läuft aus. Es kann GNU Makefiles, KDevelop Projekt Dateien, Eclipse Projekt Dateien, XCode Projekt Dateien und Visual Studio Projekt Dateien ausgeben.

CMake ist freie Software, die unter einer BSD-artigen Lizenz veröffentlicht wird. Entwickelt wird es von Kitware Inc.

Hier einige Links, wo man etwas über CMake im Allgemeinen lernen kann (meist englisch):

Es gibt auch eine CMake Mailing List.

Warum man CMake benutzen sollte

CMake ist nach einer Entscheidung im März 2006 das offizielle Werkzeug von KDE 4, vorwiegend aus technischen Vorteilen gegenüber den älteren KDE Werkzeugen automake und unsermake:

CMake wird unabhänging von KDE entwickelt und kann auch von anderen Projekten benutzt werden.
Die Übersetzungszeit verkürzt sich durch CMake, hauptsächlich weil libtool nicht mehr benutzt wird.
Die CMake-Dateien sind einfacher zu schreiben.

Wie man KDE mit Hilfe von CMake übersetzt

CMake herunterladen und installieren

Linux, BSD und andere Unix Systeme

Die neuste Version von CMake kann von [1] heruntergeladen werden.

Einmal heruntergeladen, muss es entpackt und übersetzt werden:

$ mkdir cmake-build
$ cd cmake-build
$ ../bootstrap
$ make
$ make install

Standardmäßig wird CMake in /usr/local installiert, daher muss /usr/local/bin in Pfad für ausführbare Dateien stehen. Um das Installationspräfix zu ändern (z.B. in /usr in debian), muss die '--prefix=PATH' Option zum bootstrap Kommando hinzugefügt werden.

Möchte man die aktuelle Entwicklerversion von CMake benutzen, findet man hier eine Anleitung.

Windows

Neuste Version von CMake von hier herunterladen.

Dann den Cmake-Installer aufrufen

Standardmäßig wird CMake in C:\$(Program Files)\CMake 2.4 installiert.

Möchte man die aktuelle Entwicklerversion von CMake benutzen, findet man hier eine Anleitung.

CMake ausführen

Linux, BSD, and other Unix Systems

Um die Build-Dateien für das System zu erzeugen, muss CMake aufgerufen werden. Sowohl Übersetzungsvorgänge innerhalb des Codes als auch in einem gesonderten werden von CMake unterstützt, wobei KDE derzeit einen Übersetzungsvorgang innerhalb des Quellcodes verbietet.

Hat man zum Beispiel kdelibs/ in ~/src/kdelibs/, dann ruft man folgende Befehle auf:

$ ls
kdelibs/
$ mkdir kdelibs-build
$ cd kdelibs-build
$ cmake ../kdelibs

Das wird die Makefiles im Verzeichnis kdelibs-build erzeugen, die zum Übersetzen von kdelibs benötigt werden.

Windows

Hat man zum Beispiel kdelibs\ in c:\daten\kde4, dann ruft man folgende Befehle auf:

c:\daten\kde4> cd kdelibs\win
c:\daten\kde4> cmake
c:\daten\kde4> make 
c:\daten\kde4> make install
c:\daten\kde4> cd ..
c:\daten\kde4> mkdir kdelibs-build
c:\daten\kde4> cd kdelibs-build
c:\daten\kde4\kdelibs-build> cmake ..\kdelibs

Dadurch werden die Makefiles, um kdelibs\ zu erzeugen in kdelibs-build angelegt. Siehe auch KDE On Windows für mehr Informationen über das Übersetzen von KDE unter Windows.

Projektdateien für KDevelop

Benötigen Sie Projektdateien für KDevelop (was einfache Makefile mit einigen zusätzlichen Extradateien für KDevelop sind), rufen Sie folgenden Befehl auf:

$ cmake ../kdelibs -GKDevelop3

Mit 'cmake -h' kann man herausfinden, welche Generatoren CMake unterstützt und welche weiteren Optionen es gibt.

CMake und Qt4

Um Qt 4 zu finden sucht CMake nach qmake im Pfad für ausführbare Dateien. CMake benutzt nicht die QTDIR Umgebungsvariable. Daher müssen Sie sicherstellen, dass das erste qmake, welches im Pfad gefunden wird dasjenige ist, welches benutzt werden soll (also bei Parallelinstallationen von Qt3 und Qt4 entsprechend Qt4 zuerst gefunden wird).

Mehr Details

Wenn CMake seine Arbeit beendet hat, existiert eine Datei namens "CMakeCache.txt". Diese Datei enthält alle Einstellungen, die von CMake auf dem System entdeckt worden sind. Soll CMake mit einem anderen Generator aufgerufen werden oder das System neu untersucht werden, löschen Sie diese Datei. Wenn CMake etwas nicht findet, aber Sie wissen, dass es auf Ihrem System ist, können Sie CMake manuell mitteilen, wo man es findet. CMake benutzt Variablen um diese Information zu speichern und zwar in der eben erwähnten CMakeCache.txt Datei. Es gibt drei Möglichkeiten, diese Variablen manuell einzustellen:

CMake den korrekten Wert über die Kommandozeile mitteilen:

cmake ../kdelibs -DNAME_OF_THE_VARIABLE=value

ccmake benutzen, welches eine auf curses basierende GUI aufruft, um CMake Variablen zu setzen ((run: ccmake ../kdelibs)
Die Datei CMakeCache.txt direkt bearbeiten (wird nicht empfohlen)

Sie sollten "ccmake ../kdelibs" mindesten einmal aufrufen, so dass Sie einen Eindruck bekommen, welche Variable CMake benutzt. Drücken Sie "T" um die "fortgeschrittenen" Variablen zu sehen. Wenn also CMake etwas bestimmtes nicht von sich aus findet, rufen Sie ccmake auf und stellen Sie es von Hand ein.

Kommandozeilenvariablen

Folgende cmake Kommandozeilenvariablen könnten für Sie von Interesse sein:

CMAKE_INSTALL_PREFIX: cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4 entspricht dem früheren ./configure --prefix=/opt/kde4
CMAKE_BUILD_TYPE: Hier kann man sich aussuchen, welche Debug-Informationen erzeugt werden sollen. Folgende Möglichkeiten stehen zur Auswahl: "debugfull", "debug", "profile", "relwithdebinfo", "release". Voreinstellung ist "relwithdebinfo" (-O2 -g). Weitere Details befinden sich im Artikel CMake Build Types.
KDE4_BUILD_TESTS=ON: erzeugt Makefiles die zusätzliche Testprogramme erzeugen und auch das Ziel 'test' zur Verfügung stellen.
KDE4_TEST_OUTPUT=xml: Unit tests, die das QTestLib Framework benutzen werden xml-formatierte Logfiles erzeugen.
KDE4_DISABLE_MULTIMEDIA=ON: Erzeugt KDE ohne jegliche Multimediaunterstützung (Audio und Video)
RPATH_STYLE: Diese Kommandozeilenoption gibt es nicht mehr. Per Voreinstllung wird alles mit einem korrekten RPATH erzeugt. Möchten Sie RPATH nicht, setzten Sie CMAKE_SKIP_RPATH auf TRUE.
BUILD_foo=OFF: Schaltet die Erzeugung im Unterverzeichnis 'foo' ab.
WITH_foo: Hier gibt es mehrere Möglichkeiten, z.B. WITH_CUPS oder WITH_Jasper. Wenn Sie diese Punkte ausschalten, wird CMake nicht versuchen, die Pakete zu finden, ansonsten sucht CMake danach. Schlägt das Fehl, kann man wie oben beschrieben manuell nachhelfen.

Umgebungsvariablen

Wenn sich Header oder Bibliotheken an einem nicht-standarisierten Ort befinden, den CMake nicht findenkann (so wird zum Beispiel fink auf Mac OSX in /sw installiert), kann man folgendende Umgebungsvariablen setzen. Trotz der ähnlichen Namensgebung, funktionieren diese nicht als Kommandozeilenparameter für CMake:

CMAKE_INCLUDE_PATH, Beispiel: export CMAKE_INCLUDE_PATH=/sw/include
CMAKE_LIBRARY_PATH, Beispiel: export CMAKE_LIBRARY_PATH=/sw/lib

Mehr Informationen über Umgebungsvariablen hier

Nach dem Aufruf von CMake

Schließt cmake mit der Meldung "Generating done" ab, gab es keine Fehler. Schließt es jedoch mit "Configuring done" ab, gab es Fehler, die es zu beheben gilt. Wenn cmake erfolgreich durchgelaufen ist, rufen Sie das entsprechende Werkzeug zur weiteren Bearbeitung auf (z.B. make, KDevelop, XCode oder MSVC). Das Ziel wird erzeugt, warten Sie bis die Erzeugung abgeschlossen ist. Anschließend können Sie z.B. "make install" aufrufen.

Gibt es eine Fehlermeldung der Art

CMake Error: This project requires some variables to be set,
and cmake can not find them.
Please set the following variables:
X11_XTest_LIB (ADVANCED)

kann es an einer fehlenden Bibliothek oder anderen Abhängigkeit liegen. Um herauszufinden, welche Bibliothek, suchen Sie im Verzeichnis cmake/modules nach der Variable, die cmake nicht finden kann. Im obigen Beispiel ist das

FIND_LIBRARY(X11_XTest_LIB Xtst ${X11_LIB_SEARCH_PATH})

Also fehlt die Biblothek Xtst. Diese muss ggf. nachinstalliert werden oder der Pfad dahin angegeben werden (s.o.). Anschließend rufen Sie cmake erneut auf.

CMake für eine einfache Applikation anwenden

Die einfachste CMakeLists.txt Datei ist folgende:

add_executable(hello main.cpp)

Dadurch wird aus der Quelldatei "main.cpp" eine ausführbare Datei namens "hello" (oder "hello.exe" unter Windows) erzeugt. C und C++ Dateien können vermischt werden, wenn das gewünscht wird. Es kann mehrere ausführbare Dateien und/oder Bibliotheken in einer CMakeLists.txt Datei geben. Die selbe Quelldatei kann in mehreren Zielen benutzt werden, es wird für jedes Ziel unabhängig von anderen Zielen erzeugt. Der vielleicht interessanteste Teil an der CMake-Sprache sind die Variablen:

SET( MY_SOURCES main.cpp widget.cpp)
MESSAGE(STATUS "my sources: ${MY_SOURCES}")

Mit dem SET() Kommando werden die Werte von Variblen gesetzt. Wenn Sie mehr als eine Zeichenkette übergeben, wird die Variable als Liste gesetzt. Eine Liste ist eine Liste von Zeichenketten, die durch Semikolon getrennt sind. Haben Sie nur einen Eintrag, wird die Variable nur auf diesen einen Wert gesetzt. Um den Wert einer Variable zu ermitteln, benutzen Sie ${VAR}. Eine Liste kann mit FOREACH() iteriert werden:

FOREACH(next_ITEM ${MY_SOURCES})
   MESSAGE(STATUS "next item: ${next_ITEM}")
ENDFOREACH(next_ITEM ${MY_SOURCES})

Groß- und Kleinschreibung wird in CMake Kommandos ignoriert, jedoch in Variablen und den Namen von Parametern unterschieden.

Man kann auch auf verschiedene Werte testen:

IF (UNIX)
   MESSAGE(STATUS "This is UNIX (including OS X and CygWin)")
ENDIF (UNIX)

IF (MSVC)
   SET(MY_SRCS ${MY_SRCS} winextra.cpp)
ENDIF (MSVC)

Das zweite Beispiel zeigt gleichzeitig, wie man Einträge zu einer Liste hinzufügt.

Es gibt auch in der CMake Wiki eine lesenswerte Anleitung, die erläutert, wie man cmake benutzt, um KDE 4 Software zu erzeugen.

CMake für ein KDE 4 Projekt benutzen

Folgendes Beispiel demonstriert eine einfache CMakeList.txt Datei für ein kleines KDE 4 Projekt:

PROJECT(kde4project)
FIND_PACKAGE(KDE4 REQUIRED)
INCLUDE_DIRECTORIES( ${KDE4_INCLUDES} )

SET(KDE4ProjectSources kde4mainapp.cpp someclass.cpp someotherclass.cpp)

KDE4_ADD_EXECUTABLE(kde4project ${KDE4ProjectSources} )

TARGET_LINK_LIBRARIES(kde4project ${KDE4_KDEUI_LIBS} ${KDE4_KPARTS_LIBS} )

Variablen, Makros und andere nützliche Informationen spezifisch für KDE kann unter Development/CMake/Addons for KDE gefunden werden.

CMake erweitern

CMake kann mit cmake-Skripten erweitert werden. Es werden eine Reihe von Scripten mitgeliefert, die unter UNIX standardmäßig unter /usr/local/share/CMake/Modules/ installiert werden. Die KDE-Bibliotheken installieren selber einen Satz CMake-Module nach share/apps/cmake/modules/. Die Dateien dort werden denjenigen im globalen Modulpfad von cmake vorgezogen.

Um Software-Pakete zu finden, gibt es FindFOO.cmake Dateien, siehe hier für weitere Informationen. Sie können auch Makros in CMake schreiben. Diese sind mächtig genug, die meisten Dinge zu erledigen, die Sie benötigen, um Software zu erstellen, sind jedoch nicht dazu konzipiert, als allgemeine Programmiersprache zu dienen.

autotools-basierte KDE Software nach CMake konvertieren

In kdesdk/cmake/ gibt es ein Skript namens am2cmake. Da es sich um ein Ruby-Script handelt, muss ruby installiert sein. Rufen Sie am2cmake im obersten Verzeichnis ihres Projektes auf:

$ cd src/mykooltool/
$ am2cmake --kde4

Vergessen Sie nicht den Schalter "--kde4", sonst werden keine für KDE 4 Software passenden Dateien erzeugt. Die erzeugten Dateien 'könnten' so wie sind funktieren, doch bei komplizierteren Projekten wird in der Regel zusätzliche Bearbeitung notwendig sein.

Es könnte sein, dass

mit INCLUDE_DIRECTORIES() weitere benötigte Verzeichnisse hinzugefügt werden müssen
mit TARGET_LINK_LIBRARIES() zusätzliche Bibliotheken angeben werden müssen, die mit dem Projekt verlinkt werden müssen.
mit ADD_DEFINITIONS() zusätzliche Compiler-Schalter gesetzt werden müssen
einige zusätzliche "configure" Prüfungen gesetzt werden müssen, siehe auch How To Do Platform Checks und How To Find Installed Software
Sie sich den sog. "convenience libraries" von libtool gesondert annehmen müssen. Diese werden von cmake nicht unterstützt, statt dessen wird eine Datei namens ConvenienceLibs.cmake created erzeugt. In dieser Datei finden Sie für jede einzelne "convenience library" eine einzelne Variable, welche alle Quelldateien für diese Bibliothek beinhaltet. Für Ziele, die mit diesen Bibliotheken verlinkt werden, fügen Sie einfach die Variable zu den Quellen hinzu.
Eine Datei namens AdditionalInfo.txt wird erzeugt. Hier werden alle *.in und *.in.in Dateien des Projektes aufgelistet. Die Aufgaben in diesen Dateien müssen von Hand nach cmake konvertiert werden.

Häufig gestellte Fragen (FAQs)

Wie kann ich meinem bevorzugten Editor beibringen, die CMake Syntax hevorzuheben?

Lesen Sie CMake Editors Support. Hier wird beschrieben, wie man Emacs (auch XEmacs), VIM, Kate, KWrite, and KDevelop anpasst.

Ich benötige einige Dateien, welche während des Übersetzens erzeugt werden. Wie bewerkstellige ich das?

Fügen Sie ADD_CUSTOM_COMMAND() hinzu. Das wird im CMake wiki erklärt: How can I generate a source file during the build

Ich benötige ausführbare Dateien, die im späteren Übersetzungsvorgang bestimmte Dateien erzeugen. Wie mache ich das?

Nehmen wir an die ausführbare Datei heißt genembed. Benutzen Sie KDE4_ADD_EXECUTABLE(foo RUN_UNINSTALLED ${fooSources}) um diese ausführbare Datei zu erzeugen. Die RUN_UNINSTALLED Option ist wichtig, da die ausführbare Datei vom build Verzeichnis aus aufgerufen wird und Bibliotheken in diesem Verzeichnis benötigt. Um das zu bewerkstelligen, wird die ausführbare Datei mit einem entsprechend gesetztem RPATH kompiliert, und ein Wrapper Shell Skript erzeugt, welches genau so heißt wie die ausführbare Datei nur mit der Endung ".sh". Diese Script setzt die Variable LD_LIBRARY_PATH und ruft die eigentliche ausführbare Datei auf

Benutzen Sie dieses Script im oben beschriebenen ADD_CUSTOM_COMMAND(). Sie könnnen den Namen und den Pfad ermittelt, indem Sie die Eigenschaft WRAPPER_SCRIPT abfragen. Das hier ist ein vollständiges Beispiel aus kdelibs/kstyles/keramik/ :

# build the executable
KDE4_ADD_EXECUTABLE(genembed RUN_UNINSTALLED ${genembed_SRCS})

# get the name of the generated wrapper script (which sets up LD_LIBRARY_PATH)
GET_TARGET_PROPERTY(GENEMBED_EXECUTABLE genembed WRAPPER_SCRIPT)

# and the custom command
ADD_CUSTOM_COMMAND(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/keramikrc.h
  COMMAND ${GENEMBED_EXECUTABLE} --file ${CMAKE_CURRENT_BINARY_DIR}/keramikPics.txt > \
  ${CMAKE_CURRENT_BINARY_DIR}/pixmaps.keramik
  DEPENDS genembed ${keramikPics}
)

Wie Sie sehen, ist genembed auch als Abhängigkeit gelistet. Das heißt, dass cmake weiß, daß es diese Datei erzeugen muss, bevor diese Regel aushgeführt wird.

Ich möchte statt der -DCMAKE_INSTALL_PREFIX Kommandozeilenoptionen lieber die KDEDIR Umgebungsvariable benutzen. Wird das von CMake unterstützt?

Nein. $KDEDIR ist in KDE4 veraltet.

Warum bekomme ich Compilerfehler wie /usr/lib/qt4/include/QtCore/qstring.h:536: undefined reference to `QString::fromLatin1_helper(char const*, int)'?

A: Wenn Sie eine alte Qt4 Version im qt/lib Verzeichnis installiert haben, müssen die alten (4.0.1) Dateien gelöscht werden.

Wie kann ich cmake anweisen, mehr Makefiles mit mehr Ausgaben zu erzeugen. Ich möchte genau sehen, welche Kommandos während des Make-Prozesses ausgeführt werden

Übergeben Sie einfach die VERBOSE Variable zu make, z.B.

% make VERBOSE=1

oder

% VERBOSE=1 make

Nähere Informationen können dem Artikel Is there an option to produce more 'verbose' compiling? entnommen werden.

Es gibt kein 'make distclean' Ziel in den erzeugten Makefiles. Wie kann ich das Projekt einschließlich der Cache-Dateien komplett neu erzeugen?

Entfernen Sie einfach das build Verzeichnis oder den Inhalt dieses Verzeichnisses.