Raspberry PiのC++開発環境を Visual Studio Codeで構築

Raspberry PiでVS Code実行

Raspberry PiでVS Code実行

Raspberry Pi3のC++開発環境をVS Codeで構築

2018年3月、Raspberry Pi3のC++開発環境をVisual Studio Code(VS Code)で実現しました。

少し前に、Windows環境で動作するVisual Studio Codeを使用して Windows Subsystem for Linux(WSL)で動作するUbuntuのC++開発環境を構築しました。

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

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

マイクロソフト社のVisual Studio Codeサイトによれば、VS Codeは Mac OS X/Linux/Windowsのプラットフォームで動作します。ということは、Raspberry Pi3のRasbian OSでもVS Codeは動作する可能性があると考えました。

Linux用のパッケージはx86アーキテクチャー用なので、ARMアーキテクチャーのRaspberry Pi3では動作しません。また、Raspbery Piで使えるリポジトリーは存在しないので「sudo apt install」でインストールできません。

ネットで検索した情報によると、VS Codeのソースをダウンロードしてビルドすれば動作するようです。

いろいろ試した結果、Raspberry Pi3でVisual Studio Codeを使用してC++開発環境を構築できました。

VS Codeでデバッグ

VS Codeでデバッグ

Visual Studio Codeのインストール

ソースコードからのビルドは面倒です。Raspberry Pi用バイナリーを公開しているサイトがありましたので、Community builds of Visual Studio Codeからダウンロードしました。

Community Build サイト

サイトの説明に従ってVS Codeをインストールします。

Community Build サイト インストール説明

Community Build サイト インストール説明

管理者権限で wgetによりダウンロードして実行します。

Code-OSS メニュー

Code-OSS メニュー

インストールが完了すると、「メニュー>プログラミング>Code – OSS」が追加されます。[Code – OSS]を選択すると、Visual Studio Codeが立ち上がります。

Visual Studio Code が動いた

Visual Studio Code が動いた

Visual Studio Code のバージョンを確認します。「ヘルプ(H)-バージョン情報(A)」と入力します。

VS Code バージョン

VS Code バージョン



Windows10版のVS Codeは、「バージョン 1.21.1」でした。こちらのパッケージは「バージョン 1.14.0」なので、ちょっと古いです。

Rasbian OS C++開発環境

Raspberry Pi3 で使用する Rasbian OS のC++開発環境を構築します。


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


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


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

統合ターミナルの設定

Visual Studio Code の統合ターミナルの設定をします。「[Ctrl]+[Shift]+[P]キー」でコマンドパレットを表示して「shell」と入力します。

ターミナル設定

ターミナル設定

「ターミナル:ワークスペースでシェルを構成することを許可する」を選択します。

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

ターミナル実行

ターミナル実行

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

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

「WSL(Ubuntu)のC++開発環境を Visual Studio Codeで構築」と同じサンプルコードを使用します。

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

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

C++ サンプルコード

C++ サンプルコード


Rasbian環境でのビルドと実行

次に makefile を作成します。

make ファイル

make ファイル



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

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

「表示(V)-統合ターミナル(I)」 で、ターミナルを開きます。makeコマンドでビルドします。

make 実行

make 実行



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

サンプルコードの実行

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

makeによる実行

makeによる実行


Visual Studio Codeからビルド

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

VS Code ビルド設定1

VS Code ビルド設定1

「Tasks-Build Task」または、[Ctrl]+[Shift]+[B]と入力します。

VS Code ビルド設定2

VS Code ビルド設定2

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

VS Code ビルド設定3

VS Code ビルド設定3

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

VS Code ビルド設定4

VS Code ビルド設定4

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

Windows10版のVS Code (Version 1.21.1)のtask.jsonとは記述方法が異なるようです。バージョンが異なります。

 

プラットフォーム VS Code Ver. task.json Ver.
Windows10 Ver 1.21.1 2.0.0
Rasbian Ver 1.14.0 0.1.0

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

VS Code ビルド設定5

VS Code ビルド設定5



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

VS Code ビルド設定6

VS Code ビルド設定6

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

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

VS Code テスト設定1

VS Code テスト設定1

「Tasks-Test Task」と入力します。

VS Code テスト設定2

VS Code テスト設定2

「タスクランナーの構成」をクリックします。

VS Code テスト設定3

VS Code テスト設定3



task.json が表示されますので、下記のように修正します。

VS Code テスト設定4

VS Code テスト設定4



 

VS Code テスト設定5

VS Code テスト設定5

「Tasks-Test Task」と入力すると、実行することができました。

 


 

VS Code タスク実行

VS Code タスク実行

「Tasks-Run Task…」と入力します。

VS Code タスク選択

VS Code タスク選択

[MyTest]と[MyBuild]のタスクの選択となります。

  • [MyTest]を選択すると、プログラム実行
  • [MyBuild]を選択すると、プログラムのビルド

 

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

拡張機能インストール1

拡張機能インストール1

左の拡張機能をクリックして、検索窓に「C/C++」と入力します。

拡張機能インストール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からブレークポイントを設定してデバッグできるようにします。

VS Code デバッグ設定1

VS Code デバッグ設定1

「デバッグ(D)-デバッグの開始(S)」または、[F5]と入力します。

VS Code デバッグ設定2

VS Code デバッグ設定2

環境の選択で [C++(GDB/LLDB)]を選択します。

VS Code デバッグ設定3

VS Code デバッグ設定3

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

 

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

program を修正します。

