`cmake`から` pkg-config`を使用する適切な方法は何ですか？

Question 1

ネットを見回すと、次のようなコードがたくさん見られます。

include(FindPkgConfig)
pkg_search_module(SDL2 REQUIRED sdl2)

target_include_directories(app SYSTEM PUBLIC ${SDL2_INCLUDE_DIRS}
target_link_libraries(app ${SDL2_LIBRARIES})

ただし、インクルードディレクトリとライブラリのみを使用し、定義、ライブラリパス、およびによって返される可能性のあるその他のフラグを無視するため、これは間違った方法のようpkg-configです。

これを行い、によって返されるすべてのコンパイルフラグとリンクフラグpkg-configがコンパイル済みで使用されるようにする正しい方法は何でしょうappか？そして、これを達成するための単一のコマンド、つまり次のようなものはありtarget_use(app SDL2)ますか？

参照：

Question 2

cmakeとpkg-configをごく普通の方法で使用している場合、このソリューションは機能します。

ただし、開発ディレクトリ（/ home / me / hack / libなど）にライブラリが存在する場合は、ここに示す他の方法を使用しても、リンカーパスを構成できません。通常のインストール場所にライブラリが見つからない場合は、のようなリンカーエラーが発生します/usr/bin/ld: cannot find -lmy-hacking-library-1.0。このソリューションは、その場合のリンカーエラーを修正します。

別の問題は、pkg-configファイルが通常の場所にインストールされておらず、cmakeの実行中にPKG_CONFIG_PATH環境変数を使用してプロジェクトのpkg-configパスを追加する必要があることです（これに関する他のスタックオーバーフローの質問を参照してください）。正しいpkg-configパスが設定されていると仮定すると、このソリューションはその問題も修正します。

解決策は、動作するCMakeLists.txtのこの最終バージョンに要約されます。

cmake_minimum_required(VERSION 3.14)
project(ya-project C)

# the `pkg_check_modules` function is created with this call
find_package(PkgConfig REQUIRED) 

# these calls create special `PkgConfig::<MODULE>` variables
pkg_check_modules(MY_PKG REQUIRED IMPORTED_TARGET any-package)
pkg_check_modules(YOUR_PKG REQUIRED IMPORTED_TARGET ya-package)

add_executable(program-name file.c ya.c)

target_link_libraries(program-name PUBLIC
        PkgConfig::MY_PKG
        PkgConfig::YOUR_PKG)

target_link_librariesリンカコマンドを変更するだけではないことに注意してください。また、コンパイラフラグ、コンパイラ定義、インクルードパスなど、指定されたターゲットの他のPUBLICプロパティを伝播します。

Question 3

まず、呼び出し：

include(FindPkgConfig)

次のように置き換える必要があります。

find_package(PkgConfig)

find_package()コールは、より柔軟であり、そのようななどのオプションができますREQUIRED1が使用して手動で行う必要があろうと、自動的に物事を行います、include()。

第二に、手動で呼び出すことpkg-configは可能な限り避けるべきです。CMakeには、Linuxのの下にある豊富なパッケージ定義のセットが付属しています/usr/share/cmake-3.0/Modules/Find*cmake。これらは、への生の呼び出しよりも多くのオプションと選択肢をユーザーに提供しますpkg_search_module()。

前述の架空のtarget_use()コマンドに関しては、CMakeにはすでにPUBLIC | PRIVATE | INTERFACEの方法で組み込みがあります。以下のようなコールは、target_include_directories(mytarget PUBLIC ...)ディレクトリが自動的に使用しているすべてのターゲットで使用されるように含ませます mytarget、例えばtarget_link_libraries(myapp mytarget)。ただし、このメカニズムはCMakeLists.txtファイル内で作成されたライブラリにのみ適用されるようで、で取得されたライブラリでは機能しませんpkg_search_module()。そのために電話add_library(bar SHARED IMPORTED)が使われるかもしれませんが、私はまだそれを調べていません。

主な質問に関しては、これはほとんどの場合ここで機能します：

find_package(PkgConfig REQUIRED)
pkg_check_modules(SDL2 REQUIRED sdl2)
...
target_link_libraries(testapp ${SDL2_LIBRARIES})
target_include_directories(testapp PUBLIC ${SDL2_INCLUDE_DIRS})
target_compile_options(testapp PUBLIC ${SDL2_CFLAGS_OTHER})

SDL2_CFLAGS_OTHER定義し、成功したコンパイルに必要な他のフラグが含まれています。旗SDL2_LIBRARY_DIRSとSDL2_LDFLAGS_OTHERしかし、まだ、それが問題になる頻度は考えて無視されていません。

その他のドキュメントはこちらhttp://www.cmake.org/cmake/help/v3.0/module/FindPkgConfig.html

Question 4

SDL2とリンクするだけでよいことはめったにありません。現在人気のある回答pkg_search_module()では、特定のモジュールをチェックし、最初に機能するモジュールを使用します。

SDL2、SDL2_Mixer、SDL2_TTFなどとリンクする可能性が高くなります...pkg_check_modules()指定されたすべてのモジュールをチェックします。

# sdl2 linking variables
find_package(PkgConfig REQUIRED)
pkg_check_modules(SDL2 REQUIRED sdl2 SDL2_ttf SDL2_mixer SDL2_image)

# your app
file(GLOB SRC "my_app/*.c")
add_executable(my_app ${SRC})
target_link_libraries(my_app ${SDL2_LIBRARIES})
target_include_directories(my_app PUBLIC ${SDL2_INCLUDE_DIRS})
target_compile_options(my_app PUBLIC ${SDL2_CFLAGS_OTHER})

免責事項：stackoverflowで十分なストリートクレジットがあれば、Grumbelの自己回答についてコメントしただけです。

Question 5

利用可能な回答のほとんどは、pkg-configライブラリのヘッダーを構成できません。FindPkgConfigのドキュメントについて瞑想した後、私はそれらも提供するソリューションを思いつきました。

include(FindPkgConfig)
if(NOT PKG_CONFIG_FOUND)
  message(FATAL_ERROR "pkg-config not found!" )
endif()
 
pkg_check_modules(<some-lib> REQUIRED IMPORTED_TARGET <some-lib>)
 
target_link_libraries(<my-target> PkgConfig::<some-lib>)

（それに応じて、の代わりにターゲットを、代わりに<my-target>任意のライブラリを使用してください<some-lib>。）

このIMPORTED_TARGETオプションは重要なようで、PkgConfig::名前空間の下ですべてを利用できるようにします。これは必要とされたものをすべてだったし、また、すべてのことがなければならない必要になること。

Question 6

のようなコマンドはありませんtarget_use。しかし、私はそれらの内部使用のためにそのようなコマンドを書いたいくつかのプロジェクトを知っています。しかし、すべてのプロジェクトは追加のフラグまたは定義を渡したいので、一般的にCMakeを使用することは意味がありません。それを持たないもう1つの理由は、EigenのようなC ++テンプレートライブラリです。ライブラリはありませんが、インクルードファイルはたくさんあります。
説明されている方法はしばしば正しいです。ライブラリによっては異なる場合があります。その場合は、_LDFLAGSまたはを追加する必要があり_CFLAGSます。がないもう1つの理由target_use。それがうまくいかない場合は、SDL2または使用したいライブラリに固有の新しい質問をしてください。

Question 7

ライブラリから定義を追加することも検討している場合は、そのためのadd_definitions手順があります。ドキュメントはここにあります、コンパイラフラグを追加するその他の方法とともに、にあります。

次のコードスニペットは、この命令を使用してGTKGLをプロジェクトに追加します。

pkg_check_modules(GTKGL REQUIRED gtkglext-1.0)
include_directories(${GTKGL_INCLUDE_DIRS})
link_directories(${GTKGL_LIBRARY_DIRS})
add_definitions(${GTKGL_CFLAGS_OTHER})
set(LIBS ${LIBS} ${GTKGL_LIBRARIES})

target_link_libraries([insert name of program] ${LIBS})