MochiuWiki : SUSE, EC, PCB

「Qtの設定 - CMake」の版間の差分

📢 Webサイト閉鎖と移転のお知らせ
このWebサイトは2026年9月に閉鎖いたします。
新しい記事は移転先で追加しております。（旧サイトでは記事を追加しておりません）

← 古い編集
ビジュアルウィキテキスト
細 文字列「__FORCETOC__」を「{{#seo: |title={{PAGENAME}} : Exploring Electronics and SUSE Linux | MochiuWiki |keywords=MochiuWiki,Mochiu,Wiki,Mochiu Wiki,Electric Circuit,Electric,pcb,Mathematics,AVR,TI,STMicro,AVR,ATmega,MSP430,STM,Arduino,Xilinx,FPGA,Verilog,HDL,PinePhone,Pine Phone,Raspberry,Raspberry Pi,C,C++,C#,Qt,Qml,MFC,Shell,Bash,Zsh,Fish,SUSE,SLE,Suse Enterprise,Suse Linux,openSUSE,open SUSE,Leap,Linux,uCLnux,Podman,電気回路,電子回路,基板,プリント基板 |description={{PAGENAME}} - 電子回路とSUSE Linuxに関する情報 | This pag…
 
(同じ利用者による、間の36版が非表示)
23行目: 23行目:


== 非推奨のコマンドおよび設定 ==
== 非推奨のコマンドおよび設定 ==
==== 非推奨のコマンド ====
* include_directoriesコマンド
* include_directories
*: 指定したディレクトリからヘッダファイルを検索するコマンドである。
*: 指定したディレクトリからヘッダファイルを検索するコマンドである。
*: 定義した箇所以降の全てのターゲットが指定したディレクトリをインクルードするため、使用は避けるべきである。
*: 定義した箇所以降の全てのターゲットが指定したディレクトリをインクルードするため、使用は避けるべきである。
* add_definitions
*: 代わりに、<code>target_include_directories</code>コマンドを使用する必要がある。
* add_compile_definitions
* add_compile_options
* link_directories
* link_libraries
<br><br>
 
== CMakeのバージョン管理 (cmake_minimum_requiredコマンド) ==
CMakeは、新しいツールやプラットフォーム、機能のサポートを追加するために継続的に更新および拡張されている。<br>
開発者は、新しいリリースごとに後方互換性を維持することに非常に注意を払うことになる。<br>
そのため、ユーザがCMakeの新しいバージョンに更新した時、プロジェクトは以前と同じようにビルドし続けることができる。<br>
<br>
<br>
時には、CMakeの特定の動作を変更する必要があったり、より厳しいチェックや警告が新しいバージョンで導入されたりすることがある。<br>
* add_definitionsコマンド
全てのプロジェクトに直ちにこのような対応を要求するのではなく、CMakeは、プロジェクトが"CMakeのバージョン X.Y.Zのように振る舞う"というようなポリシー機構を提供する。<br>
** プロジェクト全体に影響を与えてしまう。
** ビルド依存性の管理が難しくなる。
** コンパイラの最適化を阻害する可能性がある。
*: 代わりに、<code>target_compile_definitions</code>コマンドを使用する必要がある。
<br>
<br>
CMakeのバージョン動作の詳細を指定する主な方法は、<code>cmake_minimum_required</code>コマンドを使用することである。<br>
* add_compile_definitionsコマンド
これは、CMakeLists.txtファイルの最初の行で記述するべきであり、プロジェクトの要件が他の何よりも先にチェックされ、確立されるようにするものである。<br>
** プロジェクト全体への影響
<code>cmake_minimum_required</code>コマンドは、以下に示す2つのことを実行する。<br>
**: プロジェクト内の全てのターゲットに対して定義を追加される。
* プロジェクトが必要とするCMakeの最小バージョンを指定する。<br>CMakeLists.txtファイルが指定されたバージョンより古いCMakeのバージョンで処理された場合、エラーが発生して直ちに停止する。<br>これにより、処理を進める前に、CMakeの機能の特定の最小セットが利用可能であることが保証される。
**: これにより、意図しないターゲットにまで定義が設定されてしまう可能性がある。
* CMakeの動作を指定されたバージョンに一致させるためのポリシー設定を強制するものである。
** ビルド依存性の管理が難しくなる
**: 特定のターゲットにのみ必要な定義がプロジェクト全体に設定されると、ビルド依存性の管理が複雑になる。
** コンパイラの最適化への影響
**: 不要な定義が設定されると、コンパイラの最適化が阻害される可能性がある。
*: 代わりに、<code>target_compile_definitions</code>コマンドを使用する必要がある。
<br>
<br>
もし、<code>cmake_minimum_required</code>コマンドを記述しなかった場合は警告を出力する。<br>
* add_compile_optionsコマンド
ほとんどのプロジェクトでは、<code>cmake_minimum_required</code>コマンドは、単に必要最小限のCMakeのバージョンを指定するものとして扱えば十分である。<br>
*: プロジェクト全体に対してコンパイルオプションを設定してしまうため、以下に示すような問題が発生する可能性がある。
** 意図しないターゲットへの影響
**: プロジェクト内の全てのターゲットに対してコンパイルオプションが設定されるため、意図しないターゲットにも影響を及ぼす。
** ビルド依存性の管理が難しくなる
**: 特定のターゲットにのみ必要なコンパイルオプションがプロジェクト全体に設定されると、ビルド依存性の管理が複雑になる。
** コンパイラの最適化への影響
**: 不要なコンパイルオプションが設定されると、コンパイラの最適化が阻害される可能性がある。
*: 代わりに、<code>target_compile_options</code>コマンドを使用する必要がある。
<br>
<br>
cmake_minimum_required(VERSION <メジャー番号>.<マイナー番号>[.<バグフィックス番号>.<ビルド番号>])
* link_directoriesコマンド
*: プロジェクト内の全てのターゲットに対してリンクディレクトリを追加するため、以下に示すような問題が発生する可能性がある。
** プロジェクト全体への影響
**: 意図しないターゲットにもリンクディレクトリが設定される可能性がある。
** ビルド依存性の管理が難しくなる
**: 特定のターゲットにのみ必要なリンクディレクトリがプロジェクト全体に設定されると、ビルド依存性の管理が複雑になる。
** リンク順序の問題
**: このコマンドで追加したディレクトリは、自動的にコマンドラインのリンカ引数の最後に追加される。
**: これにより、リンク順序に関する問題が発生する可能性がある。
*: 代わりに、<code>target_link_libraries</code>コマンドを使用する必要がある。
<br>
<br>
<code>VERSION</code>オプションは常に必要であり、<code><メジャー番号></code>および<code><マイナー番号></code>も記述する必要がある。<br>
* link_librariesコマンド
ほとんどのCMakeプロジェクトでは、<code><バグフィックス番号></code>および<code><ビルド番号></code>を指定する必要はない。(CMakeの新しい機能はマイナー番号のアップデートでのみ現れるため)<br>
*: プロジェクト内の全てのターゲットに対してリンクライブラリを追加するため、以下に示すような問題が発生する可能性がある。
特定のバグフィックスが必要な場合のみ、<code><バグフィックス番号></code>を指定すべきである。
** プロジェクト全体への影響
**: 意図しないターゲットにもリンクライブラリが設定される可能性がある。
** ビルド依存性の管理が難しくなる
**: 例えば、特定のターゲットにのみ必要なライブラリがプロジェクト全体にリンクされると、ビルド依存性の管理が複雑になる。
** リンク順序の問題
**: このコマンドで追加したライブラリは、自動的にコマンドラインのリンカ引数の最後に追加される。
**: これにより、リンク順序に関する問題が発生する可能性がある。
*: 代わりに、<code>target_link_libraries</code>コマンドを使用する必要がある。
<br>
<br>
さらに、CMake 3.0以降では、<code><ビルド番号></code>を使用していないため、指定する必要はない。<br>
* キャッシュ変数には、必ず接頭辞を付加する
*: キャッシュ変数はグローバル変数であるため、名前の衝突を避けるために接頭辞を付加する。
<br>
<br>
詳細を知りたい場合は、[[Qtの設定 - CMake#CMakeのポリシー設定]]において、<code>cmake_minimum_required</code>コマンドの挙動を調整する方法を参照すること。<br>
* 変数CMAKE_<LANG>_FLAGS
これにより、CMakeは内部でバグを修正し、新しい機能を導入しながらも、過去の特定のリリースの期待される振る舞いを維持することができる。<br>
*: 代わりに、<code>target_compile_options</code>を使用する。
<br><br>
*: <code>target_compile_options(<ターゲット名> PUBLIC -Wall)</code>
 
== projectコマンド ==
全てのCMakeプロジェクトは、<code>project</code>コマンドを含む必要があり、<code>cmake_minimum_required</code>コマンドの後に記述する。<br>
<syntaxhighlight lang="cmake">
# CMake 3.0以降
project(
    <プロジェクト名>
   [VERSION <メジャー番号>[.<マイナー番号>.<バグフィックス番号>.<ビルド番号>]]
   [LANGUAGES <プログラム言語名  例. CやCXX等>]
)
# CMake 2.x以前
project(
    <プロジェクト名>
    [<プログラム言語名  例. CやCXX等>]
)
</syntaxhighlight>
<br>
<code><プロジェクト名></code>オプションは必須であり、英数字、アンダースコア(<code>_</code>)、ハイフン(<code>-</code>)が使用できる。<br>
ただし、空白は使用できない。<br>
<code><プロジェクト名></code>は、引用符で囲む必要はない。<br>
<br>
<code>VERSION</code>オプションは、CMake 3.0以降でのみサポートされている。<br>
<br>
<br>
<code>LANGUAGES</code>オプションは、CMakeプロジェクトで有効にするプログラム言語を指定する。(<code>C</code>、<code>CXX</code>、<code>Fortran</code>、<code>ASM</code>、<code>Java</code>等)<br>
* 変数<code>CMAKE_CXX_FLAGS</code>や<code>target_compile_options</code>コマンドに、<code>-std=c++17</code>等を指定しない。
複数の言語を指定する場合は、それぞれをスペースで区切る。<br>
*: 変数<code>CMAKE_CXX_STANDARD</code>を使用する（CMake 3.1以降）、または、<code>target_compile_features</code>コマンドに<code>cxx_std_17</code>を指定する。（CMake 3.8以降）
<br>
<br>
特殊な状況下では、CMakeプロジェクトはプログラム言語を使用しないことを示す必要がある場合が存在する。<br>
* 変数CMAKE_SOURCE_DIRを使用しない
このような場合、<code>LANGUAGES NONE</code>を指定する。
*: 変数<code>CMAKE_SOURCE_DIR</code>は、トップレベルのディレクトリを指す。
*: 異なるプロジェクトがネストしている場合、自身のプロジェクトのルートディレクトリ以外のパスを指すため、使用すべきでない。
*: 代わりに、変数<code>CMAKE_CURRENT_SOURCE_DIR</code>、変数<code>PROJECT_SOURCE_DIR</code>、変数<code><プロジェクト名>_SOURCE_DIR</code>を使用する。
<br>
<br>
CMake 2.x以前では、<code>LANGUAGES</code>オプションがサポートされていないため、<code><プロジェクト名></code>の後にプログラム言語を指定する。<br>
* macroコマンドの代わりにfunctionコマンドを使用する
*: <code>function</code>コマンドは、関数を定義するためのコマンドである。
*: <code>macro</code>コマンドは、呼び出す側のスコープにある変数を上書きするため、自身のスコープを持つ<code>function</code>コマンドを使用する。
*: 親ディレクトリのスコープにある変数を上書きする場合は、<code>set(<変数名> <値> ... PARENT_SCOPE)</code>コマンドを使用する。
<br>
<br>
<code>project</code>コマンドの重要な役割の1つは、有効化された各言語のコンパイラをチェックして、正常にコンパイルとリンクを行えるかどうかを確認することである。<br>
* file(GLOB)コマンド
コンパイラやリンカのチェックが正常に終了した後、その結果はキャッシュされて、ビルドディレクトリのCMakeCache.txtファイルに保存される。<br>
*: <code>file(GLOB)</code>コマンドは、CMakeを実行するたびに条件に合致するファイルのリストを自動的に作成するコマンドである。
その後、CMakeは有効化された機能を制御する多くの変数とプロパティをセットアップする。<br>
*: ただし、特定のIDEでは正常に動作しない可能性があるため、コマンドラインから実行するような場合ではない限り使用すべきではない。
<br><br>
*: IDEで使用する場合は、CMakeLists.txtファイルに<code>add_subdirectory</code>コマンドと<code>target_sources</code>コマンドを使用して、再帰的にファイルを明示して追加する。
 
== 実行ファイルの構築 (add_executableコマンド) ==
<code>add_executable</code>コマンドは、CMakeにソースファイルのセットから実行ファイルを作成する。<br>
  <syntaxhighlight lang="cmake">
  <syntaxhighlight lang="cmake">
  add_executable(
  # CMakeLists.txtファイル
    <ターゲット名>
    <ソースコードファイル名 1>
    <ソースコードファイル名 2>
    # ...略
)
   
   
  # 例. myAppまたはmyApp.exeという名前の実行ファイルが生成される
  add_executable(<ターゲット名>)
  add_executable(
  add_subdirectory(<ディレクトリ名1>)
    myApp
add_subdirectory(<ディレクトリ名2>)
    main.cpp
  # 同様に子ディレクトリを追加する
  )
  </syntaxhighlight>
  </syntaxhighlight>
<br>
<code><ターゲット名></code>には、英数字、アンダースコア、ハイフンを使用することができる。<br>
CMakeプロジェクトのビルドが正常に終了すると、<code><ターゲット名></code>として実行ファイルが作成される。<br>
<br>
ターゲット名は、CMakeの機能であるターゲットプロパティでカスタマイズすることもできる。<Br>
また、ターゲット名を変更して、<code>add_executable</code>コマンドを複数回呼び出すことにより、1つのCMakeLists.txtファイル内で複数の実行ファイルを定義することができる。<br>
<br>
ただし、同じターゲット名を複数の<code>add_executable</code>コマンドで使用する場合は、CMakeは失敗してエラーがハイライトされる。<br>
<br>
<br>
  <syntaxhighlight lang="cmake">
  <syntaxhighlight lang="cmake">
  # CMakeプロジェクトの例
  # <ディレクトリ名1>/CMakeLists.txtファイル
cmake_minimum_required(VERSION 3.2)
# C++コンパイラは未使用とするため、プラットフォームが持っていない場合に備えて、projectコマンドで使用されないように指定する
project(MyApp VERSION 4.7.2 LANGUAGES C)
   
   
  # メインの実行ファイルを生成
  # CMake 3.12以前
  add_executable(
  target_sources(<ターゲット名> PRIVATE
     mainTool
     ${CMAKE_CURRENT_SOURCE_DIR}/file1.cpp
   main.c
    ${CMAKE_CURRENT_SOURCE_DIR}/file2.cpp
   debug.c # リリースビルドのために最適化される
    # 絶対パスで指定しないとエラーになるため注意すること
  )
  )
   
   
  # サブの実行ファイルの生成
  # CMake 3.13以降
add_executable(
  cmake_policy(SET CMP0076 NEW)  # CMakeが自動的に相対パスを絶対パスへ変換する
    testTool
  target_sources(<ターゲット名> PRIVATE
    testTool.c
     file1.cpp
)
     file2.cpp
  </syntaxhighlight>
<br><br>
 
== ライブラリの構築 (add_libraryコマンド) ==
CMakeは様々な種類のライブラリのビルドをサポートしている。<br>
ライブラリを作成して使用する場合、<code>add_library</code>コマンドを使用する。<br>
  <syntaxhighlight lang="cmake">
add_library(
    <ターゲット名>
    [<STATIC または SHARED または MODULE>]
    [EXCLUDE_FROM_ALL]
    <ソースコードファイル名 1>
    <ソースコードファイル名 2>
    # ...略
)
</syntaxhighlight>
<br>
<code><ターゲット名></code>は、CMakeLists.txtファイル内でライブラリを参照するために使用される。<br>
ビルドされたライブラリ名は、<code><ターゲット名></code>となる。<br>
<br>
<code>EXCLUDE_FROM_ALL</code>オプションは、<code>add_executable</code>コマンドと同様、ライブラリがデフォルトのALLターゲットに含まれないようにする。<br>
構築するライブラリの種類は、<code>STATIC</code>、<code>SHARED</code>、<code>MODULE</code>のうちの1つを指定する。<br>
<br>
* STATICオプション
*: 静的ライブラリまたはアーカイブを指定する。
*: Windowsでは、デフォルトのライブラリ名は、<u><ライブラリファイル名>.lib</u>となる。
*: Linuxでは、デフォルトのライブラリ名は、<u>lib<ライブラリファイル名>.a</u>となる。
* SHARED
*: 共有ライブラリまたは動的ライブラリを指定する。
*: Windowsでは、デフォルトのライブラリ名は、<u><ライブラリファイル名>.dll</u>となる。
*: Linuxでは、デフォルトのライブラリ名は、<u>lib<ライブラリファイル名>.so</u>となる。
* MODULE
*: 共有ライブラリに似ているが、ライブラリや実行ファイルに直接リンクされるのではなく、実行時に動的にロードされることを意図しているライブラリを指定する。
*: これらは、ユーザがロードするかどうかを選択できるプラグイン、または、オプションのコンポーネントである。
*: Windowsでは、DLL向けのインポートライブラリは作成されない。
<br>
よほどのことがない限り、<code>STATIC</code>または<code>SHARED</code>オプションは、それが必要であることが分かるまで付加しないことを推奨する。<br>
これにより、プロジェクト全体を通して、スタティックライブラリかダイナミックライブラリかをより柔軟に選択することができる。<br>
<br>
ビルドするライブラリの種類を定義するオプションを省略することも可能である。<br>
特定のライブラリが必要でない限り、プロジェクトファイルには指定せずに、プロジェクトの構築時に開発者が選択できるようにすることが望ましい。<br>
そのような場合、ライブラリは<code>STATIC</code>か<code>SHARED</code>のどちらかになり、変数<code>BUILD_SHARED_LIBS</code>の値により選択される。<br>
<br>
変数<code>BUILD_SHARED_LIBS</code>が<code>true</code>を代入する場合はライブラリのターゲットはダイナミックライブラリ、それ以外の場合はスタティックライブラリとなる。<br>
<code>add_library</code>コマンドを呼び出すたびに変更する必要がなく、1ヶ所に記述するだけで設定を変更することができる。<br>
ただし、<code>add_library</code>コマンドを呼び出す前に、変数<code>BUILD_SHARED_LIBS</code>を記述する必要がある。<br>
<syntaxhighlight lang="cmake">
set(BUILD_SHARED_LIBS YES)
</syntaxhighlight>
<br>
変数<code>BUILD_SHARED_LIBS</code>を設定する方法として、<code>cmake</code>コマンドに<code>-DBUILD_SHARED_LIBS</code>オプションを付加する方法がある。<br>
  cmake -DBUILD_SHARED_LIBS=YES /path/to/source
<br><br>
 
== ターゲットのリンク ==
例えば、ライブラリAがライブラリBを必要とする時、ライブラリ間に存在し得る依存関係には、いくつかの異なる種類がある。<br>
<br>
* PRIVATE
*: プライベートな依存関係とは、ライブラリAが自身の内部実装でライブラリBを使用することを指定する。
*: ライブラリAにリンクする他のものは、ライブラリBについて知る必要はない。なぜなら、ライブラリBはライブラリAの内部実装だからである。
* PUBLIC
*: パブリックな依存関係とは、ライブラリAが内部でライブラリBを使用するだけでなく、そのインターフェイスでもライブラリBを使用することを指定する。
*: 例えば、ライブラリAで定義された関数が、ライブラリBで定義・実装された型のパラメータを少なくとも1つ持つ場合、
*: ライブラリBの型を持つパラメータを提供しなければ、ライブラリAからその関数を呼び出すことができない。
* INTERFACE
*: インターフェースな依存関係とは、ライブラリAを使用するために、ライブラリBの一部も使用しなければならないことを指定する。
*: これは、ライブラリAが内部的にライブラリBを必要とせず、そのインターフェイスでライブラリBを使用するだけであるという点で、<code>PUBLIC</code>とは異なる。
*: <br>
*: <code>add_library</code>コマンドのINTERFACE形式を使用して定義されたライブラリターゲットを使用する場合に便利である。
*: 例えば、ヘッダファイルのみのライブラリの依存関係を表すためにターゲットを使用する場合等が挙げられる。
<br>
<code>target_link_libraries</code>コマンドを使用して、リンクだけではなく、依存関係を捉えることができる。<br>
<syntaxhighlight lang="cmake">
target_link_libraries(
    <ターゲット名>
    <PRIVATE または PUBLIC または INTERFACE>
    item 1
     item 2
    # ...略
    [<PRIVATE または PUBLIC または INTERFACE>]
    item 3
     item 4
    # ...略
  )
  )
  </syntaxhighlight>
  </syntaxhighlight>
<br>
<br>
これにより、あるライブラリが他のライブラリにどのように依存するかをプロジェクトで定義することができる。<br>
CMakeは、この方法でリンクされたライブラリの連鎖を通して依存関係を管理する。<br>
<br>
以下の例では、uiライブラリは<code>PUBLIC</code>としてcollectorライブラリとリンクされているため、myAppが直接collectorにリンクしているだけでも、その<code>PUBLIC</code>関係からmyAppはuiにもリンクされる。<br>
一方、algoライブラリとengineライブラリは、<code>PRIVATE</code>としてcollectorにリンクされているため、myAppはそれらに直接リンクされるわけではない。<br>
これらのコマンドにより、ターゲット間で<code>target_link_libraries</code>コマンドで接続された場合、コンパイラやリンカのフラグやヘッダ検索パスもターゲット間で伝達されるようになる。<br>
  <syntaxhighlight lang="cmake">
  <syntaxhighlight lang="cmake">
  add_library(collector src1.cpp)
  # 画像ファイルの取得 (PNG, JPG, SVG)
  add_library(algo src2.cpp)
  execute_process(
add_library(engine src3.cpp)
    COMMAND find ${CMAKE_CURRENT_SOURCE_DIR}/Image -iname "*.png" -o -iname "*.jpg" -o -iname "*.svg"
add_library(ui src4.cpp)
    OUTPUT_VARIABLE IMAGES
add_executable(myApp main.cpp)
target_link_libraries(
  collector
   PUBLIC ui
   PRIVATE algo engine
  )
  )
   
   
  target_link_libraries(myApp PRIVATE collector)
  string(REPLACE "\n" ";" IMAGE_FILES "${IMAGES}")
  </syntaxhighlight>
  </syntaxhighlight>
<br>
<br>
このような場合、<code>target_link_libraries</code>コマンドで使用するターゲット名は、<br>
* <code>PRIVATE</code>オプション、<code>PUBLIC</code>オプション、<code>INTERFACE</code>オプションを適切に使用する。
<code>target_link_libraries</code>コマンドが呼び出されている同じディレクトリにおいて、<code>add_executable</code>コマンドまたは<code>add_library</code>コマンドにより定義されている必要がある。<br>
*: これらのオプションは、コマンドのターゲットおよびそのターゲットに依存するターゲットに対する必要性を表す。
<br><br>
*: ヘッダファイルのみのライブラリの場合は、<code>INTERFACE</code>オプションを使用する。
 
<center>
== 非ターゲットのリンク (target_link_librariesコマンド) ==
{| class="wikitable" | style="background-color:#fefefe;text-align: center;"
<code>target_link_libraries</code>コマンドを呼び出す時は、常に、<code>PRIVATE</code>、<code>PUBLIC</code>、<code>INTERFACE</code>オプションを指定する。<br>
|-
! style="background-color:#66CCFF;" | オプション
! style="background-color:#66CCFF;" | ターゲットが必要とする
! style="background-color:#66CCFF;" | ターゲットに依存するターゲットが必要とする
|-
| PRIVATE || ○ || ☓
|-
| PUBLIC || ○ || ○
|-
| INTERFACE || ☓ || ○
|}
</center>
<br>
<br>
<code>target_link_libraries</code>コマンドは、CMakeのターゲット以外にも、以下に示すものを指定することが可能である。<br>
* ライブラリの種類を指定しない
<br>
*: ビルドするユーザがスタティックライブラリまたはダイナミックライブラリを指定できるようにする。
* ライブラリファイルへのフルパス
*: <code>BUILD_SHARED_LIBS</code>オプションを付加して選択することもできるが、各ライブラリごとにオプションを設定すべきである。
*: CMakeはそのライブラリファイルをリンカコマンドに追加する。
*: ライブラリファイルが変更された場合、CMakeはその変更を検出して、ターゲットを再リンクする。
*: CMake 3.3以降では、リンカコマンドは指定されたフルパスを使用するが、CMake 3.2以前では、CMakeが代わりにライブラリを検索するようリンカに要求する場合がある。
*: （例. /usr/lib/libfoo.soファイルを-lfooに置換する等）
* 単純なライブラリ名
*: パスなしでライブラリ名だけを指定する場合、リンカコマンドはそのライブラリを検索する。
*: （例えば、プラットフォームによって、fooは-lfoo、または、foo.libになる）
* リンクフラグ
*: 特殊なケースとして、-lや-framework以外のハイフンで始まる項目は、リンカコマンドに追加されるフラグとして扱われる。
*: <br>
*: ただし、これらは<code>PRIVATE</code>項目にのみ使用するように警告している。
*: <code>PUBLIC</code>や<code>INTERFACE</code>として定義する場合は、他のターゲットに引き継がれてしまい、必ずしも安全とは言えないからである。
<br>
上記に加え、項目の前に<code>debug</code>、<code>optimized</code>、<code>general</code>のいずれかのオプションを付加することができる。<br>
これらのオプションは、ビルドがデバッグビルドとして設定されているかどうかに基づいて、それに続く項目が含まれるべき時をさらに絞り込むことである。<br>
<u>ただし、これらのオプションは、同様の機能をより明確で柔軟かつ堅牢な方法が別に存在するため、現在は使用しない方がよい。</u><br>
* debugオプション
*: 項目の前にdebugオプションを付加する場合、そのビルドがデバッグビルドである場合にのみ追加される。
* optimizedオプション
*: 項目の前にoptimizedオプションを付加する場合、ビルドがデバッグビルドでない場合のみ追加される。
* generalオプション
*: 項目の前にgeneralオプションを付加する場合、全てのビルド構成に対して項目を追加するように指定する。
<br><br>
 
== 非ターゲットのインクルード (target_include_directoriesコマンド) ==
<code>find_package</code>コマンドは、<code>include</code>コマンドで手動で行う設定を、<code>REQUIRED</code>オプション等を使用して自動で行うことができる。<br>
find_package(PkgConfig)
<br>
<code>find_package</code>コマンドは、<code>pkg_search_module</code>コマンドよりも柔軟でより多くのオプションが存在する。<br>
また、CMakeには豊富なパッケージ定義が付属しており、パッケージ管理システムからインストールしたソフトウェアは/usr/share/cmake/Modules/Find*.cmakeファイルにある。<br>
<br>
<code>target_include_directories(<ターゲット名> PUBLIC ...)</code>コマンドは、<br>
<ターゲット名>を使用する全てのターゲットにおいて、自動的にインクルードディレクトリが使用されるようになる。<br>
ただし、CMakeLists.txtファイル内にターゲットにのみ有効であり、<code>pkg_search_module</code>コマンドで取得したライブラリに対しては機能しない。<br>
  <syntaxhighlight lang="cmake">
  <syntaxhighlight lang="cmake">
  find_package(PkgConfig REQUIRED)
  option(<変数名1> "build library as a shared library" ON)
pkg_check_modules(<任意の変数名> <.pcファイル内の[Name]セクション名  例. sdl2> REQUIRED IMPORTED_TARGET)
   
   
  # ...略
  if(<変数名1>)
     add_library(<ターゲット名> SHARED)
target_link_libraries(<ターゲット名>
  else()
     ${<任意の変数名>_LIBRARIES}
    add_library(<ターゲット名> STATIC)
  )
  endif()
target_include_directories(<ターゲット名> PUBLIC
    ${<任意の変数名>_INCLUDE_DIRS}
)
   
target_compile_options(<ターゲット名> PUBLIC
    ${<任意の変数名>_CFLAGS}
    # または
    ${<任意の変数名>_CFLAGS_OTHER}
)
  </syntaxhighlight>
  </syntaxhighlight>
<br><br>
<br><br>
325行目: 177行目:
! style="background-color:#66CCFF;width: 35%;" | CMake
! style="background-color:#66CCFF;width: 35%;" | CMake
|-
|-
| style="background-color:#EEEEEE;" | レシピファイル || <Qtプロジェクト名>.pro || CMakeLists.txt
| レシピファイル || <Qtプロジェクト名>.pro || CMakeLists.txt
|-
|-
| style="background-color:#EEEEEE;" | レシピの呼び方 || プロジェクトファイル || CMakeソースコード
| レシピの呼び方 || プロジェクトファイル || CMakeソースコード
|-
|-
| style="background-color:#EEEEEE;" | 特徴 || 変数ベース || コマンドベース
| 特徴 || 変数ベース || コマンドベース
|-
|-
| style="background-color:#EEEEEE;" | ターゲット || 1ファイル １ターゲット || 1ファイル 複数ターゲット
| ターゲット || 1ファイル １ターゲット || 1ファイル 複数ターゲット
|-
|-
| style="background-color:#EEEEEE;" | プロジェクト間の連携 || 不可 || ターゲット名でリンク可能
| プロジェクト間の連携 || 不可 || ターゲット名でリンク可能
|-
|-
| style="background-color:#EEEEEE;" | Qtのサポート || ◎ || ○
| Qtのサポート || ◎ || ○
|-
|-
| style="background-color:#EEEEEE;" | Qt Creatorの対応 || ◎ || ファイルの追加等の対応がイマイチ
| Qt Creatorの対応 || ◎ || ファイルの追加等の対応がイマイチ
|-
|-
| style="background-color:#EEEEEE;" | カスタムコンパイラの対応 || △ || ◎
| カスタムコンパイラの対応 || △ || ◎
|-
|-
| style="background-color:#EEEEEE;" | Packageの作成 || △ || ○
| Packageの作成 || △ || ○
|}
|}
</center>
</center>
417行目: 269行目:
<br><br>
<br><br>


== 変数 ==
== set(CMAKE_AUTORCC ON)コマンド ==
==== 変数の宣言と代入 ====
このコマンドは、CMakeの機能の一部であり、Qtプロジェクトで特によく使用される。<br>
変数は、<code>set</code>コマンドを使用して、変数を宣言および代入することができる。<br>
ただし、この機能はQtプロジェクトの開発のために設計されている。<br>
CMakeでは、全ての変数を文字列として扱っており、変数名には、英数字、<code>_</code>、<code>.</code>、<code>/</code>、<code>-</code>、<code>+</code>を含めることができる。<br>
また、大文字と小文字が区別される。<br>
<br>
<br>
変数の値を代入する時、値にスペースが含まれていない限り、引用符で囲む必要はない。<br>
この機能は比較的新しく、CMake 3.9以降で導入された。<br>
<syntaxhighlight lang="cmake">
set(value 1)  # 値が1の変数valueを宣言
</syntaxhighlight>
<br>
<br>
既存の変数への代入も<code>set</code>コマンドを使用する。<br>
変数<code>CMAKE_AUTORCC</code>を有効にする場合、CMakeは、Qtのqrcファイルを自動的にコンパイルすることができる。<br>
変数の値の参照は、入れ子にすることもできる。<br>
qrcファイルは、アプリケーションにバイナリリソース (画像、アイコン、翻訳ファイル等) を埋め込むために使用される。<br>
<syntaxhighlight lang="cmake">
set(value 1)  # 値が1の変数valueを生成
set(value 2)  # 既存の変数valueに値1を代入
set(value_name value)  # 変数value_nameに変数valueの値を代入
message(${${value_name}}) # ${value_name}が展開されて、${${value_name}}が${value}になり、これが展開されて2になる
</syntaxhighlight>
<br>
<br>
1つの変数に複数の値を指定する場合、各値はセミコロンで区切って結合される。(<u>文字列リストとして代入される</u>)<br>
* CMakeの機能
また、未定義の変数を参照する場合は、空の文字列となる。<br>
*: 変数<code>CMAKE_AUTORCC</code>は、CMakeに組み込まれた変数である。
<syntaxhighlight lang="cmake">
*: CMakeはQtに限らず、多くのプロジェクトタイプをサポートする汎用的なビルドシステムジェネレータである。
set(myVar a b c)    # myVarの値: a;b;c
* Qtの統合
set(myVar a;b;c)    # myVarの値: a;b;c
*: CMakeはQtプロジェクトとの統合を強化するために、この機能を提供している。
set(myVar "a b c") # myVarの値: a b c
*: Qtのリソースコンパイラ (RCC) と連携して動作する。
set(myVar a b;c)    # myVarの値: a;b;c
* 他のフレームワークでの使用
set(myVar a "b c")  # myVarの値: a;b c
*: RCCと同様のリソース処理システムを持つ他のフレームワークでも使用できる可能性があるが、実際にはQt以外での使用は一般的ではない。
</syntaxhighlight>
<br>
<br>
<syntaxhighlight lang="cmake">
Qtプロジェクトでqrcファイルを使用する場合、変数<code>CMAKE_AUTORCC</code>を有効にすることが推奨されている。<br>
set(USE_CCACHE OFF CACHE BOOL "")
* 自動リソース処理
</syntaxhighlight>
*: CMakeが自動的にqrcファイルを検出し、必要なリソースコンパイル (rcc) ステップを実行する。
* ビルドプロセスの簡素化
*: 手動でリソースファイルの処理を記述する必要がなくなる。
* 依存関係の管理
*: リソースファイルが変更された場合、CMakeが自動的に再ビルドを行う。
<br>
<br>
==== 変数の削除 ====
ただし、以下に示すような場合は、変数<code>CMAKE_AUTORCC</code>を使用しない場合もある。<br>
変数の削除する場合は、<code>unset</code>コマンドを使用する。<br>
これらのケースでは、<code>qt_add_resources()</code>コマンドを使用して手動で処理を行うことができる。<br>
<syntaxhighlight lang="cmake">
* より細かな制御が必要な場合
set(value 1) # 変数valueを宣言
* 特定のqrcファイルのみを処理したい場合
unset(value)  # 変数valueを削除
* パフォーマンス上の理由で手動処理を行う場合
</syntaxhighlight>
<br>
<br>
==== 定義された全ての変数を出力 ====
したがって、多くの場合は<code>set(CMAKE_AUTORCC ON)</code>コマンドを実行することにより、qrcファイルの処理が簡単になる。<br>
<syntaxhighlight lang="cmake">
get_cmake_property(variableNames VARIABLES)
foreach(variableName ${variableNames})
    message(STATUS "${variableName}=${${variableName}}")
endforeach()
</syntaxhighlight>
<br><br>
<br><br>


== ログメッセージの出力 ==
== set(CMAKE_AUTOMOC ON)コマンド ==
==== messageコマンドとは ====
変数<code>CMAKE_AUTOUIC</code>は、CMakeにおいてQt User Interface Compiler (UIC) の自動実行を制御するための設定である。<br>
<syntaxhighlight lang="cmake">
message([<mode>] "message to display" ...)
</syntaxhighlight>
<br>
<br>
下表に、<code><mode></code>に指定できる項目を示す。(一部）<br>
変数<code>CMAKE_AUTOUIC</code>は、Qt開発を効率化するための重要な機能の1つである。<br>
<center>
Qt Designerで作成された.uiファイルを自動的にコンパイルして、対応するC++ヘッダファイルを生成する。<br>
{| class="wikitable" | style="background-color:#fefefe;text-align: center;"
これにより、UIファイルの変更が自動的にビルドプロセスに反映される。<br>
|-
! style="background-color:#66CCFF;width: 20%;" | modeの種類
! style="background-color:#66CCFF;width: 30%;" | 説明
! style="background-color:#66CCFF;width: 30%;" | 処理の継続
! style="background-color:#66CCFF;width: 20%;" | 出力先
|-
| 省略する場合 || 重要な情報 || CMakeの処理を継続する || STDERR
|-
| STATUS || 情報 || CMakeの処理を継続する || STDOUT
|-
| WARNING || 警告 || CMakeの処理を継続する || STDERR
|-
| SEND_ERROR || エラー || CMakeの処理を継続する || STDERR
|-
| FATAL_ERROR || 致命的なエラー || CMakeの処理を終了する || STDERR
|}
</center>
<br>
<br>
以下の例では、<code>message</code>コマンドにおいて、第1引数に<code>FATAL_ERROR</code>を指定することにより、エラーメッセージを出力して、CMakeコマンドを終了している。<br>
多くの場合、この変数を有効にすることで、UIファイルの処理に関する手間を大幅に削減することができる。<br>
<syntaxhighlight lang="cmake">
message(FATAL_ERROR "cmake to terminate.")
</syntaxhighlight>
<br>
<br>
また、<code>message</code>コマンドにおいて、第1引数に<code>SEND_ERROR</code>を指定することにより、エラーメッセージを出力して動作を継続する。<br>
Qtコンソールアプリケーションの場合は、GUIを持たないため、.uiファイルを使用しない。<br>
<syntaxhighlight lang="cmake">
したがって、この変数の設定は不要である。<br>
message(SEND_ERROR "Continue cmake.")
</syntaxhighlight>
<br>
<br>
以下の例では、Linux以外のOSの場合は、エラーメッセージを出力して、<code>cmake</code>コマンドを終了している。<br>
この機能は、CMake 2.8.11以降で利用可能である。<br>
<syntaxhighlight lang="cmake">
if(NOT (UNIX AND NOT APPLE))
    message(FATAL_ERROR "ERROR! Only Linux can build this software.")
else()
    set(LINUX TRUE)
endif()
</syntaxhighlight>
<br>
<br>
以下の例では、CMakeの特殊変数である<code>CMAKE_COMMAND</code>と<code>CMAKE_CTEST_COMMAND</code>を出力している。<br>
* 目的
<syntaxhighlight lang="cmake">
*: QtのUIファイル (.ui) を自動的に処理して、対応するヘッダファイルを生成する。
message("${CMAKE_COMMAND}")        # /usr/bin/cmake
* 動作
message("${CMAKE_CTEST_COMMAND}")  # /usr/bin/ctest
*: 変数<code>CMAKE_AUTOUIC</code>を有効にする時、CMakeはプロジェクト内の.uiファイルを自動的に検出して、UICを実行してヘッダファイルを生成する。
</syntaxhighlight>
*: 生成されたファイルは、一般的に、ビルドディレクトリに配置される。
<br><br>
* 利点
 
*: 手動でUICの実行を設定する必要がなくなり、ビルドプロセスが簡素化される。
== インクルードパスの指定 ==
*: UIファイルが変更された場合、自動的に再処理される。
インクルードパスを指定する場合、<code>include_directories</code>コマンドを使用する。<br>
* 対象ファイル
<syntaxhighlight lang="cmake">
*: プロジェクト内の全ての.uiファイルが処理の対象となる。
include_directories(/path/to/include)
* 関連する変数
</syntaxhighlight>
*: CMAKE_AUTOUIC_SEARCH_PATHS : UICが.uiファイルを検索するパスを指定する。
*: CMAKE_AUTOUIC_OPTIONS : UICに渡す追加オプションを指定する。
* パフォーマンス
*: 大規模プロジェクトでは、自動処理が若干のビルド時間の増加をもたらす可能性がある。
<br>
<br>
<code>include_directories</code>コマンドを複数使用する場合、デフォルトでは、指定したパスは最後尾となる。<br>
変数<code>CMAKE_AUTOUIC</code>を無効にする場合、<code>qt_wrap_ui()</code>コマンドを使用して手動で.uiファイルを処理することもできる。<br>
ただし、<code>include_directories</code>コマンドに<code>BEFORE</code>オプションを付加した場合は最前となる。<br>
<br>
<br>
以下の例では、"-I/path1/to/include -I/path2/to/include"となる。<br>
また、Qtプロジェクトによっては、特定のUIファイルのみを処理したい場合がある。<br>
<syntaxhighlight lang="cmake">
その場合は、この変数<code>CMAKE_AUTOUIC</code>を無効にして手動で制御することも可能である。<br>
include_directories(/path1/to/include)
include_directories(/path2/to/include)
</syntaxhighlight>
<br>
<br>
以下の例では、"-I/path2/to/include -I/path1/to/include" となる。<br>
<u>※注意</u><br>
<syntaxhighlight lang="cmake">
<u>変数<code>CMAKE_AUTOUIC</code>は、Qt Widgetベースのアプリケーションで使用される.uiファイル (XML形式) を処理するためのものである。</u><br>
include_directories(/path1/to/include)
<u>QMLは独自の宣言的UIフォーマットを使用して、.qmlファイルで定義される。</u><br>
include_directories(BEFORE /path2/to/include)
<u>したがって、QMLを使用したプロジェクトでは、この変数<code>CMAKE_AUTOUIC</code>の設定は不要である。</u><br>
</syntaxhighlight>
<br><br>
<br><br>


== ライブラリパスの指定 ==
== set(CMAKE_AUTOMOC ON)コマンド ==
ライブラリパスを指定する場合、<code>link_directories</code>コマンドを使用する。<br>
変数<code>CMAKE_AUTOMOC</code>は、CMakeにおいてQt Meta-Object Compiler (MOC) の自動実行を制御するための重要な設定である。<br>
<syntaxhighlight lang="cmake">
<br>
link_directories(/path/to/lib)
<u>この変数は、ほとんどのQtプロジェクトで必須の設定である。</u><br>
</syntaxhighlight>
Qtのメタオブジェクトシステムに必要なメタデータを生成するために、MOCを自動的に実行する。<br>
これにより、開発者はQtの高度な機能 (シグナル / スロット、プロパティシステム等) を簡単に利用できるようになり、同時にビルドプロセスも自動化される。<br>
<br>
この機能はCMake 2.8.6以降で利用可能である。<br>
<br>
<br>
<code>link_directories</code>コマンドを複数使用する場合、デフォルトでは、指定したパスは最後尾となる。<br>
* 動作
ただし、<code>link_directories</code>コマンドに<code>BEFORE</code>オプションを付加した場合は最前となる。<br>
*: 変数<code>CMAKE_AUTOMOC</code>を有効にする時、CMakeはプロジェクト内のQtクラス (<code>Q_OBJECT</code>マクロを使用しているクラス等) を自動的に検出して、
*: 必要に応じてMOCを実行する。
* 処理対象
** Q_OBJECTマクロを含むヘッダファイル
** シグナルやスロットを使用しているクラス
** プロパティシステムを使用しているクラス
** その他のQt固有の機能をC++で使用する場合
* メリット
** 手動でMOCの実行を設定する必要がなくなり、開発プロセスが簡素化される。
** ソースファイルの変更時に自動的にMOC処理が行われる。
* 生成ファイル
*: moc_*.cppファイルがビルドディレクトリに生成される。
* 関連する変数
** <code>CMAKE_AUTOMOC_MACRO_NAMES</code>
**: 追加のマクロ名を指定して、MOC処理の対象を拡張できる。
** <code>CMAKE_AUTOMOC_PATH_PREFIX</code>
**: 生成されるmocファイルのパスプレフィックスを設定する。
*  パフォーマンスへの影響
*: 大規模プロジェクトでは、ビルド時間が若干増加する可能性がある。
* デバッグ
*: 変数<code>CMAKE_AUTOMOC_VERBOSE</code>を有効にする時、MOC処理の詳細なログが出力され、問題のデバッグに役立つ。
* QtとC++の統合
*: この変数を有効にすることにより、QtのメタオブジェクトシステムとC++のコードがシームレスに統合される。
<br>
<br>
以下の例では、"-I/path1/to/lib -I/path2/to/lib"となる。<br>
また、特定のファイルのみMOCを処理をしたい場合は、変数<code>CMAKE_AUTOMOC</code>を無効にして、<code>qt_wrap_cpp()</code>コマンドを使用して手動で制御できる。<br>
<syntaxhighlight lang="cmake">
link_directories(/path1/to/lib)
link_directories(/path2/to/lib)
</syntaxhighlight>
<br>
<br>
以下の例では、"-I/path2/to/lib -I/path1/to/lib" となる。<br>
<u>※注意</u><br>
<syntaxhighlight lang="cmake">
<u>プリコンパイル済みヘッダ (PCH、GCH等) を使用する場合、追加の設定が必要になることがある。</u><br>
link_directories(/path1/to/lib)
link_directories(BEFORE /path2/to/lib)
</syntaxhighlight>
<br><br>
<br><br>


589行目: 408行目:
  </syntaxhighlight>
  </syntaxhighlight>
<br><br>
<br><br>
{{#seo:
|title={{PAGENAME}} : Exploring Electronics and SUSE Linux | MochiuWiki
|keywords=MochiuWiki,Mochiu,Wiki,Mochiu Wiki,Electric Circuit,Electric,pcb,Mathematics,AVR,TI,STMicro,AVR,ATmega,MSP430,STM,Arduino,Xilinx,FPGA,Verilog,HDL,PinePhone,Pine Phone,Raspberry,Raspberry Pi,C,C++,C#,Qt,Qml,MFC,Shell,Bash,Zsh,Fish,SUSE,SLE,Suse Enterprise,Suse Linux,openSUSE,open SUSE,Leap,Linux,uCLnux,Podman,電気回路,電子回路,基板,プリント基板
|description={{PAGENAME}} - 電子回路とSUSE Linuxに関する情報 | This page is {{PAGENAME}} in our wiki about electronic circuits and SUSE Linux
|image=/resources/assets/MochiuLogo_Single_Blue.png
}}


__FORCETOC__
__FORCETOC__
[[カテゴリ:Qt]]
[[カテゴリ:Qt]]
「http://mochiuwiki.e2.valueserver.jp/index.php?title=Qtの設定_-_CMake」から取得