Deprecated API

Contents

• For Removal
• Interfaces
• Classes
• Fields
• Methods
• Constructors

For Removal

Element	Description
docking.action.DockingActionProviderIf	use DockingTool
ghidra.program.model.symbol.SymbolType.CODE	use SymbolType.LABEL instead.

Interfaces

Interface	Description
docking.action.DockingActionProviderIf	use DockingTool

Classes

Class	Description
ghidra.app.cmd.label.AddUniqueLabelCmd	The need for this class is now unnecessary since duplicate labels are permitted
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.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.GhidraOptions.OLD_CATEGORY_BROWSER_DISPLAY
ghidra.GhidraOptions.OLD_CATEGORY_BROWSER_FIELDS
ghidra.GhidraOptions.OLD_CATEGORY_BROWSER_POPUPS
ghidra.program.model.symbol.RefType.STACK_READ	use RefType.READ instead
ghidra.program.model.symbol.RefType.STACK_WRITE	use RefType.WRITE instead
ghidra.program.model.symbol.SymbolType.CODE	use SymbolType.LABEL instead.
ghidra.util.task.TaskMonitorAdapter.DUMMY_MONITOR	use TaskMonitor.DUMMY instead

Methods

Method	Description
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(Window, 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.test.AbstractDockingTest.waitForWindowByTitleContaining(Window, 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.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)
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.services.MarkerService.createAreaMarker(String, String, int, boolean, boolean, boolean, Color)	Instead use MarkerService.createAreaMarker(String, String, Program, int, boolean, boolean, boolean, Color)
ghidra.app.services.MarkerService.createPointMarker(String, String, int, boolean, boolean, boolean, Color, ImageIcon)	Instead use MarkerService.createPointMarker(String, String, Program, int, boolean, boolean, boolean, Color, ImageIcon)
ghidra.app.services.MarkerService.getMarkerSet(String)	use MarkerService.getMarkerSet(String, Program)
ghidra.app.services.MarkerService.removeMarker(MarkerSet)	use MarkerService.removeMarker(MarkerSet,Program)
ghidra.app.services.ProgramManager.openProgram(Program, boolean)	use openProgram(Program program, int state) instead.
ghidra.app.util.datatype.microsoft.RTTIDataType.isValid(Program, Address, boolean, boolean)
ghidra.app.util.NamespaceUtils.splitNamespacePath(String)	use SymbolPath instead
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.util.PluginDescription.createPluginDescription(Class<?>, PluginStatus, String, String, String, String)
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.getEquate(Instruction, int)	this form of getEquate is not supported and will throw a UnsupportedOperationException
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.flatapi.FlatProgramAPI.removeEquate(Instruction, int)	this form of getEquate is not supported and will throw a UnsupportedOperationException
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.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) instead
ghidra.program.model.symbol.SymbolTable.createSymbol(Address, String, SourceType)	use SymbolTable.createLabel(Address, String, SourceType) instead. Deprecated in version 7.5, will be removed a few versions later.
ghidra.program.model.symbol.SymbolTable.getSymbol(String, Namespace)	This method is no longer useful as Ghidra allows duplicate symbol names in the same namespace. Use #getSymbols(Namespace, String) instead. Deprecated in version 7.5, will be removed a few versions later.
ghidra.test.TestEnv.waitForDialogComponent(Class<T>, int)	use instead AbstractDockingTest.waitForDialogComponent(Class)
ghidra.test.TestEnv.waitForWindow(String, int)
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()	use instead #showImage(String), which will show a comparison of the old and new images 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
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)