Właściwy sposób na skonstruowanie mojego projektu C++ za pomocą cmake?

Question

Od pewnego czasu borykam się z tym problemem, a moje przygody z cmake doprowadziły tylko do hackowych rozwiązań, które jestem prawie pewien, że nie są poprawne.

stworzyłem bibliotekę, która składa się z kilku plików, co następuje:

-libfolder 
    -codepart1folder 
    -CMakeLists.txt 
    -codepart1.cpp 
    -codepart1.hpp 
    -codepart2folder 
    -codepart3folder 
    -lib.cpp 
    -lib.hpp 
    -CMakeLists.txt 

pisałem plik CMakeLists skompilować bibliotekę (po pewnym eksperymentów) i mogę wygenerować plik lib.a. Teraz chciałbym włączyć ten kod jako bibliotekę w innych projektach i uzyskać do niej dostęp poprzez interfejs w lib.hpp. Jaki jest najlepszy sposób, aby to zrobić, jeśli chodzi o strukturę katalogów i co muszę umieścić w CMakeLists.txt w moim głównym projekcie?

Moja obecna próba została dodać -libfolder jako podfolder do mojego obecnego projektu i dodać komendy:

include_directories(${PROJECT_SOURCE_DIR}/libfolder) 
link_directories(${PROJECT_BINARY_DIR}/libfolder) 
add_subdirectory(libfolder) 
target_link_libraries(project lib) 

Kiedy biegnę zrobić, biblioteka kompiluje grzywny, ale gdy project.cpp kompiluje, narzeka, że ​​nie może znaleźć codepart1.hpp (który jest zawarty w lib.hpp, dołączony z project.cpp).

Podejrzewam, że jest to niewłaściwy sposób, ale nie mogę przejrzeć dokumentacji CMake i znaleźć dobrego samouczka na temat tworzenia takich projektów. Proszę o pomoc, guru CMake!

Answer 1

Ok, więc po konsultacji współpracownika kopalni, który jest guru CUpewnij wydaje CMake nie ma wsparcia, co próbuję zrobić, pozostawiając jedną z 3 opcji:

1. Dodaj wszystko zależności do nadrzędnych projektów CMakeLists.txt - niezbyt czyste, ale to sprawi, że wszystko będzie działać. Będziesz musiał to zrobić dla każdego projektu, do którego dodasz kod, i wrócić i naprawić rzeczy, jeśli zmieni się twoja biblioteka.

2. posprzątać nagłówki biblioteki. Odbywa się to za pomocą jakiegoś hackery kompilatora. Chodzi o to, aby forwardować - deklarować każdą klasę i używać tylko wskaźników lub boost :: shared_ptr, a następnie włączać zależności tylko w pliku cpp. W ten sposób możesz zbudować plik cpp przy użyciu wszystkich rzeczy pakietu findpackage, a otrzymasz premię z możliwości korzystania z biblioteki, włączając tylko nagłówek i link do biblioteki.

3. Zajrzyj do systemów kompilacji. Posiadanie przenośnego kodu i szybka kompilacja kodu ze złożonymi zależnościami nie rozwiązuje problemu! Z moich badań okazało się dość skomplikowane. Skończyłem na przyjęciu mojego systemu budowania współpracowników, który sam stworzył w cmake, wykorzystując rzeczy, które wziął od Google.

Answer 2

Oczywistym sposobem importowania jednego projektu CMake do innego jest wykonanie polecenia find_package. Deklarację pakietu wykonuje się przy użyciu polecenia export. Zaletą korzystania z find_package jest to, że eliminuje potrzebę stosowania ścieżek o twardym kodowaniu do plików pakietu.

Jeśli chodzi o brakujący plik hpp, nie uwzględniono pliku kodepartu1, więc nie ma go na ścieżce dołączania.

Answer 3

Patrząc na swój wpis, nie wydaje się dodawać "codepart1folder" do załączników w dowolnym miejscu. Jak się pan tym codepart1.hpp jak:

#include <codepart1.hpp> 
#include "codepart1folder/codepart1.hpp" 

nie sądzę jest standardem przyjętym sposobem strukturyzacji projektów CUpewnij. Spojrzałem na kilka repo CMU i mają tendencję do różnic. Osobiście wykonać następujące czynności:

-project 
    CMakeLists.txt 
    -build 
    -cmake 
     OptionalCmakeModule.cmake 
    -src 
     -Main 
      Main.cpp 
      Main.hpp 
     -DataStructs 
      SomeTree.hpp 
      SomeObject.hpp 
     -Debug 
      Debug.hpp 
     -UI 
      Window.hpp 
      Window.cpp 

Zasadniczo że wysypisk cały kod źródłowy do 1 katalogu, a następnie wykonują z źródła zbudować z: "mkdir budować & & cd budować & & cmake .. & & markę "w folderze głównym projektów.

Jeśli masz oddzielne biblioteki jako część swojego projektu, możesz potrzebować oddzielnego katalogu libs z innym podfolderem dla konkretnej biblioteki.

Mam kilka moich repozytoriów: https://github.com/dcbishop/, jeśli chcesz przejrzeć pliki CMakeLists.txt.

Główne problemy z moim struktury projektu jest to, że używam FILE_GLOB który jest pozornie „niewłaściwy” sposób zrobić rzeczy (jeśli dodać pliki po uruchomieniu „cmake ..” wtedy nie będzie podniósł do zrobienia "make").Nie doszedłem do wniosku, że "właściwy" sposób to zrobić (z tego co widzę wymaga oddzielnej listy plików) Używam tylko 1 pliku CMakeLists.txt.

Niektóre projekty również wybierają oddzielenie swoich plików cpp i hpp w oddzielne katalogi. Więc będziesz miał foldery include i src (przynajmniej dla plików hpp, które mają być używane zewnętrznie). Myślę, że dotyczyłoby to głównie projektów, które są głównie dużymi bibliotekami. Czyni też znacznie łatwiejsze instalowanie plików nagłówkowych.

Answer 4

Prawdopodobnie brakuje

include_directories(${PROJECT_SOURCE_DIR}/libfolder/codepart1folder) 

W takim przypadku warto set(CMAKE_INCLUDE_CURRENT_DIR on) dodać wszystkie foldery do zmiennej zawierać ścieżkę katalogu.

Sprawdź dane wyjściowe cmake w wierszu poleceń, czy ustawione są właściwe foldery dołączania. Dodatkowo zawsze możesz użyć message() jako "debugowania drukowania" dla zmiennych cmake. W przypadku katalogów dołączania należy jednak przeczytać właściwość katalogu, aby zobaczyć, co faktycznie znajduje się w katalogach uwzględniania.

get_property(inc_dirs DIRECTORY PROPERTY INCLUDE_DIRECTORIES) 
message("inc_dirs = ${inc_dirs}") 

Mam nadzieję, że pomoże to w ustaleniu, czego brakuje.

Edit

Właśnie widziałem komentarz o dodanej codepart1folder w libfolder. Jest dostępny tylko w ścieżce include_directory folderu libfolder i nie jest propagowany do folderu głównego. Ponieważ plik include codepart1.hpp znajduje się w bibliotece lib.hpp, ale musisz mieć go również dostępny w ścieżce projektu, w przeciwnym razie podczas tworzenia projektu otrzymasz błąd braku deklaracji.