Summary: Methods | Inherited Methods | [Expand All]

public interface

ICodeUnit

implements IInteractiveUnit

com.pnfsoftware.jeb.core.units.code.ICodeUnit

Known Indirect Subclasses

AbstractCodeUnit, IDexUnit, INativeCodeUnit<InsnType extends IInstruction>

Class Overview

Base interface for units disassembling binary code, such as bytecode, opcodes, object files, executable files.

Code units are inherently interactive, in order to provide facility for code refactoring, modification, etc.

Code units generate CodeDocument, and as such, generate AssemblyItem objects. Implementors must implement getItemObject(long) properly.

Currently, we recommend that third-party developers do not implement code units, as the code.* API packages are going to be evolving until JEB 2.2. Preferably, implementors should implement or extend a more specialized sub-type, such as INativeCodeUnit.

Summary

Public Methods
abstract String	getAddressFromCodeCoordinates(ICodeCoordinates cc) Convert code coordinates to a unit address.
abstract ICodeClass	getClass(String fqname) Convenience method used to retrieve a class by name.
abstract List<? extends ICodeClass>	getClasses() Get the list of classes.
abstract ICodeCoordinates	getCodeCoordinatesFromAddress(String address) Convert a unit address to code coordinates.
abstract CodeCommentManager<?>	getCommentManager() Get the comment manager.
abstract String	getDisassembly() Convenience method used to generate the disassembly of this code unit using standard settings.
abstract ITextDocument	getDisassemblyDocument() Convenience method to retrieve the text document representing the disassembly of this code unit.
abstract ICodeField	getField(String fqname) Convenience method used to retrieve a field by name.
abstract List<? extends ICodeField>	getFields() Get the list of fields.
abstract ICodeHierarchy	getHierarchy() Get the code hierarchy.
abstract ICodeMethod	getMethod(String fqname) Convenience method used to retrieve a method by name.
abstract List<? extends ICodeMethod>	getMethods() Get the list of methods.
abstract List<? extends ICodePackage>	getPackages() Get the list of code packages.
abstract List<? extends ICodeString>	getStrings() Get the list of code strings.
abstract List<? extends ICodeType>	getTypes() Get the list of types.

[Expand]

Inherited Methods

From interface com.pnfsoftware.jeb.core.IUnitCreator

From interface com.pnfsoftware.jeb.core.IUserDataSupport

From interface com.pnfsoftware.jeb.core.units.IAddressableUnit

abstract String	getAddressLabel(String address) Retrieve the label at a given address.
abstract Map<String, String>	getAddressLabels() Retrieve all labels.
abstract String	getAddressOfItem(long id) Attempt to determine the best address for a given item.
abstract String	getCanonicalAddress(String address) Convert the provided address to its canonical form.
abstract long	getItemAtAddress(String address) Attempt to determine the best item for a given address.
abstract Object	getItemObject(long id) Optionally provide an object associated with the given item.
abstract List<Long>	getRelatedItems(long id) Retrieve items related to the provided item id.
abstract Collection<String>	getWellKnownAddresses(int maxCount, Predicate<String> validator) Retrieve a collection of valid unit addresses.
abstract boolean	isValidAddress(String address) Determine if the provided address is a valid address for this unit.

From interface com.pnfsoftware.jeb.core.units.IInteractiveUnit

abstract IInputLocation	addressToLocation(String address) Convert a unit-specific address to location information relative to the input.
abstract boolean	canExecuteAction(ActionContext actionContext) Verify if an action can be executed.
abstract boolean	executeAction(ActionContext actionContext, IActionData actionData, boolean notify) Execute an action and optionally notify clients if the action was executed successfully and modified the unit contents.
abstract boolean	executeAction(ActionContext actionContext, IActionData actionData) Execute an action.
abstract List<Integer>	getAddressActions(String address) Provide a list of actions that may be executed at the given address.
abstract AbstractCommentManager<?, ?>	getCommentManager() Get the comment manager.
abstract String	getFullComment(String address) This convenience method is used to generate the full string comment attached to the provided address.
abstract Map<String, String>	getFullComments() This convenience method is used to generate a map of full string comments held by the units.
abstract List<Integer>	getGlobalActions() Provide a list of actions that may be executed globally.
abstract String	getInlineComment(String address) Retrieve the primary comment at a given address.
abstract Map<String, String>	getInlineComments() Retrieve all primary comments.
abstract List<Integer>	getItemActions(long id) Provide a list of actions that may be executed on the item with the given id.
abstract IMetadataManager	getMetadataManager() Get a reference to the metadata manager for this unit.
abstract String	getPrimaryComment(String address) This method is deprecated. use `getInlineComment(String)`
abstract Map<String, String>	getPrimaryComments() This method is deprecated. use `getInlineComments()`
abstract String	locationToAddress(IInputLocation location) Convert a location relative to the input to a unit-specific address.
abstract boolean	prepareExecution(ActionContext actionContext, IActionData actionData) Prepare the execution of an action.
abstract boolean	setInlineComment(String address, String comment) Set or delete the primary comment at a given address.
abstract boolean	setPrimaryComment(String address, String comment) This method is deprecated. use `setInlineComment(String, String)`

From interface com.pnfsoftware.jeb.core.units.IUnit

From interface com.pnfsoftware.jeb.util.events.IEventSource

Public Methods

public abstract String getAddressFromCodeCoordinates (ICodeCoordinates cc)

Convert code coordinates to a unit address.

public abstract ICodeClass getClass (String fqname)

Convenience method used to retrieve a class by name.

public abstract List<? extends ICodeClass> getClasses ()

Get the list of classes.

public abstract ICodeCoordinates getCodeCoordinatesFromAddress (String address)

Convert a unit address to code coordinates.

public abstract CodeCommentManager<?> getCommentManager ()

Get the comment manager. This method is optional. When the unit is disposed, this method must return null. The default implementation returns null.

Returns

a comment manager, or null if the unit does not have one

public abstract String getDisassembly ()

Convenience method used to generate the disassembly of this code unit using standard settings.

public abstract ITextDocument getDisassemblyDocument ()

Convenience method to retrieve the text document representing the disassembly of this code unit.

The caller is responsible for disposing the returned document after usage.

public abstract ICodeField getField (String fqname)

Convenience method used to retrieve a field by name.

public abstract List<? extends ICodeField> getFields ()

Get the list of fields.

public abstract ICodeHierarchy getHierarchy ()

Get the code hierarchy.

public abstract ICodeMethod getMethod (String fqname)

Convenience method used to retrieve a method by name.

public abstract List<? extends ICodeMethod> getMethods ()

Get the list of methods.

public abstract List<? extends ICodePackage> getPackages ()

Get the list of code packages.

public abstract List<? extends ICodeString> getStrings ()

Get the list of code strings.

public abstract List<? extends ICodeType> getTypes ()

Get the list of types.

Interfaces

Classes

Enums