Package ghidra.features.base.memsearch.matcher

Class InvalidByteMatcher

java.lang.Object

ghidra.features.base.memsearch.matcher.UserInputByteMatcher

ghidra.features.base.memsearch.matcher.InvalidByteMatcher

All Implemented Interfaces:

ByteMatcher<SearchData>

public class InvalidByteMatcher
extends UserInputByteMatcher

Objects of this class are the result of SearchFormats not being able to fully parse input text. There are two cases. The first is the user type an illegal character for the selected search format. In that case this matcher is both an invalid search and an invalid input and the description will explain the error. The second case is the input is valid text, but not complete so that a fully valid byte matcher could not be created. In this case, the search is still invalid, but the input is valid. The description will reflect this situation.

Field Summary

Fields inherited from class ghidra.features.base.memsearch.matcher.UserInputByteMatcher

searchData

Constructor Summary

Constructors

Constructor	Description
InvalidByteMatcher(String errorMessage)	Construct an invalid matcher from invalid input text.
InvalidByteMatcher(String errorMessage, boolean isValidInput)	Construct an invalid matcher from invalid input text or partial input text.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a description of what this byte matcher matches.
String	getToolTip()	Returns additional information about this byte matcher.
boolean	isValidInput()	Returns true if this byte matcher has valid (but possibly incomplete) input text.
boolean	isValidSearch()	Returns true if this byte matcher is valid and can be used to perform a search.
Iterable<Match<SearchData>>	match(ExtendedByteSequence bytes)	Returns an Iterable for returning matches within the given byte sequence.

Methods inherited from class ghidra.features.base.memsearch.matcher.UserInputByteMatcher

equals, getInput, getName, getSearchData, getSettings, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

InvalidByteMatcher

public InvalidByteMatcher(String errorMessage)

Construct an invalid matcher from invalid input text.

Parameters:

errorMessage - the message describing the invalid input

InvalidByteMatcher

public InvalidByteMatcher(String errorMessage,
 boolean isValidInput)

Construct an invalid matcher from invalid input text or partial input text.

Parameters:

errorMessage - the message describing why this matcher is invalid

isValidInput - return true if the reason this is invalid is simply that the input text is not complete. For example, the user types "-" as they are starting to input a negative number.

Method Details

match

public Iterable<Match<SearchData>> match(ExtendedByteSequence bytes)

Description copied from class: UserInputByteMatcher

Returns an Iterable for returning matches within the given byte sequence.

Specified by:

match in interface ByteMatcher<SearchData>

Specified by:

match in class UserInputByteMatcher

Parameters:

bytes - the byte sequence to search

Returns:

an iterable for return matches in the given sequence

getDescription

public String getDescription()

Description copied from class: UserInputByteMatcher

Returns a description of what this byte matcher matches. (Typically a sequence of bytes)

Specified by:

getDescription in interface ByteMatcher<SearchData>

Specified by:

getDescription in class UserInputByteMatcher

Returns:

a description of what this byte matcher matches

getToolTip

public String getToolTip()

Description copied from class: UserInputByteMatcher

Returns additional information about this byte matcher. (Typically the mask bytes)

Specified by:

getToolTip in class UserInputByteMatcher

Returns:

additional information about this byte matcher

isValidInput

public boolean isValidInput()

Description copied from class: UserInputByteMatcher

Returns true if this byte matcher has valid (but possibly incomplete) input text. For example, when entering decimal values, the input could be just "-" as the user starts to enter a negative number. In this case the input is valid, but the UserInputByteMatcher.isValidSearch() would return false.

Overrides:

isValidInput in class UserInputByteMatcher

Returns:

true if this byte matcher has valid text

isValidSearch

public boolean isValidSearch()

Description copied from class: UserInputByteMatcher

Returns true if this byte matcher is valid and can be used to perform a search. If false, the description will return an error message explaining why this byte matcher is invalid.

Overrides:

isValidSearch in class UserInputByteMatcher

Returns:

true if this byte matcher is valid and can be used to perform a search.