inspector-repl/inspector

A drop-anywhere C++ REPL

Inspector - A drop-anywhere C++ REPL

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 in Ruby or Pdb in Python:

Example program:

// save as main.cpp
#include <iostream>
#include <string>

int main(int argc, char** argv) {
    int a = 1;
    std::string b = "hello world";
#include INSPECTOR
    std::cout << "second break." << std::endl;
#include INSPECTOR
}

$ ./inspector prebuild main.cpp 
$ clang++ $(./inspector print-cflags) main.cpp -o main 
$ ./inspector repl
$ ./main

Presentation slides on Inspector

10 min video presentation on Inspector

Cppcast about Inspector

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.

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 <llvm-root>/src/tools/clang/bindings/python/)
export LD_LIBRARY_PATH=$(readlink -f <llvm-repo>/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

inspector's Issues

Handle relative includes, which escapes .inspector-includes/ better

If I a file is relative to the compiler in an parent directory (ex.: gcc ../../test.cpp) then FILE contains also ...
This makes generated headers ending up outside the hidden directory .inspector-includes.

Possible hacky solution: Put headers in a sub-sub-sub-sub... directory (.inspector-includes/a/a/a/a/a/a) and print a warning if this level get exceeded.

completion: fix insertion point

The completion point is currently ignored, so it will add too much text, when completing.
A possible algorithm is here: https://github.com/justmao945/vim-clang/blob/master/plugin/clang.vim#L592

How to reproduce:

  #include <string>
  int main() {
->    std::string b = "Hello world!";
#include INSPECTOR
  }
> b.len<TAB><TAB>
> b.lenlength # wrong behavior at the moment
> b.length # that would be the right behavior

the start_position needs to computed correctly.