X-Git-Url: http://git.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/PHPeclipsePlugin.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/PHPeclipsePlugin.java index 4511487..b0b2811 100644 --- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/PHPeclipsePlugin.java +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/PHPeclipsePlugin.java @@ -10,7 +10,9 @@ Klaus Hartlage - www.eclipseproject.de **********************************************************************/ package net.sourceforge.phpeclipse; + import java.io.File; +import java.io.IOException; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; @@ -18,13 +20,28 @@ import java.util.HashSet; import java.util.Iterator; import java.util.List; import java.util.Set; + +import net.sourceforge.phpdt.core.IBuffer; +import net.sourceforge.phpdt.core.IBufferFactory; +import net.sourceforge.phpdt.core.ICompilationUnit; +import net.sourceforge.phpdt.core.IJavaElement; import net.sourceforge.phpdt.core.JavaCore; +import net.sourceforge.phpdt.core.WorkingCopyOwner; import net.sourceforge.phpdt.externaltools.internal.model.ColorManager; import net.sourceforge.phpdt.externaltools.internal.model.ExternalToolsPlugin; -import net.sourceforge.phpdt.externaltools.internal.model.VariableContextManager; +import net.sourceforge.phpdt.internal.core.BatchOperation; import net.sourceforge.phpdt.internal.core.JavaModelManager; +import net.sourceforge.phpdt.internal.corext.template.php.CodeTemplateContextType; +import net.sourceforge.phpdt.internal.corext.template.php.HTMLContextType; +import net.sourceforge.phpdt.internal.corext.template.php.JavaContextType; +import net.sourceforge.phpdt.internal.corext.template.php.JavaDocContextType; +import net.sourceforge.phpdt.internal.ui.IJavaStatusConstants; +import net.sourceforge.phpdt.internal.ui.JavaElementAdapterFactory; +import net.sourceforge.phpdt.internal.ui.ResourceAdapterFactory; import net.sourceforge.phpdt.internal.ui.preferences.MembersOrderPreferenceCache; -import net.sourceforge.phpdt.internal.ui.preferences.TemplatePreferencePage; +import net.sourceforge.phpdt.internal.ui.preferences.MockupPreferenceStore; +import net.sourceforge.phpdt.internal.ui.text.PreferencesAdapter; +import net.sourceforge.phpdt.internal.ui.text.folding.JavaFoldingStructureProviderRegistry; import net.sourceforge.phpdt.internal.ui.text.java.hover.JavaEditorTextHoverDescriptor; import net.sourceforge.phpdt.internal.ui.viewsupport.ImageDescriptorRegistry; import net.sourceforge.phpdt.internal.ui.viewsupport.ProblemMarkerManager; @@ -36,35 +53,45 @@ import net.sourceforge.phpeclipse.builder.ExternalEditorInput; import net.sourceforge.phpeclipse.builder.ExternalStorageDocumentProvider; import net.sourceforge.phpeclipse.builder.FileStorage; import net.sourceforge.phpeclipse.builder.IdentifierIndexManager; +import net.sourceforge.phpeclipse.phpeditor.CustomBufferFactory; +import net.sourceforge.phpeclipse.phpeditor.DocumentAdapter; import net.sourceforge.phpeclipse.phpeditor.PHPDocumentProvider; import net.sourceforge.phpeclipse.phpeditor.PHPSyntaxRdr; import net.sourceforge.phpeclipse.phpeditor.WorkingCopyManager; import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider; -import net.sourceforge.phpeclipse.resourcesview.PHPElement; -import net.sourceforge.phpeclipse.resourcesview.PHPElementAdapterFactory; -import net.sourceforge.phpeclipse.resourcesview.ResourceAdapterFactory; -import org.eclipse.core.boot.BootLoader; + import org.eclipse.core.resources.IFile; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IResource; import org.eclipse.core.resources.IResourceChangeEvent; +import org.eclipse.core.resources.ISavedState; import org.eclipse.core.resources.IWorkspace; +import org.eclipse.core.resources.IWorkspaceRunnable; import org.eclipse.core.resources.ResourcesPlugin; import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IAdapterManager; +import org.eclipse.core.runtime.IConfigurationElement; import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IPluginDescriptor; +import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.IStatus; import org.eclipse.core.runtime.Path; import org.eclipse.core.runtime.Platform; import org.eclipse.core.runtime.Status; +import org.eclipse.core.runtime.jobs.ISchedulingRule; import org.eclipse.jface.action.GroupMarker; import org.eclipse.jface.action.IMenuManager; import org.eclipse.jface.action.Separator; import org.eclipse.jface.preference.IPreferenceStore; import org.eclipse.jface.preference.PreferenceConverter; +import org.eclipse.jface.resource.JFaceResources; import org.eclipse.jface.text.BadLocationException; import org.eclipse.jface.text.IDocument; +import org.eclipse.jface.text.templates.ContextTypeRegistry; +import org.eclipse.jface.text.templates.persistence.TemplateStore; +import org.eclipse.jface.util.IPropertyChangeListener; +import org.eclipse.jface.util.PropertyChangeEvent; +import org.eclipse.swt.graphics.RGB; import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Shell; import org.eclipse.ui.IEditorDescriptor; @@ -75,70 +102,192 @@ import org.eclipse.ui.IWorkbench; import org.eclipse.ui.IWorkbenchPage; import org.eclipse.ui.IWorkbenchWindow; import org.eclipse.ui.PlatformUI; +import org.eclipse.ui.editors.text.EditorsUI; +import org.eclipse.ui.editors.text.templates.ContributionContextTypeRegistry; +import org.eclipse.ui.editors.text.templates.ContributionTemplateStore; import org.eclipse.ui.ide.IDE; import org.eclipse.ui.plugin.AbstractUIPlugin; +import org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants; +import org.eclipse.ui.texteditor.ChainedPreferenceStore; +import org.eclipse.ui.texteditor.ConfigurationElementSorter; import org.eclipse.ui.texteditor.IDocumentProvider; import org.eclipse.ui.texteditor.ITextEditor; +import org.eclipse.ui.texteditor.MarkerAnnotationPreferences; +import org.osgi.framework.BundleContext; + /** * The main plugin class to be used in the desktop. */ -public class PHPeclipsePlugin extends AbstractUIPlugin - implements - IPreferenceConstants { +public class PHPeclipsePlugin extends AbstractUIPlugin implements + IPreferenceConstants { /** * The id of the PHP plugin (value "net.sourceforge.phpeclipse"). */ public static final String PLUGIN_ID = "net.sourceforge.phpeclipse"; //$NON-NLS-1$ + /** * id of builder - matches plugin.xml (concatenate pluginid.builderid) */ public static final String BUILDER_PARSER_ID = PLUGIN_ID + ".parserbuilder"; + //public static final String BUILDER_INDEX_ID = PLUGIN_ID + ".indexbuilder"; /** General debug flag */ public static final boolean DEBUG = false; + /** * The maximum number of allowed proposals by category */ public final static int MAX_PROPOSALS = 200; + + /** + * The key to store customized templates. + * @since 3.0 + */ + private static final String TEMPLATES_KEY= "net.sourceforge.phpdt.ui.text.custom_templates"; //$NON-NLS-1$ + /** + * The key to store customized code templates. + * @since 3.0 + */ + private static final String CODE_TEMPLATES_KEY= "net.sourceforge.phpdt.ui.text.custom_code_templates"; //$NON-NLS-1$ + /** + * The key to store whether the legacy templates have been migrated + * @since 3.0 + */ +// private static final String TEMPLATES_MIGRATION_KEY= "net.sourceforge.phpdt.ui.text.templates_migrated"; //$NON-NLS-1$ + /** + * The key to store whether the legacy code templates have been migrated + * @since 3.0 + */ +// private static final String CODE_TEMPLATES_MIGRATION_KEY= "net.sourceforge.phpdt.ui.text.code_templates_migrated"; //$NON-NLS-1$ + + private static ExternalToolsPlugin externalTools; + /** * The Java virtual machine that we are running on. */ private static int jvm; + /** MRJ 2.0 */ private static final int MRJ_2_0 = 0; + /** MRJ 2.1 or later */ private static final int MRJ_2_1 = 1; + /** Java on Mac OS X 10.0 (MRJ 3.0) */ private static final int MRJ_3_0 = 3; + /** MRJ 3.1 */ private static final int MRJ_3_1 = 4; + /** JVM constant for any other platform */ private static final int OTHER = -1; + // public static final String PHP_RESOURCES_VIEW_ID = PLUGIN_ID + // ".resourcesview.ViewPHPResources"; //$NON-NLS-1$ public static final String PHP_CODING_ACTION_SET_ID = PLUGIN_ID + ".ui.CodingActionSet"; //$NON-NLS-1$ + public final static String PHP_NATURE_ID = PLUGIN_ID + ".phpnature"; + public static final String PHPPARSER_ORIGINAL = "net.sourceforge.phpdt.internal.compiler.parser.Parser"; + public static final String PHPPARSER_NEW = "test.PHPParser"; + /** Change this if you want to switch PHP Parser. */ public static final String PHPPARSER = PHPPARSER_ORIGINAL; + //The shared instance. private static PHPeclipsePlugin plugin; + + /** + * The template context type registry for the java editor. + * @since 3.0 + */ + private ContextTypeRegistry fContextTypeRegistry; + /** + * The code template context type registry for the java editor. + * @since 3.0 + */ + private ContextTypeRegistry fCodeTemplateContextTypeRegistry; + + /** + * The template store for the java editor. + * @since 3.0 + */ + private TemplateStore fTemplateStore; + /** + * The coded template store for the java editor. + * @since 3.0 + */ + private TemplateStore fCodeTemplateStore; + /** Windows 9x */ private static final int WINDOWS_9x = 6; + /** Windows NT */ private static final int WINDOWS_NT = 5; + private ImageDescriptorRegistry fImageDescriptorRegistry; + private HashMap fIndexManagerMap = new HashMap(); + private IWorkingCopyManager fWorkingCopyManager; + + private IBufferFactory fBufferFactory; + private PHPDocumentProvider fCompilationUnitDocumentProvider; + private JavaTextTools fJavaTextTools; + private ProblemMarkerManager fProblemMarkerManager; + private MembersOrderPreferenceCache fMembersOrderPreferenceCache; + private IFile fLastEditorFile = null; + private JavaEditorTextHoverDescriptor[] fJavaEditorTextHoverDescriptors; + + private JavaElementAdapterFactory fJavaElementAdapterFactory; + + // private MarkerAdapterFactory fMarkerAdapterFactory; + // private EditorInputAdapterFactory fEditorInputAdapterFactory; + private ResourceAdapterFactory fResourceAdapterFactory; + + // private LogicalPackageAdapterFactory fLogicalPackageAdapterFactory; + private IPropertyChangeListener fFontPropertyChangeListener; + + /** + * Property change listener on this plugin's preference store. + * + * @since 3.0 + */ + private IPropertyChangeListener fPropertyChangeListener; + + /** + * The combined preference store. + * + * @since 3.0 + */ + private IPreferenceStore fCombinedPreferenceStore; + + /** + * The extension point registry for the + * net.sourceforge.phpdt.ui.javaFoldingStructureProvider extension + * point. + * + * @since 3.0 + */ + private JavaFoldingStructureProviderRegistry fFoldingStructureProviderRegistry; + + /** + * Mockup preference store for firing events and registering listeners on + * project setting changes. FIXME: Temporary solution. + * + * @since 3.0 + */ + private MockupPreferenceStore fMockupPreferenceStore; + /** * The constructor. */ @@ -154,6 +303,20 @@ public class PHPeclipsePlugin extends AbstractUIPlugin // resourceBundle = null; // } } + + // /** + // * Returns all Java editor text hovers contributed to the workbench. + // * + // * @return an array of JavaEditorTextHoverDescriptor + // * @since 2.1 + // */ + // public JavaEditorTextHoverDescriptor[] getJavaEditorTextHoverDescriptors() + // { + // if (fJavaEditorTextHoverDescriptors == null) + // fJavaEditorTextHoverDescriptors = JavaEditorTextHoverDescriptor + // .getContributedHovers(); + // return fJavaEditorTextHoverDescriptors; + // } /** * Returns all Java editor text hovers contributed to the workbench. * @@ -161,11 +324,88 @@ public class PHPeclipsePlugin extends AbstractUIPlugin * @since 2.1 */ public JavaEditorTextHoverDescriptor[] getJavaEditorTextHoverDescriptors() { - if (fJavaEditorTextHoverDescriptors == null) + if (fJavaEditorTextHoverDescriptors == null) { fJavaEditorTextHoverDescriptors = JavaEditorTextHoverDescriptor .getContributedHovers(); + ConfigurationElementSorter sorter = new ConfigurationElementSorter() { + /* + * @see org.eclipse.ui.texteditor.ConfigurationElementSorter#getConfigurationElement(java.lang.Object) + */ + public IConfigurationElement getConfigurationElement(Object object) { + return ((JavaEditorTextHoverDescriptor) object) + .getConfigurationElement(); + } + }; + sorter.sort(fJavaEditorTextHoverDescriptors); + + // The Problem hover has to be the first and the Annotation hover has to + // be the last one in the JDT UI's hover list + int length = fJavaEditorTextHoverDescriptors.length; + int first = -1; + int last = length - 1; + int problemHoverIndex = -1; + int annotationHoverIndex = -1; + for (int i = 0; i < length; i++) { + if (!fJavaEditorTextHoverDescriptors[i].getId().startsWith(PLUGIN_ID)) { + if (problemHoverIndex == -1 || annotationHoverIndex == -1) + continue; + else { + last = i - 1; + break; + } + } + if (first == -1) + first = i; + + if (fJavaEditorTextHoverDescriptors[i].getId().equals( + "net.sourceforge.phpdt.ui.AnnotationHover")) { //$NON-NLS-1$ + annotationHoverIndex = i; + continue; + } + if (fJavaEditorTextHoverDescriptors[i].getId().equals( + "net.sourceforge.phpdt.ui.ProblemHover")) { //$NON-NLS-1$ + problemHoverIndex = i; + continue; + } + } + + JavaEditorTextHoverDescriptor hoverDescriptor = null; + + if (first > -1 && problemHoverIndex > -1 && problemHoverIndex != first) { + // move problem hover to beginning + hoverDescriptor = fJavaEditorTextHoverDescriptors[first]; + fJavaEditorTextHoverDescriptors[first] = fJavaEditorTextHoverDescriptors[problemHoverIndex]; + fJavaEditorTextHoverDescriptors[problemHoverIndex] = hoverDescriptor; + + // update annotation hover index if needed + if (annotationHoverIndex == first) + annotationHoverIndex = problemHoverIndex; + } + + if (annotationHoverIndex > -1 && annotationHoverIndex != last) { + // move annotation hover to end + hoverDescriptor = fJavaEditorTextHoverDescriptors[last]; + fJavaEditorTextHoverDescriptors[last] = fJavaEditorTextHoverDescriptors[annotationHoverIndex]; + fJavaEditorTextHoverDescriptors[annotationHoverIndex] = hoverDescriptor; + } + + // Move Best Match hover to front + for (int i = 0; i < fJavaEditorTextHoverDescriptors.length - 1; i++) { + if (PreferenceConstants.ID_BESTMATCH_HOVER + .equals(fJavaEditorTextHoverDescriptors[i].getId())) { + hoverDescriptor = fJavaEditorTextHoverDescriptors[i]; + for (int j = i; j > 0; j--) + fJavaEditorTextHoverDescriptors[j] = fJavaEditorTextHoverDescriptors[j - 1]; + fJavaEditorTextHoverDescriptors[0] = hoverDescriptor; + break; + } + + } + } + return fJavaEditorTextHoverDescriptors; } + /** * Resets the Java editor text hovers contributed to the workbench. *

