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

[アーティクル]
05/01/2024

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

前提条件

この例では、Visual Studio C++ 開発ワークロードで C++ MSVC コンパイラを使用します。

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 - Visual Studio Code 拡張機能をインストールする

拡張機能ビューに移動し、C++ 拡張機能をインストールします。これにより、C++ IntelliSense とコードナビゲーションが有効になります。

C++ Visual Studio Code 拡張機能のインストール

CMake ツール拡張機能をインストールします。これにより、Visual Studio Code での CMake のサポートが有効になります。

CMake Tools Visual Studio Code 拡張機能のインストール

3 - vcpkg のセットアップ

環境変数を構成します VCPKG_ROOT 。

Visual Studio Code で新しいターミナルを開く: ターミナル > の新しいターミナル

次のコマンドを実行します。

$env:VCPKG_ROOT="C:\path\to\vcpkg"
$env:PATH="$env:VCPKG_ROOT;$env:PATH"

vcpkg 環境変数の設定

Note

この方法で環境変数を設定すると、現在のターミナルセッションにのみ影響します。これらの変更をすべてのセッションで永続的にするには、[Windows システム環境変数] パネルで設定します。

set "VCPKG_ROOT=C:\path\to\vcpkg"
set PATH=%VCPKG_ROOT%;%PATH%

Note

export VCPKG_ROOT=/c/path/to/vcpkg
export PATH=$PATH:$VCPKG_ROOT

Note

コマンドを使用して環境変数を設定すると、 export 現在のシェルセッションにのみ影響します。この変更をセッション間で永続的にするには、シェルのプロファイルスクリプト (例: ~/.bashrc または~/.zshrc) にコマンドを追加exportします。

設定 VCPKG_ROOT は、Visual Studio が vcpkg インスタンスを見つけるのに役立ちます。これを追加すると PATH 、vcpkg コマンドをシェルから直接実行できるようになります。

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

次のコマンドを実行して、vcpkg マニフェストファイル (vcpkg.json) を作成します。

vcpkg new --application

このコマンドは vcpkg new 、プロジェクトの vcpkg.json ディレクトリにファイルと vcpkg-configuration.json ファイルを追加します。

依存関係としてパッケージを追加します fmt 。

vcpkg add port fmt

次のものが vcpkg.json 含まれるはずです。

{
  "dependencies": [
    "fmt"
  ]
}

これはマニフェストファイルです。 vcpkg はマニフェストファイルを読み取り、インストールする依存関係を学習し、MSBuild と統合して、プロジェクトに必要な依存関係を提供します。

生成されたvcpkg-configuration.jsonファイルには、プロジェクトの依存関係に最小バージョンの制約を設定するベースラインが導入されています。このファイルの変更は、このチュートリアルの範囲外です。このチュートリアルでは適用できませんが、異なる開発環境間でバージョンの一貫性を vcpkg-configuration.json 確保するために、ファイルをソース管理の下に置くことをお勧めします。

3 - プロジェクトファイルを設定する

次の内容の CMakeLists.txt ファイルを作成します。

cmake_minimum_required(VERSION 3.10)

project(HelloWorld)

find_package(fmt CONFIG REQUIRED)

add_executable(HelloWorld main.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 キーワード (keyword)により、パッケージが見つからない場合にエラーが生成されます。
add_executable(HelloWorld main.cpp): ソースファイル main.cppからビルドされた "HelloWorld" という名前の実行可能ターゲットを追加します。
target_link_libraries(HelloWorld PRIVATE fmt::fmt): 実行可能ファイルがライブラリに HelloWorld 対して fmt リンクする必要があることを指定します。キーワード (keyword)はPRIVATE、ビルドHelloWorldにのみ必要であり、他の依存プロジェクトには反映されないことを示fmtします。

次の内容の helloworld.cpp ファイルを作成します。

#include <fmt/core.h>

int main()
{
    fmt::print("Hello World!\n");
    return 0;
}

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

CMake プロジェクトシステムが vcpkg によって提供される C++ ライブラリを認識できるようにするには、ツールチェーンファイルを vcpkg.cmake 指定する必要があります。これを自動化するには、次の内容を含む CMakePresets.json ファイルを "helloworld" ディレクトリに作成します。

{
  "version": 2,
  "configurePresets": [
    {
      "name": "vcpkg",
      "generator": "Ninja",
      "binaryDir": "${sourceDir}/build",
      "cacheVariables": {
        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
      }
    }
  ]
}

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

{
  "version": 2,
  "configurePresets": [
    {
      "name": "default",
      "inherits": "vcpkg",
      "environment": {
        "VCPKG_ROOT": "<path to vcpkg>"
      }
    }
  ]
}

この CMakePresets.json ファイルには、CMake 用の 1 つの "vcpkg" プリセットが含まれており、変数が設定されます CMAKE_TOOLCHAIN_FILE 。これにより CMAKE_TOOLCHAIN_FILE 、CMake プロジェクトシステムは vcpkg によって提供される C++ ライブラリを認識できます。ソース管理CMakeUserPresets.jsonにチェックし、ローカルで使用することのみをCMakePresets.json目的としています。

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

コマンドパレットのCMake: Build表示>でコマンドパレットに移動して、プロジェクトのコマンドを実行します。

Visual Studio Code の CMake ビルドコマンド

CMake プリセットを選択します default 。これにより、vcpkg ツールチェーンが有効になります。

Visual Studio Code での CMake ビルドコマンドでのプリセットの選択

プロジェクトを起動する

次のように出力されるはずです。

Hello World!

次のステップ

詳細 vcpkg.jsonについては、リファレンスドキュメントを参照してください。

次の方法で共有

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

前提条件

1 - vcpkg を設定する

2 - Visual Studio Code 拡張機能をインストールする

3 - vcpkg のセットアップ

3 - プロジェクトファイルを設定する

次のステップ

フィードバック

その他のリソース

次の方法で共有

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

前提条件

1 - vcpkg を設定する

2 - Visual Studio Code 拡張機能をインストールする

3 - vcpkg のセットアップ

3 - プロジェクト ファイルを設定する

次のステップ

フィードバック

その他のリソース

3 - プロジェクトファイルを設定する