Deprecated List

For Removal
Element	Description
docking.action.DockingActionProviderIf	use `Tool`
docking.widgets.dialogs.TableChooserDialog	This class has been replaced by `TableSelectionDialog`. At the time of writing, both classes are identical. This version introduced a naming conflict with another API. Thus, the new version better matches the existing dialog choosing API.
docking.widgets.dialogs.TableChooserDialog(String, RowObjectTableModel<T>, boolean)	see the class header
docking.widgets.dialogs.TableChooserDialog.getSelectionItems()	see the class header
docking.widgets.fieldpanel.field.FlowLayoutTextField(FieldElement[], int, int, int, HighlightFactory)	use the constructor that takes a list
docking.widgets.fieldpanel.field.VerticalLayoutTextField(FieldElement[], int, int, int, HighlightFactory)	use the constructor that takes a list
ghidra.app.util.bin.RandomAccessByteProvider	See `FileByteProvider` as replacement ByteProvider.
ghidra.app.util.demangler.Demangler.demangle(String, boolean)	see above
ghidra.formats.gfilesystem.FileCache.performCacheMaintOnOldDirIfNeeded(File)	Marked as deprecated to ensure this is removed in a few versions after most user's old-style cache dirs have been cleaned up.
ghidra.framework.Platform.LINUX	Use `Platform.LINUX_X86_32` instead.
ghidra.framework.Platform.LINUX_64	Use `Platform.LINUX_X86_64` instead.
ghidra.framework.Platform.LINUX_UKNOWN	Unknown architectures are not supported
ghidra.framework.Platform.MAC_OSX_32	Use `Platform.MAC_OSX_32` instead.
ghidra.framework.Platform.MAC_OSX_64	Use `Platform.MAC_X86_64` instead.
ghidra.framework.Platform.MAC_UNKNOWN	Use `Platform.MAC_X86_64` instead.
ghidra.framework.Platform.WIN_64	Use `Platform.WIN_X86_64` instead.
ghidra.framework.Platform.WIN_UNKOWN	Unknown architectures are not supported
ghidra.GhidraLauncher.main(String[])	Use `Ghidra.main(String[])` instead
ghidra.program.model.listing.Data.getComponentAt(int)	method name has been changed to better reflect behavior. The method `Data.getComponentContaining(int)` should be used instead.
ghidra.program.model.symbol.SymbolType.CODE	use `SymbolType.LABEL` instead.
ghidra.util.classfinder.ClassSearcher.search(boolean, TaskMonitor)	use `ClassSearcher.search(TaskMonitor)` instead

Interfaces
Interface Description

docking.action.DockingActionProviderIf
use Tool

Classes
Class	Description
docking.widgets.dialogs.TableChooserDialog	This class has been replaced by `TableSelectionDialog`. At the time of writing, both classes are identical. This version introduced a naming conflict with another API. Thus, the new version better matches the existing dialog choosing API.
ghidra.app.cmd.label.AddUniqueLabelCmd	The need for this class is now unnecessary since duplicate labels are permitted
ghidra.app.util.bin.RandomAccessByteProvider	See `FileByteProvider` as replacement ByteProvider.
ghidra.app.util.datatype.microsoft.RTTI1DataType	Use of this dynamic data type class is no longer recommended. Instead a BaseClassDescriptor structure data type can be obtained using the Rtti1Model.
ghidra.app.util.datatype.microsoft.RTTI2DataType	Use of this dynamic data type class is no longer recommended. Instead an array of either pointers or displacements to BaseClassDescriptor structures can be obtained using the Rtti2Model.
ghidra.app.util.datatype.microsoft.RTTI3DataType	Use of this dynamic data type class is no longer recommended. Instead a ClassHierarchyDescriptor structure data type can be obtained using the Rtti3Model.
ghidra.app.util.datatype.microsoft.RTTI4DataType	Use of this dynamic data type class is no longer recommended. Instead a CompleteObjectLocator structure data type can be obtained using the Rtti4Model.
ghidra.app.util.XReferenceUtil	deprecated for 10.1; removal for 10.3 or later
ghidra.program.database.util.SharedRangeMapDB	This map class should not be used except by the OldFunctionMapDB class
ghidra.program.model.listing.FunctionSignatureImpl	FunctionDefinitionDataType should be used for defining a function signature

