JEB Developer Tutorial

Positioning within inputs, units, and documents

There are 3 types of addressing depending on where the addressing takes place:

• location: specific to the input data, eg, offset in a byte input
• address : specific to the unit. Addresses are strings defined by the plugin developer
• coordinates: specific to documents, used to locate data within IGenericDocument

Methods:

• location<>address: implement locationToAddress/addressToLocation in IInteractiveUnit
• address<>coordinates: implement coordinatesToAddress/addressToCoordinates in ITextDocument, ITableDocument, ITreeDocument

Positioning is always optional, however, it is recommended that units that wish to offer interactive analysis capabilities implement at least an addressing scheme as well as an address-to-coordinates conversion scheme for documents. This makes actions such as cross-referencing or jumping possible.

Providing input location is great for binary units that wish to provide binary correspondence to and from items in documents, for example. Clients then have the ability to use that data to navigate back and forth document views and equivalent bytes in hexdump views.