Cómo agregar correctamente directorios de inclusión con CMake

Hace aproximadamente un año, pregunté sobre las dependencias de encabezado en CMake .

Recientemente me di cuenta de que el problema parecía ser que CMake consideraba que esos archivos de encabezado eran externos al proyecto. Al menos, al generar un proyecto Code :: Blocks, los archivos de encabezado no aparecen dentro del proyecto (los archivos de origen sí). Por lo tanto, me parece que CMake considera que esos encabezados son externos al proyecto y no los rastrea en las dependencias.

Una búsqueda rápida en el tutorial de CMake solo señaló include_directoriesque no parece hacer lo que deseo ...

¿Cuál es la forma correcta de indicarle a CMake que un directorio en particular contiene encabezados para incluir, y que esos encabezados deben ser rastreados por el Makefile generado?

Hay que hacer dos cosas.

Primero agregue el directorio que se incluirá:

target_include_directories(test PRIVATE ${YOUR_DIRECTORY})

En caso de que esté atascado con una versión CMake muy antigua (2.8.10 o anterior) sin soporte target_include_directories, también puede usar el legado en su include_directorieslugar:

include_directories(${YOUR_DIRECTORY})

Luego, también debe agregar los archivos de encabezado a la lista de sus archivos de origen para el destino actual, por ejemplo:

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

De esta forma, los archivos de encabezado aparecerán como dependencias en el Makefile, y también, por ejemplo, en el proyecto generado de Visual Studio, si genera uno.

Cómo usar esos archivos de encabezado para varios objetivos:

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

Primero, usted le include_directories()dice a CMake que agregue el directorio -Ia la línea de comando de compilación. En segundo lugar, enumera los encabezados en su add_executable()o add_library()llamada.

Como ejemplo, si las fuentes de su proyecto están incluidas srcy necesita encabezados include, puede hacerlo así:

include_directories(include)

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

CMake es más como un lenguaje de script si lo compara con otras formas de crear Makefile (por ejemplo, make o qmake). No es tan genial como Python, pero aún así.

No existe una " forma adecuada " si se observa en varios proyectos de código abierto cómo las personas incluyen directorios. Pero hay dos formas de hacerlo.

1. Los include_directories brutos agregarán un directorio al proyecto actual y a todos los demás proyectos descendientes que agregará a través de una serie de comandos add_subdirectory . A veces la gente dice que ese enfoque es legado.

2. Una forma más elegante es con target_include_directories . Permite agregar un directorio para un proyecto / objetivo específico sin (tal vez) herencia innecesaria o choque de varios directorios de inclusión. También permita realizar incluso una configuración sutil y agregue uno de los siguientes marcadores para este comando.

PRIVADO : se usa solo para este objetivo de compilación especificado

PÚBLICO : utilícelo para el objetivo especificado y para los objetivos que se vinculan con este proyecto

INTERFAZ : úsela solo para objetivos que se vinculan con el proyecto actual

PD:

1. Ambos comandos permiten marcar un directorio como SYSTEM para dar una pista de que no es asunto suyo que los directorios especificados contengan advertencias.

2. Una respuesta similar es con otros pares de comandos target_compile_definitions / add_definitions , target_compile_options / CMAKE_C_FLAGS

Añadir include_directories("/your/path/here").

Esto será similar a llamar gcccon -I/your/path/here/opción.

Asegúrese de poner comillas dobles alrededor del camino. Otras personas no mencionaron eso y me hicieron quedar atrapado durante 2 días. Entonces, esta respuesta es para personas que son muy nuevas en CMake y están muy confundidas.

Yo tuve el mismo problema.

Mi directorio de proyectos era así:

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

Y lo que solía incluir los archivos en todas esas carpetas:

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

    add_executable(Server ${source_files})

Y funcionó totalmente.