org.eclipse.pde.internal.ui.PDEPlugin Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2000, 2019 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* Alexander Fedorov - Bug 489181
*******************************************************************************/
package org.eclipse.pde.internal.ui;
import java.lang.reflect.InvocationTargetException;
import java.net.URL;
import java.util.Hashtable;
import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.pde.internal.core.PDEPreferencesManager;
import org.eclipse.pde.internal.ui.launcher.PDELogFileProvider;
import org.eclipse.pde.internal.ui.shared.target.RepositoryBundleContainerAdapterFactory;
import org.eclipse.pde.internal.ui.shared.target.TargetReferenceBundleContainerAdapterFactory;
import org.eclipse.pde.internal.ui.shared.target.TargetStatus;
import org.eclipse.pde.internal.ui.util.SWTUtil;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.editors.text.TextFileDocumentProvider;
import org.eclipse.ui.forms.FormColors;
import org.eclipse.ui.internal.views.log.ILogFileProvider;
import org.eclipse.ui.internal.views.log.LogFilesManager;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.eclipse.ui.texteditor.IDocumentProvider;
import org.osgi.framework.BundleContext;
public class PDEPlugin extends AbstractUIPlugin implements IPDEUIConstants {
// Shared instance
private static PDEPlugin fInstance;
private Hashtable fCounters;
// Provides Launch Configurations log files to Log View
private ILogFileProvider fLogFileProvider;
// Shared colors for all forms
private FormColors fFormColors;
private PDELabelProvider fLabelProvider;
/**
* The shared text file document provider.
* @since 3.2
*/
private IDocumentProvider fTextFileDocumentProvider;
private PDEPreferencesManager fPreferenceManager;
public PDEPlugin() {
fInstance = this;
}
public PDEPreferencesManager getPreferenceManager() {
if (fPreferenceManager == null) {
fPreferenceManager = new PDEPreferencesManager(PLUGIN_ID);
}
return fPreferenceManager;
}
public URL getInstallURL() {
return getDefault().getBundle().getEntry("/"); //$NON-NLS-1$
}
/**
* @return The active workbench page or null if the workbench is shutting down
*/
public static IWorkbenchPage getActivePage() {
return getDefault().internalGetActivePage();
}
public static Shell getActiveWorkbenchShell() {
IWorkbenchWindow window = getActiveWorkbenchWindow();
if (window != null) {
return window.getShell();
}
return null;
}
/**
* Returns the currently active window for the workbench (if any). Returns
* null if there is no active workbench window. Returns
* null if called from a non-UI thread.
*
* @return the active workbench window, or null if there is
* no active workbench window or if called from a non-UI thread
*/
public static IWorkbenchWindow getActiveWorkbenchWindow() {
return PlatformUI.getWorkbench().getActiveWorkbenchWindow();
}
public static PDEPlugin getDefault() {
return fInstance;
}
public Hashtable getDefaultNameCounters() {
if (fCounters == null)
fCounters = new Hashtable<>();
return fCounters;
}
public static String getPluginId() {
return getDefault().getBundle().getSymbolicName();
}
public static IWorkspace getWorkspace() {
return ResourcesPlugin.getWorkspace();
}
/**
* @return The active workbench page or null if the workbench is shutting down
*/
private IWorkbenchPage internalGetActivePage() {
IWorkbenchWindow workbenchWin = PlatformUI.getWorkbench().getActiveWorkbenchWindow();
return workbenchWin != null ? workbenchWin.getActivePage() : null;
}
/**
* Logs the given status object in the error log
* @param status status to add to the error log
*/
public static void log(IStatus status) {
getDefault().getLog().log(status);
}
/**
* Logs a new error status with the given message in the error log
* @param message message to add to the error log
*/
public static void log(String message) {
log(Status.error(message));
}
public static void logException(Throwable e, final String title, String message) {
if (e instanceof InvocationTargetException) {
e = ((InvocationTargetException) e).getTargetException();
}
IStatus status = null;
if (e instanceof CoreException ce) {
// Re-use status only if it has attached exception with the stack
// trace
if (ce.getStatus().getException() != null) {
status = ce.getStatus();
}
}
if (status == null) {
if (message == null) {
message = e.getMessage();
}
if (message == null) {
message = e.toString();
}
status = Status.error(message, e);
}
getDefault().getLog().log(status);
Display display = SWTUtil.getStandardDisplay();
final IStatus fstatus = status;
display.asyncExec(() -> ErrorDialog.openError(null, title, null, fstatus));
}
public static void logException(Throwable e) {
logException(e, null, null);
}
public static void log(Throwable e) {
if (e instanceof InvocationTargetException) {
e = ((InvocationTargetException) e).getTargetException();
}
IStatus status = null;
if (e instanceof CoreException ce) {
// Re-use status only if it has attached exception with the stack trace
if (ce.getStatus().getException() != null) {
status = ce.getStatus();
}
}
if (status == null) {
status = Status.error(e.getMessage(), e);
}
log(status);
}
public FormColors getFormColors(Display display) {
if (fFormColors == null) {
fFormColors = new FormColors(display);
fFormColors.markShared();
}
return fFormColors;
}
@Override
public void start(BundleContext context) throws Exception {
super.start(context);
fLogFileProvider = new PDELogFileProvider();
LogFilesManager.addLogFileProvider(fLogFileProvider);
TargetStatus.initializeTargetStatus();
}
@Override
public void stop(BundleContext context) throws Exception {
if (fFormColors != null) {
fFormColors.dispose();
fFormColors = null;
}
if (fLabelProvider != null) {
fLabelProvider.dispose();
fLabelProvider = null;
}
if (fLogFileProvider != null) {
LogFilesManager.removeLogFileProvider(fLogFileProvider);
fLogFileProvider = null;
}
Utilities.shutdown();
super.stop(context);
TargetReferenceBundleContainerAdapterFactory.LABEL_PROVIDER.dispose();
RepositoryBundleContainerAdapterFactory.LABEL_PROVIDER.dispose();
}
public PDELabelProvider getLabelProvider() {
if (fLabelProvider == null)
fLabelProvider = new PDELabelProvider();
return fLabelProvider;
}
public static boolean isFullNameModeEnabled() {
IPreferenceStore store = getDefault().getPreferenceStore();
return store.getString(IPreferenceConstants.PROP_SHOW_OBJECTS).equals(IPreferenceConstants.VALUE_USE_NAMES);
}
/**
* Returns the shared text file document provider for this plug-in.
*
* @return the shared text file document provider
* @since 3.2
*/
public synchronized IDocumentProvider getTextFileDocumentProvider() {
if (fTextFileDocumentProvider == null)
fTextFileDocumentProvider = new TextFileDocumentProvider();
return fTextFileDocumentProvider;
}
/**
* Returns a section in the PDE UI plug-in's dialog settings. If the section doesn't exist yet, it is created.
*
* @param name the name of the section
* @return the section of the given name
* @since 3.6.100
*/
public IDialogSettings getDialogSettingsSection(String name) {
IDialogSettings dialogSettings = getDialogSettings();
IDialogSettings section = dialogSettings.getSection(name);
if (section == null) {
section = dialogSettings.addNewSection(name);
}
return section;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy