Implement official Arduino IDE debugger API on 2.x #9118
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use regexs to replace all occurrences of `{runtime.platform.path}` with
the correct `{runtime.tools.*.path}`, regardless of directory separator,
and remove dependency on specific text around each path.
Note that the order has been changed to ensure that the longest paths
are replaced first, to avoid replacing parts of other paths.
Ensure Windows paths properly use a backslash as folder separator.
Implement sketch debugging according to the official Arduino Platform Debug Specification [1]. The biggest improvement is that now `launch.json` can be fully customized by the core (including the type of each entry), so there is no need to copy files in the sketch folder. In particular, `debug_custom.json` is not used anymore. [1] https://arduino.github.io/arduino-cli/latest/platform-specification/#sketch-debugging-configuration BREAKING CHANGE: This commit requires Arduino IDE 2.3.0 or later to use the debugging features. Older versions will no longer be able to start a debug session successfully.
Cortex-debug requires objdump to be in the same folder as gdb, or needs the full path to the executable in the `launch.json` file. This is now possible with the new debugging API. On Arduino-ESP32 core versions 2.x, though, this causes a crash within the Cortex-Debug extension as a result of loading the symbol table. This feature is thus disabled for now.
If the `debug.executable` variable is null or unset, the Debug button appears grayed out. The new IDE also takes current parameters into account, allowing to conditionally enable the Debug button only when some conditions are met.
pillo79
force-pushed
the
new_debug_api_2.x
branch
from
447462c
to
17a6b71
Compare
|
While testing this we found an issue with Cortex-Debug. It seems that some global symbols that are defined in core 2.x cause the plugin to crash when opening the "globals" sidebar. Since this feature was not present until now, I have disabled it in bca404d. |
|
@pillo79 is it now supported by the latest released IDE? |
|
Not yet - IDE 2.6.0 is currently scheduled to be released by mid next week. |
|
@pillo79 OK. let's merge it when it's released. LGTM |
|
IDE 2.3 has been released yesterday 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR replaces the current experimental sketch debugging description with a full implementation according to the finalized Arduino Platform Debug Specification. It is a backport of #9116 to the
release/v2.xbranch.