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 java.awt.Color;
import java.awt.Font;
import java.io.File;
import java.io.IOException;
import java.util.Objects;
import javax.swing.Icon;
import javax.swing.LookAndFeel;
/**
* Class to store all the configurable appearance properties (Colors, Fonts, Icons, Look and Feel)
* in an application.
*/
public class GTheme extends GThemeValueMap {
public static final String FILE_PREFIX = "File:";
public static final String JAVA_ICON = "<JAVA ICON>";
public static String FILE_EXTENSION = "theme";
public static String ZIP_FILE_EXTENSION = "theme.zip";
private final String name;
private final LafType lookAndFeel;
private final boolean useDarkDefaults;
private final File file;
/**
* Creates a new GTheme with the given name, the default {@link LookAndFeel} for the
* platform and not using dark defaults. This theme will be using all the standard defaults
* from the theme.property files and the defaults from the default LookAndFeel.
* @param name the name for this GTheme
*/
public GTheme(String name) {
this(name, LafType.getDefaultLookAndFeel());
}
/**
* Creates a new empty GTheme with the given name, {@link LookAndFeel}, and whether or not to
* use dark defaults.
* @param name the name for the new GTheme
* @param lafType the look and feel type used by this theme
*/
public GTheme(String name, LafType lafType) {
this(null, name, lafType, lafType.usesDarkDefaults());
}
/**
* Constructor for creating a GTheme with an associated File.
* @param file the file that this theme will save to
* @param name the name of the new theme
* @param lafType the {@link LafType} for the new theme
* @param useDarkDefaults true if this new theme uses dark defaults
*/
public GTheme(File file, String name, LafType lafType, boolean useDarkDefaults) {
this.name = name;
this.lookAndFeel = lafType;
this.useDarkDefaults = useDarkDefaults;
this.file = file;
}
/**
* Returns the name of this GTheme
* @return the name of this GTheme
*/
public String getName() {
return name;
}
/**
* Returns the name of the LookAndFeel associated with this GTheme
* @return the name of the LookAndFeel associated with this GTheme
*/
public LafType getLookAndFeelType() {
return lookAndFeel;
}
/**
* Returns true if this theme should use dark defaults
* @return true if this theme should use dark defaults
*/
public boolean useDarkDefaults() {
return useDarkDefaults;
}
/**
* Returns a String that can be used to find and restore this theme.
* @return a String that can be used to find and restore this theme.
*/
public String getThemeLocater() {
if (file != null) {
return FILE_PREFIX + file.getAbsolutePath();
}
return "Default";
}
/**
* Returns the file associated with this theme.
* @return the file associated with this theme.
*/
public File getFile() {
return file;
}
/**
* Sets the Color for the given id
* @param id the id to associate with the given Color
* @param color the Color to associate with the given id
*/
public void setColor(String id, Color color) {
addColor(new ColorValue(id, color));
}
/**
* Sets a referred Color for the given id
* @param id the id to associate with the refId
* @param refId the id of an indirect Color lookup for the given id.
*/
public void setColorRef(String id, String refId) {
addColor(new ColorValue(id, refId));
}
/**
* Sets the Font for the given id
* @param id the id to associate with the given Font
* @param font the Font to associate with the given id
*/
public void setFont(String id, Font font) {
addFont(new FontValue(id, font));
}
/**
* Sets a referred font for the given id
* @param id the id to associate with the given Font reference id
* @param refId the id of an indirect Font lookup for the given id.
*/
public void setFontRef(String id, String refId) {
addFont(new FontValue(id, refId));
}
/**
* Sets the icon for the given id
* @param id the id to associate with the given IconPath
* @param icon the icon to assign to the given id
*/
public void setIcon(String id, Icon icon) {
addIcon(new IconValue(id, icon));
}
/**
* Sets a referred icon id for the given id
* @param id the id to associate with the given Font
* @param refId the id of an indirect Icon lookup for the given id.
*/
public void setIconRef(String id, String refId) {
addIcon(new IconValue(id, refId));
}
@Override
public String toString() {
return name;
}
@Override
public int hashCode() {
return name.hashCode();
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
GTheme other = (GTheme) obj;
return Objects.equals(name, other.name) && Objects.equals(lookAndFeel, other.lookAndFeel);
}
/**
* Returns true if this theme has a {@link LookAndFeel} that is supported by the current
* platform.
* @return true if this theme has a {@link LookAndFeel} that is supported by the current
* platform.
*/
public boolean hasSupportedLookAndFeel() {
return lookAndFeel.isSupported();
}
/**
* Saves this theme to its associated file.
* @throws IOException if an I/O error occurs when writing the file
*/
public void save() throws IOException {
ThemeWriter writer = new ThemeWriter(this);
writer.writeThemeToFile(file);
}
/**
* Returns true if this theme can not be changed
* @return true if this theme can not be changed
*/
public boolean isReadOnly() {
return false;
}
/**
* Reads a theme from a file. The file can be either a theme file or a zip file containing
* a theme file and optionally a set of icon files.
* @param file the file to read.
* @return the theme that was read from the file
* @throws IOException if an error occurred trying to read a theme from the file.
*/
public static GTheme loadTheme(File file) throws IOException {
ThemeReader reader = new ThemeReader(file);
return reader.readTheme();
}
}