C++ Insights – コンパイラの目でソースコードを見る
C++ Insights – See your source code with the eyes of a Compiler (github.com)
要約
C++ Insightsは、コンパイラがソースコードに対して行う内部的な変換や、通常は隠されている処理を可視化するClangベースのソース・トゥ・ソース変換ツールです。ラムダ式、範囲ベースforループ、autoキーワード、構造化束縛などのC++の機能を、コンパイラがどのように解釈・展開するかを、コンパイラが生成するコードに近い形で理解できるようにします。これにより、C++の学習者や開発者は、コードが実際にどのように機能するかをより深く理解することができます。
全文翻訳
C++ Insights - コンパイラの視点でソースコードを見る。
[画像: License] [画像: download] [画像: Build Status] [画像: codecov] [画像: Try online] [画像: Documentation] [画像: patreon]
目次
What
C++ Insightsは、Clangをベースとしたソースコードからソースコードへの変換ツールです。C++ Insightsの目標は、通常は意図的にバックグラウンドで行われることを可視化することです。それは、物事を機能させるためにコンパイラが私たちにしてくれる魔法のようなものです。
例えば、このコード片を見てみましょう。
class Base {
};
class Derived : public Base {
};
int main() {
Derived d;
Derived d2 = d;
d2 = d;
Base& b = d;
}
特別なことは何もありませんし、もちろんコンパイルも通ります。これがコンパイラの視点からのコードです。
class Base
{
public:
// inline constexpr Base() noexcept = default;
// inline constexpr Base(const Base &) noexcept = default;
// inline constexpr Base & operator=(const Base &) noexcept = default;
};
class Derived : public Base
{
public:
// inline constexpr Derived() noexcept = default;
// inline constexpr Derived(const Derived &) noexcept = default;
// inline constexpr Derived & operator=(const Derived &) noexcept = default;
};
int main()
{
Derived d;
Derived d2 = Derived(d);
d2.operator=(d);
Base & b = static_cast<Base&>(d);
return 0;
}
コンパイラによって提供されるすべての特殊メンバ関数と、DerivedからBaseへのアップキャストが見えます。
Why
C++ Insightsは、Clangをベースとしたソースコードからソースコードへの変換ツールです。C++ Insightsの目標は、通常は意図的にバックグラウンドで行われることを可視化することです。それは、物事を機能させるためにコンパイラが私たちにしてくれる魔法のようなものです。あるいは、コンパイラのクラスを通して見ることです。
2017年、私はC++11、C++14、C++17で導入されたいくつかの新しい機能について調べ始めました。ラムダ、範囲ベースforループ、構造化束縛のような素晴らしい機能です。私はそれらをまとめて一つのトークにしました。スライドとビデオはオンラインで見つけることができます。
しかし、そのすべての調査と、私のトレーニングや教育の一部が、コンパイラの目を通して見ることができたらどうなるだろうかと考えさせられました。確かに、ASTダンプはあります。少なくともClangには。Compiler Explorerのようなツールで、コンパイラがC++ソーススニペットからどのようなコードを生成するかを見ることができます。しかし、私たちが目にするのはアセンブラです。ASTもCompiler Explorerの出力も、私がコードを書く言語ではありません。そのため、この出力にはあまり慣れていません。さらに、学生にC++を教える際に、ASTを見せて、それがすべてだと説明しても、私にとってはあまり満足のいくものではありませんでした。
私は、範囲ベースforループをコンパイラの内部バージョンに変換できるClangベースのツールを書き始めました。その後、構造化束縛やラムダについても同様のことを行いました。最終的には、当初計画していたよりもはるかに多くのことを行いました。演算子が呼び出される場所や、コンパイラがキャストを行う場所を示します。C++ Insightsは、autoやdecltypeの背後にある型を推測できます。目標は、コンパイル可能なコードを生成することです。しかし、これはすべての場所で可能なわけではありません。
例えば、ラムダ、範囲ベースforループ、またはautoの変換を見ることができます。もちろん、他のC++スニペットも変換できます。
自分で見てみてください。C++ Insightsはオンラインで利用可能です: cppinsights.io。
それでも、まだやるべきことはあります。
私はすべてを正しく理解していると主張するつもりはありません。現在、C++20のような新しい標準の機能のサポートにも取り組んでいます。C++ InsightsはClangとそのASTの理解に基づいていることを覚えておいてください。
C++ Insightsをリリースして以来、いくつかのトークを行いました。例えば、C++ nowでのトークです。スライドとビデオは以下の通りです。
Building
C++ Insightsは、Clangソースツリーの内側または外側でビルドできます。
Building on Windows
Readme_Windows.mdを参照してください。
Building on Arch Linux
extra/clangでビルドするには、次の追加フラグを使用します: -DINSIGHTS_USE_SYSTEM_INCLUDES=off -DCLANG_LINK_CLANG_DYLIB=on -DLLVM_LINK_LLVM_DYLIB=on
INSIGHTS_USE_SYSTEM_INCLUDESをオフにする必要がある理由については、#186を参照してください。
extra/clangとextra/llvmは/usr/lib/{libclangAST.so,libLLVM*.a,libLLVM.so}を提供します。libclangAST.soはlibLLVM.soを必要とし、libLLVM*.a(libLLVM.soの代わりに)をリンクすると競合が発生します。詳細はhttps://bugs.archlinux.org/task/60512を参照してください。
Building outside Clang
検索パスにClangのインストールが必要です。
git clone https://github.com/andreasfertig/cppinsights.git
mkdir build && cd build
cmake -G"Ninja" ../cppinsights
ninja
結果のバイナリ(insights)はbuildフォルダにあります。
Building inside Clang
Clangソースツリー内でC++ Insightsをビルドする最も簡単な方法は、LLVM_EXTERNAL_PROJECTSオプションを使用することです。
git clone https://github.com/llvm/llvm-project.git
git clone https://github.com/andreasfertig/cppinsights.git
mkdir build
cd build
cmake -G Ninja -D=CMAKE_BUILD_TYPE=Release -DLLVM_EXTERNAL_PROJECTS=cppinsights -DLLVM_EXTERNAL_CPPINSIGHTS_SOURCE_DIR=<PATH/TO/cppinsights> [INSIGHTS CMAKE OPTIONS] ../llvm-project/llvm
ninja
cmake options
cmakeで有効にできるオプションがいくつかあります。
| Option | Description | Default |
|---|---|---|
| INSIGHTS_STRIP | ビルド後にinsightをストリップする | ON |
| INSIGHTS_STATIC | 静的リンクを使用する | OFF |
| INSIGHTS_COVERAGE | コードカバレッジを有効にする | OFF |
| INSIGHTS_USE_LIBCPP | テストにlibc++を使用する | OFF |
| DEBUG | デバッグを有効にする | OFF |
Building for ARM on macOS
アーキテクチャを構成中に指定するのが最善のようです。
cmake -DCMAKE_OSX_ARCHITECTURES=arm64 ../cppinsights
Use it with Cevelop
git clone https://github.com/andreasfertig/cppinsights.git
mkdir build_eclipse
cd build_eclipse
cmake -G"Eclipse CDT4 - Unix Makefiles" ../cppinsights/
その後、CevelopでImport -> General -> Existing Project into Workspaceを選択します。build_eclipseを選択してください。Cevelopでの編集をお楽しみください。
Usage
C++ Insightsの使用は非常に簡単です。
insights <YOUR_CPP_FILE> -- -std=c++17
システムインクルードパスに関しては、状況は複雑になります。これらのパスは、C++ Insightsがビルドされたコンパイラから取得されるバイナリにハードコードされているようです。そのために役立つのが、scripts/getinclude.pyです。このスクリプトは、コンパイラからシステムインクルードパスを収集しようとします。オプションなしで、getinclude.pyはg++を使用します。別のコンパイラを最初の引数として渡すこともできます。
例を挙げます。
./scripts/getinclude.py
-isystem/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/../include/c++/v1 -isystem/usr/local/include -isystem/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/../lib/clang/7.3.0/include -isystem/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include -isystem/usr/include
このスクリプトはC++ Insightsと組み合わせて使用できます。
insights <YOUR_CPP_FILE> -- -std=c++17 `./scripts/getinclude.py`
Custom GCC installation
カスタムビルドのGCCコンパイラ(例: gcc-11.2.0)があり、システムデフォルトパスにインストールされていない場合、ビルド後、Clangは正しいlibstdc++パス(GCCのSTL)を見つけるのに失敗します。この状況に陥った場合は、--gcc-toolchain=/path/GCC-1x.x.x/installed/pathを使用して、Clang/C++ InsightsにSTLの場所を伝えることができます。
./cppinsights Insights.cpp -- --gcc-toolchain=${GCC_11_2_0_INSTALL_PATH} -std=c++20
ここで「${GCC_11_2_0_INSTALL_PATH}」は、カスタマイズされたGCCのインストールディレクトリです。Clangのオプションについては、こちらで説明されています。
Ready to use Docker container
最新バージョンのC++ Insightsを搭載したDockerコンテナを設定する別のGitHubプロジェクトもあります: C++ Insights - Docker
Plugins / Extensions / Packages
C++ Insights @ Vim
Vim用のプラグインがこちらで利用可能です。
C++ Insights @ Neovim
Neovim用のプラグインがこちらで利用可能です。
C++ Insights @ VSCode
Visual Studio Code用の拡張機能がVS Codeマーケットプレイスで利用可能です: C++ Insights - VSCode Extension。
C++ Insights @ brew
少なくともmacOSでは、このフォーミュラのおかげでHomebrew経由でC++ Insightsをインストールできます。
brew install cppinsights
Shell autocomplete
bash、zsh、fish用の補完スクリプトがあります。これらは、C++ Insightsオプション(説明を含む)および--の後に続くClangオプションを補完します。
ソースからビルドすると、補完スクリプトはshare/の下のシェル固有のディレクトリに自動的にインストールされます(CMAKE_INSTALL_PREFIXで設定可能)。
cmake --install build
これにより、スクリプトは次の場所に配置されます。
- bash:
share/bash-completion/completions/insights - zsh:
share/zsh/site-functions/_insights - fish:
share/fish/vendor_completions.d/insights.fish
C++ Insightsを自分でインストールした場合(またはスクリプトだけが必要な場合)、個別にダウンロードできます。
cd <YOUR_BASH_COMPLETION.D>
curl -o insights https://github.com/andreasfertig/cppinsights/tree/main/scripts/bash-autocomplete.sh
Compatibility
リポジトリが最新バージョンのClangでコンパイルされ、少なくともその一つ前でもコンパイルされることを目指しています。ウェブサイトはClangの最新リリースに近くなるように努めています。しかし、特定の(Windows用のClangのビルドなど)問題のため、ウェブサイトのバージョンは数ヶ月遅れることがよくあります。
C++ Insights @ YouTube
毎月新しいビデオを公開するYouTubeチャンネルを作成しました。これらのビデオでは、C++ Insightsを使用して特定のC++構文を示して説明し、時にはC++ Insights自体についても説明します。
ToDo's
TODOを参照してください。
Get Involved
- GitHub issueを提出してバグ/問題を報告する。
- pull requestsを使用して貢献を提出する。Contributingを参照してください。
Support
プロジェクトをサポートしたい場合は、パッチの提出を検討してください。もう一つの選択肢は、GitHub SponsorまたはPatreonのサポーターになることです。