CMake - リンク

ターゲットのリンク

例えば、ライブラリAがライブラリBを必要とする時、ライブラリ間に存在し得る依存関係には、いくつかの異なる種類がある。

• PRIVATE

  プライベートな依存関係とは、ライブラリAが自身の内部実装でライブラリBを使用することを指定する。

  ライブラリAにリンクする他のものは、ライブラリBについて知る必要はない。なぜなら、ライブラリBはライブラリAの内部実装だからである。

• PUBLIC

  パブリックな依存関係とは、ライブラリAが内部でライブラリBを使用するだけでなく、そのインターフェイスでもライブラリBを使用することを指定する。

  例えば、ライブラリAで定義された関数が、ライブラリBで定義・実装された型のパラメータを少なくとも1つ持つ場合、

  ライブラリBの型を持つパラメータを提供しなければ、ライブラリAからその関数を呼び出すことができない。

• INTERFACE

  インターフェースな依存関係とは、ライブラリAを使用するために、ライブラリBの一部も使用しなければならないことを指定する。

  これは、ライブラリAが内部的にライブラリBを必要とせず、そのインターフェイスでライブラリBを使用するだけであるという点で、PUBLICとは異なる。

  
  

  add_libraryコマンドのINTERFACE形式を使用して定義されたライブラリターゲットを使用する場合に便利である。

  例えば、ヘッダファイルのみのライブラリの依存関係を表すためにターゲットを使用する場合等が挙げられる。

target_link_librariesコマンドを使用して、リンクだけではなく、依存関係を捉えることができる。

 target_link_libraries(
    <ターゲット名>
    <PRIVATE または PUBLIC または INTERFACE>
    item 1
    item 2
    # ...略
    [<PRIVATE または PUBLIC または INTERFACE>]
    item 3
    item 4
    # ...略
 )

これにより、あるライブラリが他のライブラリにどのように依存するかをプロジェクトで定義することができる。
CMakeは、この方法でリンクされたライブラリの連鎖を通して依存関係を管理する。

以下の例では、uiライブラリはPUBLICとしてcollectorライブラリとリンクされているため、myAppが直接collectorにリンクしているだけでも、そのPUBLIC関係からmyAppはuiにもリンクされる。
一方、algoライブラリとengineライブラリは、PRIVATEとしてcollectorにリンクされているため、myAppはそれらに直接リンクされるわけではない。
これらのコマンドにより、ターゲット間でtarget_link_librariesコマンドで接続された場合、コンパイラやリンカのフラグやヘッダ検索パスもターゲット間で伝達されるようになる。

 add_library(collector src1.cpp)
 add_library(algo src2.cpp)
 add_library(engine src3.cpp)
 add_library(ui src4.cpp)
 add_executable(myApp main.cpp)
 
 target_link_libraries(
   collector
   PUBLIC ui
   PRIVATE algo engine
 )
 
 target_link_libraries(myApp PRIVATE collector)

このような場合、target_link_librariesコマンドで使用するターゲット名は、
target_link_librariesコマンドが呼び出されている同じディレクトリにおいて、add_executableコマンドまたはadd_libraryコマンドにより定義されている必要がある。

非ターゲットのリンク (target_link_librariesコマンド)

target_link_librariesコマンドを呼び出す時は、常に、PRIVATE、PUBLIC、INTERFACEオプションを指定する。

target_link_librariesコマンドは、CMakeのターゲット以外にも、以下に示すものを指定することが可能である。

• ライブラリファイルへのフルパス

  CMakeはそのライブラリファイルをリンカコマンドに追加する。

  ライブラリファイルが変更された場合、CMakeはその変更を検出して、ターゲットを再リンクする。

  CMake 3.3以降では、リンカコマンドは指定されたフルパスを使用するが、CMake 3.2以前では、CMakeが代わりにライブラリを検索するようリンカに要求する場合がある。

  （例. /usr/lib/libfoo.soファイルを-lfooに置換する等）

• 単純なライブラリ名

  パスなしでライブラリ名だけを指定する場合、リンカコマンドはそのライブラリを検索する。

  （例えば、プラットフォームによって、fooは-lfoo、または、foo.libになる）

• リンクフラグ

  特殊なケースとして、-lや-framework以外のハイフンで始まる項目は、リンカコマンドに追加されるフラグとして扱われる。

  
  

  ただし、これらはPRIVATE項目にのみ使用するように警告している。

  PUBLICやINTERFACEとして定義する場合は、他のターゲットに引き継がれてしまい、必ずしも安全とは言えないからである。

上記に加え、項目の前にdebug、optimized、generalのいずれかのオプションを付加することができる。
これらのオプションは、ビルドがデバッグビルドとして設定されているかどうかに基づいて、それに続く項目が含まれるべき時をさらに絞り込むことである。
ただし、これらのオプションは、同様の機能をより明確で柔軟かつ堅牢な方法が別に存在するため、現在は使用しない方がよい。

• debugオプション

  項目の前にdebugオプションを付加する場合、そのビルドがデバッグビルドである場合にのみ追加される。

• optimizedオプション

  項目の前にoptimizedオプションを付加する場合、ビルドがデバッグビルドでない場合のみ追加される。

• generalオプション

  項目の前にgeneralオプションを付加する場合、全てのビルド構成に対して項目を追加するように指定する。

ライブラリパスの指定

ライブラリパスを指定する場合、link_directoriesコマンドを使用する。

 link_directories(/path/to/lib)

link_directoriesコマンドを複数使用する場合、デフォルトでは、指定したパスは最後尾となる。
ただし、link_directoriesコマンドにBEFOREオプションを付加した場合は最前となる。

以下の例では、"-I/path1/to/lib -I/path2/to/lib"となる。

 link_directories(/path1/to/lib)
 link_directories(/path2/to/lib)

以下の例では、"-I/path2/to/lib -I/path1/to/lib" となる。

 link_directories(/path1/to/lib)
 link_directories(BEFORE /path2/to/lib)