Deprecated API
Contents
-
Terminally Deprecated ElementsElementDescriptionuse
ToolThis class has been replaced byTableSelectionDialog. 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.see the class headersee the class headeruse the constructor that takes a listuse the constructor that takes a listunusedunusedthis class is no longer used and will be removedUseAbstractGuiTest.waitForSwing()insteadcallProgramPlugin(PluginTool)insteadcallProgramPlugin(PluginTool)insteadthis method is no longer used by the systemthis method is no longer used by the systemextendingAbstractElfRelocationHandlerin conjunction with the use of a processor-specificElfRelocationTypeenum is now preferred.SeeFileByteProvideras replacement ByteProvider.see abovenot usednot usedMarked as deprecated to ensure this is removed in a few versions after most user's old-style cache dirs have been cleaned up.use alternativeDomainFile.checkin(CheckinHandler, TaskMonitor)method since okToUpgrade cannot be respected and is ignored. Upgrade cannot be performed during checkin.useOptions.getActionTrigger(String, ActionTrigger)insteadUse insteadOptions.registerOptionsEditor(Supplier)useOptions.setActionTrigger(String, ActionTrigger)insteadUsePlatform.LINUX_X86_32instead.UsePlatform.LINUX_X86_64instead.Unknown architectures are not supportedUsePlatform.MAC_OSX_32instead.UsePlatform.MAC_X86_64instead.UsePlatform.MAC_X86_64instead.UsePlatform.WIN_X86_64instead.Unknown architectures are not supportedUseGhidra.main(String[])insteadthe methodFlatProgramAPI.analyzeAll(ghidra.program.model.listing.Program)orFlatProgramAPI.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.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.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.useFlatProgramAPI.createLabel(Address, String, boolean)instead. Deprecated in Ghidra 7.4useFlatProgramAPI.createLabel(Address, String, boolean, SourceType)instead. Deprecated in Ghidra 7.4this method makes no sense in the new world order where function names no longer have to be unique. UseFlatProgramAPI.getGlobalFunctions(String)Deprecated in Ghidra 7.4Since the same label name can be at the same address if in a different namespace, this method is ambiguous. UseFlatProgramAPI.getSymbolAt(Address, String, Namespace)instead.method name has been changed to better reflect behavior. The methodData.getComponentContaining(int)should be used instead.Method intended for internal ProgramDB use and is not intended for general use. This method may be removed from this interface in a future release.useSymbolType.LABELinstead.Byte.toUnsignedInt(byte)will handle most use cases of this constantUseByte.toUnsignedInt(byte)insteadUseByte.toUnsignedLong(byte)insteadUse other built-ins likeByte.toUnsignedInt(byte)Integer.toUnsignedLong(int)will handle most use cases of this constantUseInteger.toUnsignedLong(int)insteadShort.toUnsignedInt(short)will handle most use cases of this constantUseShort.toUnsignedInt(short)insteadUseShort.toUnsignedLong(short)insteadUsenew String(bytes, StandardCharSets.US_ASCII)insteadUse the theming system for fontsuse either of the other constructorsThis class has been replaced byDisabledImageIconsince it extendsImageIconWrapperwhich has also been deprecated.This class has been replaced by a series of classes that extendLazyImageIcon:UrlImageIcon,DerivedImageIcon,BytesImageIcon,DisabledImageIcon, andScaledImageIcon. Pick the one that matches the constructor that was being used to create an ImageIconWrapperThis class has been replaced byScaledImageIconsince it extendsImageIconWrapperwhich has also been deprecated.
-
Deprecated Interfaces
-
Deprecated ClassesClassDescriptionThis 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.this class is no longer used and will be removedfunction signatures should be modified in their entirety using eitherUpdateFunctionCommandorApplyFunctionSignatureCmd.function signatures should be modified in their entirety using eitherUpdateFunctionCommandorApplyFunctionSignatureCmd.function signatures should be modified in their entirety using eitherUpdateFunctionCommandorApplyFunctionSignatureCmd.function signatures should be modified in their entirety using eitherUpdateFunctionCommandorApplyFunctionSignatureCmd.The need for this class is now unnecessary since duplicate labels are permittedSeeFileByteProvideras replacement ByteProvider.Use of this dynamic data type class is no longer recommended. Instead a BaseClassDescriptor structure data type can be obtained using the Rtti1Model.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.Use of this dynamic data type class is no longer recommended. Instead a ClassHierarchyDescriptor structure data type can be obtained using the Rtti3Model.Use of this dynamic data type class is no longer recommended. Instead a CompleteObjectLocator structure data type can be obtained using the Rtti4Model.deprecated for 10.1; removal for 10.3 or laterThis map class should not be used except by the OldFunctionMapDB classFunctionDefinitionDataType should be used for defining a function signatureThis class has been replaced byDisabledImageIconsince it extendsImageIconWrapperwhich has also been deprecated.This class has been replaced by a series of classes that extendLazyImageIcon:UrlImageIcon,DerivedImageIcon,BytesImageIcon,DisabledImageIcon, andScaledImageIcon. Pick the one that matches the constructor that was being used to create an ImageIconWrapperThis class has been replaced byScaledImageIconsince it extendsImageIconWrapperwhich has also been deprecated.
-
Deprecated Enum ClassesEnum ClassDescriptionCalling convention name strings should be used instead of this class.
CompilerSpecprovides constants for those included in this enumeration and other setter/getter methods exist for using the string form.
-
Deprecated FieldsFieldDescriptionuse instead
DockingUtils.CONTROL_KEY_MODIFIER_MASKEvent type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.should useVoidDataType.dataTypeinsteaduse of this type is discouraged and may be eliminated in a future release. The typeRefType.DATAshould generally be used in place of this type.useSymbolType.LABELinstead.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Event type numeric constants have been changed to enums. Use the enum directly.Byte.toUnsignedInt(byte)will handle most use cases of this constantInteger.toUnsignedLong(int)will handle most use cases of this constantShort.toUnsignedInt(short)will handle most use cases of this constantuseTaskMonitor.DUMMYinstead
-
Deprecated MethodsMethodDescriptionCall
StatusBar.setStatusText(String)instead. Remove after 9.3instead call the newAbstractDockingTest.closeAllWindows()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.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.useAbstractDockingTest.waitForJDialog(String)insteadInstead 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.see the class headerunusedunusedto be removed sometime after the 9.3 releaseThis is not a test writer's method, but instead an infrastructure method.UseAbstractGuiTest.waitForSwing()insteadWill be removed once we have better way to attach address spaces to pointer data-typesaccessing class file directly precludes OSGi wiring according to requirements and capabilitiesuse getActiveBlockModel(Program) insteaduse getActiveBlockModel(Program, boolean) insteaduse getActiveSubroutineModel(Program) insteaduse getActiveSubroutineModel(Program) insteaduse getNewModelByName(String, Program) insteaduse getNewModelByName(String, Program, boolean) insteadthis method is no longer used by the systemthis method is no longer used by the systemsee aboveuseLoader.supportsLoadIntoProgram(Program)instead so you can restrict what types ofPrograms can get loaded into other types ofProgramsnot usednot usedMarked as deprecated to ensure this is removed in a few versions after most user's old-style cache dirs have been cleaned up.use alternativeDomainFile.checkin(CheckinHandler, TaskMonitor)method since okToUpgrade cannot be respected and is ignored. Upgrade cannot be performed during checkin.useDomainObjectChangedEvent.contains(EventType)instead. This is here to help transition older code from using integer constants for even types to the new enum way that uses enums instead.useOptions.getActionTrigger(String, ActionTrigger)insteadUse insteadOptions.registerOptionsEditor(Supplier)useOptions.setActionTrigger(String, ActionTrigger)insteaddialogs are now always shown over the active window when possible, use@PluginInfoinstead.UseGhidra.main(String[])insteaduseJythonCodeCompletionFactory.newCodeCompletion(String, String, PyObject, String)instead, it allows creation of substituting code completionsthe methodFlatProgramAPI.analyzeAll(ghidra.program.model.listing.Program)orFlatProgramAPI.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.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.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.useFlatProgramAPI.createLabel(Address, String, boolean)instead. Deprecated in Ghidra 7.4useFlatProgramAPI.createLabel(Address, String, boolean, SourceType)instead. Deprecated in Ghidra 7.4this method makes no sense in the new world order where function names no longer have to be unique. UseFlatProgramAPI.getGlobalFunctions(String)Deprecated in Ghidra 7.4Since the same label name can be at the same address if in a different namespace, this method is ambiguous. UseFlatProgramAPI.getSymbolAt(Address, String, Namespace)instead.this method should be avoided since it repeats the work of the getDestinations iteratorthis method should be avoided since it repeats the work of the getSources iteratorthis method should be avoided since it repeats the work of the iteratorthis method should be avoided since it repeats the work of the iteratoruseDataTypeManager.getDataType(String)or better yetDataTypeManager.getDataType(DataTypePath)the methodDataType.getParents()should be used instead. Use ofSetimplementations for containing DataTypes is also inefficient.Use ofGenericCallingConventionis deprecated since arbitrary calling convention names are now supported.FunctionDefinition.setCallingConvention(String)should be used.method name has been changed to better reflect behavior. The methodData.getComponentContaining(int)should be used instead.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 toFunction.updateFunction(String, Variable, List, FunctionUpdateType, boolean, SourceType)since many use cases will likely want a complete list of thunk functions a recursive search is generally needed (seeFunction.getFunctionThunkAddresses(boolean)). This method form may be removed in a future release.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 toFunction.updateFunction(String, Variable, List, FunctionUpdateType, boolean, SourceType)The use of this method is discouraged. The function signature should generally be adjusted with a single call toFunction.updateFunction(String, Variable, List, FunctionUpdateType, boolean, SourceType)The use of this method is discouraged. The function signature should generally be adjusted with a single call toFunction.updateFunction(String, Variable, List, FunctionUpdateType, boolean, SourceType)Method intended for internal ProgramDB use and is not intended for general use. This method may be removed from this interface in a future release.should rely on auto-param instead - try not to use this method which may be eliminatedUseExternalManager.getExternalLocations(Namespace, String)orExternalManager.getUniqueExternalLocation(Namespace, String)since duplicate names may existUseExternalManager.getExternalLocations(String, String)orExternalManager.getUniqueExternalLocation(String, String)since duplicate names may existYou should now use the form that takes in aGraphDisplayOptionsUseByte.toUnsignedInt(byte)insteadUseByte.toUnsignedLong(byte)insteadUse other built-ins likeByte.toUnsignedInt(byte)UseInteger.toUnsignedLong(int)insteadUseShort.toUnsignedInt(short)insteadUseShort.toUnsignedLong(short)insteadUsenew String(bytes, StandardCharSets.US_ASCII)insteadthis method may be removed in a subsequent release due to limited use and applicability (project names and project file names have different naming restrictions).method has been deprecated due to improper and widespread use. New methods includeNamingUtilities.isValidProjectName(String)andLocalFileSystem.testValidName(String,boolean).Use the theming system for fontsUseTaskMonitor.checkCancelled()insteadUseTaskMonitor.clearCancelled()insteaduseAbstractScreenShotGenerator.addr(long)insteaduse insteadGhidraScreenShotGenerator.finished(File, String).use insteadGhidraScreenShotGenerator.finished(File, String).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!!!).
-
Deprecated ConstructorsConstructorDescriptionsee the class headeruse the constructor that takes a listuse the constructor that takes a listthe other constructor form should be used with an appropriate RefType specified.
RefType.DATAshould be used for address table pointer references.callProgramPlugin(PluginTool)insteadcallProgramPlugin(PluginTool)insteadextendingAbstractElfRelocationHandlerin conjunction with the use of a processor-specificElfRelocationTypeenum is now preferred.use either of the other constructors
-
Deprecated Enum ConstantsEnum ConstantDescriptionUse
Platform.LINUX_X86_32instead.UsePlatform.LINUX_X86_64instead.Unknown architectures are not supportedUsePlatform.MAC_OSX_32instead.UsePlatform.MAC_X86_64instead.UsePlatform.MAC_X86_64instead.UsePlatform.WIN_X86_64instead.Unknown architectures are not supported