Fields
Field	Description
docking.DockingUtils.CONTROL_KEY_MODIFIER_MASK_DEPRECATED	use instead `DockingUtils.CONTROL_KEY_MODIFIER_MASK`
ghidra.program.model.data.DataType.VOID	should use `VoidDataType.dataType` instead
ghidra.program.model.symbol.Namespace.NAMESPACE_DELIMITER	use `Namespace.DELIMITER`
ghidra.program.model.symbol.SymbolType.CODE	use `SymbolType.LABEL` instead.
ghidra.util.task.TaskMonitorAdapter.DUMMY_MONITOR	use `TaskMonitor.DUMMY` instead

Methods
Method	Description
docking.StatusBar.setStatusText(String, boolean)	Call `StatusBar.setStatusText(String)` instead. Remove after 9.3
docking.test.AbstractDockingTest.closeAllWindowsAndFrames()	instead call the new `AbstractDockingTest.closeAllWindows()`
docking.test.AbstractDockingTest.waitForComponentProvider(Window, Class<T>, int)	Instead call one of the methods that does not take a timeout (we are standardizing timeouts). The timeouts passed to this method will be ignored in favor of the standard value.
docking.test.AbstractDockingTest.waitForDialogComponent(Window, Class<T>, int)	Instead call one of the methods that does not take a timeout (we are standardizing timeouts). The timeouts passed to this method will be ignored in favor of the standard value.
docking.test.AbstractDockingTest.waitForJDialog(Window, String, int)	use `AbstractDockingTest.waitForJDialog(String)` instead
docking.test.AbstractDockingTest.waitForWindow(String, int)	Instead call one of the methods that does not take a timeout (we are standardizing timeouts). The timeouts passed to this method will be ignored in favor of the standard value.
docking.widgets.dialogs.TableChooserDialog.getSelectionItems()	see the class header
docking.widgets.filechooser.GhidraFileChooser.setFileSelectionMode(int)	use instead `GhidraFileChooser.setFileSelectionMode(GhidraFileChooserMode)`
docking.widgets.label.GHtmlLabel.setText(String)
docking.widgets.label.GIconLabel.setText(String)
docking.widgets.label.GLabel.setText(String)
docking.widgets.ListSelectionTableDialog.setMultiSelectionMode(boolean)	to be removed sometime after the 9.3 release
generic.test.AbstractGenericTest.privateWaitForPostedSwingRunnables_SwingSafe()	This is not a test writer's method, but instead an infrastructure method.
ghidra.app.plugin.processors.generic.Handle.isCodeAddress()
ghidra.app.plugin.processors.sleigh.SleighLanguage.getDefaultPointerWordSize()	Will be removed once we have better way to attach address spaces to pointer data-types
ghidra.app.plugin.ProgramPlugin.enableOnHighlight(DockingAction)	`ActionContext` is now used for action enablement. Deprecated in 9.1; to be removed no sooner than two versions after that.
ghidra.app.plugin.ProgramPlugin.enableOnLocation(DockingAction)	`ActionContext` is now used for action enablement. Deprecated in 9.1; to be removed no sooner than two versions after that.
ghidra.app.plugin.ProgramPlugin.enableOnProgram(DockingAction)	`ActionContext` is now used for action enablement. Deprecated in 9.1; to be removed no sooner than two versions after that.
ghidra.app.plugin.ProgramPlugin.enableOnSelection(DockingAction)	`ActionContext` is now used for action enablement. Deprecated in 9.1; to be removed no sooner than two versions after that.
ghidra.app.script.GhidraScriptProvider.fixupName(String)
ghidra.app.script.GhidraScriptUtil.getExplodedCompiledSourceBundlePaths()	accessing class file directly precludes OSGi wiring according to requirements and capabilities
ghidra.app.services.BlockModelService.getActiveBlockModel()	use getActiveBlockModel(Program) instead
ghidra.app.services.BlockModelService.getActiveSubroutineModel()	use getActiveSubroutineModel(Program) instead
ghidra.app.services.BlockModelService.getNewModelByName(String)	use getNewModelByName(String, Program) instead
ghidra.app.services.ProgramManager.isLocked()	deprecated for 10.1; removal for 10.3 or later
ghidra.app.services.ProgramManager.lockDown(boolean)	deprecated for 10.1; removal for 10.3 or later
ghidra.app.services.ProgramManager.openProgram(DomainFile, Component)	deprecated for 10.1; removal for 10.3 or later; use `ProgramManager.openProgram(DomainFile)`
ghidra.app.util.cparser.C.SimpleCharStream.getColumn()
ghidra.app.util.cparser.C.SimpleCharStream.getLine()
ghidra.app.util.cparser.CPP.JavaCharStream.getColumn()
ghidra.app.util.cparser.CPP.JavaCharStream.getLine()
ghidra.app.util.datatype.microsoft.RTTIDataType.isValid(Program, Address, boolean, boolean)
ghidra.app.util.demangler.Demangler.demangle(String, boolean)	see above
ghidra.app.util.importer.MessageLog.error(String, String)	use `MessageLog.appendMsg(String)`
ghidra.app.util.PseudoData.getComponentAt(int)
ghidra.formats.gfilesystem.FileCache.performCacheMaintOnOldDirIfNeeded(File)	Marked as deprecated to ensure this is removed in a few versions after most user's old-style cache dirs have been cleaned up.
ghidra.framework.plugintool.Plugin.getPluginName(Class<?>)
ghidra.framework.plugintool.Plugin.registerEventConsumed(Class<? extends PluginEvent>)
ghidra.framework.plugintool.Plugin.registerEventProduced(Class<? extends PluginEvent>)
ghidra.framework.plugintool.Plugin.registerServiceUsed(Class<?>, boolean)
ghidra.framework.plugintool.PluginTool.showDialogOnActiveWindow(DialogComponentProvider)	dialogs are now always shown over the active window when possible
ghidra.framework.plugintool.util.PluginDescription.createPluginDescription(Class<?>, PluginStatus, String, String, String, String)
ghidra.GhidraLauncher.main(String[])	Use `Ghidra.main(String[])` instead
ghidra.program.flatapi.FlatProgramAPI.analyze(Program)	the method `FlatProgramAPI.analyzeAll(ghidra.program.model.listing.Program)` or `FlatProgramAPI.analyzeChanges(ghidra.program.model.listing.Program)` should be invoked. These separate methods were created to clarify their true behavior since many times it is only necessary to analyze changes and not the entire program which can take much longer and affect more of the program than is necessary.
ghidra.program.flatapi.FlatProgramAPI.createFragment(String, Address, Address)	This method is deprecated because it did not allow you to include the largest possible address. Instead use the one that takes a start address and a length.
ghidra.program.flatapi.FlatProgramAPI.createSymbol(Address, String, boolean)	use `FlatProgramAPI.createLabel(Address, String, boolean)` instead. Deprecated in Ghidra 7.4
ghidra.program.flatapi.FlatProgramAPI.getFunction(String)	this method makes no sense in the new world order where function names no longer have to be unique. Use `FlatProgramAPI.getGlobalFunctions(String)` Deprecated in Ghidra 7.4
ghidra.program.flatapi.FlatProgramAPI.getSymbol(String, Namespace)	use `FlatProgramAPI.getSymbols(String, Namespace)`
ghidra.program.flatapi.FlatProgramAPI.getSymbolAt(Address, String)	Since the same label name can be at the same address if in a different namespace, this method is ambiguous. Use `FlatProgramAPI.getSymbolAt(Address, String, Namespace)` instead.
ghidra.program.model.block.SimpleBlockModel.getNumDestinations(CodeBlock, TaskMonitor)	this method should be avoided since it repeats the work of the getDestinations iterator
ghidra.program.model.block.SimpleBlockModel.getNumSources(CodeBlock, TaskMonitor)	this method should be avoided since it repeats the work of the getSources iterator
ghidra.program.model.block.SimpleDestReferenceIterator.getNumDestinations(CodeBlock, boolean, TaskMonitor)	this method should be avoided since it repeats the work of the iterator
ghidra.program.model.block.SimpleSourceReferenceIterator.getNumSources(CodeBlock, boolean, TaskMonitor)	this method should be avoided since it repeats the work of the iterator
ghidra.program.model.data.DataTypeManager.findDataType(String)	use `DataTypeManager.getDataType(String)` or better yet `DataTypeManager.getDataType(DataTypePath)`
ghidra.program.model.lang.LanguageService.getLanguageDescriptions(Processor, Endian, Integer, String)	use `LanguageService.getLanguageDescriptions(Processor)` instead
ghidra.program.model.lang.PrototypeModel.getReturnLocation(DataType, Program)	Get the preferred return location given the specified dataType. In truth, there is no one location. The routines that use this method tend to want the default storage location for integer or pointer return values.
ghidra.program.model.listing.Data.getComponentAt(int)	method name has been changed to better reflect behavior. The method `Data.getComponentContaining(int)` should be used instead.
ghidra.program.model.listing.Function.addParameter(Variable, SourceType)	The use of this method is discouraged due to the potential injection of auto-parameters which are easily overlooked when considering parameter ordinal. The function signature should generally be adjusted with a single call to `Function.updateFunction(String, Variable, List, FunctionUpdateType, boolean, SourceType)`
ghidra.program.model.listing.Function.insertParameter(int, Variable, SourceType)	The use of this method is discouraged due to the potential injection of auto-parameters which are easily overlooked when considering parameter ordinal. The function signature should generally be adjusted with a single call to `Function.updateFunction(String, Variable, List, FunctionUpdateType, boolean, SourceType)`
ghidra.program.model.listing.Function.moveParameter(int, int)	The use of this method is discouraged. The function signature should generally be adjusted with a single call to `Function.updateFunction(String, Variable, List, FunctionUpdateType, boolean, SourceType)`
ghidra.program.model.listing.Function.removeParameter(int)	The use of this method is discouraged. The function signature should generally be adjusted with a single call to `Function.updateFunction(String, Variable, List, FunctionUpdateType, boolean, SourceType)`
ghidra.program.model.listing.VariableUtilities.getThisParameter(Function, PrototypeModel)	should rely on auto-param instead - try not to use this method which may be eliminated
ghidra.program.model.mem.Memory.getInitializedAddressSet()
ghidra.program.model.pcode.PcodeOverride.getPrimaryCallReference()
ghidra.program.model.pcode.PcodeSyntaxTree.getVbank()
ghidra.program.model.symbol.ExternalManager.getExternalLocation(String, String)	Use `ExternalManager.getExternalLocations(String, String)` or `ExternalManager.getUniqueExternalLocation(String, String)` since duplicate names may exist
ghidra.service.graph.GraphDisplay.setGraph(AttributedGraph, String, boolean, TaskMonitor)	You should now use the form that takes in a `GraphDisplayOptions`
ghidra.test.TestEnv.waitForDialogComponent(Class<T>, int)	use instead `AbstractDockingTest.waitForDialogComponent(Class)`
ghidra.test.TestEnv.waitForWindow(String, int)
ghidra.util.classfinder.ClassSearcher.search(boolean, TaskMonitor)	use `ClassSearcher.search(TaskMonitor)` instead
ghidra.util.NamingUtilities.findInvalidChar(String)	this method may be removed in a subsequent release due to limited use and applicability (project names and project file names have different naming restrictions).
ghidra.util.NamingUtilities.isValidName(String)	method has been deprecated due to improper and widespread use. New methods include `NamingUtilities.isValidProjectName(String)` and `LocalFileSystem.testValidName(String,boolean)`.
help.screenshot.AbstractScreenShotGenerator.address(long)	use `AbstractScreenShotGenerator.addr(long)` instead
help.screenshot.AbstractScreenShotGenerator.topOfListing(long)
help.screenshot.GhidraScreenShotGenerator.saveToHelp(String, String)	use instead `GhidraScreenShotGenerator.finished(File, String)`.
help.screenshot.GhidraScreenShotGenerator.showImage(String, String)	use instead `GhidraScreenShotGenerator.finished(File, String)`.
help.screenshot.TutorialScreenShotGenerator.showImage()	NOTE: Please do not remove this until we have decided how to create a showImage() method that is compatible with screenshots NOT in Help (ahem, Tutorial!!!).

