Package ghidra.program.model.util

Class DefaultPropertyMap

java.lang.Object

ghidra.program.model.util.DefaultPropertyMap

All Implemented Interfaces:

PropertyMap

Direct Known Subclasses:

DefaultIntPropertyMap, DefaultLongPropertyMap, DefaultObjectPropertyMap, DefaultSettingsPropertyMap, DefaultStringPropertyMap, DefaultVoidPropertyMap

public abstract class DefaultPropertyMap
extends java.lang.Object
implements PropertyMap

PropertyMap is used to store values for a fixed property at address locations given as longs. The values for the property must be homogeneous, i.e. all have the same type, and are determined by which subclass of PropertyMap is instantiated. For any long the property manager can be used to tell if the property exists there and what its value is. It also maintains information that allows it to efficiently search for the next and previous occurrence of the property relative to a given address. The subclass provides the createPage() method that dictates the type of PropertyPage that will be managed.

Field Summary

Fields

Modifier and Type	Field	Description
protected AddressMapImpl	addrMap
protected java.lang.String	description
protected PropertySet	propertyMgr

Constructor Summary

Constructors

Constructor	Description
DefaultPropertyMap(PropertySet propertyMgr)	Construct a PropertyMap

Method Summary

Modifier and Type	Method	Description
void	applyValue(PropertyVisitor visitor, Address addr)	Applies a property value at the indicated address without knowing its type (String, int, long, etc.) by using the property visitor.
java.lang.String	getDescription()	Return the property description.
Address	getFirstPropertyAddress()	Get the first Address where a property value exists.
Address	getLastPropertyAddress()	Get the last Address where a property value exists.
java.lang.String	getName()	Get the name for this property manager.
Address	getNextPropertyAddress(Address addr)	Get the next address where the property value exists.
Address	getPreviousPropertyAddress(Address addr)	Get the previous Address where a property value exists.
AddressIterator	getPropertyIterator()	Returns an iterator over addresses that have a property value within the property map.
AddressIterator	getPropertyIterator(Address start, boolean forward)	Returns an iterator over the address having a property value.
AddressIterator	getPropertyIterator(Address start, Address end)	Returns an iterator over addresses that have a property value within the given address range.
AddressIterator	getPropertyIterator(Address start, Address end, boolean forward)	Returns an iterator over addresses that have a property value.
AddressIterator	getPropertyIterator(AddressSetView asv)	Returns an iterator over the addresses that have a property value and are in the given address set.
AddressIterator	getPropertyIterator(AddressSetView asv, boolean forward)	Returns an iterator over the addresses that have a property value and are in the given address set.
int	getSize()	Get the number of properties in the map.
boolean	hasProperty(Address addr)	returns whether there is a property value at addr.
boolean	intersects(Address start, Address end)	Given two addresses, indicate whether there is an address in that range (inclusive) having the property.
boolean	intersects(AddressSetView set)	Indicate whether there is an address within the set which exists within this map.
void	moveRange(Address start, Address end, Address newStart)	Moves the properties defined in the range from the start address thru the end address to now be located beginning at the newStart address.
boolean	remove(Address addr)	Remove the property value at the given address.
boolean	removeRange(Address start, Address end)	Removes all property values within a given range.
void	restoreProperties(java.io.ObjectInputStream ois)	Restore properties from the given input stream.
void	saveProperties(java.io.ObjectOutputStream oos, Address start, Address end)	Save the properties in the given range to output stream.
void	setDescription(java.lang.String description)	Set the description for this property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.program.model.util.PropertyMap

getObject

Field Detail

propertyMgr

protected PropertySet propertyMgr

addrMap

protected AddressMapImpl addrMap

description

protected java.lang.String description

Constructor Detail

DefaultPropertyMap

public DefaultPropertyMap(PropertySet propertyMgr)

Construct a PropertyMap

Parameters:

propertyMgr - property manager that manages storage of properties

Method Detail

getName

public java.lang.String getName()

Get the name for this property manager.

Specified by:

getName in interface PropertyMap

setDescription

public void setDescription(java.lang.String description)

Set the description for this property.

Parameters:

description - property description

getDescription

public java.lang.String getDescription()

Return the property description.

Returns:

the property description

intersects

public boolean intersects(Address start,
                          Address end)

Given two addresses, indicate whether there is an address in that range (inclusive) having the property.

Specified by:

intersects in interface PropertyMap

Parameters:

start - the start of the range.

end - the end of the range.

Returns:

boolean true if at least one address in the range has the property, false otherwise.

intersects

public boolean intersects(AddressSetView set)

Description copied from interface: PropertyMap

Indicate whether there is an address within the set which exists within this map.

Specified by:

intersects in interface PropertyMap

Parameters:

set - set of addresses

Returns:

boolean true if at least one address in the set has the property, false otherwise.

removeRange

public boolean removeRange(Address start,
                           Address end)

Removes all property values within a given range.

Specified by:

removeRange in interface PropertyMap

Parameters:

start - begin range

end - end range, inclusive

Returns:

true if any property value was removed; return false otherwise.

remove

public boolean remove(Address addr)

Remove the property value at the given address.

Specified by:

remove in interface PropertyMap

Parameters:

addr - the address where the property should be removed

Returns:

true if the property value was removed, false otherwise.

