Як правильно додати включити каталоги з CMake

Близько року тому я запитав про залежності заголовка в CMake .

Нещодавно я зрозумів, що проблема, здавалося, полягає в тому, що 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})

По-перше, ви використовуєте include_directories()для того, щоб сказати CMake, щоб додати каталог як -Iдо командного рядка компіляції. По-друге, ви перераховуєте заголовки у своєму add_executable()або add_library()зателефонуйте.

Наприклад, якщо джерела вашого проекту є src, і вам потрібні заголовки include, ви можете зробити це так:

include_directories(include)

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

CMake більше схожий на мову скрипта, якщо порівнювати його з іншими способами створення Makefile (наприклад, make або qmake). Це не дуже круто, як Python, але все ж.

Не існує такого поняття, як " правильний спосіб ", якщо в різних проектах з відкритими джерелами дивитися, як люди включають каталоги. Але це можна зробити двома способами.

1. Неочищені include_directories додадуть каталог до поточного проекту та всіх інших нащадків, які ви додасте за допомогою ряду команд add_subdirectory . Іноді люди кажуть, що такий підхід є спадщиною.

2. Більш елегантний спосіб - за допомогою target_include_directories . Це дозволяє додавати каталог для конкретного проекту / цілі без (можливо) зайвого успадкування або зіткнення різних каталогів, що включають. Дозвольте також виконати навіть тонку конфігурацію і додати один із наступних маркерів для цієї команди.

PRIVATE - використовувати лише для цієї заданої цілі збірки

PUBLIC - використовуйте її для визначеної цілі та для цілей, які пов'язують цей проект

ІНТЕРФЕЙС - використовуйте його лише для цілей, які пов'язані з поточним проектом

PS:

1. Обидві команди дозволяють позначати каталог як СИСТЕМА, щоб натякнути, що вказані каталоги будуть містити попередження не у вашому бізнесі.

2. Аналогічна відповідь - з іншими парами команд target_compile_definitions / add_definitions , target_compile_options / CMAKE_C_FLAGS

Додайте include_directories("/your/path/here").

Це буде схоже на дзвінки gccз -I/your/path/here/опцією.

Обов’язково поставте подвійні лапки навколо шляху. Інші люди не згадували про це, і це змусило мене застрягти 2 дні. Тож ця відповідь призначена для людей, які є новинкою CMake і дуже розгублені.

У мене була така ж проблема.

Мій каталог проекту був такий:

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

І що я використовував для включення файлів у всі ці папки:

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

    add_executable(Server ${source_files})

І це повністю спрацювало.