Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inspector-repl/inspector
A drop-anywhere C++ REPL
https://github.com/inspector-repl/inspector
cpp17 gdb inspector lldb repl
Last synced: 13 days ago
JSON representation
A drop-anywhere C++ REPL
- Host: GitHub
- URL: https://github.com/inspector-repl/inspector
- Owner: inspector-repl
- License: other
- Created: 2017-07-24T08:22:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-12T03:36:03.000Z (over 1 year ago)
- Last Synced: 2024-10-13T16:20:52.347Z (29 days ago)
- Topics: cpp17, gdb, inspector, lldb, repl
- Language: C++
- Size: 85.9 KB
- Stars: 838
- Watchers: 27
- Forks: 30
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.TXT
Awesome Lists containing this project
README
# Inspector - A drop-anywhere C++ REPL
[](https://travis-ci.org/inspector-repl/inspector)
Allows to inject a fully-functional C++17 REPL into running, compiled programs
that can access your program state and offers features like code-completion and
syntax highlighting.
The API is similar to tools like [Pry](http://pryrepl.org/) in Ruby or
[Pdb](https://docs.python.org/3/library/pdb.html) in Python:
Example program:
```c++
// save as main.cpp
#include
#include
int main(int argc, char** argv) {
int a = 1;
std::string b = "hello world";
#include INSPECTOR
std::cout << "second break." << std::endl;
#include INSPECTOR
}
```
```console
$ ./inspector prebuild main.cpp
$ clang++ $(./inspector print-cflags) main.cpp -o main
$ ./inspector repl
$ ./main
```
[Presentation slides on Inspector](https://hackmd.shackspace.de/p/rypPYkqUM#/)
[10 min video presentation on Inspector](https://www.youtube.com/watch?v=Cl5RSlW6xAc)
[Cppcast about Inspector](http://cppcast.com/2018/02/mathieu-ropert/)
## Build
### Requirements
- a c++ compiler (gcc or clang++)
- libcling (see installation instructions below)
- jsoncpp
- python3
- python-prompt-toolkit (for python3)
- python-setuptools (for python3)
- pkg-config
### Build Cling
Note that for some linux distributions the cling project also provide pre-build [binaries](https://root.cern.ch/download/cling/).
```
git clone http://root.cern.ch/git/llvm.git src
cd src
git checkout cling-patches
cd tools
git clone http://root.cern.ch/git/cling.git
git clone http://root.cern.ch/git/clang.git
cd clang
git checkout cling-patches
cd ../..
mkdir build inst
cd build
cmake -DCMAKE_INSTALL_PREFIX=../inst ..
cmake --build .
cmake --build . --target install
```
### Build Inspector
```
git clone [email protected]:inspector-repl/inspector.git
cd inspector
mkdir build
cd build
cmake -DCMAKE_PREFIX_PATH="../inst" ..
cmake --build .
```
## Usage
```
# bring python bindings
# (requires clang 5/trunk for python3 support, the clang branch from cling is new enough)
# and libclang into path
export PYTHONPATH=$(readlink -f /src/tools/clang/bindings/python/)
export LD_LIBRARY_PATH=$(readlink -f /inst/lib)
cd build
./inspector prebuild ../test/test.cpp
gcc -o test-proc $(./inspector print-cflags) ../test/test.cpp
# start repl cli
./inspector repl
# let program connect to repl
./test-proc
```
## TODO
- [ ] buildsystem integration:
- [ ] cmake
- [ ] autotools
- [ ] make
- [ ] meson
- [ ] include type declaration into the repl
- [ ] search for '#include INSPECTOR' before parsing (speed)
- [ ] use verbose mode of compiler to get additional include paths for cling /
libclang parsing
- [ ] multiprocessing scanning
- [ ] GDB/LLDB plugin: link/preload libinspector.so and invoke inspector with debug information from gdb/lldb.
- Support for more languages:
- [ ] C