Jak poprawnie dodać dołączone katalogi za pomocą CMake

Około rok temu zapytałem o zależności nagłówka w CMake .

Ostatnio zdałem sobie sprawę, że wydaje się, że problem polega na tym, że CMake uznał te pliki nagłówkowe za zewnętrzne dla projektu. Przynajmniej podczas generowania projektu Code :: Blocks pliki nagłówkowe nie pojawiają się w projekcie (tak jak pliki źródłowe). Dlatego wydaje mi się, że CMake uważa te nagłówki za zewnętrzne dla projektu i nie śledzi ich w zależności.

Szybkie wyszukiwanie w samouczku CMake wskazało tylko, include_directoriesktóre nie wydają się robić tego, co chciałbym ...

Jaki jest właściwy sposób zasygnalizowania CMake, że określony katalog zawiera nagłówki, które należy uwzględnić, i że nagłówki te powinny być śledzone przez wygenerowany plik Makefile?

Dwie rzeczy muszą być zrobione.

Najpierw dodaj katalog, który chcesz dołączyć:

target_include_directories(test PRIVATE ${YOUR_DIRECTORY})

Jeśli utkniesz z bardzo starą wersją CMake (2.8.10 lub starszą) bez wsparcia target_include_directories, możesz również użyć starszej wersji include_directories:

include_directories(${YOUR_DIRECTORY})

Następnie musisz również dodać pliki nagłówkowe do listy plików źródłowych dla bieżącego celu, na przykład:

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

W ten sposób pliki nagłówkowe pojawią się jako zależności w pliku Makefile, a także na przykład w wygenerowanym projekcie Visual Studio, jeśli go wygenerujesz.

Jak korzystać z tych plików nagłówkowych dla kilku celów:

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

Po pierwsze, include_directories()mówisz CMake, aby dodała katalog -Ido wiersza poleceń kompilacji. Po drugie, wypisujesz nagłówki w swoim add_executable()lub add_library()wywołaniu.

Na przykład, jeśli źródła twojego projektu są włączone srci potrzebujesz nagłówków z include, możesz to zrobić w następujący sposób:

include_directories(include)

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

CMake jest bardziej jak język skryptowy, jeśli porównuje się go z innymi sposobami tworzenia Makefile (np. Make lub qmake). Nie jest tak fajny jak Python, ale nadal.

Nie ma czegoś takiego jak „ właściwy sposób ”, jeśli w różnych projektach typu open source ludzie uwzględniają katalogi. Ale są na to dwa sposoby.

1. Surowe katalog_włączenia doda katalog do bieżącego projektu i wszystkich innych projektów potomnych, które dodasz za pomocą szeregu poleceń add_subdirectory . Czasami ludzie mówią, że takie podejście jest dziedzictwem.

2. Bardziej elegancki jest sposób z target_include_directories . Pozwala dołączyć katalog do konkretnego projektu / celu bez (być może) niepotrzebnego dziedziczenia lub kolizji różnych katalogów dołączanych. Pozwól także na wykonanie nawet subtelnej konfiguracji i dodaj jeden z następujących znaczników do tego polecenia.

PRYWATNE - użyj tylko dla tego określonego celu kompilacji

PUBLICZNY - użyj go dla określonego celu i celów, które łączą się z tym projektem

BERŁO - używaj go tylko do celów, które łączą się z bieżącym projektem

PS:

1. Obie komendy pozwalają oznaczyć katalog jako SYSTEM, dając do zrozumienia, że ​​to nie twoja firma zawiera określone ostrzeżenia.

2. Podobna odpowiedź jest z innymi parami poleceń target_compile_definitions / add_definitions , target_compile_options / CMAKE_C_FLAGS

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

Będzie to podobne do dzwonienia gccz -I/your/path/here/opcją.

Upewnij się, że umieściłeś podwójne cudzysłowy wokół ścieżki. Inni o tym nie wspominali i utknąłem na 2 dni. Ta odpowiedź jest więc dla osób, które są nowe w CMake i bardzo zdezorientowane.

Miałem ten sam problem.

Mój katalog projektów wyglądał tak:

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

I to, co zwykłem umieszczać pliki we wszystkich tych folderach:

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

    add_executable(Server ${source_files})

I to całkowicie zadziałało.