C++ debugging with Visual Studio Code

Visual Studio Code is a cross-platform IDE that can be used for debugging C++ and Python code.

Tip

For debugging on Windows, Visual Studio is recommended as it has much better performance and many more features than Visual Studio Code.

Prerequisites

  • Build 3D Slicer in Debug mode, outside of Visual Studio Code, by following the build instructions.

  • Install Visual Studio Code

  • Install the C/C++ extension in Visual Studio Code

Note

Visual Studio Code uses GDB for debugging on Linux, which requires Python. However, Python that is linked into GDB is not the same as Slicer’s Python, which may cause issues. If GDB does not start because _sysconfigdata__linux_x86_64-linux-gnu.py file is missing then Slicer’s sysconfigdata file must be copied to the expected filename. For example:

cp ~/D/Slicer-SuperBuild-Debug/python-install/lib/python3.6/_sysconfigdata_m_linux2_.py \
~/D/Slicer-SuperBuild-Debug/python-install/lib/python3.6/_sysconfigdata__linux_x86_64-linux-gnu.py

Running the debugger on Linux

  1. From a terminal, launch Visual Studio Code through the Slicer launcher to setup environment to set up the directory paths necessary for running the Slicer application. For example:

    cd ~/D/Slicer-SuperBuild-Debug/Slicer-build
    ./Slicer --launch code
    
  2. Set up settings.json. For example:

    {
        "launch": {
            "configurations": [
                      {
                        "name": "Slicer debug",
                        "type": "cppdbg",
                        "request": "launch",
                        "program": "/home/perklab/D/Slicer-SuperBuild-Debug/Slicer-build/bin/SlicerApp-real",
                        "args": [],
                        "stopAtEntry": false,
                        "cwd": ".",
                        "environment": [],
                        "externalConsole": false,
                        "MIMode": "gdb",
                        "setupCommands": [
                          {
                            "description": "Enable pretty-printing for gdb",
                            "text": "-enable-pretty-printing",
                            "ignoreFailures": true
                          }
                        ],
                        "miDebuggerPath": "/usr/bin/gdb"
                      }
            ]
        }
    }
    
  3. Choose Run / Start debugging in the menu to start Slicer application with the debugger attached