CMAKE – Wie kopiert man die Header-Datei der statischen Bibliothek richtig nach /usr/include?

Question 1

Ich steige in die CMAKE-Nutzung mit C ein und erstelle eigentlich zwei sehr kleine statische Bibliotheken.

Mein Ziel ist:

Die Bibliotheken werden kompiliert und in *.a-Dateien gelinkt. [THIS
WORKS]
Dann möchte ich diese *.a-Dateien nach /usr/local/lib kopieren [THIS ALSO WORKS]
Soweit ich über Bibliotheken weiß (sehr wenig), werden sie mit verknüpft -lnameoflib, was ein Compiler-Flag ist. OK. Ich habe meine CMakeLists.txt vorbereitet und sie kopiert tatsächlich *.a-Dateien hinein /usr/local/lib. Um sie jedoch in einem Programm verwenden zu können, muss ich auch ihre Header-Dateien hinein kopieren /usr/local/includedann kann ich sie ganz einfach einbinden #include <mylibheader.h>. So verstehe ich das jetzt.

Und meine Frage ist: Wie kopiert man Header-Dateien mit CMAKE in den Ordner /usr/include? Ich möchte, dass es sie automatisch kopiert, wenn make install ausgeführt wird, wie es *.a-Dateien sind.

Für beide Bibliotheken habe ich eine ähnliche CMakeLists.txt:

project(programming-network)

add_library(programming-network STATIC
    send_string.c
    recv_line.c
    )

INSTALL(TARGETS programming-network
        DESTINATION "lib"
        )

Question 2

Ein besserer Weg für die neueste cmake-Version ist die Verwendung von Zielen PUBLIC_HEADER Eigenschaften.

project(myproject)

add_library(mylib some.c another.c)
set_target_properties(mylib PROPERTIES PUBLIC_HEADER "some.h;another.h")
INSTALL(TARGETS mylib 
        LIBRARY DESTINATION some/libpath
        PUBLIC_HEADER DESTINATION some/includepath
)

Einige Hinweise:

PUBLIC_HEADER

CMake-Installationsbefehl

Question 3

Auf eine viel bessere Weise werden alle Dateien kopiert, die dem Muster entsprechen, und die Verzeichnisstruktur beibehalten.

INSTALL (
    DIRECTORY ${CMAKE_SOURCE_DIR}/include/
    DESTINATION include
    FILES_MATCHING PATTERN "*.h*")

Question 4

Ich glaube nicht, dass deine Lösung die richtige ist. /usr/include sollte für Ihren Anbieter reserviert sein, um Dateien einzufügen.

Das Richtige ist meiner Meinung nach, den Header zu installieren /usr/local/include und dann den Benutzer anweisen export CPATH="/usr/local/include:${CPATH}".

Es scheint /usr/local/lib wurde automatisch gesucht, aber wenn Sie ein anderes Verzeichnis verwenden möchten export LIBRARY_PATH="/usr/local/lib:${LIBRARY_PATH}" funktioniert ähnlich für die .a-Binärdatei (kann aber je nach Betriebssystem für gemeinsam genutzte Bibliotheken gut funktionieren oder nicht).

Optional, aber umständlicher hinzuzufügen -I /usr/local/include und -L /usr/local/lib beim Kompilieren.

Dies ist eine etwas subjektive Antwort, aber sie hat für mich gut funktioniert.

Question 5

Jahre später, mit CMake 3.23, können wir FILE_SET für öffentliche Header verwenden:

project(programming-network)

add_library(programming-network STATIC)

target_include_directories(programming-network PRIVATE "${PROJECT_SOURCE_DIR}")

target_sources(programming-network 
    PRIVATE send_string.c recv_line.c
    PUBLIC FILE_SET HEADERS 
    BASE_DIRS ${PROJECT_SOURCE_DIR}
    FILES publicheader1.h publicheader2.h)

install(TARGETS programming-network FILE_SET HEADERS)

Sehen wir uns nun an, was diese Befehle bewirken:

add_library(): definiert den Namen des Ziels, STATIC für eine statische Bibliothek, SHARED für eine gemeinsame Bibliothek, OBJECT für Objekte.
target_include_directories(): Diese Zeile hier ist nur dann, wenn Sie Unterverzeichnisse und private Header haben, die sich relativ zum Projektverzeichnis gegenseitig referenzieren. Im Allgemeinen wird dieser Befehl jedoch zum Einfügen externer Header in ein Projekt verwendet.

target_sources(): Dieser Befehl wird verwendet, um Definitionsdateien und private Header hinzuzufügen PRIVATE Stichwort. Außerdem wird es verwendet, um öffentliche Header über hinzuzufügen FILE_SET Stichwort. BASE_DIRS besteht darin, den absoluten Pfad öffentlicher Header in einen relativen Pfad umzuwandeln, indem das Basisverzeichnis von ihrem Pfad abgezogen wird. Also dieser öffentliche Header

/home/someuser/programming-network/sub1/publicheader1.h

mit Basisverzeichnis von

/home/someuser/programming-network/

wird eingebaut

/cmake/install/prefix/include/sub1/publicheader.h

Notiz target_sources() kann verwendet werden CMakeLists.txt auch von Unterverzeichnissen.

install(): soll Binärdateien, statische/gemeinsam genutzte Bibliotheken und öffentliche Header installieren. Die standardmäßigen Installationsunterverzeichnisse sind bin, lib und include. Das kannst du auch so ändern

install(TARGETS myTarget
        # for executables and dll on Win
        RUNTIME DESTINATION bin
        # shared libraries
        LIBRARY DESTINATION lib
        # for static libraries
        ARCHIVE DESTINATION lib
        # public headers
        INCLUDES DESTINATION include)

Und schließlich wird das Projekt gebaut und installiert mit (für Multikonfigurationsgeneratoren: MS Visual C++, Xcode)

# in project directory
mkdir build
cd build
cmake ..
cmake --build . --config Release
cmake --install . --prefix "/usr/local/" --config Release

Für Generatoren mit einer Konfiguration (Marke, Ninja) lassen Sie das obige weg --config Release Bedingungen und Änderungen cmake .. zu cmake -DCMAKE_BUILD_TYPE=Release ...

Question 6

Zusätzlich zu der akzeptierten Antwort, wenn Sie viele Bibliotheken erstellen und die set_property Syntax wirft Sie ab. Sie könnten es in ein sehr einfaches Makro packen, wie zum Beispiel:

# File: target_public_headers.cmake
macro(target_public_headers TARGET)
  set_target_properties(${TARGET} PROPERTIES PUBLIC_HEADER "${ARGN}")
endmacro()

Dann können Sie es wie folgt verwenden:

project(myproject)

include(target_public_headers)

add_library(mylib some.c another.c)
target_public_headers(mylib some.h another.h) # <<<<<

# If you're exporting this library then you need to tell
# CMake how to include the "installed" version of the headers.
target_include_directories(mylib
  PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
  PUBLIC $<INSTALL_INTERFACE:some/includepath>
)

INSTALL(TARGETS mylib 
        LIBRARY DESTINATION some/libpath
        PUBLIC_HEADER DESTINATION some/includepath
)