yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-05 10:49:34 +02:00
Code Issues Releases Wiki Activity

GT-3414 code review, unit tests for DefinedDataIterator.

Browse source
This commit is contained in:
dev747368 2019-12-23 15:09:20 -05:00
parent 4fbbe989be
commit 5a66f68e47
5 changed files with 208 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/listing/DataIterator.java
View file

@ -26,9 +26,15 @@ import util.CollectionUtils;
* @see CollectionUtils#asIterable
*/
public interface DataIterator extends Iterator<Data> {
public static final DataIterator EMPTY = Of(/*nothing*/);
public static final DataIterator EMPTY = of(/*nothing*/);
public static DataIterator Of(Data... dataInstances) {
/**
* Create a DataIterator that returns a sequence of the specified items.
*
* @param dataInstances variable length list of items that will be iterated
* @return new Iterator
*/
public static DataIterator of(Data... dataInstances) {
return new IteratorWrapper(Arrays.asList(dataInstances).iterator());
}

33
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/util/DefinedDataIterator.java
View file

@ -23,7 +23,7 @@ import ghidra.program.model.data.*;
import ghidra.program.model.listing.*;
/**
* Iterator that visits each defined data instance in a Program or in the footprint of
* Iterator that visits each defined data instance in the initialized memory of a Program or in the footprint of
* a specified data element.
* <p>
* Data elements that are nested inside of composites or arrays are visited, not just the
@ -32,7 +32,7 @@ import ghidra.program.model.listing.*;
public class DefinedDataIterator implements DataIterator {
/**
* Creates a new iterator that traverses the entire Program's address space, visiting
* Creates a new iterator that traverses the entire Program's address space, returning
* data instances that successfully match the predicate.
*
* @param program Program to search
@ -45,7 +45,21 @@ public class DefinedDataIterator implements DataIterator {
}
/**
* Creates a new iterator that traverses the entire Program's address space.
* Creates a new iterator that traverses the entire Program's address space, returning
* data instances that successfully match the predicate.
*
* @param program Program to search
* @param dataInstancePredicate {@link Predicate} that tests each data instance's properties
* @return new iterator
*/
public static DefinedDataIterator byDataInstance(Program program,
Predicate<Data> dataInstancePredicate) {
return new DefinedDataIterator(program, null, null, dataInstancePredicate);
}
/**
* Creates a new iterator that traverses the entire Program's address space returning
* data instances that are strings.
*
* @param program Ghidra {@link Program} to search
* @return new iterator
@ -57,7 +71,8 @@ public class DefinedDataIterator implements DataIterator {
}
/**
* Creates a new iterator that traverses a portion of the Program's address space.
* Creates a new iterator that traverses a portion of the Program's address space returning
* data instances that are strings.
*
* @param program Ghidra {@link Program} to search
* @param addrs addresses to limit the iteration to
@ -84,6 +99,12 @@ public class DefinedDataIterator implements DataIterator {
private Predicate<DataType> dataTypePredicate;
private Predicate<Data> dataInstancePredicate;
/**
* LIFO stack of iterators. Newly found iterators of sub-components are
* pushed onto the end and become the current iterator. When an iterator is exhausted,
* it is popped of the end and the uncovered iterator is now the current.
*/
private Deque<DataIterator> itStack = new ArrayDeque<>();
private Data currentDataResult;
@ -101,7 +122,7 @@ public class DefinedDataIterator implements DataIterator {
this.dataTypePredicate = dataTypePredicate;
this.dataInstancePredicate = dataInstancePredicate;
itStack.addLast(DataIterator.Of(singleDataInstance));
itStack.addLast(DataIterator.of(singleDataInstance));
}
@Override
@ -160,6 +181,8 @@ public class DefinedDataIterator implements DataIterator {
return recursiveMatchesDataTypePredicate(elementDT);
}
else if (dt instanceof Structure) {
// handle Structures and general Composite's separately so
// we can focus on just the defined elements of a structure
Structure comp = (Structure) dt;
for (DataTypeComponent dtc : comp.getDefinedComponents()) {
if (recursiveMatchesDataTypePredicate(dtc.getDataType())) {