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

Merge remote-tracking branch 'origin/GP-4800_ghizard_fix_AbstractProgramBasedTest_addr_method_to_use_param'

Browse source
This commit is contained in:
Ryan Kurtz 2024-07-30 13:49:17 -04:00
commit d201b939d2
1 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

30
Ghidra/Features/Base/src/main/java/ghidra/test/AbstractProgramBasedTest.java
View file

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* http://www.apache.org/licenses/LICENSE-2.0 * http://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -39,13 +39,13 @@ import utility.function.ExceptionalFunction;
/** /**
* A convenience base class for creating tests that use the default tool and open a program. * A convenience base class for creating tests that use the default tool and open a program.
* This class will create for you a tool, a {@link TestEnv} and will open the program * This class will create for you a tool, a {@link TestEnv} and will open the program
* specified by {@link #getProgramName()}. * specified by {@link #getProgramName()}.
* *
* <P>To use this class, you must call {@link #initialize()} from your test or <code>setUp</code> * <P>To use this class, you must call {@link #initialize()} from your test or <code>setUp</code>
* method. * method.
* *
* <P>Note: if you are loading a pre-existing program, then simply override * <P>Note: if you are loading a pre-existing program, then simply override
* {@link #getProgramName()}. Alternatively, if you are building a program, then override * {@link #getProgramName()}. Alternatively, if you are building a program, then override
* {@link #getProgram()} and return it there. * {@link #getProgram()} and return it there.
*/ */
@ -72,7 +72,7 @@ public abstract class AbstractProgramBasedTest extends AbstractGhidraHeadedInteg
/** /**
* Override this method if you need to build your own program. * Override this method if you need to build your own program.
* *
* @return the program to use for this test. * @return the program to use for this test.
* @throws Exception if an exception is thrown opening the program * @throws Exception if an exception is thrown opening the program
*/ */
@ -102,7 +102,7 @@ public abstract class AbstractProgramBasedTest extends AbstractGhidraHeadedInteg
} }
public Address addr(Program p, long offset) { public Address addr(Program p, long offset) {
AddressFactory addrMap = program.getAddressFactory(); AddressFactory addrMap = p.getAddressFactory();
AddressSpace space = addrMap.getDefaultAddressSpace(); AddressSpace space = addrMap.getDefaultAddressSpace();
return space.getAddress(offset); return space.getAddress(offset);
} }
@ -165,8 +165,8 @@ public abstract class AbstractProgramBasedTest extends AbstractGhidraHeadedInteg
/** /**
* Provides a convenient method for modifying the current program, handling the transaction * Provides a convenient method for modifying the current program, handling the transaction
* logic. * logic.
* *
* @param callback the code to execute * @param callback the code to execute
*/ */
public <E extends Exception> void modifyProgram(ExceptionalConsumer<Program, E> callback) { public <E extends Exception> void modifyProgram(ExceptionalConsumer<Program, E> callback) {
@ -191,7 +191,7 @@ public abstract class AbstractProgramBasedTest extends AbstractGhidraHeadedInteg
/** /**
* Provides a convenient method for modifying the current program, handling the transaction * Provides a convenient method for modifying the current program, handling the transaction
* logic and returning a new item as a result. * logic and returning a new item as a result.
* *
* @param f the function for modifying the program and creating the desired result * @param f the function for modifying the program and creating the desired result
* @return the result * @return the result
*/ */
@ -217,12 +217,12 @@ public abstract class AbstractProgramBasedTest extends AbstractGhidraHeadedInteg
} }
/** /**
* Returns a field by the given name at the given address. Clients can use the convention * Returns a field by the given name at the given address. Clients can use the convention
* that field factory classes specify a public static field named 'FIELD_NAME' to choose the * that field factory classes specify a public static field named 'FIELD_NAME' to choose the
* desired field name. * desired field name.
* <p> * <p>
* Note: you will have to perform a {@code goTo()} to trigger the view to load the given field. * Note: you will have to perform a {@code goTo()} to trigger the view to load the given field.
* *
* @param a the address * @param a the address
* @param fieldName the field name * @param fieldName the field name
* @return the field * @return the field