Constructors
Constructor	Description
docking.widgets.dialogs.TableChooserDialog(String, RowObjectTableModel<T>, boolean)	see the class header
docking.widgets.fieldpanel.field.FlowLayoutTextField(FieldElement[], int, int, int, HighlightFactory)	use the constructor that takes a list
docking.widgets.fieldpanel.field.VerticalLayoutTextField(FieldElement[], int, int, int, HighlightFactory)	use the constructor that takes a list
ghidra.app.cmd.refs.SetExternalRefCmd(Address, int, String, String, Address, SourceType)	the other constructor form should be used with an appropriate RefType specified. `RefType.DATA` should be used for address table pointer references.
ghidra.framework.plugintool.Plugin(String, PluginTool)
ghidra.program.model.address.AddressSet(AddressFactory)	use `AddressSet()` (will be kept until at least Ghidra 6.2)

Enum Constants
Enum Constant	Description
ghidra.framework.Platform.LINUX	Use `Platform.LINUX_X86_32` instead.
ghidra.framework.Platform.LINUX_64	Use `Platform.LINUX_X86_64` instead.
ghidra.framework.Platform.LINUX_UKNOWN	Unknown architectures are not supported
ghidra.framework.Platform.MAC_OSX_32	Use `Platform.MAC_OSX_32` instead.
ghidra.framework.Platform.MAC_OSX_64	Use `Platform.MAC_X86_64` instead.
ghidra.framework.Platform.MAC_UNKNOWN	Use `Platform.MAC_X86_64` instead.
ghidra.framework.Platform.WIN_64	Use `Platform.WIN_X86_64` instead.
ghidra.framework.Platform.WIN_UNKOWN	Unknown architectures are not supported

Deprecated API

Contents