[#943] Provide API for "org.eclipse.cdt.debug.gdbjtag.core.jtagDevice"

[ruspl-afed]

• add IGDBJtagConstants.ATTR_JTAG_DEVICE and remove duplicated definitions

Fixes #943

[jonahgraham]

-1 on this as it undoes 5188547 - see API notes: https://github.com/eclipse-cdt/cdt/blob/main/NewAndNoteworthy/CHANGELOG-API.md#:~:text=IGDBJtagConstants.ATTR_JTAG_DEVICE%20has%20been%20removed.%20Use%20IGDBJtagConstants.ATTR_JTAG_DEVICE_ID%20to%20persist%20device%20ID%20rather%20than%20device%20name.%20See%20Bug%20566462.

[ruspl-afed]

@jonahgraham after reading both https://github.com/eclipse-cdt/cdt/blob/main/NewAndNoteworthy/CHANGELOG-API.md and https://bugs.eclipse.org/bugs/show_bug.cgi?id=566462 I still miss the rationale why this was done.
Perhaps, because we want to switch to jtagDeviceId and stop spreading the jtagDevice. But in this case we need to first stop spreading the jtagDevice through our own codebase. Perhaps we should provide a common way to resolve GDBJtagDeviceContribution instead of duplicating the same code for core and UI

@jld01 could you please provide your opinion here?

[jonahgraham]

Perhaps we should provide a common way to resolve GDBJtagDeviceContribution instead of duplicating the same code for core and UI

This exists already in GDBJtagDeviceContributionFactory.getInstance().findByDeviceId - the duplication around the call sites of findByDeviceId are because the attributes are stored in a different location in UI and core parts (ILaunchConfiguration.getAttribute vs a map called attributes - which is populated by a combination of the launch configuration and other attributes). The other duplication is handling of the deprecated attribute, but that code could eventually be deleted and is only needed for compatibility with old launch configurations.

[jld01]

@ruspl-afed the jtagDeviceId launch attribute was introduced with https://bugs.eclipse.org/bugs/show_bug.cgi?id=535024 to allow localization of JTAG device names presented in the UI while maintaining the portability of launch configurations. The old jtagDevice launch attribute was deprecated and eventually removed from API but is still defined privately by both GDBJtagDSFFinalLaunchSequence and GDBJtagDSFDebuggerTab to support the continued use and possible upgrading of legacy launch configurations that do not currently include a JTAG device ID.

I agree that a common definition of the legacy jtagDevice attribute would be more elegant in some ways, but the value of these strings will never change.

Reintroduction of this attribute as API would not be appropriate.