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

fixed recently introduced options bug

Browse source
This commit is contained in:
ghidravore 2020-08-25 16:31:43 -04:00
parent f92c5a53bd
commit d34d2cfa8d
3 changed files with 37 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

41
Ghidra/Features/Base/src/test/java/ghidra/framework/data/OptionsDBTest.java
View file

@ -91,6 +91,19 @@ public class OptionsDBTest extends AbstractGenericTest {
assertEquals(co, retrieved); assertEquals(co, retrieved);
} }
@Test
public void testRegisterTwiceDifferentValuesNoTransaction() {
// we want to test registering without a transaction and setup
// start one for convenience.
builder.getProgram().endTransaction(txID, false);
options.registerOption("bob", OptionType.FILE_TYPE, null, null, "Help description");
options.registerOption("bob", OptionType.FILE_TYPE, new File(""), null, "Help description");
// open a transaction back again so tear down will be happy
txID = builder.getProgram().startTransaction("Test");
}
//------------------------------- //-------------------------------
@Test @Test
public void testGettingDefaultWhenNoOptionsExist() { public void testGettingDefaultWhenNoOptionsExist() {
@ -110,7 +123,7 @@ public class OptionsDBTest extends AbstractGenericTest {
@Test @Test
public void testDefaultsNotSaved() { public void testDefaultsNotSaved() {
options.registerOption("Foo", 5, null, null); options.registerOption("Foo", 5, null, "description");
assertTrue(options.contains("Foo")); assertTrue(options.contains("Foo"));
assertEquals(5, options.getInt("Foo", 0)); assertEquals(5, options.getInt("Foo", 0));
saveAndRestoreOptions(); saveAndRestoreOptions();
@ -199,8 +212,6 @@ public class OptionsDBTest extends AbstractGenericTest {
Date date = new Date(); Date date = new Date();
options.setDate("Foo", date); options.setDate("Foo", date);
saveAndRestoreOptions(); saveAndRestoreOptions();
System.out.println("Date getTime = " + date.getTime());
System.out.println("restored getTime = " + options.getDate("Foo", null).getTime());
assertEquals(date, options.getDate("Foo", new Date())); assertEquals(date, options.getDate("Foo", new Date()));
} }
@ -269,7 +280,7 @@ public class OptionsDBTest extends AbstractGenericTest {
@Test @Test
public void testGetDefaultValue() { public void testGetDefaultValue() {
options.registerOption("Foo", Color.RED, null, null); options.registerOption("Foo", Color.RED, null, "description");
options.setColor("Foo", Color.BLUE); options.setColor("Foo", Color.BLUE);
assertEquals(Color.BLUE, options.getColor("Foo", null)); assertEquals(Color.BLUE, options.getColor("Foo", null));
assertEquals(Color.RED, options.getDefaultValue("Foo")); assertEquals(Color.RED, options.getDefaultValue("Foo"));
@ -278,7 +289,8 @@ public class OptionsDBTest extends AbstractGenericTest {
@Test @Test
public void testRegisterPropertyEditor() { public void testRegisterPropertyEditor() {
MyPropertyEditor editor = new MyPropertyEditor(); MyPropertyEditor editor = new MyPropertyEditor();
options.registerOption("color", OptionType.COLOR_TYPE, Color.RED, null, null, editor); options.registerOption("color", OptionType.COLOR_TYPE, Color.RED, null, "description",
editor);
assertEquals(editor, options.getRegisteredPropertyEditor("color")); assertEquals(editor, options.getRegisteredPropertyEditor("color"));
} }
@ -286,13 +298,13 @@ public class OptionsDBTest extends AbstractGenericTest {
@Test @Test
public void testGetHelpLocation() { public void testGetHelpLocation() {
HelpLocation helpLocation = new HelpLocation("topic", "anchor"); HelpLocation helpLocation = new HelpLocation("topic", "anchor");
options.registerOption("Foo", 3, helpLocation, null); options.registerOption("Foo", 3, helpLocation, "description");
assertEquals(helpLocation, options.getHelpLocation("Foo")); assertEquals(helpLocation, options.getHelpLocation("Foo"));
} }
@Test @Test
public void testRestoreOptionValue() { public void testRestoreOptionValue() {
options.registerOption("Foo", Color.RED, null, null); options.registerOption("Foo", Color.RED, null, "description");
options.setColor("Foo", Color.BLUE); options.setColor("Foo", Color.BLUE);
assertEquals(Color.BLUE, options.getColor("Foo", null)); assertEquals(Color.BLUE, options.getColor("Foo", null));
options.restoreDefaultValue("Foo"); options.restoreDefaultValue("Foo");
@ -360,16 +372,16 @@ public class OptionsDBTest extends AbstractGenericTest {
assertTrue(!options.isRegistered("Bar")); assertTrue(!options.isRegistered("Bar"));
assertTrue(!options.isRegistered("aaa")); assertTrue(!options.isRegistered("aaa"));
options.registerOption("aaa", 3, null, null); options.registerOption("aaa", 3, null, "description");
assertTrue(options.isRegistered("aaa")); assertTrue(options.isRegistered("aaa"));
} }
@Test @Test
public void testRestoreDefaults() { public void testRestoreDefaults() {
options.registerOption("Foo", 10, null, null); options.registerOption("Foo", 10, null, "description");
options.setInt("Foo", 2); options.setInt("Foo", 2);
options.registerOption("Bar", 100, null, null); options.registerOption("Bar", 100, null, "description");
options.setInt("Bar", 1); options.setInt("Bar", 1);
options.restoreDefaultValues(); options.restoreDefaultValues();
assertEquals(10, options.getInt("Foo", 0)); assertEquals(10, options.getInt("Foo", 0));
@ -485,7 +497,7 @@ public class OptionsDBTest extends AbstractGenericTest {
@Test @Test
public void testGetDefaultValueAsString() { public void testGetDefaultValueAsString() {
options.registerOption("foo", 7, null, null); options.registerOption("foo", 7, null, "description");
options.setInt("foo", 5); options.setInt("foo", 5);
assertEquals("7", options.getDefaultValueAsString("foo")); assertEquals("7", options.getDefaultValueAsString("foo"));
assertNull(options.getDefaultValueAsString("bar")); assertNull(options.getDefaultValueAsString("bar"));
@ -494,7 +506,7 @@ public class OptionsDBTest extends AbstractGenericTest {
@Test @Test
public void testResgisteringOptionWithNullValue() { public void testResgisteringOptionWithNullValue() {
try { try {
options.registerOption("Foo", null, null, null); options.registerOption("Foo", null, null, "description");
Assert.fail("Should not be able to register an options with a default value"); Assert.fail("Should not be able to register an options with a default value");
} }
catch (IllegalArgumentException e) { catch (IllegalArgumentException e) {
@ -505,7 +517,7 @@ public class OptionsDBTest extends AbstractGenericTest {
@Test @Test
public void testRegisteringOptionWithUnsupportedType() { public void testRegisteringOptionWithUnsupportedType() {
try { try {
options.registerOption("Foo", new ArrayList<String>(), null, null); options.registerOption("Foo", new ArrayList<String>(), null, "description");
Assert.fail( Assert.fail(
"Should not be able to register an options with an ArrayList as a default value"); "Should not be able to register an options with an ArrayList as a default value");
} }
@ -517,7 +529,7 @@ public class OptionsDBTest extends AbstractGenericTest {
@Test @Test
public void testRegisteringOptionWithTypeNone() { public void testRegisteringOptionWithTypeNone() {
try { try {
options.registerOption("Foo", OptionType.NO_TYPE, null, null, null); options.registerOption("Foo", OptionType.NO_TYPE, null, null, "description");
Assert.fail("Should not be able to register an options of type NONE"); Assert.fail("Should not be able to register an options of type NONE");
} }
catch (IllegalArgumentException e) { catch (IllegalArgumentException e) {
@ -538,6 +550,7 @@ public class OptionsDBTest extends AbstractGenericTest {
@Test @Test
public void testSettingValueToNull() { public void testSettingValueToNull() {
options.registerOption("Bar", Color.BLUE, null, "description");
options.setColor("Bar", Color.red); options.setColor("Bar", Color.red);
options.setColor("Bar", null); options.setColor("Bar", null);
assertEquals(null, options.getColor("Bar", null)); assertEquals(null, options.getColor("Bar", null));

5
Ghidra/Framework/Generic/src/main/java/ghidra/framework/options/AbstractOptions.java
View file

@ -167,7 +167,10 @@ public abstract class AbstractOptions implements Options {
valueMap.put(optionName, newOption); valueMap.put(optionName, newOption);
} }
private void copyCurrentValue(Option currentOption, Option newOption) { protected void copyCurrentValue(Option currentOption, Option newOption) {
if (currentOption.isDefault()) {
return; // don't copy the current value if it is just the old default.
}
Object currentValue = currentOption.getCurrentValue(); Object currentValue = currentOption.getCurrentValue();
OptionType type = currentOption.getOptionType(); OptionType type = currentOption.getOptionType();

6
Ghidra/Framework/Generic/src/main/java/ghidra/framework/options/OptionType.java
View file

@ -51,10 +51,16 @@ public enum OptionType {
private StringAdapter stringAdapter; private StringAdapter stringAdapter;
public Object convertStringToObject(String string) { public Object convertStringToObject(String string) {
if (string == null) {
return null;
}
return stringAdapter.stringToObject(string); return stringAdapter.stringToObject(string);
} }
public String convertObjectToString(Object object) { public String convertObjectToString(Object object) {
if (object == null) {
return null;
}
return stringAdapter.objectToString(object); return stringAdapter.objectToString(object);
} }