VSCodeでC/C++開発環境を整えてみる(MSBuild(Visual Studio Express)編)

公開日| 2017年10月20日 | コメントはまだありません。

カテゴリー:開発関連 | タグ: VSCode

ご利用のブラウザは、JavaScript が無効となっていませんか？
このサイトでは、コンテンツの一部が非表示、あるいは、コメント、お問い合わせの投稿ができない、検索ができないことがあります。

今や、Windows ユーザにとって Visual Studio Express や Visual Studio Community が無料で利用できるうれしい限りの環境となっています。少し前まで、高価な Visual Studio を購入するか、mingw ( g++ ) でゴリゴリ記述して開発やるか、選択肢が少ない環境でしたが、今やいろんな選択肢があります。

今回のVSCodeでも C/C++ 開発もその一つです。

ただ、一般的には、既に無料で手に入る Visual Studio Express や Visual Studio Community を使うことがもっとも楽で便利で、開発を行う上ではスピーディな開発が行えることは間違いありません。

ただ、Visual Studio Express においては、2017で最後になる模様です。

Expressエディションは2017が最後となり、今後は代替としてVisual Studio CodeとVisual Studio Communityの利用が推奨されている。 (出典:https://ja.wikipedia.org/wiki/Microsoft_Visual_Studio_Express )

Visual Studio Community では、ちょっとライセンスのしばりがきついと思われている方は、 VSCode への移行も勧めているらしいので、今回は、VSCodeで MSBuild(Visual Studio Express) を使ったC/C++開発環境を整えてみたいと思います。

目次
履歴

2017-10-18 初版

最低限必要な環境は？

VSCodeで C/C++ の開発を行う上で、最低限必要なものは、以下のものです。

Visual Studio Express or Visual Studio Community : MSコンパイラとMSBuild 、PDBデバッグが必須となります。
Visual Studio Code : 本体

→ https://code.visualstudio.com/download
C/C++ for Visual Studio Code(Extension) : マイクロソフトが提供しているC/C++開発環境です。VSCodeでデバッグする際に必須となります。

→ https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools
CMake : Visula Studio のプロジェクトファイル作成のためのツール

Visula Studio のプロジェクトファイルは、VC++ Expressでも作成できますので、そちらで済ませる方にはここでは不要です。
ただ、g++ や MinGW などへの移行もいずれは考える必要がある方は、ここで CMake を導入しておくと、 mingw、g++のmakefileの出力も CMake で可能ですから、あとで楽に移行ができるかと思います。（ここでは、インストール先を "C:\CMake" として解説します）
→ https://cmake.org/download/

上記は、すべて無料です。それぞれ、指示に従いインストールしましょう。

VSCodeで C/C++ で簡単なプログラミングをやってみよう

VSCodeで C/C++ で簡単なプログラミングをやってみます。

定番 Hello world を作る

適当なディレクトリを作成し、そこをここで利用する Hello World のプロジェクトディレクトリとします。ここでは、"C:/project/vsc/hello/" とします。

まずは、定番 Hello world の "hello.cpp" を作成します。

[ hello.cpp ]

#include <stdio.h>
 
int main()
{
	printf("Hello world");
	return 1;
}

エラー表示を解除する

先の "hello.cpp" の編集を終えたら、以下のように表示されているかと思います。

上記の緑の波線は、エラー表記となっています。
これは、C/C++ for Visual Studio Code(Extension) によって簡易エラー表記されているものですので、これはこれで、先のExtensionが間違いなく動作していることでもあります。

上記の緑の波線は、実際にはエラーではないので、C/C++ for Visual Studio Code(Extension) が正しく判断できていないことは、ソースコードからもわかります。

では、C/C++ for Visual Studio Code(Extension) が正しく判断できるように設定し、先の緑の波線のエラー表記を解除してみます。

C/C++ for Visual Studio Code のデフォルト設定ファイルを作成する。

Ctrl + Shift + P でコマンドパレット(ショートカットが設定されていない場合は、[表示]-[コマンドパレット])を表示します。

コマンドパレットから、"C/Cpp: Edit Configurations..." を選択します。
以下のデフォルトの C/C++ 設定ファイル( .vscode/c_cpp_properties.json ) が、カレントディレクトリの .vscode ディレクトリ に作成されます。

[ .vscode/c_cpp_properties.json ]

{
    "configurations": [
        {
            "name": "Mac",
            "includePath": [
                "/usr/include",
                "/usr/local/include",
                "${workspaceRoot}"
            ],
            "defines": [],
            "intelliSenseMode": "clang-x64",
            "browse": {
                "path": [
                    "/usr/include",
                    "/usr/local/include",
                    "${workspaceRoot}"
                ],
                "limitSymbolsToIncludedHeaders": true,
                "databaseFilename": ""
            },
            "macFrameworkPath": [
                "/System/Library/Frameworks",
                "/Library/Frameworks"
            ]
        },
        {
            "name": "Linux",
            "includePath": [
                "/usr/include",
                "/usr/local/include",
                "${workspaceRoot}"
            ],
            "defines": [],
            "intelliSenseMode": "clang-x64",
            "browse": {
                "path": [
                    "/usr/include",
                    "/usr/local/include",
                    "${workspaceRoot}"
                ],
                "limitSymbolsToIncludedHeaders": true,
                "databaseFilename": ""
            }
        },
        {
            "name": "Win32",
            "includePath": [
                "C:/Program Files (x86)/Windows Kits/8.1/Include/um",
                "C:/Program Files (x86)/Windows Kits/8.1/Include/shared",
                "C:/Program Files (x86)/Windows Kits/8.1/Include/winrt",
                "${workspaceRoot}"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE"
            ],
            "intelliSenseMode": "msvc-x64",
            "browse": {
                "path": [
                    "C:/Program Files (x86)/Windows Kits/8.1/Include/um",
                    "C:/Program Files (x86)/Windows Kits/8.1/Include/shared",
                    "C:/Program Files (x86)/Windows Kits/8.1/Include/winrt",
                    "${workspaceRoot}"
                ],
                "limitSymbolsToIncludedHeaders": true,
                "databaseFilename": ""
            }
        }
    ],
    "version": 3
}

とりあえず、インストールされている最新？ Windows SDK( Windows Kits )の include パスは設定？してくれるようです。
あとは、VC++の include パスを指定してあげると良さそうです。

VC++の include パスを確認する。

VC++の include パスを確認する最も簡単な方法は、VC++の開発コマンドプロンプトで環境変数の include を出力することです。
VC++の開発コマンドプロンプトは、Express版にもありますし、Windowsのスタートメニューから起動できます。

以下は、Visual Studio 2013 Express for Desktop での例です。

C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC> echo %include%

# 以下は見やすく改行をいれています。通常の出力は、セミコロン区切りのみです。
C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\INCLUDE;
C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\ATLMFC\INCLUDE;
C:\Program Files (x86)\Windows Kits\8.1\include\shared;
C:\Program Files (x86)\Windows Kits\8.1\include\um;
C:\Program Files (x86)\Windows Kits\8.1\include\winrt;
...

先のデフォルトのc_cpp_properties.json に設定されていない上２行をコピーすれば良さそうです。

C/C++ for Visual Studio Code の設定ファイルを編集する。

先で出力した include パスで、c_cpp_properties.json に設定されていない部分を加筆します。

[ .vscode/c_cpp_properties.json ]

{
    "configurations": [
        ...
        {
            "name": "Win32",
            "includePath": [
                "C:/Program Files (x86)/Microsoft Visual Studio 12.0/VC/INCLUDE",
                "C:/Program Files (x86)/Microsoft Visual Studio 12.0/VC/ATLMFC/INCLUDE",
                "C:/Program Files (x86)/Windows Kits/8.1/Include/um",
                "C:/Program Files (x86)/Windows Kits/8.1/Include/shared",
                "C:/Program Files (x86)/Windows Kits/8.1/Include/winrt",
                "${workspaceRoot}"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE"
            ],
            "intelliSenseMode": "msvc-x64",
            "browse": {
                "path": [
                    "C:/Program Files (x86)/Microsoft Visual Studio 12.0/VC/INCLUDE",
                    "C:/Program Files (x86)/Microsoft Visual Studio 12.0/VC/ATLMFC/INCLUDE",
                    "C:/Program Files (x86)/Windows Kits/8.1/Include/um",
                    "C:/Program Files (x86)/Windows Kits/8.1/Include/shared",
                    "C:/Program Files (x86)/Windows Kits/8.1/Include/winrt",
                    "${workspaceRoot}"
                ],
                "limitSymbolsToIncludedHeaders": true,
                "databaseFilename": ""
            }
        }
        ...
}

"includePath"（インクルード用パス）および "path"（インテリセンス用パス）に上2行を追記しました。

これで保存します。

エラー表記を再確認する。

C/C++ 設定ファイル( .vscode/c_cpp_properties.json )の更新を行えば、エラー表記が消えるはずなので、確認してみます。

上記のようにエラー表記の緑の波線が無くなっていればOKです。

VSCodeで C/C++ をビルドしてみよう

先に作成した "hello.cpp" をコンパイル、リンクし実行ファイルを作成します。

ここでの例が１つのソースコードなので、VC++の環境からすれば、cl.exe コマンドで実行ファイルを簡単に作成することもできます。

ただ、ここでは、MSBuild を使って VC++ のIDE環境と同じようにビルド(コンパイル、リンク)できるようにプロジェクトファイルを作成し、実際にMSBuild を使ってビルドしてみます。
（以降では、手動で行っていますが、本来はビルドタスクへ登録を行い、そのビルドタスクを実行することでビルドし、実行ファイルを作成します。確認作業の解説は要らない方は、ビルドタスクの項へどうぞ。）

プロジェクトファイルを作成してみる

VC++ のプロジェクトファイルは、ここでは、CMake を使ってみます。

もちろん、既にVC++ はインストールされているはずなので、VC++のIDEを使って、空のコンソールプロジェクトを作って先の "hello.cpp" を追加すれば簡単にできます。 CMake を使って回りくどいことをしたくない方は、VC++のIDEを使ってプロジェクトファイルを作成し、次のビルドしてみるへ進んでください。

CMake が "C:\CMake" にインストールされているものとして、以降、簡単に解説してみます。

CMake の設定ファイル(CMakeLists.txt)を作成する。

同一ディレクトリに "CMakeLists.txt" ファイルを作成し、以下の2行を追加します。
これで、hello.exe というコンソール実行ファイルが作成できるプロジェクトを作成できます。

[ CMakeLists.txt ]
cmake_minimum_required(VERSION 2.8) add_executable(hello hello.cpp)
CMake の設定内容などの詳細な解説は、時間とページの浪費を避けられないため、ここでは詳細な項目などの解説は行いません。 CMakeについては、必要であれば別途解説したいと思います。

VC++ プロジェクトファイルを出力してみる。

先に作成した CMake の設定ファイル(CMakeLists.txt) から DOSプロンプトから CMake を実行してVC++のプロジェクトファイルを出力してみます。ここでは、先にも例に使った Visual Studio 2013 express のためのプロジェクトファイルを作成してみます。

# CMake を使って Visual Studio 2013 用のプロジェクトファイルを出力します。
C:\project\vsc\hello> C:\CMake\bin\cmake.exe -G "Visual Studio 12 2013"
...
-- The C compiler identification is MSVC 18.0.40629.0
-- The CXX compiler identification is MSVC 18.0.40629.0
-- Check for working C compiler: C:/Program Files (x86)/Microsoft Visual Studio12.0/VC/bin/cl.exe
-- Check for working C compiler: C:/Program Files (x86)/Microsoft Visual Studio12.0/VC/bin/cl.exe -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working CXX compiler: C:/Program Files (x86)/Microsoft Visual Studio 12.0/VC/bin/cl.exe
-- Check for working CXX compiler: C:/Program Files (x86)/Microsoft Visual Studio 12.0/VC/bin/cl.exe -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: C:\project\vsc\hello


# 出力されたファイルを確認します。
C:\project\vsc\hello> dir /b

.vscode
ALL_BUILD.vcxproj
ALL_BUILD.vcxproj.filters
CMakeCache.txt
CMakeFiles
CMakeLists.txt
cmake_install.cmake
hello.cpp
hello.vcxproj
hello.vcxproj.filters
Project.sln
ZERO_CHECK.vcxproj
ZERO_CHECK.vcxproj.filters

"hello.vcxproj" が作成されているので OK のようですね。

MSBuild でビルドしてみる

先のプロジェクトファイル作成で作成したプロジェクトをビルドしてみましょう。
ビルドには、先に記述したように "MSBuild.exe" を使います。 MSBuildは、.NET Framework ベースなので、3.5 から 4.0 までは、同梱されていた？ようで、
C:\Windows\Microsoft.NET\Framework\v3.5 のように最後がバージョン情報となるようなディレクトリにあります。

MSBuildのバージョンが 4.0 以降は、
C:\Program Files (x86)\MSBuild\12.0 のようにMSBuildは分離され別のディレクトリとなっています。

ここでは、Visual Studio 2013 express なので、
このVSのバージョンだと .NET Framework 4.5.1 に対応しているので、それ以下のバージョンで動くMSBuild の最新は、MSBuild 12のようなのでそれを使ってみます。 ( 参考 : https://msdn.microsoft.com/ja-jp/library/bb822049(v=vs.110).aspx )

C:\project\vsc\hello> "C:\Program Files (x86)\MSBuild\12.0\Bin\MSBuild.exe" "hello.vcxproj"

Microsoft (R) Build Engine バージョン 12.0.40629.0
[Microsoft .NET Framework、バージョン 4.0.30319.42000]
Copyright (C) Microsoft Corporation. All rights reserved.

2017/10/19 20:46:19 にビルドを開始しました。

...

ビルドに成功しました。
    0 個の警告
    0 エラー

経過時間 00:00:04.14

上記のような出力であればOKのようです。

一連のビルド作業をビルドタスクとして登録してみよう

先に手動で行っったビルド作業をビルドタスクとしてtasks.json に記述することでコマンド起動することができます。では、早速、ビルドタスクとして登録してみましょう。

ビルドタスクのデフォルト設定ファイルを作成する。

Ctrl + Shift + P でコマンドパレット(ショートカットが設定されていない場合は、[表示]-[コマンドパレット])を表示します。

コマンドパレットから、"Tasks: Configure Task" を選択します。
以下のデフォルトのビルドタスクファイル( .vscode/tasks.json ) が、カレントディレクトリの .vscode ディレクトリに作成されます。

[ .vscode/tasks.json ]

{
	// See https://go.microsoft.com/fwlink/?LinkId=733558
	// for the documentation about the tasks.json format
	"version": "2.0.0",
	"tasks": [
		{
			"taskName": "build",
			"type": "process",
			"command": "msbuild",
			"args": [
				// Ask msbuild to generate full paths for file names.
				"/property:GenerateFullPaths=true",
				"/t:build"
			],
			"group": "build",
			"presentation": {
				// Reveal the output only if unrecognized errors occur.
				"reveal": "silent"
			},
			// Use the standard MS compiler pattern to detect errors, warnings and infos
			"problemMatcher": "$msCompile"
		}
	]
}

CMake のタスクを設定する。

ビルドタスクファイル( .vscode/tasks.json ) の雛形に、まずは、CMake のタスクを設定します。

[ .vscode/tasks.json ]

{
	// See https://go.microsoft.com/fwlink/?LinkId=733558
	// for the documentation about the tasks.json format
	"version": "2.0.0",
	"tasks": [
		{
			"taskName": "cmake",
			"type": "process",
			"command": "C:/CMake/bin/cmake.exe",
			"args": [
				"-G",
				"Visual Studio 12 2013"
			],
			"group": "build",
			"presentation": {
				// Reveal the output only if unrecognized errors occur.
				"reveal": "silent"
			}
			// Use the standard MS compiler pattern to detect errors, warnings and infos
		//	"problemMatcher": "$msCompile"
		}
	]
}

雛形から手を加えたのは、以下の項目になります。

taskName : タスク名

文字通りタスク名になります。この名前は、ビルドタスクを実行するときの一覧に表示されます。
command : コマンド

実行するコマンドイメージです。
args : コマンド引数

先のコマンドに渡すパラメータです。カンマ区切りで複数指定可です。
problemMatcher : 問題出力イメージのマッチング（正規表現）

結果出力の文字列のジャンプ先取得の正規表現になります。これは、既定のものになります。

MSBuild のタスクを設定する。

ビルドタスクファイル( .vscode/tasks.json ) に、MSBuild のタスクを設定します。

[ .vscode/tasks.json ]

{
	// See https://go.microsoft.com/fwlink/?LinkId=733558
	// for the documentation about the tasks.json format
	"version": "2.0.0",
	"tasks": [
		{
			"taskName": "cmake",
			...
			...
		},
		{
			"taskName": "build-debug",
			"type": "process",
			"command": "C:/Program Files (x86)/MSBuild/12.0/Bin/MSBuild.exe",
			"args": [
				"${workspaceRoot}/hello.vcxproj",
				"/p:Configuration=Debug;GenerateFullPaths=true",
				"/t:build"
			],
			"group": "build",
			"presentation": {
				// Reveal the output only if unrecognized errors occur.
				"reveal": "silent"
			},
			// Use the standard MS compiler pattern to detect errors, warnings and infos
			"problemMatcher": "$msCompile"
		},
		{
			"taskName": "build-release",
			"type": "process",
			"command": "C:/Program Files (x86)/MSBuild/12.0/Bin/MSBuild.exe",
			"args": [
				"${workspaceRoot}/hello.vcxproj",
				"/p:Configuration=Release;GenerateFullPaths=true",
				"/t:build"
			],
			"group": "build",
			"presentation": {
				// Reveal the output only if unrecognized errors occur.
				"reveal": "silent"
			},
			// Use the standard MS compiler pattern to detect errors, warnings and infos
			"problemMatcher": "$msCompile"
		}
	]
}

雛形から手を加えたのは、以下の項目になります。

taskName : タスク名

文字通りタスク名になります。この名前は、ビルドタスクを実行するときの一覧に表示されます。
command : コマンド

実行するコマンドイメージです。MSBuild のフルパスを指定しました。
args : コマンド引数

先のコマンドに渡すパラメータです。カンマ区切りで複数指定可です。 Configuration=Release のようにリリース版とデバッグ版でそれぞれのパラメータを指定しました。

最後に動作確認する。

ここまでで設定は終了です。設定がうまくいっているか確認のために、一度、実行してみます。
1. Ctrl + Shif + B でビルドタスクの実行(Tasks: Run Build Task)（ショートカットが設定されていない場合はコマンドパレット([表示]-[コマンドパレット])から検索してください）を実行します。
2. ビルドタスクの一覧から実行したいタスクをクリックします。
  
  ここでは、"cmake" をクリックしてみます。
3. ビルドタスクの出力をスキャンするかのー一覧からスキャンの種別をクリックします。
  
  ここでは、"タスクの出力をスキャンせずに続行" をクリックしてみます。
4. ターミナルに実行結果が出力されたか確認します。
  
  正しく動作したら、実行結果がターミナルへ出力されます。上記のように出力されればOKです。

VSCodeで C/C++ をデバッグしてみよう

最後にデバッグ実行してみます。もちろんブレークポイントを設定して、停止してみます。

デバッグ実行のデフォルト設定ファイルを作成する。

サイドメニューのデバッグをクリックし、歯車アイコンをクリック( メニューの[デバッグ]-[構成の追加...] でも可 )してデバッグ環境の一覧が表示されます。

ここでは、"C++(Windows)" を選択します。
以下のデフォルトのデバッグ設定ファイルが( ./vscode/launch.json )作成されます。

[ .vscode/launch.json ]

{
		"version": "0.2.0",
		"configurations": [
			{
				"name": "(Windows) Launch",
				"type": "cppvsdbg",
				"request": "launch",
				"program": "enter program name, for example ${workspaceRoot}/a.exe",
				"args": [],
				"stopAtEntry": false,
				"cwd": "${workspaceRoot}",
				"environment": [],
				"externalConsole": true
			}
		]
	}

デバッグ設定ファイルを編集する。

デバッグ設定ファイルを編集します。編集するといってもデバッグ対象の実行ファイルを指定している "program" の1行だけです。

[ .vscode/launch.json ]

{
		"version": "0.2.0",
		"configurations": [
			{
				"name": "(Windows) Launch",
				"type": "cppvsdbg",
				"request": "launch",
				"program": "${workspaceRoot}/debug/hello.exe",
				"args": [],
				"stopAtEntry": false,
				"cwd": "${workspaceRoot}",
				"environment": [],
				"externalConsole": true
			}
		]
	}

最後にデバッグ実行する。

設定はこれでOKです。
ソースコードにブレークポイントを設定し、これでデバッグ実行してみます。

"hello.cpp" を開き適当な場所にマウスでクリックするとブレークポイントが設定できます。
それで、[ デバッグ ] - [ デバッグ開始 ] でデバッグ実行してみると、先の設定したブレークポイントで停止すれば、環境的には、全て整ったことになります。

上のgif 動画は、そのデバッグ実行の様子です。
最後に指定したブレークポイントで正しく停止していますのでOKですね。

いかがだったでしょうか？

まだまだ、VC++ のIDE からすれば、かなり面倒ですね。（GUIでプロパティをいろいろ設定する手間を考えれば、案外、楽にできるかもしれませんが・・。）
ただ、今後、Visual Studio の Express版がなくなれば、ゆるい制限で利用できる開発環境がなくなることになります。一応、マイクロソフトも Express版は、VSCode への移行を考えているようなので、基本的なところをおさえておくのも良いのかもしれません。

マルチプラットフォームでの開発を行う上では、g++ (Windows では、MinGW or cygwin) での開発環境が良いのかもしれません。ただ、Windowsでは、どうしても VC++ の環境から抜けられない場合も多いので、上記のような環境を１つのクッションとして、g++ への移行を考えるのも１つかもしれません。

ただ、すぐに必要性はないので、今は、Visual Studioを使ったほうが楽です。興味のある方は、お試しを。

この記事を読んだ人は、こんな記事も読んでいます。:

コメントをどうぞ

PHPの使えるレンタルサーバー

初級者向け

簡単インストール機能のあるロリポップ！スタンダードプラン
Joomla!,wordpress などインストールに不安のある方には、簡単インストール機能のあるロリポップ！スタンダードプラン（旧チカッパ）がおすすめ！！

中級者向け

安定感抜群のさくらインターネットプレミアム
Joomla!,wordpress などsshを使って自由にＣＭＳを構築したい方には、安定感抜群のさくらインターネットプレミアムがおすすめ！！

上級者向け

root権限ありのさくらインターネット VPS
１からサーバー構築を行い方には、root権限ありのさくらインターネット VPS がおすすめ！！
サーバー構築なんて、面倒臭い方には、安定感、セキュリティ面、大容量などなど、充実したさくらインターネットビジネスプロがおすすめ！！

詳しくは、
WordPress, Joomla! が使えそうな無料/有料レンタルサーバーで、いろいろなレンタルサーバを確認できます。

コンテンツ

このサイトは？

ウェブやソフトウェアに関するサポート＆情報サイトです。サイト構築からソフトウェアの作成、利用まであなたの助けになるかも・・・・しれません。たぶん・・。

VSCodeでC/C++開発環境を整えてみる(MSBuild(Visual Studio Express)編)

最低限必要な環境は？

VSCodeで C/C++ で簡単なプログラミングをやってみよう

定番 Hello world を作る

エラー 表示を解除する

VSCodeで C/C++ をビルドしてみよう

プロジェクトファイルを作成してみる

MSBuild でビルドしてみる

一連のビルド作業をビルドタスクとして登録してみよう

VSCodeで C/C++ をデバッグしてみよう

この記事を読んだ人は、こんな記事も読んでいます。:

コメント

最近の記事

PHPの使えるレンタルサーバー

コンテンツ

このサイトは？

エラー表示を解除する