Được TopGit lập chỉ mục từ metadata GitHub: andreasfertig/cppinsights có 4.7k sao, viết chủ yếu bằng C++. C++ Insights - See your source code with the eyes of a compiler
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
C++ Insights - See your source code with the eyes of a compiler.
Contents
What
Why
Building
Usage
Get Involved
Support
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;
Derived d2 = d;
d2 = d;
Base& b = d;
}
Nothing special, and of course, it compiles. This is the compiler's view on it:
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;
}
You can see all the compiler-provided special member functions and the upcast 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. We can see what code the compiler generates from a C++ source snippet with
tools like Compiler Explorer. However, what we see is assembler. Neither the AST nor the Compiler Explorer output is in the language I write
code. Hence, I'm not very familiar with this output. 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 or outside the Clang source tree.
Building on Windows
See Readme_Windows.md
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 https://github.com/andreasfertig/cppinsights/issues/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.
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.
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:
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 that sets up a docker container with the latest C++ Insights version in it: C++
Insights - Docker
Plugins / Extensions / Packages
C++ Insights @ Vim
A plugin for Vim is available at
here.
C++ Insights @ Neovim
A plugin for Neovim is available at
here.
C++ Insights @ VSCode
An extension for Visual Studio Code is available at the VS Code marketplace: C++
Insights - VSCode Extension.
C++ Insights @ brew
At least for macOS, you can install C++ Insights via Homebrew thanks to this formular:
brew install cppinsights
Shell autocomplete
There are completion scripts for bash, zsh and fish. They autocomplete the C++ Insights options (including their descriptions) as well as the Clang options provided after --.
When building from source, the completion scripts are installed automatically into the shell-specific directories under share/ (configurable via CMAKE_INSTALL_PREFIX):
If you install C++ Insights yourself (or just want the script), you can download them individually:
cd <YOUR_BASH_COMPLETION.D>
curl -o insights https://github.com/andreasfertig/cppinsights/tree/main/scripts/bash-autocomplete.sh
Compatibility
I aim for the repository to compile 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 by 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 GitHub Sponsor or a Patreon supporter.
andreasfertig/cppinsights có 4.7k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/andreasfertig/cppinsights. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
andreasfertig/cppinsights có phải mã nguồn mở không?
Có — andreasfertig/cppinsights phát hành theo license MIT, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/andreasfertig/cppinsights.
andreasfertig/cppinsights còn đang phát triển không?
Commit gần nhất trên andreasfertig/cppinsights là 5 tháng trước (theo timestamp GitHub). Repo có 270 fork — một chỉ báo về mức độ quan tâm của cộng đồng.
andreasfertig/cppinsights là gì?
andreasfertig/cppinsights (andreasfertig/cppinsights) là dự án C++ trên GitHub. Theo mô tả gốc: C++ Insights - See your source code with the eyes of a compiler
andreasfertig/cppinsights so với các dự án Backend khác thế nào?
andreasfertig/cppinsights được TopGit xếp vào nhóm Backend, với 4.7k sao GitHub và viết bằng C++. Xem trang chủ đề Backend trên TopGit để so sánh với các dự án tương tự theo số sao và mức độ hoạt động.
Đọc thêm về andreasfertig/cppinsights ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/andreasfertig/cppinsights là nguồn chính thức.
Đọc đầy đủ README ở tab phía trên.
Chưa chắc cppinsights có hợp với bạn?
Để ChatGPT, Claude hoặc Perplexity tìm hiểu giúp — bấm bên dưới và xem AI nói gì về cppinsights.