C++ Insights - See your source code with the eyes of a compiler.
Contents
What
C++ Insights is a Clang-based tool that does a source-to-source transformation. The goal of C++ Insights is to make things visible that normally and intentionally happen behind the scenes. It's about the magic the compiler does for us to make things work.
Take this piece of code for example:
class Base {
};
class Derived : public Base {
};
int main() {
Derived d;
Base& b = d;
}Nothing special and of course it compiles. This is the compilers view on it:
class Base {
/* public: inline constexpr Base() noexcept; */
/* public: inline ~Base(); */
/* public: inline constexpr Base(const Base &); */
/* public: inline constexpr Base(Base &&); */
};
class Derived : public Base {
/* public: inline constexpr Derived() noexcept; */
/* public: inline constexpr Derived(const Derived &); */
/* public: inline constexpr Derived(Derived &&); */
};
int main(){
Derived d;
Base& b = static_cast<Base&>(d);
}You can see all the compiler-provided functions as well as the downcast from Derived to Base.
Why
C++ Insights is a Clang-based tool that does a source-to-source transformation. The goal of C++ Insights is to make things visible that normally and intentionally happen behind the scenes. It's about the magic the compiler does for us to make things work. Or looking through the classes of a compiler.
In 2017 I started looking into some new things we got with C++11, C++14, and C++17. Amazing things like lambdas, range-based for-loops, and structured bindings. I put it together in a talk. You can find the slides and a video online.
However, all that research and some of my training and teaching got me to start thinking about how it would be if we could see with the eyes of the compiler. Sure, there is an AST dump, at least for Clang. With tools like Compiler Explorer, we can see what code the compiler generates from a C++ source snippet. However, what we see is assembler. Neither the AST nor the Compiler Explorer output is in the language I write code, and therefore I'm most familiar with. Plus, when teaching students C++ showing an AST and explaining that it is all there was not quite satisfying for me.
I started to write a Clang-based tool that can transform a range-based for-loop into the compiler-internal version. Then, I did the same
for structured bindings and lambdas. In the end, I did much more than initially planned. It shows where operators are
invoked and places in which the compiler does some casting. C++ Insights can deduce the type behind auto or decltype. The goal
is to produce compilable code. However, this is not possible in all places.
You can see, for example, the transformation of a lambda, range-based for-loop, or auto. Of course, you can transform any other C++ snippet.
See yourself. C++ Insights is available online: cppinsights.io.
Still, there is work to do.
I do not claim to get all the things right. I'm also working on supporting features from new standards, like C++20, at the moment. Please remember that C++ Insights is based on Clang and its understanding of the AST.
I did a couple of talks about C++ Insights since I released C++ Insights. For example, at C++ now. Here are the slides and the video.
Building
C++ Insights can be built inside the Clang source tree or outside.
Building on Windows
Building on Arch Linux
To build with extra/clang use the following extra flags: -DINSIGHTS_USE_SYSTEM_INCLUDES=off -DCLANG_LINK_CLANG_DYLIB=on -DLLVM_LINK_LLVM_DYLIB=on
See #186 for an explanation of why INSIGHTS_USE_SYSTEM_INCLUDES needs to be turned off.
extra/clang and extra/llvm provide /usr/lib/{libclangAST.so,libLLVM*.a,libLLVM.so}. libclangAST.so needs libLLVM.so and there would be a conflict if libLLVM*.a (instead of libLLVM.so) are linked. See https://bugs.archlinux.org/task/60512
Building outside Clang
You need to have a Clang installation in the search path.
git clone https://github.com/andreasfertig/cppinsights.git
mkdir build && cd build
cmake -G"Ninja" ../cppinsights
ninja
The resulting binary (insights) can be found in the build-folder.
Building inside Clang
For building it inside the Clang source tree, assuming you have your source tree already prepared:
cd llvm/tools/clang/tools/extra
git clone https://github.com/andreasfertig/cppinsights.git
echo "add_subdirectory(cppinsights)" >> CMakeLists.txt
Then build Clang as you normally do.
cmake options
There are a couple of options which can be enable with cmake:
| Option | Description | Default |
|---|---|---|
| INSIGHTS_STRIP | Strip insight after build | ON |
| INSIGHTS_STATIC | Use static linking | OFF |
| INSIGHTS_COVERAGE | Enable code coverage | OFF |
| INSIGHTS_USE_LIBCPP | Use libc++ for tests | OFF |
| DEBUG | Enable debug | OFF |
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/
Then in Cevelop Import -> General -> Existing Project into Workspace. Select build_eclipse. Enjoy editing with
Cevelop.
Usage
Using C++ Insights is fairly simple:
insights <YOUR_CPP_FILE> -- -std=c++17
Things get complicated when it comes to the system include paths. These paths are hard-coded in the binary, which seems
to come from the compiler C++ Insights was built with. To help with that, check out scripts/getinclude.py. The script tries to
collect the system include paths, from the compiler. Without an option, getinclude.py uses g++. You can also pass another compiler
as a first argument.
Here is an example:
./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
The script can be used together with C++ Insights:
insights <YOUR_CPP_FILE> -- -std=c++17 `./scripts/getinclude.py`
Custom GCC installation
In case you have a custom build of the GCC compiler, for example, gcc-11.2.0, and NOT installed in the compiler in the default system path, then after building, Clang fails to find the correct libstdc++ path (GCC's STL). If you run into this situation, you can use "--gcc-toolchain=/path/GCC-1x.x.x/installed/path" to tell Clang/C++ Insights the location of the STL:
./cppinsights Insights.cpp -- --gcc-toolchain=${GCC_11_2_0_INSTALL_PATH} -std=c++20
Here "${GCC_11_2_0_INSTALL_PATH}" is the installation directory of your customized-built GCC. The option for Clang is described here.
Ready to use Docker container
There is also another GitHub project which sets up a docker container with the latest C++ Insights version in it: C++ Insights - Docker
C++ Insights @ Vim
A plugin for Vim is available at here.
C++ Insights @ VSCode
An extension for Visual Studio Code is available at the VS Code marketplace: C++ Insights - VSCode Extension.
Compatibility
I aim that the repository compiles with the latest version of Clang and at least the one before. The website tries to stay close to the latest release of Clang. However, due to certain issues (building Clang for Windows), the website's version is often delayed a few months.
C++ Insights @ YouTube
I created a YouTube channel where I release a new video each month. In these videos, I use C++ Insights to show and explain certain C++ constructs, and sometimes I explain C++ Insights as well.
ToDo's
See TODO.
Get Involved
- Report bugs/issues by submitting a GitHub issue.
- Submit contributions using pull requests. See Contributing
Support
If you like to support the project, consider submitting a patch. Another alternative is to become a Patreon supporter.