@@ -179,6 +419,7 @@ public class PHPeclipsePlugin extends AbstractUIPlugin public void resetJavaEditorTextHoverDescriptors() { fJavaEditorTextHoverDescriptors = null; } + /** * Creates the PHP plugin standard groups in a context menu. */ @@ -197,12 +438,15 @@ public class PHPeclipsePlugin extends AbstractUIPlugin menu.add(new Separator(IContextMenuConstants.GROUP_VIEWER_SETUP)); menu.add(new Separator(IContextMenuConstants.GROUP_PROPERTIES)); } + public static IWorkbenchPage getActivePage() { return getDefault().internalGetActivePage(); } + public static Shell getActiveWorkbenchShell() { return getActiveWorkbenchWindow().getShell(); } + /** * Returns an array of all editors that have an unsaved content. If the * identical content is presented in more than one editor, only one of those @@ -231,27 +475,34 @@ public class PHPeclipsePlugin extends AbstractUIPlugin } return (IEditorPart[]) result.toArray(new IEditorPart[result.size()]); } + public static IWorkbenchWindow getActiveWorkbenchWindow() { return getDefault().getWorkbench().getActiveWorkbenchWindow(); } + /** * Returns the shared instance. */ public static PHPeclipsePlugin getDefault() { return plugin; } + public static ImageDescriptorRegistry getImageDescriptorRegistry() { return getDefault().internalGetImageDescriptorRegistry(); } + static IPath getInstallLocation() { return new Path(getDefault().getDescriptor().getInstallURL().getFile()); } + public static int getJVM() { return jvm; } + public static String getPluginId() { return getDefault().getDescriptor().getUniqueIdentifier(); } + /** * Returns the standard display to be used. The method first checks, if the * thread calling this method has an associated display. If so, this display @@ -264,6 +515,7 @@ public class PHPeclipsePlugin extends AbstractUIPlugin } return display; } + // public static ExternalToolsPlugin getExternalTools() { // return externalTools; // } @@ -273,9 +525,11 @@ public class PHPeclipsePlugin extends AbstractUIPlugin public static IWorkspace getWorkspace() { return ResourcesPlugin.getWorkspace(); } + public static boolean isDebug() { return getDefault().isDebugging(); } + // public static void logErrorMessage(String message) { // log(new Status(IStatus.ERROR, getPluginId(), // JavaStatusConstants.INTERNAL_ERROR, message, null)); @@ -301,13 +555,21 @@ public class PHPeclipsePlugin extends AbstractUIPlugin Status status = new Status(severity, PLUGIN_ID, IStatus.OK, message, null); log(status); } + public static void log(IStatus status) { getDefault().getLog().log(status); } + public static void log(Throwable e) { log(new Status(IStatus.ERROR, PLUGIN_ID, IStatus.ERROR, "PHPeclipsePlugin.internalErrorOccurred", e)); //$NON-NLS-1$ } + + public static void logErrorMessage(String message) { + log(new Status(IStatus.ERROR, getPluginId(), + IJavaStatusConstants.INTERNAL_ERROR, message, null)); + } + private static void setJVM() { String osName = System.getProperty("os.name"); if (osName.startsWith("Mac OS")) { @@ -335,17 +597,19 @@ public class PHPeclipsePlugin extends AbstractUIPlugin } } } + // TODO: refactor this into a better method name ! public synchronized PHPDocumentProvider getCompilationUnitDocumentProvider() { if (fCompilationUnitDocumentProvider == null) fCompilationUnitDocumentProvider = new PHPDocumentProvider(); return fCompilationUnitDocumentProvider; } + /** * Get the identifier index manager for the given project * * @param iProject - * the current project + * the current project * @return */ public IdentifierIndexManager getIndexManager(IProject iProject) { @@ -359,6 +623,7 @@ public class PHPeclipsePlugin extends AbstractUIPlugin } return indexManager; } + public synchronized IWorkingCopyManager getWorkingCopyManager() { if (fWorkingCopyManager == null) { PHPDocumentProvider provider = getCompilationUnitDocumentProvider(); @@ -366,24 +631,46 @@ public class PHPeclipsePlugin extends AbstractUIPlugin } return fWorkingCopyManager; } + public synchronized MembersOrderPreferenceCache getMemberOrderPreferenceCache() { if (fMembersOrderPreferenceCache == null) fMembersOrderPreferenceCache = new MembersOrderPreferenceCache(); return fMembersOrderPreferenceCache; } + + /** + * Returns the mockup preference store for firing events and registering + * listeners on project setting changes. Temporary solution. + */ + public MockupPreferenceStore getMockupPreferenceStore() { + if (fMockupPreferenceStore == null) + fMockupPreferenceStore = new MockupPreferenceStore(); + + return fMockupPreferenceStore; + } + public synchronized ProblemMarkerManager getProblemMarkerManager() { if (fProblemMarkerManager == null) fProblemMarkerManager = new ProblemMarkerManager(); return fProblemMarkerManager; } + + // public synchronized JavaTextTools getJavaTextTools() { + // if (fJavaTextTools == null) + // fJavaTextTools = new JavaTextTools(getPreferenceStore()); + // return fJavaTextTools; + // } public synchronized JavaTextTools getJavaTextTools() { if (fJavaTextTools == null) - fJavaTextTools = new JavaTextTools(getPreferenceStore()); + fJavaTextTools = new JavaTextTools(getPreferenceStore(), JavaCore + .getPlugin().getPluginPreferences()); return fJavaTextTools; } + public IFile getLastEditorFile() { return fLastEditorFile; } + /** * Returns the string from the plugin's resource bundle, or 'key' if not * found. @@ -404,28 +691,40 @@ public class PHPeclipsePlugin extends AbstractUIPlugin // } protected void initializeDefaultPreferences(IPreferenceStore store) { // windows preferences: - store.setDefault(LOCALHOST_PREF, "http://localhost"); - store.setDefault(SHOW_EXTERNAL_PREVIEW_PREF, "true"); + // store.setDefault(LOCALHOST_PREF, "http://localhost"); + // store.setDefault(DOCUMENTROOT_PREF, + // getWorkspace().getRoot().getLocation().toString()); +// store.setDefault(PHP_LOCALHOST_PREF, "http://localhost"); +// store.setDefault(PHP_DOCUMENTROOT_PREF, getWorkspace().getRoot() +// .getLocation().toString()); + + // store.setDefault(SHOW_EXTERNAL_PREVIEW_PREF, "true"); store.setDefault(USE_EXTERNAL_BROWSER_PREF, "false"); store.setDefault(SHOW_OUTPUT_IN_CONSOLE, "true"); - String windowsSystem = BootLoader.getWS(); + store.setDefault(PHP_OBFUSCATOR_DEFAULT, "c:\\temp"); +// store.setDefault(PHP_BOOKMARK_DEFAULT, ""); +// +// store.setDefault(PHP_AUTO_PREVIEW_DEFAULT, "true"); +// store.setDefault(PHP_BRING_TO_TOP_PREVIEW_DEFAULT, "true"); +// store.setDefault(PHP_SHOW_HTML_FILES_LOCAL, "true"); + + String windowsSystem = Platform.getWS(); if (jvm == WINDOWS_9x) { store.setDefault(EXTERNAL_BROWSER_PREF, "command.com /c start iexplore {0}"); - } else if (windowsSystem.equals(BootLoader.WS_WIN32)) { + } else if (windowsSystem.equals(Platform.WS_WIN32)) { store.setDefault(EXTERNAL_BROWSER_PREF, "rundll32 url.dll,FileProtocolHandler {0}"); - } else if (windowsSystem.equals(BootLoader.WS_CARBON)) { + } else if (windowsSystem.equals(Platform.WS_CARBON)) { // TODO How do we start Safari on Mac OS X ? store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}"); } else { + store.setDefault(PHP_OBFUSCATOR_DEFAULT, "/tmp"); store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}"); } - store.setDefault(DOCUMENTROOT_PREF, getWorkspace().getRoot().getLocation() - .toString()); // if ((jvm == WINDOWS_9x) || (jvm == WINDOWS_NT)) { // - if (windowsSystem.equals(BootLoader.WS_WIN32)) { + if (windowsSystem.equals(Platform.WS_WIN32)) { store.setDefault(PHP_RUN_PREF, "c:\\apache\\php\\php.exe"); store.setDefault(EXTERNAL_PARSER_PREF, "c:\\apache\\php\\php -l -f {0}"); store.setDefault(MYSQL_RUN_PREF, "c:\\apache\\mysql\\bin\\mysqld-nt.exe"); @@ -444,9 +743,9 @@ public class PHPeclipsePlugin extends AbstractUIPlugin store.setDefault(APACHE_START_BACKGROUND, "true"); store.setDefault(APACHE_STOP_BACKGROUND, "true"); store.setDefault(APACHE_RESTART_BACKGROUND, "true"); - store.setDefault(PHP_PARSER_DEFAULT, PHP_EXTERNAL_PARSER); - store.setDefault(PHP_INTERNAL_PARSER, "false"); - store.setDefault(PHP_EXTERNAL_PARSER, "true"); + // store.setDefault(PHP_PARSER_DEFAULT, PHP_EXTERNAL_PARSER); + // store.setDefault(PHP_INTERNAL_PARSER, "false"); + // store.setDefault(PHP_EXTERNAL_PARSER, "true"); // store.setDefault(PHP_PARSE_ON_SAVE, "true"); // show line numbers: // store.setDefault(LINE_NUMBER_RULER, "false"); @@ -479,6 +778,17 @@ public class PHPeclipsePlugin extends AbstractUIPlugin PHPColorProvider.PHPDOC_LINK); PreferenceConverter.setDefault(store, PHPDOC_DEFAULT, PHPColorProvider.PHPDOC_DEFAULT); + + PreferenceConverter.setDefault(store, EDITOR_PHP_KEYWORD_RETURN_COLOR, + new RGB(127, 0, 85)); + store.setDefault(EDITOR_PHP_KEYWORD_RETURN_BOLD, true); + store.setDefault(EDITOR_PHP_KEYWORD_RETURN_ITALIC, false); + + PreferenceConverter.setDefault(store, EDITOR_PHP_OPERATOR_COLOR, new RGB(0, + 0, 0)); + store.setDefault(EDITOR_PHP_OPERATOR_BOLD, false); + store.setDefault(EDITOR_PHP_OPERATOR_ITALIC, false); + // PreferenceConverter.setDefault( // store, // PHP_EDITOR_BACKGROUND, @@ -519,27 +829,28 @@ public class PHPeclipsePlugin extends AbstractUIPlugin // store.setDefault(RESOURCE_BUNDLE_DE, "false"); // store.setDefault(RESOURCE_BUNDLE_FR, "false"); // store.setDefault(RESOURCE_BUNDLE_ES, "false"); - store.setDefault(PHP_OUTLINE_CLASS, "true"); //$NON-NLS-1$ - store.setDefault(PHP_OUTLINE_FUNC, "true"); //$NON-NLS-1$ - store.setDefault(PHP_OUTLINE_VAR, "true"); //$NON-NLS-1$ - TemplatePreferencePage.initDefaults(store); +// TemplatePreferencePage.initDefaults(store); //this will initialize the static fields in the syntaxrdr class new PHPSyntaxRdr(); JavaCore.initializeDefaultPluginPreferences(); PreferenceConstants.initializeDefaultValues(store); externalTools.initializeDefaultPreferences(store); + MarkerAnnotationPreferences.initializeDefaultValues(store); } + private IWorkbenchPage internalGetActivePage() { IWorkbenchWindow window = getWorkbench().getActiveWorkbenchWindow(); if (window != null) return window.getActivePage(); return null; } + private ImageDescriptorRegistry internalGetImageDescriptorRegistry() { if (fImageDescriptorRegistry == null) fImageDescriptorRegistry = new ImageDescriptorRegistry(); return fImageDescriptorRegistry; } + /** * Open a file in the Workbench that may or may not exist in the workspace. * Must be run on the UI thread. @@ -570,7 +881,8 @@ public class PHPeclipsePlugin extends AbstractUIPlugin IEditorRegistry registry = getWorkbench().getEditorRegistry(); IEditorDescriptor desc = registry.getDefaultEditor(filename); if (desc == null) { - desc = registry.getDefaultEditor(); + desc = registry.findEditor(IEditorRegistry.SYSTEM_EXTERNAL_EDITOR_ID); + // desc = registry.getDefaultEditor(); } IEditorInput input = new ExternalEditorInput(storage); editor = page.openEditor(input, desc.getId()); @@ -585,6 +897,7 @@ public class PHPeclipsePlugin extends AbstractUIPlugin } return textEditor; } + /** * Open a file in the Workbench that may or may not exist in the workspace. * Must be run on the UI thread. @@ -611,6 +924,7 @@ public class PHPeclipsePlugin extends AbstractUIPlugin } } } + /** * Open a file in the Workbench that may or may not exist in the workspace. * Must be run on the UI thread. @@ -631,6 +945,7 @@ public class PHPeclipsePlugin extends AbstractUIPlugin } } } + public void openFileAndFindString(String filename, String findString) throws CoreException { ITextEditor textEditor = openFileInTextEditor(filename); @@ -648,96 +963,607 @@ public class PHPeclipsePlugin extends AbstractUIPlugin } } } + public void setLastEditorFile(IFile textEditor) { this.fLastEditorFile = textEditor; } + + /* + * @see org.eclipse.core.runtime.Plugin#stop + */ + public void stop(BundleContext context) throws Exception { + try { + // JavaCore.stop(this, context); + plugin.savePluginPreferences(); + IWorkspace workspace = ResourcesPlugin.getWorkspace(); + workspace.removeResourceChangeListener(JavaModelManager + .getJavaModelManager().deltaState); + workspace.removeSaveParticipant(plugin); + + JavaModelManager.getJavaModelManager().shutdown(); + + ColorManager.getDefault().dispose(); + // save the information from the php index files if necessary + Collection collection = fIndexManagerMap.values(); + Iterator iterator = collection.iterator(); + IdentifierIndexManager indexManager = null; + while (iterator.hasNext()) { + indexManager = (IdentifierIndexManager) iterator.next(); + indexManager.writeFile(); + } + if (fImageDescriptorRegistry != null) + fImageDescriptorRegistry.dispose(); + + // AllTypesCache.terminate(); + + if (fImageDescriptorRegistry != null) + fImageDescriptorRegistry.dispose(); + + unregisterAdapters(); + + // if (fASTProvider != null) { + // fASTProvider.dispose(); + // fASTProvider= null; + // } + + if (fWorkingCopyManager != null) { + fWorkingCopyManager.shutdown(); + fWorkingCopyManager = null; + } + + if (fCompilationUnitDocumentProvider != null) { + fCompilationUnitDocumentProvider.shutdown(); + fCompilationUnitDocumentProvider = null; + } + + if (fJavaTextTools != null) { + fJavaTextTools.dispose(); + fJavaTextTools = null; + } + // JavaDocLocations.shutdownJavadocLocations(); + + uninstallPreferenceStoreBackwardsCompatibility(); + + // RefactoringCore.getUndoManager().shutdown(); + } finally { + super.stop(context); + } + } + /** * @see org.eclipse.ui.plugin.AbstractUIPlugin#shutdown() */ - public void shutdown() throws CoreException { - // moved down (see below): - // super.shutdown(); - // externalTools.shutDown(); - ColorManager.getDefault().dispose(); - // save the information from the php index files if necessary - Collection collection = fIndexManagerMap.values(); - Iterator iterator = collection.iterator(); - IdentifierIndexManager indexManager = null; - while (iterator.hasNext()) { - indexManager = (IdentifierIndexManager) iterator.next(); - indexManager.writeFile(); - } - if (fImageDescriptorRegistry != null) - fImageDescriptorRegistry.dispose(); - // unregisterAdapters(); - super.shutdown(); - if (fWorkingCopyManager != null) { - fWorkingCopyManager.shutdown(); - fWorkingCopyManager = null; - } - if (fCompilationUnitDocumentProvider != null) { - fCompilationUnitDocumentProvider.shutdown(); - fCompilationUnitDocumentProvider = null; + // public void shutdown() throws CoreException { + // // moved down (see below): + // // super.shutdown(); + // // externalTools.shutDown(); + // ColorManager.getDefault().dispose(); + // // save the information from the php index files if necessary + // Collection collection = fIndexManagerMap.values(); + // Iterator iterator = collection.iterator(); + // IdentifierIndexManager indexManager = null; + // while (iterator.hasNext()) { + // indexManager = (IdentifierIndexManager) iterator.next(); + // indexManager.writeFile(); + // } + // if (fImageDescriptorRegistry != null) + // fImageDescriptorRegistry.dispose(); + // // unregisterAdapters(); + // super.shutdown(); + // if (fWorkingCopyManager != null) { + // fWorkingCopyManager.shutdown(); + // fWorkingCopyManager = null; + // } + // if (fCompilationUnitDocumentProvider != null) { + // fCompilationUnitDocumentProvider.shutdown(); + // fCompilationUnitDocumentProvider = null; + // } + // if (fJavaTextTools != null) { + // fJavaTextTools.dispose(); + // fJavaTextTools = null; + // } + // // JavaDocLocations.shutdownJavadocLocations(); + // // + // // + // JFaceResources.getFontRegistry().removeListener(fFontPropertyChangeListener); + // // begin JavaCore#shutdown() + // //savePluginPreferences(); + // savePluginPreferences(); + // IWorkspace workspace = ResourcesPlugin.getWorkspace(); + // workspace.removeResourceChangeListener(JavaModelManager.getJavaModelManager().deltaState); + // workspace.removeSaveParticipant(this); + // ((JavaModelManager) JavaModelManager.getJavaModelManager()).shutdown(); + // // end JavaCore#shutdown() + // } + /** + * Installs backwards compatibility for the preference store. + */ + private void installPreferenceStoreBackwardsCompatibility() { + + /* + * Installs backwards compatibility: propagate the Java editor font from a + * pre-2.1 plug-in to the Platform UI's preference store to preserve the + * Java editor font from a pre-2.1 workspace. This is done only once. + */ + String fontPropagatedKey = "fontPropagated"; //$NON-NLS-1$ + if (getPreferenceStore().contains(JFaceResources.TEXT_FONT) + && !getPreferenceStore().isDefault(JFaceResources.TEXT_FONT)) { + if (!getPreferenceStore().getBoolean(fontPropagatedKey)) + PreferenceConverter.setValue(PlatformUI.getWorkbench() + .getPreferenceStore(), PreferenceConstants.EDITOR_TEXT_FONT, + PreferenceConverter.getFontDataArray(getPreferenceStore(), + JFaceResources.TEXT_FONT)); } - if (fJavaTextTools != null) { - fJavaTextTools.dispose(); - fJavaTextTools = null; + getPreferenceStore().setValue(fontPropagatedKey, true); + + /* + * Backwards compatibility: set the Java editor font in this plug-in's + * preference store to let older versions access it. Since 2.1 the Java + * editor font is managed by the workbench font preference page. + */ + PreferenceConverter.putValue(getPreferenceStore(), + JFaceResources.TEXT_FONT, JFaceResources.getFontRegistry().getFontData( + PreferenceConstants.EDITOR_TEXT_FONT)); + + fFontPropertyChangeListener = new IPropertyChangeListener() { + public void propertyChange(PropertyChangeEvent event) { + if (PreferenceConstants.EDITOR_TEXT_FONT.equals(event.getProperty())) + PreferenceConverter.putValue(getPreferenceStore(), + JFaceResources.TEXT_FONT, JFaceResources.getFontRegistry() + .getFontData(PreferenceConstants.EDITOR_TEXT_FONT)); + } + }; + JFaceResources.getFontRegistry().addListener(fFontPropertyChangeListener); + + /* + * Backwards compatibility: propagate the Java editor tab width from a + * pre-3.0 plug-in to the new preference key. This is done only once. + */ + final String oldTabWidthKey = PreferenceConstants.EDITOR_TAB_WIDTH; + final String newTabWidthKey = AbstractDecoratedTextEditorPreferenceConstants.EDITOR_TAB_WIDTH; + String tabWidthPropagatedKey = "tabWidthPropagated"; //$NON-NLS-1$ + if (getPreferenceStore().contains(oldTabWidthKey) + && !getPreferenceStore().isDefault(oldTabWidthKey)) { + if (!getPreferenceStore().getBoolean(tabWidthPropagatedKey)) + getPreferenceStore().setValue(newTabWidthKey, + getPreferenceStore().getInt(oldTabWidthKey)); } - // JavaDocLocations.shutdownJavadocLocations(); - // - // JFaceResources.getFontRegistry().removeListener(fFontPropertyChangeListener); - // begin JavaCore#shutdown() - //savePluginPreferences(); - savePluginPreferences(); - IWorkspace workspace = ResourcesPlugin.getWorkspace(); - workspace.removeResourceChangeListener(JavaModelManager - .getJavaModelManager().deltaProcessor); - workspace.removeSaveParticipant(PHPeclipsePlugin.getDefault()); - ((JavaModelManager) JavaModelManager.getJavaModelManager()).shutdown(); - // end JavaCore#shutdown() - } - public void startup() throws CoreException { - super.startup(); - // begin JavaCore.startup(); - JavaModelManager manager = JavaModelManager.getJavaModelManager(); + getPreferenceStore().setValue(tabWidthPropagatedKey, true); + + /* + * Backwards compatibility: set the Java editor tab width in this plug-in's + * preference store with the old key to let older versions access it. Since + * 3.0 the tab width is managed by the extended texteditor and uses a new + * key. + */ + getPreferenceStore().putValue(oldTabWidthKey, + getPreferenceStore().getString(newTabWidthKey)); + + fPropertyChangeListener = new IPropertyChangeListener() { + public void propertyChange(PropertyChangeEvent event) { + if (newTabWidthKey.equals(event.getProperty())) + getPreferenceStore().putValue(oldTabWidthKey, + getPreferenceStore().getString(newTabWidthKey)); + } + }; + getPreferenceStore().addPropertyChangeListener(fPropertyChangeListener); + + /* + * Backward compatibility for the refactoring preference key. + */ + // getPreferenceStore().setValue( + // PreferenceConstants.REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD, + // RefactoringCore.getConditionCheckingFailedSeverity()); + } + + /** + * Uninstalls backwards compatibility for the preference store. + */ + private void uninstallPreferenceStoreBackwardsCompatibility() { + JFaceResources.getFontRegistry() + .removeListener(fFontPropertyChangeListener); + getPreferenceStore().removePropertyChangeListener(fPropertyChangeListener); + } + + /* + * (non - Javadoc) Method declared in Plugin + */ + public void start(BundleContext context) throws Exception { + super.start(context); + + // JavaCore.start(this, context); + final JavaModelManager manager = JavaModelManager.getJavaModelManager(); try { manager.configurePluginDebugOptions(); + // request state folder creation (workaround 19885) - // JavaCore.getPlugin().getStateLocation(); + // JavaCore.getPlugin().getStateLocation(); getStateLocation(); // retrieve variable values - // JavaCore.getPlugin().getPluginPreferences().addPropertyChangeListener(new + //JavaCore.getPlugin().getPluginPreferences().addPropertyChangeListener(new // JavaModelManager.PluginPreferencesListener()); - getPluginPreferences().addPropertyChangeListener( - new JavaModelManager.PluginPreferencesListener()); - // TODO khartlage temp-del - // manager.loadVariablesAndContainers(); - IWorkspace workspace = ResourcesPlugin.getWorkspace(); - workspace.addResourceChangeListener(manager.deltaProcessor, - IResourceChangeEvent.PRE_AUTO_BUILD - | IResourceChangeEvent.POST_AUTO_BUILD - | IResourceChangeEvent.POST_CHANGE - | IResourceChangeEvent.PRE_DELETE - | IResourceChangeEvent.PRE_CLOSE); - // startIndexing(); - workspace.addSaveParticipant(PHPeclipsePlugin.getDefault(), manager); - } catch (CoreException e) { + // manager.loadVariablesAndContainers(); + + final IWorkspace workspace = ResourcesPlugin.getWorkspace(); + workspace.addResourceChangeListener( + manager.deltaState, + IResourceChangeEvent.PRE_BUILD + | IResourceChangeEvent.POST_BUILD + | IResourceChangeEvent.POST_CHANGE + | IResourceChangeEvent.PRE_DELETE + | IResourceChangeEvent.PRE_CLOSE); + +// startIndexing(); + ISavedState savedState = workspace.addSaveParticipant(PHPeclipsePlugin.this, manager); + + // process deltas since last activated in indexer thread so that indexes are up-to-date. + // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=38658 +// Job processSavedState = new Job(Util.bind("savedState.jobName")) { //$NON-NLS-1$ +// protected IStatus run(IProgressMonitor monitor) { +// try { +// // add save participant and process delta atomically +// // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=59937 +// workspace.run( +// new IWorkspaceRunnable() { +// public void run(IProgressMonitor progress) throws CoreException { +// ISavedState savedState = workspace.addSaveParticipant(PHPeclipsePlugin.this, manager); +// if (savedState != null) { +// // the event type coming from the saved state is always POST_AUTO_BUILD +// // force it to be POST_CHANGE so that the delta processor can handle it +// manager.deltaState.getDeltaProcessor().overridenEventType = IResourceChangeEvent.POST_CHANGE; +// savedState.processResourceChangeEvents(manager.deltaState); +// } +// } +// }, +// monitor); +// } catch (CoreException e) { +// return e.getStatus(); +// } +// return Status.OK_STATUS; +// } +// }; +// processSavedState.setSystem(true); +// processSavedState.setPriority(Job.SHORT); // process asap +// processSavedState.schedule(); } catch (RuntimeException e) { manager.shutdown(); throw e; } - // end JavaCore.startup(); - IAdapterManager platformManager = Platform.getAdapterManager(); - platformManager.registerAdapters(new PHPElementAdapterFactory(), - PHPElement.class); - platformManager.registerAdapters(new ResourceAdapterFactory(), - IResource.class); - // externalTools.startUp(); - getStandardDisplay().asyncExec(new Runnable() { - public void run() { - //initialize the variable context manager - VariableContextManager.getDefault(); + + registerAdapters(); + + // if (USE_WORKING_COPY_OWNERS) { + WorkingCopyOwner.setPrimaryBufferProvider(new WorkingCopyOwner() { + public IBuffer createBuffer(ICompilationUnit workingCopy) { + ICompilationUnit original = workingCopy.getPrimary(); + IResource resource = original.getResource(); + if (resource instanceof IFile) + return new DocumentAdapter(workingCopy, (IFile) resource); + return DocumentAdapter.NULL; } }); + // } + + installPreferenceStoreBackwardsCompatibility(); + + } + + // registerAdapters(); + // + // // externalTools.startUp(); + // getStandardDisplay().asyncExec(new Runnable() { + // public void run() { + // //initialize the variable context manager + // VariableContextManager.getDefault(); + // } + // }); + // + // // if (USE_WORKING_COPY_OWNERS) { + // WorkingCopyOwner.setPrimaryBufferProvider(new WorkingCopyOwner() { + // public IBuffer createBuffer(ICompilationUnit workingCopy) { + // ICompilationUnit original = workingCopy.getPrimary(); + // IResource resource = original.getResource(); + // if (resource instanceof IFile) + // return new DocumentAdapter(workingCopy, (IFile) resource); + // return DocumentAdapter.NULL; + // } + // }); + // // } + + // installPreferenceStoreBackwardsCompatibility(); + + // AllTypesCache.initialize(); + + // Initialize AST provider + // getASTProvider(); + // } + + // public void startup() throws CoreException { + // super.startup(); + // // begin JavaCore.startup(); + // JavaModelManager manager = JavaModelManager.getJavaModelManager(); + // try { + // manager.configurePluginDebugOptions(); + // // request state folder creation (workaround 19885) + // // JavaCore.getPlugin().getStateLocation(); + // getStateLocation(); + // // retrieve variable values + // // + // JavaCore.getPlugin().getPluginPreferences().addPropertyChangeListener(new + // // JavaModelManager.PluginPreferencesListener()); + // getPluginPreferences().addPropertyChangeListener( + // new JavaModelManager.PluginPreferencesListener()); + // // TODO khartlage temp-del + // // manager.loadVariablesAndContainers(); + // final IWorkspace workspace = ResourcesPlugin.getWorkspace(); + // workspace.addResourceChangeListener( + // manager.deltaState, + // IResourceChangeEvent.PRE_BUILD + // | IResourceChangeEvent.POST_BUILD + // | IResourceChangeEvent.POST_CHANGE + // | IResourceChangeEvent.PRE_DELETE + // | IResourceChangeEvent.PRE_CLOSE); + // // startIndexing(); + // workspace.addSaveParticipant(PHPeclipsePlugin.getDefault(), manager); + // } catch (CoreException e) { + // } catch (RuntimeException e) { + // manager.shutdown(); + // throw e; + // } + // // end JavaCore.startup(); + // IAdapterManager platformManager = Platform.getAdapterManager(); + // platformManager.registerAdapters(new PHPElementAdapterFactory(), + // PHPElement.class); + // platformManager.registerAdapters(new ResourceAdapterFactory(), + // IResource.class); + // // externalTools.startUp(); + // getStandardDisplay().asyncExec(new Runnable() { + // public void run() { + // //initialize the variable context manager + // VariableContextManager.getDefault(); + // } + // }); + // } + + private void registerAdapters() { + fJavaElementAdapterFactory = new JavaElementAdapterFactory(); + // fMarkerAdapterFactory= new MarkerAdapterFactory(); + // fEditorInputAdapterFactory= new EditorInputAdapterFactory(); + fResourceAdapterFactory = new ResourceAdapterFactory(); + // fLogicalPackageAdapterFactory= new LogicalPackageAdapterFactory(); + + IAdapterManager manager = Platform.getAdapterManager(); + manager.registerAdapters(fJavaElementAdapterFactory, IJavaElement.class); + // manager.registerAdapters(fMarkerAdapterFactory, IMarker.class); + // manager.registerAdapters(fEditorInputAdapterFactory, IEditorInput.class); + manager.registerAdapters(fResourceAdapterFactory, IResource.class); + // manager.registerAdapters(fLogicalPackageAdapterFactory, + // LogicalPackage.class); + } + + private void unregisterAdapters() { + IAdapterManager manager = Platform.getAdapterManager(); + manager.unregisterAdapters(fJavaElementAdapterFactory); + // manager.unregisterAdapters(fMarkerAdapterFactory); + // manager.unregisterAdapters(fEditorInputAdapterFactory); + manager.unregisterAdapters(fResourceAdapterFactory); + // manager.unregisterAdapters(fLogicalPackageAdapterFactory); } + + /** + * Returns a combined preference store, this store is read-only. + * + * @return the combined preference store + * + * @since 3.0 + */ + public IPreferenceStore getCombinedPreferenceStore() { + if (fCombinedPreferenceStore == null) { + IPreferenceStore generalTextStore = EditorsUI.getPreferenceStore(); + fCombinedPreferenceStore = new ChainedPreferenceStore( + new IPreferenceStore[] { + getPreferenceStore(), + new PreferencesAdapter(PHPeclipsePlugin.getDefault() + .getPluginPreferences()), generalTextStore }); + } + return fCombinedPreferenceStore; + } + + public synchronized IBufferFactory getBufferFactory() { + if (fBufferFactory == null) + fBufferFactory = new CustomBufferFactory(); + return fBufferFactory; + } + + /** + * Returns the registry of the extensions to the + * net.sourceforge.phpdt.ui.javaFoldingStructureProvider extension + * point. + * + * @return the registry of contributed + * IJavaFoldingStructureProvider + * @since 3.0 + */ + public synchronized JavaFoldingStructureProviderRegistry getFoldingStructureProviderRegistry() { + if (fFoldingStructureProviderRegistry == null) + fFoldingStructureProviderRegistry = new JavaFoldingStructureProviderRegistry(); + return fFoldingStructureProviderRegistry; + } + + /** + * Runs the given action as an atomic Java model operation. + *

