WSL(Ubuntu)のC++開発環境を Visual Studio Codeで構築

WSL Ubuntu開発環境を VS Codeで構築

WSL Ubuntu開発環境を VS Codeで構築

WSL(Ubuntu) C++開発環境をVS Codeで構築

2018年3月、Windows Subsystem for Linux(WSL)で動作するUbuntuのC++開発環境をWindows環境で動作するVisual Studio Codeで実現しました。

マイクロソフトが WSLを正式リリースして、Microsoft StoreからUbuntuがダウンロードできるようになり、WindowsでLinuxが動作するという便利な時代となりました。

WSL : Windows で Ubuntu環境 を実行する

Visual Studio Code(VS Code)を使用して、Windows Subsystem for Linuxで動作するUbuntuのC++開発環境を構築しました。VS Codeは、マイクロソフト社が開発したクロスプラットフォームで動作する高機能なソースコードエディターです。VS Codeはエディターであり、Visual Studio 20xx のような統合開発環境(IDE)ではありません。しかし、デバッグ機能やタスク機能(頻繁に行う作業の自動化)が組み込まれています。従って、「コード編集→ビルド処理→デバッグ実行」がVS Code内で行うことができます。

VS Codeでデバッグ

VS Codeでデバッグ

Ubuntu C++開発環境

最初に Windows Subsystem for Linux (Ubuntu) のC++開発環境を構築します。


gccを使用できるように開発ツールをインストールします。


gdbデバッガをインストールします。


使用したツールのバージョンを下記に示します。

C++ 作業ディレクトリー

C++言語をビルドして実行するのは、WSLで動作する Ubuntu環境です。また、Visual Studio Codeは、Windows環境で動作します。

今回は、このUbuntu環境とWindows環境を連携したC++開発環境を構築します。Windows環境からUbuntu環境のファイルへの(追加/変更/削除)アクセスは禁止されていますので、作業ディレクトリーをWindows側にします。

「c:\Users\pi\MyHome」をWindows環境とUbuntu環境から共通でアクセスする作業ディレクトリーとします。

MyHome ディレクトリーを作成します。

.bashrc の最後に、カレントディレクトリーを MyHome にするコマンドを入れます。

次にログインすると、/mnt/c/Users/pi/MyHome がカレントディレクトリーになります。

Visual Studio Codeのインストール

マイクロソフトのVisual Studio CodeサイトからVisual Studio Codeをダウンロードします。

VS Code ダウンロード1

VS Code ダウンロード1

Visual Studio Code ダウンロード」を入力します。

VS Code ダウンロード2

VS Code ダウンロード2

Windowsプラットフォームを選択します。

VS Code ダウンロード3

VS Code ダウンロード3

インストールを開始します。

Visual Studio Code を実行します。

VS Code 実行

VS Code 実行

 

Gitが見つかりません」とメッセージが表示されます。Gitは使いませんので、 [今後は表示しない]をクリックします。

Visual Studio Code のバージョンを確認します。

ヘルプ(H)-バージョン情報(A)」と入力します。

VS Code バージョン

VS Code バージョン


統合ターミナルの設定

Visual Studio Code の統合ターミナルで、WSL(Ubuntu)のbashを使うように設定します。

[Ctrl]+[Shift]+[P]キー」でコマンドパレットを表示して「shell」と入力します。

統合ターミナルの設定1

統合ターミナルの設定1

ターミナル:規定のシェルの選択」を入力します。

統合ターミナルの設定2

統合ターミナルの設定2

シェルの選択項目が表示されます。

  • Command Prompt
  • PowerShell
  • WSL Bash

WSL Bash c:\WINDOWS\System32\bash.exe」を選択します。

統合ターミナルの設定3

統合ターミナルの設定3

表示(V)-統合ターミナル(I)」または、[Ctrl]+[Shift]+[@]キーを入力します。

統合ターミナルの設定4

統合ターミナルの設定4

画面下にUbuntu環境のbashターミナルが開きます。

C++言語のサンプルコード

これからVisual Studio Code でC++言語の開発環境を構築します。文字のASCIIコードを表示する簡単なC++言語のサンプルコードを使用します。

MyHomeに cpp_outAscii ディレクトリーを作成して、ソースコード outAsciiCode.cpp を作成します。

[ファイル(F)]-[フォルダを開く]」で、c:\Users\pi\MyHome\cpp_outAscii を指定します。次に「[ファイル(F)]-[新規ファイル(N)]」で、outAsciiCode.cppを指定します。

C++言語のサンプルコード

C++言語のサンプルコード

 

ソースコードをWindows環境とUbuntu環境からアクセスすることを考慮して、文字コードのエンコードを BOM付き Unicode(UTF-8)にします。

文字エンコード UTF-8

文字エンコード UTF-8

右下の 「UTF-8」をクリックします。

文字エンコード 保存

文字エンコード 保存

[エンコード付きで保存]を選択します。

文字エンコード UTF-8 with BOM

文字エンコード UTF-8 with BOM

[UTF-8 with BOM]を選択します。

 

Ubuntu環境でのビルドと実行

次に makefile を作成します。

gdbでデバッグしますので、次のオプションを付けます。

  • -g : コンパイル,リンク時にDEBUG情報を付加する
  • -O0 : 最適化をしません

表示(V)-統合ターミナル(I)」 で、ターミナルを開きます。

makeコマンドでビルドします。

makeコマンド実行

makeコマンド実行



outAscii を実行して、結果を確認します。

makefileに実行用のオプションを入れましたので、makeコマンドからでも実行できます。

プログラム実行

プログラム実行


Visual Studio Codeからビルド

Visual Studio Code から、プログラムのビルドをできるようにします。

VS Code ビルド設定1

