チュートリアル: CMake でパッケージをインストールして使用する

[アーティクル]
09/26/2024

このチュートリアルでは、CMake と vcpkg で fmt ライブラリを使用する C++ "Hello World" プログラムを作成する方法について説明します。依存関係のインストール、構成、ビルド、および単純なアプリケーションの実行を行います。

前提条件

ターミナル
C++ コンパイラ
CMake
Git

Note

Windows ユーザーの場合、Visual Studio の MSVC (Microsoft Visual C++ コンパイラ) は、C++ 開発に必要なコンパイラです。

1 - vcpkg を設定する

リポジトリの複製

最初の手順では、GitHub から vcpkg リポジトリを複製します。リポジトリには、vcpkg 実行可能ファイルを取得するスクリプトと、vcpkg コミュニティによって管理されるキュレーションされたオープンソースライブラリのレジストリが含まれています。これを行うには、次を実行します。
```
git clone https://github.com/microsoft/vcpkg.git
```
vcpkg キュレーションレジストリは、2,000 を超えるオープンソースライブラリのセットです。これらのライブラリは、vcpkg の継続的インテグレーションパイプラインによって検証され、連携しています。 vcpkg リポジトリにはこれらのライブラリのソースコードは含まれていませんが、レシピとメタデータを保持して、それらをビルドしてシステムにインストールします。
ブートストラップスクリプトを実行する

vcpkg リポジトリを複製したら、 vcpkg ディレクトリに移動し、ブートストラップスクリプトを実行します。
```
cd vcpkg && bootstrap-vcpkg.bat
```
```
cd vcpkg; .\bootstrap-vcpkg.bat
```
```
cd vcpkg && ./bootstrap-vcpkg.sh
```
ブートストラップスクリプトは前提条件チェックを実行し、vcpkg 実行可能ファイルをダウンロードします。

これで完了です。 vcpkg がセットアップされ、使用する準備が整いました。

2 - プロジェクトを設定する

VCPKG_ROOT 環境変数を構成します。
```
export VCPKG_ROOT=/path/to/vcpkg
export PATH=$VCPKG_ROOT:$PATH
```
Note

export コマンドを使用して環境変数を設定すると、現在のシェルセッションにのみ影響します。この変更をセッション間で永続的にするには、シェルのプロファイルスクリプト (~/.bashrcや~/.zshrcなど) に export コマンドを追加します。
```
set "VCPKG_ROOT=C:\path\to\vcpkg"
set PATH=%VCPKG_ROOT%;%PATH%
```
Note

この方法で環境変数を設定すると、現在のターミナルセッションにのみ影響します。これらの変更をすべてのセッションで永続的にするには、[Windows システム環境変数] パネルで設定します。
```
$env:VCPKG_ROOT = "C:\path\to\vcpkg"
$env:PATH = "$env:VCPKG_ROOT;$env:PATH"
```
Note

この方法で環境変数を設定すると、現在のターミナルセッションにのみ影響します。これらの変更をすべてのセッションで永続的にするには、[Windows システム環境変数] パネルで設定します。
VCPKG_ROOT設定すると、vcpkg インスタンスが配置されている場所が vcpkg に通知されます。これを PATH に追加すると、シェルから直接 vcpkg コマンドを実行できます。
プロジェクトディレクトリを作成します。
```
mkdir helloworld && cd helloworld
```

3 - 依存関係とプロジェクトファイルを追加する

マニフェストファイルを作成し、 fmt 依存関係を追加します。

まず、helloworld ディレクトリ内から vcpkg new コマンドを実行して、プロジェクトのディレクトリにマニフェストファイル (vcpkg.json) を作成します。
```
vcpkg new --application
```
次に、 fmt 依存関係を追加します。
```
vcpkg add port fmt
```
vcpkg.json は次のようになります。
```
{
    "dependencies": [
        "fmt"
    ]
}
```
これはマニフェストファイルです。 vcpkg はマニフェストファイルを読み取り、インストールする依存関係を学習し、CMake と統合して、プロジェクトに必要な依存関係を提供します。

既定の vcpkg-configuration.json ファイルには基準制約が導入され、プロジェクトで使用する必要がある依存関係の最小バージョンが指定されます。このファイルの変更は、このチュートリアルの範囲外ですが、プロジェクトの依存関係のバージョン制約を定義する上で重要な役割を果たします。そのため、このチュートリアルでは厳密には必要ではありませんが、ソース管理に vcpkg-configuration.json を追加して、異なる開発環境間でバージョンの整合性を確保することをお勧めします。
プロジェクトファイルを作成します。

