Package ghidra.program.model.address
Class AddressSet
- java.lang.Object
-
- ghidra.program.model.address.AddressSet
-
- All Implemented Interfaces:
AddressSetView,java.lang.Iterable<AddressRange>
- Direct Known Subclasses:
ExtCodeBlockImpl
public class AddressSet extends java.lang.Object implements AddressSetView
Class for storing sets of addresses. This implementation uses a red-black tree where each entry node in the tree stores an address range. The key for an entry node is the minimum address of the range and the value is the maximum address of the range.
-
-
Constructor Summary
Constructors Constructor Description AddressSet()Create a new empty Address Set.AddressSet(Address addr)Create a new Address containing a single address.AddressSet(AddressFactory factory)Deprecated.useAddressSet()(will be kept until at least Ghidra 6.2)AddressSet(AddressFactory factory, Address addr)Deprecated.useAddressSet(Address)(will be kept until at least Ghidra 6.2)AddressSet(AddressFactory factory, AddressRange range)Deprecated.useAddressSet(AddressRange)(will be kept until at least Ghidra 6.2)AddressSet(AddressFactory factory, Address start, Address end)Deprecated.useAddressSet(Address, Address)(will be kept until at least Ghidra 6.2)AddressSet(AddressFactory factory, AddressSetView set)Deprecated.useAddressSet(AddressSetView)(will be kept until at least Ghidra 6.2)AddressSet(AddressRange range)Create a new Address Set from an address range.AddressSet(Address start, Address end)Creates a new Address set containing a single rangeAddressSet(AddressSetView set)Create a new Address Set from an existing Address Set.AddressSet(Program program, Address start, Address end)Creates a new Address set containing a single range
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidadd(Address address)Adds the given address to this set.voidadd(AddressRange range)Add an address range to this set.voidadd(Address start, Address end)Adds the range to this setvoidadd(AddressSetView addressSet)Add all addresses of the given AddressSet to this set.voidaddRange(Address start, Address end)Adds the range to this setvoidaddRange(Program program, Address start, Address end)Adds a range of addresses to this set.voidclear()Removes all addresses from the set.booleancontains(Address address)Test if the address is contained within this set.booleancontains(Address start, Address end)Test if the given address range is contained in this set.booleancontains(AddressSetView addrSet)Test if the given address set is a subset of this set.voiddelete(AddressRange range)Deletes an address range from this set.voiddelete(Address start, Address end)Deletes a range of addresses from this setvoiddelete(AddressSetView addressSet)Delete all addresses in the given AddressSet from this set.voiddeleteRange(Address start, Address end)Deletes a range of addresses from this setbooleanequals(java.lang.Object obj)AddressfindFirstAddressInCommon(AddressSetView set)Finds the first address in this collection that is also in the given addressSet.AddressIteratorgetAddresses(boolean forward)Returns an iterator over all addresses in this set.AddressIteratorgetAddresses(Address start, boolean forward)Returns an iterator over the addresses in this address set starting at the start addressAddressRangeIteratorgetAddressRanges()Returns an iterator over the address ranges in this address set.AddressRangeIteratorgetAddressRanges(boolean forward)Returns an iterator over the ranges in the specified orderAddressRangeIteratorgetAddressRanges(Address start, boolean forward)Returns an iterator of address ranges starting with the range that contains the given address.AddressRangegetFirstRange()Returns the first range in this set or null if the set is empty;AddressRangegetLastRange()Returns the last range in this set or null if the set is empty;AddressgetMaxAddress()Return the maximum address for this set.AddressgetMinAddress()Return the minimum address for this set.longgetNumAddresses()Returns the number of addresses in this set.intgetNumAddressRanges()Return the number of address ranges in this set.AddressRangegetRangeContaining(Address address)Returns the range that contains the given addressinthashCode()booleanhasSameAddresses(AddressSetView addrSet)Returns true if the given address set contains the same set of addresses as this set.AddressSetintersect(AddressSetView addrSet)Computes the intersection of this address set with the given address set.AddressSetintersectRange(Address start, Address end)Computes the intersection of this address set with the given address range.booleanintersects(Address start, Address end)Determine if the start and end range intersects with the specified address set.booleanintersects(AddressSetView addrSet)Determine if this address set intersects with the specified address set.booleanisEmpty()Returns true if this set is empty.java.util.Iterator<AddressRange>iterator()Returns an iterator over the address ranges in this address set.java.util.Iterator<AddressRange>iterator(boolean forward)Returns an iterator over the ranges in the specified orderjava.util.Iterator<AddressRange>iterator(Address start, boolean forward)Returns an iterator of address ranges starting with the range that contains the given address.java.lang.StringprintRanges()Returns a string displaying the ranges in this set.AddressSetsubtract(AddressSetView addrSet)Computes the difference of this address set with the given address set (this - set).java.util.List<AddressRange>toList()Returns a list of the AddressRanges in this set.java.lang.StringtoString()AddressSetunion(AddressSetView addrSet)Computes the union of this address set with the given address set.AddressSetxor(AddressSetView addrSet)Computes the exclusive-or of this address set with the given set.
-
-
-
Constructor Detail
-
AddressSet
public AddressSet()
Create a new empty Address Set.
-
AddressSet
@Deprecated public AddressSet(AddressFactory factory)
Deprecated.useAddressSet()(will be kept until at least Ghidra 6.2)Create a new empty Address Set.- Parameters:
factory- NOT USED.
-
AddressSet
public AddressSet(AddressRange range)
Create a new Address Set from an address range.- Parameters:
range- the range of addresses to include in this set.
-
AddressSet
@Deprecated public AddressSet(AddressFactory factory, AddressRange range)
Deprecated.useAddressSet(AddressRange)(will be kept until at least Ghidra 6.2)Create a new Address Set from an address range.- Parameters:
factory- NOT USED.range- the range of addresses to include in this set.
-
AddressSet
public AddressSet(Address start, Address end)
Creates a new Address set containing a single range- Parameters:
start- the start address of the rangeend- the end address of the range- Throws:
java.lang.IllegalArgumentException- if the start and end addresses are in different spaces. To avoid this, use the constructorAddressSet(Program, Address, Address)
-
AddressSet
@Deprecated public AddressSet(AddressFactory factory, Address start, Address end)
Deprecated.useAddressSet(Address, Address)(will be kept until at least Ghidra 6.2)Creates a new Address set containing a single range- Parameters:
start- the start address of the rangeend- the end address of the rangeaddressFactory- NOT USED.
-
AddressSet
public AddressSet(Program program, Address start, Address end)
Creates a new Address set containing a single range- Parameters:
start- the start address of the rangeend- the end address of the rangeprogram- the program whose AddressFactory is used to resolve address ranges where the start and end are in different address spaces. If you use the constructor with just the start and end address and the addresses are in different spaces, you would get an IllegalArgumentException.
-
AddressSet
@Deprecated public AddressSet(AddressFactory factory, AddressSetView set)
Deprecated.useAddressSet(AddressSetView)(will be kept until at least Ghidra 6.2)Create a new Address Set from an existing Address Set.- Parameters:
addrSet- Existing Address Set to clone.addressFactory- NOT USED.
-
AddressSet
public AddressSet(AddressSetView set)
Create a new Address Set from an existing Address Set.- Parameters:
addrSet- Existing Address Set to clone.
-
AddressSet
@Deprecated public AddressSet(AddressFactory factory, Address addr)
Deprecated.useAddressSet(Address)(will be kept until at least Ghidra 6.2)Create a new Address containing a single address.- Parameters:
addr- the address to be included in this address set.addressFactory- NOT USED.
-
AddressSet
public AddressSet(Address addr)
Create a new Address containing a single address.- Parameters:
addr- the address to be included in this address set.
-
-
Method Detail
-
add
public final void add(Address address)
Adds the given address to this set.- Parameters:
address- the address to add
-
add
public final void add(AddressRange range)
Add an address range to this set.- Parameters:
range- the range to add.
-
add
public void add(Address start, Address end)
Adds the range to this set- Parameters:
start- the start address of the range to addend- the end address of the range to add
-
addRange
public void addRange(Address start, Address end)
Adds the range to this set- Parameters:
start- the start address of the range to addend- the end address of the range to add- Throws:
java.lang.IllegalArgumentException- if the start and end addresses are in different spaces. To avoid this, use the constructoraddRange(Program, Address, Address)
-
addRange
public void addRange(Program program, Address start, Address end)
Adds a range of addresses to this set.- Parameters:
program- program whose AddressFactory is used to resolve address ranges that span multiple address spaces.start- the start address of the range to addend- the end address of the range to add
-
add
public final void add(AddressSetView addressSet)
Add all addresses of the given AddressSet to this set.- Parameters:
addressSet- set of addresses to add.
-
delete
public final void delete(AddressRange range)
Deletes an address range from this set.- Parameters:
range- AddressRange to remove from this set
-
delete
public final void delete(Address start, Address end)
Deletes a range of addresses from this set- Parameters:
start- the starting address of the range to be removedend- the ending address of the range to be removed
-
deleteRange
public final void deleteRange(Address start, Address end)
Deletes a range of addresses from this set- Parameters:
start- the starting address of the range to be removedend- the ending address of the range to be removed
-
delete
public final void delete(AddressSetView addressSet)
Delete all addresses in the given AddressSet from this set.- Parameters:
addressSet- set of addresses to remove from this set.
-
clear
public void clear()
Removes all addresses from the set.
-
printRanges
public java.lang.String printRanges()
Returns a string displaying the ranges in this set.- Returns:
- a string displaying the ranges in this set.
-
toList
public java.util.List<AddressRange> toList()
Returns a list of the AddressRanges in this set.- Returns:
- a list of the AddressRanges in this set.
-
contains
public final boolean contains(Address address)
Description copied from interface:AddressSetViewTest if the address is contained within this set.- Specified by:
containsin interfaceAddressSetView- Parameters:
address- address to test.- Returns:
- true if addr exists in the set, false otherwise.
-
contains
public final boolean contains(Address start, Address end)
Description copied from interface:AddressSetViewTest if the given address range is contained in this set.- Specified by:
containsin interfaceAddressSetView- Parameters:
start- the first address in the range.end- the last address in the range.- Returns:
- true if entire range is contained within the set, false otherwise.
-
contains
public final boolean contains(AddressSetView addrSet)
Description copied from interface:AddressSetViewTest if the given address set is a subset of this set.- Specified by:
containsin interfaceAddressSetView- Parameters:
addrSet- the set to test.- Returns:
- true if the entire set is contained within this set, false otherwise.
-
hasSameAddresses
public final boolean hasSameAddresses(AddressSetView addrSet)
Description copied from interface:AddressSetViewReturns true if the given address set contains the same set of addresses as this set.- Specified by:
hasSameAddressesin interfaceAddressSetView- Parameters:
addrSet- the address set to compare.- Returns:
- true if the given set contains the same addresses as this set.
-
equals
public final boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
intersects
public boolean intersects(AddressSetView addrSet)
Description copied from interface:AddressSetViewDetermine if this address set intersects with the specified address set.- Specified by:
intersectsin interfaceAddressSetView- Parameters:
addrSet- address set to check intersection with.
-
intersectRange
public final AddressSet intersectRange(Address start, Address end)
Description copied from interface:AddressSetViewComputes the intersection of this address set with the given address range. This method does not modify this address set.- Specified by:
intersectRangein interfaceAddressSetView- Parameters:
start- start of rangeend- end of range- Returns:
- AddressSet a new address set that contains all addresses that are contained in both this set and the given range.
-
intersect
public final AddressSet intersect(AddressSetView addrSet)
Description copied from interface:AddressSetViewComputes the intersection of this address set with the given address set. This method does not modify this address set.- Specified by:
intersectin interfaceAddressSetView- Parameters:
addrSet- the address set to intersect with.- Returns:
- AddressSet a new address set that contains all addresses that are contained in both this set and the given set.
-
union
public final AddressSet union(AddressSetView addrSet)
Description copied from interface:AddressSetViewComputes the union of this address set with the given address set. This method does not change this address set.- Specified by:
unionin interfaceAddressSetView- Parameters:
addrSet- The address set to be unioned with this address set.- Returns:
- AddressSet A new address set which contains all the addresses from both this set and the given set.
-
subtract
public final AddressSet subtract(AddressSetView addrSet)
Description copied from interface:AddressSetViewComputes the difference of this address set with the given address set (this - set). Note that this is not the same as (set - this). This method does not change this address set.- Specified by:
subtractin interfaceAddressSetView- Parameters:
addrSet- the set to subtract from this set.- Returns:
- AddressSet a new address set which contains all the addresses that are in this set, but not in the given set.
-
isEmpty
public boolean isEmpty()
Description copied from interface:AddressSetViewReturns true if this set is empty.- Specified by:
isEmptyin interfaceAddressSetView
-
getMinAddress
public Address getMinAddress()
Description copied from interface:AddressSetViewReturn the minimum address for this set. Returns null if the set is empty.- Specified by:
getMinAddressin interfaceAddressSetView
-
getMaxAddress
public Address getMaxAddress()
Description copied from interface:AddressSetViewReturn the maximum address for this set. Returns null if the set is empty.- Specified by:
getMaxAddressin interfaceAddressSetView
-
getNumAddressRanges
public int getNumAddressRanges()
Description copied from interface:AddressSetViewReturn the number of address ranges in this set.- Specified by:
getNumAddressRangesin interfaceAddressSetView
-
iterator
public java.util.Iterator<AddressRange> iterator()
Description copied from interface:AddressSetViewReturns an iterator over the address ranges in this address set.- Specified by:
iteratorin interfaceAddressSetView- Specified by:
iteratorin interfacejava.lang.Iterable<AddressRange>
-
iterator
public java.util.Iterator<AddressRange> iterator(boolean forward)
Description copied from interface:AddressSetViewReturns an iterator over the ranges in the specified order- Specified by:
iteratorin interfaceAddressSetView- Parameters:
forward- the ranges are returned from lowest to highest, otherwise from highest to lowest- Returns:
- an iterator over all the addresse ranges in the set.
-
iterator
public java.util.Iterator<AddressRange> iterator(Address start, boolean forward)
Description copied from interface:AddressSetViewReturns an iterator of address ranges starting with the range that contains the given address. If there is no range containing the start address, then the the first range will be the next range greater than the start address if going forward, otherwise the range less than the start address- Specified by:
iteratorin interfaceAddressSetView- Parameters:
start- the address the the first range should contain.forward- true iterators forward, false backwards- Returns:
- the AddressRange iterator
-
getAddressRanges
public AddressRangeIterator getAddressRanges()
Description copied from interface:AddressSetViewReturns an iterator over the address ranges in this address set.- Specified by:
getAddressRangesin interfaceAddressSetView
-
getAddressRanges
public AddressRangeIterator getAddressRanges(boolean forward)
Description copied from interface:AddressSetViewReturns an iterator over the ranges in the specified order- Specified by:
getAddressRangesin interfaceAddressSetView- Parameters:
forward- the ranges are returned from lowest to highest, otherwise from highest to lowest- Returns:
- an iterator over all the addresse ranges in the set.
-
getAddressRanges
public AddressRangeIterator getAddressRanges(Address start, boolean forward)
Description copied from interface:AddressSetViewReturns an iterator of address ranges starting with the range that contains the given address. If there is no range containing the start address, then the the first range will be the next range greater than the start address if going forward, otherwise the range less than the start address- Specified by:
getAddressRangesin interfaceAddressSetView- Parameters:
start- the address the the first range should contain.forward- true iterators forward, false backwards- Returns:
- the AddressRange iterator
-
getNumAddresses
public long getNumAddresses()
Description copied from interface:AddressSetViewReturns the number of addresses in this set.- Specified by:
getNumAddressesin interfaceAddressSetView
-
getAddresses
public AddressIterator getAddresses(boolean forward)
Description copied from interface:AddressSetViewReturns an iterator over all addresses in this set.- Specified by:
getAddressesin interfaceAddressSetView- Parameters:
forward- if true the address are return in increasing order, otherwise in decreasing order.
-
getAddresses
public AddressIterator getAddresses(Address start, boolean forward)
Description copied from interface:AddressSetViewReturns an iterator over the addresses in this address set starting at the start address- Specified by:
getAddressesin interfaceAddressSetView- Parameters:
start- address to start iterating at in the address setforward- if true address are return from lowest to highest, else from highest to lowest
-
intersects
public boolean intersects(Address start, Address end)
Description copied from interface:AddressSetViewDetermine if the start and end range intersects with the specified address set.- Specified by:
intersectsin interfaceAddressSetView- Parameters:
start- start of rangeend- end of range- Returns:
- true if the given range intersects this address set.
-
xor
public AddressSet xor(AddressSetView addrSet)
Description copied from interface:AddressSetViewComputes the exclusive-or of this address set with the given set. This method does not modify this address set.- Specified by:
xorin interfaceAddressSetView- Returns:
- AddressSet a new address set containing all addresses that are in either this set or the given set, but not in both sets
-
toString
public final java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getRangeContaining
public AddressRange getRangeContaining(Address address)
Description copied from interface:AddressSetViewReturns the range that contains the given address- Specified by:
getRangeContainingin interfaceAddressSetView- Parameters:
address- the address for which to find a range.- Returns:
- the range that contains the given address.
-
getFirstRange
public AddressRange getFirstRange()
Description copied from interface:AddressSetViewReturns the first range in this set or null if the set is empty;- Specified by:
getFirstRangein interfaceAddressSetView- Returns:
- the first range in this set or null if the set is empty;
-
getLastRange
public AddressRange getLastRange()
Description copied from interface:AddressSetViewReturns the last range in this set or null if the set is empty;- Specified by:
getLastRangein interfaceAddressSetView- Returns:
- the last range in this set or null if the set is empty;
-
findFirstAddressInCommon
public Address findFirstAddressInCommon(AddressSetView set)
Description copied from interface:AddressSetViewFinds the first address in this collection that is also in the given addressSet.- Specified by:
findFirstAddressInCommonin interfaceAddressSetView- Parameters:
set- the addressSet to search for the first (lowest) common address.- Returns:
- the first address that is contained in this set and the given set.
-
-