yetangitu/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2025-10-03 17:59:46 +02:00
Code Issues Releases Wiki Activity

GP-3924 Added askValues() method to GhidraScript. Allows users to enter

Browse source 
multiple values with one dialog.
This commit is contained in:
ghidragon 2023-10-17 15:22:21 -04:00
parent 87bd074603
commit e71d5f8faf
45 changed files with 4856 additions and 235 deletions
Download patch file Download diff file Expand all files Collapse all files

92
Ghidra/Features/Base/ghidra_scripts/AskValuesExampleScript.java Normal file
View file

@ -0,0 +1,92 @@
/* ###
* IP: GHIDRA
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Example script for showing how to use the "AskValues" script method for inputing multiple values
// @category Examples
import ghidra.app.script.GhidraScript;
import ghidra.features.base.values.GhidraValuesMap;
import ghidra.program.model.address.Address;
import ghidra.program.model.listing.Program;
import ghidra.util.MessageType;
public class AskValuesExampleScript extends GhidraScript {
@Override
public void run() throws Exception {
GhidraValuesMap values = new GhidraValuesMap();
values.defineString("Name");
values.defineAddress("Address", currentProgram);
values.defineInt("Count");
values.defineInt("Max Results", 100);
values.defineChoice("Priority", "Low", "Low", "Medium", "High");
// When asking for a program, you must supply a consumer that you will use
// to release the program. Since programs share open instances, Ghidra uses
// consumers to keep track of these uses. Scripts can just add themselves
// as the consumer (The askProgram() method does this for you). It is
// important to release it when you are done with. Optionally, you can also
// provide a tool in which case the program will also be opened in the tool (and the
// tool would then also add itself as a consumer). Otherwise, the program will not
// show up in the tool and when you release the consumer, it will be closed.
values.defineProgram("Other Program", this, state.getTool());
// Optional validator that can be set to validate values before the dialog returns. It
// is called when the "Ok" button is pushed and must return true before the dialog exits.
// It also includes a statusListener where messages can be set on the dialog. In this
// example, we are requiring that the name and program fields be populated
values.setValidator((valueMap, status) -> {
if (!valueMap.hasValue("Name")) {
status.setStatusText("Name must be filled in!", MessageType.ERROR);
return false;
}
if (!valueMap.hasValue("Other Program")) {
status.setStatusText("Other Program must be filled it!", MessageType.ERROR);
return false;
}
return true;
});
// asks the script to show a dialog where the user can give values for all the items
// in the ValuesMap.
values = askValues("Enter Example Script Values", null, values);
// if the user cancels the ask dialog, the script will exit as cancelled. Otherwise
// the returned ValuesMap will contain the results of the user filling in values from the
//dialog. The values map returned may or may not be the same instance as the one passed in.
String name = values.getString("Name");
Address address = values.getAddress("Address");
int age = values.getInt("Count");
int max = values.getInt("Max Results");
String priority = values.getChoice("Priority");
Program program = values.getProgram("Other Program");
println("Name = " + name);
println("Address = " + address);
println("Count = " + age);
println("Max Results = " + max);
println("Priority = " + priority);
println("Program = " + program);
// VERY IMPORTANT!!! you must release any programs when you are done with them!
// If you also opened in the tool, you can immediately release it because the tool will
// then keep it open.
program.release(this);
}
}