Ghidra is a software reverse engineering (SRE) framework
/* ###
* 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.
*/
package generic.theme;
import static org.junit.Assert.*;
import java.text.ParseException;
import javax.swing.Icon;
import org.junit.Before;
import org.junit.Test;
import ghidra.util.Msg;
import ghidra.util.SpyErrorLogger;
import resources.MultiIcon;
import resources.ResourceManager;
import resources.icons.EmptyIcon;
import resources.icons.TranslateIcon;
public class IconValueTest {
private static Icon ICON1 = ResourceManager.getDefaultIcon();
private GThemeValueMap values;
@Before
public void setup() {
// disable warning messages when some test values cannot be found
Msg.setErrorLogger(new SpyErrorLogger());
values = new GThemeValueMap();
}
@Test
public void testDirectValue() {
IconValue value = new IconValue("icon.test", ICON1);
values.addIcon(value);
assertEquals("icon.test", value.getId());
assertEquals(ICON1, value.getRawValue());
assertNull(value.getReferenceId());
assertEquals(ICON1, value.get(values));
}
@Test
public void testIndirectValue() {
values.addIcon(new IconValue("icon.parent", ICON1));
IconValue value = new IconValue("icon.test", "icon.parent");
values.addIcon(value);
assertEquals("icon.test", value.getId());
assertNull(value.getRawValue());
assertEquals("icon.parent", value.getReferenceId());
assertEquals(ICON1, value.get(values));
}
@Test
public void TestIndirectMultiHopValue() {
values.addIcon(new IconValue("icon.grandparent", ICON1));
values.addIcon(new IconValue("icon.parent", "icon.grandparent"));
IconValue value = new IconValue("icon.test", "icon.parent");
values.addIcon(value);
assertNull(value.getRawValue());
assertEquals("icon.parent", value.getReferenceId());
assertEquals(ICON1, value.get(values));
}
@Test
public void TestUnresolvedIndirectValue() {
IconValue value = new IconValue("icon.test", "icon.parent");
values.addIcon(value);
assertNull(value.getRawValue());
assertEquals("icon.parent", value.getReferenceId());
assertEquals(IconValue.LAST_RESORT_DEFAULT, value.get(values));
}
@Test
public void testReferenceLoop() {
values.addIcon(new IconValue("icon.grandparent", "icon.test"));
values.addIcon(new IconValue("icon.parent", "icon.grandparent"));
IconValue value = new IconValue("icon.test", "icon.parent");
assertEquals(IconValue.LAST_RESORT_DEFAULT, value.get(values));
}
@Test
public void testGetSerializationString() {
IconValue value = new IconValue("icon.test", ICON1);
assertEquals("icon.test = images/core.png", value.getSerializationString());
value = new IconValue("foo.bar", ICON1);
assertEquals("[icon]foo.bar = images/core.png", value.getSerializationString());
value = new IconValue("icon.test", "xyz.abc");
assertEquals("icon.test = [icon]xyz.abc", value.getSerializationString());
}
@Test
public void testParse() throws ParseException {
IconValue value = IconValue.parse("icon.test", "images/core.png");
assertEquals("icon.test", value.getId());
assertEquals(ICON1, value.getRawValue());
assertEquals(null, value.getReferenceId());
value = IconValue.parse("[icon]foo.bar", "images/core.png");
assertEquals("foo.bar", value.getId());
assertEquals(ICON1, value.getRawValue());
assertEquals(null, value.getReferenceId());
value = IconValue.parse("icon.test", "[icon]xyz.abc");
assertEquals("icon.test", value.getId());
assertEquals(null, value.getRawValue());
assertEquals("xyz.abc", value.getReferenceId());
}
@Test
public void testParseWithOverlays() throws ParseException {
IconValue value = IconValue.parse("icon.foo", "EMPTY_ICON{Plus2.png}");
values.addIcon(value);
value = IconValue.parse("icon.test",
"images/core.png[size(25,25)]{icon.foo[move(4,4)]}");
assertEquals("icon.test", value.getId());
Icon icon = value.get(values);
assertTrue(icon instanceof MultiIcon);
MultiIcon multiIcon = (MultiIcon) icon;
Icon[] icons = multiIcon.getIcons();
assertEquals(2, icons.length);
assertEquals(25, icons[0].getIconWidth());
assertEquals(25, icons[0].getIconWidth());
assertEquals(16, icons[1].getIconWidth());
assertEquals(16, icons[1].getIconWidth());
assertTrue(icons[1] instanceof TranslateIcon);
TranslateIcon tIcon = (TranslateIcon) icons[1];
Icon baseIcon = tIcon.getBaseIcon();
assertTrue(baseIcon instanceof MultiIcon);
}
@Test
public void testParseWithModifiedOverlay() throws ParseException {
IconValue value = IconValue.parse("icon.test",
"images/core.png[size(25,25)]{images/flag.png[size(8,8)][move(4,4)]}");
assertEquals("icon.test", value.getId());
Icon icon = value.get(values);
assertTrue(icon instanceof MultiIcon);
MultiIcon multiIcon = (MultiIcon) icon;
Icon[] icons = multiIcon.getIcons();
assertEquals(2, icons.length);
assertEquals(25, icons[0].getIconWidth());
assertEquals(25, icons[0].getIconWidth());
assertEquals(8, icons[1].getIconWidth());
assertEquals(8, icons[1].getIconWidth());
assertTrue(icons[1] instanceof TranslateIcon);
}
@Test
public void testIsIconKey() {
assertTrue(IconValue.isIconKey("icon.a.b.c"));
assertTrue(IconValue.isIconKey("[icon]a.b.c"));
assertFalse(IconValue.isIconKey("a.b.c"));
}
@Test
public void testInheritsFrom() {
IconValue grandParent = new IconValue("icon.grandparent", ICON1);
values.addIcon(grandParent);
IconValue parent = new IconValue("icon.parent", "icon.grandparent");
values.addIcon(parent);
IconValue value = new IconValue("icon.test", "icon.parent");
values.addIcon(value);
assertTrue(value.inheritsFrom("icon.parent", values));
assertTrue(value.inheritsFrom("icon.grandparent", values));
assertTrue(parent.inheritsFrom("icon.grandparent", values));
assertFalse(value.inheritsFrom("icon.test", values));
assertFalse(parent.inheritsFrom("icon.test", values));
assertFalse(grandParent.inheritsFrom("icon.test", values));
}
@Test
public void testCreatingValueFromGIcon() {
IconValue parent = new IconValue("icon.parent", ICON1);
values.addIcon(parent);
Icon gIcon = new GIcon("icon.parent");
IconValue value = new IconValue("icon.value", gIcon);
assertEquals("icon.parent", value.getReferenceId());
assertNull(value.getRawValue());
}
@Test
public void testParseEmptyIcon() throws ParseException {
IconValue value = IconValue.parse("icon.test", "EMPTY_ICON");
assertEquals("icon.test", value.getId());
Icon icon = value.get(values);
assertEquals(new EmptyIcon(16, 16), icon);
}
@Test
public void testParseEmptyIconWithSize() throws ParseException {
IconValue value = IconValue.parse("icon.test", "EMPTY_ICON[size(12,15)]");
assertEquals("icon.test", value.getId());
Icon icon = value.get(values);
assertEquals(new EmptyIcon(12, 15), icon);
}
@Test
public void testGetSerializationStringWithEmptyIcon() {
IconValue value = new IconValue("icon.test", new EmptyIcon(16, 16));
assertEquals("icon.test = EMPTY_ICON", value.getSerializationString());
}
@Test
public void testGetSerializationStringWithEmptyCustomSizeIcon() {
IconValue value = new IconValue("icon.test", new EmptyIcon(22, 13));
assertEquals("icon.test = EMPTY_ICON[size(22,13)]", value.getSerializationString());
}
@Test
public void testJavaIconValueRoundTrip() throws Exception {
IconValue value =
IconValue.parse("[laf.icon]FileChooser.homeFolderIcon", "images/go-home.png");
values.addIcon(value);
assertEquals("laf.icon.FileChooser.homeFolderIcon", value.getId());
assertEquals(ResourceManager.loadIcon("images/go-home.png"), value.get(values));
assertEquals("[laf.icon]FileChooser.homeFolderIcon = images/go-home.png",
value.getSerializationString());
}
@Test
public void testInheritsFrom_JavaValues() throws Exception {
IconValue parent =
IconValue.parse("[laf.icon]FileChooser.homeFolderIcon", "images/go-home.png");
values.addIcon(parent);
IconValue value =
IconValue.parse("[laf.icon]FileView.computerIcon",
"[laf.icon]FileChooser.homeFolderIcon");
values.addIcon(value);
//
// Note: IconValue.parse() works on external ids or normalized ids.
//
// IconValue() constructor and inheritsFrom() only work on normalized ids
//
assertTrue(value.inheritsFrom("laf.icon.FileChooser.homeFolderIcon", values));
}
}