Package ghidra.app.util.navigation

Class GoToServiceImpl

java.lang.Object

ghidra.app.util.navigation.GoToServiceImpl

All Implemented Interfaces:

GoToService

public class GoToServiceImpl
extends java.lang.Object
implements GoToService

Field Summary

Fields

Modifier and Type	Field	Description
protected Plugin	plugin

Fields inherited from interface ghidra.app.services.GoToService

VALID_GOTO_CHARS

Constructor Summary

Constructors

Constructor	Description
GoToServiceImpl(Plugin plugin, Navigatable defaultNavigatable)

Method Summary

Modifier and Type	Method	Description
Navigatable	getDefaultNavigatable()
GoToOverrideService	getOverrideService()
boolean	goTo(Navigatable navigatable, Address goToAddress)
boolean	goTo(Navigatable navigatable, Program program, Address address, Address refAddress)
boolean	goTo(Navigatable navigatable, ProgramLocation loc, Program program)
boolean	goTo(Address goToAddress)	Generates a GoTo event to the gotoAddress.
boolean	goTo(Address currentAddress, Address goToAddress)	Generates a GoTo event to the goToAddress or symbol.
boolean	goTo(Address goToAddress, Program program)	Generates a GoTo event to the gotoAddress.
boolean	goTo(ProgramLocation loc)	Generates a GoTo event and handles any history state that needs to be saved.
boolean	goTo(ProgramLocation loc, Program program)	Generates a GoTo event and handles any history state that needs to be saved.
boolean	goToExternalLocation(Navigatable navigatable, ExternalLocation extLoc, boolean checkNavigationOption)	Navigate to either the external program location or address linkage location.
boolean	goToExternalLocation(ExternalLocation extLoc, boolean checkNavigationOption)	Navigate to either the external program location or address linkage location.
boolean	goToQuery(Navigatable navigatable, Address fromAddr, QueryData queryData, GoToServiceListener listener, TaskMonitor monitor)
boolean	goToQuery(Address fromAddr, QueryData queryData, GoToServiceListener listener, TaskMonitor monitor)	Parses the input string as either: an address/symbol expression (0x1000+5, or LAB1000+5) a symbol wildcard expression (LAB*, LAB?100) a symbol lookup an address lookup If the query results in more than one location, a list of locations will be displayed.
void	setOverrideService(GoToOverrideService override)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

plugin

protected final Plugin plugin

Constructor Detail

GoToServiceImpl

public GoToServiceImpl(Plugin plugin,
                       Navigatable defaultNavigatable)

Method Detail

getOverrideService

public GoToOverrideService getOverrideService()

Specified by:

getOverrideService in interface GoToService

goTo

public boolean goTo(ProgramLocation loc)

Description copied from interface: GoToService

Generates a GoTo event and handles any history state that needs to be saved. This method will attempt to find the program that contains the given ProgramLocation.

Specified by:

goTo in interface GoToService

Parameters:

loc - location to go to

Returns:

true if the go to was successful

See Also:

GoToService.goTo(ProgramLocation, Program)

goTo

public boolean goTo(ProgramLocation loc,
                    Program program)

Description copied from interface: GoToService

Generates a GoTo event and handles any history state that needs to be saved. This overloaded version of GoToService.goTo(Address) uses the given program as the program within which to perform the GoTo. If the given program does not contain the given address, then the GoTo will not be performed and false will be returned. Passing null as the program parameter will cause this method to attempt to find a program that contains the given ProgramLocation.

Specified by:

goTo in interface GoToService

Parameters:

loc - location to go to

program - the program within which to perform the GoTo

Returns:

true if the go to was successful

See Also:

GoToService.goTo(ProgramLocation)

goTo

public boolean goTo(Navigatable navigatable,
                    ProgramLocation loc,
                    Program program)

Specified by:

goTo in interface GoToService

goTo

public boolean goTo(Navigatable navigatable,
                    Address goToAddress)

Specified by:

goTo in interface GoToService

goTo

