So fügen Sie Include-Verzeichnisse mit CMake richtig hinzu

Vor ungefähr einem Jahr habe ich nach Header-Abhängigkeiten in CMake gefragt .

Ich habe kürzlich festgestellt, dass das Problem darin zu bestehen schien, dass CMake diese Header-Dateien als außerhalb des Projekts liegend ansah . Zumindest beim Generieren eines Code :: Blocks-Projekts werden die Header-Dateien nicht im Projekt angezeigt (die Quelldateien). Es scheint mir daher, dass CMake diese Header als außerhalb des Projekts liegend betrachtet und sie nicht in den Abhängigkeiten verfolgt.

Eine schnelle Suche im CMake-Tutorial zeigte nur, include_directorieswas nicht zu tun scheint, was ich wünsche ...

Was ist der richtige Weg, um CMake zu signalisieren, dass ein bestimmtes Verzeichnis zu enthaltende Header enthält und dass diese Header vom generierten Makefile verfolgt werden sollten?

Zwei Dinge müssen getan werden.

Fügen Sie zuerst das Verzeichnis hinzu, das aufgenommen werden soll:

target_include_directories(test PRIVATE ${YOUR_DIRECTORY})

Wenn Sie mit einer sehr alten CMake-Version (2.8.10 oder älter) ohne Unterstützung nicht weiterkommen target_include_directories, können Sie include_directoriesstattdessen auch das Legacy verwenden:

include_directories(${YOUR_DIRECTORY})

Dann müssen Sie auch die Header-Dateien zur Liste Ihrer Quelldateien für das aktuelle Ziel hinzufügen, zum Beispiel:

set(SOURCES file.cpp file2.cpp ${YOUR_DIRECTORY}/file1.h ${YOUR_DIRECTORY}/file2.h)
add_executable(test ${SOURCES})

Auf diese Weise werden die Header-Dateien als Abhängigkeiten im Makefile und beispielsweise auch im generierten Visual Studio-Projekt angezeigt, sofern Sie eines generieren.

So verwenden Sie diese Header-Dateien für mehrere Ziele:

set(HEADER_FILES ${YOUR_DIRECTORY}/file1.h ${YOUR_DIRECTORY}/file2.h)

add_library(mylib libsrc.cpp ${HEADER_FILES})
target_include_directories(mylib PRIVATE ${YOUR_DIRECTORY})
add_executable(myexec execfile.cpp ${HEADER_FILES})
target_include_directories(myexec PRIVATE ${YOUR_DIRECTORY})

Zunächst include_directories()weisen Sie CMake an, das Verzeichnis -Izur Kompilierungsbefehlszeile hinzuzufügen . Zweitens listen Sie die Header in Ihrem add_executable()oder add_library()Anruf auf.

Wenn sich beispielsweise die Quellen Ihres Projekts in befinden srcund Sie Header von benötigen include, können Sie dies folgendermaßen tun:

include_directories(include)

add_executable(MyExec
  src/main.c
  src/other_source.c
  include/header1.h
  include/header2.h
)

CMake ähnelt eher einer Skriptsprache, wenn es mit anderen Methoden zum Erstellen von Makefile (z. B. make oder qmake) verglichen wird. Es ist nicht sehr cool wie Python, aber trotzdem.

Es gibt keinen " richtigen Weg ", wenn man in verschiedenen OpenSource-Projekten nachschaut, wie Leute Verzeichnisse einbinden. Es gibt jedoch zwei Möglichkeiten.

1. Crude include_directories hängt ein Verzeichnis an das aktuelle Projekt und alle anderen untergeordneten Projekte an, die Sie über eine Reihe von Befehlen add_subdirectory anhängen . Manchmal sagen die Leute, dass ein solcher Ansatz ein Vermächtnis ist.

2. Ein eleganterer Weg ist mit target_include_directories . Es ermöglicht das Anhängen eines Verzeichnisses für ein bestimmtes Projekt / Ziel ohne (möglicherweise) unnötige Vererbung oder Kollision verschiedener Include-Verzeichnisse. Ermöglichen Sie auch das Durchführen einer subtilen Konfiguration und das Anhängen einer der folgenden Markierungen für diesen Befehl.

PRIVATE - Nur für dieses angegebene Build-Ziel verwenden

PUBLIC - Verwenden Sie es für ein bestimmtes Ziel und für Ziele, die mit diesem Projekt verknüpft sind

SCHNITTSTELLE - Verwenden Sie diese Option nur für Ziele, die mit dem aktuellen Projekt verknüpft sind

PS:

1. Mit beiden Befehlen können Sie ein Verzeichnis als SYSTEM markieren, um einen Hinweis darauf zu geben, dass die angegebenen Verzeichnisse keine Warnungen enthalten.

2. Eine ähnliche Antwort gibt es mit anderen Befehlspaaren target_compile_definitions / add_definitions , target_compile_options / CMAKE_C_FLAGS

Hinzufügen include_directories("/your/path/here").

Dies ähnelt dem Aufruf gccmit -I/your/path/here/Option.

Stellen Sie sicher, dass Sie den Pfad in doppelte Anführungszeichen setzen. Andere Leute haben das nicht erwähnt und es hat mich 2 Tage lang festgefahren. Diese Antwort ist also für Leute, die CMake noch sehr neu und sehr verwirrt sind.

Ich hatte das gleiche Problem.

Mein Projektverzeichnis war wie folgt:

    --project
    ---Classes
    ----Application
    -----.h and .c files
    ----OtherFolders
    --main.cpp

Und was ich verwendet habe, um die Dateien in all diese Ordner aufzunehmen:

    file(GLOB source_files
            "*.h"
            "*.cpp"
            "Classes/*/*.cpp"
            "Classes/*/*.h"
    )

    add_executable(Server ${source_files})

Und es hat total funktioniert.