What's the best way to debug WPILIB source from a robot program?

[dawonn]

I'm debugging an issue in a cpp robot program and it would be helpful if I could set a breakpoint and step into some WPILIB functions but VScode doesn't know where to find the source. How can I clone wplib and tell VScode where to search for those source files?

---

In the parent directory of my robot project:

git clone https://github.com/wpilibsuite/allwpilib.git
cd allwpilib
git checkout v2022.3.1

So I guess the remaining question is just how do I tell VScode where to search for the wpilib source files...

---

This is the error message when trying to step into a WPILIB function

Unable to open 'DifferentialDrivetrainSim.cpp': 
Unable to read file '/__w/allwpilib/allwpilib/wpilibc/src/main/native/cpp/simulation/DifferentialDrivetrainSim.cpp'  
(Error: Unable to resolve nonexistent file '/__w/allwpilib/allwpilib/wpilibc/src/main/native/cpp/simulation/DifferentialDrivetrainSim.cpp').

So I added a 'sourceFileMap to the robot project launch file, but no dice.

    {
      "type": "wpilib",
      "name": "WPILib Desktop Debug",
      "request": "launch",
      "desktop": true,
      "sourceFileMap": { "/__w/allwpilib/allwpilib/": "/home/dereck/projects/allwpilib/" }
    },

[ThadHouse]

This is actually kind of a hard problem. We do set a sourceFileMap when we launch the debugger to a copy of the sources we download during a build, but it likes to not work when you need it. Adding a sourceFileMap where you put it won't do anything, as that's the wpilib debug definition, and not what gets passed to the c++ debug configuration.

But, since you're running on Linux, you actually have a solution that should mostly work. Instead of trying to use sourceFileMap, just recreate the folder directory. So download sources from the tag for the release you're using, and place them in /__w/allwpilib