public boolean goTo(Navigatable navigatable,
                    Program program,
                    Address address,
                    Address refAddress)

Specified by:

goTo in interface GoToService

goTo

public boolean goTo(Address currentAddress,
                    Address goToAddress)

Description copied from interface: GoToService

Generates a GoTo event to the goToAddress or symbol. The currentAddress is used to determine if there is a specific symbol reference from the current address.

Specified by:

goTo in interface GoToService

Parameters:

currentAddress - the current address

goToAddress - the address to goto

Returns:

true if the go to was successful

goTo

public boolean goTo(Address goToAddress)

Description copied from interface: GoToService

Generates a GoTo event to the gotoAddress.

Specified by:

goTo in interface GoToService

Parameters:

goToAddress - the address to goto

Returns:

true if the go to was successful

See Also:

GoToService.goTo(Address, Program)

goTo

public boolean goTo(Address goToAddress,
                    Program program)

Description copied from interface: GoToService

Generates a GoTo event to the gotoAddress. This overloaded version of GoToService.goTo(Address) uses the given program as the program within which to perform the GoTo. If the given program does not contain the given address, then the GoTo will not be performed and false will be returned. Passing null as the program parameter will cause this method to attempt to find a program that contains the given ProgramLocation.

Specified by:

goTo in interface GoToService

Parameters:

goToAddress - the address to goto

program - the program within which to perform the GoTo

Returns:

true if the go to was successful

See Also:

GoToService.goTo(Address)

goToExternalLocation

public boolean goToExternalLocation(ExternalLocation extLoc,
                                    boolean checkNavigationOption)

Description copied from interface: GoToService

Navigate to either the external program location or address linkage location. Specific behavior may vary based upon implementation.

Specified by:

goToExternalLocation in interface GoToService

Parameters:

extLoc - external location

checkNavigationOption - if true the service navigation option will be used to determine if navigation to the external program will be attempted, or if navigation to the external linkage location within the current program will be attempted. If false, the implementations default behavior will be performed.

Returns:

true if either navigation to the external program or to a linkage location was completed successfully.

goToExternalLocation

public boolean goToExternalLocation(Navigatable navigatable,
                                    ExternalLocation extLoc,
                                    boolean checkNavigationOption)

Description copied from interface: GoToService

Navigate to either the external program location or address linkage location. Specific behavior may vary based upon implementation.

Specified by:

goToExternalLocation in interface GoToService

Parameters:

navigatable - Navigatable

extLoc - external location

checkNavigationOption - if true the service navigation option will be used to determine if navigation to the external program will be attempted, or if navigation to the external linkage location within the current program will be attempted. If false, the implementations default behavior will be performed.

Returns:

true if either navigation to the external program or to a linkage location was completed successfully.

goToQuery

public boolean goToQuery(Navigatable navigatable,
                         Address fromAddr,
                         QueryData queryData,
                         GoToServiceListener listener,
                         TaskMonitor monitor)

Specified by:

goToQuery in interface GoToService

goToQuery

public boolean goToQuery(Address fromAddr,
                         QueryData queryData,
                         GoToServiceListener listener,
                         TaskMonitor monitor)

Description copied from interface: GoToService

Parses the input string as either: an address/symbol expression (0x1000+5, or LAB1000+5) a symbol wildcard expression (LAB*, LAB?100) a symbol lookup an address lookup If the query results in more than one location, a list of locations will be displayed. If the query results in only one location, then a goto event will be fired(except for a wildcard query in which case a list will still be displayed. The listener will be notified after query and will indicate the query status.

Specified by:

goToQuery in interface GoToService

Parameters:

fromAddr - The address used to determine the scope of the query

queryData - the query input data

listener - the listener that will be notified when the query completes.

monitor - the task monitor

Returns:

true if the queryInput is found or appears to be a wildcard search.

setOverrideService

public void setOverrideService(GoToOverrideService override)

Specified by:

setOverrideService in interface GoToService

getDefaultNavigatable

public Navigatable getDefaultNavigatable()

Specified by:

getDefaultNavigatable in interface GoToService