“program”: “enter program name, for example ${workspaceRoot}/a.out”,

“program”: “${workspaceRoot}/outAscii”,

VS Code デバッグ設定4

VS Code デバッグ設定4


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

デバッグアダプタープロセスが予期せずに終了しました」とエラーが発生して実行できませんでした。

デバッグ実行のエラー原因?

launch.json の記述内容にミスがあるかと考えて、いろいろ試行錯誤しましたが解決しません。

ネットで「Visual Studio Code デバッグアダプタープロセスが予期せずに終了しました」を検索キーとしていろいろ調べましたが、解決策らしい情報をみつけることができませんでした。「デバッグアダプタープロセスが予期せずに終了しました」という日本語のエラーメッセージに関する情報が少ないみたいです。

ロケールをEnglishにしたら、英語のメッセージが表示されるのではと考えました。

「Raspberry Pi Configuration」で Locale を ja(Japanese) → en(English) に変更してリブートします。

そして、Visual Studio Code を実行したら、メニューが英語表記になりました。

VS Code 英語メニュー

VS Code 英語メニュー

[F5]で実行します。

VS Code 英語エラーメッセージ

VS Code 英語エラーメッセージ

英語のエラーメッセージがわかりました。「Debug adapter process has terminated unexpectedly」というエラーです。


ネットで「Visual Studio Code Debug adapter process has terminated unexpectedly」を検索キーとして、いろいろ調べました。Debug adapter processの停止問題が多いようで、たくさんの情報がヒットしました。

どうも、C/C++拡張機能が ARMアーキテクチャーに正式に対応していないようです。

半分諦めかけていたときに、有益な情報をみつけることができました。

Debug adapter process has terminated unexpectedly on Raspberry pi #164にヒントがありました。

The C/C++ for Visual Studio Code extension has no official support for running on ARM platforms like the Raspberry Pi. However, it may work if you manually install Mono on your Pi by following the instructions here: http://www.mono-project.com/docs/getting-started/install/linux/#debian-ubuntu-and-derivatives

You’ll need to “apt-get install mono-runtime” at least, other packages may be required as well.

Visual Studio Code用のC/C++拡張拡張は、Raspberry PiのARMプラットフォームでの公式なサポートは無いようです。

I have a workaround to get the debugger working for you. You will need to download the mono runtime located at:
http://download.mono-project.com/repo/debian/pool/main/m/mono/

The file you are looking for is called:
mono-runtime-sgen_4.2.3.4-0xamarin1_armhf.deb

Extract the .deb file to some location and locate the mono-sgen executable.
mkdir ~/mono_temp
dpkg -x mono-runtime-sgen_4.2.3.4-0xamarin1_armhf.deb ~/mono_temp

The file should be under ~/mono_temp/usr/bin

Copy the file to your extension folder as follows. Notice that the file name is renamed to mono.linux:
cp ~/mono_temp/usr/bin/mono-sgen ~/.vscode-oss-dev/extensions/ms-vscode.cpptools-0.9.0/debugAdapters/mono.linux

Your debugging should now work.


monoランタイムが必要と書いてあります。「mono」とは、何でしょうか?

調べてみると、Monoは.NET Framework互換の環境を実現するためのオープンソースのソフトウェアらしいです。

monoランタイムの mono-sgenを /…/debugAdapters/mono.linux にコピーしなさいと書いてあります。これは何をしているのか、少し調べてみました。

私の環境では、デバッグアダプターが「~/.vscode-oss/extensions/ms-vscode.cpptools-0.14.0/debugAdapters」にインストールされています。

デバッグアダプターファイル (前)

デバッグアダプターファイル (前)

OpenDebugAD7 の内容を見ました。

MONO_CMD は、「~/.vscode-oss/extensions/ms-vscode.cpptools-0.14.0/debugAdapters/mono.linux」となります。

実際に mono.linuxが無いので、mono を起動して実行エラーになっていると考えました。


 

Mono is a Cross platform, open source .NET frameworkを参照すると各種バージョンがそろっています。

mono ランタイム

mono ランタイム

 

この情報に基づいて、monoランタイムをインストールします。

デバッグアダプターファイル (後)

デバッグアダプターファイル (後)

デバッグアダプターに mono.linux をコピーしたことを確認します。

デバッグ実行のエラー原因…解決したか?

mono.linux をインストールしたので、[F5]で再度実行してみます。

デバッガ起動の端末エラー

デバッガ起動の端末エラー

またもや、エラーが発生しました。

Unable to start debugging. No terminal is available to launch the debugger. Please install Gnome Terminal or XTerm

デバッガを起動するための端末が無いので、Gnome TerminalまたはXTermのインストールが必要なようです。

Gnome Terminalをインストールします。

今度はどうでしょうか? [F5]で実行してみます。

VS Code デバッグ実行1

VS Code デバッグ実行1

デバッグ実行が正常起動して、ブレークポイントで停止しました。これで、問題解決しました。

VS Code デバッグ実行2

VS Code デバッグ実行2

[F11]でシングルステップも正常に動作しています。

まとめ

Raspberry Pi3のC++開発環境をVisual Studio Codeで構築することができました。

C/C++拡張機能がARMアーキテクチャーに正式対応していませんでしたがネット情報を根気よく探した結果、手作業で動作するように対応できました。
このブログも同じ悩みをもつユーザーの役に立てば幸いです。

Raspberry Pi3のRasbian OSでVisual Studio Codeが使えるようになったのでC++の開発環境が快適になりました。