Comment ajouter correctement des répertoires d'inclusion avec CMake

Il y a environ un an, j'ai posé des questions sur les dépendances d'en-tête dans CMake .

J'ai réalisé récemment que le problème semblait être que CMake considérait ces fichiers d'en-tête comme externes au projet. Au moins, lors de la génération d'un projet Code :: Blocks, les fichiers d'en-tête n'apparaissent pas dans le projet (les fichiers source le font). Il me semble donc que CMake considère ces en-têtes comme externes au projet et ne les suit pas dans les dépendances.

Une recherche rapide dans le tutoriel CMake ne fait que pointer vers include_directoriesce qui ne semble pas faire ce que je souhaite ...

Quelle est la bonne façon de signaler à CMake qu'un répertoire particulier contient des en-têtes à inclure et que ces en-têtes doivent être suivis par le Makefile généré?

Il faut faire deux choses.

Ajoutez d'abord le répertoire à inclure:

target_include_directories(test PRIVATE ${YOUR_DIRECTORY})

Dans le cas où vous êtes bloqué avec une très ancienne version de CMake (2.8.10 ou plus ancienne) sans prise en charge de target_include_directories, vous pouvez également utiliser l'héritage à la include_directoriesplace:

include_directories(${YOUR_DIRECTORY})

Ensuite, vous devez également ajouter les fichiers d'en-tête à la liste de vos fichiers source pour la cible actuelle, par exemple:

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

De cette façon, les fichiers d'en-tête apparaîtront comme des dépendances dans le Makefile, et aussi par exemple dans le projet Visual Studio généré, si vous en générez un.

Comment utiliser ces fichiers d'en-tête pour plusieurs cibles:

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})

Tout d'abord, vous utilisez include_directories()pour dire à CMake d'ajouter le répertoire -Ià la ligne de commande de compilation. Deuxièmement, vous répertoriez les en-têtes dans votre add_executable()ou add_library()appelez.

Par exemple, si les sources de votre projet sont dedans srcet que vous avez besoin d'en-têtes include, vous pouvez le faire comme ceci:

include_directories(include)

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

CMake ressemble plus à un langage de script si on le compare avec d'autres façons de créer un Makefile (par exemple make ou qmake). Ce n'est pas très cool comme Python, mais quand même.

Il n'y a rien de tel qu'une " bonne façon " si l'on regarde dans divers projets open source comment les gens incluent les répertoires. Mais il y a deux façons de procéder.

1. Les include_directories bruts ajouteront un répertoire au projet actuel et à tous les autres projets descendants que vous ajouterez via une série de commandes add_subdirectory . Parfois, les gens disent qu'une telle approche est un héritage.

2. Une manière plus élégante est avec target_include_directories . Il permet d'ajouter un répertoire pour un projet / cible spécifique sans (peut-être) héritage inutile ni conflit de divers répertoires d'inclusion. Permet également d'effectuer une configuration même subtile et d'ajouter l'un des marqueurs suivants pour cette commande.

PRIVÉ - à utiliser uniquement pour cette cible de génération spécifiée

PUBLIC - utilisez-le pour la cible spécifiée et pour les cibles liées à ce projet

INTERFACE - utilisez-le uniquement pour les cibles liées au projet en cours

PS:

1. Les deux commandes permettent de marquer un répertoire en tant que SYSTEM pour donner un indice que ce n'est pas votre entreprise que les répertoires spécifiés contiendront des avertissements.

2. Une réponse similaire est avec d'autres paires de commandes target_compile_definitions / add_definitions , target_compile_options / CMAKE_C_FLAGS

Ajouter include_directories("/your/path/here").

Cela sera similaire à l'appel gccavec -I/your/path/here/option.

Assurez-vous de mettre des guillemets doubles autour du chemin. D'autres personnes n'ont pas mentionné cela et cela m'a fait coincé pendant 2 jours. Cette réponse s'adresse donc aux personnes qui sont très nouvelles à CMake et très confuses.

J'ai eu le même problème.

Mon répertoire de projet était comme ceci:

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

Et ce que j'avais l'habitude d'inclure les fichiers dans tous ces dossiers:

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

    add_executable(Server ${source_files})

Et cela a totalement fonctionné.