次の内容を含む CMakeLists.txt ファイルを作成します。
```
cmake_minimum_required(VERSION 3.10)

project(HelloWorld)

find_package(fmt CONFIG REQUIRED)

add_executable(HelloWorld helloworld.cpp)

target_link_libraries(HelloWorld PRIVATE fmt::fmt)
```
次に、 CMakeLists.txt ファイルの各行の動作を分解してみましょう。
- cmake_minimum_required(VERSION 3.10): プロジェクトのビルドに必要な CMake の最小バージョンが 3.10 であることを指定します。システムにインストールされている CMake のバージョンがこれより低い場合は、エラーが生成されます。
- project(HelloWorld): プロジェクトの名前を "HelloWorld" に設定します。
- find_package(fmt CONFIG REQUIRED): CMake 構成ファイルを使用して fmt ライブラリを探します。 REQUIRED キーワードを使用すると、パッケージが見つからない場合にエラーが生成されます。
- add_executable(HelloWorld helloworld.cpp): ソースファイル helloworld.cppからビルドされた "HelloWorld" という名前の実行可能ターゲットを追加します。
- target_link_libraries(HelloWorld PRIVATE fmt::fmt): HelloWorld 実行可能ファイルが fmt ライブラリに対してリンクする必要があることを指定します。 PRIVATE キーワードは、fmtはHelloWorldの構築にのみ必要であり、他の依存プロジェクトには反映されないことを示します。
次の内容を含む helloworld.cpp ファイルを作成します。
```
#include <fmt/core.h>

int main()
{
    fmt::print("Hello World!\n");
    return 0;
}
```
このhelloworld.cpp ファイルには、fmt ライブラリを使用するための<fmt/core.h> ヘッダーが含まれています。 main()関数は、fmt::print()を呼び出して"Hello World!" メッセージをコンソールに出力します。

4 - プロジェクトをビルドして実行する

CMake 構成を実行する

CMAKE_TOOLCHAIN_FILEがvcpkg のカスタムツールチェーンを使用するように設定されている場合、CMake は vcpkg によってインストールされたライブラリ自動的にリンクできます。これは、CMake プリセットファイルを使用して完成させることができます。

helloworld ディレクトリ内に次のファイルを作成します。

CMakePresets.json
```
{
  "version": 2,
  "configurePresets": [
    {
      "name": "vcpkg",
      "generator": "Ninja",
      "binaryDir": "${sourceDir}/build",
      "cacheVariables": {
        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
      }
    }
  ]
}
```
CMakeUserPresets.json
```
{
    "version": 2,
    "configurePresets": [
      {
        "name": "default",
        "inherits": "vcpkg",
        "environment": {
          "VCPKG_ROOT": "<path to vcpkg>"
        }
      }
    ]
  }
```
CMakePresets.json ファイルには、CMAKE_TOOLCHAIN_FILE変数を設定する "vcpkg" という名前のプリセットが 1 つ含まれています。 CMakeUserPresets.json ファイルは、vcpkg のローカルインストールを含む絶対パスを指すVCPKG_ROOT環境変数を設定します。バージョン管理システムに CMakeUserPresets.json をチェックしないことをお勧めします。

最後に、CMake を使用してビルドを構成します。
```
cmake --preset=default
```
プロジェクトをビルドする

実行 (Run):
```
cmake --build build
```
アプリケーションの実行

最後に、実行可能ファイルを実行して、アプリケーションの動作を確認します。
```
./build/HelloWorld

Hello World!
```
```
.\build\HelloWorld.exe

Hello World!
```

次の方法で共有

チュートリアル: CMake でパッケージをインストールして使用する

前提条件

1 - vcpkg を設定する

2 - プロジェクトを設定する

3 - 依存関係とプロジェクトファイルを追加する

4 - プロジェクトをビルドして実行する

次のステップ

その他のリソース

次の方法で共有

チュートリアル: CMake でパッケージをインストールして使用する

前提条件

1 - vcpkg を設定する

2 - プロジェクトを設定する

3 - 依存関係とプロジェクト ファイルを追加する

4 - プロジェクトをビルドして実行する

次のステップ

その他のリソース

3 - 依存関係とプロジェクトファイルを追加する