mirror of
https://github.com/NationalSecurityAgency/ghidra.git
synced 2025-10-04 02:09:44 +02:00
GP-2796 - Refactor DockingApplicationLayout to be more generic
This commit is contained in:
dragonmacher
parent
3586062eb4
commit
93f9e93cd7
9 changed files with 74 additions and 217 deletions
|
|
@ -27,11 +27,11 @@ import javax.swing.table.TableModel;
|
|||
|
||||
import db.buffers.LocalBufferFile;
|
||||
import docking.framework.DockingApplicationConfiguration;
|
||||
import docking.framework.DockingApplicationLayout;
|
||||
import docking.widgets.combobox.GComboBox;
|
||||
import docking.widgets.filechooser.GhidraFileChooser;
|
||||
import docking.widgets.label.GDLabel;
|
||||
import docking.widgets.label.GLabel;
|
||||
import generic.application.GenericApplicationLayout;
|
||||
import ghidra.app.plugin.debug.dbtable.DbLargeTableModel;
|
||||
import ghidra.app.plugin.debug.dbtable.DbSmallTableModel;
|
||||
import ghidra.framework.Application;
|
||||
|
|
@ -238,7 +238,7 @@ public class DbViewer extends JFrame {
|
|||
* @param table
|
||||
* @return arrays containing statistics. Element 0 provides
|
||||
* statsitics for primary table, element 1 provides combined
|
||||
* statsitics for all index tables. Remaining array elements
|
||||
* statsitics for all index tables. Remaining array elements
|
||||
* should be ignored since they have been combined into element 1.
|
||||
*/
|
||||
private TableStatistics[] getStats(Table table) {
|
||||
|
|
@ -268,7 +268,7 @@ public class DbViewer extends JFrame {
|
|||
*/
|
||||
public static void main(String[] args) throws IOException {
|
||||
|
||||
ApplicationLayout layout = new DockingApplicationLayout("DB Viewer", "1.0");
|
||||
ApplicationLayout layout = new GenericApplicationLayout("DB Viewer", "1.0");
|
||||
|
||||
DockingApplicationConfiguration configuration = new DockingApplicationConfiguration();
|
||||
configuration.setShowSplashScreen(false);
|
||||
|
|
|
|||
|
|
@ -21,14 +21,15 @@ import javax.swing.*;
|
|||
|
||||
import docking.DialogComponentProvider;
|
||||
import docking.DockingWindowManager;
|
||||
import generic.application.GenericApplicationLayout;
|
||||
import generic.theme.GThemeDefaults.Colors;
|
||||
import ghidra.framework.Application;
|
||||
import utility.application.ApplicationLayout;
|
||||
|
||||
/**
|
||||
* Splash screen window to display version information about the current release of
|
||||
* Splash screen window to display version information about the current release of
|
||||
* the Ghidra application. The window is displayed when Ghidra starts; when
|
||||
* initialization is complete, the splash screen is dismissed.
|
||||
* initialization is complete, the splash screen is dismissed.
|
||||
*/
|
||||
public class AboutDialog extends DialogComponentProvider {
|
||||
|
||||
|
|
@ -68,7 +69,7 @@ public class AboutDialog extends DialogComponentProvider {
|
|||
}
|
||||
|
||||
public static void main(String[] args) throws Exception {
|
||||
ApplicationLayout layout = new DockingApplicationLayout("About Dialog", "1.0");
|
||||
ApplicationLayout layout = new GenericApplicationLayout("About Dialog", "1.0");
|
||||
DockingApplicationConfiguration config = new DockingApplicationConfiguration();
|
||||
config.setShowSplashScreen(false);
|
||||
Application.initializeApplication(layout, config);
|
||||
|
|
|
|||
|
|
@ -24,6 +24,7 @@ import javax.swing.border.BevelBorder;
|
|||
|
||||
import docking.*;
|
||||
import docking.widgets.label.GDLabel;
|
||||
import generic.application.GenericApplicationLayout;
|
||||
import generic.theme.GColor;
|
||||
import generic.theme.Gui;
|
||||
import generic.util.WindowUtilities;
|
||||
|
|
@ -317,7 +318,7 @@ public class SplashScreen extends JWindow {
|
|||
}
|
||||
|
||||
public static void main(String[] args) throws Exception {
|
||||
ApplicationLayout layout = new DockingApplicationLayout("Splash Screen Main", "1.0");
|
||||
ApplicationLayout layout = new GenericApplicationLayout("Splash Screen Main", "1.0");
|
||||
DockingApplicationConfiguration config = new DockingApplicationConfiguration();
|
||||
|
||||
config.setShowSplashScreen(false);
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@
|
|||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package docking.framework;
|
||||
package generic.application;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.FileNotFoundException;
|
||||
|
|
@ -33,10 +33,11 @@ import utility.module.ClasspathFilter;
|
|||
import utility.module.ModuleUtilities;
|
||||
|
||||
/**
|
||||
* The docking application layout defines the customizable elements of a docking application's
|
||||
* directory structure.
|
||||
* A low-level implementation of {@link ApplicationLayout} that is suitable for basic applications.
|
||||
* This class makes use of the {@link GModule Module} system to find application components at
|
||||
* runtime.
|
||||
*/
|
||||
public class DockingApplicationLayout extends ApplicationLayout {
|
||||
public class GenericApplicationLayout extends ApplicationLayout {
|
||||
|
||||
private static final String NO_RELEASE_NAME = "NO_RELEASE";
|
||||
|
||||
|
|
@ -45,30 +46,30 @@ public class DockingApplicationLayout extends ApplicationLayout {
|
|||
Pattern.compile(".*/(\\w+)/bin/main");
|
||||
|
||||
/**
|
||||
* Constructs a new docking application layout object with the given name and version.
|
||||
* Constructs a new application layout object with the given name and version.
|
||||
*
|
||||
* @param name The name of the application.
|
||||
* @param version The version of the application.
|
||||
* @throws FileNotFoundException if there was a problem getting a user directory.
|
||||
*/
|
||||
public DockingApplicationLayout(String name, String version) throws FileNotFoundException {
|
||||
public GenericApplicationLayout(String name, String version) throws FileNotFoundException {
|
||||
this(new ApplicationProperties(name, version, NO_RELEASE_NAME));
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a new docking application layout object with the given set of application
|
||||
* Constructs a new application layout object with the given set of application
|
||||
* properties. The default Ghidra application root directory(s) will be used.
|
||||
*
|
||||
* @param applicationProperties The properties object that will be read system properties.
|
||||
* @throws FileNotFoundException if there was a problem getting a user directory.
|
||||
*/
|
||||
public DockingApplicationLayout(ApplicationProperties applicationProperties)
|
||||
public GenericApplicationLayout(ApplicationProperties applicationProperties)
|
||||
throws FileNotFoundException {
|
||||
this(getDefaultApplicationRootDirs(), applicationProperties);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a new docking application layout object with the given set of application
|
||||
* Constructs a new application layout object with the given set of application
|
||||
* properties.
|
||||
*
|
||||
* @param applicationRootDirs list of application root directories which should be
|
||||
|
|
@ -77,7 +78,7 @@ public class DockingApplicationLayout extends ApplicationLayout {
|
|||
* @param applicationProperties The properties object that will be read system properties.
|
||||
* @throws FileNotFoundException if there was a problem getting a user directory.
|
||||
*/
|
||||
public DockingApplicationLayout(Collection<ResourceFile> applicationRootDirs,
|
||||
public GenericApplicationLayout(Collection<ResourceFile> applicationRootDirs,
|
||||
ApplicationProperties applicationProperties) throws FileNotFoundException {
|
||||
|
||||
this.applicationProperties = Objects.requireNonNull(applicationProperties);
|
||||
|
|
@ -128,8 +129,8 @@ public class DockingApplicationLayout extends ApplicationLayout {
|
|||
ModuleUtilities.findModuleRootDirectories(applicationRootDirs, new ArrayList<>());
|
||||
Map<String, GModule> allModules = ModuleUtilities.findModules(applicationRootDirs, roots);
|
||||
|
||||
// Filter any modules found to ensure that we only include those that are listed on the
|
||||
// classpath. (Due to the nature of how the development classpath is created, not all
|
||||
// Filter any modules found to ensure that we only include those that are listed on the
|
||||
// classpath. (Due to the nature of how the development classpath is created, not all
|
||||
// found modules may match the classpath entries.)
|
||||
Set<String> cpNames = getClassPathModuleNames();
|
||||
Map<String, GModule> filteredModules = new HashMap<>();
|
||||
|
|
@ -29,10 +29,10 @@ import utility.application.ApplicationLayout;
|
|||
import utility.module.ModuleUtilities;
|
||||
|
||||
/**
|
||||
* The Application class provides a variety of static convenience methods for accessing Application
|
||||
* The Application class provides a variety of static convenience methods for accessing Application
|
||||
* elements that can be used once the {@link #initializeApplication} call has been made.
|
||||
*
|
||||
* <p>In order to initialize an application, an {@link ApplicationLayout} and an
|
||||
* <p>In order to initialize an application, an {@link ApplicationLayout} and an
|
||||
* {@link ApplicationConfiguration} must be provided. The layout and configuration come in a
|
||||
* variety of flavors, and are what makes the Application class usable across a range of tools.
|
||||
*
|
||||
|
|
@ -59,7 +59,7 @@ public class Application {
|
|||
|
||||
/**
|
||||
* Creates a new application object. Application is a singleton so this is private.
|
||||
*
|
||||
*
|
||||
* @param layout The application layout to be used by this application.
|
||||
* @param configuration The application configuration to be used by this application.
|
||||
*/
|
||||
|
|
@ -102,8 +102,8 @@ public class Application {
|
|||
|
||||
/**
|
||||
* Initializes the application. The static methods of this class cannot be used until the
|
||||
* application is initialized.
|
||||
*
|
||||
* application is initialized.
|
||||
*
|
||||
* @param layout The application layout to be used by the application.
|
||||
* @param configuration The application configuration to be used by the application.
|
||||
*/
|
||||
|
|
@ -123,7 +123,7 @@ public class Application {
|
|||
|
||||
/**
|
||||
* Checks to see if the application has been initialized.
|
||||
*
|
||||
*
|
||||
* @return true if the application has been initialized; otherwise, false.
|
||||
*/
|
||||
public static boolean isInitialized() {
|
||||
|
|
@ -150,12 +150,12 @@ public class Application {
|
|||
|
||||
/**
|
||||
* If the Application was previously initialized with logging disabled, this method
|
||||
* may be used to perform delayed logging initialization.
|
||||
* may be used to perform delayed logging initialization.
|
||||
* @param logFile application log file, if null the default <i>application.log</i> will be stored
|
||||
* within the user's application settings directory
|
||||
* @param scriptLogFile scripting log file, if null the default <i>script.log</i> will be stored
|
||||
* within the user's application settings directory
|
||||
* @throws AssertException if Application has not yet been initialized, or logging
|
||||
* @throws AssertException if Application has not yet been initialized, or logging
|
||||
* was previously configured for the application.
|
||||
*/
|
||||
public static void initializeLogging(File logFile, File scriptLogFile) {
|
||||
|
|
@ -170,7 +170,7 @@ public class Application {
|
|||
}
|
||||
if (scriptLogFile == null) {
|
||||
// Some clients pass null for the script file, as they do not support scripting. In
|
||||
// that case, just have the system use the application log as the script log. This
|
||||
// that case, just have the system use the application log as the script log. This
|
||||
// prevents the logging system from creating an oddly named log file.
|
||||
scriptLogFile = logFile;
|
||||
}
|
||||
|
|
@ -328,8 +328,7 @@ public class Application {
|
|||
return null;
|
||||
}
|
||||
|
||||
private List<ResourceFile> findFilesByExtensionInModule(String moduleName, String extension)
|
||||
throws IllegalArgumentException {
|
||||
private List<ResourceFile> findFilesByExtensionInModule(String moduleName, String extension) {
|
||||
extension = verifyExtension(extension);
|
||||
List<ResourceFile> list = new ArrayList<>();
|
||||
GModule gModule = app.layout.getModules().get(moduleName);
|
||||
|
|
@ -479,7 +478,7 @@ public class Application {
|
|||
file = getModuleFile(module, "os/" + Platform.WIN_X86_32.getDirectoryName(),
|
||||
exactFilename);
|
||||
}
|
||||
|
||||
|
||||
// Allow mac_x86_64 to be used for mac_arm_64 as fallback (requires macOS Rosetta 2)
|
||||
if (file == null && Platform.CURRENT_PLATFORM == Platform.MAC_ARM_64) {
|
||||
file = getModuleFile(module, "build/os/" + Platform.MAC_X86_64.getDirectoryName(),
|
||||
|
|
@ -493,7 +492,7 @@ public class Application {
|
|||
if (file == null) {
|
||||
throw new OSFileNotFoundException(moduleName, exactFilename);
|
||||
}
|
||||
|
||||
|
||||
return file;
|
||||
}
|
||||
|
||||
|
|
@ -523,7 +522,7 @@ public class Application {
|
|||
if (file == null && Platform.CURRENT_PLATFORM == Platform.WIN_X86_64) {
|
||||
file = findModuleFile("os/" + Platform.WIN_X86_32.getDirectoryName(), path);
|
||||
}
|
||||
|
||||
|
||||
// Allow mac_x86_64 to be used for mac_arm_64 as fallback (requires macOS Rosetta 2)
|
||||
if (file == null && Platform.CURRENT_PLATFORM == Platform.MAC_ARM_64) {
|
||||
file = findModuleFile("build/os/" + Platform.MAC_X86_64.getDirectoryName(), path);
|
||||
|
|
@ -591,19 +590,19 @@ public class Application {
|
|||
return app.layout.getApplicationRootDirs();
|
||||
}
|
||||
|
||||
/**
|
||||
/**
|
||||
* Returns the application root directory. An application root directory is a
|
||||
* directory containing one or more modules. In development mode there may be multiple
|
||||
* application root directories, which can be retrieved via
|
||||
* directory containing one or more modules. In development mode there may be multiple
|
||||
* application root directories, which can be retrieved via
|
||||
* {@link #getApplicationRootDirectories()}.
|
||||
* <p>
|
||||
* In an installation of the application, there will only be one application root directory.
|
||||
* <p>
|
||||
* <b>Note: Be sure you understand that there may be multiple application root
|
||||
* directories in development mode.</b> In general you should not be using this method for
|
||||
* searching for files yourself, but instead using
|
||||
* the various <code>find*</code> methods of this class.
|
||||
*
|
||||
* directories in development mode.</b> In general you should not be using this method for
|
||||
* searching for files yourself, but instead using
|
||||
* the various <code>find*</code> methods of this class.
|
||||
*
|
||||
* @return Returns the application root directory.
|
||||
* @see #getApplicationRootDirectories()
|
||||
*/
|
||||
|
|
@ -624,11 +623,11 @@ public class Application {
|
|||
/**
|
||||
* Returns the temporary directory specific to the user and the application.
|
||||
* Directory has name of <username>-<appname>
|
||||
* This directory may be removed at system reboot or during periodic
|
||||
* This directory may be removed at system reboot or during periodic
|
||||
* system cleanup of unused temp files.
|
||||
* This directory is specific to the application name but not the version.
|
||||
* Resources stored within this directory should utilize some
|
||||
* form of access locking or unique naming. Transient resources should be
|
||||
* Resources stored within this directory should utilize some
|
||||
* form of access locking or unique naming. Transient resources should be
|
||||
* deleted when no longer in use.
|
||||
* @return temp directory
|
||||
*/
|
||||
|
|
@ -639,12 +638,12 @@ public class Application {
|
|||
|
||||
/**
|
||||
* Returns the cache directory specific to the user and the application.
|
||||
* The intention is for directory contents to be preserved, however the
|
||||
* The intention is for directory contents to be preserved, however the
|
||||
* specific location is platform specific and contents may be removed when
|
||||
* not in use and may in fact be the same directory the user temp directory.
|
||||
* This directory is specific to the application name but not the version.
|
||||
* Resources stored within this directory should utilize some
|
||||
* form of access locking and/or unique naming.
|
||||
* Resources stored within this directory should utilize some
|
||||
* form of access locking and/or unique naming.
|
||||
* @return cache directory
|
||||
*/
|
||||
public static File getUserCacheDirectory() {
|
||||
|
|
@ -672,7 +671,7 @@ public class Application {
|
|||
* Returns the installation directory. In an installation, there is only one application root
|
||||
* and its parent is the installation directory. If not an installation, then this call doesn't
|
||||
* really make sense, but it will return the parent of the first installation root.
|
||||
* @return
|
||||
* @return the directory
|
||||
*/
|
||||
public static ResourceFile getInstallationDirectory() {
|
||||
checkAppInitialized();
|
||||
|
|
@ -697,8 +696,8 @@ public class Application {
|
|||
*/
|
||||
public static boolean isTestBuild() {
|
||||
checkAppInitialized();
|
||||
String value = app.layout.getApplicationProperties().getProperty(
|
||||
ApplicationProperties.TEST_RELEASE_PROPERTY);
|
||||
String value = app.layout.getApplicationProperties()
|
||||
.getProperty(ApplicationProperties.TEST_RELEASE_PROPERTY);
|
||||
if (value == null) {
|
||||
return false;
|
||||
}
|
||||
|
|
@ -707,7 +706,7 @@ public class Application {
|
|||
|
||||
/**
|
||||
* Checks whether or not the application is in "single jar" mode.
|
||||
*
|
||||
*
|
||||
* @return true if the application is in "single jar" mode; otherwise, false.
|
||||
*/
|
||||
public static boolean inSingleJarMode() {
|
||||
|
|
@ -818,8 +817,7 @@ public class Application {
|
|||
* @param extension the filename extension for which to find file.s
|
||||
* @return a list of all files with the given extension that are located in the named module.
|
||||
*/
|
||||
public static List<ResourceFile> findFilesByExtension(String moduleName, String extension)
|
||||
throws IllegalArgumentException {
|
||||
public static List<ResourceFile> findFilesByExtension(String moduleName, String extension) {
|
||||
checkAppInitialized();
|
||||
return app.findFilesByExtensionInModule(moduleName, extension);
|
||||
}
|
||||
|
|
@ -839,6 +837,7 @@ public class Application {
|
|||
/**
|
||||
* Returns the directory relative to the calling class's module's data directory.
|
||||
* @param relativePath the path relative the module's data directory
|
||||
* @return the directory
|
||||
* @throws FileNotFoundException if the directory does not exist.
|
||||
* @throws IOException if an error occurred trying to access the directory.
|
||||
*/
|
||||
|
|
@ -857,8 +856,9 @@ public class Application {
|
|||
/**
|
||||
* Return the directory relative the the name module's data directory. (i.e. "/data" will
|
||||
* be prepended to the given path)
|
||||
* @param moduleName the name of the module.
|
||||
* @param moduleName the name of the module.
|
||||
* @param relativePath the path relative to the module's data directory.
|
||||
* @return @return the directory
|
||||
* @throws FileNotFoundException if the directory does not exist
|
||||
* @throws IOException if an error occurred trying to access the directory.
|
||||
*/
|
||||
|
|
@ -870,8 +870,9 @@ public class Application {
|
|||
|
||||
/**
|
||||
* Return the directory relative the the name module's directory.
|
||||
* @param moduleName the name of the module.
|
||||
* @param moduleName the name of the module.
|
||||
* @param relativePath the path relative to the module's root directory.
|
||||
* @return the directory
|
||||
* @throws FileNotFoundException if the directory does not exist
|
||||
* @throws IOException if an error occurred trying to access the directory.
|
||||
*/
|
||||
|
|
@ -884,6 +885,7 @@ public class Application {
|
|||
/**
|
||||
* Returns the file relative to the calling class's module's data directory
|
||||
* @param relativeDataPath the path relative the to module's data directory
|
||||
* @return the file
|
||||
* @throws FileNotFoundException if the file or module does not exist.
|
||||
*/
|
||||
public static ResourceFile getModuleDataFile(String relativeDataPath)
|
||||
|
|
@ -902,6 +904,7 @@ public class Application {
|
|||
* be prepended to the give path)
|
||||
* @param moduleName the name of the module.
|
||||
* @param relativeDataPath the path relative to the module's data directory.
|
||||
* @return the file
|
||||
* @throws FileNotFoundException if the file does not exist.
|
||||
*/
|
||||
public static ResourceFile getModuleDataFile(String moduleName, String relativeDataPath)
|
||||
|
|
@ -914,6 +917,7 @@ public class Application {
|
|||
* Returns the file relative to the named module's directory.
|
||||
* @param moduleName the name of the module.
|
||||
* @param relativePath the path relative to the module's data directory.
|
||||
* @return the file
|
||||
* @throws FileNotFoundException if the file does not exist.
|
||||
*/
|
||||
public static ResourceFile getModuleFile(String moduleName, String relativePath)
|
||||
|
|
@ -924,7 +928,7 @@ public class Application {
|
|||
|
||||
/**
|
||||
* Returns the OS specific file within the given module with the given name.
|
||||
*
|
||||
*
|
||||
* @param moduleName the name of the module
|
||||
* @param exactFilename the name of the OS file within the module.
|
||||
* @return the OS specific file.
|
||||
|
|
@ -938,7 +942,7 @@ public class Application {
|
|||
/**
|
||||
* Returns the specified OS specific file. It is first searched for in the calling class's
|
||||
* module. If it is not found there, it is searched for in all modules.
|
||||
*
|
||||
*
|
||||
* @param exactFilename the name of the OS specific file.
|
||||
* @return the OS specific file.
|
||||
* @throws OSFileNotFoundException if the file does not exist.
|
||||
|
|
@ -953,7 +957,7 @@ public class Application {
|
|||
// not found in my module...fall through
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// We are either not in a module (perhaps script?) or it was not found in my module
|
||||
return app.getOSFileInAnyModule(exactFilename);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -21,6 +21,7 @@ import java.nio.file.Path;
|
|||
import java.nio.file.Paths;
|
||||
import java.util.*;
|
||||
|
||||
import generic.application.GenericApplicationLayout;
|
||||
import generic.theme.ApplicationThemeManager;
|
||||
import ghidra.framework.Application;
|
||||
import ghidra.framework.ApplicationConfiguration;
|
||||
|
|
@ -77,7 +78,8 @@ public class GHelpBuilder {
|
|||
return false;
|
||||
}
|
||||
};
|
||||
Application.initializeApplication(new HelpApplicationLayout("Help Builder", "0.1"), config);
|
||||
Application.initializeApplication(new GenericApplicationLayout("Help Builder", "0.1"),
|
||||
config);
|
||||
|
||||
builder.build(args);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,154 +0,0 @@
|
|||
/* ###
|
||||
* 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 help;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.FileNotFoundException;
|
||||
import java.util.*;
|
||||
import java.util.Map.Entry;
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
import generic.jar.ResourceFile;
|
||||
import ghidra.framework.ApplicationProperties;
|
||||
import ghidra.framework.GModule;
|
||||
import ghidra.util.SystemUtilities;
|
||||
import util.CollectionUtils;
|
||||
import utility.application.ApplicationLayout;
|
||||
import utility.application.ApplicationUtilities;
|
||||
import utility.module.ClasspathFilter;
|
||||
import utility.module.ModuleUtilities;
|
||||
|
||||
//
|
||||
// TODO this class should be deleted when the GP-1981 branch is merged into master. The
|
||||
// DockingApplicationLayout is not accessible by help, due to Docking depending on Help.
|
||||
// Much of the application layout code should live in Utility so that it is reachable by more
|
||||
// modules. Docking and Ghidra application layout classes should also have their names
|
||||
// changed.
|
||||
//
|
||||
// Perhaps: ModuleAppliactionLayout and ClasspathApplicationLayout.
|
||||
//
|
||||
public class HelpApplicationLayout extends ApplicationLayout {
|
||||
|
||||
private static final String NO_RELEASE_NAME = "NO_RELEASE";
|
||||
|
||||
/** Dev mode main source bin dir pattern */
|
||||
private static final Pattern CLASS_PATH_MODULE_NAME_PATTERN =
|
||||
Pattern.compile(".*/(\\w+)/bin/main");
|
||||
|
||||
/**
|
||||
* Constructs a new docking application layout object with the given name and version.
|
||||
*
|
||||
* @param name The name of the application.
|
||||
* @param version The version of the application.
|
||||
* @throws FileNotFoundException if there was a problem getting a user directory.
|
||||
*/
|
||||
public HelpApplicationLayout(String name, String version) throws FileNotFoundException {
|
||||
|
||||
this.applicationProperties =
|
||||
Objects.requireNonNull(new ApplicationProperties(name, version, NO_RELEASE_NAME));
|
||||
this.applicationRootDirs = getDefaultApplicationRootDirs();
|
||||
applicationRootDirs.addAll(getAdditionalApplicationRootDirs(applicationRootDirs));
|
||||
|
||||
// Application installation directory
|
||||
applicationInstallationDir = applicationRootDirs.iterator().next().getParentFile();
|
||||
if (SystemUtilities.isInDevelopmentMode()) {
|
||||
applicationInstallationDir = applicationInstallationDir.getParentFile();
|
||||
}
|
||||
|
||||
// Modules
|
||||
if (SystemUtilities.isInDevelopmentMode()) {
|
||||
|
||||
// In development mode we rely on the IDE's classpath to determine which modules to
|
||||
// include, as opposed to scanning the filesystem. This prevents unrelated modules
|
||||
// from being used.
|
||||
|
||||
modules = ModuleUtilities.findModules(applicationRootDirs,
|
||||
ModuleUtilities.findModuleRootDirectories(applicationRootDirs),
|
||||
new ClasspathFilter());
|
||||
}
|
||||
else {
|
||||
modules = ModuleUtilities.findModules(applicationRootDirs, applicationRootDirs);
|
||||
}
|
||||
|
||||
// User directories
|
||||
userTempDir = ApplicationUtilities.getDefaultUserTempDir(applicationProperties);
|
||||
userSettingsDir = ApplicationUtilities.getDefaultUserSettingsDir(applicationProperties,
|
||||
applicationInstallationDir);
|
||||
}
|
||||
|
||||
protected Collection<ResourceFile> getAdditionalApplicationRootDirs(
|
||||
Collection<ResourceFile> roots) {
|
||||
return Collections.emptyList();
|
||||
}
|
||||
|
||||
protected Map<String, GModule> findModules() {
|
||||
if (!SystemUtilities.isInDevelopmentMode()) {
|
||||
// in release mode we only have one application root, so no need to find all others
|
||||
return ModuleUtilities.findModules(applicationRootDirs, applicationRootDirs);
|
||||
}
|
||||
|
||||
// In development mode we may have multiple module root directories under which modules may
|
||||
// be found. Search all roots for modules.
|
||||
Collection<ResourceFile> roots =
|
||||
ModuleUtilities.findModuleRootDirectories(applicationRootDirs, new ArrayList<>());
|
||||
Map<String, GModule> allModules = ModuleUtilities.findModules(applicationRootDirs, roots);
|
||||
|
||||
// Filter any modules found to ensure that we only include those that are listed on the
|
||||
// classpath. (Due to the nature of how the development classpath is created, not all
|
||||
// found modules may match the classpath entries.)
|
||||
Set<String> cpNames = getClassPathModuleNames();
|
||||
Map<String, GModule> filteredModules = new HashMap<>();
|
||||
Set<Entry<String, GModule>> entrySet = allModules.entrySet();
|
||||
for (Entry<String, GModule> entry : entrySet) {
|
||||
GModule module = entry.getValue();
|
||||
if (cpNames.contains(module.getName())) {
|
||||
filteredModules.put(entry.getKey(), module);
|
||||
}
|
||||
}
|
||||
|
||||
return filteredModules;
|
||||
}
|
||||
|
||||
private Set<String> getClassPathModuleNames() {
|
||||
String cp = System.getProperty("java.class.path");
|
||||
String[] pathParts = cp.split(File.pathSeparator);
|
||||
Set<String> paths = new HashSet<>(Arrays.asList(pathParts));
|
||||
Set<String> cpNames = new HashSet<>();
|
||||
for (String cpEntry : paths) {
|
||||
Matcher matcher = CLASS_PATH_MODULE_NAME_PATTERN.matcher(cpEntry);
|
||||
if (matcher.matches()) {
|
||||
cpNames.add(matcher.group(1));
|
||||
}
|
||||
}
|
||||
return cpNames;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the default list of Application directories. In repo-based
|
||||
* development mode this includes the root Ghidra directory within each repo.
|
||||
* When not in development mode, the requirement is that the current working
|
||||
* directory correspond to the installation root. The first entry will be
|
||||
* the primary root in both cases.
|
||||
* @return root directories
|
||||
*/
|
||||
public static Collection<ResourceFile> getDefaultApplicationRootDirs() {
|
||||
if (SystemUtilities.isInDevelopmentMode()) {
|
||||
return ApplicationUtilities.findDefaultApplicationRootDirs();
|
||||
}
|
||||
return CollectionUtils.asList(new ResourceFile(System.getProperty("user.dir")));
|
||||
}
|
||||
}
|
||||
|
|
@ -24,8 +24,8 @@ import javax.swing.text.html.HTMLEditorKit;
|
|||
import docking.DialogComponentProvider;
|
||||
import docking.DockingWindowManager;
|
||||
import docking.framework.DockingApplicationConfiguration;
|
||||
import docking.framework.DockingApplicationLayout;
|
||||
import docking.widgets.label.GDLabel;
|
||||
import generic.application.GenericApplicationLayout;
|
||||
import generic.theme.Gui;
|
||||
import ghidra.framework.Application;
|
||||
import ghidra.util.HTMLUtilities;
|
||||
|
|
@ -113,7 +113,7 @@ public class UserAgreementDialog extends DialogComponentProvider {
|
|||
}
|
||||
|
||||
public static void main(String[] args) throws Exception {
|
||||
ApplicationLayout layout = new DockingApplicationLayout("User Agreement Main", "1.0");
|
||||
ApplicationLayout layout = new GenericApplicationLayout("User Agreement Main", "1.0");
|
||||
DockingApplicationConfiguration config = new DockingApplicationConfiguration();
|
||||
Application.initializeApplication(layout, config);
|
||||
UserAgreementDialog dialog = new UserAgreementDialog(true, true);
|
||||
|
|
|
|||
|
|
@ -27,7 +27,9 @@ import org.jdom.Element;
|
|||
import org.jdom.input.SAXBuilder;
|
||||
import org.jdom.output.XMLOutputter;
|
||||
|
||||
import docking.framework.*;
|
||||
import docking.framework.ApplicationInformationDisplayFactory;
|
||||
import docking.framework.DockingApplicationConfiguration;
|
||||
import generic.application.GenericApplicationLayout;
|
||||
import ghidra.framework.*;
|
||||
import ghidra.framework.model.ToolServices;
|
||||
import ghidra.util.Msg;
|
||||
|
|
@ -61,7 +63,7 @@ public abstract class StandAloneApplication implements GenericStandAloneApplicat
|
|||
* @throws IOException error causing application initialization failure
|
||||
*/
|
||||
public StandAloneApplication(String propertiesFilename) throws IOException {
|
||||
this(new DockingApplicationLayout(readApplicationProperties(propertiesFilename)));
|
||||
this(new GenericApplicationLayout(readApplicationProperties(propertiesFilename)));
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -72,7 +74,7 @@ public abstract class StandAloneApplication implements GenericStandAloneApplicat
|
|||
* @throws IOException error causing application initialization failure
|
||||
*/
|
||||
public StandAloneApplication(String name, String version) throws IOException {
|
||||
this(new DockingApplicationLayout(name, version));
|
||||
this(new GenericApplicationLayout(name, version));
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue