如何使用CMake正确添加包含目录 [英] How to properly add include directories with CMake

问题描述

大约一年前，我问了 CMake中的头依赖项./p>

最近我意识到问题似乎是CMake认为这些头文件是项目的外部.至少在生成Code :: Blocks项目时，头文件不会出现在项目中(源文件会出现).因此，在我看来，CMake认为这些标头是该项目的外部，并且不在依赖中跟踪它们.

在CMake教程中进行的快速搜索仅指向include_directories，这似乎并没有达到我的期望...

向CMake发信号通知特定目录包含要包含的标头，并且应由生成的Makefile跟踪这些标头的正确方法是什么?

解决方案

必须完成两件事.

首先添加要包含的目录:

target_include_directories(test PRIVATE ${YOUR_DIRECTORY})

如果您使用的是非常老的CMake版本(2.8.10或更旧版本)而又不支持target_include_directories，则也可以使用旧版include_directories:

include_directories(${YOUR_DIRECTORY})

然后，您还必须将头文件添加到当前目标的源文件列表中，例如:

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

通过这种方式，头文件将作为依赖项显示在Makefile中，如果生成的话，也将显示在所生成的Visual Studio项目中.

如何将这些头文件用于多个目标:

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

About a year ago I asked about header dependencies in CMake.

I realized recently that the issue seemed to be that CMake considered those header files to be external to the project. At least, when generating a Code::Blocks project the header files do not appear within the project (the source files do). It therefore seems to me that CMake consider those headers to be external to the project, and does not track them in the depends.

A quick search in the CMake tutorial only pointed to include_directories which does not seem to do what I wish...

What is the proper way to signal to CMake that a particular directory contains headers to be included, and that those headers should be tracked by the generated Makefile?

解决方案

Two things must be done.

First add the directory to be included:

target_include_directories(test PRIVATE ${YOUR_DIRECTORY})

In case you are stuck with a very old CMake version (2.8.10 or older) without support for target_include_directories, you can also use the legacy include_directories instead:

include_directories(${YOUR_DIRECTORY})

Then you also must add the header files to the list of your source files for the current target, for instance:

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

This way, the header files will appear as dependencies in the Makefile, and also for example in the generated Visual Studio project, if you generate one.

How to use those header files for several targets:

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

这篇关于如何使用CMake正确添加包含目录的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！