# Eclipse CDT Deprecated and Breaking API changes and removals

Deprecated API can be marked for deletion without requiring a major version increment. See the policy for the details. This section describes API removals that occurred in past releases, and upcoming removals in future releases.

API Changes prior to CDT 10.0 / 2020-09.

Prior to CDT 10 release API changes were published as part of the New and Noteworthy entries for that release. From CDT 10 forward breaking API changes are included in this document.

API Changes in CDT 10.0.

1. Eclipse CDT requires Java 11 as a minimum to build and run.
2. Some deprecated methods and classes have been removed.
3. Previously exported packages that were not API are now correctly marked as such.
4. Activators removed for all bundles where possible.
5. NewClassCreationWizardPage breaking changes.
6. Arduino plug-ins and features removed.
7. Remove LRParser, XLC and UPC.
8. Remove org.eclipse.cdt.utils.Platform.
9. DSF and DSF-GDB API Changes.
10. Partial removal of CDT 3.X project support.
11. Removal of CDT Core Options API.
12. TM Terminal has major changes to support new color and preference functionality.
13. Environment Variables are always case sensitive in CDT.
14. Environment variables no longer support \${ to avoid expanding.
15. The binary parsers are now implement Autocloseable
16. ICPPASTDeductionGuide and ICPPASTParameterListOwner removed in CDT 10.0.1

Planned Removals after June 2022

1. 32-bit Binary parsers with 64-bit replacements
2. BaudRate enum in org.eclipse.cdt.serial

Planned Removals after June 2023

1. Rework of API to determine GDB command line in org.eclipse.cdt.dsf.gdb
2. Add ITool parameter to ManagedCommandLineGenerator.toManagedCommandLineInfo
3. Removed unneded boolean from function
4. Changed methods from static to non-static

## API Changes in CDT 10.0.

### 1. Eclipse CDT requires Java 11 as a minimum to build and run.

Java 11 or greater is required for CDT. This means that the BREE for all CDT bundles is now Java 11. See Bug 562494.

The previous workaround for single-sourcing Java 8 and Java 11 has been removed. This means the org.eclipse.tools.templates.freemarker.java11 bundle fragment has been removed. See Bug 563494.

### 2. Some deprecated methods and classes have been removed.

Across the CDT code base some previously deprecated code has been removed.

- EnvironmentReader.getRawEnvVars has been removed. Use EnvironmentReader.getEnvVars instead. See Bug 564123.
- GDBJtagStartupTab.createRunOptionGroup has been removed. Override GDBJtagStartupTab.createRunGroup instead. See Bug 566462.
- IGDBJtagConstants.ATTR_JTAG_DEVICE has been removed. Use IGDBJtagConstants.ATTR_JTAG_DEVICE_ID to persist device ID rather than device name. See Bug 566462.
- IGDBJtagConstants.DEFAULT_JTAG_DEVICE has been removed. Use a local String if necessary. See Bug 566462.
- IGDBJtagConstants.DEFAULT_JTAG_DEVICE_ID has been removed. Use a local String if necessary. See Bug 566462.
- IGDBJtagDevice.getDefaultIpAddress has been removed. Implement IGDBJtagConnection and specify default_connection in JTagDevice extension XML instead. See Bug 566462.
- IGDBJtagDevice.getDefaultPortNumber has been removed. Implement IGDBJtagConnection and specify default_connection in JTagDevice extension XML instead. See Bug 566462.
- IGDBJtagDevice.doRemote has been removed. Implement IGDBJtagConnection.doRemote instead. See Bug 566462.
- PTY constructor PTY(boolean console) has been removed. Use PTY(Mode mode) instead.
- org.eclipse.cdt.core.browser.PathUtil has been removed. Use org.eclipse.cdt.utils.PathUtil instead. See Bug 564123.
- org.eclipse.cdt.launch.ui.CMainTab has been removed. This was part of the long since removed CDI and has no use. See Bug 566530.
- org.eclipse.cdt.launch.ui.CMainCoreTab has been removed. This was part of the long since removed CDI and has no use. See Bug 566530.
- org.eclipse.cdt.launch.ui.CMainAttachTab has been removed. This was part of the long since removed CDI and has no use. See Bug 566530.

### 3. Previously exported packages that were not API are now correctly marked as such.

A review of the previously exported API of CDT was performed. A lot of what was previously marked as public API has now been marked as internal. This means the API has either had `x-internal` or `x-friends` added to the `Export-Package` declarations.

The following bundles have had all their packages exported as internal See Bug 561389:

- org.eclipse.cdt.cmake.ui
- org.eclipse.cdt.autotools.core
- org.eclipse.cdt.core.autotools.core
- org.eclipse.cdt.core.autotools.ui
- org.eclipse.cdt.autotools.tests
- org.eclipse.cdt.autotools.ui.tests
- org.eclipse.cdt.build.crossgcc
- org.eclipse.cdt.cmake.ui
- org.eclipse.cdt.build.gcc.core
- org.eclipse.cdt.build.gcc.ui
- org.eclipse.cdt.codan.checkers.ui.tests
- org.eclipse.tools.templates.ui

The following bundles had additional changes made to be able to mark packages as internal:

org.eclipse.cdt.cmake.ui: renamed package "org.eclipse.cdt.cmake.ui.properties" to "org.eclipse.cdt.cmake.internal.ui.properties". See Bug 561390

org.eclipse.cdt.codan.checkers: marked package "org.eclipse.cdt.codan.checkers" as internal. See Bug 561582

### 4. Activators removed for all bundles where possible.

Where possible bundles have had their Activators removed. Some of these activators were API and are no longer available. See Bug 561635 for workarounds where items that used to be in Activators are still needed, such as logging and plug-ids.

The following Activators that were API have been removed.

- org.eclipse.tools.templates.ui

### 5. NewClassCreationWizardPage breaking changes.

The NewClassCreationWizardPage has some API breaking changes due to how some protected fields, especially `ALL_FIELDS` was used. While this breaks binary compatibility, no code changes should be needed in extenders, just compiling against the new version. See Bug 510789 and Bug 561770.

### 6. Arduino plug-ins and features removed.

The CDT Arduino plug-ins and features have been removed. Arduino can still be used with CDT with manual maintenance of packages, etc. Or a third-party add-on such as Sloeber can be used as a replacement.

The bundles and features that have been removed are:

- org.eclipse.cdt.arduino-feature
- org.eclipse.cdt.arduino.core.tests
- org.eclipse.cdt.arduino.core
- org.eclipse.cdt.arduino.ui

See Bug 562498.

### 7. Remove LRParser, XLC and UPC.

The LR, UPC and XLC support have been removed from CDT. The bundles have not been maintained for a while and were not functional anymore.

The bundles and features that have been removed are:

- org.eclipse.cdt.core.lrparser.feature
- org.eclipse.cdt.core.lrparser.sdk.branding
- org.eclipse.cdt.core.lrparser.sdk.feature
- org.eclipse.cdt.core.lrparser.tests
- org.eclipse.cdt.core.lrparser
- org.eclipse.cdt.bupc-feature
- org.eclipse.cdt.core.parser.upc.feature
- org.eclipse.cdt.core.parser.upc.sdk.branding
- org.eclipse.cdt.core.parser.upc.sdk.feature
- org.eclipse.cdt.core.parser.upc.tests
- org.eclipse.cdt.core.parser.upc
- org.eclipse.cdt.managedbuilder.bupc.ui
- org.eclipse.cdt.core.lrparser.xlc.tests
- org.eclipse.cdt.core.lrparser.xlc
- org.eclipse.cdt.errorparsers.xlc.tests
- org.eclipse.cdt.errorparsers.xlc
- org.eclipse.cdt.make.xlc.core
- org.eclipse.cdt.managedbuilder.xlc.core
- org.eclipse.cdt.managedbuilder.xlc.ui
- org.eclipse.cdt.managedbuilder.xlupc.ui
- org.eclipse.cdt.xlc.feature
- org.eclipse.cdt.xlc.sdk-feature
- org.eclipse.cdt.xlc.sdk.branding

See Bug 562498.

### 8. Remove org.eclipse.cdt.utils.Platform.

Class org.eclipse.cdt.utils.Platform has been removed. Use org.eclipse.core.runtime.Platform instead.

See Bug 564123.

### 9. DSF and DSF-GDB API Changes

DSF and DSF-GDB have had some small API changes, but they are still breaking changes and are listed here:

- org.eclipse.cdt.dsf.gdb.launching.GdbLaunchDelegate.getCLILabel(ILaunchConfiguration, String) has been removed. Use org.eclipse.cdt.dsf.gdb.launching.GdbLaunchDelegate.getCLILabel(GdbLaunch, ILaunchConfiguration, String) instead. See Bug 564553.

### 10. Partial removal of CDT 3.X project support

CDT 3.X projects have been deprecated since CDT 4.0. Some classes supporting this old version have been removed:

- org.eclipse.cdt.make.ui.wizards.ConvertToMakeProjectWizard
- org.eclipse.cdt.make.ui.wizards.ConvertToMakeProjectWizardPage
- org.eclipse.cdt.make.ui.wizards.MakeProjectWizardOptionPage
- org.eclipse.cdt.make.ui.wizards.NewMakeCCProjectWizard
- org.eclipse.cdt.make.ui.wizards.NewMakeCProjectWizard
- org.eclipse.cdt.make.ui.wizards.NewMakeProjectWizard

See Bug 564949.

### 11. Removal of CDT Core Options API

The CDT Core Options API and implementation has been removed as now it is a part of Eclipse Equinox 4.16 Preferences API, the removed packages are:

- org.eclipse.cdt.core.options
- org.eclipse.cdt.internal.core.options

See Bug 565154.

### 12. TM Terminal has major changes to support new color and preference functionality.

The TM Terminal's control (org.eclipse.tm.terminal.control) bundle has a major new version to support numerous API changes to support features such as new colors, preference sharing and some other code clean-up.

- org.eclipse.tm.terminal.model.Style removed and is mostly replaced by org.eclipse.tm.terminal.model.TerminalStyle. To handle new API and color handling, the entire Style class was replaced with TerminalStyle that operates in a similar way. Because some methods in TerminalStyle have similar signatures to those in removed Style class a new class was introduced to prevent accidental use of incorrect API. See Bug 562495.
- org.eclipse.tm.terminal.model.StyleColor removed. Replaced by a new way of representing standard color in the terminal using the new enum org.eclipse.tm.terminal.model.TerminalColor.. See Bug 562495.
- org.eclipse.tm.terminal.model.ITerminalTextData method taking or returning Style now use TerminalStyle. See Bug 562495.
- org.eclipse.tm.terminal.model.ITerminalTextDataReadOnly method taking or returning Style now use TerminalStyle. See Bug 562495.
- org.eclipse.tm.terminal.model.LineSegment method taking or returning Style now use TerminalStyle. See Bug 562495.

### 13. Environment Variables are always case sensitive in CDT.

The handling of environment and build variables in CDT has changed to being case sensitive. This means some API changes to remove methods such as isVariableCaseSensitive (see full list below). The PATH and dome other special environment variables in CDT are always uppercased, such as Path. See Bug 564123.

- org.eclipse.cdt.managedbuilder.core.IBuilder.isVariableCaseSensitive() removed.
- org.eclipse.cdt.managedbuilder.envvar.IEnvironmentVariableProvider.isVariableCaseSensitive() removed.
- org.eclipse.cdt.core.envvar.IEnvironmentVariableManager.isVariableCaseSensitive() removed.

### 14. Environment variables no longer support \${ to avoid expanding.

This change is not literally an api change but will impact your code if you used \${ to not expand environment variables. It may impact your code if you import environment variables and had to workaround path\${childPath} resolving to path${childPath}. See Bug 560330.

- org.eclipse.cdt.managedbuilder.core.IBuilder.isVariableCaseSensitive() removed.
- org.eclipse.cdt.managedbuilder.envvar.IEnvironmentVariableProvider.isVariableCaseSensitive() removed.
- org.eclipse.cdt.core.envvar.IEnvironmentVariableManager.isVariableCaseSensitive() removed.

### 15. The binary parsers are now implement AutoCloseable

The binary parsers part of CDT core now implement the AutoCloseable interface and can be used in try-with-resources blocks. See list below for all the classes that are now AutoCloseable. See Bug 553674.

- org.eclipse.cdt.utils.coff.Exe
- org.eclipse.cdt.utils.coff.PE
- org.eclipse.cdt.utils.coff.PE64
- org.eclipse.cdt.utils.coff.PEArchive
- org.eclipse.cdt.utils.elf.Elf
- org.eclipse.cdt.utils.elf.ElfHelper
- org.eclipse.cdt.utils.AR
- org.eclipse.cdt.utils.elf.AR
- org.eclipse.cdt.utils.som.AR
- org.eclipse.cdt.utils.xcoff.AR
- org.eclipse.cdt.utils.macho.AR

### 16. ICPPASTDeductionGuide and ICPPASTParameterListOwner removed in CDT 10.0.1

Classes org.eclipse.cdt.core.dom.ast.cpp.ICPPASTDeductionGuide and org.eclipse.cdt.core.dom.ast.cpp.ICPPASTParameterListOwner which were added for CDT 10.0.0 have been removed in CDT 10.0.1. See Bug 567261.

## Future Deletions

The items below can be removed after the given date or on the next major release, whichever is sooner. The details and discussion on the removal happens in the Bugzilla associated with the entry below. See the policy for the details.

### API Removals after June 2022

### 1. 32-bit Binary parsers with 64-bit replacements

The following binary parser classes have replacements, mostly due to these versions not supporting 64-bit variants of the binary files. The new 64-bit parsers support both 32 and 64 bit files.

- org.eclipse.cdt.utils.coff.parser.CygwinPEBinaryArchive
- org.eclipse.cdt.utils.coff.parser.CygwinPEBinaryExecutable
- org.eclipse.cdt.utils.coff.parser.CygwinPEBinaryObject
- org.eclipse.cdt.utils.coff.parser.CygwinPEBinaryShared
- org.eclipse.cdt.utils.coff.parser.CygwinPEParser
- org.eclipse.cdt.utils.coff.parser.CygwinSymbol
- org.eclipse.cdt.utils.coff.parser.PEBinaryArchive
- org.eclipse.cdt.utils.coff.parser.PEBinaryExecutable
- org.eclipse.cdt.utils.coff.parser.PEBinaryObject
- org.eclipse.cdt.utils.coff.parser.PEBinaryShared
- org.eclipse.cdt.utils.coff.parser.PEParser
- org.eclipse.cdt.utils.macho.parser.MachOBinaryArchive
- org.eclipse.cdt.utils.macho.parser.MachOBinaryExecutable
- org.eclipse.cdt.utils.macho.parser.MachOBinaryObject
- org.eclipse.cdt.utils.macho.parser.MachOBinaryShared
- org.eclipse.cdt.utils.macho.parser.MachOParser

See Bug 562495.

### 2. BaudRate enum in org.eclipse.cdt.serial

The BaudRate enum in org.eclipse.cdt.serial package will be removed. The following APIs will be removed, listed with their replacement.

- org.eclipse.cdt.serial.BaudRate, use org.eclipse.cdt.serial.StandardBaudRates to obtain typical baud rate values
- org.eclipse.cdt.serial.SerialPort.setBaudRate(BaudRate), use org.eclipse.cdt.serial.SerialPort.setBaudRateValue(int) instead
- org.eclipse.cdt.serial.SerialPort.getBaudRate(), use org.eclipse.cdt.serial.SerialPort.getBaudRateValue() instead
- org.eclipse.tm.terminal.connector.cdtserial.connector.SerialSettings.getBaudRate(), use org.eclipse.tm.terminal.connector.cdtserial.connector.SerialSettings.getBaudRateValue() instead
- org.eclipse.tm.terminal.connector.cdtserial.connector.SerialSettings.setBaudRate(BaudRate), use org.eclipse.tm.terminal.connector.cdtserial.connector.SerialSettings.setBaudRateValue(int) instead

See Bug 563108.

### API Removals after June 2023

### 1. Rework of API to determine GDB command line in org.eclipse.cdt.dsf.gdb

To support presentation of the GDB command line within the process property page, a public method getDebuggerCommandLineArray() has been added to the org.eclipse.cdt.dsf.gdb.service.IGDBBackend interface and the following redundant protected methods will be removed:

- org.eclipse.cdt.dsf.gdb.service.GDBBackend.getDebuggerCommandLine()
- org.eclipse.cdt.dsf.gdb.service.GDBBackend.getGDBCommandLineArray()

Extenders that override the above protected methods should override org.eclipse.cdt.dsf.gdb.service.IGDBBackend.getDebuggerCommandLineArray() instead.

See Bug 572944.

### 2. Add ITool parameter to ManagedCommandLineGenerator.toManagedCommandLineInfo

To allow extenders to know the context of a generated command line, the ITool instance was added to ManagedCommandLineGenerator.toManagedCommandLineInfo method and the method without the ITool parameter will be removed:

- org.eclipse.cdt.managedbuilder.core.ManagedCommandLineGenerator.toManagedCommandLineInfo(String, String, String, String[], String, String, String, String[])

Extenders that override the above protected method should override org.eclipse.cdt.managedbuilder.core.ManagedCommandLineGenerator.toManagedCommandLineInfo(ITool, String, String, String, String[], String, String, String, String[]) instead.

See Bug 573254.

### 3. Removed unneded boolean from function

The implementation for how post-build steps are generated was changed. The "bEmitPostBuildStepCall"-parameter is thus no longer needed.

- org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator.addRuleForTool(ITool, StringBuffer, boolean, String, String, List<String>, Vector<String>, boolean)

Extenders that override the above protected method should override org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator.addRuleForTool(ITool, StringBuffer, boolean, String, String, List<String>, Vector<String>) instead.

See Bug 573502.

### 4. Changed methods from static to non-static

The implementation for generating the header in the make resources was changed. The following APIs will be removed, listed with their (non-static) replacement.

- org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator.populateDummyTargets(IConfiguration, IFile, boolean), use org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator.generateDummyTargets(IConfiguration, IFile, boolean) instead.
- org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator.populateDummyTargets(IResourceInfo, IFile, boolean), use org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator.generateDummyTargets(IResourceInfo, IFile, boolean) instead.
- org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator.addDefaultHeader(), use org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator.addGenericHeader() instead.

See Bug 573722.