2019年12月4日水曜日

Developer PowerShell for VS 2019をx64に切り替える方法

Visual Studio 2019から,Developer PowerShell for VS 2019,というものが付いてきます.

これで,PowerShellからcl.exeを使うためにゴニョゴニョしなくて済む,と思ったら,コンパイラが32bit環境になっていました.

次のコマンドで確認したときに,パスがHostx86のx86になっていました.

(gcm cl).Source

どうしても64bit環境が使いたいのですが,コマンドプロンプトについては,x86,x86からx64のクロスコンパイル,x64,x64からx86のクロスコンパイル,としっかり組み合わせが用意されているのに,PowerShellについては用意されていません.

そこで,Developer PowerShell for VS 2019のリンクのプロパティを見て,実際に何をやっているのか確認してみました.

%SystemRoot%\system32\WindowsPowerShell\v1.0\powershell.exe -noe -c "&{Import-Module """C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\Microsoft.VisualStudio.DevShell.dll""";Enter-VsDevShell インスタンスID}"

インスタンスIDの部分は,たぶん環境によって変わります.

どうやら,Enter-VsDevShellというものを呼び出しているようです.取り合えずヘルプを見てみましょう.

Get-Help -Detailed Enter-VsDevShell

非常に簡単なことしか書いていませんが,-DevCmdArgumentsというものがあることに気付きます.これに -help を渡してみます.

Enter-VsDevShell インスタンスID -DevCmdArguments -help

すると,どうやらvsdevcmd.batを裏で呼んでいるようです.これについても情報が少ないのですが,あれこれ調べた結果,-arch=x64を指定してやれば良さそうです.

Developer PowerShell for VS 2019のリンクのプロパティからリンク先を書き換えてみましょう.
%SystemRoot%\system32\WindowsPowerShell\v1.0\powershell.exe -noe -c "&{Import-Module """C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\Tools\Microsoft.VisualStudio.DevShell.dll""";Enter-VsDevShell インスタンスID -DevCmdArguments -arch=x64}"

書き換えたら,そのリンクからPowerShellを起動します.そして,もう一度次のコマンドを実行します.

(gcm cl).Source

無事,Hostx64のx64が選択されています.

やってやりました!

via GIFMAGAZINE



ちなみにインスタンスIDは,書いてあるものを使えば良いのですが,間違えて消してしまったりした場合,vswhereというものを使えば見れるようです.

注意点として,どうもリンク先の長さに上限があるらしく,書き換え方次第では入りきらなくなるようです.

2019年12月3日火曜日

CMakeで生成したVisual C++のプロジェクトで例外を無効にする方法

CMake 3.15.5でVisual Studio 2019向けに生成したプロジェクトで,次のようなCMakeのコマンドを実行して確認する.

message("${CMAKE_CXX_FLAGS}")

すると,/EHscが入っていることが分かる.これを次のように削除する.

string(REPLACE " /EHsc" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")

すると,プロパティページの「C/C++」の「コード生成」の「C++の例外を有効にする」が空欄になる.合わせて,「_HAS_EXCEPTIONS=0」をtarget_compile_definitionsで定義してやれば,例外を無効にできる.

他に何か良い方法があれば教えて欲しい.

コマンドラインからVisual Studioの仕組みを学ぶ2

前回はこちら
コマンドラインからVisual Studioの仕組みを学ぶ

マクロによるDebug版とRelease版の切り替え


さて,次のように_DEBUGの有無でデバッグ時とそれ以外で処理を変える,といったコードを書いたことはあるでしょうか?

#include <iostream>
using namespace std;

int main()
{
#if defined(_DEBUG)
    cout << "Debug" << endl;
#else
    cout << "Release" << endl;
#endif
}

この例だとあまり意味はないですが,例えば開発中のみデバッグ機能を有効にしたり,特別にログを出力するようにするなど,こういった書き方をすることは良くあります.

ところで,この _DEBUG というマクロはどこで定義されているのでしょうか? また,定義されていたとすると,デバッグ機能を無効にしたい場合は,わざわざ消さないといけないのでしょうか?

そんな面倒なことはしません.コマンドラインのオプションでマクロを定義することができます.これにより,コンパイル時にデバッグ有り版とデバッグ無し版を切り替えることができます.

マクロの定義には "/D マクロ" という書き方をします.

次のコマンドでは,_DEBUGが定義された状態でコンパイルします.
cl /EHsc /D _DEBUG main.cpp

一方,次のコマンドでは,_DEBUGが定義されていない状態でコンパイルします.
cl /EHsc main.cpp

ソースコードを読んでいて,どこにも定義されていないマクロに遭遇したことがあるかもしれません.そういったマクロは,このようにコンパイル時に定義されているのです.

Visual Studioのプロパティとしては,C/C++のプリプロセッサのプリプロセッサの定義になります.このプロパティは ; 区切りでマクロが定義されていて,コンパイル時にはそれを分解して,それぞれを /D と一緒にコンパイラに渡しているわけです.

プロパティの左上にある構成をDebugやReleaseで切り替えると,このプリプロセッサの定義,が変わることが分かります.

Visual Studioでは,DebugやReleaseといった目的やx64などのプラットフォームの組み合わせ毎に,こういった定義を設定することができて,その設定に合わせてコンパイラにマクロを渡してくれているわけです.

clangの場合,-D でマクロが定義できます.似ていますね.そして,clangを使っているXcodeでも,同じようにマクロを定義する項目があります.

まとめ

/D マクロ,でコンパイル時にマクロを定義した状態でコンパイルすることができます.
DebugやReleaseといった構成やx64などのプラットフォームを切り替えると,プロパティのプリプロセッサの定義が切り替わり,/D の形にしてコンパイラに渡してくれます.

おまけ

Windows.hを開いてみると,色々とコードを変更するためのマクロが書いています.特に,NOMINMAXは,次のようなコードがちゃんとコンパイルできるようにするために必要です.

#include <iostream>
#include <cmath>

int main()
{
 std::cout << std::min(1, 2) << endl;
}

どうしてNOMINMAXが必要なのか,実際に確かめてみると理解が深まるかもしれません.

ついでに,_USE_MATH_DEFINESについても調べておくと,役立つときがあるかもしれません.

2019年12月2日月曜日

コマンドラインからVisual Studioの仕組みを学ぶ



Visual Studioそのものについて解説した本や,Visual C++について解説した本はいくつかあります.ただ,Visual Studioの場合,C#前提だったり,Visual C++についての本でもC++のコードを書くことが前提だったりして,自分でライブラリを作ったり,他のライブラリを利用したりする場合の方法についてはあまり詳しくなかったりします.

このツイートの後に,コマンドラインを覚えれば,色々なIDEの設定などが分かるのでは,という話になったものの,そういった解説って無いよね,という話になったので,ちょっと書いてみようかと.

前提として,Visual Studio 2019でC++の開発環境が入っている前提とします.
また,cdやmkdirなど基本的なコマンドラインの機能についてはこの解説には含めないので,必要に応じて調べてみてください.

コマンドラインを使えるようにする

スタートメニューからVisual Studio 2019のフォルダを探し,Developer Command Prompt for VS 2019かDeveloper PowerShell for VS 2019を起動します.

起動したら,次のコマンドを実行してみましょう.

cl /?

この,cl というのがC++のコンパイラで,/?を渡すことで指定できるオプションの一覧を表示したわけです.

Visual C++の設定の多くは,このclに渡すオプションを生成するために使われます.

そして,ここが肝心なポイントなのですが,色々なC++コンパイラでコマンドラインから指定できるオプションには,共通の機能を提供するものが多々あるのです.

つまり,コマンドラインのオプションが分かっていれば,このオプションを設定するIDEの設定項目はどれか,という探し方ができるので,普段Visual Studioを使っていて,突然Xcodeを使うことになったとしても,何となく設定する方法が分かってしまうのです.

コンパイルしてみる

よくあるHello, Worldをコンパイルしてみましょう.

// main.cpp
#include <iostream>
using namespace std;

int main()
{
    cout << "Hello, World!" << endl;
}
cl main.cpp

コンパイルすると,何やら警告が出ます.着目するポイントは,warning(警告)という単語の直後のC4530という警告の番号です.これをGoogleなどで検索すると,Microsoftのドキュメントが表示されます.

他にもエラーや警告が出た場合,必ずその直後にこういったエラーの種類を示す番号が出ているので,Microsoftのドキュメントで検索してみましょう.エラーや警告の理由が分かれば,修正もしやすくなります.

詳細については省くとして,取り合えず/EHscを指定しろ,ということなので,次のように指定してみましょう.

cl /EHsc main.cpp

これで,問題なくコンパイルできました.同じフォルダにmain.exeとmain.objというファイルができているはずです.

さて,このobjってなんでしょう? これは,C++のソースコードをコンパイルした結果です.これに,標準ライブラリなどの機能をリンクさせて,最終的に実行可能ファイル(exe)になるのです.

簡単なソースコードの場合,コンパイルも一瞬で終わるので気になりませんが,大規模になってくるとコンパイル時間は数十分,数時間,場合によっては一晩かかったりするかもしれません.

できれば,変更した部分だけコンパイルするようにしたいところですよね.IDEは,objとcppを比較して,更新されている場合だけコンパイルする,といったことをすることで,コンパイル時間を短くする手助けをしてくれています.

単純に比較しているわけではなく,ヘッダファイルを書き換えた場合,そのヘッダファイルをインクルードしているcppも変更の対象にしてくれたり,と色々と賢くやってくれています.

ちなみに,この/EHscというのは,プロジェクトのプロパティのC/C++のコード生成のC++の例外を有効にする,で設定できる値です.

インクルードパスを指定する


さて,続いてインクルードパスについて解説します.まずは,次のような構造で必要なファイルを用意してください.

main.cppがあって,subフォルダがあって,その中にheader.hとsub.cppがある状態です.

|- main.cpp
|- sub
|   |- header.h
|   |- sub.cpp

それぞれのファイルの中身は次のようになります.

// sub/header.h
#ifndef HEADER_H_INCLUDED
#define HEADER_H_INCLUDED

int f();

#endif // HEADER_H_INCLUDED

// sub/sub.cpp
#include "header.h"

int f()
{
    return -1;
}

// main.cpp
#include <iostream>
#include "sub/header.h"

using namespace std;

int main()
{
    cout << f() << endl;
}

これをコンパイルしてみましょう.

cl /EHsc main.cpp sub/sub.cpp

いくつか注目するポイントがあります.

1つ目は,#includeの後の書き方に2種類あることです.一般的に,<と>で囲まれている場合,コンパイラが定義したパスからの相対パスでインクルードするファイルを探し,"で囲まれている場合,コンパイルしているファイルのある場所からの相対パスでインクルードするファイルを探した後に,コンパイラが定義したパスからの相対パスでインクルードするファイルを探します.

2つ目は,sub/header.hという書き方です.1つ目の説明でも書いたように,インクルードするファイルの指定は相対パスになるので,フォルダを指定して,そのフォルダ以下にあるファイルを指定することも可能なのです.

さて,先ほどからコンパイラが定義した場所から,と言っていますが,それを追加する方法があります.まずは,main.cppを次のように書き換えてみましょう.

// main.cpp
#include <iostream>
#include 
using namespace std; int main() { cout << f() << endl; }

次のように,/I subを追加すると,コンパイルできます.

cl /EHsc /I sub main.cpp sub/sub.cpp

/I の後にパスを書くことで,コンパイラがインクルードするファイルを探すパスのリストに追加することができます.

一般的には,他のライブラリを利用する場合,そのライブラリのヘッダファイルなどは一か所にまとまっていて,そのルートフォルダへのパスを/Iで指定することで利用できるようにします.

これは,プロジェクトのプロパティでは,C/C++の全般の追加のインクルードディレクトリに当たります.この項目に ; 区切りで設定したパスは,区切りで分けられ,それぞれ/I に指定されます.

同様の設定は,Xcodeにも存在しますし,Xcodeが利用しているclangというコンパイラにも同様の設定があります.clangの場合 -I で指定します.そう,似ているんですよ.

まとめ

コマンドラインのコンパイラへの理解を深めることで,IDEの設定項目についての理解を深め,プロジェクトの環境を整えることができるようになります.

まだまだ説明したいことはありますが,長くなるのでまた分けて書こうと思います.

考えている話題は,こんな感じです.

  • 警告レベルの変更
  • 警告やエラーの抑制
  • 警告をエラーに
  • 最適化レベルの変更
  • リンク関係の設定
  • ソースコードからコンパイラに指示を出す方法
  • ビルドイベント
  • C++言語仕様の選択