hasProperty

public boolean hasProperty(Address addr)

returns whether there is a property value at addr.

Specified by:

hasProperty in interface PropertyMap

Parameters:

addr - the address in question

getNextPropertyAddress

public Address getNextPropertyAddress(Address addr)

Get the next address where the property value exists.

Specified by:

getNextPropertyAddress in interface PropertyMap

Parameters:

addr - the address from which to begin the search (exclusive).

getPreviousPropertyAddress

public Address getPreviousPropertyAddress(Address addr)

Get the previous Address where a property value exists.

Specified by:

getPreviousPropertyAddress in interface PropertyMap

Parameters:

addr - the address from which to begin the search (exclusive).

getFirstPropertyAddress

public Address getFirstPropertyAddress()

Get the first Address where a property value exists.

Specified by:

getFirstPropertyAddress in interface PropertyMap

getLastPropertyAddress

public Address getLastPropertyAddress()

Get the last Address where a property value exists.

Specified by:

getLastPropertyAddress in interface PropertyMap

getSize

public int getSize()

Get the number of properties in the map.

Specified by:

getSize in interface PropertyMap

getPropertyIterator

public AddressIterator getPropertyIterator(Address start,
                                           Address end)

Returns an iterator over addresses that have a property value within the given address range.

Specified by:

getPropertyIterator in interface PropertyMap

Parameters:

start - the first address in the range.

end - the last address in the range.

Throws:

TypeMismatchException - thrown if the property does not have values of type Object.

getPropertyIterator

public AddressIterator getPropertyIterator(Address start,
                                           Address end,
                                           boolean forward)

Description copied from interface: PropertyMap

Returns an iterator over addresses that have a property value.

Specified by:

getPropertyIterator in interface PropertyMap

forward - if true will iterate in increasing address order, otherwise it will start at the end and iterate in decreasing address order

See Also:

PropertyMap.getPropertyIterator(ghidra.program.model.address.Address, ghidra.program.model.address.Address, boolean)

getPropertyIterator

public AddressIterator getPropertyIterator()

Returns an iterator over addresses that have a property value within the property map.

Specified by:

getPropertyIterator in interface PropertyMap

Throws:

TypeMismatchException - thrown if the property does not have values of type Object.

getPropertyIterator

public AddressIterator getPropertyIterator(AddressSetView asv)

Returns an iterator over the addresses that have a property value and are in the given address set.

Specified by:

getPropertyIterator in interface PropertyMap

Parameters:

asv - the set of addresses to iterate over.

getPropertyIterator

public AddressIterator getPropertyIterator(AddressSetView asv,
                                           boolean forward)

Description copied from interface: PropertyMap

Returns an iterator over the addresses that have a property value and are in the given address set.

Specified by:

getPropertyIterator in interface PropertyMap

forward - if true will iterate in increasing address order, otherwise it will start at the end and iterate in decreasing address order

See Also:

PropertyMap.getPropertyIterator(ghidra.program.model.address.AddressSetView, boolean)

getPropertyIterator

public AddressIterator getPropertyIterator(Address start,
                                           boolean forward)

Description copied from interface: PropertyMap

Returns an iterator over the address having a property value.

Specified by:

getPropertyIterator in interface PropertyMap

Parameters:

start - the starting address

forward - if true will iterate in increasing address order, otherwise it will start at the end and iterate in decreasing address order

See Also:

PropertyMap.getPropertyIterator(ghidra.program.model.address.Address, boolean)

applyValue

public void applyValue(PropertyVisitor visitor,
                       Address addr)

Description copied from interface: PropertyMap

Applies a property value at the indicated address without knowing its type (String, int, long, etc.) by using the property visitor.

Specified by:

applyValue in interface PropertyMap

Parameters:

visitor - the property visitor that lets you apply the property without knowing its specific type ahead of time.

addr - the address where the property is to be applied.

See Also:

PropertyMap.applyValue(ghidra.util.prop.PropertyVisitor, ghidra.program.model.address.Address)

moveRange

public void moveRange(Address start,
                      Address end,
                      Address newStart)

Description copied from interface: PropertyMap

Moves the properties defined in the range from the start address thru the end address to now be located beginning at the newStart address. The moved properties will be located at the same relative location to the newStart address as they were previously to the start address.

Specified by:

moveRange in interface PropertyMap

Parameters:

start - the start of the range to move.

end - the end of the range to move.

newStart - the new start location of the range of properties after the move.

See Also:

PropertyMap.moveRange(ghidra.program.model.address.Address, ghidra.program.model.address.Address, ghidra.program.model.address.Address)

saveProperties

public void saveProperties(java.io.ObjectOutputStream oos,
                           Address start,
                           Address end)
                    throws java.io.IOException

Save the properties in the given range to output stream.

Parameters:

oos - output stream to write to

start - start address in the range

end - end address in the range

Throws:

java.io.IOException - if there a problem doing the write

restoreProperties

public void restoreProperties(java.io.ObjectInputStream ois)
                       throws java.io.IOException,
                              java.lang.ClassNotFoundException

Restore properties from the given input stream.

Parameters:

ois - input stream

Throws:

java.io.IOException - if there is a problem reading from the stream

java.lang.ClassNotFoundException - if the class for the object being read is not in the class path