VS Code ビルド設定1

タスク(T)-ビルドタスクの実行(B)」と入力します。

VS Code ビルド設定2

VS Code ビルド設定2

ビルドタスクを構成する…」をクリックします。

VS Code ビルド設定3

VS Code ビルド設定3

テンプレートから task.json を生成」をクリックします。

「Others 任意の外部コマンドを実行する例」を選択します。

VS Code ビルド設定4

VS Code ビルド設定4

task.json のひな形が表示されます。

task.json を下記のように修正して、makeコマンドを実行するようにします。

VS Code ビルド設定5

VS Code ビルド設定5



項目の意味は、Tasks in Visual Code ドキュメントを参考にします。

項目 設定例 意味
label My build ユーザーインターフェイスで使用するタスクのラベル
type shell タスクのタイプ (shell or process)
・shell : コマンドはシェルコマンドとして解釈
・process : コマンドは実行するプロセスとして解釈
command make 実行する実際のコマンド
group build 実行タスクが属するグループ (build or test)

タスク(T)-ビルドタスクの実行(B)」 または、[Ctrl]+[Shift]+[B]キーで、makeコマンドを実行してビルドします。

VS Code ビルド設定6

VS Code ビルド設定6

Visual Studio Codeからプログラムの実行

Visual Studio Code から、プログラムの実行ができるようにします。

task.json を下記のように修正して、testグループを追加します。

VS Code タスク実行1

VS Code タスク実行1



VS Code タスク実行2

VS Code タスク実行2

タスク(T)-タスクの実行(R)」と入力します。

VS Code タスク実行3

VS Code タスク実行3

タスクの選択になりますので、「My exec」を選択します。

VS Code タスク実行4

VS Code タスク実行4

make execコマンドにより、./outAscii プログラムを実行しました。

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

拡張機能インストール1

拡張機能インストール1

左の拡張機能をクリックします。

拡張機能インストール2

拡張機能インストール2

C/C++を選択してインストールします。

拡張機能インストール3

拡張機能インストール3

[インストール]をクリックします。

拡張機能インストール4

拡張機能インストール4

[再読み込み]をクリックします。


拡張機能インストール5

拡張機能インストール5

C/C++ InteliSense を選択してインストールします。

拡張機能インストール6

拡張機能インストール6

[インストール]をクリックします。

拡張機能インストール7

拡張機能インストール7

[再読み込み]をクリックします。

拡張機能インストール8

拡張機能インストール8

インストール済みの拡張機能を確認します。

 

Visual Studio Codeからデバッグの設定

Visual Studio Codeからブレークポイントを設定してデバッグできるようにします。

BashOnWindowsでのVisualStudioCodeのlaunch.jsonの書き方を参考にしました。

VS Code デバッグ設定1

VS Code デバッグ設定1

デバッグ(D)-デバッグの開始(S)」と入力します。

VS Code デバッグ設定2

VS Code デバッグ設定2

環境の選択で [More…]を選択します。

VS Code デバッグ設定3

VS Code デバッグ設定3

launch.json のひな形が表示されます。

 

VS Code デバッグ設定4

VS Code デバッグ設定4

右下の「構成の追加…」をクリックします

VS Code デバッグ設定5

VS Code デバッグ設定5

C/C++: (gdb) Bash on Windows Launch」を選択します。

元の launch.json ひな形を削除して、以下のようになります。

VS Code デバッグ設定6

VS Code デバッグ設定6



launch.json を自分の環境に合わせて修正します。

項目 意味
name 構成の名前
program Ubuntu環境の実行ファイルのパス
args 実行時の引数
stopAtEntry エントリーポイントで停止
cwd Ubuntu環境の実行ディレクトリー
pipeTransport:
debuggerPath
Ubuntu環境のgdbのパス
pipeTransport:
pipeProgram
Windows環境のbashのパス
pipeTransport:
pipeArgs
pipeのオプション
sourceFileMap Ubuntu環境とWindows環境のマップ

以下のようになりました。

VS Code デバッグ設定7

VS Code デバッグ設定7



C/C++: (gdb) Bash on Windows Launchの修正前後の差分を示します。

launch.json 変更差分

launch.json 変更差分

Visual Studio Codeからデバッグの実行

VS Code デバッグ実行1

VS Code デバッグ実行1

左のデバッグボタンを押します。

VS Code デバッグ実行2

VS Code デバッグ実行2

ソースコードの行番号の左をクリックしてブレークポイントを設定します。

VS Code デバッグ実行3

VS Code デバッグ実行3

デバッグ(D)-デバッグの開始(S)」と入力します。

VS Code デバッグ実行4

VS Code デバッグ実行4

ブレークポイントで実行が停止します。左の領域には、変数の内容が表示されます。

VS Code デバッグ実行5

VS Code デバッグ実行5

デバッグ(D)-ステップインする(I)」または、F11を入力します。ステップ実行もできました。

まとめ

Windows Subsystem for Linux(WSL)で動作するUbuntuのC++開発環境をVisual Studio Codeで実現することができました。Visual Studio Codeは高機能なエディターですが、Visual Studio 20xx のような統合開発環境(IDE)風に使えます。

今までは、Windows環境はVisual Studio 20xx統合環境で快適に開発できますが、Linux環境はgdbでデバッグが大変という認識を持っていました。しかし、Visual Studio CodeによりUbuntu環境のC++開発が快適にデバッグできる時代になり感激しています。

 

 

このエントリーをはてなブックマークに追加

WSL(Ubuntu)のC++開発環境を Visual Studio Codeで構築」への1件のフィードバック

  1. ピンバック: Raspberry PiのC++開発環境を Visual Studio Codeで構築 | ある計算機屋さんの手帳

コメントは受け付けていません。