+ * After running a method that modifies java elements, registered listeners + * receive after-the-fact notification of what just transpired, in the form of + * a element changed event. This method allows clients to call a number of + * methods that modify java elements and only have element changed event + * notifications reported at the end of the entire batch. + *

+ *

+ * If this method is called outside the dynamic scope of another such call, + * this method runs the action and then reports a single element changed event + * describing the net effect of all changes done to java elements by the + * action. + *

+ *

+ * If this method is called in the dynamic scope of another such call, this + * method simply runs the action. + *

+ * + * @param action + * the action to perform + * @param monitor + * a progress monitor, or null if progress reporting + * and cancellation are not desired + * @exception CoreException + * if the operation failed. + * @since 2.1 + */ + public static void run(IWorkspaceRunnable action, IProgressMonitor monitor) + throws CoreException { + run(action, ResourcesPlugin.getWorkspace().getRoot(), monitor); + } + + /** + * Runs the given action as an atomic Java model operation. + *

+ * After running a method that modifies java elements, registered listeners + * receive after-the-fact notification of what just transpired, in the form of + * a element changed event. This method allows clients to call a number of + * methods that modify java elements and only have element changed event + * notifications reported at the end of the entire batch. + *

+ *

+ * If this method is called outside the dynamic scope of another such call, + * this method runs the action and then reports a single element changed event + * describing the net effect of all changes done to java elements by the + * action. + *

+ *

+ * If this method is called in the dynamic scope of another such call, this + * method simply runs the action. + *

+ *

+ * The supplied scheduling rule is used to determine whether this operation + * can be run simultaneously with workspace changes in other threads. See + * IWorkspace.run(...) for more details. + *

+ * + * @param action + * the action to perform + * @param rule + * the scheduling rule to use when running this operation, or + * null if there are no scheduling restrictions for + * this operation. + * @param monitor + * a progress monitor, or null if progress reporting + * and cancellation are not desired + * @exception CoreException + * if the operation failed. + * @since 3.0 + */ + public static void run(IWorkspaceRunnable action, ISchedulingRule rule, + IProgressMonitor monitor) throws CoreException { + IWorkspace workspace = ResourcesPlugin.getWorkspace(); + if (workspace.isTreeLocked()) { + new BatchOperation(action).run(monitor); + } else { + // use IWorkspace.run(...) to ensure that a build will be done in + // autobuild mode + workspace.run(new BatchOperation(action), rule, IWorkspace.AVOID_UPDATE, + monitor); + } + } + + /** + * Returns the template context type registry for the java plugin. + * + * @return the template context type registry for the java plugin + * @since 3.0 + */ + public ContextTypeRegistry getTemplateContextRegistry() { + if (fContextTypeRegistry == null) { + fContextTypeRegistry= new ContributionContextTypeRegistry(); + + fContextTypeRegistry.addContextType(new JavaContextType()); + fContextTypeRegistry.addContextType(new JavaDocContextType()); + fContextTypeRegistry.addContextType(new HTMLContextType()); + } + + return fContextTypeRegistry; + } + + /** + * Returns the template store for the java editor templates. + * + * @return the template store for the java editor templates + * @since 3.0 + */ + public TemplateStore getTemplateStore() { + if (fTemplateStore == null) { +// boolean alreadyMigrated= getPreferenceStore().getBoolean(TEMPLATES_MIGRATION_KEY); +// if (alreadyMigrated) + fTemplateStore= new ContributionTemplateStore(getTemplateContextRegistry(), getPreferenceStore(), TEMPLATES_KEY); +// else { +// fTemplateStore= new CompatibilityTemplateStore(getTemplateContextRegistry(), getPreferenceStore(), TEMPLATES_KEY, Templates.getInstance()); +// getPreferenceStore().setValue(TEMPLATES_MIGRATION_KEY, true); +// } + + try { + fTemplateStore.load(); + } catch (IOException e) { + log(e); + } + } + + return fTemplateStore; + } + + /** + * Returns the template context type registry for the code generation + * templates. + * + * @return the template context type registry for the code generation + * templates + * @since 3.0 + */ + public ContextTypeRegistry getCodeTemplateContextRegistry() { + if (fCodeTemplateContextTypeRegistry == null) { + fCodeTemplateContextTypeRegistry= new ContributionContextTypeRegistry(); + + CodeTemplateContextType.registerContextTypes(fCodeTemplateContextTypeRegistry); + } + + return fCodeTemplateContextTypeRegistry; + } + + /** + * Returns the template store for the code generation templates. + * + * @return the template store for the code generation templates + * @since 3.0 + */ + public TemplateStore getCodeTemplateStore() { + if (fCodeTemplateStore == null) { +// boolean alreadyMigrated= getPreferenceStore().getBoolean(CODE_TEMPLATES_MIGRATION_KEY); +// if (alreadyMigrated) + fCodeTemplateStore= new ContributionTemplateStore(getCodeTemplateContextRegistry(), getPreferenceStore(), CODE_TEMPLATES_KEY); +// else { +// fCodeTemplateStore= new CompatibilityTemplateStore(getCodeTemplateContextRegistry(), getPreferenceStore(), CODE_TEMPLATES_KEY, CodeTemplates.getInstance()); +// getPreferenceStore().setValue(CODE_TEMPLATES_MIGRATION_KEY, true); +// } + + try { + fCodeTemplateStore.load(); + } catch (IOException e) { + log(e); + } + + // compatibility / bug fixing code for duplicated templates + // TODO remove for 3.0 +// CompatibilityTemplateStore.pruneDuplicates(fCodeTemplateStore, true); + } + + return fCodeTemplateStore; + } } \ No newline at end of file