Package ghidra.program.model.address
Interface AddressSetView
- All Superinterfaces:
Iterable<AddressRange>
- All Known Subinterfaces:
CodeBlock
,Memory
,ProgramFragment
- All Known Implementing Classes:
AddressSet
,AddressSetViewAdapter
,CodeBlockImpl
,ExtCodeBlockImpl
,MemoryMapDB
,NormalizedAddressSet
,ProgramSelection
,StubMemory
Defines a read-only interface for an address set.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Test if the address is contained within this set.boolean
Test if the given address range is contained in this set.boolean
contains
(AddressSetView rangeSet) Test if the given address set is a subset of this set.Finds the first address in this collection that is also in the given addressSet.default long
getAddressCountBefore
(Address address) Returns the number of address in this address set before the given address.getAddresses
(boolean forward) Returns an iterator over all addresses in this set.getAddresses
(Address start, boolean forward) Returns an iterator over the addresses in this address set starting at the start addressgetAddressRanges
(boolean forward) Returns an iterator over the ranges in the specified ordergetAddressRanges
(Address start, boolean forward) Returns an iterator of address ranges starting with the range that contains the given address.Returns the first range in this set or null if the set is empty;Returns the last range in this set or null if the set is empty;Get the maximum address for this address set.Get the minimum address for this address set.long
int
getRangeContaining
(Address address) Returns the range that contains the given addressboolean
Returns true if the given address set contains the same set of addresses as this set.intersect
(AddressSetView view) Computes the intersection of this address set with the given address set.intersectRange
(Address start, Address end) Computes the intersection of this address set with the given address range.boolean
intersects
(Address start, Address end) Determine if the start and end range intersects with the specified address set.boolean
intersects
(AddressSetView addrSet) Determine if this address set intersects with the specified address set.boolean
isEmpty()
iterator()
Returns an iterator over the address ranges in this address set.iterator
(boolean forward) Returns an iterator over the ranges in the specified orderReturns an iterator of address ranges starting with the range that contains the given address.subtract
(AddressSetView addrSet) Computes the difference of this address set with the given address set (this - set).static AddressSetView
trimEnd
(AddressSetView set, Address addr) Trim address set removing all addresses greater-than-or-equal to specified address based uponAddress
comparison.static AddressSetView
trimStart
(AddressSetView set, Address addr) Trim address set removing all addresses less-than-or-equal to specified address based uponAddress
comparison.union
(AddressSetView addrSet) Computes the union of this address set with the given address set.xor
(AddressSetView addrSet) Computes the exclusive-or of this address set with the given set.Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
contains
Test if the address is contained within this set.- Parameters:
addr
- address to test.- Returns:
- true if addr exists in the set, false otherwise.
-
contains
Test if the given address range is contained in this set. The specified start and end addresses must form a valid range within a singleAddressSpace
.- 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
Test if the given address set is a subset of this set.- Parameters:
rangeSet
- the set to test.- Returns:
- true if the entire set is contained within this set, false otherwise.
-
isEmpty
boolean isEmpty()- Returns:
- true if this set is empty.
-
getMinAddress
Address getMinAddress()Get the minimum address for this address set. NOTE: AnAddressRange
should generally not be formed using this address andgetMaxAddress()
since it may span multipleAddressSpace
s.- Returns:
- the minimum address for this set. Returns null if the set is empty.
-
getMaxAddress
Address getMaxAddress()Get the maximum address for this address set. NOTE: AnAddressRange
should generally not be formed using this address andgetMaxAddress()
since it may span multipleAddressSpace
s.- Returns:
- the maximum address for this set. Returns null if the set is empty.
-
getNumAddressRanges
int getNumAddressRanges()- Returns:
- the number of address ranges in this set.
-
getAddressRanges
AddressRangeIterator getAddressRanges()- Returns:
- an iterator over the address ranges in this address set.
-
getAddressRanges
Returns an iterator over the ranges in the specified order- 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
Returns 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- Parameters:
start
- the address the the first range should contain.forward
- true iterators forward, false backwards- Returns:
- the AddressRange iterator
-
iterator
Iterator<AddressRange> iterator()Returns an iterator over the address ranges in this address set.- Specified by:
iterator
in interfaceIterable<AddressRange>
-
iterator
Returns an iterator over the ranges in the specified order- 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
Returns 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- Parameters:
start
- the address the the first range should contain.forward
- true iterators forward, false backwards- Returns:
- the AddressRange iterator
-
getNumAddresses
long getNumAddresses()- Returns:
- the number of addresses in this set.
-
getAddresses
Returns an iterator over all addresses in this set.- Parameters:
forward
- if true the address are return in increasing order, otherwise in decreasing order.- Returns:
- an iterator over all addresses in this set.
-
getAddresses
Returns an iterator over the addresses in this address set starting at the start address- 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- Returns:
- an iterator over the addresses in this address set starting at the start address
-
intersects
Determine if this address set intersects with the specified address set.- Parameters:
addrSet
- address set to check intersection with.- Returns:
- true if this set intersects the specified addrSet else false
-
intersects
Determine if the start and end range intersects with the specified address set. The specified start and end addresses must form a valid range within a singleAddressSpace
.- Parameters:
start
- start of rangeend
- end of range- Returns:
- true if the given range intersects this address set.
-
intersect
Computes the intersection of this address set with the given address set. This method does not modify this address set.- Parameters:
view
- 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.
-
intersectRange
Computes the intersection of this address set with the given address range. This method does not modify this address set. The specified start and end addresses must form a valid range within a singleAddressSpace
.- 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.
-
union
Computes the union of this address set with the given address set. This method does not change this address set.- 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
Computes 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.- 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.
-
xor
Computes the exclusive-or of this address set with the given set. This method does not modify this address set.- Parameters:
addrSet
- address set to exclusive-or with.- Returns:
- AddressSet a new address set containing all addresses that are in either this set or the given set, but not in both sets
-
hasSameAddresses
Returns true if the given address set contains the same set of addresses as this set.- Parameters:
view
- the address set to compare.- Returns:
- true if the given set contains the same addresses as this set.
-
getFirstRange
AddressRange getFirstRange()Returns the first range in this set or null if the set is empty;- Returns:
- the first range in this set or null if the set is empty;
-
getLastRange
AddressRange getLastRange()Returns the last range in this set or null if the set is empty;- Returns:
- the last range in this set or null if the set is empty;
-
getRangeContaining
Returns the range that contains the given address- Parameters:
address
- the address for which to find a range.- Returns:
- the range that contains the given address.
-
findFirstAddressInCommon
Finds the first address in this collection that is also in the given addressSet.- 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.
-
getAddressCountBefore
Returns the number of address in this address set before the given address.- Parameters:
address
- the address after the last address to be counted- Returns:
- the number of address in this address set before the given address
-
trimStart
Trim address set removing all addresses less-than-or-equal to specified address based uponAddress
comparison. The address set may contain address ranges from multiple address spaces.- Parameters:
set
- address set to be trimmedaddr
- trim point. Only addresses greater than this address will be returned.- Returns:
- trimmed address set view
-
trimEnd
Trim address set removing all addresses greater-than-or-equal to specified address based uponAddress
comparison. The address set may contain address ranges from multiple address spaces.- Parameters:
set
- address set to be trimmedaddr
- trim point. Only addresses less than this address will be returned.- Returns:
- trimmed address set view
-