1 /**********************************************************************
2 Copyright (c) 2000, 2002 IBM Corp. and others.
3 All rights reserved. This program and the accompanying materials
4 are made available under the terms of the Common Public License v1.0
5 which accompanies this distribution, and is available at
6 http://www.eclipse.org/legal/cpl-v10.html
8 **********************************************************************/
9 package net.sourceforge.phpeclipse;
12 import java.io.IOException;
13 import java.io.InputStream;
14 import java.util.ArrayList;
15 import java.util.Collection;
16 import java.util.Enumeration;
17 import java.util.HashMap;
18 import java.util.HashSet;
19 import java.util.Iterator;
20 import java.util.List;
21 import java.util.PropertyResourceBundle;
24 import net.sourceforge.phpdt.core.IBuffer;
25 import net.sourceforge.phpdt.core.IBufferFactory;
26 import net.sourceforge.phpdt.core.ICompilationUnit;
27 import net.sourceforge.phpdt.core.IJavaElement;
28 import net.sourceforge.phpdt.core.JavaCore;
29 import net.sourceforge.phpdt.core.WorkingCopyOwner;
30 import net.sourceforge.phpdt.externaltools.internal.model.ColorManager;
31 import net.sourceforge.phpdt.internal.core.BatchOperation;
32 import net.sourceforge.phpdt.internal.core.JavaModelManager;
33 import net.sourceforge.phpdt.internal.core.util.Util;
34 import net.sourceforge.phpdt.internal.corext.template.php.CodeTemplateContextType;
35 import net.sourceforge.phpdt.internal.corext.template.php.HTMLContextType;
36 import net.sourceforge.phpdt.internal.corext.template.php.JavaContextType;
37 import net.sourceforge.phpdt.internal.corext.template.php.JavaDocContextType;
38 import net.sourceforge.phpdt.internal.ui.IJavaStatusConstants;
39 import net.sourceforge.phpdt.internal.ui.JavaElementAdapterFactory;
40 import net.sourceforge.phpdt.internal.ui.ResourceAdapterFactory;
41 import net.sourceforge.phpdt.internal.ui.preferences.MembersOrderPreferenceCache;
42 import net.sourceforge.phpdt.internal.ui.preferences.MockupPreferenceStore;
43 import net.sourceforge.phpdt.internal.ui.text.PreferencesAdapter;
44 import net.sourceforge.phpdt.internal.ui.text.folding.JavaFoldingStructureProviderRegistry;
45 import net.sourceforge.phpdt.internal.ui.text.java.hover.JavaEditorTextHoverDescriptor;
46 import net.sourceforge.phpdt.internal.ui.viewsupport.ImageDescriptorRegistry;
47 import net.sourceforge.phpdt.internal.ui.viewsupport.ProblemMarkerManager;
48 import net.sourceforge.phpdt.ui.IContextMenuConstants;
49 import net.sourceforge.phpdt.ui.IWorkingCopyManager;
50 import net.sourceforge.phpdt.ui.PreferenceConstants;
51 import net.sourceforge.phpdt.ui.text.JavaTextTools;
52 import net.sourceforge.phpeclipse.builder.ExternalEditorInput;
53 import net.sourceforge.phpeclipse.builder.ExternalStorageDocumentProvider;
54 import net.sourceforge.phpeclipse.builder.FileStorage;
55 import net.sourceforge.phpeclipse.builder.IdentifierIndexManager;
56 import net.sourceforge.phpeclipse.phpeditor.CustomBufferFactory;
57 import net.sourceforge.phpeclipse.phpeditor.DocumentAdapter;
58 import net.sourceforge.phpeclipse.phpeditor.ICompilationUnitDocumentProvider;
59 import net.sourceforge.phpeclipse.phpeditor.PHPDocumentProvider;
60 import net.sourceforge.phpeclipse.phpeditor.PHPSyntaxRdr;
61 import net.sourceforge.phpeclipse.phpeditor.WorkingCopyManager;
62 import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
64 import org.eclipse.core.resources.IFile;
65 import org.eclipse.core.resources.IProject;
66 import org.eclipse.core.resources.IResource;
67 import org.eclipse.core.resources.IResourceChangeEvent;
68 import org.eclipse.core.resources.ISavedState;
69 import org.eclipse.core.resources.IWorkspace;
70 import org.eclipse.core.resources.IWorkspaceRunnable;
71 import org.eclipse.core.resources.ResourcesPlugin;
72 import org.eclipse.core.runtime.CoreException;
73 import org.eclipse.core.runtime.IAdapterManager;
74 import org.eclipse.core.runtime.IConfigurationElement;
75 import org.eclipse.core.runtime.IPath;
76 import org.eclipse.core.runtime.IPluginDescriptor;
77 import org.eclipse.core.runtime.IProgressMonitor;
78 import org.eclipse.core.runtime.IStatus;
79 import org.eclipse.core.runtime.Path;
80 import org.eclipse.core.runtime.Platform;
81 import org.eclipse.core.runtime.Status;
82 import org.eclipse.core.runtime.jobs.ISchedulingRule;
83 import org.eclipse.core.runtime.jobs.Job;
84 import org.eclipse.jface.action.GroupMarker;
85 import org.eclipse.jface.action.IMenuManager;
86 import org.eclipse.jface.action.Separator;
87 import org.eclipse.jface.preference.IPreferenceStore;
88 import org.eclipse.jface.preference.PreferenceConverter;
89 import org.eclipse.jface.resource.JFaceResources;
90 import org.eclipse.jface.text.BadLocationException;
91 import org.eclipse.jface.text.IDocument;
92 import org.eclipse.jface.text.templates.ContextTypeRegistry;
93 import org.eclipse.jface.text.templates.persistence.TemplateStore;
94 import org.eclipse.jface.util.IPropertyChangeListener;
95 import org.eclipse.jface.util.PropertyChangeEvent;
96 import org.eclipse.swt.graphics.RGB;
97 import org.eclipse.swt.widgets.Display;
98 import org.eclipse.swt.widgets.Shell;
99 import org.eclipse.ui.IEditorDescriptor;
100 import org.eclipse.ui.IEditorInput;
101 import org.eclipse.ui.IEditorPart;
102 import org.eclipse.ui.IEditorRegistry;
103 import org.eclipse.ui.IWorkbench;
104 import org.eclipse.ui.IWorkbenchPage;
105 import org.eclipse.ui.IWorkbenchWindow;
106 import org.eclipse.ui.PlatformUI;
107 import org.eclipse.ui.editors.text.EditorsUI;
108 import org.eclipse.ui.editors.text.templates.ContributionContextTypeRegistry;
109 import org.eclipse.ui.editors.text.templates.ContributionTemplateStore;
110 import org.eclipse.ui.ide.IDE;
111 import org.eclipse.ui.plugin.AbstractUIPlugin;
112 import org.eclipse.ui.texteditor.ChainedPreferenceStore;
113 import org.eclipse.ui.texteditor.ConfigurationElementSorter;
114 import org.eclipse.ui.texteditor.IDocumentProvider;
115 import org.eclipse.ui.texteditor.ITextEditor;
116 import org.eclipse.ui.texteditor.MarkerAnnotationPreferences;
117 import org.osgi.framework.BundleContext;
120 * The main plugin class to be used in the desktop.
122 public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceConstants {
124 * The id of the PHP plugin (value <code>"net.sourceforge.phpeclipse"</code>).
126 public static final String PLUGIN_ID = "net.sourceforge.phpeclipse"; //$NON-NLS-1$
127 public static final String ID_PERSPECTIVE = "net.sourceforge.phpeclipse.PHPPerspective"; //$NON-NLS-1$
132 * id of builder - matches plugin.xml (concatenate pluginid.builderid)
134 public static final String BUILDER_PARSER_ID = PLUGIN_ID + ".parserbuilder";
136 //public static final String BUILDER_INDEX_ID = PLUGIN_ID + ".indexbuilder";
137 /** General debug flag */
139 public static final boolean DEBUG = false;
142 * The maximum number of allowed proposals by category
144 public final static int MAX_PROPOSALS = 200;
147 * The key to store customized templates.
151 private static final String TEMPLATES_KEY = "net.sourceforge.phpdt.ui.text.custom_templates"; //$NON-NLS-1$
154 * The key to store customized code templates.
158 private static final String CODE_TEMPLATES_KEY = "net.sourceforge.phpdt.ui.text.custom_code_templates"; //$NON-NLS-1$
161 * The key to store whether the legacy templates have been migrated
165 // private static final String TEMPLATES_MIGRATION_KEY= "net.sourceforge.phpdt.ui.text.templates_migrated"; //$NON-NLS-1$
167 * The key to store whether the legacy code templates have been migrated
171 // private static final String CODE_TEMPLATES_MIGRATION_KEY= "net.sourceforge.phpdt.ui.text.code_templates_migrated";
173 // private static ExternalToolsPlugin externalTools;
176 * The Java virtual machine that we are running on.
178 // private static int jvm;
180 // private static final int MRJ_2_0 = 0;
182 // /** MRJ 2.1 or later */
183 // private static final int MRJ_2_1 = 1;
185 // /** Java on Mac OS X 10.0 (MRJ 3.0) */
186 // private static final int MRJ_3_0 = 3;
189 // private static final int MRJ_3_1 = 4;
191 // /** JVM constant for any other platform */
192 // private static final int OTHER = -1;
193 // public static final String PHP_RESOURCES_VIEW_ID = PLUGIN_ID +
194 // ".resourcesview.ViewPHPResources"; //$NON-NLS-1$
195 public static final String PHP_CODING_ACTION_SET_ID = PLUGIN_ID + ".ui.CodingActionSet"; //$NON-NLS-1$
197 public final static String PHP_NATURE_ID = PLUGIN_ID + ".phpnature";
199 public static final String PHPPARSER_ORIGINAL = "net.sourceforge.phpdt.internal.compiler.parser.Parser";
201 public static final String PHPPARSER_NEW = "test.PHPParser";
203 /** Change this if you want to switch PHP Parser. */
204 public static final String PHPPARSER = PHPPARSER_ORIGINAL;
206 //The shared instance.
207 private static PHPeclipsePlugin plugin;
210 * The template context type registry for the java editor.
214 private ContextTypeRegistry fContextTypeRegistry;
217 * The code template context type registry for the java editor.
221 private ContextTypeRegistry fCodeTemplateContextTypeRegistry;
224 * The template store for the java editor.
228 private TemplateStore fTemplateStore;
231 * The coded template store for the java editor.
235 private TemplateStore fCodeTemplateStore;
238 private static final int WINDOWS_9x = 6;
241 private static final int WINDOWS_NT = 5;
243 private ImageDescriptorRegistry fImageDescriptorRegistry;
245 private HashMap fIndexManagerMap = new HashMap();
247 private IWorkingCopyManager fWorkingCopyManager;
249 private IBufferFactory fBufferFactory;
251 private ICompilationUnitDocumentProvider fCompilationUnitDocumentProvider;
253 private JavaTextTools fJavaTextTools;
255 private ProblemMarkerManager fProblemMarkerManager;
257 private MembersOrderPreferenceCache fMembersOrderPreferenceCache;
259 private IFile fLastEditorFile = null;
261 private JavaEditorTextHoverDescriptor[] fJavaEditorTextHoverDescriptors;
263 private JavaElementAdapterFactory fJavaElementAdapterFactory;
265 // private MarkerAdapterFactory fMarkerAdapterFactory;
266 // private EditorInputAdapterFactory fEditorInputAdapterFactory;
267 private ResourceAdapterFactory fResourceAdapterFactory;
269 // private LogicalPackageAdapterFactory fLogicalPackageAdapterFactory;
270 private IPropertyChangeListener fFontPropertyChangeListener;
273 * Property change listener on this plugin's preference store.
277 // private IPropertyChangeListener fPropertyChangeListener;
279 * The combined preference store.
283 private IPreferenceStore fCombinedPreferenceStore;
286 * The extension point registry for the <code>net.sourceforge.phpdt.ui.javaFoldingStructureProvider</code> extension point.
290 private JavaFoldingStructureProviderRegistry fFoldingStructureProviderRegistry;
293 * Mockup preference store for firing events and registering listeners on project setting changes. FIXME: Temporary solution.
297 private MockupPreferenceStore fMockupPreferenceStore;
302 public PHPeclipsePlugin(IPluginDescriptor descriptor) {
305 // externalTools = new ExternalToolsPlugin();
309 // ResourceBundle.getBundle("net.sourceforge.PHPeclipsePluginResources");
310 // } catch (MissingResourceException x) {
311 // resourceBundle = null;
316 // * Returns all Java editor text hovers contributed to the workbench.
318 // * @return an array of JavaEditorTextHoverDescriptor
321 // public JavaEditorTextHoverDescriptor[] getJavaEditorTextHoverDescriptors()
323 // if (fJavaEditorTextHoverDescriptors == null)
324 // fJavaEditorTextHoverDescriptors = JavaEditorTextHoverDescriptor
325 // .getContributedHovers();
326 // return fJavaEditorTextHoverDescriptors;
329 * Returns all Java editor text hovers contributed to the workbench.
331 * @return an array of JavaEditorTextHoverDescriptor
334 public JavaEditorTextHoverDescriptor[] getJavaEditorTextHoverDescriptors() {
335 if (fJavaEditorTextHoverDescriptors == null) {
336 fJavaEditorTextHoverDescriptors = JavaEditorTextHoverDescriptor.getContributedHovers();
337 ConfigurationElementSorter sorter = new ConfigurationElementSorter() {
339 * @see org.eclipse.ui.texteditor.ConfigurationElementSorter#getConfigurationElement(java.lang.Object)
341 public IConfigurationElement getConfigurationElement(Object object) {
342 return ((JavaEditorTextHoverDescriptor) object).getConfigurationElement();
345 sorter.sort(fJavaEditorTextHoverDescriptors);
347 // The Problem hover has to be the first and the Annotation hover has to
348 // be the last one in the JDT UI's hover list
349 int length = fJavaEditorTextHoverDescriptors.length;
351 int last = length - 1;
352 int problemHoverIndex = -1;
353 int annotationHoverIndex = -1;
354 for (int i = 0; i < length; i++) {
355 if (!fJavaEditorTextHoverDescriptors[i].getId().startsWith(PLUGIN_ID)) {
356 if (problemHoverIndex == -1 || annotationHoverIndex == -1)
366 if (fJavaEditorTextHoverDescriptors[i].getId().equals("net.sourceforge.phpdt.ui.AnnotationHover")) { //$NON-NLS-1$
367 annotationHoverIndex = i;
370 if (fJavaEditorTextHoverDescriptors[i].getId().equals("net.sourceforge.phpdt.ui.ProblemHover")) { //$NON-NLS-1$
371 problemHoverIndex = i;
376 JavaEditorTextHoverDescriptor hoverDescriptor = null;
378 if (first > -1 && problemHoverIndex > -1 && problemHoverIndex != first) {
379 // move problem hover to beginning
380 hoverDescriptor = fJavaEditorTextHoverDescriptors[first];
381 fJavaEditorTextHoverDescriptors[first] = fJavaEditorTextHoverDescriptors[problemHoverIndex];
382 fJavaEditorTextHoverDescriptors[problemHoverIndex] = hoverDescriptor;
384 // update annotation hover index if needed
385 if (annotationHoverIndex == first)
386 annotationHoverIndex = problemHoverIndex;
389 if (annotationHoverIndex > -1 && annotationHoverIndex != last) {
390 // move annotation hover to end
391 hoverDescriptor = fJavaEditorTextHoverDescriptors[last];
392 fJavaEditorTextHoverDescriptors[last] = fJavaEditorTextHoverDescriptors[annotationHoverIndex];
393 fJavaEditorTextHoverDescriptors[annotationHoverIndex] = hoverDescriptor;
396 // Move Best Match hover to front
397 for (int i = 0; i < fJavaEditorTextHoverDescriptors.length - 1; i++) {
398 if (PreferenceConstants.ID_BESTMATCH_HOVER.equals(fJavaEditorTextHoverDescriptors[i].getId())) {
399 hoverDescriptor = fJavaEditorTextHoverDescriptors[i];
400 for (int j = i; j > 0; j--)
401 fJavaEditorTextHoverDescriptors[j] = fJavaEditorTextHoverDescriptors[j - 1];
402 fJavaEditorTextHoverDescriptors[0] = hoverDescriptor;
409 return fJavaEditorTextHoverDescriptors;
413 * Resets the Java editor text hovers contributed to the workbench.
415 * This will force a rebuild of the descriptors the next time a client asks for them.
418 * @return an array of JavaEditorTextHoverDescriptor
421 public void resetJavaEditorTextHoverDescriptors() {
422 fJavaEditorTextHoverDescriptors = null;
426 * Creates the PHP plugin standard groups in a context menu.
428 public static void createStandardGroups(IMenuManager menu) {
431 menu.add(new Separator(IContextMenuConstants.GROUP_NEW));
432 menu.add(new GroupMarker(IContextMenuConstants.GROUP_GOTO));
433 menu.add(new Separator(IContextMenuConstants.GROUP_OPEN));
434 menu.add(new GroupMarker(IContextMenuConstants.GROUP_SHOW));
435 menu.add(new Separator(IContextMenuConstants.GROUP_REORGANIZE));
436 menu.add(new Separator(IContextMenuConstants.GROUP_GENERATE));
437 menu.add(new Separator(IContextMenuConstants.GROUP_SEARCH));
438 menu.add(new Separator(IContextMenuConstants.GROUP_BUILD));
439 menu.add(new Separator(IContextMenuConstants.GROUP_ADDITIONS));
440 menu.add(new Separator(IContextMenuConstants.GROUP_VIEWER_SETUP));
441 menu.add(new Separator(IContextMenuConstants.GROUP_PROPERTIES));
444 public static IWorkbenchPage getActivePage() {
445 return getDefault().internalGetActivePage();
448 public static Shell getActiveWorkbenchShell() {
449 return getActiveWorkbenchWindow().getShell();
453 * Returns an array of all editors that have an unsaved content. If the identical content is presented in more than one editor,
454 * only one of those editor parts is part of the result.
456 * @return an array of all dirty editor parts.
458 public static IEditorPart[] getDirtyEditors() {
459 Set inputs = new HashSet();
460 List result = new ArrayList(0);
461 IWorkbench workbench = getDefault().getWorkbench();
462 IWorkbenchWindow[] windows = workbench.getWorkbenchWindows();
463 for (int i = 0; i < windows.length; i++) {
464 IWorkbenchPage[] pages = windows[i].getPages();
465 for (int x = 0; x < pages.length; x++) {
466 IEditorPart[] editors = pages[x].getDirtyEditors();
467 for (int z = 0; z < editors.length; z++) {
468 IEditorPart ep = editors[z];
469 IEditorInput input = ep.getEditorInput();
470 if (!inputs.contains(input)) {
477 return (IEditorPart[]) result.toArray(new IEditorPart[result.size()]);
480 public static IWorkbenchWindow getActiveWorkbenchWindow() {
481 return getDefault().getWorkbench().getActiveWorkbenchWindow();
485 * Returns the shared instance.
487 public static PHPeclipsePlugin getDefault() {
491 public static ImageDescriptorRegistry getImageDescriptorRegistry() {
492 return getDefault().internalGetImageDescriptorRegistry();
495 static IPath getInstallLocation() {
496 return new Path(getDefault().getDescriptor().getInstallURL().getFile());
499 // public static int getJVM() {
503 public static String getPluginId() {
504 return getDefault().getDescriptor().getUniqueIdentifier();
508 * Returns the standard display to be used. The method first checks, if the thread calling this method has an associated display.
509 * If so, this display is returned. Otherwise the method returns the default display.
511 public static Display getStandardDisplay() {
512 Display display = Display.getCurrent();
513 if (display == null) {
514 display = Display.getDefault();
519 // public static ExternalToolsPlugin getExternalTools() {
520 // return externalTools;
523 * Returns the workspace instance.
525 public static IWorkspace getWorkspace() {
526 return ResourcesPlugin.getWorkspace();
529 public static boolean isDebug() {
530 return getDefault().isDebugging();
533 // public static void logErrorMessage(String message) {
534 // log(new Status(IStatus.ERROR, getPluginId(),
535 // JavaStatusConstants.INTERNAL_ERROR, message, null));
538 // public static void logErrorStatus(String message, IStatus status) {
539 // if (status == null) {
540 // logErrorMessage(message);
543 // MultiStatus multi= new MultiStatus(getPluginId(),
544 // JavaStatusConstants.INTERNAL_ERROR, message, null);
545 // multi.add(status);
549 // public static void log(Throwable e) {
550 // log(new Status(IStatus.ERROR, getPluginId(),
551 // JavaStatusConstants.INTERNAL_ERROR,
552 // JavaUIMessages.getString("JavaPlugin.internal_error"), e)); //$NON-NLS-1$
554 public static void log(int severity, String message) {
555 Status status = new Status(severity, PLUGIN_ID, IStatus.OK, message, null);
559 public static void log(IStatus status) {
560 getDefault().getLog().log(status);
563 public static void log(Throwable e) {
564 log(new Status(IStatus.ERROR, PLUGIN_ID, IStatus.ERROR, "PHPeclipsePlugin.internalErrorOccurred", e)); //$NON-NLS-1$
567 public static void logErrorMessage(String message) {
568 log(new Status(IStatus.ERROR, getPluginId(), IJavaStatusConstants.INTERNAL_ERROR, message, null));
571 // private static void setJVM() {
572 // String osName = System.getProperty("os.name");
573 // if (osName.startsWith("Mac OS")) {
574 // String mrjVersion = System.getProperty("mrj.version");
575 // String majorMRJVersion = mrjVersion.substring(0, 3);
578 // double version = Double.valueOf(majorMRJVersion).doubleValue();
579 // if (version == 2) {
581 // } else if (version >= 2.1 && version < 3) {
583 // } else if (version == 3.0) {
585 // } else if (version >= 3.1) {
588 // } catch (NumberFormatException nfe) {
590 // } else if (osName.startsWith("Windows")) {
591 // if (osName.indexOf("9") != -1) {
599 // TODO: refactor this into a better method name !
600 public synchronized ICompilationUnitDocumentProvider getCompilationUnitDocumentProvider() {
601 if (fCompilationUnitDocumentProvider == null)
602 fCompilationUnitDocumentProvider = new PHPDocumentProvider();
603 return fCompilationUnitDocumentProvider;
607 * Get the identifier index manager for the given project
610 * the current project
613 public IdentifierIndexManager getIndexManager(IProject iProject) {
614 IPath path = iProject.getWorkingLocation(PHPeclipsePlugin.PLUGIN_ID);
615 path = path.append("project.index");
616 String indexFilename = path.toString();
618 // IdentDB db = IdentDB.getInstance();
619 // } catch (ClassNotFoundException e) {
620 // e.printStackTrace();
621 // } catch (SQLException e) {
622 // e.printStackTrace();
624 IdentifierIndexManager indexManager = (IdentifierIndexManager) fIndexManagerMap.get(indexFilename);
625 if (indexManager == null) {
626 indexManager = new IdentifierIndexManager(indexFilename);
627 fIndexManagerMap.put(indexFilename, indexManager);
632 public synchronized IWorkingCopyManager getWorkingCopyManager() {
633 if (fWorkingCopyManager == null) {
634 ICompilationUnitDocumentProvider provider = getCompilationUnitDocumentProvider();
635 fWorkingCopyManager = new WorkingCopyManager(provider);
637 return fWorkingCopyManager;
640 public synchronized MembersOrderPreferenceCache getMemberOrderPreferenceCache() {
641 if (fMembersOrderPreferenceCache == null)
642 fMembersOrderPreferenceCache = new MembersOrderPreferenceCache();
643 return fMembersOrderPreferenceCache;
647 * Returns the mockup preference store for firing events and registering listeners on project setting changes. Temporary solution.
649 public MockupPreferenceStore getMockupPreferenceStore() {
650 if (fMockupPreferenceStore == null)
651 fMockupPreferenceStore = new MockupPreferenceStore();
653 return fMockupPreferenceStore;
656 public synchronized ProblemMarkerManager getProblemMarkerManager() {
657 if (fProblemMarkerManager == null)
658 fProblemMarkerManager = new ProblemMarkerManager();
659 return fProblemMarkerManager;
662 // public synchronized JavaTextTools getJavaTextTools() {
663 // if (fJavaTextTools == null)
664 // fJavaTextTools = new JavaTextTools(getPreferenceStore());
665 // return fJavaTextTools;
667 public synchronized JavaTextTools getJavaTextTools() {
668 if (fJavaTextTools == null)
669 fJavaTextTools = new JavaTextTools(getPreferenceStore(), JavaCore.getPlugin().getPluginPreferences());
670 return fJavaTextTools;
673 public IFile getLastEditorFile() {
674 return fLastEditorFile;
678 * Returns the string from the plugin's resource bundle, or 'key' if not found.
680 // public static String getResourceString(String key) {
681 // ResourceBundle bundle = PHPeclipsePlugin.getDefault().getResourceBundle();
683 // return bundle.getString(key);
684 // } catch (MissingResourceException e) {
689 * Returns the plugin's resource bundle,
691 // public ResourceBundle getResourceBundle() {
692 // return resourceBundle;
694 protected void initializeDefaultPreferences(IPreferenceStore store) {
695 String operatingSystem = Platform.getOS();
696 // maxosx, linux, solaris, win32,...
698 InputStream is = getDefault().openStream(
699 new Path("prefs/default_" + operatingSystem + ".properties"));
700 PropertyResourceBundle resourceBundle = new PropertyResourceBundle(is);
701 Enumeration enum = resourceBundle.getKeys();
703 while (enum.hasMoreElements()) {
704 key = (String)enum.nextElement();
705 store.setDefault(key, resourceBundle.getString( key ));
707 } catch (Exception e) {
708 // no default properties found
709 if (operatingSystem.equals(Platform.OS_WIN32)) {
710 store.setDefault(PHP_RUN_PREF, "c:\\apache\\php\\php.exe");
711 store.setDefault(EXTERNAL_PARSER_PREF, "c:\\apache\\php\\php -l -f {0}");
712 store.setDefault(MYSQL_RUN_PREF, "c:\\apache\\mysql\\bin\\mysqld-nt.exe");
713 store.setDefault(APACHE_RUN_PREF, "c:\\apache\\apache.exe");
714 store.setDefault(XAMPP_START_PREF, "c:\\xampp\\xampp_start.exe");
715 store.setDefault(XAMPP_STOP_PREF, "c:\\xampp\\xampp_stop.exe");
717 ETC_HOSTS_PATH_PREF, "c:\\windows\\system32\\drivers\\etc\\hosts");
719 store.setDefault(PHP_RUN_PREF, "/apache/php/php");
720 store.setDefault(EXTERNAL_PARSER_PREF, "/apache/php/php -l -f {0}");
721 store.setDefault(MYSQL_RUN_PREF, "/apache/mysql/bin/mysqld");
722 store.setDefault(APACHE_RUN_PREF, "/apache/apache");
723 store.setDefault(XAMPP_START_PREF, "xamp/xampp_start");
724 store.setDefault(XAMPP_STOP_PREF, "xampp/xampp_stop");
726 store.setDefault(MYSQL_PREF, "--standalone");
727 store.setDefault(APACHE_START_PREF, "-c \"DocumentRoot \"{0}\"\"");
728 store.setDefault(APACHE_STOP_PREF, "-k shutdown");
729 store.setDefault(APACHE_RESTART_PREF, "-k restart");
730 store.setDefault(MYSQL_START_BACKGROUND, "true");
731 store.setDefault(APACHE_START_BACKGROUND, "true");
732 store.setDefault(APACHE_STOP_BACKGROUND, "true");
733 store.setDefault(APACHE_RESTART_BACKGROUND, "true");
736 store.setDefault(SHOW_OUTPUT_IN_CONSOLE, "true");
737 store.setDefault(PHP_OBFUSCATOR_DEFAULT, "c:\\temp");
738 if (operatingSystem.equals(Platform.OS_WIN32)) {
739 // store.setDefault(EXTERNAL_BROWSER_PREF, "rundll32 url.dll,FileProtocolHandler {0}");
740 } else if (operatingSystem.equals(Platform.OS_MACOSX)) {
741 store.setDefault(PHP_OBFUSCATOR_DEFAULT, "/tmp");
742 // TODO How do we start Safari on Mac OS X ?
743 // store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
745 store.setDefault(PHP_OBFUSCATOR_DEFAULT, "/tmp");
746 // store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
749 store.setDefault(PHP_EXTENSION_PREFS, "php,php3,php4,php5,phtml,inc,module,class");
751 // store.setDefault(PHP_PARSER_DEFAULT, PHP_EXTERNAL_PARSER);
752 // store.setDefault(PHP_INTERNAL_PARSER, "false");
753 // store.setDefault(PHP_EXTERNAL_PARSER, "true");
754 // store.setDefault(PHP_PARSE_ON_SAVE, "true");
755 // show line numbers:
756 // store.setDefault(LINE_NUMBER_RULER, "false");
757 // store.setDefault(FORMATTER_TAB_SIZE, "4");
758 // php syntax highlighting
759 store.setDefault(PHP_USERDEF_XMLFILE, "");
760 //assume there is none chooA
761 // PreferenceConverter.setDefault(store, PHP_MULTILINE_COMMENT, PHPColorProvider.MULTI_LINE_COMMENT);
762 // PreferenceConverter.setDefault(store, PHP_SINGLELINE_COMMENT, PHPColorProvider.SINGLE_LINE_COMMENT);
763 PreferenceConverter.setDefault(store, PHP_TAG, PHPColorProvider.TAG);
764 PreferenceConverter.setDefault(store, PHP_KEYWORD, PHPColorProvider.KEYWORD);
765 PreferenceConverter.setDefault(store, PHP_VARIABLE, PHPColorProvider.VARIABLE);
766 PreferenceConverter.setDefault(store, PHP_FUNCTIONNAME, PHPColorProvider.FUNCTION_NAME);
767 PreferenceConverter.setDefault(store, PHP_CONSTANT, PHPColorProvider.CONSTANT);
768 PreferenceConverter.setDefault(store, PHP_TYPE, PHPColorProvider.TYPE);
769 // PreferenceConverter.setDefault(store, PHP_STRING_DQ, PHPColorProvider.STRING_DQ);
770 // store.setDefault(PHP_STRING_BOLD_DQ, true);
771 // PreferenceConverter.setDefault(store, PHP_STRING_SQ, PHPColorProvider.STRING_SQ);
772 PreferenceConverter.setDefault(store, PHP_DEFAULT, PHPColorProvider.DEFAULT);
773 PreferenceConverter.setDefault(store, PHPDOC_KEYWORD, PHPColorProvider.PHPDOC_KEYWORD);
774 PreferenceConverter.setDefault(store, PHPDOC_TAG, PHPColorProvider.PHPDOC_TAG);
775 PreferenceConverter.setDefault(store, PHPDOC_LINK, PHPColorProvider.PHPDOC_LINK);
776 PreferenceConverter.setDefault(store, PHPDOC_DEFAULT, PHPColorProvider.PHPDOC_DEFAULT);
778 PreferenceConverter.setDefault(store, EDITOR_PHP_KEYWORD_RETURN_COLOR, new RGB(127, 0, 85));
779 store.setDefault(EDITOR_PHP_KEYWORD_RETURN_BOLD, true);
780 store.setDefault(EDITOR_PHP_KEYWORD_RETURN_ITALIC, false);
782 PreferenceConverter.setDefault(store, EDITOR_PHP_OPERATOR_COLOR, new RGB(0, 0, 0));
783 store.setDefault(EDITOR_PHP_OPERATOR_BOLD, false);
784 store.setDefault(EDITOR_PHP_OPERATOR_ITALIC, false);
786 PreferenceConverter.setDefault(store, EDITOR_PHP_BRACE_OPERATOR_COLOR, new RGB(0, 0, 0));
787 store.setDefault(EDITOR_PHP_BRACE_OPERATOR_BOLD, false);
788 store.setDefault(EDITOR_PHP_BRACE_OPERATOR_ITALIC, false);
789 // PreferenceConverter.setDefault(
791 // PHP_EDITOR_BACKGROUND,
792 // PHPColorProvider.BACKGROUND);
793 // PreferenceConverter.setDefault(
795 // LINKED_POSITION_COLOR,
796 // PHPColorProvider.LINKED_POSITION_COLOR);
797 // PreferenceConverter.setDefault(
799 // LINE_NUMBER_COLOR,
800 // PHPColorProvider.LINE_NUMBER_COLOR);
801 // // set default PHPDoc colors:
802 // PreferenceConverter.setDefault(
805 // PHPColorProvider.PHPDOC_KEYWORD);
806 // PreferenceConverter.setDefault(
809 // PHPColorProvider.PHPDOC_LINK);
810 // PreferenceConverter.setDefault(
813 // PHPColorProvider.PHPDOC_DEFAULT);
814 // PreferenceConverter.setDefault(
817 // PHPColorProvider.PHPDOC_TAG);
818 // store.setDefault(PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT, "true");
819 // PreferenceConverter.setDefault(
821 // PREFERENCE_COLOR_BACKGROUND,
822 // PHPColorProvider.BACKGROUND_COLOR);
824 // store.setDefault(RESOURCE_BUNDLE, LANGUAGE_DEFAULT);
825 // store.setDefault(RESOURCE_BUNDLE_EN_GB, "true");
826 // store.setDefault(RESOURCE_BUNDLE_DE, "false");
827 // store.setDefault(RESOURCE_BUNDLE_FR, "false");
828 // store.setDefault(RESOURCE_BUNDLE_ES, "false");
829 // TemplatePreferencePage.initDefaults(store);
830 //this will initialize the static fields in the syntaxrdr class
832 JavaCore.initializeDefaultPluginPreferences();
833 PreferenceConstants.initializeDefaultValues(store);
834 // externalTools.initializeDefaultPreferences(store);
835 MarkerAnnotationPreferences.initializeDefaultValues(store);
838 private IWorkbenchPage internalGetActivePage() {
839 IWorkbenchWindow window = getWorkbench().getActiveWorkbenchWindow();
841 return window.getActivePage();
845 private ImageDescriptorRegistry internalGetImageDescriptorRegistry() {
846 if (fImageDescriptorRegistry == null)
847 fImageDescriptorRegistry = new ImageDescriptorRegistry();
848 return fImageDescriptorRegistry;
852 * Open a file in the Workbench that may or may not exist in the workspace. Must be run on the UI thread.
855 * @throws CoreException
857 public ITextEditor openFileInTextEditor(String filename) throws CoreException {
858 // reject directories
859 if (new File(filename).isDirectory())
861 IWorkbench workbench = PlatformUI.getWorkbench();
862 IWorkbenchWindow window = workbench.getWorkbenchWindows()[0];
863 IWorkbenchPage page = window.getActivePage();
864 IPath path = new Path(filename);
865 // If the file exists in the workspace, open it
866 IFile file = getWorkspace().getRoot().getFileForLocation(path);
868 ITextEditor textEditor;
869 if (file != null && file.exists()) {
870 editor = IDE.openEditor(page, file, true);
871 textEditor = (ITextEditor) editor.getAdapter(ITextEditor.class);
873 // Otherwise open the stream directly
876 FileStorage storage = new FileStorage(path);
877 IEditorRegistry registry = getWorkbench().getEditorRegistry();
878 IEditorDescriptor desc = registry.getDefaultEditor(filename);
880 desc = registry.findEditor(IEditorRegistry.SYSTEM_EXTERNAL_EDITOR_ID);
881 // desc = registry.getDefaultEditor();
883 IEditorInput input = new ExternalEditorInput(storage);
884 editor = page.openEditor(input, desc.getId());
885 textEditor = (ITextEditor) editor.getAdapter(ITextEditor.class);
886 // If the storage provider is not ours, we can't guarantee read/write.
887 if (textEditor != null) {
888 IDocumentProvider documentProvider = textEditor.getDocumentProvider();
889 if (!(documentProvider instanceof ExternalStorageDocumentProvider)) {
890 storage.setReadOnly();
898 * Open a file in the Workbench that may or may not exist in the workspace. Must be run on the UI thread.
902 * @throws CoreException
904 public void openFileAndGotoLine(String filename, int line) throws CoreException {
905 ITextEditor textEditor = openFileInTextEditor(filename);
906 if (textEditor != null) {
907 // If a line number was given, go to it
910 line--; // document is 0 based
911 IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
912 textEditor.selectAndReveal(document.getLineOffset(line), document.getLineLength(line));
913 } catch (BadLocationException e) {
914 // invalid text position -> do nothing
921 * Open a file in the Workbench that may or may not exist in the workspace. Must be run on the UI thread.
925 * @throws CoreException
927 public void openFileAndGotoOffset(String filename, int offset, int length) throws CoreException {
928 ITextEditor textEditor = openFileInTextEditor(filename);
929 if (textEditor != null) {
930 // If a line number was given, go to it
932 IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
933 textEditor.selectAndReveal(offset, length);
938 public void openFileAndFindString(String filename, String findString) throws CoreException {
939 ITextEditor textEditor = openFileInTextEditor(filename);
940 if (textEditor != null) {
941 // If a string was given, go to it
942 if (findString != null) {
944 IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
945 int offset = document.search(0, findString, true, false, true);
946 textEditor.selectAndReveal(offset, findString.length());
947 } catch (BadLocationException e) {
948 // invalid text position -> do nothing
954 public void setLastEditorFile(IFile textEditor) {
955 this.fLastEditorFile = textEditor;
959 * @see org.eclipse.core.runtime.Plugin#stop
961 public void stop(BundleContext context) throws Exception {
963 // JavaCore.stop(this, context);
964 plugin.savePluginPreferences();
965 IWorkspace workspace = ResourcesPlugin.getWorkspace();
966 workspace.removeResourceChangeListener(JavaModelManager.getJavaModelManager().deltaState);
967 workspace.removeSaveParticipant(plugin);
969 JavaModelManager.getJavaModelManager().shutdown();
971 ColorManager.getDefault().dispose();
972 // save the information from the php index files if necessary
973 Collection collection = fIndexManagerMap.values();
974 Iterator iterator = collection.iterator();
975 IdentifierIndexManager indexManager = null;
976 while (iterator.hasNext()) {
977 indexManager = (IdentifierIndexManager) iterator.next();
978 indexManager.writeFile();
980 if (fImageDescriptorRegistry != null)
981 fImageDescriptorRegistry.dispose();
983 // AllTypesCache.terminate();
985 if (fImageDescriptorRegistry != null)
986 fImageDescriptorRegistry.dispose();
988 unregisterAdapters();
990 // if (fASTProvider != null) {
991 // fASTProvider.dispose();
992 // fASTProvider= null;
995 if (fWorkingCopyManager != null) {
996 fWorkingCopyManager.shutdown();
997 fWorkingCopyManager = null;
1000 if (fCompilationUnitDocumentProvider != null) {
1001 fCompilationUnitDocumentProvider.shutdown();
1002 fCompilationUnitDocumentProvider = null;
1005 if (fJavaTextTools != null) {
1006 fJavaTextTools.dispose();
1007 fJavaTextTools = null;
1009 // JavaDocLocations.shutdownJavadocLocations();
1011 uninstallPreferenceStoreBackwardsCompatibility();
1013 // RefactoringCore.getUndoManager().shutdown();
1015 super.stop(context);
1020 * @see org.eclipse.ui.plugin.AbstractUIPlugin#shutdown()
1022 // public void shutdown() throws CoreException {
1023 // // moved down (see below):
1024 // // super.shutdown();
1025 // // externalTools.shutDown();
1026 // ColorManager.getDefault().dispose();
1027 // // save the information from the php index files if necessary
1028 // Collection collection = fIndexManagerMap.values();
1029 // Iterator iterator = collection.iterator();
1030 // IdentifierIndexManager indexManager = null;
1031 // while (iterator.hasNext()) {
1032 // indexManager = (IdentifierIndexManager) iterator.next();
1033 // indexManager.writeFile();
1035 // if (fImageDescriptorRegistry != null)
1036 // fImageDescriptorRegistry.dispose();
1037 // // unregisterAdapters();
1038 // super.shutdown();
1039 // if (fWorkingCopyManager != null) {
1040 // fWorkingCopyManager.shutdown();
1041 // fWorkingCopyManager = null;
1043 // if (fCompilationUnitDocumentProvider != null) {
1044 // fCompilationUnitDocumentProvider.shutdown();
1045 // fCompilationUnitDocumentProvider = null;
1047 // if (fJavaTextTools != null) {
1048 // fJavaTextTools.dispose();
1049 // fJavaTextTools = null;
1051 // // JavaDocLocations.shutdownJavadocLocations();
1054 // JFaceResources.getFontRegistry().removeListener(fFontPropertyChangeListener);
1055 // // begin JavaCore#shutdown()
1056 // //savePluginPreferences();
1057 // savePluginPreferences();
1058 // IWorkspace workspace = ResourcesPlugin.getWorkspace();
1059 // workspace.removeResourceChangeListener(JavaModelManager.getJavaModelManager().deltaState);
1060 // workspace.removeSaveParticipant(this);
1061 // ((JavaModelManager) JavaModelManager.getJavaModelManager()).shutdown();
1062 // // end JavaCore#shutdown()
1065 * Installs backwards compatibility for the preference store.
1067 private void installPreferenceStoreBackwardsCompatibility() {
1070 * Installs backwards compatibility: propagate the Java editor font from a pre-2.1 plug-in to the Platform UI's preference store
1071 * to preserve the Java editor font from a pre-2.1 workspace. This is done only once.
1073 String fontPropagatedKey = "fontPropagated"; //$NON-NLS-1$
1074 if (getPreferenceStore().contains(JFaceResources.TEXT_FONT) && !getPreferenceStore().isDefault(JFaceResources.TEXT_FONT)) {
1075 if (!getPreferenceStore().getBoolean(fontPropagatedKey))
1076 PreferenceConverter.setValue(PlatformUI.getWorkbench().getPreferenceStore(), PreferenceConstants.EDITOR_TEXT_FONT,
1077 PreferenceConverter.getFontDataArray(getPreferenceStore(), JFaceResources.TEXT_FONT));
1079 getPreferenceStore().setValue(fontPropagatedKey, true);
1082 * Backwards compatibility: set the Java editor font in this plug-in's preference store to let older versions access it. Since
1083 * 2.1 the Java editor font is managed by the workbench font preference page.
1085 PreferenceConverter.putValue(getPreferenceStore(), JFaceResources.TEXT_FONT, JFaceResources.getFontRegistry().getFontData(
1086 PreferenceConstants.EDITOR_TEXT_FONT));
1088 fFontPropertyChangeListener = new IPropertyChangeListener() {
1089 public void propertyChange(PropertyChangeEvent event) {
1090 if (PreferenceConstants.EDITOR_TEXT_FONT.equals(event.getProperty()))
1091 PreferenceConverter.putValue(getPreferenceStore(), JFaceResources.TEXT_FONT, JFaceResources.getFontRegistry()
1092 .getFontData(PreferenceConstants.EDITOR_TEXT_FONT));
1095 JFaceResources.getFontRegistry().addListener(fFontPropertyChangeListener);
1098 * Backwards compatibility: propagate the Java editor tab width from a pre-3.0 plug-in to the new preference key. This is done
1101 // final String oldTabWidthKey = PreferenceConstants.EDITOR_TAB_WIDTH;
1102 // final String newTabWidthKey = AbstractDecoratedTextEditorPreferenceConstants.EDITOR_TAB_WIDTH;
1103 // String tabWidthPropagatedKey = "tabWidthPropagated"; //$NON-NLS-1$
1104 // if (getPreferenceStore().contains(oldTabWidthKey) && !getPreferenceStore().isDefault(oldTabWidthKey)) {
1105 // if (!getPreferenceStore().getBoolean(tabWidthPropagatedKey))
1106 // getPreferenceStore().setValue(newTabWidthKey, getPreferenceStore().getInt(oldTabWidthKey));
1108 // getPreferenceStore().setValue(tabWidthPropagatedKey, true);
1111 // * Backwards compatibility: set the Java editor tab width in this plug-in's preference store with the old key to let older
1112 // * versions access it. Since 3.0 the tab width is managed by the extended texteditor and uses a new key.
1114 // getPreferenceStore().putValue(oldTabWidthKey, getPreferenceStore().getString(newTabWidthKey));
1115 // fPropertyChangeListener = new IPropertyChangeListener() {
1116 // public void propertyChange(PropertyChangeEvent event) {
1117 // if (newTabWidthKey.equals(event.getProperty()))
1118 // getPreferenceStore().putValue(oldTabWidthKey, getPreferenceStore().getString(newTabWidthKey));
1121 // getPreferenceStore().addPropertyChangeListener(fPropertyChangeListener);
1123 * Backward compatibility for the refactoring preference key.
1125 // getPreferenceStore().setValue(
1126 // PreferenceConstants.REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD,
1127 // RefactoringCore.getConditionCheckingFailedSeverity());
1131 * Uninstalls backwards compatibility for the preference store.
1133 private void uninstallPreferenceStoreBackwardsCompatibility() {
1134 JFaceResources.getFontRegistry().removeListener(fFontPropertyChangeListener);
1135 // getPreferenceStore().removePropertyChangeListener(fPropertyChangeListener);
1139 * (non - Javadoc) Method declared in Plugin
1141 public void start(BundleContext context) throws Exception {
1142 super.start(context);
1144 // JavaCore.start(this, context);
1145 final JavaModelManager manager = JavaModelManager.getJavaModelManager();
1147 manager.configurePluginDebugOptions();
1149 // request state folder creation (workaround 19885)
1150 // JavaCore.getPlugin().getStateLocation();
1152 // retrieve variable values
1153 PHPeclipsePlugin.getDefault().getPluginPreferences().addPropertyChangeListener(
1154 new JavaModelManager.PluginPreferencesListener());
1155 // manager.loadVariablesAndContainers();
1157 final IWorkspace workspace = ResourcesPlugin.getWorkspace();
1158 workspace.addResourceChangeListener(manager.deltaState, IResourceChangeEvent.PRE_BUILD | IResourceChangeEvent.POST_BUILD
1159 | IResourceChangeEvent.POST_CHANGE | IResourceChangeEvent.PRE_DELETE | IResourceChangeEvent.PRE_CLOSE);
1162 ISavedState savedState = workspace.addSaveParticipant(PHPeclipsePlugin.this, manager);
1164 // process deltas since last activated in indexer thread so that indexes are up-to-date.
1165 // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=38658
1166 Job processSavedState = new Job(Util.bind("savedState.jobName")) { //$NON-NLS-1$
1167 protected IStatus run(IProgressMonitor monitor) {
1169 // add save participant and process delta atomically
1170 // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=59937
1171 workspace.run(new IWorkspaceRunnable() {
1172 public void run(IProgressMonitor progress) throws CoreException {
1173 ISavedState savedState = workspace.addSaveParticipant(PHPeclipsePlugin.this, manager);
1174 if (savedState != null) {
1175 // the event type coming from the saved state is always POST_AUTO_BUILD
1176 // force it to be POST_CHANGE so that the delta processor can handle it
1177 manager.deltaState.getDeltaProcessor().overridenEventType = IResourceChangeEvent.POST_CHANGE;
1178 savedState.processResourceChangeEvents(manager.deltaState);
1182 } catch (CoreException e) {
1183 return e.getStatus();
1185 return Status.OK_STATUS;
1188 processSavedState.setSystem(true);
1189 processSavedState.setPriority(Job.SHORT); // process asap
1190 processSavedState.schedule();
1191 } catch (RuntimeException e) {
1198 // if (USE_WORKING_COPY_OWNERS) {
1199 WorkingCopyOwner.setPrimaryBufferProvider(new WorkingCopyOwner() {
1200 public IBuffer createBuffer(ICompilationUnit workingCopy) {
1201 ICompilationUnit original = workingCopy.getPrimary();
1202 IResource resource = original.getResource();
1203 if (resource instanceof IFile)
1204 return new DocumentAdapter(workingCopy, (IFile) resource);
1205 return DocumentAdapter.NULL;
1210 installPreferenceStoreBackwardsCompatibility();
1214 // registerAdapters();
1216 // // externalTools.startUp();
1217 // getStandardDisplay().asyncExec(new Runnable() {
1218 // public void run() {
1219 // //initialize the variable context manager
1220 // VariableContextManager.getDefault();
1224 // // if (USE_WORKING_COPY_OWNERS) {
1225 // WorkingCopyOwner.setPrimaryBufferProvider(new WorkingCopyOwner() {
1226 // public IBuffer createBuffer(ICompilationUnit workingCopy) {
1227 // ICompilationUnit original = workingCopy.getPrimary();
1228 // IResource resource = original.getResource();
1229 // if (resource instanceof IFile)
1230 // return new DocumentAdapter(workingCopy, (IFile) resource);
1231 // return DocumentAdapter.NULL;
1236 // installPreferenceStoreBackwardsCompatibility();
1238 // AllTypesCache.initialize();
1240 // Initialize AST provider
1241 // getASTProvider();
1244 // public void startup() throws CoreException {
1246 // // begin JavaCore.startup();
1247 // JavaModelManager manager = JavaModelManager.getJavaModelManager();
1249 // manager.configurePluginDebugOptions();
1250 // // request state folder creation (workaround 19885)
1251 // // JavaCore.getPlugin().getStateLocation();
1252 // getStateLocation();
1253 // // retrieve variable values
1255 // JavaCore.getPlugin().getPluginPreferences().addPropertyChangeListener(new
1256 // // JavaModelManager.PluginPreferencesListener());
1257 // getPluginPreferences().addPropertyChangeListener(
1258 // new JavaModelManager.PluginPreferencesListener());
1260 // // manager.loadVariablesAndContainers();
1261 // final IWorkspace workspace = ResourcesPlugin.getWorkspace();
1262 // workspace.addResourceChangeListener(
1263 // manager.deltaState,
1264 // IResourceChangeEvent.PRE_BUILD
1265 // | IResourceChangeEvent.POST_BUILD
1266 // | IResourceChangeEvent.POST_CHANGE
1267 // | IResourceChangeEvent.PRE_DELETE
1268 // | IResourceChangeEvent.PRE_CLOSE);
1269 // // startIndexing();
1270 // workspace.addSaveParticipant(PHPeclipsePlugin.getDefault(), manager);
1271 // } catch (CoreException e) {
1272 // } catch (RuntimeException e) {
1273 // manager.shutdown();
1276 // // end JavaCore.startup();
1277 // IAdapterManager platformManager = Platform.getAdapterManager();
1278 // platformManager.registerAdapters(new PHPElementAdapterFactory(),
1279 // PHPElement.class);
1280 // platformManager.registerAdapters(new ResourceAdapterFactory(),
1281 // IResource.class);
1282 // // externalTools.startUp();
1283 // getStandardDisplay().asyncExec(new Runnable() {
1284 // public void run() {
1285 // //initialize the variable context manager
1286 // VariableContextManager.getDefault();
1291 private void registerAdapters() {
1292 fJavaElementAdapterFactory = new JavaElementAdapterFactory();
1293 // fMarkerAdapterFactory= new MarkerAdapterFactory();
1294 // fEditorInputAdapterFactory= new EditorInputAdapterFactory();
1295 fResourceAdapterFactory = new ResourceAdapterFactory();
1296 // fLogicalPackageAdapterFactory= new LogicalPackageAdapterFactory();
1298 IAdapterManager manager = Platform.getAdapterManager();
1299 manager.registerAdapters(fJavaElementAdapterFactory, IJavaElement.class);
1300 // manager.registerAdapters(fMarkerAdapterFactory, IMarker.class);
1301 // manager.registerAdapters(fEditorInputAdapterFactory, IEditorInput.class);
1302 manager.registerAdapters(fResourceAdapterFactory, IResource.class);
1303 // manager.registerAdapters(fLogicalPackageAdapterFactory,
1304 // LogicalPackage.class);
1307 private void unregisterAdapters() {
1308 IAdapterManager manager = Platform.getAdapterManager();
1309 manager.unregisterAdapters(fJavaElementAdapterFactory);
1310 // manager.unregisterAdapters(fMarkerAdapterFactory);
1311 // manager.unregisterAdapters(fEditorInputAdapterFactory);
1312 manager.unregisterAdapters(fResourceAdapterFactory);
1313 // manager.unregisterAdapters(fLogicalPackageAdapterFactory);
1317 * Returns a combined preference store, this store is read-only.
1319 * @return the combined preference store
1323 public IPreferenceStore getCombinedPreferenceStore() {
1324 if (fCombinedPreferenceStore == null) {
1325 IPreferenceStore generalTextStore = EditorsUI.getPreferenceStore();
1326 fCombinedPreferenceStore = new ChainedPreferenceStore(new IPreferenceStore[] {
1327 getPreferenceStore(),
1328 new PreferencesAdapter(PHPeclipsePlugin.getDefault().getPluginPreferences()),
1329 generalTextStore });
1331 return fCombinedPreferenceStore;
1334 public synchronized IBufferFactory getBufferFactory() {
1335 if (fBufferFactory == null)
1336 fBufferFactory = new CustomBufferFactory();
1337 return fBufferFactory;
1341 * Returns the registry of the extensions to the <code>net.sourceforge.phpdt.ui.javaFoldingStructureProvider</code> extension
1344 * @return the registry of contributed <code>IJavaFoldingStructureProvider</code>
1347 public synchronized JavaFoldingStructureProviderRegistry getFoldingStructureProviderRegistry() {
1348 if (fFoldingStructureProviderRegistry == null)
1349 fFoldingStructureProviderRegistry = new JavaFoldingStructureProviderRegistry();
1350 return fFoldingStructureProviderRegistry;
1354 * Runs the given action as an atomic Java model operation.
1356 * After running a method that modifies java elements, registered listeners receive after-the-fact notification of what just
1357 * transpired, in the form of a element changed event. This method allows clients to call a number of methods that modify java
1358 * elements and only have element changed event notifications reported at the end of the entire batch.
1361 * If this method is called outside the dynamic scope of another such call, this method runs the action and then reports a single
1362 * element changed event describing the net effect of all changes done to java elements by the action.
1365 * If this method is called in the dynamic scope of another such call, this method simply runs the action.
1369 * the action to perform
1371 * a progress monitor, or <code>null</code> if progress reporting and cancellation are not desired
1372 * @exception CoreException
1373 * if the operation failed.
1376 public static void run(IWorkspaceRunnable action, IProgressMonitor monitor) throws CoreException {
1377 run(action, ResourcesPlugin.getWorkspace().getRoot(), monitor);
1381 * Runs the given action as an atomic Java model operation.
1383 * After running a method that modifies java elements, registered listeners receive after-the-fact notification of what just
1384 * transpired, in the form of a element changed event. This method allows clients to call a number of methods that modify java
1385 * elements and only have element changed event notifications reported at the end of the entire batch.
1388 * If this method is called outside the dynamic scope of another such call, this method runs the action and then reports a single
1389 * element changed event describing the net effect of all changes done to java elements by the action.
1392 * If this method is called in the dynamic scope of another such call, this method simply runs the action.
1395 * The supplied scheduling rule is used to determine whether this operation can be run simultaneously with workspace changes in
1396 * other threads. See <code>IWorkspace.run(...)</code> for more details.
1400 * the action to perform
1402 * the scheduling rule to use when running this operation, or <code>null</code> if there are no scheduling restrictions
1403 * for this operation.
1405 * a progress monitor, or <code>null</code> if progress reporting and cancellation are not desired
1406 * @exception CoreException
1407 * if the operation failed.
1410 public static void run(IWorkspaceRunnable action, ISchedulingRule rule, IProgressMonitor monitor) throws CoreException {
1411 IWorkspace workspace = ResourcesPlugin.getWorkspace();
1412 if (workspace.isTreeLocked()) {
1413 new BatchOperation(action).run(monitor);
1415 // use IWorkspace.run(...) to ensure that a build will be done in
1417 workspace.run(new BatchOperation(action), rule, IWorkspace.AVOID_UPDATE, monitor);
1422 * Returns the template context type registry for the java plugin.
1424 * @return the template context type registry for the java plugin
1427 public ContextTypeRegistry getTemplateContextRegistry() {
1428 if (fContextTypeRegistry == null) {
1429 fContextTypeRegistry = new ContributionContextTypeRegistry();
1431 fContextTypeRegistry.addContextType(new JavaContextType());
1432 fContextTypeRegistry.addContextType(new JavaDocContextType());
1433 fContextTypeRegistry.addContextType(new HTMLContextType());
1436 return fContextTypeRegistry;
1440 * Returns the template store for the java editor templates.
1442 * @return the template store for the java editor templates
1445 public TemplateStore getTemplateStore() {
1446 if (fTemplateStore == null) {
1447 // boolean alreadyMigrated= getPreferenceStore().getBoolean(TEMPLATES_MIGRATION_KEY);
1448 // if (alreadyMigrated)
1449 fTemplateStore = new ContributionTemplateStore(getTemplateContextRegistry(), getPreferenceStore(), TEMPLATES_KEY);
1451 // fTemplateStore= new CompatibilityTemplateStore(getTemplateContextRegistry(), getPreferenceStore(), TEMPLATES_KEY,
1452 // Templates.getInstance());
1453 // getPreferenceStore().setValue(TEMPLATES_MIGRATION_KEY, true);
1457 fTemplateStore.load();
1458 } catch (IOException e) {
1463 return fTemplateStore;
1467 * Returns the template context type registry for the code generation templates.
1469 * @return the template context type registry for the code generation templates
1472 public ContextTypeRegistry getCodeTemplateContextRegistry() {
1473 if (fCodeTemplateContextTypeRegistry == null) {
1474 fCodeTemplateContextTypeRegistry = new ContributionContextTypeRegistry();
1476 CodeTemplateContextType.registerContextTypes(fCodeTemplateContextTypeRegistry);
1479 return fCodeTemplateContextTypeRegistry;
1483 * Returns the template store for the code generation templates.
1485 * @return the template store for the code generation templates
1488 public TemplateStore getCodeTemplateStore() {
1489 if (fCodeTemplateStore == null) {
1490 // boolean alreadyMigrated= getPreferenceStore().getBoolean(CODE_TEMPLATES_MIGRATION_KEY);
1491 // if (alreadyMigrated)
1492 fCodeTemplateStore = new ContributionTemplateStore(getCodeTemplateContextRegistry(), getPreferenceStore(), CODE_TEMPLATES_KEY);
1494 // fCodeTemplateStore= new CompatibilityTemplateStore(getCodeTemplateContextRegistry(), getPreferenceStore(),
1495 // CODE_TEMPLATES_KEY, CodeTemplates.getInstance());
1496 // getPreferenceStore().setValue(CODE_TEMPLATES_MIGRATION_KEY, true);
1500 fCodeTemplateStore.load();
1501 } catch (IOException e) {
1505 // compatibility / bug fixing code for duplicated templates
1506 // TODO remove for 3.0
1507 // CompatibilityTemplateStore.pruneDuplicates(fCodeTemplateStore, true);
1510 return fCodeTemplateStore;